ListEvents
Retrieves a paginated list of event summaries for your account. Use this operation to monitor and investigate potential threats to the resources that your web ACLs protect. Results are paginated. Use the NextMarker value from the response to retrieve the next batch of results. Currently, this operation supports API Security AWS Managed Rules.
You can filter the results by time window, event category, resource, and API pattern, and sort them by start time, end time, or confidence.
To retrieve the events for a single web ACL, use ListEventsByWebACL. To retrieve the full details of a single event, use GetEvent.
Request Syntax
{
"ApiPatternFilters": [
{
"Domains": [ "string" ],
"Method": "string",
"PathPattern": "string",
"Port": number
}
],
"Filters": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"Include": [ "string" ],
"Limit": number,
"NextMarker": "string",
"Scope": "string",
"SortBy": "string",
"SortOrder": "string",
"TimeWindow": {
"EndTime": number,
"StartTime": number
}
}
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.
- ApiPatternFilters
-
Filters that narrow the results to events that involve the specified API patterns. If you specify more than one API pattern filter, AWS WAF returns the events that match any of the filters. You can specify up to 20 API pattern filters.
Type: Array of ApiPatternFilter objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required: No
- Filters
-
Filters that narrow the results by event category or by the Amazon Resource Name (ARN) of the protected resource. You can specify up to 8 filters.
Type: Array of EventFilter objects
Array Members: Minimum number of 1 item. Maximum number of 8 items.
Required: No
- Include
-
Additional fields to return with each event summary. By default, the response includes only the default summary fields.
Specify
TIMELINEto return the timeline of each event inApiSecurityEventDetail$Timeline.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Valid Values:
TIMELINERequired: No
- Limit
-
The maximum number of events that you want AWS WAF to return for this request. Valid values are 1 to 20. If more events are available, AWS WAF returns a
NextMarkervalue in the response that you can use in a subsequent call to get the next batch of events.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No
- NextMarker
-
When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.The marker is valid only for a request with the same
TimeWindow,Filters,SortBy, andSortOrdersettings as the request that returned it.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*\S.*Required: No
- 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
-
- SortBy
-
The field that AWS WAF sorts the events by. Valid values:
-
CONFIDENCE- Sort by the confidence level of the event detection. -
END_TIME- Sort by the time that the event ended. -
START_TIME- Sort by the time that the event started.
Type: String
Valid Values:
START_TIME | END_TIME | CONFIDENCERequired: No
-
- SortOrder
-
The order in which AWS WAF sorts the events. Valid values:
-
ASC- Sort in ascending order. -
DESC- Sort in descending order. This is the default.
Type: String
Valid Values:
ASC | DESCRequired: No
-
- TimeWindow
-
The time range for the events to return. If you don't specify a time window, AWS WAF returns events from the past year. The time window can't be longer than one year.
Type: TimeWindow object
Required: No
Response Syntax
{
"Events": [
{
"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"
}
],
"NextMarker": "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.
- Events
-
The list of event summaries.
Type: Array of EventDetailSummary objects
Array Members: Maximum number of 100 items.
- NextMarker
-
When you request a list of objects with a
Limitsetting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns aNextMarkervalue in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*\S.*
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
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: