libZSservicesZSamazonka-chimeZSamazonka-chime
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Chime.SearchAvailablePhoneNumbers

Description

Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.

Synopsis

Creating a Request

data SearchAvailablePhoneNumbers Source #

See: newSearchAvailablePhoneNumbers smart constructor.

Constructors

SearchAvailablePhoneNumbers' 

Fields

Instances

Instances details
Eq SearchAvailablePhoneNumbers Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

Read SearchAvailablePhoneNumbers Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

Show SearchAvailablePhoneNumbers Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

Generic SearchAvailablePhoneNumbers Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

Associated Types

type Rep SearchAvailablePhoneNumbers :: Type -> Type #

NFData SearchAvailablePhoneNumbers Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

Hashable SearchAvailablePhoneNumbers Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

AWSRequest SearchAvailablePhoneNumbers Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

ToHeaders SearchAvailablePhoneNumbers Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

ToPath SearchAvailablePhoneNumbers Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

ToQuery SearchAvailablePhoneNumbers Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

type Rep SearchAvailablePhoneNumbers Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

type AWSResponse SearchAvailablePhoneNumbers Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

newSearchAvailablePhoneNumbers :: SearchAvailablePhoneNumbers Source #

Create a value of SearchAvailablePhoneNumbers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:phoneNumberType:SearchAvailablePhoneNumbers', searchAvailablePhoneNumbers_phoneNumberType - The phone number type used to filter results. Required for non-US numbers.

$sel:state:SearchAvailablePhoneNumbers', searchAvailablePhoneNumbers_state - The state used to filter results. Required only if you provide City. Only applies to the US.

$sel:tollFreePrefix:SearchAvailablePhoneNumbers', searchAvailablePhoneNumbers_tollFreePrefix - The toll-free prefix that you use to filter results. Only applies to the US.

$sel:country:SearchAvailablePhoneNumbers', searchAvailablePhoneNumbers_country - The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

$sel:nextToken:SearchAvailablePhoneNumbers', searchAvailablePhoneNumbers_nextToken - The token used to retrieve the next page of results.

$sel:city:SearchAvailablePhoneNumbers', searchAvailablePhoneNumbers_city - The city used to filter results. Only applies to the US.

$sel:areaCode:SearchAvailablePhoneNumbers', searchAvailablePhoneNumbers_areaCode - The area code used to filter results. Only applies to the US.

$sel:maxResults:SearchAvailablePhoneNumbers', searchAvailablePhoneNumbers_maxResults - The maximum number of results to return in a single call.

Request Lenses

searchAvailablePhoneNumbers_phoneNumberType :: Lens' SearchAvailablePhoneNumbers (Maybe PhoneNumberType) Source #

The phone number type used to filter results. Required for non-US numbers.

searchAvailablePhoneNumbers_state :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The state used to filter results. Required only if you provide City. Only applies to the US.

searchAvailablePhoneNumbers_tollFreePrefix :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The toll-free prefix that you use to filter results. Only applies to the US.

searchAvailablePhoneNumbers_country :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

searchAvailablePhoneNumbers_nextToken :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The token used to retrieve the next page of results.

searchAvailablePhoneNumbers_city :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The city used to filter results. Only applies to the US.

searchAvailablePhoneNumbers_areaCode :: Lens' SearchAvailablePhoneNumbers (Maybe Text) Source #

The area code used to filter results. Only applies to the US.

searchAvailablePhoneNumbers_maxResults :: Lens' SearchAvailablePhoneNumbers (Maybe Natural) Source #

The maximum number of results to return in a single call.

Destructuring the Response

data SearchAvailablePhoneNumbersResponse Source #

Constructors

SearchAvailablePhoneNumbersResponse' 

Fields

Instances

Instances details
Eq SearchAvailablePhoneNumbersResponse Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

Show SearchAvailablePhoneNumbersResponse Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

Generic SearchAvailablePhoneNumbersResponse Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

NFData SearchAvailablePhoneNumbersResponse Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

type Rep SearchAvailablePhoneNumbersResponse Source # 
Instance details

Defined in Amazonka.Chime.SearchAvailablePhoneNumbers

type Rep SearchAvailablePhoneNumbersResponse = D1 ('MetaData "SearchAvailablePhoneNumbersResponse" "Amazonka.Chime.SearchAvailablePhoneNumbers" "libZSservicesZSamazonka-chimeZSamazonka-chime" 'False) (C1 ('MetaCons "SearchAvailablePhoneNumbersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "e164PhoneNumbers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Sensitive Text])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchAvailablePhoneNumbersResponse Source #

Create a value of SearchAvailablePhoneNumbersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:e164PhoneNumbers:SearchAvailablePhoneNumbersResponse', searchAvailablePhoneNumbersResponse_e164PhoneNumbers - List of phone numbers, in E.164 format.

$sel:nextToken:SearchAvailablePhoneNumbers', searchAvailablePhoneNumbersResponse_nextToken - The token used to retrieve the next page of search results.

$sel:httpStatus:SearchAvailablePhoneNumbersResponse', searchAvailablePhoneNumbersResponse_httpStatus - The response's http status code.

Response Lenses

searchAvailablePhoneNumbersResponse_nextToken :: Lens' SearchAvailablePhoneNumbersResponse (Maybe Text) Source #

The token used to retrieve the next page of search results.