/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Comprehend::CreateDocumentClassifier

NAME

Paws::Comprehend::CreateDocumentClassifier - Arguments for method CreateDocumentClassifier on Paws::Comprehend

DESCRIPTION

This class represents the parameters used for calling the method CreateDocumentClassifier on the Amazon Comprehend service. Use the attributes of this class as arguments to method CreateDocumentClassifier.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDocumentClassifier.

SYNOPSIS

my $comprehend = Paws->service('Comprehend');
my $CreateDocumentClassifierResponse =
  $comprehend->CreateDocumentClassifier(
  DataAccessRoleArn      => 'MyIamRoleArn',
  DocumentClassifierName => 'MyComprehendArnName',
  InputDataConfig        => {
    AugmentedManifests => [
      {
        AttributeNames => [
          'MyAttributeNamesListItem', ...    # min: 1, max: 63
        ],
        S3Uri => 'MyS3Uri',                  # max: 1024

      },
      ...
    ],    # OPTIONAL
    DataFormat => 'COMPREHEND_CSV'
    ,     # values: COMPREHEND_CSV, AUGMENTED_MANIFEST; OPTIONAL
    LabelDelimiter => 'MyLabelDelimiter',    # min: 1, max: 1; OPTIONAL
    S3Uri          => 'MyS3Uri',             # max: 1024
  },
  LanguageCode       => 'en',
  ClientRequestToken => 'MyClientRequestTokenString',    # OPTIONAL
  Mode               => 'MULTI_CLASS',                   # OPTIONAL
  ModelKmsKeyId      => 'MyKmsKeyId',                    # OPTIONAL
  OutputDataConfig   => {
    KmsKeyId => 'MyKmsKeyId',                            # max: 2048
    S3Uri    => 'MyS3Uri',                               # max: 1024
  },    # OPTIONAL
  Tags => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # max: 256; OPTIONAL
    },
    ...
  ],    # OPTIONAL
  VolumeKmsKeyId => 'MyKmsKeyId',    # OPTIONAL
  VpcConfig      => {
    SecurityGroupIds => [
      'MySecurityGroupId', ...       # min: 1, max: 32
    ],    # min: 1, max: 5
    Subnets => [
      'MySubnetId', ...    # min: 1, max: 32
    ],    # min: 1, max: 16

  },    # OPTIONAL
  );

# Results:
my $DocumentClassifierArn =
  $CreateDocumentClassifierResponse->DocumentClassifierArn;

# Returns a L<Paws::Comprehend::CreateDocumentClassifierResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/comprehend/CreateDocumentClassifier

ATTRIBUTES

ClientRequestToken => Str

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

REQUIRED DataAccessRoleArn => Str

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

REQUIRED DocumentClassifierName => Str

The name of the document classifier.

REQUIRED InputDataConfig => Paws::Comprehend::DocumentClassifierInputDataConfig

Specifies the format and location of the input data for the job.

REQUIRED LanguageCode => Str

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.

Valid values are: "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"

Mode => Str

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 (|).

Valid values are: "MULTI_CLASS", "MULTI_LABEL"

ModelKmsKeyId => Str

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"

OutputDataConfig => Paws::Comprehend::DocumentClassifierOutputDataConfig

Enables the addition of output results configuration parameters for custom classifier jobs.

Tags => ArrayRef[Paws::Comprehend::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.

VolumeKmsKeyId => Str

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"

VpcConfig => Paws::Comprehend::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 (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateDocumentClassifier in Paws::Comprehend

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues