public class ReleasePhoneNumberRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
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.
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.
| Constructor and Description |
|---|
ReleasePhoneNumberRequest() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getClientToken()
A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
|
java.lang.String |
getPhoneNumberId()
A unique identifier for the phone number.
|
int |
hashCode() |
void |
setClientToken(java.lang.String clientToken)
A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
|
void |
setPhoneNumberId(java.lang.String phoneNumberId)
A unique identifier for the phone number.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ReleasePhoneNumberRequest |
withClientToken(java.lang.String clientToken)
A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
|
ReleasePhoneNumberRequest |
withPhoneNumberId(java.lang.String phoneNumberId)
A unique identifier for the phone number.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic java.lang.String getPhoneNumberId()
A unique identifier for the phone number.
A unique identifier for the phone number.
public void setPhoneNumberId(java.lang.String phoneNumberId)
A unique identifier for the phone number.
phoneNumberId - A unique identifier for the phone number.
public ReleasePhoneNumberRequest withPhoneNumberId(java.lang.String phoneNumberId)
A unique identifier for the phone number.
Returns a reference to this object so that method calls can be chained together.
phoneNumberId - A unique identifier for the phone number.
public java.lang.String getClientToken()
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.
Constraints:
Length: - 500
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.
public void setClientToken(java.lang.String 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.
Constraints:
Length: - 500
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.
public ReleasePhoneNumberRequest withClientToken(java.lang.String 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 500
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.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object