« blib/lib/Paws/Translate/ParallelDataProperties.pm
↑ Summary
blib/lib/Paws/Translate/StartTextTranslationJobResponse.pm »
| 1 | |||
| 2 | package Paws::Translate::StartTextTranslationJob; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DataAccessRoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has InputDataConfig => (is => 'ro', isa => 'Paws::Translate::InputDataConfig', required => 1); | ||
| 7 | has JobName => (is => 'ro', isa => 'Str'); | ||
| 8 | has OutputDataConfig => (is => 'ro', isa => 'Paws::Translate::OutputDataConfig', required => 1); | ||
| 9 | has ParallelDataNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has SourceLanguageCode => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has TargetLanguageCodes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 12 | has TerminologyNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartTextTranslationJob'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Translate::StartTextTranslationJobResponse'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Translate::StartTextTranslationJob - Arguments for method StartTextTranslationJob on L<Paws::Translate> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method StartTextTranslationJob on the | ||
| 30 | L<Amazon Translate|Paws::Translate> service. Use the attributes of this class | ||
| 31 | as arguments to method StartTextTranslationJob. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartTextTranslationJob. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $translate = Paws->service('Translate'); | ||
| 38 | my $StartTextTranslationJobResponse = $translate->StartTextTranslationJob( | ||
| 39 | ClientToken => 'MyClientTokenString', | ||
| 40 | DataAccessRoleArn => 'MyIamRoleArn', | ||
| 41 | InputDataConfig => { | ||
| 42 | ContentType => 'MyContentType', # max: 256 | ||
| 43 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 44 | |||
| 45 | }, | ||
| 46 | OutputDataConfig => { | ||
| 47 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 48 | |||
| 49 | }, | ||
| 50 | SourceLanguageCode => 'MyLanguageCodeString', | ||
| 51 | TargetLanguageCodes => [ | ||
| 52 | 'MyLanguageCodeString', ... # min: 2, max: 5 | ||
| 53 | ], | ||
| 54 | JobName => 'MyJobName', # OPTIONAL | ||
| 55 | ParallelDataNames => [ | ||
| 56 | 'MyResourceName', ... # min: 1, max: 256 | ||
| 57 | ], # OPTIONAL | ||
| 58 | TerminologyNames => [ | ||
| 59 | 'MyResourceName', ... # min: 1, max: 256 | ||
| 60 | ], # OPTIONAL | ||
| 61 | ); | ||
| 62 | |||
| 63 | # Results: | ||
| 64 | my $JobId = $StartTextTranslationJobResponse->JobId; | ||
| 65 | my $JobStatus = $StartTextTranslationJobResponse->JobStatus; | ||
| 66 | |||
| 67 | # Returns a L<Paws::Translate::StartTextTranslationJobResponse> object. | ||
| 68 | |||
| 69 | 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. | ||
| 70 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/translate/StartTextTranslationJob> | ||
| 71 | |||
| 72 | =head1 ATTRIBUTES | ||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> ClientToken => Str | ||
| 76 | |||
| 77 | A unique identifier for the request. This token is auto-generated when | ||
| 78 | using the Amazon Translate SDK. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> DataAccessRoleArn => Str | ||
| 83 | |||
| 84 | The Amazon Resource Name (ARN) of an AWS Identity Access and Management | ||
| 85 | (IAM) role that grants Amazon Translate read access to your input data. | ||
| 86 | For more nformation, see identity-and-access-management. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> InputDataConfig => L<Paws::Translate::InputDataConfig> | ||
| 91 | |||
| 92 | Specifies the format and S3 location of the input documents for the | ||
| 93 | translation job. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 JobName => Str | ||
| 98 | |||
| 99 | The name of the batch translation job to be performed. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 B<REQUIRED> OutputDataConfig => L<Paws::Translate::OutputDataConfig> | ||
| 104 | |||
| 105 | Specifies the S3 folder to which your job output will be saved. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 ParallelDataNames => ArrayRef[Str|Undef] | ||
| 110 | |||
| 111 | The names of the parallel data resources to use in the batch | ||
| 112 | translation job. For a list of available parallel data resources, use | ||
| 113 | the ListParallelData operation. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 B<REQUIRED> SourceLanguageCode => Str | ||
| 118 | |||
| 119 | The language code of the input language. For a list of language codes, | ||
| 120 | see what-is-languages. | ||
| 121 | |||
| 122 | Amazon Translate does not automatically detect a source language during | ||
| 123 | batch translation jobs. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 B<REQUIRED> TargetLanguageCodes => ArrayRef[Str|Undef] | ||
| 128 | |||
| 129 | The language code of the output language. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 TerminologyNames => ArrayRef[Str|Undef] | ||
| 134 | |||
| 135 | The name of the terminology to use in the batch translation job. For a | ||
| 136 | list of available terminologies, use the ListTerminologies operation. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head1 SEE ALSO | ||
| 142 | |||
| 143 | This class forms part of L<Paws>, documenting arguments for method StartTextTranslationJob in L<Paws::Translate> | ||
| 144 | |||
| 145 | =head1 BUGS and CONTRIBUTIONS | ||
| 146 | |||
| 147 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 148 | |||
| 149 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 150 | |||
| 151 | =cut | ||
| 152 |