com.amazonaws.services.connect.model

Class UpdatePhoneNumberRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.UpdatePhoneNumberRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class UpdatePhoneNumberRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.

You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdatePhoneNumberRequest()

Method Summary

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.
java.lang.String	getTargetArn() The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
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.
void	setTargetArn(java.lang.String targetArn) The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdatePhoneNumberRequest	withClientToken(java.lang.String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
UpdatePhoneNumberRequest	withPhoneNumberId(java.lang.String phoneNumberId) A unique identifier for the phone number.
UpdatePhoneNumberRequest	withTargetArn(java.lang.String targetArn) The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdatePhoneNumberRequest

public UpdatePhoneNumberRequest()

Method Detail

getPhoneNumberId

public java.lang.String getPhoneNumberId()

A unique identifier for the phone number.

Returns:

A unique identifier for the phone number.

setPhoneNumberId

public void setPhoneNumberId(java.lang.String phoneNumberId)

A unique identifier for the phone number.

Parameters:

phoneNumberId -

A unique identifier for the phone number.

withPhoneNumberId

public UpdatePhoneNumberRequest 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.

Parameters:

phoneNumberId -

A unique identifier for the phone number.

Returns:

A reference to this updated object so that method calls can be chained together.

getTargetArn

public java.lang.String getTargetArn()

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Returns:

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

setTargetArn

public void setTargetArn(java.lang.String targetArn)

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Parameters:

targetArn -

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

withTargetArn

public UpdatePhoneNumberRequest withTargetArn(java.lang.String 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.

Parameters:

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 updated object so that method calls can be chained together.

getClientToken

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

Returns:

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.

setClientToken

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

Parameters:

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.

withClientToken

public UpdatePhoneNumberRequest 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

Parameters:

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 updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object