rcs_agents

Creates, updates, deletes, gets or lists a rcs_agents resource.

Overview

Name	rcs_agents
Type	Resource
Id	aws.pinpoint_sms_voice_v2.rcs_agents

Fields

The following fields are returned by SELECT queries:

describe_rcs_agents

Name	Datatype	Description
created_timestamp	string (date-time)	The time when the RCS agent was created, in UNIX epoch time format.
deletion_protection_enabled	boolean	When set to true the RCS agent can't be deleted.
opt_out_list_name	string	The name of the OptOutList associated with the RCS agent. (pattern: <code>[A-Za-z0-9_-]+</code>)
pool_id	string	The unique identifier of the pool associated with the RCS agent.
rcs_agent_arn	string	The Amazon Resource Name (ARN) of the RCS agent.
rcs_agent_id	string	The unique identifier for the RCS agent.
self_managed_opt_outs_enabled	boolean	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.
status	string	The current status of the RCS agent. (CREATED, PENDING, TESTING, PARTIAL, ACTIVE, DELETED)
testing_agent	object	The testing agent information associated with the RCS agent.
two_way_channel_arn	string	The Amazon Resource Name (ARN) of the two way channel. (pattern: <code>\S+</code>)
two_way_channel_role	string	An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. (pattern: <code>arn:\S+</code>)
two_way_enabled	boolean	When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
two_way_media_s3_bucket_name	string	The name of the S3 bucket where inbound RCS media files are stored. (pattern: <code>[a-z0-9][a-z0-9.-]*[a-z0-9]</code>)
two_way_media_s3_key_prefix	string	The key prefix used for inbound RCS media objects in the S3 bucket. (pattern: <code>[\S]+</code>)
two_way_media_s3_role	string	The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. (pattern: <code>arn:\S+</code>)
two_way_rcs_events_enabled	array	The list of RCS event types enabled for two-way messaging on the agent.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_rcs_agents	select	region		Retrieves the specified RCS agents or all RCS agents associated with your Amazon Web Services account. If you specify RCS agent IDs, the output includes information for only the specified RCS agents. If you specify filters, the output includes information for only those RCS agents that meet the filter criteria. If you don't specify RCS agent IDs or filters, the output includes information for all RCS agents.
create_rcs_agent	insert	region		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.
update_rcs_agent	update	region, RcsAgentId		Updates the configuration of an existing RCS agent. You can update the opt-out list, deletion protection, two-way messaging settings, and self-managed opt-outs configuration.
delete_rcs_agent	delete	region		Deletes an existing RCS agent. If deletion protection is enabled, an error is returned.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_rcs_agents

Retrieves the specified RCS agents or all RCS agents associated with your Amazon Web Services account. If you specify RCS agent IDs, the output includes information for only the specified RCS agents. If you specify filters, the output includes information for only those RCS agents that meet the filter criteria. If you don't specify RCS agent IDs or filters, the output includes information for all RCS agents.

SELECT
created_timestamp,
deletion_protection_enabled,
opt_out_list_name,
pool_id,
rcs_agent_arn,
rcs_agent_id,
self_managed_opt_outs_enabled,
status,
testing_agent,
two_way_channel_arn,
two_way_channel_role,
two_way_enabled,
two_way_media_s3_bucket_name,
two_way_media_s3_key_prefix,
two_way_media_s3_role,
two_way_rcs_events_enabled
FROM aws.pinpoint_sms_voice_v2.rcs_agents
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_rcs_agent

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.

INSERT INTO aws.pinpoint_sms_voice_v2.rcs_agents (
DeletionProtectionEnabled,
OptOutListName,
Tags,
ClientToken,
region
)
SELECT 
{{ DeletionProtectionEnabled }},
'{{ OptOutListName }}',
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
created_timestamp,
deletion_protection_enabled,
opt_out_list_name,
rcs_agent_arn,
rcs_agent_id,
self_managed_opt_outs_enabled,
status,
tags,
two_way_channel_arn,
two_way_channel_role,
two_way_enabled,
two_way_media_s3_bucket_name,
two_way_media_s3_key_prefix,
two_way_media_s3_role,
two_way_rcs_events_enabled
;

Manifest

# Description fields are for documentation purposes
- name: rcs_agents
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the rcs_agents resource.
  - name: DeletionProtectionEnabled
    value: {{ DeletionProtectionEnabled }}
    description: |
      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.
  - name: OptOutListName
    value: "{{ OptOutListName }}"
    description: |
      The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.
  - name: Tags
    description: |
      An array of tags (key and value pairs) associated with the RCS agent.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      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.

UPDATE examples

update_rcs_agent

Updates the configuration of an existing RCS agent. You can update the opt-out list, deletion protection, two-way messaging settings, and self-managed opt-outs configuration.

UPDATE aws.pinpoint_sms_voice_v2.rcs_agents
SET 
RcsAgentId = '{{ RcsAgentId }}',
DeletionProtectionEnabled = {{ DeletionProtectionEnabled }},
OptOutListName = '{{ OptOutListName }}',
SelfManagedOptOutsEnabled = {{ SelfManagedOptOutsEnabled }},
TwoWayChannelArn = '{{ TwoWayChannelArn }}',
TwoWayChannelRole = '{{ TwoWayChannelRole }}',
TwoWayEnabled = {{ TwoWayEnabled }},
TwoWayMediaS3BucketName = '{{ TwoWayMediaS3BucketName }}',
TwoWayMediaS3KeyPrefix = '{{ TwoWayMediaS3KeyPrefix }}',
TwoWayMediaS3Role = '{{ TwoWayMediaS3Role }}',
TwoWayRcsEventsEnabled = '{{ TwoWayRcsEventsEnabled }}'
WHERE 
region = '{{ region }}' --required
AND RcsAgentId = '{{ RcsAgentId }}' --required
RETURNING
created_timestamp,
deletion_protection_enabled,
opt_out_list_name,
rcs_agent_arn,
rcs_agent_id,
self_managed_opt_outs_enabled,
status,
two_way_channel_arn,
two_way_channel_role,
two_way_enabled,
two_way_media_s3_bucket_name,
two_way_media_s3_key_prefix,
two_way_media_s3_role,
two_way_rcs_events_enabled;

DELETE examples

delete_rcs_agent

Deletes an existing RCS agent. If deletion protection is enabled, an error is returned.

DELETE FROM aws.pinpoint_sms_voice_v2.rcs_agents
WHERE region = '{{ region }}' --required
;