« blib/lib/Paws/Transcribe/CreateVocabulary.pm
↑ Summary
blib/lib/Paws/Transcribe/CreateVocabularyFilterResponse.pm »
| 1 | |||
| 2 | package Paws::Transcribe::CreateVocabularyFilter; | ||
| 3 | use Moose; | ||
| 4 | has LanguageCode => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has VocabularyFilterFileUri => (is => 'ro', isa => 'Str'); | ||
| 6 | has VocabularyFilterName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Words => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateVocabularyFilter'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Transcribe::CreateVocabularyFilterResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Transcribe::CreateVocabularyFilter - Arguments for method CreateVocabularyFilter on L<Paws::Transcribe> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateVocabularyFilter on the | ||
| 25 | L<Amazon Transcribe Service|Paws::Transcribe> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateVocabularyFilter. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateVocabularyFilter. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $transcribe = Paws->service('Transcribe'); | ||
| 33 | my $CreateVocabularyFilterResponse = $transcribe->CreateVocabularyFilter( | ||
| 34 | LanguageCode => 'af-ZA', | ||
| 35 | VocabularyFilterName => 'MyVocabularyFilterName', | ||
| 36 | VocabularyFilterFileUri => 'MyUri', # OPTIONAL | ||
| 37 | Words => [ | ||
| 38 | 'MyWord', ... # min: 1, max: 256 | ||
| 39 | ], # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $LanguageCode = $CreateVocabularyFilterResponse->LanguageCode; | ||
| 44 | my $LastModifiedTime = $CreateVocabularyFilterResponse->LastModifiedTime; | ||
| 45 | my $VocabularyFilterName = | ||
| 46 | $CreateVocabularyFilterResponse->VocabularyFilterName; | ||
| 47 | |||
| 48 | # Returns a L<Paws::Transcribe::CreateVocabularyFilterResponse> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/transcribe/CreateVocabularyFilter> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> LanguageCode => Str | ||
| 57 | |||
| 58 | The language code of the words in the vocabulary filter. All words in | ||
| 59 | the filter must be in the same language. The vocabulary filter can only | ||
| 60 | be used with transcription jobs in the specified language. | ||
| 61 | |||
| 62 | Valid values are: C<"af-ZA">, C<"ar-AE">, C<"ar-SA">, C<"cy-GB">, C<"da-DK">, C<"de-CH">, C<"de-DE">, C<"en-AB">, C<"en-AU">, C<"en-GB">, C<"en-IE">, C<"en-IN">, C<"en-US">, C<"en-WL">, C<"es-ES">, C<"es-US">, C<"fa-IR">, C<"fr-CA">, C<"fr-FR">, C<"ga-IE">, C<"gd-GB">, C<"he-IL">, C<"hi-IN">, C<"id-ID">, C<"it-IT">, C<"ja-JP">, C<"ko-KR">, C<"ms-MY">, C<"nl-NL">, C<"pt-BR">, C<"pt-PT">, C<"ru-RU">, C<"ta-IN">, C<"te-IN">, C<"tr-TR">, C<"zh-CN"> | ||
| 63 | |||
| 64 | =head2 VocabularyFilterFileUri => Str | ||
| 65 | |||
| 66 | The Amazon S3 location of a text file used as input to create the | ||
| 67 | vocabulary filter. Only use characters from the character set defined | ||
| 68 | for custom vocabularies. For a list of character sets, see Character | ||
| 69 | Sets for Custom Vocabularies | ||
| 70 | (https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html#charsets). | ||
| 71 | |||
| 72 | The specified file must be less than 50 KB of UTF-8 characters. | ||
| 73 | |||
| 74 | If you provide the location of a list of words in the | ||
| 75 | C<VocabularyFilterFileUri> parameter, you can't use the C<Words> | ||
| 76 | parameter. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> VocabularyFilterName => Str | ||
| 81 | |||
| 82 | The vocabulary filter name. The name must be unique within the account | ||
| 83 | that contains it. If you try to create a vocabulary filter with the | ||
| 84 | same name as another vocabulary filter, you get a C<ConflictException> | ||
| 85 | error. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 Words => ArrayRef[Str|Undef] | ||
| 90 | |||
| 91 | The words to use in the vocabulary filter. Only use characters from the | ||
| 92 | character set defined for custom vocabularies. For a list of character | ||
| 93 | sets, see Character Sets for Custom Vocabularies | ||
| 94 | (https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html#charsets). | ||
| 95 | |||
| 96 | If you provide a list of words in the C<Words> parameter, you can't use | ||
| 97 | the C<VocabularyFilterFileUri> parameter. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head1 SEE ALSO | ||
| 103 | |||
| 104 | This class forms part of L<Paws>, documenting arguments for method CreateVocabularyFilter in L<Paws::Transcribe> | ||
| 105 | |||
| 106 | =head1 BUGS and CONTRIBUTIONS | ||
| 107 | |||
| 108 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 109 | |||
| 110 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 111 | |||
| 112 | =cut | ||
| 113 |