« blib/lib/Paws/Chime/SMAUpdateCallArgumentsMap.pm
↑ Summary
blib/lib/Paws/Chime/SearchAvailablePhoneNumbersResponse.pm »
| 1 | |||
| 2 | package Paws::Chime::SearchAvailablePhoneNumbers; | ||
| 3 | use Moose; | ||
| 4 | has AreaCode => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'area-code'); | ||
| 5 | has City => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'city'); | ||
| 6 | has Country => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'country'); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'max-results'); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'next-token'); | ||
| 9 | has PhoneNumberType => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'phone-number-type'); | ||
| 10 | has State => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'state'); | ||
| 11 | has TollFreePrefix => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'toll-free-prefix'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchAvailablePhoneNumbers'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/search?type=phone-numbers'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Chime::SearchAvailablePhoneNumbersResponse'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Chime::SearchAvailablePhoneNumbers - Arguments for method SearchAvailablePhoneNumbers on L<Paws::Chime> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method SearchAvailablePhoneNumbers on the | ||
| 30 | L<Amazon Chime|Paws::Chime> service. Use the attributes of this class | ||
| 31 | as arguments to method SearchAvailablePhoneNumbers. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchAvailablePhoneNumbers. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $chime = Paws->service('Chime'); | ||
| 38 | my $SearchAvailablePhoneNumbersResponse = | ||
| 39 | $chime->SearchAvailablePhoneNumbers( | ||
| 40 | AreaCode => 'MyString', # OPTIONAL | ||
| 41 | City => 'MyString', # OPTIONAL | ||
| 42 | Country => 'MyAlpha2CountryCode', # OPTIONAL | ||
| 43 | MaxResults => 1, # OPTIONAL | ||
| 44 | NextToken => 'MyString', # OPTIONAL | ||
| 45 | PhoneNumberType => 'Local', # OPTIONAL | ||
| 46 | State => 'MyString', # OPTIONAL | ||
| 47 | TollFreePrefix => 'MyTollFreePrefix', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $E164PhoneNumbers = | ||
| 52 | $SearchAvailablePhoneNumbersResponse->E164PhoneNumbers; | ||
| 53 | my $NextToken = $SearchAvailablePhoneNumbersResponse->NextToken; | ||
| 54 | |||
| 55 | # Returns a L<Paws::Chime::SearchAvailablePhoneNumbersResponse> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/chime/SearchAvailablePhoneNumbers> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 AreaCode => Str | ||
| 64 | |||
| 65 | The area code used to filter results. Only applies to the US. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 City => Str | ||
| 70 | |||
| 71 | The city used to filter results. Only applies to the US. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Country => Str | ||
| 76 | |||
| 77 | The country used to filter results. Defaults to the US Format: ISO | ||
| 78 | 3166-1 alpha-2. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 MaxResults => Int | ||
| 83 | |||
| 84 | The maximum number of results to return in a single call. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 NextToken => Str | ||
| 89 | |||
| 90 | The token used to retrieve the next page of results. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 PhoneNumberType => Str | ||
| 95 | |||
| 96 | The phone number type used to filter results. Required for non-US | ||
| 97 | numbers. | ||
| 98 | |||
| 99 | Valid values are: C<"Local">, C<"TollFree"> | ||
| 100 | |||
| 101 | =head2 State => Str | ||
| 102 | |||
| 103 | The state used to filter results. Required only if you provide C<City>. | ||
| 104 | Only applies to the US. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 TollFreePrefix => Str | ||
| 109 | |||
| 110 | The toll-free prefix that you use to filter results. Only applies to | ||
| 111 | the US. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head1 SEE ALSO | ||
| 117 | |||
| 118 | This class forms part of L<Paws>, documenting arguments for method SearchAvailablePhoneNumbers in L<Paws::Chime> | ||
| 119 | |||
| 120 | =head1 BUGS and CONTRIBUTIONS | ||
| 121 | |||
| 122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 123 | |||
| 124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 125 | |||
| 126 | =cut | ||
| 127 |