Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444270263.9 KB

Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are integers between 90 and 2557. By default, TerminationProtection is enabled.

For event data stores for CloudTrail events, AdvancedEventSelectors includes or excludes management and data events in your event data store. For more information about AdvancedEventSelectors, see PutEventSelectorsRequest$AdvancedEventSelectors.

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, AdvancedEventSelectors includes events of that type in your event data store.

post/#X-Amz-Target=com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101.UpdateEventDataStore

Headers

X-Amz-Target'com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101.UpdateEventDataStore' required

Request body

EventDataStorestring required

The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

Namestring

The event data store name.

MultiRegionEnabledboolean

Specifies whether an event data store collects events from all regions, or only from the region in which it was created.

OrganizationEnabledboolean

Specifies whether an event data store collects events logged for an organization in Organizations.

RetentionPeriodinteger

The retention period, in days.

TerminationProtectionEnabledboolean

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

KmsKeyIdstring
<p>Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by <code>alias/</code>, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</p> <important> <p>Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.</p> </important> <p>CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>Examples:</p> <ul> <li> <p> <code>alias/MyAliasName</code> </p> </li> <li> <p> <code>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</code> </p> </li> <li> <p> <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p> <code>12345678-1234-1234-1234-123456789012</code> </p> </li> </ul>

Response

Success

EventDataStoreArnstring

The ARN of the event data store.

Namestring

The name of the event data store.

Status'CREATED' | 'ENABLED' | 'PENDING_DELETION'

The status of an event data store. Values can be <code>ENABLED</code> and <code>PENDING_DELETION</code>.

MultiRegionEnabledboolean

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

OrganizationEnabledboolean

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

RetentionPeriodinteger

The retention period, in days.

TerminationProtectionEnabledboolean

Indicates whether termination protection is enabled for the event data store.

CreatedTimestampstring date-time

The timestamp that shows when an event data store was first created.

UpdatedTimestampstring date-time

The timestamp that shows when the event data store was last updated. <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in <code>CreatedTimestamp</code>.

KmsKeyIdstring
<p>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.</p> <p> <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p>