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 |
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
- data SearchAvailablePhoneNumbers = SearchAvailablePhoneNumbers' {}
- newSearchAvailablePhoneNumbers :: Text -> PhoneNumberCountryCode -> PhoneNumberType -> SearchAvailablePhoneNumbers
- searchAvailablePhoneNumbers_maxResults :: Lens' SearchAvailablePhoneNumbers (Maybe Natural)
- searchAvailablePhoneNumbers_nextToken :: Lens' SearchAvailablePhoneNumbers (Maybe Text)
- searchAvailablePhoneNumbers_phoneNumberPrefix :: Lens' SearchAvailablePhoneNumbers (Maybe Text)
- searchAvailablePhoneNumbers_targetArn :: Lens' SearchAvailablePhoneNumbers Text
- searchAvailablePhoneNumbers_phoneNumberCountryCode :: Lens' SearchAvailablePhoneNumbers PhoneNumberCountryCode
- searchAvailablePhoneNumbers_phoneNumberType :: Lens' SearchAvailablePhoneNumbers PhoneNumberType
- data SearchAvailablePhoneNumbersResponse = SearchAvailablePhoneNumbersResponse' {}
- newSearchAvailablePhoneNumbersResponse :: Int -> SearchAvailablePhoneNumbersResponse
- searchAvailablePhoneNumbersResponse_availableNumbersList :: Lens' SearchAvailablePhoneNumbersResponse (Maybe [AvailableNumberSummary])
- searchAvailablePhoneNumbersResponse_nextToken :: Lens' SearchAvailablePhoneNumbersResponse (Maybe Text)
- searchAvailablePhoneNumbersResponse_httpStatus :: Lens' SearchAvailablePhoneNumbersResponse Int
Creating a Request
data SearchAvailablePhoneNumbers Source #
See: newSearchAvailablePhoneNumbers
smart constructor.
SearchAvailablePhoneNumbers' | |
|
Instances
newSearchAvailablePhoneNumbers Source #
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.
SearchAvailablePhoneNumbersResponse' | |
|
Instances
newSearchAvailablePhoneNumbersResponse Source #
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.