GetEventSelectors
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
-
If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
-
If your event selector includes management events.
-
If your event selector includes data events, the resources on which you are logging data events.
For more information, see Logging Data and Management Events for Trails in the Amazon CloudTrail User Guide.
Request Syntax
{
"TrailName": "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.
- TrailName
-
Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
If you specify a trail ARN, it must be in the format:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Type: String
Required: Yes
-
Response Syntax
{
"AdvancedEventSelectors": [
{
"FieldSelectors": [
{
"EndsWith": [ "string" ],
"Equals": [ "string" ],
"Field": "string",
"NotEndsWith": [ "string" ],
"NotEquals": [ "string" ],
"NotStartsWith": [ "string" ],
"StartsWith": [ "string" ]
}
],
"Name": "string"
}
],
"EventSelectors": [
{
"DataResources": [
{
"Type": "string",
"Values": [ "string" ]
}
],
"ExcludeManagementEventSources": [ "string" ],
"IncludeManagementEvents": boolean,
"ReadWriteType": "string"
}
],
"TrailARN": "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.
- AdvancedEventSelectors
-
The advanced event selectors that are configured for the trail.
Type: Array of AdvancedEventSelector objects
- EventSelectors
-
The event selectors that are configured for the trail.
Type: Array of EventSelector objects
- TrailARN
-
The specified trail ARN that has the event selectors.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidTrailNameException
-
This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
HTTP Status Code: 400
-
- OperationNotPermittedException
-
This exception is thrown when the requested operation is not permitted.
HTTP Status Code: 400
- TrailNotFoundException
-
This exception is thrown when the trail with the given name is not found.
HTTP Status Code: 400
- UnsupportedOperationException
-
This exception is thrown when the requested operation is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: