« blib/lib/Paws/SageMaker/UpdateWorkforceResponse.pm
↑ Summary
blib/lib/Paws/SageMaker/UpdateWorkteamResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::UpdateWorkteam; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has MemberDefinitions => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::MemberDefinition]'); | ||
| 6 | has NotificationConfiguration => (is => 'ro', isa => 'Paws::SageMaker::NotificationConfiguration'); | ||
| 7 | has WorkteamName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateWorkteam'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::UpdateWorkteamResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::SageMaker::UpdateWorkteam - Arguments for method UpdateWorkteam on L<Paws::SageMaker> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method UpdateWorkteam on the | ||
| 25 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 26 | as arguments to method UpdateWorkteam. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateWorkteam. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 33 | my $UpdateWorkteamResponse = $api . sagemaker->UpdateWorkteam( | ||
| 34 | WorkteamName => 'MyWorkteamName', | ||
| 35 | Description => 'MyString200', # OPTIONAL | ||
| 36 | MemberDefinitions => [ | ||
| 37 | { | ||
| 38 | CognitoMemberDefinition => { | ||
| 39 | ClientId => 'MyClientId', # min: 1, max: 1024 | ||
| 40 | UserGroup => 'MyCognitoUserGroup', # min: 1, max: 128 | ||
| 41 | UserPool => 'MyCognitoUserPool', # min: 1, max: 55 | ||
| 42 | |||
| 43 | }, # OPTIONAL | ||
| 44 | OidcMemberDefinition => { | ||
| 45 | Groups => [ | ||
| 46 | 'MyGroup', ... # min: 1, max: 63 | ||
| 47 | ], # min: 1, max: 10 | ||
| 48 | |||
| 49 | }, # OPTIONAL | ||
| 50 | }, | ||
| 51 | ... | ||
| 52 | ], # OPTIONAL | ||
| 53 | NotificationConfiguration => { | ||
| 54 | NotificationTopicArn => 'MyNotificationTopicArn', # OPTIONAL | ||
| 55 | }, # OPTIONAL | ||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $Workteam = $UpdateWorkteamResponse->Workteam; | ||
| 60 | |||
| 61 | # Returns a L<Paws::SageMaker::UpdateWorkteamResponse> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/UpdateWorkteam> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Description => Str | ||
| 70 | |||
| 71 | An updated description for the work team. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 MemberDefinitions => ArrayRef[L<Paws::SageMaker::MemberDefinition>] | ||
| 76 | |||
| 77 | A list of C<MemberDefinition> objects that contains objects that | ||
| 78 | identify the workers that make up the work team. | ||
| 79 | |||
| 80 | Workforces can be created using Amazon Cognito or your own OIDC | ||
| 81 | Identity Provider (IdP). For private workforces created using Amazon | ||
| 82 | Cognito use C<CognitoMemberDefinition>. For workforces created using | ||
| 83 | your own OIDC identity provider (IdP) use C<OidcMemberDefinition>. You | ||
| 84 | should not provide input for both of these parameters in a single | ||
| 85 | request. | ||
| 86 | |||
| 87 | For workforces created using Amazon Cognito, private work teams | ||
| 88 | correspond to Amazon Cognito I<user groups> within the user pool used | ||
| 89 | to create a workforce. All of the C<CognitoMemberDefinition> objects | ||
| 90 | that make up the member definition must have the same C<ClientId> and | ||
| 91 | C<UserPool> values. To add a Amazon Cognito user group to an existing | ||
| 92 | worker pool, see Adding groups to a User Pool. For more information | ||
| 93 | about user pools, see Amazon Cognito User Pools | ||
| 94 | (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). | ||
| 95 | |||
| 96 | For workforces created using your own OIDC IdP, specify the user groups | ||
| 97 | that you want to include in your private work team in | ||
| 98 | C<OidcMemberDefinition> by listing those groups in C<Groups>. Be aware | ||
| 99 | that user groups that are already in the work team must also be listed | ||
| 100 | in C<Groups> when you make this request to remain on the work team. If | ||
| 101 | you do not include these user groups, they will no longer be associated | ||
| 102 | with the work team you update. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 NotificationConfiguration => L<Paws::SageMaker::NotificationConfiguration> | ||
| 107 | |||
| 108 | Configures SNS topic notifications for available or expiring work items | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 B<REQUIRED> WorkteamName => Str | ||
| 113 | |||
| 114 | The name of the work team to update. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head1 SEE ALSO | ||
| 120 | |||
| 121 | This class forms part of L<Paws>, documenting arguments for method UpdateWorkteam in L<Paws::SageMaker> | ||
| 122 | |||
| 123 | =head1 BUGS and CONTRIBUTIONS | ||
| 124 | |||
| 125 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 126 | |||
| 127 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 128 | |||
| 129 | =cut | ||
| 130 |