* 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. *
*/ public class ReleasePhoneNumberRequest extends AmazonWebServiceRequest implements Serializable { /** ** A unique identifier for the phone number. *
*/ private String phoneNumberId; /** ** 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
*/
private String clientToken;
/**
*
* A unique identifier for the phone number. *
* * @return* A unique identifier for the phone number. *
*/ public String getPhoneNumberId() { return phoneNumberId; } /** ** A unique identifier for the phone number. *
* * @param phoneNumberId* A unique identifier for the phone number. *
*/ public void setPhoneNumberId(String phoneNumberId) { this.phoneNumberId = phoneNumberId; } /** ** A unique identifier for the phone number. *
** Returns a reference to this object so that method calls can be chained * together. * * @param phoneNumberId
* A unique identifier for the phone number. *
* @return A reference to this updated object so that method calls can be * chained together. */ public ReleasePhoneNumberRequest withPhoneNumberId(String phoneNumberId) { this.phoneNumberId = phoneNumberId; 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. *
*
* Constraints:
* Length: - 500
*
* @return
* 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 String getClientToken() { return 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
*
* @param 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 void setClientToken(String clientToken) { this.clientToken = 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
*
* @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public ReleasePhoneNumberRequest withClientToken(String clientToken) { this.clientToken = clientToken; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getPhoneNumberId() != null) sb.append("PhoneNumberId: " + getPhoneNumberId() + ","); if (getClientToken() != null) sb.append("ClientToken: " + getClientToken()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getPhoneNumberId() == null) ? 0 : getPhoneNumberId().hashCode()); hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ReleasePhoneNumberRequest == false) return false; ReleasePhoneNumberRequest other = (ReleasePhoneNumberRequest) obj; if (other.getPhoneNumberId() == null ^ this.getPhoneNumberId() == null) return false; if (other.getPhoneNumberId() != null && other.getPhoneNumberId().equals(this.getPhoneNumberId()) == false) return false; if (other.getClientToken() == null ^ this.getClientToken() == null) return false; if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false) return false; return true; } }