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.ListPhoneNumbersV2

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists phone numbers claimed 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 traffic distribution group.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data ListPhoneNumbersV2 Source #

See: newListPhoneNumbersV2 smart constructor.

Constructors

ListPhoneNumbersV2'

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.
phoneNumberCountryCodes :: Maybe [PhoneNumberCountryCode]
The ISO country code.
phoneNumberPrefix :: Maybe Text
The prefix of the phone number. If provided, it must contain + as part of the country code.
phoneNumberTypes :: Maybe [PhoneNumberType]
The type of phone number.
targetArn :: Maybe Text
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.

Instances

Instances details

ToJSON ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods toJSON :: ListPhoneNumbersV2 -> Value # toEncoding :: ListPhoneNumbersV2 -> Encoding # toJSONList :: [ListPhoneNumbersV2] -> Value # toEncodingList :: [ListPhoneNumbersV2] -> Encoding #
ToHeaders ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods toHeaders :: ListPhoneNumbersV2 -> [Header] #
ToPath ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods toPath :: ListPhoneNumbersV2 -> ByteString #
ToQuery ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods toQuery :: ListPhoneNumbersV2 -> QueryString #
AWSPager ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods page :: ListPhoneNumbersV2 -> AWSResponse ListPhoneNumbersV2 -> Maybe ListPhoneNumbersV2 #
AWSRequest ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Associated Types type AWSResponse ListPhoneNumbersV2 # Methods request :: (Service -> Service) -> ListPhoneNumbersV2 -> Request ListPhoneNumbersV2 # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListPhoneNumbersV2 -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPhoneNumbersV2))) #
Generic ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Associated Types type Rep ListPhoneNumbersV2 :: Type -> Type # Methods from :: ListPhoneNumbersV2 -> Rep ListPhoneNumbersV2 x # to :: Rep ListPhoneNumbersV2 x -> ListPhoneNumbersV2 #
Read ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods readsPrec :: Int -> ReadS ListPhoneNumbersV2 # readList :: ReadS [ListPhoneNumbersV2] # readPrec :: ReadPrec ListPhoneNumbersV2 # readListPrec :: ReadPrec [ListPhoneNumbersV2] #
Show ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods showsPrec :: Int -> ListPhoneNumbersV2 -> ShowS # show :: ListPhoneNumbersV2 -> String # showList :: [ListPhoneNumbersV2] -> ShowS #
NFData ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods rnf :: ListPhoneNumbersV2 -> () #
Eq ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods (==) :: ListPhoneNumbersV2 -> ListPhoneNumbersV2 -> Bool # (/=) :: ListPhoneNumbersV2 -> ListPhoneNumbersV2 -> Bool #
Hashable ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods hashWithSalt :: Int -> ListPhoneNumbersV2 -> Int # hash :: ListPhoneNumbersV2 -> Int #
type AWSResponse ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 type AWSResponse ListPhoneNumbersV2 = ListPhoneNumbersV2Response
type Rep ListPhoneNumbersV2 Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 type Rep ListPhoneNumbersV2 = D1 ('MetaData "ListPhoneNumbersV2" "Amazonka.Connect.ListPhoneNumbersV2" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListPhoneNumbersV2'" '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 "phoneNumberCountryCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PhoneNumberCountryCode])))) :: (S1 ('MetaSel ('Just "phoneNumberPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "phoneNumberTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PhoneNumberType])) :*: S1 ('MetaSel ('Just "targetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newListPhoneNumbersV2 :: ListPhoneNumbersV2 Source #

Create a value of ListPhoneNumbersV2 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:ListPhoneNumbersV2', listPhoneNumbersV2_maxResults - The maximum number of results to return per page.

ListPhoneNumbersV2, listPhoneNumbersV2_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:phoneNumberCountryCodes:ListPhoneNumbersV2', listPhoneNumbersV2_phoneNumberCountryCodes - The ISO country code.

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

$sel:phoneNumberTypes:ListPhoneNumbersV2', listPhoneNumbersV2_phoneNumberTypes - The type of phone number.

ListPhoneNumbersV2, listPhoneNumbersV2_targetArn - The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.

Request Lenses

listPhoneNumbersV2_maxResults :: Lens' ListPhoneNumbersV2 (Maybe Natural) Source #

The maximum number of results to return per page.

listPhoneNumbersV2_nextToken :: Lens' ListPhoneNumbersV2 (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.

listPhoneNumbersV2_phoneNumberCountryCodes :: Lens' ListPhoneNumbersV2 (Maybe [PhoneNumberCountryCode]) Source #

The ISO country code.

listPhoneNumbersV2_phoneNumberPrefix :: Lens' ListPhoneNumbersV2 (Maybe Text) Source #

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

listPhoneNumbersV2_phoneNumberTypes :: Lens' ListPhoneNumbersV2 (Maybe [PhoneNumberType]) Source #

The type of phone number.

listPhoneNumbersV2_targetArn :: Lens' ListPhoneNumbersV2 (Maybe Text) Source #

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.

Destructuring the Response

data ListPhoneNumbersV2Response Source #

See: newListPhoneNumbersV2Response smart constructor.

Constructors

ListPhoneNumbersV2Response'
Fields listPhoneNumbersSummaryList :: Maybe [ListPhoneNumbersSummary] Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups. 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 ListPhoneNumbersV2Response Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Associated Types type Rep ListPhoneNumbersV2Response :: Type -> Type # Methods from :: ListPhoneNumbersV2Response -> Rep ListPhoneNumbersV2Response x # to :: Rep ListPhoneNumbersV2Response x -> ListPhoneNumbersV2Response #
Read ListPhoneNumbersV2Response Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods readsPrec :: Int -> ReadS ListPhoneNumbersV2Response # readList :: ReadS [ListPhoneNumbersV2Response] # readPrec :: ReadPrec ListPhoneNumbersV2Response # readListPrec :: ReadPrec [ListPhoneNumbersV2Response] #
Show ListPhoneNumbersV2Response Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods showsPrec :: Int -> ListPhoneNumbersV2Response -> ShowS # show :: ListPhoneNumbersV2Response -> String # showList :: [ListPhoneNumbersV2Response] -> ShowS #
NFData ListPhoneNumbersV2Response Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods rnf :: ListPhoneNumbersV2Response -> () #
Eq ListPhoneNumbersV2Response Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 Methods (==) :: ListPhoneNumbersV2Response -> ListPhoneNumbersV2Response -> Bool # (/=) :: ListPhoneNumbersV2Response -> ListPhoneNumbersV2Response -> Bool #
type Rep ListPhoneNumbersV2Response Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbersV2 type Rep ListPhoneNumbersV2Response = D1 ('MetaData "ListPhoneNumbersV2Response" "Amazonka.Connect.ListPhoneNumbersV2" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListPhoneNumbersV2Response'" 'PrefixI 'True) (S1 ('MetaSel ('Just "listPhoneNumbersSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ListPhoneNumbersSummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPhoneNumbersV2Response Source #

Arguments

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

Create a value of ListPhoneNumbersV2Response 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:listPhoneNumbersSummaryList:ListPhoneNumbersV2Response', listPhoneNumbersV2Response_listPhoneNumbersSummaryList - Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.

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

$sel:httpStatus:ListPhoneNumbersV2Response', listPhoneNumbersV2Response_httpStatus - The response's http status code.

Response Lenses

listPhoneNumbersV2Response_listPhoneNumbersSummaryList :: Lens' ListPhoneNumbersV2Response (Maybe [ListPhoneNumbersSummary]) Source #

Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.

listPhoneNumbersV2Response_nextToken :: Lens' ListPhoneNumbersV2Response (Maybe Text) Source #

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

listPhoneNumbersV2Response_httpStatus :: Lens' ListPhoneNumbersV2Response Int Source #

The response's http status code.