| 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.DescribePhoneNumber
Description
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are
calling in the Amazon Web Services Region where the traffic distribution
group was created, you can use either a phone number ARN or UUID value
for the PhoneNumberId URI request parameter. However, if the number is
claimed to a traffic distribution group and you are calling this API in
the alternate Amazon Web Services Region associated with the traffic
distribution group, you must provide a full phone number ARN. If a UUID
is provided in this scenario, you will receive a
ResourceNotFoundException.
Synopsis
- data DescribePhoneNumber = DescribePhoneNumber' {}
- newDescribePhoneNumber :: Text -> DescribePhoneNumber
- describePhoneNumber_phoneNumberId :: Lens' DescribePhoneNumber Text
- data DescribePhoneNumberResponse = DescribePhoneNumberResponse' {}
- newDescribePhoneNumberResponse :: Int -> DescribePhoneNumberResponse
- describePhoneNumberResponse_claimedPhoneNumberSummary :: Lens' DescribePhoneNumberResponse (Maybe ClaimedPhoneNumberSummary)
- describePhoneNumberResponse_httpStatus :: Lens' DescribePhoneNumberResponse Int
Creating a Request
data DescribePhoneNumber Source #
See: newDescribePhoneNumber smart constructor.
Constructors
| DescribePhoneNumber' | |
Fields
| |
Instances
newDescribePhoneNumber Source #
Arguments
| :: Text | |
| -> DescribePhoneNumber |
Create a value of DescribePhoneNumber 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:
DescribePhoneNumber, describePhoneNumber_phoneNumberId - A unique identifier for the phone number.
Request Lenses
describePhoneNumber_phoneNumberId :: Lens' DescribePhoneNumber Text Source #
A unique identifier for the phone number.
Destructuring the Response
data DescribePhoneNumberResponse Source #
See: newDescribePhoneNumberResponse smart constructor.
Constructors
| DescribePhoneNumberResponse' | |
Fields
| |
Instances
newDescribePhoneNumberResponse Source #
Create a value of DescribePhoneNumberResponse 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:claimedPhoneNumberSummary:DescribePhoneNumberResponse', describePhoneNumberResponse_claimedPhoneNumberSummary - Information about a phone number that's been claimed to your Amazon
Connect instance or traffic distribution group.
$sel:httpStatus:DescribePhoneNumberResponse', describePhoneNumberResponse_httpStatus - The response's http status code.
Response Lenses
describePhoneNumberResponse_claimedPhoneNumberSummary :: Lens' DescribePhoneNumberResponse (Maybe ClaimedPhoneNumberSummary) Source #
Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.
describePhoneNumberResponse_httpStatus :: Lens' DescribePhoneNumberResponse Int Source #
The response's http status code.