« blib/lib/Paws/Comprehend/CreateEndpointResponse.pm
↑ Summary
blib/lib/Paws/Comprehend/CreateEntityRecognizerResponse.pm »
| 1 | |||
| 2 | package Paws::Comprehend::CreateEntityRecognizer; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has DataAccessRoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has InputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::EntityRecognizerInputDataConfig', required => 1); | ||
| 7 | has LanguageCode => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has ModelKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 9 | has RecognizerName => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Comprehend::Tag]'); | ||
| 11 | has VolumeKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 12 | has VpcConfig => (is => 'ro', isa => 'Paws::Comprehend::VpcConfig'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateEntityRecognizer'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Comprehend::CreateEntityRecognizerResponse'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Comprehend::CreateEntityRecognizer - Arguments for method CreateEntityRecognizer on L<Paws::Comprehend> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateEntityRecognizer on the | ||
| 30 | L<Amazon Comprehend|Paws::Comprehend> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateEntityRecognizer. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEntityRecognizer. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $comprehend = Paws->service('Comprehend'); | ||
| 38 | my $CreateEntityRecognizerResponse = $comprehend->CreateEntityRecognizer( | ||
| 39 | DataAccessRoleArn => 'MyIamRoleArn', | ||
| 40 | InputDataConfig => { | ||
| 41 | EntityTypes => [ | ||
| 42 | { | ||
| 43 | Type => 'MyEntityTypeName', # max: 64 | ||
| 44 | |||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], | ||
| 48 | Annotations => { | ||
| 49 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 50 | |||
| 51 | }, # OPTIONAL | ||
| 52 | AugmentedManifests => [ | ||
| 53 | { | ||
| 54 | AttributeNames => [ | ||
| 55 | 'MyAttributeNamesListItem', ... # min: 1, max: 63 | ||
| 56 | ], | ||
| 57 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 58 | |||
| 59 | }, | ||
| 60 | ... | ||
| 61 | ], # OPTIONAL | ||
| 62 | DataFormat => 'COMPREHEND_CSV' | ||
| 63 | , # values: COMPREHEND_CSV, AUGMENTED_MANIFEST; OPTIONAL | ||
| 64 | Documents => { | ||
| 65 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 66 | |||
| 67 | }, # OPTIONAL | ||
| 68 | EntityList => { | ||
| 69 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 70 | |||
| 71 | }, # OPTIONAL | ||
| 72 | }, | ||
| 73 | LanguageCode => 'en', | ||
| 74 | RecognizerName => 'MyComprehendArnName', | ||
| 75 | ClientRequestToken => 'MyClientRequestTokenString', # OPTIONAL | ||
| 76 | ModelKmsKeyId => 'MyKmsKeyId', # OPTIONAL | ||
| 77 | Tags => [ | ||
| 78 | { | ||
| 79 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 80 | Value => 'MyTagValue', # max: 256; OPTIONAL | ||
| 81 | }, | ||
| 82 | ... | ||
| 83 | ], # OPTIONAL | ||
| 84 | VolumeKmsKeyId => 'MyKmsKeyId', # OPTIONAL | ||
| 85 | VpcConfig => { | ||
| 86 | SecurityGroupIds => [ | ||
| 87 | 'MySecurityGroupId', ... # min: 1, max: 32 | ||
| 88 | ], # min: 1, max: 5 | ||
| 89 | Subnets => [ | ||
| 90 | 'MySubnetId', ... # min: 1, max: 32 | ||
| 91 | ], # min: 1, max: 16 | ||
| 92 | |||
| 93 | }, # OPTIONAL | ||
| 94 | ); | ||
| 95 | |||
| 96 | # Results: | ||
| 97 | my $EntityRecognizerArn = | ||
| 98 | $CreateEntityRecognizerResponse->EntityRecognizerArn; | ||
| 99 | |||
| 100 | # Returns a L<Paws::Comprehend::CreateEntityRecognizerResponse> 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/comprehend/CreateEntityRecognizer> | ||
| 104 | |||
| 105 | =head1 ATTRIBUTES | ||
| 106 | |||
| 107 | |||
| 108 | =head2 ClientRequestToken => Str | ||
| 109 | |||
| 110 | A unique identifier for the request. If you don't set the client | ||
| 111 | request token, Amazon Comprehend generates one. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 B<REQUIRED> DataAccessRoleArn => Str | ||
| 116 | |||
| 117 | The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) | ||
| 118 | role that grants Amazon Comprehend read access to your input data. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 B<REQUIRED> InputDataConfig => L<Paws::Comprehend::EntityRecognizerInputDataConfig> | ||
| 123 | |||
| 124 | Specifies the format and location of the input data. The S3 bucket | ||
| 125 | containing the input data must be located in the same region as the | ||
| 126 | entity recognizer being created. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 B<REQUIRED> LanguageCode => Str | ||
| 131 | |||
| 132 | You can specify any of the following languages supported by Amazon | ||
| 133 | Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian | ||
| 134 | ("it"), German ("de"), or Portuguese ("pt"). All documents must be in | ||
| 135 | the same language. | ||
| 136 | |||
| 137 | Valid values are: C<"en">, C<"es">, C<"fr">, C<"de">, C<"it">, C<"pt">, C<"ar">, C<"hi">, C<"ja">, C<"ko">, C<"zh">, C<"zh-TW"> | ||
| 138 | |||
| 139 | =head2 ModelKmsKeyId => Str | ||
| 140 | |||
| 141 | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend | ||
| 142 | uses to encrypt trained custom models. The ModelKmsKeyId can be either | ||
| 143 | of the following formats | ||
| 144 | |||
| 145 | =over | ||
| 146 | |||
| 147 | =item * | ||
| 148 | |||
| 149 | KMS Key ID: C<"1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 150 | |||
| 151 | =item * | ||
| 152 | |||
| 153 | Amazon Resource Name (ARN) of a KMS Key: | ||
| 154 | C<"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 155 | |||
| 156 | =back | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | =head2 B<REQUIRED> RecognizerName => Str | ||
| 162 | |||
| 163 | The name given to the newly created recognizer. Recognizer names can be | ||
| 164 | a maximum of 256 characters. Alphanumeric characters, hyphens (-) and | ||
| 165 | underscores (_) are allowed. The name must be unique in the | ||
| 166 | account/region. | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 Tags => ArrayRef[L<Paws::Comprehend::Tag>] | ||
| 171 | |||
| 172 | Tags to be associated with the entity recognizer being created. A tag | ||
| 173 | is a key-value pair that adds as a metadata to a resource used by | ||
| 174 | Amazon Comprehend. For example, a tag with "Sales" as the key might be | ||
| 175 | added to a resource to indicate its use by the sales department. | ||
| 176 | |||
| 177 | |||
| 178 | |||
| 179 | =head2 VolumeKmsKeyId => Str | ||
| 180 | |||
| 181 | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend | ||
| 182 | uses to encrypt data on the storage volume attached to the ML compute | ||
| 183 | instance(s) that process the analysis job. The VolumeKmsKeyId can be | ||
| 184 | either of the following formats: | ||
| 185 | |||
| 186 | =over | ||
| 187 | |||
| 188 | =item * | ||
| 189 | |||
| 190 | KMS Key ID: C<"1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 191 | |||
| 192 | =item * | ||
| 193 | |||
| 194 | Amazon Resource Name (ARN) of a KMS Key: | ||
| 195 | C<"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 196 | |||
| 197 | =back | ||
| 198 | |||
| 199 | |||
| 200 | |||
| 201 | |||
| 202 | =head2 VpcConfig => L<Paws::Comprehend::VpcConfig> | ||
| 203 | |||
| 204 | Configuration parameters for an optional private Virtual Private Cloud | ||
| 205 | (VPC) containing the resources you are using for your custom entity | ||
| 206 | recognizer. For more information, see Amazon VPC | ||
| 207 | (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). | ||
| 208 | |||
| 209 | |||
| 210 | |||
| 211 | |||
| 212 | =head1 SEE ALSO | ||
| 213 | |||
| 214 | This class forms part of L<Paws>, documenting arguments for method CreateEntityRecognizer in L<Paws::Comprehend> | ||
| 215 | |||
| 216 | =head1 BUGS and CONTRIBUTIONS | ||
| 217 | |||
| 218 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 219 | |||
| 220 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 221 | |||
| 222 | =cut | ||
| 223 |