| 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.PinpointSmsVoiceV2.DescribePhoneNumbers
Description
Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an Error is returned.
This operation returns paginated results.
Synopsis
- data DescribePhoneNumbers = DescribePhoneNumbers' {
- filters :: Maybe [PhoneNumberFilter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- phoneNumberIds :: Maybe [Text]
- newDescribePhoneNumbers :: DescribePhoneNumbers
- describePhoneNumbers_filters :: Lens' DescribePhoneNumbers (Maybe [PhoneNumberFilter])
- describePhoneNumbers_maxResults :: Lens' DescribePhoneNumbers (Maybe Natural)
- describePhoneNumbers_nextToken :: Lens' DescribePhoneNumbers (Maybe Text)
- describePhoneNumbers_phoneNumberIds :: Lens' DescribePhoneNumbers (Maybe [Text])
- data DescribePhoneNumbersResponse = DescribePhoneNumbersResponse' {}
- newDescribePhoneNumbersResponse :: Int -> DescribePhoneNumbersResponse
- describePhoneNumbersResponse_nextToken :: Lens' DescribePhoneNumbersResponse (Maybe Text)
- describePhoneNumbersResponse_phoneNumbers :: Lens' DescribePhoneNumbersResponse (Maybe [PhoneNumberInformation])
- describePhoneNumbersResponse_httpStatus :: Lens' DescribePhoneNumbersResponse Int
Creating a Request
data DescribePhoneNumbers Source #
See: newDescribePhoneNumbers smart constructor.
Constructors
| DescribePhoneNumbers' | |
Fields
| |
Instances
newDescribePhoneNumbers :: DescribePhoneNumbers Source #
Create a value of DescribePhoneNumbers 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:filters:DescribePhoneNumbers', describePhoneNumbers_filters - An array of PhoneNumberFilter objects to filter the results.
$sel:maxResults:DescribePhoneNumbers', describePhoneNumbers_maxResults - The maximum number of results to return per each request.
DescribePhoneNumbers, describePhoneNumbers_nextToken - The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
$sel:phoneNumberIds:DescribePhoneNumbers', describePhoneNumbers_phoneNumberIds - The unique identifier of phone numbers to find information about. This
is an array of strings that can be either the PhoneNumberId or
PhoneNumberArn.
Request Lenses
describePhoneNumbers_filters :: Lens' DescribePhoneNumbers (Maybe [PhoneNumberFilter]) Source #
An array of PhoneNumberFilter objects to filter the results.
describePhoneNumbers_maxResults :: Lens' DescribePhoneNumbers (Maybe Natural) Source #
The maximum number of results to return per each request.
describePhoneNumbers_nextToken :: Lens' DescribePhoneNumbers (Maybe Text) Source #
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
describePhoneNumbers_phoneNumberIds :: Lens' DescribePhoneNumbers (Maybe [Text]) Source #
The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
Destructuring the Response
data DescribePhoneNumbersResponse Source #
See: newDescribePhoneNumbersResponse smart constructor.
Constructors
| DescribePhoneNumbersResponse' | |
Fields
| |
Instances
newDescribePhoneNumbersResponse Source #
Create a value of DescribePhoneNumbersResponse 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:
DescribePhoneNumbers, describePhoneNumbersResponse_nextToken - The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
$sel:phoneNumbers:DescribePhoneNumbersResponse', describePhoneNumbersResponse_phoneNumbers - An array of PhoneNumberInformation objects that contain the details for
the requested phone numbers.
$sel:httpStatus:DescribePhoneNumbersResponse', describePhoneNumbersResponse_httpStatus - The response's http status code.
Response Lenses
describePhoneNumbersResponse_nextToken :: Lens' DescribePhoneNumbersResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
describePhoneNumbersResponse_phoneNumbers :: Lens' DescribePhoneNumbersResponse (Maybe [PhoneNumberInformation]) Source #
An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.
describePhoneNumbersResponse_httpStatus :: Lens' DescribePhoneNumbersResponse Int Source #
The response's http status code.