UpdatePool
Updates the configuration of an existing pool. You can update the opt-out list, enable
or disable two-way messaging, change the TwoWayChannelArn, enable or
disable self-managed opt-outs, enable or disable deletion protection, and enable or
disable shared routes.
Request Syntax
{
"DeletionProtectionEnabled": boolean,
"OptOutListName": "string",
"PoolId": "string",
"SelfManagedOptOutsEnabled": boolean,
"SharedRoutesEnabled": boolean,
"TwoWayChannelArn": "string",
"TwoWayChannelRole": "string",
"TwoWayEnabled": boolean
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DeletionProtectionEnabled
-
When set to true the pool can't be deleted.
Type: Boolean
Required: No
- OptOutListName
-
The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
Important
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9_:/-]+Required: No
- PoolId
-
The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
Important
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9_:/-]+Required: Yes
- SelfManagedOptOutsEnabled
-
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
Type: Boolean
Required: No
-
Indicates whether shared routes are enabled for the pool.
Type: Boolean
Required: No
- TwoWayChannelArn
-
The Amazon Resource Name (ARN) of the two way channel.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
\S+Required: No
- TwoWayChannelRole
-
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:\S+Required: No
- TwoWayEnabled
-
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Type: Boolean
Required: No
Response Syntax
{
"CreatedTimestamp": number,
"DeletionProtectionEnabled": boolean,
"MessageType": "string",
"OptOutListName": "string",
"PoolArn": "string",
"PoolId": "string",
"SelfManagedOptOutsEnabled": boolean,
"SharedRoutesEnabled": boolean,
"Status": "string",
"TwoWayChannelArn": "string",
"TwoWayChannelRole": "string",
"TwoWayEnabled": boolean
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CreatedTimestamp
-
The time when the pool was created, in UNIX epoch time
format. Type: Timestamp
- DeletionProtectionEnabled
-
When set to true the pool can't be deleted.
Type: Boolean
- MessageType
-
The type of message for the pool to use.
Type: String
Valid Values:
TRANSACTIONAL | PROMOTIONAL - OptOutListName
-
The name of the OptOutList associated with the pool.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[A-Za-z0-9_-]+ - PoolArn
-
The ARN of the pool.
Type: String
- PoolId
-
The unique identifier of the pool.
Type: String
- SelfManagedOptOutsEnabled
-
When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
Type: Boolean
-
Indicates whether shared routes are enabled for the pool.
Type: Boolean
- Status
-
The current status of the pool update request.
Type: String
Valid Values:
CREATING | ACTIVE | DELETING - TwoWayChannelArn
-
The Amazon Resource Name (ARN) of the two way channel.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
\S+ - TwoWayChannelRole
-
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:\S+ - TwoWayEnabled
-
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Type: Boolean
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied because you don't have sufficient permissions to access the resource.
HTTP Status Code: 400
- ConflictException
-
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
HTTP Status Code: 400
- InternalServerException
-
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
HTTP Status Code: 500
- ResourceNotFoundException
-
A requested resource couldn't be found.
HTTP Status Code: 400
- ThrottlingException
-
An error that occurred because too many requests were sent during a certain amount of time.
HTTP Status Code: 400
- ValidationException
-
A validation exception for a field.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
