get_event_selectors¶
Operation¶
get_event_selectors
¶
get_event_selectors(request: GetEventSelectorsInput | GetEventSelectorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetEventSelectorsInputDict]) -> GetEventSelectorsOutput
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 management events, data events, and network activity events.
-
If your event selector includes management events.
-
If your event selector includes network activity events, the event sources for which you are logging network activity events.
-
If your event selector includes data events, the resources on which you are logging data events.
For more information about logging management, data, and network activity events, see the following topics in the CloudTrail User Guide:
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetEventSelectorsInput | GetEventSelectorsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetEventSelectorsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetEventSelectorsOutput
|
An instance of |
get_event_selectors
async
¶
get_event_selectors(request: GetEventSelectorsInput | GetEventSelectorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetEventSelectorsInputDict]) -> GetEventSelectorsOutput
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 management events, data events, and network activity events.
-
If your event selector includes management events.
-
If your event selector includes network activity events, the event sources for which you are logging network activity events.
-
If your event selector includes data events, the resources on which you are logging data events.
For more information about logging management, data, and network activity events, see the following topics in the CloudTrail User Guide:
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetEventSelectorsInput | GetEventSelectorsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetEventSelectorsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetEventSelectorsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetEventSelectorsInputDict
¶
Bases: TypedDict
Dictionary form of GetEventSelectorsInput.
Attributes¶
trail_name
instance-attribute
¶
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-_namespaceandmy--namespaceare 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
GetEventSelectorsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetEventSelectorsInput structure.
Attributes¶
trail_name
class-attribute
instance-attribute
¶
trail_name: str | None = ...
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-_namespaceandmy--namespaceare 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
Output¶
GetEventSelectorsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetEventSelectorsOutput structure.
Attributes¶
advanced_event_selectors
class-attribute
instance-attribute
¶
advanced_event_selectors: list[AdvancedEventSelector] | None = ...
The advanced event selectors that are configured for the trail.
event_selectors
class-attribute
instance-attribute
¶
event_selectors: list[EventSelector] | None = ...
The event selectors that are configured for the trail.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.