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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $comprehend = Paws->service('Comprehend');
my $StartEntitiesDetectionJobResponse =
  $comprehend->StartEntitiesDetectionJob(
  DataAccessRoleArn => 'MyIamRoleArn',
  InputDataConfig   => {
    S3Uri       => 'MyS3Uri',           # max: 1024
    InputFormat => 'ONE_DOC_PER_FILE'
    ,    # values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE; OPTIONAL
  },
  LanguageCode     => 'en',
  OutputDataConfig => {
    S3Uri    => 'MyS3Uri',       # max: 1024
    KmsKeyId => 'MyKmsKeyId',    # max: 2048; OPTIONAL
  },
  ClientRequestToken  => 'MyClientRequestTokenString',    # OPTIONAL
  EntityRecognizerArn => 'MyEntityRecognizerArn',         # OPTIONAL
  JobName             => 'MyJobName',                     # 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 $JobId     = $StartEntitiesDetectionJobResponse->JobId;
my $JobStatus = $StartEntitiesDetectionJobResponse->JobStatus;

# Returns a L<Paws::Comprehend::StartEntitiesDetectionJobResponse> 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/StartEntitiesDetectionJob

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 Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).

EntityRecognizerArn => Str

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

REQUIRED InputDataConfig => Paws::Comprehend::InputDataConfig

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

JobName => Str

The identifier of the job.

REQUIRED LanguageCode => Str

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

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

REQUIRED OutputDataConfig => Paws::Comprehend::OutputDataConfig

Specifies where to send the output files.

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 entity detection job. 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 StartEntitiesDetectionJob 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