[ aws . wafv2 ]

get-event

Description

Retrieves the details of the specified event for the specified web ACL, including the event actors that are associated with the event and the event timeline. Currently, this operation supports API Security Amazon Web Services Managed Rules.

See also: AWS API Documentation

Synopsis

  get-event
--scope <value>
--event-id <value>
--web-acl-arn <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>]
[--help]

Options

--scope (string) [required]

Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT .

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1 .
  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Possible values:

  • CLOUDFRONT
  • REGIONAL

--event-id (string) [required]

The unique identifier of the event. WAF returns the event ID in the responses to ListEvents and ListEventsByWebACL .

Constraints:

  • min: 1
  • max: 36
  • pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$

--web-acl-arn (string) [required]

The Amazon Resource Name (ARN) of the web ACL that the event is associated with.

Constraints:

  • min: 20
  • max: 2048
  • pattern: .*\S.*

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

--help (boolean)

Display help for the command/subcommand.

Output

Event -> (structure)

The details of the event.

EventId -> (string) [required]

The unique identifier of the event. You provide this to GetEvent to retrieve the details of the event.

Constraints:

  • min: 1
  • max: 36
  • pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$

EventStatus -> (string)

The current status of the event.

Possible values:

  • EVENT_STARTED
  • EVENT_IN_PROGRESS
  • EVENT_COMPLETED
  • EVENT_ENDED

EventCategory -> (string)

The category of the event. The only supported value is API_SECURITY .

Possible values:

  • API_SECURITY

StartTime -> (timestamp)

The time when the event started.

LastUpdatedTime -> (timestamp)

The time when the event was last updated.

EndTime -> (timestamp)

The time when the event ended. This is not populated while the event is ongoing.

ResourceArn -> (string)

The Amazon Resource Name (ARN) of the protected resource that the event is associated with.

Constraints:

  • min: 20
  • max: 2048
  • pattern: .*\S.*

WebAclArn -> (string)

The Amazon Resource Name (ARN) of the web ACL that the event is associated with.

Constraints:

  • min: 20
  • max: 2048
  • pattern: .*\S.*

ApiSecurityEventDetail -> (structure)

The API security details of the event, such as the label, category, confidence, API patterns, and event actors.

Label -> (string)

The fully qualified name of the label that WAF assigned to the event. For example, awswaf:managed:aws:api-security:credential-stuffing-high .

Constraints:

  • min: 1
  • max: 1024
  • pattern: ^[0-9A-Za-z_\-:]+$

Category -> (string)

The API security threat category of the event. For example, API2:2023 .

Constraints:

  • min: 1
  • max: 128
  • pattern: .*\S.*

Confidence -> (string)

The confidence level of the event detection: LOW , MEDIUM , or HIGH .

Possible values:

  • LOW
  • MEDIUM
  • HIGH

ApiPatterns -> (list)

The API patterns that the event involves. The list contains up to 20 API patterns.

Constraints:

  • max: 20

(structure)

An API endpoint pattern that an API security event involves.

Method -> (string)

The HTTP method of the API pattern. For example, GET or POST .

Constraints:

  • min: 1
  • max: 16

PathPattern -> (string)

The normalized URI path of the API pattern. Templated path segments are shown in braces. For example, /api/v1/accounts/{id} .

Constraints:

  • min: 1
  • max: 512

Port -> (integer)

The port of the API pattern. For example, 443 .

Constraints:

  • min: 0
  • max: 65535

Domains -> (list)

The domains that the API pattern was observed on. For example, api.example.com .

Constraints:

  • max: 100

(string)

Constraints:

  • min: 1
  • max: 256

EventActors -> (list)

The event actors that are associated with the event. The list contains up to 20 event actors. To retrieve the details of an event actor, provide its EventActorId to GetEventActor .

Constraints:

  • max: 20

(structure)

A reference to an event actor that is associated with an API security event.

EventActorId -> (string)

The unique identifier of the event actor. You provide this to GetEventActor to retrieve the details of the event actor.

Constraints:

  • min: 1
  • max: 36
  • pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$

EventActorValue -> (string)

The observed identifier of the event actor. For example, a client IP address or an authentication fingerprint.

Constraints:

  • min: 1
  • max: 512

Timeline -> (list)

The changes to the event’s label, confidence, and API patterns over time, ordered from oldest to newest. The list contains up to 32 entries.

For ListEvents and ListEventsByWebACL , this is returned only if you specify TIMELINE in the request Include setting.

Constraints:

  • max: 32

(structure)

A change to the label, confidence, or API patterns of an API security event.

ChangeTime -> (timestamp)

The time of the change.

Label -> (string)

The fully qualified name of the label that was assigned to the event at the time of the change.

Constraints:

  • min: 1
  • max: 1024
  • pattern: ^[0-9A-Za-z_\-:]+$

Confidence -> (string)

The confidence level of the event detection at the time of the change: LOW , MEDIUM , or HIGH .

Possible values:

  • LOW
  • MEDIUM
  • HIGH

ApiPatterns -> (list)

The API patterns that the event involved at the time of the change.

Constraints:

  • max: 20

(structure)

An API endpoint pattern that an API security event involves.

Method -> (string)

The HTTP method of the API pattern. For example, GET or POST .

Constraints:

  • min: 1
  • max: 16

PathPattern -> (string)

The normalized URI path of the API pattern. Templated path segments are shown in braces. For example, /api/v1/accounts/{id} .

Constraints:

  • min: 1
  • max: 512

Port -> (integer)

The port of the API pattern. For example, 443 .

Constraints:

  • min: 0
  • max: 65535

Domains -> (list)

The domains that the API pattern was observed on. For example, api.example.com .

Constraints:

  • max: 100

(string)

Constraints:

  • min: 1
  • max: 256