Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateEventDataStore

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. AdvancedEventSelectors includes or excludes management and data events in your event data store; for more information about AdvancedEventSelectors, see PutEventSelectors:AdvancedEventSelectors.

Request Syntax


{
   "AdvancedEventSelectors": [ 
      { 
         "FieldSelectors": [ 
            { 
               "EndsWith": [ "string" ],
               "Equals": [ "string" ],
               "Field": "string",
               "NotEndsWith": [ "string" ],
               "NotEquals": [ "string" ],
               "NotStartsWith": [ "string" ],
               "StartsWith": [ "string" ]
            }
         ],
         "Name": "string"
      }
   ],
   "EventDataStore": "string",
   "MultiRegionEnabled": boolean,
   "Name": "string",
   "OrganizationEnabled": boolean,
   "RetentionPeriod": number,
   "TerminationProtectionEnabled": boolean
}

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.

AdvancedEventSelectors

The advanced event selectors used to select events for the event data store.

Type: Array of AdvancedEventSelector objects

Required: No

EventDataStore

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

Type: String

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

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

Required: Yes

MultiRegionEnabled

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

Type: Boolean

Required: No

Name

The event data store name.

Type: String

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

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

Required: No

OrganizationEnabled

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

Type: Boolean

Required: No

RetentionPeriod

The retention period, in days.

Type: Integer

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

Required: No

TerminationProtectionEnabled

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

Type: Boolean

Required: No

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 that are applied to the event data store.

Type: Array of AdvancedEventSelector objects

CreatedTimestamp

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

Type: Timestamp

EventDataStoreArn

The ARN of the event data store.

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, 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 whether termination protection is enabled for the event data store.

Type: Boolean

UpdatedTimestamp

The timestamp that shows when the event data store was last updated. 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.

CloudTrailAccessNotEnabledException

This exception is thrown when trusted access has not been enabled between Amazon CloudTrail and Amazon Organizations. For more information, see Enabling Trusted Access with Other Amazon Services and Prepare For Creating a Trail For Your Organization.

HTTP Status Code: 400

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

InactiveEventDataStoreException

The event data store is inactive.

HTTP Status Code: 400

InsufficientDependencyServiceAccessPermissionException

This exception is thrown when the IAM user or role that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.

HTTP Status Code: 400

InvalidParameterException

The request includes a parameter that is not valid.

HTTP Status Code: 400

NotOrganizationMasterAccountException

This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Amazon Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.

HTTP Status Code: 400

OperationNotPermittedException

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

HTTP Status Code: 400

OrganizationNotInAllFeaturesModeException

This exception is thrown when Amazon Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.

HTTP Status Code: 400

OrganizationsNotInUseException

This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.

HTTP Status Code: 400

UnsupportedOperationException

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

HTTP Status Code: 400