NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $comprehend = Paws->service('Comprehend');
    my $StartEventsDetectionJobResponse = $comprehend->StartEventsDetectionJob(
      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
      },
      TargetEventTypes => [
        'MyEventTypeString', ...     # min: 1, max: 40
      ],
      ClientRequestToken => 'MyClientRequestTokenString',    # OPTIONAL
      JobName            => 'MyJobName',                     # OPTIONAL
    );
    # Results:
    my $JobId     = $StartEventsDetectionJobResponse->JobId;
    my $JobStatus = $StartEventsDetectionJobResponse->JobStatus;
    # Returns a L<Paws::Comprehend::StartEventsDetectionJobResponse> 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/StartEventsDetectionJob>

ATTRIBUTES

ClientRequestToken => Str

An 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.

REQUIRED InputDataConfig => Paws::Comprehend::InputDataConfig

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

JobName => Str

The identifier of the events detection job.

REQUIRED LanguageCode => Str

The language code of the input documents.

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.

REQUIRED TargetEventTypes => ArrayRef[Str|Undef]

The types of events to detect in the input documents.

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>