Class: Aws::Comprehend::Types::CreateEntityRecognizerRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::CreateEntityRecognizerRequest
- Defined in:
- gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb
Overview
When making an API call, you may pass CreateEntityRecognizerRequest data as a hash:
{
recognizer_name: "ComprehendArnName", # required
version_name: "VersionName",
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
test_s3_uri: "S3Uri",
input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
},
annotations: {
s3_uri: "S3Uri", # required
test_s3_uri: "S3Uri",
},
entity_list: {
s3_uri: "S3Uri", # required
},
augmented_manifests: [
{
s3_uri: "S3Uri", # required
split: "TRAIN", # accepts TRAIN, TEST
attribute_names: ["AttributeNamesListItem"], # required
annotation_data_s3_uri: "S3Uri",
source_documents_s3_uri: "S3Uri",
document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
},
],
},
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",
model_policy: "Policy",
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
A unique identifier for the request.
-
#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
-
#input_data_config ⇒ Types::EntityRecognizerInputDataConfig
Specifies the format and location of the input data.
-
#language_code ⇒ String
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").
-
#model_kms_key_id ⇒ String
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models.
-
#model_policy ⇒ String
The JSON resource-based policy to attach to your custom entity recognizer model.
-
#recognizer_name ⇒ String
The name given to the newly created recognizer.
-
#tags ⇒ Array<Types::Tag>
Tags to be associated with the entity recognizer being created.
-
#version_name ⇒ String
The version name given to the newly created recognizer.
-
#volume_kms_key_id ⇒ String
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.
-
#vpc_config ⇒ Types::VpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer.
Instance Attribute Details
#client_request_token ⇒ String
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.
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1156 class CreateEntityRecognizerRequest < Struct.new( :recognizer_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1156 class CreateEntityRecognizerRequest < Struct.new( :recognizer_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#input_data_config ⇒ Types::EntityRecognizerInputDataConfig
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.
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1156 class CreateEntityRecognizerRequest < Struct.new( :recognizer_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#language_code ⇒ String
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.
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1156 class CreateEntityRecognizerRequest < Struct.new( :recognizer_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#model_kms_key_id ⇒ String
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"
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1156 class CreateEntityRecognizerRequest < Struct.new( :recognizer_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#model_policy ⇒ String
The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another AWS account to import your custom model.
Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"\{"attribute": "value", "attribute": ["value"]\}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
'\{"attribute": "value", "attribute": ["value"]\}'
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1156 class CreateEntityRecognizerRequest < Struct.new( :recognizer_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#recognizer_name ⇒ String
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.
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1156 class CreateEntityRecognizerRequest < Struct.new( :recognizer_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
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.
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1156 class CreateEntityRecognizerRequest < Struct.new( :recognizer_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#version_name ⇒ String
The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1156 class CreateEntityRecognizerRequest < Struct.new( :recognizer_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#volume_kms_key_id ⇒ String
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"
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1156 class CreateEntityRecognizerRequest < Struct.new( :recognizer_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#vpc_config ⇒ Types::VpcConfig
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.
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1156 class CreateEntityRecognizerRequest < Struct.new( :recognizer_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |