[ aws . notifications ]

get-notification-event

Description

Returns a specified NotificationEvent.

Warning

User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent 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

Synopsis

  get-notification-event
--arn <value>
[--locale <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

--arn (string)

The Amazon Resource Name (ARN) of the NotificationEvent to return.

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

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

arn -> (string)

The ARN of the resource.

notificationConfigurationArn -> (string)

The ARN of the NotificationConfiguration.

creationTime -> (timestamp)

The creation time of the NotificationEvent.

content -> (structure)

The content of the NotificationEvent.

schemaVersion -> (string)

The schema version of the Notification Event.

id -> (string)

The unique identifier for a NotificationEvent.

sourceEventMetadata -> (structure)

The source event metadata.

eventTypeVersion -> (string)

The version of the type of event.

sourceEventId -> (string)

The source event id.

eventOriginRegion -> (string)

The Region the event originated from.

relatedAccount -> (string)

The Primary AWS account of Source Event

source -> (string)

The AWS servvice the event originates from. For example aws.cloudwatch .

eventOccurrenceTime -> (timestamp)

The date and time the source event occurred. This is based on the Source Event.

eventType -> (string)

The type of event. For example, an AWS CloudWatch state change.

relatedResources -> (list)

A list of resources related to this NotificationEvent.

(structure)

A resource affected by or closely linked to an event.

id -> (string)

The unique identifier for the resource.

At least one id or ARN is required.

arn -> (string)

The Amazon Resource Name (ARN) of the resource. At least one id or ARN is required.

detailUrl -> (string)

The URL to the resource’s detail page. If a detail page URL is unavailable, it is the URL to an informational page that describes the resource’s type.

tags -> (list)

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

(string)

messageComponents -> (structure)

Describes the components of a notification message.

headline -> (string)

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

paragraphSummary -> (string)

A paragraph long or multiple sentence summary. For example, AWS Chatbot notifications.

completeDescription -> (string)

A complete summary with all possible relevant information.

dimensions -> (list)

A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

Note

Included dimensions, keys, and values are subject to change.

(structure)

The key-value pair of properties for an event.

name -> (string)

The name of the dimension

value -> (string)

The value of the dimension.

sourceEventDetailUrl -> (string)

The source event URL.

sourceEventDetailUrlDisplayText -> (string)

The detailed URL for the source event.

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.

eventStatus -> (string)

The assesed nature of the event.

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

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)

If the value of aggregationEventType is not NONE , this is the Amazon Resource Event (ARN) of the parent aggregate notification.

This is omitted if notification isn’t aggregated.

startTime -> (timestamp)

The notification event start time.

endTime -> (timestamp)

The end time of the event.

textParts -> (map)

A list of text values.

key -> (string)

value -> (structure)

Describes text information objects containing fields that determine how text part objects are composed.

type -> (string)

The type of text part. Determines the usage of all other fields and whether or not they’re required.

displayText -> (string)

A short single line description of the link. Must be hyperlinked with the URL itself.

Used for text parts with the type URL .

textByLocale -> (map)

A map of locales to the text in that locale.

key -> (string)

value -> (string)

url -> (string)

The URL itself.

media -> (list)

A list of media elements.

(structure)

Describes a media element.

mediaId -> (string)

The unique ID for the media.

type -> (string)

The type of media.

url -> (string)

The url of the media.

caption -> (string)

The caption of the media.