GetEventDataStore - Amazon CloudTrail
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

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" } ], "CreatedTimestamp": number, "EventDataStoreArn": "string", "MultiRegionEnabled": boolean, "Name": "string", "OrganizationEnabled": boolean, "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

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._/\-:]+$

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

RetentionPeriod

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

Type: Integer

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

Status

The status of an event data store. Values can be ENABLED and PENDING_DELETION.

Type: String

Valid Values: CREATED | ENABLED | PENDING_DELETION

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

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

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: