* 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. *
** If you plan to claim and release numbers frequently during a 30 day period, * contact us for a service quota exception. Otherwise, it is possible you will * be blocked from claiming and releasing any more numbers until 30 days past * the oldest number released has expired. *
** By default you can claim and release up to 200% of your maximum number of * active phone numbers during any 30 day period. If you claim and release phone * numbers using the UI or API during a rolling 30 day cycle that exceeds 200% * of your phone number service level quota, you will be blocked from claiming * any more numbers until 30 days past the oldest number released has expired. *
** For example, if you already have 99 claimed numbers and a service level quota * of 99 phone numbers, and in any 30 day period you release 99, claim 99, and * then release 99, you will have exceeded the 200% limit. At that point you are * blocked from claiming any more numbers until you open an Amazon Web Services * support ticket. *
*/ public class ClaimPhoneNumberRequest extends AmazonWebServiceRequest implements Serializable { /** ** The Amazon Resource Name (ARN) for Amazon Connect instances or traffic * distribution groups that phone numbers are claimed to. *
*/ private String targetArn; /** *
* The phone number you want to claim. Phone numbers are formatted
* [+] [country code] [subscriber number including area code].
*
* Constraints:
* Pattern: \\+[1-9]\\d{1,14}$
*/
private String phoneNumber;
/**
*
* The description of the phone number. *
*
* Constraints:
* Length: 0 - 500
* Pattern: ^[\W\S_]*
*/
private String phoneNumberDescription;
/**
*
* The tags used to organize, track, or control access for this resource. * For example, { "tags": {"key1":"value1", "key2":"value2"} }. *
*/ private java.util.Map* 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}$
*
* Constraints:
* Length: - 500
*/
private String clientToken;
/**
*
* The Amazon Resource Name (ARN) for Amazon Connect instances or traffic * distribution groups that phone numbers are claimed to. *
* * @return* The Amazon Resource Name (ARN) for Amazon Connect instances or * traffic distribution groups that phone numbers are claimed to. *
*/ public String getTargetArn() { return targetArn; } /** ** The Amazon Resource Name (ARN) for Amazon Connect instances or traffic * distribution groups that phone numbers are claimed to. *
* * @param targetArn* The Amazon Resource Name (ARN) for Amazon Connect instances or * traffic distribution groups that phone numbers are claimed to. *
*/ public void setTargetArn(String targetArn) { this.targetArn = targetArn; } /** ** The Amazon Resource Name (ARN) for Amazon Connect instances or traffic * distribution groups that phone numbers are claimed to. *
** Returns a reference to this object so that method calls can be chained * together. * * @param targetArn
* The Amazon Resource Name (ARN) for Amazon Connect instances or * traffic distribution groups that phone numbers are claimed to. *
* @return A reference to this updated object so that method calls can be * chained together. */ public ClaimPhoneNumberRequest withTargetArn(String targetArn) { this.targetArn = targetArn; return this; } /** *
* The phone number you want to claim. Phone numbers are formatted
* [+] [country code] [subscriber number including area code].
*
* Constraints:
* Pattern: \\+[1-9]\\d{1,14}$
*
* @return
* The phone number you want to claim. Phone numbers are formatted
* [+] [country code] [subscriber number including area code]
* .
*
* The phone number you want to claim. Phone numbers are formatted
* [+] [country code] [subscriber number including area code].
*
* Constraints:
* Pattern: \\+[1-9]\\d{1,14}$
*
* @param phoneNumber
* The phone number you want to claim. Phone numbers are
* formatted
* [+] [country code] [subscriber number including area code]
* .
*
* The phone number you want to claim. Phone numbers are formatted
* [+] [country code] [subscriber number including area code].
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Pattern: \\+[1-9]\\d{1,14}$
*
* @param phoneNumber
* The phone number you want to claim. Phone numbers are
* formatted
* [+] [country code] [subscriber number including area code]
* .
*
* The description of the phone number. *
*
* Constraints:
* Length: 0 - 500
* Pattern: ^[\W\S_]*
*
* @return
* The description of the phone number. *
*/ public String getPhoneNumberDescription() { return phoneNumberDescription; } /** ** The description of the phone number. *
*
* Constraints:
* Length: 0 - 500
* Pattern: ^[\W\S_]*
*
* @param phoneNumberDescription
* The description of the phone number. *
*/ public void setPhoneNumberDescription(String phoneNumberDescription) { this.phoneNumberDescription = phoneNumberDescription; } /** ** The description of the phone number. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 0 - 500
* Pattern: ^[\W\S_]*
*
* @param phoneNumberDescription
* The description of the phone number. *
* @return A reference to this updated object so that method calls can be * chained together. */ public ClaimPhoneNumberRequest withPhoneNumberDescription(String phoneNumberDescription) { this.phoneNumberDescription = phoneNumberDescription; return this; } /** ** The tags used to organize, track, or control access for this resource. * For example, { "tags": {"key1":"value1", "key2":"value2"} }. *
* * @return* The tags used to organize, track, or control access for this * resource. For example, { "tags": {"key1":"value1", * "key2":"value2"} }. *
*/ public java.util.Map* The tags used to organize, track, or control access for this resource. * For example, { "tags": {"key1":"value1", "key2":"value2"} }. *
* * @param tags* The tags used to organize, track, or control access for this * resource. For example, { "tags": {"key1":"value1", * "key2":"value2"} }. *
*/ public void setTags(java.util.Map* The tags used to organize, track, or control access for this resource. * For example, { "tags": {"key1":"value1", "key2":"value2"} }. *
** Returns a reference to this object so that method calls can be chained * together. * * @param tags
* The tags used to organize, track, or control access for this * resource. For example, { "tags": {"key1":"value1", * "key2":"value2"} }. *
* @return A reference to this updated object so that method calls can be * chained together. */ public ClaimPhoneNumberRequest withTags(java.util.Map* The tags used to organize, track, or control access for this resource. * For example, { "tags": {"key1":"value1", "key2":"value2"} }. *
*
* The method adds a new key-value pair into Tags parameter, and returns a
* reference to this object so that method calls can be chained together.
*
* @param key The key of the entry to be added into Tags.
* @param value The corresponding value of the entry to be added into Tags.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public ClaimPhoneNumberRequest addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap
* Returns a reference to this object so that method calls can be chained
* together.
*/
public ClaimPhoneNumberRequest clearTagsEntries() {
this.tags = null;
return this;
}
/**
*
* 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:
*
* Constraints:
* 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 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:
*
* Constraints:
* 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 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:
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* 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}$
*
* Length: - 500
*
* @return ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
* ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
*
* Length: - 500
*
* @param clientToken ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
* ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
*
* Length: - 500
*
* @param clientToken ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
*