RcsAgentInformation
The information for an RCS agent in an AWS account.
Contents
- CreatedTimestamp
-
The time when the RCS agent was created, in UNIX epoch time
format. Type: Timestamp
Required: Yes
- DeletionProtectionEnabled
-
When set to true the RCS agent can't be deleted.
Type: Boolean
Required: Yes
- RcsAgentArn
-
The Amazon Resource Name (ARN) of the RCS agent.
Type: String
Required: Yes
- RcsAgentId
-
The unique identifier for the RCS agent.
Type: String
Required: Yes
- 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.
Type: Boolean
Required: Yes
- Status
-
The current status of the RCS agent.
Type: String
Valid Values:
CREATED | PENDING | TESTING | PARTIAL | ACTIVE | DELETEDRequired: Yes
- TwoWayEnabled
-
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
Type: Boolean
Required: Yes
- OptOutListName
-
The name of the OptOutList associated with the RCS agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[A-Za-z0-9_-]+Required: No
- PoolId
-
The unique identifier of the pool associated with the RCS agent.
Type: String
Required: No
- TestingAgent
-
The testing agent information associated with the RCS agent.
Type: TestingAgentInformation object
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
- TwoWayMediaS3BucketName
-
The name of the S3 bucket where inbound RCS media files are stored.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
[a-z0-9][a-z0-9.-]*[a-z0-9]Required: No
- TwoWayMediaS3KeyPrefix
-
The key prefix used for inbound RCS media objects in the S3 bucket.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\S]+Required: No
- TwoWayMediaS3Role
-
The ARN of the IAM role used to write inbound RCS media files to the S3 bucket.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:\S+Required: No
- TwoWayRcsEventsEnabled
-
The list of RCS event types enabled for two-way messaging on the agent.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
