Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Chime.SearchAvailablePhoneNumbers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

areaCode :: Maybe Text
The area code used to filter results. Only applies to the US.
city :: Maybe Text
The city used to filter results. Only applies to the US.
country :: Maybe Text
The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.
maxResults :: Maybe Natural
The maximum number of results to return in a single call.
nextToken :: Maybe Text
The token used to retrieve the next page of results.
phoneNumberType :: Maybe PhoneNumberType
The phone number type used to filter results. Required for non-US numbers.
state :: Maybe Text
The state used to filter results. Required only if you provide City. Only applies to the US.
tollFreePrefix :: Maybe Text
The toll-free prefix that you use to filter results. Only applies to the US.

Instances

Instances details

ToHeaders SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Methods toHeaders :: SearchAvailablePhoneNumbers -> [Header] #
ToPath SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Methods toPath :: SearchAvailablePhoneNumbers -> ByteString #
ToQuery SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Methods toQuery :: SearchAvailablePhoneNumbers -> QueryString #
AWSRequest SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Associated Types type AWSResponse SearchAvailablePhoneNumbers # Methods request :: (Service -> Service) -> SearchAvailablePhoneNumbers -> Request SearchAvailablePhoneNumbers # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchAvailablePhoneNumbers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchAvailablePhoneNumbers))) #
Generic SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Associated Types type Rep SearchAvailablePhoneNumbers :: Type -> Type # Methods from :: SearchAvailablePhoneNumbers -> Rep SearchAvailablePhoneNumbers x # to :: Rep SearchAvailablePhoneNumbers x -> SearchAvailablePhoneNumbers #
Read SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Methods readsPrec :: Int -> ReadS SearchAvailablePhoneNumbers # readList :: ReadS [SearchAvailablePhoneNumbers] # readPrec :: ReadPrec SearchAvailablePhoneNumbers # readListPrec :: ReadPrec [SearchAvailablePhoneNumbers] #
Show SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Methods showsPrec :: Int -> SearchAvailablePhoneNumbers -> ShowS # show :: SearchAvailablePhoneNumbers -> String # showList :: [SearchAvailablePhoneNumbers] -> ShowS #
NFData SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Methods rnf :: SearchAvailablePhoneNumbers -> () #
Eq SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Methods (==) :: SearchAvailablePhoneNumbers -> SearchAvailablePhoneNumbers -> Bool # (/=) :: SearchAvailablePhoneNumbers -> SearchAvailablePhoneNumbers -> Bool #
Hashable SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Methods hashWithSalt :: Int -> SearchAvailablePhoneNumbers -> Int # hash :: SearchAvailablePhoneNumbers -> Int #
type AWSResponse SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers type AWSResponse SearchAvailablePhoneNumbers = SearchAvailablePhoneNumbersResponse
type Rep SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers type Rep SearchAvailablePhoneNumbers = D1 ('MetaData "SearchAvailablePhoneNumbers" "Amazonka.Chime.SearchAvailablePhoneNumbers" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "SearchAvailablePhoneNumbers'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "areaCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "city") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "country") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "phoneNumberType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PhoneNumberType))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tollFreePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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:

SearchAvailablePhoneNumbers, searchAvailablePhoneNumbers_areaCode - The area code used to filter results. Only applies to the US.

SearchAvailablePhoneNumbers, searchAvailablePhoneNumbers_city - The city used to filter results. Only applies to the US.

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

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

SearchAvailablePhoneNumbers, searchAvailablePhoneNumbers_nextToken - The token used to retrieve the next page of results.

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

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.

Request Lenses

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

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

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

The city used 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_maxResults :: Lens' SearchAvailablePhoneNumbers (Maybe Natural) Source #

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

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

The token used to retrieve the next page of results.

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.

Destructuring the Response

data SearchAvailablePhoneNumbersResponse Source #

See: newSearchAvailablePhoneNumbersResponse smart constructor.

Constructors

SearchAvailablePhoneNumbersResponse'
Fields e164PhoneNumbers :: Maybe [Sensitive Text] List of phone numbers, in E.164 format. nextToken :: Maybe Text The token used to retrieve the next page of search results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SearchAvailablePhoneNumbersResponse Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Associated Types type Rep SearchAvailablePhoneNumbersResponse :: Type -> Type # Methods from :: SearchAvailablePhoneNumbersResponse -> Rep SearchAvailablePhoneNumbersResponse x # to :: Rep SearchAvailablePhoneNumbersResponse x -> SearchAvailablePhoneNumbersResponse #
Show SearchAvailablePhoneNumbersResponse Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Methods showsPrec :: Int -> SearchAvailablePhoneNumbersResponse -> ShowS # show :: SearchAvailablePhoneNumbersResponse -> String # showList :: [SearchAvailablePhoneNumbersResponse] -> ShowS #
NFData SearchAvailablePhoneNumbersResponse Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Methods rnf :: SearchAvailablePhoneNumbersResponse -> () #
Eq SearchAvailablePhoneNumbersResponse Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers Methods (==) :: SearchAvailablePhoneNumbersResponse -> SearchAvailablePhoneNumbersResponse -> Bool # (/=) :: SearchAvailablePhoneNumbersResponse -> SearchAvailablePhoneNumbersResponse -> Bool #
type Rep SearchAvailablePhoneNumbersResponse Source #
Instance details Defined in Amazonka.Chime.SearchAvailablePhoneNumbers type Rep SearchAvailablePhoneNumbersResponse = D1 ('MetaData "SearchAvailablePhoneNumbersResponse" "Amazonka.Chime.SearchAvailablePhoneNumbers" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" '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 #

Arguments

:: Int	`$sel:httpStatus:SearchAvailablePhoneNumbersResponse'`
-> SearchAvailablePhoneNumbersResponse

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.

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_e164PhoneNumbers :: Lens' SearchAvailablePhoneNumbersResponse (Maybe [Text]) Source #

List of phone numbers, in E.164 format.

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

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

searchAvailablePhoneNumbersResponse_httpStatus :: Lens' SearchAvailablePhoneNumbersResponse Int Source #

The response's http status code.