CloudTrail / Client / get_event_data_store
get_event_data_store#
- CloudTrail.Client.get_event_data_store(**kwargs)#
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_event_data_store( EventDataStore='string' )
- Parameters:
EventDataStore (string) –
[REQUIRED]
The ARN (or ID suffix of the ARN) of the event data store about which you want information.
- Return type:
dict
- Returns:
Response Syntax
{ 'EventDataStoreArn': 'string', 'Name': 'string', 'Status': 'CREATED'|'ENABLED'|'PENDING_DELETION'|'STARTING_INGESTION'|'STOPPING_INGESTION'|'STOPPED_INGESTION', 'AdvancedEventSelectors': [ { 'Name': 'string', 'FieldSelectors': [ { 'Field': 'string', 'Equals': [ 'string', ], 'StartsWith': [ 'string', ], 'EndsWith': [ 'string', ], 'NotEquals': [ 'string', ], 'NotStartsWith': [ 'string', ], 'NotEndsWith': [ 'string', ] }, ] }, ], 'MultiRegionEnabled': True|False, 'OrganizationEnabled': True|False, 'RetentionPeriod': 123, 'TerminationProtectionEnabled': True|False, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'KmsKeyId': 'string', 'BillingMode': 'EXTENDABLE_RETENTION_PRICING'|'FIXED_RETENTION_PRICING', 'FederationStatus': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED', 'FederationRoleArn': 'string', 'PartitionKeys': [ { 'Name': 'string', 'Type': 'string' }, ] }
Response Structure
(dict) –
EventDataStoreArn (string) –
The event data store Amazon Resource Number (ARN).
Name (string) –
The name of the event data store.
Status (string) –
The status of an event data store.
AdvancedEventSelectors (list) –
The advanced event selectors used to select events for the data store.
(dict) –
Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the Logging data events, Logging network activity events, and Logging management events topics in the CloudTrail User Guide.
You cannot apply both event selectors and advanced event selectors to a trail.
Supported CloudTrail event record fields for management events
eventCategory
(required)eventSource
readOnly
The following additional fields are available for event data stores:
eventName
eventType
sessionCredentialFromConsole
userIdentity.arn
Supported CloudTrail event record fields for data events
eventCategory
(required)resources.type
(required)readOnly
eventName
resources.ARN
The following additional fields are available for event data stores:
eventSource
eventType
sessionCredentialFromConsole
userIdentity.arn
Supported CloudTrail event record fields for network activity events
Note
Network activity events is in preview release for CloudTrail and is subject to change.
eventCategory
(required)eventSource
(required)eventName
errorCode
- The only valid value forerrorCode
isVpceAccessDenied
.vpcEndpointId
Note
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is
eventCategory
.Name (string) –
An optional, descriptive name for an advanced event selector, such as “Log data events for only two S3 buckets”.
FieldSelectors (list) –
Contains all selector statements in an advanced event selector.
(dict) –
A single selector statement in an advanced event selector.
Field (string) –
A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.
For CloudTrail management events, supported fields include
eventCategory
(required),eventSource
, andreadOnly
. The following additional fields are available for event data stores:eventName
,eventType
,sessionCredentialFromConsole
, anduserIdentity.arn
.For CloudTrail data events, supported fields include
eventCategory
(required),resources.type
(required),eventName
,readOnly
, andresources.ARN
. The following additional fields are available for event data stores:eventSource
,eventType
,sessionCredentialFromConsole
, anduserIdentity.arn
.For CloudTrail network activity events, supported fields include
eventCategory
(required),eventSource
(required),eventName
,errorCode
, andvpcEndpointId
.For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is
eventCategory
.readOnly
- This is an optional field that is only used for management events and data events. This field can be set toEquals
with a value oftrue
orfalse
. If you do not add this field, CloudTrail logs bothread
andwrite
events. A value oftrue
logs onlyread
events. A value offalse
logs onlywrite
events.eventSource
- This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set toNotEquals
kms.amazonaws.com
to exclude KMS management events, orNotEquals
rdsdata.amazonaws.com
to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses theEquals
operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. The following are valid values for network activity events:cloudtrail.amazonaws.com
ec2.amazonaws.com
kms.amazonaws.com
secretsmanager.amazonaws.com
eventName
- This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator witheventName
. You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas.eventCategory
- This field is required and must be set toEquals
.For CloudTrail management events, the value must be
Management
.For CloudTrail data events, the value must be
Data
.For CloudTrail network activity events, the value must be
NetworkActivity
.
The following are used only for event data stores:
For CloudTrail Insights events, the value must be
Insight
.For Config configuration items, the value must be
ConfigurationItem
.For Audit Manager evidence, the value must be
Evidence
.For events outside of Amazon Web Services, the value must be
ActivityAuditLog
.
eventType
- This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see CloudTrail record contents in the CloudTrail user guide.errorCode
- This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only validerrorCode
isVpceAccessDenied
.errorCode
can only use theEquals
operator.sessionCredentialFromConsole
- This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an Amazon Web Services Management Console session.sessionCredentialFromConsole
can only use theEquals
andNotEquals
operators.resources.type
- This field is required for CloudTrail data events.resources.type
can only use theEquals
operator. For a list of available resource types for data events, see Data events in the CloudTrail User Guide. You can have only oneresources.type
field per selector. To log events on more than one resource type, add another selector.resources.ARN
- Theresources.ARN
is an optional field for data events. You can use any operator withresources.ARN
, but if you useEquals
orNotEquals
, the value must exactly match the ARN of a valid resource of the type you’ve specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use theStartsWith
operator, and include only the bucket ARN as the matching value. For information about filtering data events on theresources.ARN
field, see Filtering data events by resources.ARN in the CloudTrail User Guide.
Note
You can’t use the
resources.ARN
field to filter resource types that do not have ARNs.userIdentity.arn
- This is an optional field available only for event data stores, which is used to filter management and data events on the userIdentity ARN. You can use any operator withuserIdentity.arn
. For more information on the userIdentity element, see CloudTrail userIdentity element in the CloudTrail User Guide.vpcEndpointId
- This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator withvpcEndpointId
.
Equals (list) –
An operator that includes events that match the exact value of the event record field specified as the value of
Field
. This is the only valid operator that you can use with thereadOnly
,eventCategory
, andresources.type
fields.(string) –
StartsWith (list) –
An operator that includes events that match the first few characters of the event record field specified as the value of
Field
.(string) –
EndsWith (list) –
An operator that includes events that match the last few characters of the event record field specified as the value of
Field
.(string) –
NotEquals (list) –
An operator that excludes events that match the exact value of the event record field specified as the value of
Field
.(string) –
NotStartsWith (list) –
An operator that excludes events that match the first few characters of the event record field specified as the value of
Field
.(string) –
NotEndsWith (list) –
An operator that excludes events that match the last few characters of the event record field specified as the value of
Field
.(string) –
MultiRegionEnabled (boolean) –
Indicates whether the event data store includes events from all Regions, or only from the Region in which it was created.
OrganizationEnabled (boolean) –
Indicates whether an event data store is collecting logged events for an organization in Organizations.
RetentionPeriod (integer) –
The retention period of the event data store, in days.
TerminationProtectionEnabled (boolean) –
Indicates that termination protection is enabled.
CreatedTimestamp (datetime) –
The timestamp of the event data store’s creation.
UpdatedTimestamp (datetime) –
Shows the time that an event data store was updated, if applicable.
UpdatedTimestamp
is always either the same or newer than the time shown inCreatedTimestamp
.KmsKeyId (string) –
Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
BillingMode (string) –
The billing mode for the event data store.
FederationStatus (string) –
Indicates the Lake query federation status. The status is
ENABLED
if Lake query federation is enabled, orDISABLED
if Lake query federation is disabled. You cannot delete an event data store if theFederationStatus
isENABLED
.FederationRoleArn (string) –
If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.
PartitionKeys (list) –
The partition keys for the event data store. To improve query performance and efficiency, CloudTrail Lake organizes event data into partitions based on values derived from partition keys.
(dict) –
Contains information about a partition key for an event data store.
Name (string) –
The name of the partition key.
Type (string) –
The data type of the partition key. For example,
bigint
orstring
.
Exceptions
CloudTrail.Client.exceptions.EventDataStoreARNInvalidException
CloudTrail.Client.exceptions.EventDataStoreNotFoundException
CloudTrail.Client.exceptions.InvalidParameterException
CloudTrail.Client.exceptions.OperationNotPermittedException
CloudTrail.Client.exceptions.UnsupportedOperationException
CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException