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


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

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


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

    # Returns a L<Paws::Comprehend::StartKeyPhrasesDetectionJobResponse> 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


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 (

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. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.

Valid values are: "en", "es", "fr", "de", "it", "pt"

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 key phrases detection job. For more information, see Amazon VPC (


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


The source code is located here:

Please report bugs to: