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 |
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
- data ListPhoneNumbersV2 = ListPhoneNumbersV2' {}
- newListPhoneNumbersV2 :: ListPhoneNumbersV2
- listPhoneNumbersV2_maxResults :: Lens' ListPhoneNumbersV2 (Maybe Natural)
- listPhoneNumbersV2_nextToken :: Lens' ListPhoneNumbersV2 (Maybe Text)
- listPhoneNumbersV2_phoneNumberCountryCodes :: Lens' ListPhoneNumbersV2 (Maybe [PhoneNumberCountryCode])
- listPhoneNumbersV2_phoneNumberPrefix :: Lens' ListPhoneNumbersV2 (Maybe Text)
- listPhoneNumbersV2_phoneNumberTypes :: Lens' ListPhoneNumbersV2 (Maybe [PhoneNumberType])
- listPhoneNumbersV2_targetArn :: Lens' ListPhoneNumbersV2 (Maybe Text)
- data ListPhoneNumbersV2Response = ListPhoneNumbersV2Response' {}
- newListPhoneNumbersV2Response :: Int -> ListPhoneNumbersV2Response
- listPhoneNumbersV2Response_listPhoneNumbersSummaryList :: Lens' ListPhoneNumbersV2Response (Maybe [ListPhoneNumbersSummary])
- listPhoneNumbersV2Response_nextToken :: Lens' ListPhoneNumbersV2Response (Maybe Text)
- listPhoneNumbersV2Response_httpStatus :: Lens' ListPhoneNumbersV2Response Int
Creating a Request
data ListPhoneNumbersV2 Source #
See: newListPhoneNumbersV2
smart constructor.
ListPhoneNumbersV2' | |
|
Instances
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.
ListPhoneNumbersV2Response' | |
|
Instances
newListPhoneNumbersV2Response Source #
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.