/AWS1/CL_PP2UPDATEPOOLRESULT¶
UpdatePoolResult
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_poolarn TYPE /AWS1/PP2STRING /AWS1/PP2STRING¶
The ARN of the pool.
iv_poolid TYPE /AWS1/PP2STRING /AWS1/PP2STRING¶
The unique identifier of the pool.
iv_status TYPE /AWS1/PP2POOLSTATUS /AWS1/PP2POOLSTATUS¶
The current status of the pool update request.
iv_messagetype TYPE /AWS1/PP2MESSAGETYPE /AWS1/PP2MESSAGETYPE¶
The type of message for the pool to use.
iv_twowayenabled TYPE /AWS1/PP2PRIMITIVEBOOLEAN /AWS1/PP2PRIMITIVEBOOLEAN¶
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
iv_twowaychannelarn TYPE /AWS1/PP2TWOWAYCHANNELARN /AWS1/PP2TWOWAYCHANNELARN¶
The Amazon Resource Name (ARN) of the two way channel.
iv_twowaychannelrole TYPE /AWS1/PP2IAMROLEARN /AWS1/PP2IAMROLEARN¶
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
iv_selfmanagedoptoutsenabled TYPE /AWS1/PP2PRIMITIVEBOOLEAN /AWS1/PP2PRIMITIVEBOOLEAN¶
When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS 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.
iv_optoutlistname TYPE /AWS1/PP2OPTOUTLISTNAME /AWS1/PP2OPTOUTLISTNAME¶
The name of the OptOutList associated with the pool.
iv_sharedroutesenabled TYPE /AWS1/PP2PRIMITIVEBOOLEAN /AWS1/PP2PRIMITIVEBOOLEAN¶
Indicates whether shared routes are enabled for the pool.
iv_deletionprotectionenabled TYPE /AWS1/PP2PRIMITIVEBOOLEAN /AWS1/PP2PRIMITIVEBOOLEAN¶
When set to true the pool can't be deleted.
iv_createdtimestamp TYPE /AWS1/PP2TIMESTAMP /AWS1/PP2TIMESTAMP¶
The time when the pool was created, in UNIX epoch time format.
Queryable Attributes¶
PoolArn¶
The ARN of the pool.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_POOLARN() |
Getter for POOLARN, with configurable default |
ASK_POOLARN() |
Getter for POOLARN w/ exceptions if field has no value |
HAS_POOLARN() |
Determine if POOLARN has a value |
PoolId¶
The unique identifier of the pool.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_POOLID() |
Getter for POOLID, with configurable default |
ASK_POOLID() |
Getter for POOLID w/ exceptions if field has no value |
HAS_POOLID() |
Determine if POOLID has a value |
Status¶
The current status of the pool update request.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
MessageType¶
The type of message for the pool to use.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MESSAGETYPE() |
Getter for MESSAGETYPE, with configurable default |
ASK_MESSAGETYPE() |
Getter for MESSAGETYPE w/ exceptions if field has no value |
HAS_MESSAGETYPE() |
Determine if MESSAGETYPE has a value |
TwoWayEnabled¶
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TWOWAYENABLED() |
Getter for TWOWAYENABLED |
TwoWayChannelArn¶
The Amazon Resource Name (ARN) of the two way channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TWOWAYCHANNELARN() |
Getter for TWOWAYCHANNELARN, with configurable default |
ASK_TWOWAYCHANNELARN() |
Getter for TWOWAYCHANNELARN w/ exceptions if field has no va |
HAS_TWOWAYCHANNELARN() |
Determine if TWOWAYCHANNELARN has a value |
TwoWayChannelRole¶
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TWOWAYCHANNELROLE() |
Getter for TWOWAYCHANNELROLE, with configurable default |
ASK_TWOWAYCHANNELROLE() |
Getter for TWOWAYCHANNELROLE w/ exceptions if field has no v |
HAS_TWOWAYCHANNELROLE() |
Determine if TWOWAYCHANNELROLE has a value |
SelfManagedOptOutsEnabled¶
When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SELFMANAGEDOPTOUTSENBD() |
Getter for SELFMANAGEDOPTOUTSENABLED |
OptOutListName¶
The name of the OptOutList associated with the pool.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OPTOUTLISTNAME() |
Getter for OPTOUTLISTNAME, with configurable default |
ASK_OPTOUTLISTNAME() |
Getter for OPTOUTLISTNAME w/ exceptions if field has no valu |
HAS_OPTOUTLISTNAME() |
Determine if OPTOUTLISTNAME has a value |
SharedRoutesEnabled¶
Indicates whether shared routes are enabled for the pool.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHAREDROUTESENABLED() |
Getter for SHAREDROUTESENABLED |
DeletionProtectionEnabled¶
When set to true the pool can't be deleted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DELETIONPROTECTIONENBD() |
Getter for DELETIONPROTECTIONENABLED |
CreatedTimestamp¶
The time when the pool was created, in UNIX epoch time format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDTIMESTAMP() |
Getter for CREATEDTIMESTAMP, with configurable default |
ASK_CREATEDTIMESTAMP() |
Getter for CREATEDTIMESTAMP w/ exceptions if field has no va |
HAS_CREATEDTIMESTAMP() |
Determine if CREATEDTIMESTAMP has a value |