« blib/lib/Paws/SageMaker/CreateUserProfileResponse.pm
↑ Summary
blib/lib/Paws/SageMaker/CreateWorkforceResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::CreateWorkforce; | ||
| 3 | use Moose; | ||
| 4 | has CognitoConfig => (is => 'ro', isa => 'Paws::SageMaker::CognitoConfig'); | ||
| 5 | has OidcConfig => (is => 'ro', isa => 'Paws::SageMaker::OidcConfig'); | ||
| 6 | has SourceIpConfig => (is => 'ro', isa => 'Paws::SageMaker::SourceIpConfig'); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 8 | has WorkforceName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateWorkforce'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateWorkforceResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::SageMaker::CreateWorkforce - Arguments for method CreateWorkforce on L<Paws::SageMaker> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateWorkforce on the | ||
| 26 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateWorkforce. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateWorkforce. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 34 | my $CreateWorkforceResponse = $api . sagemaker->CreateWorkforce( | ||
| 35 | WorkforceName => 'MyWorkforceName', | ||
| 36 | CognitoConfig => { | ||
| 37 | ClientId => 'MyClientId', # min: 1, max: 1024 | ||
| 38 | UserPool => 'MyCognitoUserPool', # min: 1, max: 55 | ||
| 39 | |||
| 40 | }, # OPTIONAL | ||
| 41 | OidcConfig => { | ||
| 42 | AuthorizationEndpoint => 'MyOidcEndpoint', # max: 500 | ||
| 43 | ClientId => 'MyClientId', # min: 1, max: 1024 | ||
| 44 | ClientSecret => 'MyClientSecret', # min: 1, max: 1024 | ||
| 45 | Issuer => 'MyOidcEndpoint', # max: 500 | ||
| 46 | JwksUri => 'MyOidcEndpoint', # max: 500 | ||
| 47 | LogoutEndpoint => 'MyOidcEndpoint', # max: 500 | ||
| 48 | TokenEndpoint => 'MyOidcEndpoint', # max: 500 | ||
| 49 | UserInfoEndpoint => 'MyOidcEndpoint', # max: 500 | ||
| 50 | |||
| 51 | }, # OPTIONAL | ||
| 52 | SourceIpConfig => { | ||
| 53 | Cidrs => [ | ||
| 54 | 'MyCidr', ... # min: 4, max: 64 | ||
| 55 | ], | ||
| 56 | |||
| 57 | }, # OPTIONAL | ||
| 58 | Tags => [ | ||
| 59 | { | ||
| 60 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 61 | Value => 'MyTagValue', # max: 256 | ||
| 62 | |||
| 63 | }, | ||
| 64 | ... | ||
| 65 | ], # OPTIONAL | ||
| 66 | ); | ||
| 67 | |||
| 68 | # Results: | ||
| 69 | my $WorkforceArn = $CreateWorkforceResponse->WorkforceArn; | ||
| 70 | |||
| 71 | # Returns a L<Paws::SageMaker::CreateWorkforceResponse> object. | ||
| 72 | |||
| 73 | 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. | ||
| 74 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateWorkforce> | ||
| 75 | |||
| 76 | =head1 ATTRIBUTES | ||
| 77 | |||
| 78 | |||
| 79 | =head2 CognitoConfig => L<Paws::SageMaker::CognitoConfig> | ||
| 80 | |||
| 81 | Use this parameter to configure an Amazon Cognito private workforce. A | ||
| 82 | single Cognito workforce is created using and corresponds to a single | ||
| 83 | Amazon Cognito user pool | ||
| 84 | (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). | ||
| 85 | |||
| 86 | Do not use C<OidcConfig> if you specify values for C<CognitoConfig>. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 OidcConfig => L<Paws::SageMaker::OidcConfig> | ||
| 91 | |||
| 92 | Use this parameter to configure a private workforce using your own OIDC | ||
| 93 | Identity Provider. | ||
| 94 | |||
| 95 | Do not use C<CognitoConfig> if you specify values for C<OidcConfig>. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 SourceIpConfig => L<Paws::SageMaker::SourceIpConfig> | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 106 | |||
| 107 | An array of key-value pairs that contain metadata to help you | ||
| 108 | categorize and organize our workforce. Each tag consists of a key and a | ||
| 109 | value, both of which you define. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> WorkforceName => Str | ||
| 114 | |||
| 115 | The name of the private workforce. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head1 SEE ALSO | ||
| 121 | |||
| 122 | This class forms part of L<Paws>, documenting arguments for method CreateWorkforce in L<Paws::SageMaker> | ||
| 123 | |||
| 124 | =head1 BUGS and CONTRIBUTIONS | ||
| 125 | |||
| 126 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 127 | |||
| 128 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 129 | |||
| 130 | =cut | ||
| 131 |