« blib/lib/Paws/Transcribe/UpdateMedicalVocabularyResponse.pm
↑ Summary
blib/lib/Paws/Transcribe/UpdateVocabularyFilter.pm »
| 1 | |||
| 2 | package Paws::Transcribe::UpdateVocabulary; | ||
| 3 | use Moose; | ||
| 4 | has LanguageCode => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Phrases => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has VocabularyFileUri => (is => 'ro', isa => 'Str'); | ||
| 7 | has VocabularyName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateVocabulary'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Transcribe::UpdateVocabularyResponse'); | ||
| 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::UpdateVocabulary - Arguments for method UpdateVocabulary on L<Paws::Transcribe> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method UpdateVocabulary on the | ||
| 25 | L<Amazon Transcribe Service|Paws::Transcribe> service. Use the attributes of this class | ||
| 26 | as arguments to method UpdateVocabulary. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateVocabulary. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $transcribe = Paws->service('Transcribe'); | ||
| 33 | my $UpdateVocabularyResponse = $transcribe->UpdateVocabulary( | ||
| 34 | LanguageCode => 'af-ZA', | ||
| 35 | VocabularyName => 'MyVocabularyName', | ||
| 36 | Phrases => [ | ||
| 37 | 'MyPhrase', ... # max: 256 | ||
| 38 | ], # OPTIONAL | ||
| 39 | VocabularyFileUri => 'MyUri', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $LanguageCode = $UpdateVocabularyResponse->LanguageCode; | ||
| 44 | my $LastModifiedTime = $UpdateVocabularyResponse->LastModifiedTime; | ||
| 45 | my $VocabularyName = $UpdateVocabularyResponse->VocabularyName; | ||
| 46 | my $VocabularyState = $UpdateVocabularyResponse->VocabularyState; | ||
| 47 | |||
| 48 | # Returns a L<Paws::Transcribe::UpdateVocabularyResponse> 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/UpdateVocabulary> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> LanguageCode => Str | ||
| 57 | |||
| 58 | The language code of the vocabulary entries. For a list of languages | ||
| 59 | and their corresponding language codes, see what-is-transcribe. | ||
| 60 | |||
| 61 | 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"> | ||
| 62 | |||
| 63 | =head2 Phrases => ArrayRef[Str|Undef] | ||
| 64 | |||
| 65 | An array of strings containing the vocabulary entries. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 VocabularyFileUri => Str | ||
| 70 | |||
| 71 | The S3 location of the text file that contains the definition of the | ||
| 72 | custom vocabulary. The URI must be in the same region as the API | ||
| 73 | endpoint that you are calling. The general form is | ||
| 74 | |||
| 75 | For example: | ||
| 76 | |||
| 77 | For more information about S3 object names, see Object Keys | ||
| 78 | (http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys) | ||
| 79 | in the I<Amazon S3 Developer Guide>. | ||
| 80 | |||
| 81 | For more information about custom vocabularies, see Custom Vocabularies | ||
| 82 | (http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary). | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> VocabularyName => Str | ||
| 87 | |||
| 88 | The name of the vocabulary to update. The name is case sensitive. If | ||
| 89 | you try to update a vocabulary with the same name as a previous | ||
| 90 | vocabulary you will receive a C<ConflictException> error. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method UpdateVocabulary in L<Paws::Transcribe> | ||
| 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 |