blib/lib/Paws/SageMaker/CreateUserProfile.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SageMaker::CreateUserProfile;
3 use Moose;
4 has DomainId => (is => 'ro', isa => 'Str', required => 1);
5 has SingleSignOnUserIdentifier => (is => 'ro', isa => 'Str');
6 has SingleSignOnUserValue => (is => 'ro', isa => 'Str');
7 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]');
8 has UserProfileName => (is => 'ro', isa => 'Str', required => 1);
9 has UserSettings => (is => 'ro', isa => 'Paws::SageMaker::UserSettings');
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateUserProfile');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateUserProfileResponse');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::SageMaker::CreateUserProfile - Arguments for method CreateUserProfile on L<Paws::SageMaker>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method CreateUserProfile on the
27 L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class
28 as arguments to method CreateUserProfile.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateUserProfile.
31  
32 =head1 SYNOPSIS
33  
34 my $api.sagemaker = Paws->service('SageMaker');
35 my $CreateUserProfileResponse = $api . sagemaker->CreateUserProfile(
36 DomainId => 'MyDomainId',
37 UserProfileName => 'MyUserProfileName',
38 SingleSignOnUserIdentifier => 'MySingleSignOnUserIdentifier', # OPTIONAL
39 SingleSignOnUserValue => 'MyString256', # OPTIONAL
40 Tags => [
41 {
42 Key => 'MyTagKey', # min: 1, max: 128
43 Value => 'MyTagValue', # max: 256
44  
45 },
46 ...
47 ], # OPTIONAL
48 UserSettings => {
49 ExecutionRole => 'MyRoleArn', # min: 20, max: 2048; OPTIONAL
50 JupyterServerAppSettings => {
51 DefaultResourceSpec => {
52 InstanceType => 'system'
53 , # values: system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge; OPTIONAL
54 SageMakerImageArn => 'MyImageArn', # max: 256; OPTIONAL
55 SageMakerImageVersionArn =>
56 'MyImageVersionArn', # max: 256; OPTIONAL
57 }, # OPTIONAL
58 }, # OPTIONAL
59 KernelGatewayAppSettings => {
60 CustomImages => [
61 {
62 AppImageConfigName => 'MyAppImageConfigName', # max: 63
63 ImageName => 'MyImageName', # min: 1, max: 63
64 ImageVersionNumber => 1, # OPTIONAL
65 },
66 ...
67 ], # max: 30; OPTIONAL
68 DefaultResourceSpec => {
69 InstanceType => 'system'
70 , # values: system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge; OPTIONAL
71 SageMakerImageArn => 'MyImageArn', # max: 256; OPTIONAL
72 SageMakerImageVersionArn =>
73 'MyImageVersionArn', # max: 256; OPTIONAL
74 }, # OPTIONAL
75 }, # OPTIONAL
76 SecurityGroups => [
77 'MySecurityGroupId', ... # max: 32
78 ], # max: 5; OPTIONAL
79 SharingSettings => {
80 NotebookOutputOption =>
81 'Allowed', # values: Allowed, Disabled; OPTIONAL
82 S3KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
83 S3OutputPath => 'MyS3Uri', # max: 1024; OPTIONAL
84 }, # OPTIONAL
85 TensorBoardAppSettings => {
86 DefaultResourceSpec => {
87 InstanceType => 'system'
88 , # values: system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge; OPTIONAL
89 SageMakerImageArn => 'MyImageArn', # max: 256; OPTIONAL
90 SageMakerImageVersionArn =>
91 'MyImageVersionArn', # max: 256; OPTIONAL
92 }, # OPTIONAL
93 }, # OPTIONAL
94 }, # OPTIONAL
95 );
96  
97 # Results:
98 my $UserProfileArn = $CreateUserProfileResponse->UserProfileArn;
99  
100 # Returns a L<Paws::SageMaker::CreateUserProfileResponse> object.
101  
102 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
103 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateUserProfile>
104  
105 =head1 ATTRIBUTES
106  
107  
108 =head2 B<REQUIRED> DomainId => Str
109  
110 The ID of the associated Domain.
111  
112  
113  
114 =head2 SingleSignOnUserIdentifier => Str
115  
116 A specifier for the type of value specified in SingleSignOnUserValue.
117 Currently, the only supported value is "UserName". If the Domain's
118 AuthMode is SSO, this field is required. If the Domain's AuthMode is
119 not SSO, this field cannot be specified.
120  
121  
122  
123 =head2 SingleSignOnUserValue => Str
124  
125 The username of the associated Amazon Web Services Single Sign-On User
126 for this UserProfile. If the Domain's AuthMode is SSO, this field is
127 required, and must match a valid username of a user in your directory.
128 If the Domain's AuthMode is not SSO, this field cannot be specified.
129  
130  
131  
132 =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>]
133  
134 Each tag consists of a key and an optional value. Tag keys must be
135 unique per resource.
136  
137 Tags that you specify for the User Profile are also added to all Apps
138 that the User Profile launches.
139  
140  
141  
142 =head2 B<REQUIRED> UserProfileName => Str
143  
144 A name for the UserProfile. This value is not case sensitive.
145  
146  
147  
148 =head2 UserSettings => L<Paws::SageMaker::UserSettings>
149  
150 A collection of settings.
151  
152  
153  
154  
155 =head1 SEE ALSO
156  
157 This class forms part of L<Paws>, documenting arguments for method CreateUserProfile in L<Paws::SageMaker>
158  
159 =head1 BUGS and CONTRIBUTIONS
160  
161 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
162  
163 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
164  
165 =cut
166