« blib/lib/Paws/Translate/ImportTerminologyResponse.pm
↑ Summary
blib/lib/Paws/Translate/JobDetails.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Translate::InputDataConfig; | ||
| 3 | use Moose; | ||
| 4 | has ContentType => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has S3Uri => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Translate::InputDataConfig | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Translate::InputDataConfig object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { ContentType => $value, ..., S3Uri => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Translate::InputDataConfig object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->ContentType | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The input configuration properties for requesting a batch translation | ||
| 38 | job. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 B<REQUIRED> ContentType => Str | ||
| 44 | |||
| 45 | Describes the format of the data that you submit to Amazon Translate as | ||
| 46 | input. You can specify one of the following multipurpose internet mail | ||
| 47 | extension (MIME) types: | ||
| 48 | |||
| 49 | =over | ||
| 50 | |||
| 51 | =item * | ||
| 52 | |||
| 53 | C<text/html>: The input data consists of one or more HTML files. Amazon | ||
| 54 | Translate translates only the text that resides in the C<html> element | ||
| 55 | in each file. | ||
| 56 | |||
| 57 | =item * | ||
| 58 | |||
| 59 | C<text/plain>: The input data consists of one or more unformatted text | ||
| 60 | files. Amazon Translate translates every character in this type of | ||
| 61 | input. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | C<application/vnd.openxmlformats-officedocument.wordprocessingml.document>: | ||
| 66 | The input data consists of one or more Word documents (.docx). | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | C<application/vnd.openxmlformats-officedocument.presentationml.presentation>: | ||
| 71 | The input data consists of one or more PowerPoint Presentation files | ||
| 72 | (.pptx). | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<application/vnd.openxmlformats-officedocument.spreadsheetml.sheet>: | ||
| 77 | The input data consists of one or more Excel Workbook files (.xlsx). | ||
| 78 | |||
| 79 | =back | ||
| 80 | |||
| 81 | If you structure your input data as HTML, ensure that you set this | ||
| 82 | parameter to C<text/html>. By doing so, you cut costs by limiting the | ||
| 83 | translation to the contents of the C<html> element in each file. | ||
| 84 | Otherwise, if you set this parameter to C<text/plain>, your costs will | ||
| 85 | cover the translation of every character. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> S3Uri => Str | ||
| 89 | |||
| 90 | The URI of the AWS S3 folder that contains the input file. The folder | ||
| 91 | must be in the same Region as the API endpoint you are calling. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, describing an object used in L<Paws::Translate> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |