get-alert¶

Description¶

Retrieves a single alert by its identifier.

Use ListAlerts to enumerate alerts in the space.

Synopsis¶

  get-alert
--space-id <value>
--alert-id <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]
[--cli-error-format <value>]

Options¶

--space-id (string) [required]

The unique ID of the space.

Constraints:

pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

--alert-id (string) [required]

The alert to retrieve.

Constraints:

min: 32

max: 32

pattern: [0-9a-f]{32}

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

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

alert -> (structure)

The full alert entity.

name -> (string) [required]

The name of the alert.

alertId -> (string)

The stable alert identifier (see {@link AlertId}), minted on create and immutable across updates. Use it (not {@code name}) to address the alert on GetAlert/UpdateAlert/DeleteAlert; it is also the ARN’s resource id.

Constraints:

min: 32

max: 32

pattern: [0-9a-f]{32}

description -> (string)

An optional description of the alert.

accountId -> (string) [required]

The AWS account ID that owns the alert.

Constraints:

min: 12

max: 12

pattern: [0-9]{12}

spaceId -> (string)

The ID of the space the alert belongs to.

Constraints:

pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

profileId -> (string)

The ID of the access profile associated with the alert.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9_-]+

rule -> (tagged union structure) [required]

The rule that defines how the alert is evaluated.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: telemetryRule.

telemetryRule -> (structure)

The telemetry-based rule definition.

query -> (structure)

The query expression to evaluate.

language -> (string) [required]

The query language of the expression.

Possible values:

SQL

PROMQL

expression -> (string) [required]

The query expression to evaluate.

Constraints:

min: 1

max: 10000

condition -> (structure)

The condition that determines when the alert fires.

thresholdMode -> (string)

How the threshold is applied to query results.

Possible values:

COUNT_OF_RESULTS

FIELD_VALUE

thresholdField -> (string)

The field the threshold is evaluated against.

Constraints:

min: 0

max: 256

comparator -> (string)

The comparison operator applied to the threshold.

Possible values:

GT

LT

GTE

LTE

warningThreshold -> (double)

The value at which the alert enters the WARNING state.

criticalThreshold -> (double)

The value at which the alert enters the CRITICAL state.

evaluation -> (structure)

The evaluation cadence and durations.

intervalSeconds -> (integer) [required]

The interval between evaluations, in seconds.

pendingDurationSeconds -> (integer)

The duration a breach must persist before the alert fires, in seconds.

recoveryDurationSeconds -> (integer)

The duration a recovery must persist before the alert clears, in seconds.

noData -> (structure)

How the alert behaves when a query produces no data.

treatAs -> (string) [required]

The state to report when an evaluation produces no data.

Possible values:

OK

WARNING

CRITICAL

NODATA

notificationStatus -> (string)

Whether notifications are enabled.

Possible values:

ENABLED

DISABLED

state -> (structure)

Live evaluation state (read-only, system-managed). Populated by GetAlert. ListAlerts reports state on AlertSummary instead, where it stays required.

Absent on CreateAlert: a newly created alert has never been evaluated, so any state reported there would be a default rather than an observation. Call GetAlert for live state. Not @required for that reason — GetAlert always populates it.

contributorSummary is nested inside this member, so it too is absent on CreateAlert.

value -> (string) [required]

Current flat state.

Possible values:

OK

WARNING

CRITICAL

NODATA

transitionedAt -> (timestamp)

When the alert transitioned to its current state.

contributorSummary -> (structure)

Counts of contributors currently breaching each severity threshold. Present only when contributor-level tracking is active; absent until the first contributor breaches a {@code WARNING} or {@code CRITICAL} threshold.

warningCount -> (integer)

Number of contributors currently breaching the warning threshold.

criticalCount -> (integer)

Number of contributors currently breaching the critical threshold.

data -> (structure)

Structured detail about why the alert is in its current state.

thresholdBreached -> (double)

For COUNT_OF_RESULTS alerts, the row count that breached; null for FIELD_VALUE (multi-contributor) alerts.

notificationRules -> (list)

The notification rules for the alert.

Constraints:

min: 0

max: 5

(structure)

Single notification rule: which transitions trigger this rule and where the resulting notification should be sent.

trigger -> (structure) [required]

The conditions that trigger this notification rule.

stateValues -> (list)

Alert state(s) that trigger this rule. Empty / omitted = any state.

Constraints:

min: 0

max: 4

(string)

Flat alert state. Severity is folded in: a WARNING/CRITICAL alert reports that state directly. {@code NODATA} indicates the evaluation produced no data (subject to the rule’s noData.treatAs handling).

Possible values:

OK

WARNING

CRITICAL

NODATA

target -> (structure) [required]

The destination for notifications from this rule.

type -> (string) [required]

The type of notification target.

Possible values:

sns

slack

pagerduty

arn -> (string) [required]

The Amazon Resource Name (ARN) of the notification target. For {@code slack} and {@code pagerduty}, an integration ARN as returned by {@code ListIntegrations}.

Constraints:

min: 1

max: 1024

pattern: arn:.+

metadata -> (map)

Additional target-specific metadata.

Constraints:

min: 0

max: 20

key -> (string)

Constraints:

min: 1

max: 128

value -> (string)

Constraints:

min: 0

max: 1024

createdAt -> (timestamp) [required]

The timestamp when the alert was created.

updatedAt -> (timestamp) [required]

The timestamp when the alert was last updated.

alertArn -> (string) [required]

The Amazon Resource Name (ARN) of the alert.

Constraints:

min: 1

max: 2048

pattern: arn:.+

Table of Contents

Feedback

User Guide