get-sms-attributes¶

Description¶

Returns the settings for sending SMS messages from your Amazon Web Services account.

These settings are set with the SetSMSAttributes action.

Synopsis¶

  get-sms-attributes
[--attributes <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--attributes (list)

A list of the individual attribute names, such as MonthlySpendLimit , for which you want values.

For all attribute names, see SetSMSAttributes .

If you don’t use this parameter, Amazon SNS returns all SMS attributes.

(string)

Syntax:

"string" "string" ...

--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.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list the default SMS message attributes

The following get-sms-attributes example lists the default attributes for sending SMS messages.

aws sns get-sms-attributes

Output:

{
    "attributes": {
        "DefaultSenderID": "MyName"
    }
}

Output¶

attributes -> (map)

The SMS attribute names and their values.

key -> (string)

value -> (string)

Table of Contents

Feedback

User Guide