AWS CLI Command Reference

[ aws . connect ]

create-notification

Description

Creates a new notification to be delivered to specified recipients. Notifications can include localized content with embedded links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.

See also: AWS API Documentation

Synopsis

  create-notification
--instance-id <value>
[--expires-at <value>]
--recipients <value>
[--priority <value>]
--content <value>
[--tags <value>]
[--predefined-notification-id <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]

Options

--instance-id (string) [required]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Constraints:

  • min: 1
  • max: 100

--expires-at (timestamp)

The timestamp when the notification should expire and no longer be displayed to users. If not specified, defaults to one week from creation.

--recipients (list) [required]

A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Can include user ARNs or instance ARNs to target all users in an instance. Maximum of 200 recipients.

Constraints:

  • max: 200

(string)

Syntax:

"string" "string" ...

--priority (string)

The priority level of the notification. Valid values are HIGH and LOW. High priority notifications are displayed above low priority notifications.

Possible values:

  • HIGH
  • LOW

--content (map) [required]

The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale. Content supports markdown formatting and embedded links. Maximum 250 characters per locale.

key -> (string)

The locale code for localized content. Supported values include en_US, de_DE, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW.

Possible values:

  • en_US
  • de_DE
  • es_ES
  • fr_FR
  • id_ID
  • it_IT
  • ja_JP
  • ko_KR
  • pt_BR
  • zh_CN
  • zh_TW

value -> (string)

A localized string value. Maximum length is 500 characters.

Constraints:

  • min: 0
  • max: 500

Shorthand Syntax:

  KeyName1=string,KeyName2=string

Where valid key names are:
  en_US
  de_DE
  es_ES
  fr_FR
  id_ID
  it_IT
  ja_JP
  ko_KR
  pt_BR
  zh_CN
  zh_TW

JSON Syntax:

{"en_US"|"de_DE"|"es_ES"|"fr_FR"|"id_ID"|"it_IT"|"ja_JP"|"ko_KR"|"pt_BR"|"zh_CN"|"zh_TW": "string"
  ...}

--tags (map)

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} } .

Constraints:

  • min: 1
  • max: 50

key -> (string)

Constraints:

  • min: 1
  • max: 128
  • pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

value -> (string)

Constraints:

  • max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--predefined-notification-id (string)

The unique identifier for a notification.

Constraints:

  • min: 1
  • max: 256

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs .

Constraints:

  • max: 500

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

Output

NotificationId -> (string)

The unique identifier assigned to the created notification.

Constraints:

  • min: 1
  • max: 256

NotificationArn -> (string)

The Amazon Resource Name (ARN) of the created notification.
© Copyright 2026, Amazon Web Services. Created using Sphinx.