Class: Aws::Comprehend::Types::CreateDocumentClassifierRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::CreateDocumentClassifierRequest
- Defined in:
- gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb
Overview
When making an API call, you may pass CreateDocumentClassifierRequest data as a hash:
{
document_classifier_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
s3_uri: "S3Uri",
test_s3_uri: "S3Uri",
label_delimiter: "LabelDelimiter",
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
},
],
},
output_data_config: {
s3_uri: "S3Uri",
kms_key_id: "KmsKeyId",
},
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
},
mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
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.
-
#document_classifier_name ⇒ String
The name of the document classifier.
-
#input_data_config ⇒ Types::DocumentClassifierInputDataConfig
Specifies the format and location of the input data for the job.
-
#language_code ⇒ String
The language of the input documents.
-
#mode ⇒ String
Indicates the mode in which the classifier will be trained.
-
#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 resource-based policy to attach to your custom document classifier model.
-
#output_data_config ⇒ Types::DocumentClassifierOutputDataConfig
Enables the addition of output results configuration parameters for custom classifier jobs.
-
#tags ⇒ Array<Types::Tag>
Tags to be associated with the document classifier being created.
-
#version_name ⇒ String
The version name given to the newly created classifier.
-
#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 classifier.
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.
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :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.
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#document_classifier_name ⇒ String
The name of the document classifier.
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#input_data_config ⇒ Types::DocumentClassifierInputDataConfig
Specifies the format and location of the input data for the job.
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#language_code ⇒ String
The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#mode ⇒ String
Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :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"
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#model_policy ⇒ String
The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.
Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, 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"]\}'
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#output_data_config ⇒ Types::DocumentClassifierOutputDataConfig
Enables the addition of output results configuration parameters for custom classifier jobs.
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
Tags to be associated with the document classifier 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.
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |
#version_name ⇒ String
The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :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"
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :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 classifier. For more information, see Amazon VPC.
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 886 class CreateDocumentClassifierRequest < Struct.new( :document_classifier_name, :version_name, :data_access_role_arn, :tags, :input_data_config, :output_data_config, :client_request_token, :language_code, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :model_policy) SENSITIVE = [] include Aws::Structure end |