Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateRcsAgent

Creates a new RCS agent for sending rich messages through the RCS channel. The RCS agent serves as an origination identity for sending RCS messages to your recipients.

Request Syntax


{
   "ClientToken": "string",
   "DeletionProtectionEnabled": boolean,
   "OptOutListName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

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.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No

DeletionProtectionEnabled

By default this is set to false. When set to true the RCS agent can't be deleted. You can change this value using the UpdateRcsAgent action.

Type: Boolean

Required: No

OptOutListName

The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: No

Tags

An array of tags (key and value pairs) associated with the RCS agent.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


{
   "CreatedTimestamp": number,
   "DeletionProtectionEnabled": boolean,
   "OptOutListName": "string",
   "RcsAgentArn": "string",
   "RcsAgentId": "string",
   "SelfManagedOptOutsEnabled": boolean,
   "Status": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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 RCS agent was created, in UNIX epoch time format.

Type: Timestamp

DeletionProtectionEnabled

When set to true deletion protection is enabled. By default this is set to false.

Type: Boolean

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_-]+

RcsAgentArn

The Amazon Resource Name (ARN) of the newly created RCS agent.

Type: String

RcsAgentId

The unique identifier for the RCS agent.

Type: String

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.

Type: Boolean

Status

The current status of the RCS agent.

Type: String

Tags

An array of tags (key and value pairs) associated with the RCS agent.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

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.

Reason: The reason for the exception.

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.

Reason: The reason for the exception.
ResourceId: The unique identifier of the request.
ResourceType: The type of resource that caused the exception.

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.

RequestId: The unique identifier of the request.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

ResourceId: The unique identifier of the resource.
ResourceType: The type of resource that caused the exception.

HTTP Status Code: 400

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

Reason: The reason for the exception.

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.

Fields: The field that failed validation.
Reason: The reason for the exception.

HTTP Status Code: 400