[ aws . pinpoint-sms-voice-v2 ]
send-rcs-message¶
Description¶
Creates a new RCS message and sends it to a recipient’s phone number. RCS messages support rich content including text, files, rich cards, and carousels with interactive suggested actions.
See also: AWS API Documentation
Synopsis¶
send-rcs-message
--destination-phone-number <value>
--origination-identity <value>
[--rcs-message-content <value>]
[--time-to-live <value>]
[--message-traffic-type <value>]
[--fallback-configuration <value>]
[--protect-configuration-id <value>]
[--configuration-set-name <value>]
[--max-price <value>]
[--dry-run | --no-dry-run]
[--context <value>]
[--message-feedback-enabled | --no-message-feedback-enabled]
[--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¶
--destination-phone-number (string) [required]
The destination phone number in E.164 format.
Constraints:
- min:
1- max:
20- pattern:
\+?[1-9][0-9]{1,18}
--origination-identity (string) [required]
The origination identity of the message. This can be either the RcsAgentId, RcsAgentArn, PoolId, or PoolArn.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9_:/\+-]+
--rcs-message-content (structure)
The content of the RCS message. Contains the message content (text, file, rich card, or carousel) and optional message-level suggested actions.
Content -> (tagged union structure) [required]
The content of the RCS message. Exactly one content type must be specified: TextMessage, FileMessage, RichCard, or Carousel.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:TextMessage,FileMessage,RichCard,Carousel.TextMessage -> (structure)
A plain text RCS message.
Body -> (string) [required]
The text body of the RCS message. Maximum 3072 characters.
Constraints:
- min:
1- max:
3072- pattern:
(?!\s*$)[\s\S]+FileMessage -> (structure)
A file message containing a media file (image, video, audio, or PDF) with an optional thumbnail.
FileUrl -> (string) [required]
The S3 URI of the media file to send, in the format
s3://bucket-name/key. The service downloads the file from your S3 bucket, rehosts it, and generates a presigned URL for the aggregator. Maximum 2000 characters.Constraints:
- min:
1- max:
2000- pattern:
(https://|s3://).+ThumbnailUrl -> (string)
The S3 URI of an optional thumbnail image for the media file, in the format
s3://bucket-name/key. Maximum 2000 characters.Constraints:
- min:
1- max:
2000- pattern:
(https://|s3://).+RichCard -> (structure)
A standalone rich card with media, title, description, and suggested actions.
CardOrientation -> (string) [required]
The orientation of the rich card. Valid values are HORIZONTAL and VERTICAL.
Constraints:
- min:
1- max:
50- pattern:
[A-Z_]+ThumbnailImageAlignment -> (string)
The alignment of the thumbnail image in a horizontal card. Valid values are LEFT and RIGHT. Only applicable when CardOrientation is HORIZONTAL.
Constraints:
- min:
1- max:
50- pattern:
[A-Z_]+CardContent -> (structure) [required]
The content of the rich card, including title, description, media, and card-level suggested actions.
Title -> (string)
The title of the card. Maximum 200 characters.
Constraints:
- min:
1- max:
200Description -> (string)
The description text of the card. Maximum 2000 characters.
Constraints:
- min:
1- max:
2000Media -> (structure)
The media content of the card, including the file URL, optional thumbnail, and display height.
FileUrl -> (string) [required]
The S3 URI of the media file for the card, in the format
s3://bucket-name/key. Maximum 2000 characters.Constraints:
- min:
1- max:
2000- pattern:
(https://|s3://).+ThumbnailUrl -> (string)
The S3 URI of an optional thumbnail image for the card media. Maximum 2000 characters.
Constraints:
- min:
1- max:
2000- pattern:
(https://|s3://).+Height -> (string)
The display height of the media in the card. Valid values are SHORT, MEDIUM, and TALL.
Constraints:
- min:
1- max:
50- pattern:
[A-Z_]+Suggestions -> (list)
Card-level suggested actions. Maximum 4 suggestions per card.
Constraints:
- min:
0- max:
4(tagged union structure)
A suggested action displayed to the RCS message recipient. Can be a reply, open URL, dial phone, show location, request location, or create calendar event.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Reply,OpenUrl,DialPhone,ShowLocation,RequestLocation,CreateCalendarEvent.Reply -> (structure)
A suggested reply that sends predefined text and postback data when tapped.
Text -> (string) [required]
The display text of the suggested reply. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this reply. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048OpenUrl -> (structure)
A suggested action that opens a URL in the user’s browser or a webview.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048Url -> (string) [required]
The URL to open. Must start with https://. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048- pattern:
https://\S+Application -> (string)
How to open the URL. BROWSER opens in the device’s default browser. WEBVIEW opens in an in-app webview.
Constraints:
- min:
1- max:
50- pattern:
[A-Z_]+WebviewViewMode -> (string)
The display mode of the webview. Valid values are FULL, HALF, and TALL. Only applicable when Application is WEBVIEW.
Constraints:
- min:
1- max:
50- pattern:
[A-Z_]+DialPhone -> (structure)
A suggested action that initiates a phone call to the specified number.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048PhoneNumber -> (string) [required]
The phone number to dial in E.164 format.
Constraints:
- min:
1- max:
20- pattern:
\+?[1-9][0-9]{1,18}ShowLocation -> (structure)
A suggested action that shows a location on a map.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048Latitude -> (double) [required]
The latitude of the location. Valid values are -90 to 90.
Constraints:
- min:
-90- max:
90Longitude -> (double) [required]
The longitude of the location. Valid values are -180 to 180.
Constraints:
- min:
-180- max:
180Label -> (string)
An optional label for the location pin. Maximum 100 characters.
Constraints:
- min:
1- max:
100RequestLocation -> (structure)
A suggested action that requests the user’s current location.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048CreateCalendarEvent -> (structure)
A suggested action that creates a calendar event on the user’s device.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048Title -> (string) [required]
The title of the calendar event. Maximum 100 characters.
Constraints:
- min:
1- max:
100StartTime -> (timestamp) [required]
The start time of the calendar event in ISO 8601 format.EndTime -> (timestamp) [required]
The end time of the calendar event in ISO 8601 format.Description -> (string)
An optional description for the calendar event. Maximum 500 characters.
Constraints:
- min:
1- max:
500Carousel -> (structure)
A carousel of 2 to 10 scrollable cards, each with media, title, description, and suggested actions.
CardWidth -> (string) [required]
The width of cards in the carousel. Valid values are SMALL and MEDIUM.
Constraints:
- min:
1- max:
50- pattern:
[A-Z_]+CardContents -> (list) [required]
The list of cards in the carousel. Minimum 2, maximum 10 cards.
Constraints:
- min:
2- max:
10(structure)
The content of a carousel card, including title, description, media, and card-level suggested actions. Media height is restricted to SHORT or MEDIUM.
Title -> (string)
The title of the carousel card. Maximum 200 characters.
Constraints:
- min:
1- max:
200Description -> (string)
The description text of the carousel card. Maximum 2000 characters.
Constraints:
- min:
1- max:
2000Media -> (structure)
The media content of the carousel card. Media height is restricted to SHORT or MEDIUM (TALL is not supported in carousels).
FileUrl -> (string) [required]
The S3 URI of the media file for the carousel card. Maximum 2000 characters.
Constraints:
- min:
1- max:
2000- pattern:
(https://|s3://).+ThumbnailUrl -> (string)
The S3 URI of an optional thumbnail image for the carousel card media. Maximum 2000 characters.
Constraints:
- min:
1- max:
2000- pattern:
(https://|s3://).+Height -> (string)
The display height of the media in the carousel card. Valid values are SHORT and MEDIUM.
Constraints:
- min:
1- max:
50- pattern:
[A-Z_]+Suggestions -> (list)
Card-level suggested actions for this carousel card. Maximum 4 suggestions per card.
Constraints:
- min:
0- max:
4(tagged union structure)
A suggested action displayed to the RCS message recipient. Can be a reply, open URL, dial phone, show location, request location, or create calendar event.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Reply,OpenUrl,DialPhone,ShowLocation,RequestLocation,CreateCalendarEvent.Reply -> (structure)
A suggested reply that sends predefined text and postback data when tapped.
Text -> (string) [required]
The display text of the suggested reply. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this reply. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048OpenUrl -> (structure)
A suggested action that opens a URL in the user’s browser or a webview.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048Url -> (string) [required]
The URL to open. Must start with https://. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048- pattern:
https://\S+Application -> (string)
How to open the URL. BROWSER opens in the device’s default browser. WEBVIEW opens in an in-app webview.
Constraints:
- min:
1- max:
50- pattern:
[A-Z_]+WebviewViewMode -> (string)
The display mode of the webview. Valid values are FULL, HALF, and TALL. Only applicable when Application is WEBVIEW.
Constraints:
- min:
1- max:
50- pattern:
[A-Z_]+DialPhone -> (structure)
A suggested action that initiates a phone call to the specified number.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048PhoneNumber -> (string) [required]
The phone number to dial in E.164 format.
Constraints:
- min:
1- max:
20- pattern:
\+?[1-9][0-9]{1,18}ShowLocation -> (structure)
A suggested action that shows a location on a map.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048Latitude -> (double) [required]
The latitude of the location. Valid values are -90 to 90.
Constraints:
- min:
-90- max:
90Longitude -> (double) [required]
The longitude of the location. Valid values are -180 to 180.
Constraints:
- min:
-180- max:
180Label -> (string)
An optional label for the location pin. Maximum 100 characters.
Constraints:
- min:
1- max:
100RequestLocation -> (structure)
A suggested action that requests the user’s current location.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048CreateCalendarEvent -> (structure)
A suggested action that creates a calendar event on the user’s device.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048Title -> (string) [required]
The title of the calendar event. Maximum 100 characters.
Constraints:
- min:
1- max:
100StartTime -> (timestamp) [required]
The start time of the calendar event in ISO 8601 format.EndTime -> (timestamp) [required]
The end time of the calendar event in ISO 8601 format.Description -> (string)
An optional description for the calendar event. Maximum 500 characters.
Constraints:
- min:
1- max:
500Suggestions -> (list)
Message-level suggested actions displayed to the recipient. Maximum 11 suggestions per message.
Constraints:
- min:
0- max:
11(tagged union structure)
A suggested action displayed to the RCS message recipient. Can be a reply, open URL, dial phone, show location, request location, or create calendar event.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Reply,OpenUrl,DialPhone,ShowLocation,RequestLocation,CreateCalendarEvent.Reply -> (structure)
A suggested reply that sends predefined text and postback data when tapped.
Text -> (string) [required]
The display text of the suggested reply. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this reply. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048OpenUrl -> (structure)
A suggested action that opens a URL in the user’s browser or a webview.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048Url -> (string) [required]
The URL to open. Must start with https://. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048- pattern:
https://\S+Application -> (string)
How to open the URL. BROWSER opens in the device’s default browser. WEBVIEW opens in an in-app webview.
Constraints:
- min:
1- max:
50- pattern:
[A-Z_]+WebviewViewMode -> (string)
The display mode of the webview. Valid values are FULL, HALF, and TALL. Only applicable when Application is WEBVIEW.
Constraints:
- min:
1- max:
50- pattern:
[A-Z_]+DialPhone -> (structure)
A suggested action that initiates a phone call to the specified number.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048PhoneNumber -> (string) [required]
The phone number to dial in E.164 format.
Constraints:
- min:
1- max:
20- pattern:
\+?[1-9][0-9]{1,18}ShowLocation -> (structure)
A suggested action that shows a location on a map.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048Latitude -> (double) [required]
The latitude of the location. Valid values are -90 to 90.
Constraints:
- min:
-90- max:
90Longitude -> (double) [required]
The longitude of the location. Valid values are -180 to 180.
Constraints:
- min:
-180- max:
180Label -> (string)
An optional label for the location pin. Maximum 100 characters.
Constraints:
- min:
1- max:
100RequestLocation -> (structure)
A suggested action that requests the user’s current location.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048CreateCalendarEvent -> (structure)
A suggested action that creates a calendar event on the user’s device.
Text -> (string) [required]
The display text of the action. Maximum 25 characters.
Constraints:
- min:
1- max:
25PostbackData -> (string) [required]
The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
Constraints:
- min:
1- max:
2048Title -> (string) [required]
The title of the calendar event. Maximum 100 characters.
Constraints:
- min:
1- max:
100StartTime -> (timestamp) [required]
The start time of the calendar event in ISO 8601 format.EndTime -> (timestamp) [required]
The end time of the calendar event in ISO 8601 format.Description -> (string)
An optional description for the calendar event. Maximum 500 characters.
Constraints:
- min:
1- max:
500
JSON Syntax:
{
"Content": {
"TextMessage": {
"Body": "string"
},
"FileMessage": {
"FileUrl": "string",
"ThumbnailUrl": "string"
},
"RichCard": {
"CardOrientation": "string",
"ThumbnailImageAlignment": "string",
"CardContent": {
"Title": "string",
"Description": "string",
"Media": {
"FileUrl": "string",
"ThumbnailUrl": "string",
"Height": "string"
},
"Suggestions": [
{
"Reply": {
"Text": "string",
"PostbackData": "string"
},
"OpenUrl": {
"Text": "string",
"PostbackData": "string",
"Url": "string",
"Application": "string",
"WebviewViewMode": "string"
},
"DialPhone": {
"Text": "string",
"PostbackData": "string",
"PhoneNumber": "string"
},
"ShowLocation": {
"Text": "string",
"PostbackData": "string",
"Latitude": double,
"Longitude": double,
"Label": "string"
},
"RequestLocation": {
"Text": "string",
"PostbackData": "string"
},
"CreateCalendarEvent": {
"Text": "string",
"PostbackData": "string",
"Title": "string",
"StartTime": timestamp,
"EndTime": timestamp,
"Description": "string"
}
}
...
]
}
},
"Carousel": {
"CardWidth": "string",
"CardContents": [
{
"Title": "string",
"Description": "string",
"Media": {
"FileUrl": "string",
"ThumbnailUrl": "string",
"Height": "string"
},
"Suggestions": [
{
"Reply": {
"Text": "string",
"PostbackData": "string"
},
"OpenUrl": {
"Text": "string",
"PostbackData": "string",
"Url": "string",
"Application": "string",
"WebviewViewMode": "string"
},
"DialPhone": {
"Text": "string",
"PostbackData": "string",
"PhoneNumber": "string"
},
"ShowLocation": {
"Text": "string",
"PostbackData": "string",
"Latitude": double,
"Longitude": double,
"Label": "string"
},
"RequestLocation": {
"Text": "string",
"PostbackData": "string"
},
"CreateCalendarEvent": {
"Text": "string",
"PostbackData": "string",
"Title": "string",
"StartTime": timestamp,
"EndTime": timestamp,
"Description": "string"
}
}
...
]
}
...
]
}
},
"Suggestions": [
{
"Reply": {
"Text": "string",
"PostbackData": "string"
},
"OpenUrl": {
"Text": "string",
"PostbackData": "string",
"Url": "string",
"Application": "string",
"WebviewViewMode": "string"
},
"DialPhone": {
"Text": "string",
"PostbackData": "string",
"PhoneNumber": "string"
},
"ShowLocation": {
"Text": "string",
"PostbackData": "string",
"Latitude": double,
"Longitude": double,
"Label": "string"
},
"RequestLocation": {
"Text": "string",
"PostbackData": "string"
},
"CreateCalendarEvent": {
"Text": "string",
"PostbackData": "string",
"Title": "string",
"StartTime": timestamp,
"EndTime": timestamp,
"Description": "string"
}
}
...
]
}
--time-to-live (integer)
The duration in seconds that the RCS message is valid for delivery. If the message cannot be delivered within this duration, it is considered expired. Valid values are 1 to 172800 (48 hours). If a FallbackConfiguration is provided, the fallback is triggered when the duration expires without delivery confirmation.
Constraints:
- min:
1- max:
172800
--message-traffic-type (string)
The traffic type of the RCS message. Valid values are AUTHENTICATION, TRANSACTION, PROMOTION, SERVICE_REQUEST, and ACKNOWLEDGEMENT. This field is reserved for future use.
Constraints:
- min:
1- max:
50
--fallback-configuration (structure)
Configuration for SMS or MMS fallback when RCS delivery fails. If provided, the service sends a fallback message via the specified channel when the RCS message fails or the TimeToLive expires.
Channel -> (string) [required]
The fallback channel to use when RCS delivery fails. Valid values are SMS and MMS. SMS and MMS are mutually exclusive.
Possible values:
SMSMMSMessageBody -> (string)
The text body of the fallback message. Required for SMS fallback. For MMS fallback, at least one of MessageBody or MediaUrls must be provided.
Constraints:
- min:
1- max:
1600- pattern:
(?!\s*$)[\s\S]+MediaUrls -> (list)
An array of S3 URIs to media files for MMS fallback. Only valid when Channel is MMS.
Constraints:
- min:
1- max:
1(string)
Constraints:
- min:
1- max:
2048- pattern:
s3://([a-z0-9\.-]{3,63})/(.+)OriginationIdentity -> (string)
The origination identity to use for the fallback message. This can be a PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. Pool IDs and pool ARNs are not accepted. If not specified and the original message was sent via a pool, the service selects a suitable number from the pool.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9_:/\+-]+
Shorthand Syntax:
Channel=string,MessageBody=string,MediaUrls=string,string,OriginationIdentity=string
JSON Syntax:
{
"Channel": "SMS"|"MMS",
"MessageBody": "string",
"MediaUrls": ["string", ...],
"OriginationIdentity": "string"
}
--protect-configuration-id (string)
The unique identifier of the protect configuration to use.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9_:/-]+
--configuration-set-name (string)
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9_:/-]+
--max-price (string)
The maximum amount that you want to spend, in US dollars, per each RCS message.
Constraints:
- min:
2- max:
8- pattern:
[0-9]{0,2}\.[0-9]{1,5}
--dry-run | --no-dry-run (boolean)
When set to true, the message is checked and validated, but isn’t sent to the end recipient.
--context (map)
You can specify custom data in this field. If you do, that data is logged to the event destination.
Constraints:
- min:
0- max:
5key -> (string)
Constraints:
- min:
1- max:
100- pattern:
\S+value -> (string)
Constraints:
- min:
1- max:
800- pattern:
(?!\s)^[\s\S]+(?<!\s)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--message-feedback-enabled | --no-message-feedback-enabled (boolean)
Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback .
--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