/AWS1/CL_PP2CREATERCSAGENTRSLT¶
CreateRcsAgentResult
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_rcsagentarn TYPE /AWS1/PP2STRING /AWS1/PP2STRING¶
The Amazon Resource Name (ARN) of the newly created 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_deletionprotectionenabled TYPE /AWS1/PP2PRIMITIVEBOOLEAN /AWS1/PP2PRIMITIVEBOOLEAN¶
When set to true deletion protection is enabled. By default this is set to false.
iv_createdtimestamp TYPE /AWS1/PP2TIMESTAMP /AWS1/PP2TIMESTAMP¶
The time when the RCS agent was created, in UNIX epoch time format.
iv_selfmanagedoptoutsenabled TYPE /AWS1/PP2PRIMITIVEBOOLEAN /AWS1/PP2PRIMITIVEBOOLEAN¶
By default this is set to false. 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¶
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
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_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. The role must have
s3:PutObjectpermission on the bucket and a trust policy allowingsms-voice.amazonaws.com.rproxy.govskope.usto assume it.
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.
it_tags TYPE /AWS1/CL_PP2TAG=>TT_TAGLIST TT_TAGLIST¶
An array of tags (key and value pairs) associated with the RCS agent.
Queryable Attributes¶
RcsAgentArn¶
The Amazon Resource Name (ARN) of the newly created 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 |
DeletionProtectionEnabled¶
When set to true deletion protection is enabled. By default this is set to false.
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 |
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 |
SelfManagedOptOutsEnabled¶
By default this is set to false. 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¶
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 |
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. The role must have
s3:PutObjectpermission on the bucket and a trust policy allowingsms-voice.amazonaws.com.rproxy.govskope.usto assume it.
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 |
Tags¶
An array of tags (key and value pairs) associated with the RCS agent.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |