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.Connect.SearchAvailablePhoneNumbers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.

This operation returns paginated results.

Synopsis

Creating a Request

data SearchAvailablePhoneNumbers Source #

See: newSearchAvailablePhoneNumbers smart constructor.

Constructors

SearchAvailablePhoneNumbers'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per page.
nextToken :: Maybe Text
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
phoneNumberPrefix :: Maybe Text
The prefix of the phone number. If provided, it must contain + as part of the country code.
targetArn :: Text
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
phoneNumberCountryCode :: PhoneNumberCountryCode
The ISO country code.
phoneNumberType :: PhoneNumberType
The type of phone number.

Instances

Instances details

ToJSON SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods toJSON :: SearchAvailablePhoneNumbers -> Value # toEncoding :: SearchAvailablePhoneNumbers -> Encoding # toJSONList :: [SearchAvailablePhoneNumbers] -> Value # toEncodingList :: [SearchAvailablePhoneNumbers] -> Encoding #
ToHeaders SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods toHeaders :: SearchAvailablePhoneNumbers -> [Header] #
ToPath SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods toPath :: SearchAvailablePhoneNumbers -> ByteString #
ToQuery SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods toQuery :: SearchAvailablePhoneNumbers -> QueryString #
AWSPager SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods page :: SearchAvailablePhoneNumbers -> AWSResponse SearchAvailablePhoneNumbers -> Maybe SearchAvailablePhoneNumbers #
AWSRequest SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Connect.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.Connect.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.Connect.SearchAvailablePhoneNumbers Methods readsPrec :: Int -> ReadS SearchAvailablePhoneNumbers # readList :: ReadS [SearchAvailablePhoneNumbers] # readPrec :: ReadPrec SearchAvailablePhoneNumbers # readListPrec :: ReadPrec [SearchAvailablePhoneNumbers] #
Show SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods showsPrec :: Int -> SearchAvailablePhoneNumbers -> ShowS # show :: SearchAvailablePhoneNumbers -> String # showList :: [SearchAvailablePhoneNumbers] -> ShowS #
NFData SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods rnf :: SearchAvailablePhoneNumbers -> () #
Eq SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods (==) :: SearchAvailablePhoneNumbers -> SearchAvailablePhoneNumbers -> Bool # (/=) :: SearchAvailablePhoneNumbers -> SearchAvailablePhoneNumbers -> Bool #
Hashable SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods hashWithSalt :: Int -> SearchAvailablePhoneNumbers -> Int # hash :: SearchAvailablePhoneNumbers -> Int #
type AWSResponse SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers type AWSResponse SearchAvailablePhoneNumbers = SearchAvailablePhoneNumbersResponse
type Rep SearchAvailablePhoneNumbers Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers type Rep SearchAvailablePhoneNumbers = D1 ('MetaData "SearchAvailablePhoneNumbers" "Amazonka.Connect.SearchAvailablePhoneNumbers" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "SearchAvailablePhoneNumbers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "phoneNumberPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "targetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "phoneNumberCountryCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PhoneNumberCountryCode) :*: S1 ('MetaSel ('Just "phoneNumberType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PhoneNumberType)))))

newSearchAvailablePhoneNumbers Source #

Arguments

:: Text	`SearchAvailablePhoneNumbers`
-> PhoneNumberCountryCode	`SearchAvailablePhoneNumbers`
-> PhoneNumberType	`SearchAvailablePhoneNumbers`
-> SearchAvailablePhoneNumbers

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:maxResults:SearchAvailablePhoneNumbers', searchAvailablePhoneNumbers_maxResults - The maximum number of results to return per page.

SearchAvailablePhoneNumbers, searchAvailablePhoneNumbers_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

$sel:phoneNumberPrefix:SearchAvailablePhoneNumbers', searchAvailablePhoneNumbers_phoneNumberPrefix - The prefix of the phone number. If provided, it must contain + as part of the country code.

SearchAvailablePhoneNumbers, searchAvailablePhoneNumbers_targetArn - The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

SearchAvailablePhoneNumbers, searchAvailablePhoneNumbers_phoneNumberCountryCode - The ISO country code.

SearchAvailablePhoneNumbers, searchAvailablePhoneNumbers_phoneNumberType - The type of phone number.

Request Lenses

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

The maximum number of results to return per page.

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

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

The prefix of the phone number. If provided, it must contain + as part of the country code.

searchAvailablePhoneNumbers_targetArn :: Lens' SearchAvailablePhoneNumbers Text Source #

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

searchAvailablePhoneNumbers_phoneNumberCountryCode :: Lens' SearchAvailablePhoneNumbers PhoneNumberCountryCode Source #

The ISO country code.

searchAvailablePhoneNumbers_phoneNumberType :: Lens' SearchAvailablePhoneNumbers PhoneNumberType Source #

The type of phone number.

Destructuring the Response

data SearchAvailablePhoneNumbersResponse Source #

See: newSearchAvailablePhoneNumbersResponse smart constructor.

Constructors

SearchAvailablePhoneNumbersResponse'
Fields availableNumbersList :: Maybe [AvailableNumberSummary] A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SearchAvailablePhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Associated Types type Rep SearchAvailablePhoneNumbersResponse :: Type -> Type # Methods from :: SearchAvailablePhoneNumbersResponse -> Rep SearchAvailablePhoneNumbersResponse x # to :: Rep SearchAvailablePhoneNumbersResponse x -> SearchAvailablePhoneNumbersResponse #
Read SearchAvailablePhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods readsPrec :: Int -> ReadS SearchAvailablePhoneNumbersResponse # readList :: ReadS [SearchAvailablePhoneNumbersResponse] # readPrec :: ReadPrec SearchAvailablePhoneNumbersResponse # readListPrec :: ReadPrec [SearchAvailablePhoneNumbersResponse] #
Show SearchAvailablePhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods showsPrec :: Int -> SearchAvailablePhoneNumbersResponse -> ShowS # show :: SearchAvailablePhoneNumbersResponse -> String # showList :: [SearchAvailablePhoneNumbersResponse] -> ShowS #
NFData SearchAvailablePhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods rnf :: SearchAvailablePhoneNumbersResponse -> () #
Eq SearchAvailablePhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers Methods (==) :: SearchAvailablePhoneNumbersResponse -> SearchAvailablePhoneNumbersResponse -> Bool # (/=) :: SearchAvailablePhoneNumbersResponse -> SearchAvailablePhoneNumbersResponse -> Bool #
type Rep SearchAvailablePhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.SearchAvailablePhoneNumbers type Rep SearchAvailablePhoneNumbersResponse = D1 ('MetaData "SearchAvailablePhoneNumbersResponse" "Amazonka.Connect.SearchAvailablePhoneNumbers" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "SearchAvailablePhoneNumbersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "availableNumbersList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AvailableNumberSummary])) :: (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:availableNumbersList:SearchAvailablePhoneNumbersResponse', searchAvailablePhoneNumbersResponse_availableNumbersList - A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.

SearchAvailablePhoneNumbers, searchAvailablePhoneNumbersResponse_nextToken - If there are additional results, this is the token for the next set of results.

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

Response Lenses

searchAvailablePhoneNumbersResponse_availableNumbersList :: Lens' SearchAvailablePhoneNumbersResponse (Maybe [AvailableNumberSummary]) Source #

A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.

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

If there are additional results, this is the token for the next set of results.

searchAvailablePhoneNumbersResponse_httpStatus :: Lens' SearchAvailablePhoneNumbersResponse Int Source #

The response's http status code.