Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetEventDataStore

Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

Request Syntax


{
   "EventDataStore": "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.

EventDataStore

The ARN (or ID suffix of the ARN) of the event data store about which you want information.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 256.

Pattern: ^[a-zA-Z0-9._/\-:]+$

Required: Yes

Response Syntax


{
   "AdvancedEventSelectors": [ 
      { 
         "FieldSelectors": [ 
            { 
               "EndsWith": [ "string" ],
               "Equals": [ "string" ],
               "Field": "string",
               "NotEndsWith": [ "string" ],
               "NotEquals": [ "string" ],
               "NotStartsWith": [ "string" ],
               "StartsWith": [ "string" ]
            }
         ],
         "Name": "string"
      }
   ],
   "BillingMode": "string",
   "CreatedTimestamp": number,
   "EventDataStoreArn": "string",
   "FederationRoleArn": "string",
   "FederationStatus": "string",
   "KmsKeyId": "string",
   "MultiRegionEnabled": boolean,
   "Name": "string",
   "OrganizationEnabled": boolean,
   "PartitionKeys": [ 
      { 
         "Name": "string",
         "Type": "string"
      }
   ],
   "RetentionPeriod": number,
   "Status": "string",
   "TerminationProtectionEnabled": boolean,
   "UpdatedTimestamp": number
}

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 used to select events for the data store.

Type: Array of AdvancedEventSelector objects

BillingMode

The billing mode for the event data store.

Type: String

Valid Values: EXTENDABLE_RETENTION_PRICING | FIXED_RETENTION_PRICING

CreatedTimestamp

The timestamp of the event data store's creation.

Type: Timestamp

EventDataStoreArn

The event data store Amazon Resource Number (ARN).

Type: String

Length Constraints: Minimum length of 3. Maximum length of 256.

Pattern: ^[a-zA-Z0-9._/\-:]+$

FederationRoleArn

If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 125.

Pattern: ^[a-zA-Z0-9._/\-:@=\+,\.]+$

FederationStatus

Indicates the Lake query federation status. The status is ENABLED if Lake query federation is enabled, or DISABLED if Lake query federation is disabled. You cannot delete an event data store if the FederationStatus is ENABLED.

Type: String

Valid Values: ENABLING | ENABLED | DISABLING | DISABLED

KmsKeyId

Specifies the Amazon KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a Amazon KMS key in the following format.

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

Type: String

Length Constraints: Minimum length of 1. Maximum length of 350.

Pattern: ^[a-zA-Z0-9._/\-:]+$

MultiRegionEnabled

Indicates whether the event data store includes events from all Regions, or only from the Region in which it was created.

Type: Boolean

Name

The name of the event data store.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^[a-zA-Z0-9._\-]+$

OrganizationEnabled

Indicates whether an event data store is collecting logged events for an organization in Amazon Organizations.

Type: Boolean

PartitionKeys

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.

Type: Array of PartitionKey objects

Array Members: Maximum number of 2 items.

RetentionPeriod

The retention period of the event data store, in days.

Type: Integer

Valid Range: Minimum value of 7. Maximum value of 3653.

Status

The status of an event data store.

Type: String

TerminationProtectionEnabled

Indicates that termination protection is enabled.

Type: Boolean

UpdatedTimestamp

Shows the time that an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

EventDataStoreARNInvalidException

The specified event data store ARN is not valid or does not map to an event data store in your account.

HTTP Status Code: 400

EventDataStoreNotFoundException

The specified event data store was not found.

HTTP Status Code: 400

InvalidParameterException

The request includes a parameter that is not valid.

HTTP Status Code: 400

NoManagementAccountSLRExistsException

This exception is thrown when the management account does not have a service-linked role.

HTTP Status Code: 400

OperationNotPermittedException

This exception is thrown when the requested operation is not permitted.

HTTP Status Code: 400

UnsupportedOperationException

This exception is thrown when the requested operation is not supported.

HTTP Status Code: 400