create-rcs-agent¶

Description¶

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.

Synopsis¶

  create-rcs-agent
[--deletion-protection-enabled | --no-deletion-protection-enabled]
[--opt-out-list-name <value>]
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--deletion-protection-enabled | --no-deletion-protection-enabled (boolean)

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.

--opt-out-list-name (string)

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

Constraints:

min: 1

max: 256

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

--tags (list)

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

Constraints:

min: 0

max: 200

(structure)

The list of tags to be added to the specified topic.

Key -> (string) [required]

The key identifier, or name, of the tag.

Constraints:

min: 1

max: 128

pattern: .+

Value -> (string) [required]

The string value associated with the key of the tag.

Constraints:

min: 0

max: 256

pattern: .*

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--client-token (string)

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.

Constraints:

min: 1

max: 64

pattern: [!-~]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

RcsAgentArn -> (string)

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

RcsAgentId -> (string)

The unique identifier for the RCS agent.

Status -> (string)

The current status of the RCS agent.

Possible values:

CREATED

PENDING

TESTING

PARTIAL

ACTIVE

DELETED

DeletionProtectionEnabled -> (boolean)

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

OptOutListName -> (string)

The name of the OptOutList associated with the RCS agent.

Constraints:

min: 1

max: 64

pattern: [A-Za-z0-9_-]+

CreatedTimestamp -> (timestamp)

The time when the RCS agent was created, in UNIX epoch time format.

SelfManagedOptOutsEnabled -> (boolean)

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.

TwoWayChannelArn -> (string)

The Amazon Resource Name (ARN) of the two way channel.

Constraints:

min: 20

max: 2048

pattern: \S+

TwoWayChannelRole -> (string)

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

Constraints:

min: 20

max: 2048

pattern: arn:\S+

TwoWayEnabled -> (boolean)

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

Tags -> (list)