blib/lib/Paws/SageMaker/CreateWorkteam.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::CreateWorkteam;
3 use Moose;
4 has Description => (is => 'ro', isa => 'Str', required => 1);
5 has MemberDefinitions => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::MemberDefinition]', required => 1);
6 has NotificationConfiguration => (is => 'ro', isa => 'Paws::SageMaker::NotificationConfiguration');
7 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]');
8 has WorkforceName => (is => 'ro', isa => 'Str');
9 has WorkteamName => (is => 'ro', isa => 'Str', required => 1);
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateWorkteam');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateWorkteamResponse');
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::CreateWorkteam - Arguments for method CreateWorkteam on L<Paws::SageMaker>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method CreateWorkteam on the
27 L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class
28 as arguments to method CreateWorkteam.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateWorkteam.
31  
32 =head1 SYNOPSIS
33  
34 my $api.sagemaker = Paws->service('SageMaker');
35 my $CreateWorkteamResponse = $api . sagemaker->CreateWorkteam(
36 Description => 'MyString200',
37 MemberDefinitions => [
38 {
39 CognitoMemberDefinition => {
40 ClientId => 'MyClientId', # min: 1, max: 1024
41 UserGroup => 'MyCognitoUserGroup', # min: 1, max: 128
42 UserPool => 'MyCognitoUserPool', # min: 1, max: 55
43  
44 }, # OPTIONAL
45 OidcMemberDefinition => {
46 Groups => [
47 'MyGroup', ... # min: 1, max: 63
48 ], # min: 1, max: 10
49  
50 }, # OPTIONAL
51 },
52 ...
53 ],
54 WorkteamName => 'MyWorkteamName',
55 NotificationConfiguration => {
56 NotificationTopicArn => 'MyNotificationTopicArn', # OPTIONAL
57 }, # OPTIONAL
58 Tags => [
59 {
60 Key => 'MyTagKey', # min: 1, max: 128
61 Value => 'MyTagValue', # max: 256
62  
63 },
64 ...
65 ], # OPTIONAL
66 WorkforceName => 'MyWorkforceName', # OPTIONAL
67 );
68  
69 # Results:
70 my $WorkteamArn = $CreateWorkteamResponse->WorkteamArn;
71  
72 # Returns a L<Paws::SageMaker::CreateWorkteamResponse> object.
73  
74 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.
75 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateWorkteam>
76  
77 =head1 ATTRIBUTES
78  
79  
80 =head2 B<REQUIRED> Description => Str
81  
82 A description of the work team.
83  
84  
85  
86 =head2 B<REQUIRED> MemberDefinitions => ArrayRef[L<Paws::SageMaker::MemberDefinition>]
87  
88 A list of C<MemberDefinition> objects that contains objects that
89 identify the workers that make up the work team.
90  
91 Workforces can be created using Amazon Cognito or your own OIDC
92 Identity Provider (IdP). For private workforces created using Amazon
93 Cognito use C<CognitoMemberDefinition>. For workforces created using
94 your own OIDC identity provider (IdP) use C<OidcMemberDefinition>. Do
95 not provide input for both of these parameters in a single request.
96  
97 For workforces created using Amazon Cognito, private work teams
98 correspond to Amazon Cognito I<user groups> within the user pool used
99 to create a workforce. All of the C<CognitoMemberDefinition> objects
100 that make up the member definition must have the same C<ClientId> and
101 C<UserPool> values. To add a Amazon Cognito user group to an existing
102 worker pool, see Adding groups to a User Pool. For more information
103 about user pools, see Amazon Cognito User Pools
104 (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html).
105  
106 For workforces created using your own OIDC IdP, specify the user groups
107 that you want to include in your private work team in
108 C<OidcMemberDefinition> by listing those groups in C<Groups>.
109  
110  
111  
112 =head2 NotificationConfiguration => L<Paws::SageMaker::NotificationConfiguration>
113  
114 Configures notification of workers regarding available or expiring work
115 items.
116  
117  
118  
119 =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>]
120  
121 An array of key-value pairs.
122  
123 For more information, see Resource Tag
124 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
125 and Using Cost Allocation Tags
126 (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what)
127 in the I< Amazon Web Services Billing and Cost Management User Guide>.
128  
129  
130  
131 =head2 WorkforceName => Str
132  
133 The name of the workforce.
134  
135  
136  
137 =head2 B<REQUIRED> WorkteamName => Str
138  
139 The name of the work team. Use this name to identify the work team.
140  
141  
142  
143  
144 =head1 SEE ALSO
145  
146 This class forms part of L<Paws>, documenting arguments for method CreateWorkteam in L<Paws::SageMaker>
147  
148 =head1 BUGS and CONTRIBUTIONS
149  
150 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
151  
152 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
153  
154 =cut
155