NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $comprehend = Paws->service('Comprehend');
    my $StartTopicsDetectionJobResponse = $comprehend->StartTopicsDetectionJob(
      DataAccessRoleArn => 'MyIamRoleArn',
      InputDataConfig   => {
        S3Uri       => 'MyS3Uri',           # max: 1024
        InputFormat => 'ONE_DOC_PER_FILE'
        ,    # values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE; OPTIONAL
      },
      OutputDataConfig => {
        S3Uri => 'MyS3Uri',    # max: 1024

      },
      ClientRequestToken => 'MyClientRequestTokenString',    # OPTIONAL
      JobName            => 'MyJobName',                     # OPTIONAL
      NumberOfTopics     => 1,                               # OPTIONAL
    );

    # Results:
    my $JobId     = $StartTopicsDetectionJobResponse->JobId;
    my $JobStatus = $StartTopicsDetectionJobResponse->JobStatus;

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

ATTRIBUTES

ClientRequestToken => Str

A unique identifier for the request. If you do not 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).

REQUIRED InputDataConfig => Paws::Comprehend::InputDataConfig

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

JobName => Str

The identifier of the job.

NumberOfTopics => Int

The number of topics to detect.

REQUIRED OutputDataConfig => Paws::Comprehend::OutputDataConfig

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

SEE ALSO

This class forms part of Paws, documenting arguments for method StartTopicsDetectionJob 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