Retrieves the details of the specified event actor. An event actor is a client that is associated with one or more events. The details include the latest observed attributes of the event actor, the events that it’s associated with, and the history of changes to its attributes. Currently, this operation supports API Security Amazon Web Services Managed Rules.
See also: AWS API Documentation
get-event-actor
--scope <value>
--event-actor-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>]
[--help]
--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:
CLOUDFRONTREGIONAL
--event-actor-id (string) [required]
The unique identifier of the event actor. WAF returns the event actor ID in the event details of ListEvents , ListEventsByWebACL , and GetEvent , and in the response to ListEventActors .
Constraints:
- min:
1- max:
36- pattern:
^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$
--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.
--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.
--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.
--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.
--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.
--help (boolean)
Display help for the command/subcommand.
EventActor -> (structure)
The details of the event actor.
Summary -> (structure) [required]
The latest observed attributes of the event actor.
EventActorId -> (string) [required]
The unique identifier of the event actor.
Constraints:
- min:
1- max:
36- pattern:
^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ClientIp -> (string)
The client IP address of the event actor.
Constraints:
- min:
1- max:
64TlsFingerprint -> (string)
The TLS fingerprint of the event actor, such as a JA3 or JA4 fingerprint.
Constraints:
- min:
1- max:
512Asn -> (string)
The autonomous system number (ASN) that is associated with the client IP address of the event actor.
Constraints:
- min:
1- max:
32AsnOrganization -> (string)
The name of the organization that owns the ASN. For example,
AMAZON-02.Constraints:
- min:
1- max:
256Country -> (string)
The country of the client IP address of the event actor.
Constraints:
- min:
1- max:
64AuthFingerprint -> (string)
A hash of the authentication credentials that the client of the event actor provides in the request. These can include a JSON Web Token (JWT), a JSON Web Encryption (JWE) token, an Amazon Web Services Signature Version 4 (SigV4) signature, or basic authentication credentials. You can use the fingerprint to match the same client across events and in your WAF logs.
Constraints:
- min:
1- max:
512CreatedAt -> (timestamp)
The time when WAF first observed the event actor.Events -> (list)
The API security events that the event actor is associated with. The list contains up to 20 events.
Constraints:
- max:
20(structure)
An API security event that an event actor is associated with.
EventId -> (string)
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}$StartTime -> (timestamp)
The time when the event started.Label -> (string)
The fully qualified name of the label that WAF assigned to the event.
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, orHIGH.Possible values:
LOWMEDIUMHIGHApiPatterns -> (list)
The API patterns that the event involves.
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,
GETorPOST.Constraints:
- min:
1- max:
16PathPattern -> (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:
512Port -> (integer)
The port of the API pattern. For example,
443.Constraints:
- min:
0- max:
65535Domains -> (list)
The domains that the API pattern was observed on. For example,
api.example.com.Constraints:
- max:
100(string)
Constraints:
- min:
1- max:
256Changes -> (list)
The history of changes to the network attributes of the event actor, ordered from oldest to newest. The list contains up to 20 entries.
Constraints:
- max:
20(structure)
A change to the network attributes of an event actor.
ChangeTime -> (timestamp)
The time of the change.ClientIp -> (string)
The client IP address of the event actor after the change.
Constraints:
- min:
1- max:
64TlsFingerprint -> (string)
The TLS fingerprint of the event actor after the change, such as a JA3 or JA4 fingerprint.
Constraints:
- min:
1- max:
512Asn -> (string)
The autonomous system number (ASN) that is associated with the client IP address after the change.
Constraints:
- min:
1- max:
32AsnOrganization -> (string)
The name of the organization that owns the ASN after the change.
Constraints:
- min:
1- max:
256Country -> (string)
The country of the client IP address after the change.
Constraints:
- min:
1- max:
64