class Aws::Comprehend::Types::CreateDocumentClassifierRequest

@note When making an API call, you may pass CreateDocumentClassifierRequest

data as a hash:

    {
      document_classifier_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
        s3_uri: "S3Uri",
        label_delimiter: "LabelDelimiter",
        augmented_manifests: [
          {
            s3_uri: "S3Uri", # required
            attribute_names: ["AttributeNamesListItem"], # required
          },
        ],
      },
      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",
    }

@!attribute [rw] document_classifier_name

The name of the document classifier.
@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 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.
@return [Array<Types::Tag>]

@!attribute [rw] input_data_config

Specifies the format and location of the input data for the job.
@return [Types::DocumentClassifierInputDataConfig]

@!attribute [rw] output_data_config

Enables the addition of output results configuration parameters for
custom classifier jobs.
@return [Types::DocumentClassifierOutputDataConfig]

@!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

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.
@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
classifier. 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] mode

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 (\|).
@return [String]

@!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/CreateDocumentClassifierRequest AWS API Documentation

Constants

SENSITIVE