| 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.ReleasePhoneNumber
Description
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the
ReleasePhoneNumber API, not the Amazon Connect console.
After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
Synopsis
- data ReleasePhoneNumber = ReleasePhoneNumber' {}
- newReleasePhoneNumber :: Text -> ReleasePhoneNumber
- releasePhoneNumber_clientToken :: Lens' ReleasePhoneNumber (Maybe Text)
- releasePhoneNumber_phoneNumberId :: Lens' ReleasePhoneNumber Text
- data ReleasePhoneNumberResponse = ReleasePhoneNumberResponse' {
- newReleasePhoneNumberResponse :: ReleasePhoneNumberResponse
Creating a Request
data ReleasePhoneNumber Source #
See: newReleasePhoneNumber smart constructor.
Constructors
| ReleasePhoneNumber' | |
Fields
| |
Instances
newReleasePhoneNumber Source #
Arguments
| :: Text | |
| -> ReleasePhoneNumber |
Create a value of ReleasePhoneNumber 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:clientToken:ReleasePhoneNumber', releasePhoneNumber_clientToken - A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK
populates this field. For more information about idempotency, see
Making retries safe with idempotent APIs.
ReleasePhoneNumber, releasePhoneNumber_phoneNumberId - A unique identifier for the phone number.
Request Lenses
releasePhoneNumber_clientToken :: Lens' ReleasePhoneNumber (Maybe Text) Source #
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
releasePhoneNumber_phoneNumberId :: Lens' ReleasePhoneNumber Text Source #
A unique identifier for the phone number.
Destructuring the Response
data ReleasePhoneNumberResponse Source #
See: newReleasePhoneNumberResponse smart constructor.
Constructors
| ReleasePhoneNumberResponse' | |
Instances
newReleasePhoneNumberResponse :: ReleasePhoneNumberResponse Source #
Create a value of ReleasePhoneNumberResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.