ListEventActors
Retrieves a paginated list of the event actors in your account that are associated with events in the specified time window. An event actor is a client that is associated with one or more events. The operation returns up to the top 100 event actors by event count. 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.
Request Syntax
{
"Limit": number,
"NextMarker": "string",
"Scope": "string",
"SortBy": "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.
- Limit
-
The maximum number of event actors that you want AWS WAF to return for this request. Valid values are 1 to 100. If more event actors are available, AWS WAF returns a
NextMarkervalue in the response that you can use in a subsequent call to get the next batch of event actors.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
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.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 to sort event actors by. The only supported value is
EVENT_COUNT.Type: String
Valid Values:
EVENT_COUNTRequired: No
- TimeWindow
-
The time range for the event actors to return. The time window can't be longer than one year.
Type: TimeWindow object
Required: Yes
Response Syntax
{
"EventActors": [
{
"Asn": "string",
"AsnOrganization": "string",
"AuthFingerprint": "string",
"ClientIp": "string",
"Country": "string",
"CreatedAt": number,
"EventActorId": "string",
"EventCount": number,
"TlsFingerprint": "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.
- EventActors
-
The list of event actor summaries.
Type: Array of EventActorSummary 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: