| 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.ClaimPhoneNumber
Description
Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
Synopsis
- data ClaimPhoneNumber = ClaimPhoneNumber' {
- clientToken :: Maybe Text
- phoneNumberDescription :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- targetArn :: Text
- phoneNumber :: Text
- newClaimPhoneNumber :: Text -> Text -> ClaimPhoneNumber
- claimPhoneNumber_clientToken :: Lens' ClaimPhoneNumber (Maybe Text)
- claimPhoneNumber_phoneNumberDescription :: Lens' ClaimPhoneNumber (Maybe Text)
- claimPhoneNumber_tags :: Lens' ClaimPhoneNumber (Maybe (HashMap Text Text))
- claimPhoneNumber_targetArn :: Lens' ClaimPhoneNumber Text
- claimPhoneNumber_phoneNumber :: Lens' ClaimPhoneNumber Text
- data ClaimPhoneNumberResponse = ClaimPhoneNumberResponse' {}
- newClaimPhoneNumberResponse :: Int -> ClaimPhoneNumberResponse
- claimPhoneNumberResponse_phoneNumberArn :: Lens' ClaimPhoneNumberResponse (Maybe Text)
- claimPhoneNumberResponse_phoneNumberId :: Lens' ClaimPhoneNumberResponse (Maybe Text)
- claimPhoneNumberResponse_httpStatus :: Lens' ClaimPhoneNumberResponse Int
Creating a Request
data ClaimPhoneNumber Source #
See: newClaimPhoneNumber smart constructor.
Constructors
| ClaimPhoneNumber' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ClaimPhoneNumber |
Create a value of ClaimPhoneNumber 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:ClaimPhoneNumber', claimPhoneNumber_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.
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
ClaimPhoneNumber, claimPhoneNumber_phoneNumberDescription - The description of the phone number.
ClaimPhoneNumber, claimPhoneNumber_tags - The tags used to organize, track, or control access for this resource.
For example, { "tags": {"key1":"value1", "key2":"value2"} }.
ClaimPhoneNumber, claimPhoneNumber_targetArn - The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
distribution groups that phone numbers are claimed to.
ClaimPhoneNumber, claimPhoneNumber_phoneNumber - The phone number you want to claim. Phone numbers are formatted
[+] [country code] [subscriber number including area code].
Request Lenses
claimPhoneNumber_clientToken :: Lens' ClaimPhoneNumber (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.
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
claimPhoneNumber_phoneNumberDescription :: Lens' ClaimPhoneNumber (Maybe Text) Source #
The description of the phone number.
claimPhoneNumber_tags :: Lens' ClaimPhoneNumber (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
claimPhoneNumber_targetArn :: Lens' ClaimPhoneNumber Text Source #
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
claimPhoneNumber_phoneNumber :: Lens' ClaimPhoneNumber Text Source #
The phone number you want to claim. Phone numbers are formatted
[+] [country code] [subscriber number including area code].
Destructuring the Response
data ClaimPhoneNumberResponse Source #
See: newClaimPhoneNumberResponse smart constructor.
Constructors
| ClaimPhoneNumberResponse' | |
Fields
| |
Instances
newClaimPhoneNumberResponse Source #
Create a value of ClaimPhoneNumberResponse 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:
ClaimPhoneNumberResponse, claimPhoneNumberResponse_phoneNumberArn - The Amazon Resource Name (ARN) of the phone number.
ClaimPhoneNumberResponse, claimPhoneNumberResponse_phoneNumberId - A unique identifier for the phone number.
$sel:httpStatus:ClaimPhoneNumberResponse', claimPhoneNumberResponse_httpStatus - The response's http status code.
Response Lenses
claimPhoneNumberResponse_phoneNumberArn :: Lens' ClaimPhoneNumberResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the phone number.
claimPhoneNumberResponse_phoneNumberId :: Lens' ClaimPhoneNumberResponse (Maybe Text) Source #
A unique identifier for the phone number.
claimPhoneNumberResponse_httpStatus :: Lens' ClaimPhoneNumberResponse Int Source #
The response's http status code.