« blib/lib/Paws/Comprehend/StartEntitiesDetectionJobResponse.pm
↑ Summary
blib/lib/Paws/Comprehend/StartEventsDetectionJobResponse.pm »
| 1 | |||
| 2 | package Paws::Comprehend::StartEventsDetectionJob; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has DataAccessRoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has InputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::InputDataConfig', required => 1); | ||
| 7 | has JobName => (is => 'ro', isa => 'Str'); | ||
| 8 | has LanguageCode => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has OutputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::OutputDataConfig', required => 1); | ||
| 10 | has TargetEventTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartEventsDetectionJob'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Comprehend::StartEventsDetectionJobResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Comprehend::StartEventsDetectionJob - Arguments for method StartEventsDetectionJob on L<Paws::Comprehend> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method StartEventsDetectionJob on the | ||
| 28 | L<Amazon Comprehend|Paws::Comprehend> service. Use the attributes of this class | ||
| 29 | as arguments to method StartEventsDetectionJob. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartEventsDetectionJob. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $comprehend = Paws->service('Comprehend'); | ||
| 36 | my $StartEventsDetectionJobResponse = $comprehend->StartEventsDetectionJob( | ||
| 37 | DataAccessRoleArn => 'MyIamRoleArn', | ||
| 38 | InputDataConfig => { | ||
| 39 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 40 | InputFormat => 'ONE_DOC_PER_FILE' | ||
| 41 | , # values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE; OPTIONAL | ||
| 42 | }, | ||
| 43 | LanguageCode => 'en', | ||
| 44 | OutputDataConfig => { | ||
| 45 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 46 | KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 47 | }, | ||
| 48 | TargetEventTypes => [ | ||
| 49 | 'MyEventTypeString', ... # min: 1, max: 40 | ||
| 50 | ], | ||
| 51 | ClientRequestToken => 'MyClientRequestTokenString', # OPTIONAL | ||
| 52 | JobName => 'MyJobName', # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $JobId = $StartEventsDetectionJobResponse->JobId; | ||
| 57 | my $JobStatus = $StartEventsDetectionJobResponse->JobStatus; | ||
| 58 | |||
| 59 | # Returns a L<Paws::Comprehend::StartEventsDetectionJobResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/comprehend/StartEventsDetectionJob> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 ClientRequestToken => Str | ||
| 68 | |||
| 69 | An unique identifier for the request. If you don't set the client | ||
| 70 | request token, Amazon Comprehend generates one. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> DataAccessRoleArn => Str | ||
| 75 | |||
| 76 | The Amazon Resource Name (ARN) of the AWS Identity and Access | ||
| 77 | Management (IAM) role that grants Amazon Comprehend read access to your | ||
| 78 | input data. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> InputDataConfig => L<Paws::Comprehend::InputDataConfig> | ||
| 83 | |||
| 84 | Specifies the format and location of the input data for the job. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 JobName => Str | ||
| 89 | |||
| 90 | The identifier of the events detection job. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> LanguageCode => Str | ||
| 95 | |||
| 96 | The language code of the input documents. | ||
| 97 | |||
| 98 | Valid values are: C<"en">, C<"es">, C<"fr">, C<"de">, C<"it">, C<"pt">, C<"ar">, C<"hi">, C<"ja">, C<"ko">, C<"zh">, C<"zh-TW"> | ||
| 99 | |||
| 100 | =head2 B<REQUIRED> OutputDataConfig => L<Paws::Comprehend::OutputDataConfig> | ||
| 101 | |||
| 102 | Specifies where to send the output files. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 B<REQUIRED> TargetEventTypes => ArrayRef[Str|Undef] | ||
| 107 | |||
| 108 | The types of events to detect in the input documents. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head1 SEE ALSO | ||
| 114 | |||
| 115 | This class forms part of L<Paws>, documenting arguments for method StartEventsDetectionJob in L<Paws::Comprehend> | ||
| 116 | |||
| 117 | =head1 BUGS and CONTRIBUTIONS | ||
| 118 | |||
| 119 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 120 | |||
| 121 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 122 | |||
| 123 | =cut | ||
| 124 |