AWS::SMSVOICE::RcsAgent

SMSVOICE RcsAgent

An AWS RCS Agent in AWS End User Messaging SMS. The RCS agent is the top-level resource representing your brand for RCS messaging, and serves as an origination identity for sending RCS messages. A newly created agent is in CREATED status; it advances through TESTING, PARTIAL and ACTIVE only as testing and country launch registrations are submitted and approved by carriers.

Properties

11 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`DeletionProtectionEnabled`	`boolean`
`OptOutListName`	`string`
`SelfManagedOptOutsEnabled`	`boolean`
`Tags`	`Array<Tag>`
`TwoWayChannelArn`	`string`
`TwoWayChannelRole`	`string`
`TwoWayEnabled`	`boolean`
`TwoWayMediaS3BucketName`	`string`
`TwoWayMediaS3KeyPrefix`	`string`
`TwoWayMediaS3Role`	`string`
`TwoWayRcsEventsEnabled`	`Array<string>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CreatedTimestamp`	`string`	The time when the RCS agent was created.
`PoolId`	`string`	The unique identifier of the pool associated with the RCS agent. This is populated only while the agent is associated with a pool, which is done through the pool APIs rather than through this resource.
`RcsAgentArn`	`string`	The Amazon Resource Name (ARN) of the RCS agent.
`RcsAgentId`	`string`	The unique identifier for the RCS agent, in the format rcs- followed by a hexadecimal string.
`Status`	`string`	The current status of the RCS agent. CREATED means the agent exists but no registration has been submitted. PENDING means a registration is awaiting processing. TESTING means the testing registration is approved and the agent can message registered test devices. PARTIAL means at least one country launch is active. ACTIVE means all submitted country launches are active. DELETED means the agent has been deleted.
`TestingAgent`	`TestingAgentInformation`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::SMSVOICE::RcsAgent

Resources:
  MyResource:
    Type: AWS::SMSVOICE::RcsAgent
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

sms-voice:CreateRcsAgentsms-voice:UpdateRcsAgentsms-voice:TagResourceiam:PassRole

read

sms-voice:DescribeRcsAgentssms-voice:ListTagsForResource

update

sms-voice:DescribeRcsAgentssms-voice:UpdateRcsAgentsms-voice:TagResourcesms-voice:UntagResourcesms-voice:ListTagsForResourceiam:PassRole

delete

sms-voice:DeleteRcsAgentsms-voice:DescribeRcsAgentssms-voice:ListTagsForResource

list

sms-voice:DescribeRcsAgents

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceSMSVOICE

Properties17

Required0

TaggingSupported

Primary IDRcsAgentArn

Supported Operations

CreateReadUpdateDeleteList

Related Resources

External Links

AWS Documentation