blib/lib/Paws/Polly/DescribeVoices.pm

filter: Statementstmt 100% 15 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 17 / 17 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/Net/GlacierCaller.pm ↑ Summary blib/lib/Paws/Polly/DescribeVoicesOutput.pm »
1  
2 package Paws::Polly::DescribeVoices;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has Engine => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'Engine');
5 1 has IncludeAdditionalLanguageCodes => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'IncludeAdditionalLanguageCodes');
6 1 has LanguageCode => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'LanguageCode');
7 1 has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'NextToken');
8  
9 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
10  
11 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeVoices');
12 1 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/voices');
13 1 class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
14 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Polly::DescribeVoicesOutput');
15 1 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::Polly::DescribeVoices - Arguments for method DescribeVoices on L<Paws::Polly>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeVoices on the
26 L<Amazon Polly|Paws::Polly> service. Use the attributes of this class
27 as arguments to method DescribeVoices.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeVoices.
30  
31 =head1 SYNOPSIS
32  
33 my $polly = Paws->service('Polly');
34 # To describe available voices
35 # Returns the list of voices that are available for use when requesting speech
36 # synthesis. Displayed languages are those within the specified language code.
37 # If no language code is specified, voices for all available languages are
38 # displayed.
39 my $DescribeVoicesOutput =
40 $polly->DescribeVoices( 'LanguageCode' => 'en-GB' );
41  
42 # Results:
43 my $Voices = $DescribeVoicesOutput->Voices;
44  
45 # Returns a L<Paws::Polly::DescribeVoicesOutput> object.
46  
47 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.
48 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/polly/DescribeVoices>
49  
50 =head1 ATTRIBUTES
51  
52  
53 =head2 Engine => Str
54  
55 Specifies the engine (C<standard> or C<neural>) used by Amazon Polly
56 when processing input text for speech synthesis.
57  
58 Valid values are: C<"standard">, C<"neural">
59  
60 =head2 IncludeAdditionalLanguageCodes => Bool
61  
62 Boolean value indicating whether to return any bilingual voices that
63 use the specified language as an additional language. For instance, if
64 you request all languages that use US English (es-US), and there is an
65 Italian voice that speaks both Italian (it-IT) and US English, that
66 voice will be included if you specify C<yes> but not if you specify
67 C<no>.
68  
69  
70  
71 =head2 LanguageCode => Str
72  
73 The language identification tag (ISO 639 code for the language name-ISO
74 3166 country code) for filtering the list of voices returned. If you
75 don't specify this optional parameter, all available voices are
76 returned.
77  
78 Valid values are: C<"arb">, C<"cmn-CN">, C<"cy-GB">, C<"da-DK">, C<"de-DE">, C<"en-AU">, C<"en-GB">, C<"en-GB-WLS">, C<"en-IN">, C<"en-US">, C<"es-ES">, C<"es-MX">, C<"es-US">, C<"fr-CA">, C<"fr-FR">, C<"is-IS">, C<"it-IT">, C<"ja-JP">, C<"hi-IN">, C<"ko-KR">, C<"nb-NO">, C<"nl-NL">, C<"pl-PL">, C<"pt-BR">, C<"pt-PT">, C<"ro-RO">, C<"ru-RU">, C<"sv-SE">, C<"tr-TR">
79  
80 =head2 NextToken => Str
81  
82 An opaque pagination token returned from the previous C<DescribeVoices>
83 operation. If present, this indicates where to continue the listing.
84  
85  
86  
87  
88 =head1 SEE ALSO
89  
90 This class forms part of L<Paws>, documenting arguments for method DescribeVoices in L<Paws::Polly>
91  
92 =head1 BUGS and CONTRIBUTIONS
93  
94 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
95  
96 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
97  
98 =cut
99  
« blib/lib/Paws/Net/GlacierCaller.pm ↑ Summary blib/lib/Paws/Polly/DescribeVoicesOutput.pm »