AWS CLI Command Reference

[ aws . connect ]

search-notifications

Description

Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.

See also: AWS API Documentation

Synopsis

  search-notifications
--instance-id <value>
[--next-token <value>]
[--max-results <value>]
[--search-filter <value>]
[--search-criteria <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

--next-token (string)

The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.

--max-results (integer)

The maximum number of results to return per page. Valid range is 1-100.

Constraints:

  • min: 1
  • max: 100

--search-filter (structure)

Filters to apply to the search results, such as tag-based filters.

AttributeFilter -> (structure)

Attribute-based filters to apply to the search results.

OrConditions -> (list)

A list of conditions which would be applied together with an OR condition.

(structure)

A list of conditions which would be applied together with an AND condition.

TagConditions -> (list)

A leaf node condition which can be used to specify a tag condition.

(structure)

A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .

TagKey -> (string)

The tag key in the tag condition.

TagValue -> (string)

The tag value in the tag condition.

AndCondition -> (structure)

A list of conditions which would be applied together with an AND condition.

TagConditions -> (list)

A leaf node condition which can be used to specify a tag condition.

(structure)

A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .

TagKey -> (string)

The tag key in the tag condition.

TagValue -> (string)

The tag value in the tag condition.

TagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .

TagKey -> (string)

The tag key in the tag condition.

TagValue -> (string)

The tag value in the tag condition.

JSON Syntax:

{
  "AttributeFilter": {
    "OrConditions": [
      {
        "TagConditions": [
          {
            "TagKey": "string",
            "TagValue": "string"
          }
          ...
        ]
      }
      ...
    ],
    "AndCondition": {
      "TagConditions": [
        {
          "TagKey": "string",
          "TagValue": "string"
        }
        ...
      ]
    },
    "TagCondition": {
      "TagKey": "string",
      "TagValue": "string"
    }
  }
}

--search-criteria (structure)

The search criteria to apply when searching for notifications. Supports filtering by notification ID and message content using comparison types such as STARTS_WITH, CONTAINS, and EXACT.

OrConditions -> (list)

A list of conditions to be met, where at least one condition must be satisfied.

(structure)

The search criteria to be used to return notifications.

OrConditions -> (list)

A list of conditions to be met, where at least one condition must be satisfied.

( … recursive … )

AndConditions -> (list)

A list of conditions that must all be satisfied.

( … recursive … )

StringCondition -> (structure)

A leaf node condition which can be used to specify a string condition.

FieldName -> (string)

The name of the field in the string condition.

Value -> (string)

The value of the string.

ComparisonType -> (string)

The type of comparison to be made when evaluating the string condition.

Possible values:

  • STARTS_WITH
  • CONTAINS
  • EXACT

AndConditions -> (list)

A list of conditions that must all be satisfied.

(structure)

The search criteria to be used to return notifications.

OrConditions -> (list)

A list of conditions to be met, where at least one condition must be satisfied.

( … recursive … )

AndConditions -> (list)

A list of conditions that must all be satisfied.

( … recursive … )

StringCondition -> (structure)

A leaf node condition which can be used to specify a string condition.

FieldName -> (string)

The name of the field in the string condition.

Value -> (string)

The value of the string.

ComparisonType -> (string)

The type of comparison to be made when evaluating the string condition.

Possible values:

  • STARTS_WITH
  • CONTAINS
  • EXACT

StringCondition -> (structure)

A leaf node condition which can be used to specify a string condition.

FieldName -> (string)

The name of the field in the string condition.

Value -> (string)

The value of the string.

ComparisonType -> (string)

The type of comparison to be made when evaluating the string condition.

Possible values:

  • STARTS_WITH
  • CONTAINS
  • EXACT

JSON Syntax:

{
  "OrConditions": [
    {
      "OrConditions": [
        { ... recursive ... }
        ...
      ],
      "AndConditions": [
        { ... recursive ... }
        ...
      ],
      "StringCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
      }
    }
    ...
  ],
  "AndConditions": [
    {
      "OrConditions": [
        { ... recursive ... }
        ...
      ],
      "AndConditions": [
        { ... recursive ... }
        ...
      ],
      "StringCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
      }
    }
    ...
  ],
  "StringCondition": {
    "FieldName": "string",
    "Value": "string",
    "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
  }
}

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

Notifications -> (list)

A list of notifications matching the search criteria.

(structure)

Summary information about a notification returned from a search operation.

Id -> (string)

The unique identifier for the notification.

Constraints:

  • min: 1
  • max: 256

Arn -> (string)

The Amazon Resource Name (ARN) of the notification.

InstanceId -> (string)

The identifier of the Amazon Connect instance.

Constraints:

  • min: 1
  • max: 100

Content -> (map)

The localized content of the notification.

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

Priority -> (string)

The priority level of the notification.

Possible values:

  • URGENT
  • HIGH
  • LOW

Recipients -> (list)

A list of recipient Amazon Resource Names (ARNs).

Constraints:

  • max: 200

(string)

CreatedAt -> (timestamp)

The timestamp when the notification was created.

ExpiresAt -> (timestamp)

The timestamp when the notification expires.

LastModifiedRegion -> (string)

The AWS Region where the notification was last modified.

Constraints:

  • pattern: [a-z]{2}(-[a-z]+){1,2}(-[0-9])?

LastModifiedTime -> (timestamp)

The timestamp when the notification was last modified.

Tags -> (map)

The tags associated with the notification.

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

NextToken -> (string)

The token for the next set of results. If present, there are more results available.

ApproximateTotalCount -> (long)

The approximate total number of notifications matching the search criteria.
© Copyright 2026, Amazon Web Services. Created using Sphinx.