class Aws::Chime::Types::SearchAvailablePhoneNumbersRequest

@note When making an API call, you may pass SearchAvailablePhoneNumbersRequest

data as a hash:

    {
      area_code: "String",
      city: "String",
      country: "Alpha2CountryCode",
      state: "String",
      toll_free_prefix: "TollFreePrefix",
      phone_number_type: "Local", # accepts Local, TollFree
      max_results: 1,
      next_token: "String",
    }

@!attribute [rw] area_code

The area code used to filter results. Only applies to the US.
@return [String]

@!attribute [rw] city

The city used to filter results. Only applies to the US.
@return [String]

@!attribute [rw] country

The country used to filter results. Defaults to the US Format: ISO
3166-1 alpha-2.
@return [String]

@!attribute [rw] state

The state used to filter results. Required only if you provide
`City`. Only applies to the US.
@return [String]

@!attribute [rw] toll_free_prefix

The toll-free prefix that you use to filter results. Only applies to
the US.
@return [String]

@!attribute [rw] phone_number_type

The phone number type used to filter results. Required for non-US
numbers.
@return [String]

@!attribute [rw] max_results

The maximum number of results to return in a single call.
@return [Integer]

@!attribute [rw] next_token

The token used to retrieve the next page of results.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SearchAvailablePhoneNumbersRequest AWS API Documentation

Constants

SENSITIVE