/AWS1/CL_PP2RCSAGENTINFO¶
The information for an RCS agent in an Amazon Web Services account.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_rcsagentarn TYPE /AWS1/PP2STRING /AWS1/PP2STRING¶
The Amazon Resource Name (ARN) of the RCS agent.
iv_rcsagentid TYPE /AWS1/PP2STRING /AWS1/PP2STRING¶
The unique identifier for the RCS agent.
iv_status TYPE /AWS1/PP2RCSAGENTSTATUS /AWS1/PP2RCSAGENTSTATUS¶
The current status of the RCS agent.
iv_createdtimestamp TYPE /AWS1/PP2TIMESTAMP /AWS1/PP2TIMESTAMP¶
The time when the RCS agent was created, in UNIX epoch time format.
iv_deletionprotectionenabled TYPE /AWS1/PP2PRIMITIVEBOOLEAN /AWS1/PP2PRIMITIVEBOOLEAN¶
When set to true the RCS agent can't be deleted.
iv_selfmanagedoptoutsenabled TYPE /AWS1/PP2PRIMITIVEBOOLEAN /AWS1/PP2PRIMITIVEBOOLEAN¶
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_twowayenabled TYPE /AWS1/PP2PRIMITIVEBOOLEAN /AWS1/PP2PRIMITIVEBOOLEAN¶
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
Optional arguments:¶
iv_optoutlistname TYPE /AWS1/PP2OPTOUTLISTNAME /AWS1/PP2OPTOUTLISTNAME¶
The name of the OptOutList associated with the RCS agent.
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_poolid TYPE /AWS1/PP2STRING /AWS1/PP2STRING¶
The unique identifier of the pool associated with the RCS agent.
iv_twowaymedias3bucketname TYPE /AWS1/PP2TWOWAYMEDIAS3BKTNAME /AWS1/PP2TWOWAYMEDIAS3BKTNAME¶
The name of the S3 bucket where inbound RCS media files are stored.
iv_twowaymedias3keyprefix TYPE /AWS1/PP2TWOWAYMEDIAS3KEYPREF /AWS1/PP2TWOWAYMEDIAS3KEYPREF¶
The key prefix used for inbound RCS media objects in the S3 bucket.
iv_twowaymedias3role TYPE /AWS1/PP2IAMROLEARN /AWS1/PP2IAMROLEARN¶
The ARN of the IAM role used to write inbound RCS media files to the S3 bucket.
it_twowayrcseventsenabled TYPE /AWS1/CL_PP2RCSEVENTTYPELIST_W=>TT_RCSEVENTTYPELIST TT_RCSEVENTTYPELIST¶
The list of RCS event types enabled for two-way messaging on the agent.
io_testingagent TYPE REF TO /AWS1/CL_PP2TESTINGAGENTINFO /AWS1/CL_PP2TESTINGAGENTINFO¶
The testing agent information associated with the RCS agent.
Queryable Attributes¶
RcsAgentArn¶
The Amazon Resource Name (ARN) of the RCS agent.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RCSAGENTARN() |
Getter for RCSAGENTARN, with configurable default |
ASK_RCSAGENTARN() |
Getter for RCSAGENTARN w/ exceptions if field has no value |
HAS_RCSAGENTARN() |
Determine if RCSAGENTARN has a value |
RcsAgentId¶
The unique identifier for the RCS agent.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RCSAGENTID() |
Getter for RCSAGENTID, with configurable default |
ASK_RCSAGENTID() |
Getter for RCSAGENTID w/ exceptions if field has no value |
HAS_RCSAGENTID() |
Determine if RCSAGENTID has a value |
Status¶
The current status of the RCS agent.
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 |
CreatedTimestamp¶
The time when the RCS agent 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 |
DeletionProtectionEnabled¶
When set to true the RCS agent can't be deleted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DELETIONPROTECTIONENBD() |
Getter for DELETIONPROTECTIONENABLED |
OptOutListName¶
The name of the OptOutList associated with the RCS agent.
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 |
SelfManagedOptOutsEnabled¶
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 |
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 |
TwoWayEnabled¶
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TWOWAYENABLED() |
Getter for TWOWAYENABLED |
PoolId¶
The unique identifier of the pool associated with the RCS agent.
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 |
TwoWayMediaS3BucketName¶
The name of the S3 bucket where inbound RCS media files are stored.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TWOWAYMEDIAS3BUCKETNAME() |
Getter for TWOWAYMEDIAS3BUCKETNAME, with configurable defaul |
ASK_TWOWAYMEDIAS3BUCKETNAME() |
Getter for TWOWAYMEDIAS3BUCKETNAME w/ exceptions if field ha |
HAS_TWOWAYMEDIAS3BUCKETNAME() |
Determine if TWOWAYMEDIAS3BUCKETNAME has a value |
TwoWayMediaS3KeyPrefix¶
The key prefix used for inbound RCS media objects in the S3 bucket.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TWOWAYMEDIAS3KEYPREFIX() |
Getter for TWOWAYMEDIAS3KEYPREFIX, with configurable default |
ASK_TWOWAYMEDIAS3KEYPREFIX() |
Getter for TWOWAYMEDIAS3KEYPREFIX w/ exceptions if field has |
HAS_TWOWAYMEDIAS3KEYPREFIX() |
Determine if TWOWAYMEDIAS3KEYPREFIX has a value |
TwoWayMediaS3Role¶
The ARN of the IAM role used to write inbound RCS media files to the S3 bucket.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TWOWAYMEDIAS3ROLE() |
Getter for TWOWAYMEDIAS3ROLE, with configurable default |
ASK_TWOWAYMEDIAS3ROLE() |
Getter for TWOWAYMEDIAS3ROLE w/ exceptions if field has no v |
HAS_TWOWAYMEDIAS3ROLE() |
Determine if TWOWAYMEDIAS3ROLE has a value |
TwoWayRcsEventsEnabled¶
The list of RCS event types enabled for two-way messaging on the agent.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TWOWAYRCSEVENTSENABLED() |
Getter for TWOWAYRCSEVENTSENABLED, with configurable default |
ASK_TWOWAYRCSEVENTSENABLED() |
Getter for TWOWAYRCSEVENTSENABLED w/ exceptions if field has |
HAS_TWOWAYRCSEVENTSENABLED() |
Determine if TWOWAYRCSEVENTSENABLED has a value |
TestingAgent¶
The testing agent information associated with the RCS agent.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TESTINGAGENT() |
Getter for TESTINGAGENT |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_RCSAGENTINFORMATIONLIST¶
TYPES TT_RCSAGENTINFORMATIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_PP2RCSAGENTINFO WITH DEFAULT KEY
.