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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information about the phone numbers for the specified Amazon Connect instance.

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

The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.

This operation returns paginated results.

Synopsis

data ListPhoneNumbers = ListPhoneNumbers' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- phoneNumberCountryCodes :: Maybe [PhoneNumberCountryCode]
- phoneNumberTypes :: Maybe [PhoneNumberType]
- instanceId :: Text
}
newListPhoneNumbers :: Text -> ListPhoneNumbers
listPhoneNumbers_maxResults :: Lens' ListPhoneNumbers (Maybe Natural)
listPhoneNumbers_nextToken :: Lens' ListPhoneNumbers (Maybe Text)
listPhoneNumbers_phoneNumberCountryCodes :: Lens' ListPhoneNumbers (Maybe [PhoneNumberCountryCode])
listPhoneNumbers_phoneNumberTypes :: Lens' ListPhoneNumbers (Maybe [PhoneNumberType])
listPhoneNumbers_instanceId :: Lens' ListPhoneNumbers Text
data ListPhoneNumbersResponse = ListPhoneNumbersResponse' {
- nextToken :: Maybe Text
- phoneNumberSummaryList :: Maybe [PhoneNumberSummary]
- httpStatus :: Int
}
newListPhoneNumbersResponse :: Int -> ListPhoneNumbersResponse
listPhoneNumbersResponse_nextToken :: Lens' ListPhoneNumbersResponse (Maybe Text)
listPhoneNumbersResponse_phoneNumberSummaryList :: Lens' ListPhoneNumbersResponse (Maybe [PhoneNumberSummary])
listPhoneNumbersResponse_httpStatus :: Lens' ListPhoneNumbersResponse Int

Creating a Request

data ListPhoneNumbers Source #

See: newListPhoneNumbers smart constructor.

Constructors

ListPhoneNumbers'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per page. The default MaxResult size is 100.
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.
phoneNumberTypes :: Maybe [PhoneNumberType]
The type of phone number.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

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

newListPhoneNumbers Source #

Arguments

:: Text	`ListPhoneNumbers`
-> ListPhoneNumbers

Create a value of ListPhoneNumbers 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:ListPhoneNumbers', listPhoneNumbers_maxResults - The maximum number of results to return per page. The default MaxResult size is 100.

ListPhoneNumbers, listPhoneNumbers_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:ListPhoneNumbers', listPhoneNumbers_phoneNumberCountryCodes - The ISO country code.

$sel:phoneNumberTypes:ListPhoneNumbers', listPhoneNumbers_phoneNumberTypes - The type of phone number.

ListPhoneNumbers, listPhoneNumbers_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Request Lenses

listPhoneNumbers_maxResults :: Lens' ListPhoneNumbers (Maybe Natural) Source #

The maximum number of results to return per page. The default MaxResult size is 100.

listPhoneNumbers_nextToken :: Lens' ListPhoneNumbers (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.

listPhoneNumbers_phoneNumberCountryCodes :: Lens' ListPhoneNumbers (Maybe [PhoneNumberCountryCode]) Source #

The ISO country code.

listPhoneNumbers_phoneNumberTypes :: Lens' ListPhoneNumbers (Maybe [PhoneNumberType]) Source #

The type of phone number.

listPhoneNumbers_instanceId :: Lens' ListPhoneNumbers Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Destructuring the Response

data ListPhoneNumbersResponse Source #

See: newListPhoneNumbersResponse smart constructor.

Constructors

ListPhoneNumbersResponse'
Fields nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. phoneNumberSummaryList :: Maybe [PhoneNumberSummary] Information about the phone numbers. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers Associated Types type Rep ListPhoneNumbersResponse :: Type -> Type # Methods from :: ListPhoneNumbersResponse -> Rep ListPhoneNumbersResponse x # to :: Rep ListPhoneNumbersResponse x -> ListPhoneNumbersResponse #
Read ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers Methods readsPrec :: Int -> ReadS ListPhoneNumbersResponse # readList :: ReadS [ListPhoneNumbersResponse] # readPrec :: ReadPrec ListPhoneNumbersResponse # readListPrec :: ReadPrec [ListPhoneNumbersResponse] #
Show ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers Methods showsPrec :: Int -> ListPhoneNumbersResponse -> ShowS # show :: ListPhoneNumbersResponse -> String # showList :: [ListPhoneNumbersResponse] -> ShowS #
NFData ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers Methods rnf :: ListPhoneNumbersResponse -> () #
Eq ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers Methods (==) :: ListPhoneNumbersResponse -> ListPhoneNumbersResponse -> Bool # (/=) :: ListPhoneNumbersResponse -> ListPhoneNumbersResponse -> Bool #
type Rep ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers type Rep ListPhoneNumbersResponse = D1 ('MetaData "ListPhoneNumbersResponse" "Amazonka.Connect.ListPhoneNumbers" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListPhoneNumbersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "phoneNumberSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PhoneNumberSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPhoneNumbersResponse Source #

Arguments

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

Create a value of ListPhoneNumbersResponse 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:

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

$sel:phoneNumberSummaryList:ListPhoneNumbersResponse', listPhoneNumbersResponse_phoneNumberSummaryList - Information about the phone numbers.

$sel:httpStatus:ListPhoneNumbersResponse', listPhoneNumbersResponse_httpStatus - The response's http status code.

Response Lenses

listPhoneNumbersResponse_nextToken :: Lens' ListPhoneNumbersResponse (Maybe Text) Source #

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

listPhoneNumbersResponse_phoneNumberSummaryList :: Lens' ListPhoneNumbersResponse (Maybe [PhoneNumberSummary]) Source #

Information about the phone numbers.

listPhoneNumbersResponse_httpStatus :: Lens' ListPhoneNumbersResponse Int Source #

The response's http status code.