| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::Workforce; | ||
| 3 | use Moose; | ||
| 4 | has CognitoConfig => (is => 'ro', isa => 'Paws::SageMaker::CognitoConfig'); | ||
| 5 | has CreateDate => (is => 'ro', isa => 'Str'); | ||
| 6 | has LastUpdatedDate => (is => 'ro', isa => 'Str'); | ||
| 7 | has OidcConfig => (is => 'ro', isa => 'Paws::SageMaker::OidcConfigForResponse'); | ||
| 8 | has SourceIpConfig => (is => 'ro', isa => 'Paws::SageMaker::SourceIpConfig'); | ||
| 9 | has SubDomain => (is => 'ro', isa => 'Str'); | ||
| 10 | has WorkforceArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has WorkforceName => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::SageMaker::Workforce | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::SageMaker::Workforce object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { CognitoConfig => $value, ..., WorkforceName => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::Workforce object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->CognitoConfig | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | A single private workforce, which is automatically created when you | ||
| 44 | create your first private work team. You can create one private work | ||
| 45 | force in each Amazon Web Services Region. By default, any | ||
| 46 | workforce-related API operation used in a specific region will apply to | ||
| 47 | the workforce created in that region. To learn how to create a private | ||
| 48 | workforce, see Create a Private Workforce | ||
| 49 | (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html). | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 CognitoConfig => L<Paws::SageMaker::CognitoConfig> | ||
| 55 | |||
| 56 | The configuration of an Amazon Cognito workforce. A single Cognito | ||
| 57 | workforce is created using and corresponds to a single Amazon Cognito | ||
| 58 | user pool | ||
| 59 | (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). | ||
| 60 | |||
| 61 | |||
| 62 | =head2 CreateDate => Str | ||
| 63 | |||
| 64 | The date that the workforce is created. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 LastUpdatedDate => Str | ||
| 68 | |||
| 69 | The most recent date that was used to successfully add one or more IP | ||
| 70 | address ranges (CIDRs | ||
| 71 | (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)) to | ||
| 72 | a private workforce's allow list. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 OidcConfig => L<Paws::SageMaker::OidcConfigForResponse> | ||
| 76 | |||
| 77 | The configuration of an OIDC Identity Provider (IdP) private workforce. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 SourceIpConfig => L<Paws::SageMaker::SourceIpConfig> | ||
| 81 | |||
| 82 | A list of one to ten IP address ranges (CIDRs | ||
| 83 | (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)) to | ||
| 84 | be added to the workforce allow list. By default, a workforce isn't | ||
| 85 | restricted to specific IP addresses. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 SubDomain => Str | ||
| 89 | |||
| 90 | The subdomain for your OIDC Identity Provider. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> WorkforceArn => Str | ||
| 94 | |||
| 95 | The Amazon Resource Name (ARN) of the private workforce. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 B<REQUIRED> WorkforceName => Str | ||
| 99 | |||
| 100 | The name of the private workforce. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head1 SEE ALSO | ||
| 105 | |||
| 106 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 107 | |||
| 108 | =head1 BUGS and CONTRIBUTIONS | ||
| 109 | |||
| 110 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 111 | |||
| 112 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 113 | |||
| 114 | =cut | ||
| 115 |