« blib/lib/Paws/Chime/ListPhoneNumberOrdersResponse.pm
↑ Summary
blib/lib/Paws/Chime/ListPhoneNumbersResponse.pm »
| 1 | |||
| 2 | package Paws::Chime::ListPhoneNumbers; | ||
| 3 | use Moose; | ||
| 4 | has FilterName => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'filter-name'); | ||
| 5 | has FilterValue => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'filter-value'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'max-results'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'next-token'); | ||
| 8 | has ProductType => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'product-type'); | ||
| 9 | has Status => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'status'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListPhoneNumbers'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/phone-numbers'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Chime::ListPhoneNumbersResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Chime::ListPhoneNumbers - Arguments for method ListPhoneNumbers on L<Paws::Chime> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ListPhoneNumbers on the | ||
| 28 | L<Amazon Chime|Paws::Chime> service. Use the attributes of this class | ||
| 29 | as arguments to method ListPhoneNumbers. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListPhoneNumbers. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $chime = Paws->service('Chime'); | ||
| 36 | my $ListPhoneNumbersResponse = $chime->ListPhoneNumbers( | ||
| 37 | FilterName => 'AccountId', # OPTIONAL | ||
| 38 | FilterValue => 'MyString', # OPTIONAL | ||
| 39 | MaxResults => 1, # OPTIONAL | ||
| 40 | NextToken => 'MyString', # OPTIONAL | ||
| 41 | ProductType => 'BusinessCalling', # OPTIONAL | ||
| 42 | Status => 'AcquireInProgress', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $NextToken = $ListPhoneNumbersResponse->NextToken; | ||
| 47 | my $PhoneNumbers = $ListPhoneNumbersResponse->PhoneNumbers; | ||
| 48 | |||
| 49 | # Returns a L<Paws::Chime::ListPhoneNumbersResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/chime/ListPhoneNumbers> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 FilterName => Str | ||
| 58 | |||
| 59 | The filter to use to limit the number of results. | ||
| 60 | |||
| 61 | Valid values are: C<"AccountId">, C<"UserId">, C<"VoiceConnectorId">, C<"VoiceConnectorGroupId">, C<"SipRuleId"> | ||
| 62 | |||
| 63 | =head2 FilterValue => Str | ||
| 64 | |||
| 65 | The value to use for the filter. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 MaxResults => Int | ||
| 70 | |||
| 71 | The maximum number of results to return in a single call. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 NextToken => Str | ||
| 76 | |||
| 77 | The token to use to retrieve the next page of results. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 ProductType => Str | ||
| 82 | |||
| 83 | The phone number product type. | ||
| 84 | |||
| 85 | Valid values are: C<"BusinessCalling">, C<"VoiceConnector">, C<"SipMediaApplicationDialIn"> | ||
| 86 | |||
| 87 | =head2 Status => Str | ||
| 88 | |||
| 89 | The phone number status. | ||
| 90 | |||
| 91 | Valid values are: C<"AcquireInProgress">, C<"AcquireFailed">, C<"Unassigned">, C<"Assigned">, C<"ReleaseInProgress">, C<"DeleteInProgress">, C<"ReleaseFailed">, C<"DeleteFailed"> | ||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, documenting arguments for method ListPhoneNumbers in L<Paws::Chime> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |