class Aws::Comprehend::Types::CreateEntityRecognizerRequest
@note When making an API call, you may pass CreateEntityRecognizerRequest
data as a hash: { recognizer_name: "ComprehendArnName", # required data_access_role_arn: "IamRoleArn", # required tags: [ { key: "TagKey", # required value: "TagValue", }, ], input_data_config: { # required data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST entity_types: [ # required { type: "EntityTypeName", # required }, ], documents: { s3_uri: "S3Uri", # required }, annotations: { s3_uri: "S3Uri", # required }, entity_list: { s3_uri: "S3Uri", # required }, augmented_manifests: [ { s3_uri: "S3Uri", # required attribute_names: ["AttributeNamesListItem"], # required }, ], }, client_request_token: "ClientRequestTokenString", language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW volume_kms_key_id: "KmsKeyId", vpc_config: { security_group_ids: ["SecurityGroupId"], # required subnets: ["SubnetId"], # required }, model_kms_key_id: "KmsKeyId", }
@!attribute [rw] recognizer_name
The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (\_) are allowed. The name must be unique in the account/region. @return [String]
@!attribute [rw] data_access_role_arn
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data. @return [String]
@!attribute [rw] tags
Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. @return [Array<Types::Tag>]
@!attribute [rw] input_data_config
Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created. @return [Types::EntityRecognizerInputDataConfig]
@!attribute [rw] client_request_token
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one. **A suitable default value is auto-generated.** You should normally not need to pass this option. @return [String]
@!attribute [rw] language_code
You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language. @return [String]
@!attribute [rw] volume_kms_key_id
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"` * Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"` @return [String]
@!attribute [rw] vpc_config
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see [Amazon VPC][1]. [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html @return [Types::VpcConfig]
@!attribute [rw] model_kms_key_id
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"` * Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"` @return [String]
@see docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEntityRecognizerRequest AWS API Documentation
Constants
- SENSITIVE