update-sms-channel¶

Description¶

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

Synopsis¶

  update-sms-channel
--application-id <value>
--sms-channel-request <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]

Options¶

--application-id (string)

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

--sms-channel-request (structure)

Specifies the status and settings of the SMS channel for an application.

Enabled -> (boolean)

Specifies whether to enable the SMS channel for the application.

SenderId -> (string)

The identity that you want to display on recipients’ devices when they receive messages from the SMS channel.

ShortCode -> (string)

The registered short code that you want to use when you send messages through the SMS channel.

Shorthand Syntax:

Enabled=boolean,SenderId=string,ShortCode=string

JSON Syntax:

{
  "Enabled": true|false,
  "SenderId": "string",
  "ShortCode": "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.

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

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

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 enable SMS channel or to update the status and settings of the SMS channel for an application.

The following update-sms-channel example enables SMS channel for an SMS channel for an application.

aws pinpoint update-sms-channel \
    --application-id 611e3e3cdd47474c9c1399a505665b91 \
    --sms-channel-request Enabled=true \
    --region us-west-2

Output:

{
    "SMSChannelResponse": {
        "ApplicationId": "611e3e3cdd47474c9c1399a505665b91",
        "CreationDate": "2019-01-28T23:25:25.224Z",
        "Enabled": true,
        "Id": "sms",
        "IsArchived": false,
        "LastModifiedDate": "2023-05-18T23:22:50.977Z",
        "Platform": "SMS",
        "PromotionalMessagesPerSecond": 20,
        "TransactionalMessagesPerSecond": 20,
        "Version": 3
    }
}

For more information, see Amazon Pinpoint SMS channel in the Amazon Pinpoint User Guide.

Output¶

SMSChannelResponse -> (structure)

Provides information about the status and settings of the SMS channel for an application.

ApplicationId -> (string)

The unique identifier for the application that the SMS channel applies to.

CreationDate -> (string)

The date and time, in ISO 8601 format, when the SMS channel was enabled.

Enabled -> (boolean)

Specifies whether the SMS channel is enabled for the application.

HasCredential -> (boolean)

(Not used) This property is retained only for backward compatibility.

Id -> (string)

(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

IsArchived -> (boolean)

Specifies whether the SMS channel is archived.

LastModifiedBy -> (string)

The user who last modified the SMS channel.

LastModifiedDate -> (string)

The date and time, in ISO 8601 format, when the SMS channel was last modified.

Platform -> (string)

The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

PromotionalMessagesPerSecond -> (integer)

The maximum number of promotional messages that you can send through the SMS channel each second.

SenderId -> (string)

The identity that displays on recipients’ devices when they receive messages from the SMS channel.

ShortCode -> (string)

The registered short code to use when you send messages through the SMS channel.

TransactionalMessagesPerSecond -> (integer)

The maximum number of transactional messages that you can send through the SMS channel each second.

Version -> (integer)

The current version of the SMS channel.

Table of Contents

Feedback

User Guide