[ aws . notifications ]

list-notification-events

Description

Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).

Warning

User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn’t backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the AWS User Notifications User Guide .

See also: AWS API Documentation

list-notification-events is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: notificationEvents

Synopsis

  list-notification-events
[--start-time <value>]
[--end-time <value>]
[--locale <value>]
[--source <value>]
[--include-child-events | --no-include-child-events]
[--aggregate-notification-event-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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

--start-time (timestamp)

The earliest time of events to return from this call.

--end-time (timestamp)

Latest time of events to return from this call.

--locale (string)

The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US) .

Possible values:

• de_DE
• en_CA
• en_US
• en_UK
• es_ES
• fr_CA
• fr_FR
• id_ID
• it_IT
• ja_JP
• ko_KR
• pt_BR
• tr_TR
• zh_CN
• zh_TW

--source (string)

The matched event source.

Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch . For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide .

--include-child-events | --no-include-child-events (boolean)

Include aggregated child events in the result.

--aggregate-notification-event-arn (string)

The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

nextToken -> (string)

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

notificationEvents -> (list)

The list of notification events.

(structure)

Describes a short summary of a NotificationEvent. This is only used when listing notification events.

arn -> (string)

The Amazon Resource Name (ARN) of the resource.

notificationConfigurationArn -> (string)

The ARN of the NotificationConfiguration.

relatedAccount -> (string)

The account name containing the NotificationHub.

creationTime -> (timestamp)

The creation time of the NotificationEvent.

notificationEvent -> (structure)

Refers to a NotificationEventSummary object.

Similar in structure to content in the GetNotificationEvent response.

schemaVersion -> (string)

The schema version of the Notification Event.

sourceEventMetadata -> (structure)

The source event metadata.

eventOriginRegion -> (string)

The Region where the notification originated.

Unavailable for aggregated notifications.

source -> (string)

The matched event source.

Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch . For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide .

eventType -> (string)

The event type to match.

Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide .

messageComponents -> (structure)

The message components of a notification event.

headline -> (string)

A sentence long summary. For example, titles or an email subject line.

eventStatus -> (string)

The notification event status.

• Values:
  • HEALTHY
    • All EventRules are ACTIVE and any call can be run.
  • UNHEALTHY
    • Some EventRules are ACTIVE and some are INACTIVE . Any call can be run.

notificationType -> (string)

The type of event causing the notification.

• Values:
  • ALERT
    • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.
  • WARNING
    • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.
  • ANNOUNCEMENT
    • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.
  • INFORMATIONAL
    • A notification about informational messages. For example, recommendations, service announcements, or reminders.

aggregationEventType -> (string)

The NotificationConfiguration’s aggregation type.

• Values:
  • AGGREGATE
    • The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.
  • CHILD
    • Some EventRules are ACTIVE and some are INACTIVE . Any call can be run.
  • NONE
    • The notification isn’t aggregated.

aggregateNotificationEventArn -> (string)

The ARN of the aggregatedNotificationEventArn to match.