GetEvent
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 AWS Managed Rules.
Request Syntax
{
"EventId": "string",
"Scope": "string",
"WebAclArn": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- EventId
-
The unique identifier of the event. AWS WAF returns the event ID in the responses to ListEvents and ListEventsByWebACL.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$Required: Yes
- Scope
-
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS 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.
Type: String
Valid Values:
CLOUDFRONT | REGIONALRequired: Yes
-
- WebAclArn
-
The Amazon Resource Name (ARN) of the web ACL that the event is associated with.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
.*\S.*Required: Yes
Response Syntax
{
"Event": {
"ApiSecurityEventDetail": {
"ApiPatterns": [
{
"Domains": [ "string" ],
"Method": "string",
"PathPattern": "string",
"Port": number
}
],
"Category": "string",
"Confidence": "string",
"EventActors": [
{
"EventActorId": "string",
"EventActorValue": "string"
}
],
"Label": "string",
"Timeline": [
{
"ApiPatterns": [
{
"Domains": [ "string" ],
"Method": "string",
"PathPattern": "string",
"Port": number
}
],
"ChangeTime": number,
"Confidence": "string",
"Label": "string"
}
]
},
"EndTime": number,
"EventCategory": "string",
"EventId": "string",
"EventStatus": "string",
"LastUpdatedTime": number,
"ResourceArn": "string",
"StartTime": number,
"WebAclArn": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Event
-
The details of the event.
Type: EventDetailSummary object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- WAFInternalErrorException
-
Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request.
HTTP Status Code: 500
- WAFInvalidOperationException
-
The operation isn't valid.
HTTP Status Code: 400
- WAFInvalidParameterException
-
The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
-
You specified a parameter name or value that isn't valid.
-
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
-
You tried to update a
WebACLwith aDefaultActionthat isn't among the types available at DefaultAction. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
- Field
-
The settings where the invalid parameter was found.
- Parameter
-
The invalid parameter that resulted in the exception.
- Reason
-
Additional information about the exception.
HTTP Status Code: 400
-
- WAFNonexistentItemException
-
AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: