Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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.

This operation returns paginated results.

Synopsis

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

Creating a Request

data ListPhoneNumbers Source #

See: newListPhoneNumbers smart constructor.

Constructors

ListPhoneNumbers'

Fields

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

Instances

Instances details

Eq ListPhoneNumbers Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers Methods (==) :: ListPhoneNumbers -> ListPhoneNumbers -> Bool # (/=) :: ListPhoneNumbers -> ListPhoneNumbers -> Bool #
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 #
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 #
NFData ListPhoneNumbers Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers Methods rnf :: ListPhoneNumbers -> () #
Hashable ListPhoneNumbers Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers Methods hashWithSalt :: Int -> ListPhoneNumbers -> Int # hash :: ListPhoneNumbers -> Int #
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 :: ListPhoneNumbers -> Request ListPhoneNumbers # response :: MonadResource m => Logger -> Service -> Proxy ListPhoneNumbers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPhoneNumbers))) #
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 #
type Rep ListPhoneNumbers Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers type Rep ListPhoneNumbers = D1 ('MetaData "ListPhoneNumbers" "Amazonka.Connect.ListPhoneNumbers" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "ListPhoneNumbers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "phoneNumberTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PhoneNumberType])) :: S1 ('MetaSel ('Just "phoneNumberCountryCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PhoneNumberCountryCode]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListPhoneNumbers Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers type AWSResponse ListPhoneNumbers = ListPhoneNumbersResponse

newListPhoneNumbers Source #

Arguments

:: Text	`$sel:instanceId: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:phoneNumberTypes:ListPhoneNumbers', listPhoneNumbers_phoneNumberTypes - The type of phone number.

$sel:phoneNumberCountryCodes:ListPhoneNumbers', listPhoneNumbers_phoneNumberCountryCodes - The ISO country code.

$sel:nextToken: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:maxResults:ListPhoneNumbers', listPhoneNumbers_maxResults - The maximum number of results to return per page.

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

Request Lenses

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

The type of phone number.

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

The ISO country code.

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_maxResults :: Lens' ListPhoneNumbers (Maybe Natural) Source #

The maximum number of results to return per page.

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 phoneNumberSummaryList :: Maybe [PhoneNumberSummary] Information about the phone numbers. 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

Eq ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers Methods (==) :: ListPhoneNumbersResponse -> ListPhoneNumbersResponse -> Bool # (/=) :: ListPhoneNumbersResponse -> ListPhoneNumbersResponse -> Bool #
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 #
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 #
NFData ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers Methods rnf :: ListPhoneNumbersResponse -> () #
type Rep ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Connect.ListPhoneNumbers type Rep ListPhoneNumbersResponse = D1 ('MetaData "ListPhoneNumbersResponse" "Amazonka.Connect.ListPhoneNumbers" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "ListPhoneNumbersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "phoneNumberSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PhoneNumberSummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:

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

$sel:nextToken:ListPhoneNumbers', listPhoneNumbersResponse_nextToken - If there are additional results, this is the token for the next set of results.

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

Response Lenses

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

Information about the phone numbers.

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

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

listPhoneNumbersResponse_httpStatus :: Lens' ListPhoneNumbersResponse Int Source #

The response's http status code.