« blib/lib/Paws/Connect/ListLexBotsResponse.pm
↑ Summary
blib/lib/Paws/Connect/ListPhoneNumbersResponse.pm »
| 1 | |||
| 2 | package Paws::Connect::ListPhoneNumbers; | ||
| 3 | use Moose; | ||
| 4 | has InstanceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'InstanceId', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 7 | has PhoneNumberCountryCodes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'phoneNumberCountryCodes'); | ||
| 8 | has PhoneNumberTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'phoneNumberTypes'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListPhoneNumbers'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/phone-numbers-summary/{InstanceId}'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Connect::ListPhoneNumbersResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Connect::ListPhoneNumbers - Arguments for method ListPhoneNumbers on L<Paws::Connect> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListPhoneNumbers on the | ||
| 27 | L<Amazon Connect Service|Paws::Connect> service. Use the attributes of this class | ||
| 28 | as arguments to method ListPhoneNumbers. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListPhoneNumbers. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $connect = Paws->service('Connect'); | ||
| 35 | my $ListPhoneNumbersResponse = $connect->ListPhoneNumbers( | ||
| 36 | InstanceId => 'MyInstanceId', | ||
| 37 | MaxResults => 1, # OPTIONAL | ||
| 38 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 39 | PhoneNumberCountryCodes => [ | ||
| 40 | 'AF', | ||
| 41 | ... # values: AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW | ||
| 42 | ], # OPTIONAL | ||
| 43 | PhoneNumberTypes => [ | ||
| 44 | 'TOLL_FREE', ... # values: TOLL_FREE, DID | ||
| 45 | ], # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $NextToken = $ListPhoneNumbersResponse->NextToken; | ||
| 50 | my $PhoneNumberSummaryList = | ||
| 51 | $ListPhoneNumbersResponse->PhoneNumberSummaryList; | ||
| 52 | |||
| 53 | # Returns a L<Paws::Connect::ListPhoneNumbersResponse> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/connect/ListPhoneNumbers> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> InstanceId => Str | ||
| 62 | |||
| 63 | The identifier of the Amazon Connect instance. You can find the | ||
| 64 | instanceId in the ARN of the instance. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 MaxResults => Int | ||
| 69 | |||
| 70 | The maximum number of results to return per page. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 NextToken => Str | ||
| 75 | |||
| 76 | The token for the next set of results. Use the value returned in the | ||
| 77 | previous response in the next request to retrieve the next set of | ||
| 78 | results. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 PhoneNumberCountryCodes => ArrayRef[Str|Undef] | ||
| 83 | |||
| 84 | The ISO country code. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 PhoneNumberTypes => ArrayRef[Str|Undef] | ||
| 89 | |||
| 90 | The type of phone number. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method ListPhoneNumbers in L<Paws::Connect> | ||
| 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 |