{ "version": "2.0", "metadata": { "apiVersion": "2013-11-01", "endpointPrefix": "cloudtrail", "jsonVersion": "1.1", "protocol": "json", "serviceAbbreviation": "CloudTrail", "serviceFullName": "AWS CloudTrail", "serviceId": "CloudTrail", "signatureVersion": "v4", "targetPrefix": "com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101", "uid": "cloudtrail-2013-11-01" }, "operations": { "AddTags": { "name": "AddTags", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AddTagsRequest" }, "output": { "shape": "AddTagsResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "CloudTrailARNInvalidException" }, { "shape": "EventDataStoreARNInvalidException" }, { "shape": "ChannelARNInvalidException" }, { "shape": "ResourceTypeNotSupportedException" }, { "shape": "TagsLimitExceededException" }, { "shape": "InvalidTrailNameException" }, { "shape": "InvalidTagParameterException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "ChannelNotFoundException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "ConflictException" } ], "documentation": "

Adds one or more tags to a trail, event data store, or channel, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home Region).

", "idempotent": true }, "CancelQuery": { "name": "CancelQuery", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CancelQueryRequest" }, "output": { "shape": "CancelQueryResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "InactiveQueryException" }, { "shape": "InvalidParameterException" }, { "shape": "QueryIdNotFoundException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "ConflictException" } ], "documentation": "

Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore. The ID of the query that you want to cancel is also required. When you run CancelQuery, the query status might show as CANCELLED even if the operation is not yet finished.

", "idempotent": true }, "CreateChannel": { "name": "CreateChannel", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateChannelRequest" }, "output": { "shape": "CreateChannelResponse" }, "errors": [ { "shape": "ChannelMaxLimitExceededException" }, { "shape": "InvalidSourceException" }, { "shape": "ChannelAlreadyExistsException" }, { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InvalidEventDataStoreCategoryException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidTagParameterException" }, { "shape": "TagsLimitExceededException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.

" }, "CreateEventDataStore": { "name": "CreateEventDataStore", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateEventDataStoreRequest" }, "output": { "shape": "CreateEventDataStoreResponse" }, "errors": [ { "shape": "EventDataStoreAlreadyExistsException" }, { "shape": "EventDataStoreMaxLimitExceededException" }, { "shape": "InvalidEventSelectorsException" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidTagParameterException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "ConflictException" }, { "shape": "InsufficientEncryptionPolicyException" }, { "shape": "InvalidKmsKeyIdException" }, { "shape": "KmsKeyNotFoundException" }, { "shape": "KmsException" }, { "shape": "CloudTrailAccessNotEnabledException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "OrganizationsNotInUseException" }, { "shape": "OrganizationNotInAllFeaturesModeException" }, { "shape": "NoManagementAccountSLRExistsException" } ], "documentation": "

Creates a new event data store.

" }, "CreateTrail": { "name": "CreateTrail", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTrailRequest" }, "output": { "shape": "CreateTrailResponse" }, "errors": [ { "shape": "MaximumNumberOfTrailsExceededException" }, { "shape": "TrailAlreadyExistsException" }, { "shape": "S3BucketDoesNotExistException" }, { "shape": "InsufficientS3BucketPolicyException" }, { "shape": "InsufficientSnsTopicPolicyException" }, { "shape": "InsufficientEncryptionPolicyException" }, { "shape": "InvalidS3BucketNameException" }, { "shape": "InvalidS3PrefixException" }, { "shape": "InvalidSnsTopicNameException" }, { "shape": "InvalidKmsKeyIdException" }, { "shape": "InvalidTrailNameException" }, { "shape": "TrailNotProvidedException" }, { "shape": "TagsLimitExceededException" }, { "shape": "InvalidParameterCombinationException" }, { "shape": "InvalidParameterException" }, { "shape": "KmsKeyNotFoundException" }, { "shape": "KmsKeyDisabledException" }, { "shape": "KmsException" }, { "shape": "InvalidCloudWatchLogsLogGroupArnException" }, { "shape": "InvalidCloudWatchLogsRoleArnException" }, { "shape": "CloudWatchLogsDeliveryUnavailableException" }, { "shape": "InvalidTagParameterException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "CloudTrailAccessNotEnabledException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "OrganizationsNotInUseException" }, { "shape": "OrganizationNotInAllFeaturesModeException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "CloudTrailInvalidClientTokenIdException" }, { "shape": "ConflictException" }, { "shape": "ThrottlingException" } ], "documentation": "

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

", "idempotent": true }, "DeleteChannel": { "name": "DeleteChannel", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteChannelRequest" }, "output": { "shape": "DeleteChannelResponse" }, "errors": [ { "shape": "ChannelARNInvalidException" }, { "shape": "ChannelNotFoundException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Deletes a channel.

" }, "DeleteEventDataStore": { "name": "DeleteEventDataStore", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteEventDataStoreRequest" }, "output": { "shape": "DeleteEventDataStoreResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "EventDataStoreTerminationProtectedException" }, { "shape": "EventDataStoreHasOngoingImportException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "InvalidParameterException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "ChannelExistsForEDSException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" }, { "shape": "ConflictException" }, { "shape": "EventDataStoreFederationEnabledException" } ], "documentation": "

Disables the event data store specified by EventDataStore, which accepts an event data store ARN. After you run DeleteEventDataStore, the event data store enters a PENDING_DELETION state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled must be set to False on the event data store and the FederationStatus must be DISABLED. You cannot delete an event data store if TerminationProtectionEnabled is True or the FederationStatus is ENABLED.

After you run DeleteEventDataStore on an event data store, you cannot run ListQueries, DescribeQuery, or GetQueryResults on queries that are using an event data store in a PENDING_DELETION state. An event data store in the PENDING_DELETION state does not incur costs.

" }, "DeleteResourcePolicy": { "name": "DeleteResourcePolicy", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteResourcePolicyRequest" }, "output": { "shape": "DeleteResourcePolicyResponse" }, "errors": [ { "shape": "ResourceARNNotValidException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ResourcePolicyNotFoundException" }, { "shape": "ResourceTypeNotSupportedException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Deletes the resource-based policy attached to the CloudTrail channel.

", "idempotent": true }, "DeleteTrail": { "name": "DeleteTrail", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTrailRequest" }, "output": { "shape": "DeleteTrailResponse" }, "errors": [ { "shape": "TrailNotFoundException" }, { "shape": "InvalidTrailNameException" }, { "shape": "CloudTrailARNInvalidException" }, { "shape": "ConflictException" }, { "shape": "ThrottlingException" }, { "shape": "InvalidHomeRegionException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" } ], "documentation": "

Deletes a trail. This operation must be called from the Region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.

", "idempotent": true }, "DeregisterOrganizationDelegatedAdmin": { "name": "DeregisterOrganizationDelegatedAdmin", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeregisterOrganizationDelegatedAdminRequest" }, "output": { "shape": "DeregisterOrganizationDelegatedAdminResponse" }, "errors": [ { "shape": "AccountNotFoundException" }, { "shape": "AccountNotRegisteredException" }, { "shape": "CloudTrailAccessNotEnabledException" }, { "shape": "ConflictException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" }, { "shape": "InvalidParameterException" }, { "shape": "NotOrganizationManagementAccountException" }, { "shape": "OrganizationNotInAllFeaturesModeException" }, { "shape": "OrganizationsNotInUseException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" } ], "documentation": "

Removes CloudTrail delegated administrator permissions from a member account in an organization.

", "idempotent": true }, "DescribeQuery": { "name": "DescribeQuery", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeQueryRequest" }, "output": { "shape": "DescribeQueryResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "InvalidParameterException" }, { "shape": "QueryIdNotFoundException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "NoManagementAccountSLRExistsException" } ], "documentation": "

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.

You must specify either a QueryID or a QueryAlias. Specifying the QueryAlias parameter returns information about the last query run for the alias.

", "idempotent": true }, "DescribeTrails": { "name": "DescribeTrails", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTrailsRequest" }, "output": { "shape": "DescribeTrailsResponse" }, "errors": [ { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "InvalidTrailNameException" }, { "shape": "CloudTrailARNInvalidException" }, { "shape": "NoManagementAccountSLRExistsException" } ], "documentation": "

Retrieves settings for one or more trails associated with the current Region for your account.

", "idempotent": true }, "DisableFederation": { "name": "DisableFederation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableFederationRequest" }, "output": { "shape": "DisableFederationResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InvalidParameterException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "CloudTrailAccessNotEnabledException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "OrganizationsNotInUseException" }, { "shape": "OrganizationNotInAllFeaturesModeException" }, { "shape": "ConcurrentModificationException" }, { "shape": "AccessDeniedException" } ], "documentation": "

Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables the integration with Glue, Lake Formation, and Amazon Athena. After disabling Lake query federation, you can no longer query your event data in Amazon Athena.

No CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake.

" }, "EnableFederation": { "name": "EnableFederation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableFederationRequest" }, "output": { "shape": "EnableFederationResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InvalidParameterException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "CloudTrailAccessNotEnabledException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "OrganizationsNotInUseException" }, { "shape": "OrganizationNotInAllFeaturesModeException" }, { "shape": "ConcurrentModificationException" }, { "shape": "AccessDeniedException" }, { "shape": "EventDataStoreFederationEnabledException" } ], "documentation": "

Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue Data Catalog and run SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query.

When you enable Lake query federation, CloudTrail creates a managed database named aws:cloudtrail (if the database doesn't already exist) and a managed federated table in the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in Lake Formation, the service responsible for allowing fine-grained access control of the federated resources in the Glue Data Catalog.

For more information about Lake query federation, see Federate an event data store.

" }, "GetChannel": { "name": "GetChannel", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetChannelRequest" }, "output": { "shape": "GetChannelResponse" }, "errors": [ { "shape": "ChannelARNInvalidException" }, { "shape": "ChannelNotFoundException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Returns information about a specific channel.

", "idempotent": true }, "GetEventDataStore": { "name": "GetEventDataStore", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetEventDataStoreRequest" }, "output": { "shape": "GetEventDataStoreResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InvalidParameterException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "NoManagementAccountSLRExistsException" } ], "documentation": "

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

", "idempotent": true }, "GetEventSelectors": { "name": "GetEventSelectors", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetEventSelectorsRequest" }, "output": { "shape": "GetEventSelectorsResponse" }, "errors": [ { "shape": "TrailNotFoundException" }, { "shape": "InvalidTrailNameException" }, { "shape": "CloudTrailARNInvalidException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "NoManagementAccountSLRExistsException" } ], "documentation": "

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

For more information about logging management and data events, see the following topics in the CloudTrail User Guide:

", "idempotent": true }, "GetImport": { "name": "GetImport", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetImportRequest" }, "output": { "shape": "GetImportResponse" }, "errors": [ { "shape": "ImportNotFoundException" }, { "shape": "InvalidParameterException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Returns information about a specific import.

" }, "GetInsightSelectors": { "name": "GetInsightSelectors", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetInsightSelectorsRequest" }, "output": { "shape": "GetInsightSelectorsResponse" }, "errors": [ { "shape": "InvalidParameterException" }, { "shape": "InvalidParameterCombinationException" }, { "shape": "TrailNotFoundException" }, { "shape": "InvalidTrailNameException" }, { "shape": "CloudTrailARNInvalidException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "InsightNotEnabledException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "ThrottlingException" } ], "documentation": "

Describes the settings for the Insights event selectors that you configured for your trail or event data store. GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail or event data store, and if it is, which Insights types are enabled. If you run GetInsightSelectors on a trail or event data store that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException

Specify either the EventDataStore parameter to get Insights event selectors for an event data store, or the TrailName parameter to the get Insights event selectors for a trail. You cannot specify these parameters together.

For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.

", "idempotent": true }, "GetQueryResults": { "name": "GetQueryResults", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetQueryResultsRequest" }, "output": { "shape": "GetQueryResultsResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "InvalidMaxResultsException" }, { "shape": "InvalidNextTokenException" }, { "shape": "InvalidParameterException" }, { "shape": "QueryIdNotFoundException" }, { "shape": "InsufficientEncryptionPolicyException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "NoManagementAccountSLRExistsException" } ], "documentation": "

Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation.

" }, "GetResourcePolicy": { "name": "GetResourcePolicy", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetResourcePolicyRequest" }, "output": { "shape": "GetResourcePolicyResponse" }, "errors": [ { "shape": "ResourceARNNotValidException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ResourcePolicyNotFoundException" }, { "shape": "ResourceTypeNotSupportedException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.

", "idempotent": true }, "GetTrail": { "name": "GetTrail", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTrailRequest" }, "output": { "shape": "GetTrailResponse" }, "errors": [ { "shape": "CloudTrailARNInvalidException" }, { "shape": "TrailNotFoundException" }, { "shape": "InvalidTrailNameException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" } ], "documentation": "

Returns settings information for a specified trail.

", "idempotent": true }, "GetTrailStatus": { "name": "GetTrailStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTrailStatusRequest" }, "output": { "shape": "GetTrailStatusResponse" }, "errors": [ { "shape": "CloudTrailARNInvalidException" }, { "shape": "TrailNotFoundException" }, { "shape": "InvalidTrailNameException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" } ], "documentation": "

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single Region. To return trail status from all Regions, you must call the operation on each Region.

", "idempotent": true }, "ListChannels": { "name": "ListChannels", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListChannelsRequest" }, "output": { "shape": "ListChannelsResponse" }, "errors": [ { "shape": "InvalidNextTokenException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Lists the channels in the current account, and their source names.

", "idempotent": true }, "ListEventDataStores": { "name": "ListEventDataStores", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListEventDataStoresRequest" }, "output": { "shape": "ListEventDataStoresResponse" }, "errors": [ { "shape": "InvalidMaxResultsException" }, { "shape": "InvalidNextTokenException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "NoManagementAccountSLRExistsException" } ], "documentation": "

Returns information about all event data stores in the account, in the current Region.

", "idempotent": true }, "ListImportFailures": { "name": "ListImportFailures", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListImportFailuresRequest" }, "output": { "shape": "ListImportFailuresResponse" }, "errors": [ { "shape": "InvalidNextTokenException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "InvalidParameterException" } ], "documentation": "

Returns a list of failures for the specified import.

", "idempotent": true }, "ListImports": { "name": "ListImports", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListImportsRequest" }, "output": { "shape": "ListImportsResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "InvalidNextTokenException" }, { "shape": "InvalidParameterException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Returns information on all imports, or a select set of imports by ImportStatus or Destination.

", "idempotent": true }, "ListInsightsMetricData": { "name": "ListInsightsMetricData", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListInsightsMetricDataRequest" }, "output": { "shape": "ListInsightsMetricDataResponse" }, "errors": [ { "shape": "InvalidParameterException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Returns Insights metrics data for trails that have enabled Insights. The request must include the EventSource, EventName, and InsightType parameters.

If the InsightType is set to ApiErrorRateInsight, the request must also include the ErrorCode parameter.

The following are the available time periods for ListInsightsMetricData. Each cutoff is inclusive.

Access to the ListInsightsMetricData API operation is linked to the cloudtrail:LookupEvents action. To use this operation, you must have permissions to perform the cloudtrail:LookupEvents action.

", "idempotent": true }, "ListPublicKeys": { "name": "ListPublicKeys", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListPublicKeysRequest" }, "output": { "shape": "ListPublicKeysResponse" }, "errors": [ { "shape": "InvalidTimeRangeException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "InvalidTokenException" } ], "documentation": "

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

CloudTrail uses different private and public key pairs per Region. Each digest file is signed with a private key unique to its Region. When you validate a digest file from a specific Region, you must look in the same Region for its corresponding public key.

", "idempotent": true }, "ListQueries": { "name": "ListQueries", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListQueriesRequest" }, "output": { "shape": "ListQueriesResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "InvalidDateRangeException" }, { "shape": "InvalidMaxResultsException" }, { "shape": "InvalidNextTokenException" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidQueryStatusException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "NoManagementAccountSLRExistsException" } ], "documentation": "

Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

", "idempotent": true }, "ListTags": { "name": "ListTags", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTagsRequest" }, "output": { "shape": "ListTagsResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "CloudTrailARNInvalidException" }, { "shape": "EventDataStoreARNInvalidException" }, { "shape": "ChannelARNInvalidException" }, { "shape": "ResourceTypeNotSupportedException" }, { "shape": "InvalidTrailNameException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "InvalidTokenException" }, { "shape": "NoManagementAccountSLRExistsException" } ], "documentation": "

Lists the tags for the specified trails, event data stores, or channels in the current Region.

", "idempotent": true }, "ListTrails": { "name": "ListTrails", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTrailsRequest" }, "output": { "shape": "ListTrailsResponse" }, "errors": [ { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" } ], "documentation": "

Lists trails that are in the current account.

", "idempotent": true }, "LookupEvents": { "name": "LookupEvents", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "LookupEventsRequest" }, "output": { "shape": "LookupEventsResponse" }, "errors": [ { "shape": "InvalidLookupAttributesException" }, { "shape": "InvalidTimeRangeException" }, { "shape": "InvalidMaxResultsException" }, { "shape": "InvalidNextTokenException" }, { "shape": "InvalidEventCategoryException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" } ], "documentation": "

Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days.

LookupEvents returns recent Insights events for trails that enable Insights. To view Insights events for an event data store, you can run queries on your Insights event data store, and you can also view the Lake dashboard for Insights.

Lookup supports the following attributes for management events:

Lookup supports the following attributes for Insights events:

All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

The rate of lookup requests is limited to two per second, per account, per Region. If this limit is exceeded, a throttling error occurs.

", "idempotent": true }, "PutEventSelectors": { "name": "PutEventSelectors", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutEventSelectorsRequest" }, "output": { "shape": "PutEventSelectorsResponse" }, "errors": [ { "shape": "TrailNotFoundException" }, { "shape": "InvalidTrailNameException" }, { "shape": "CloudTrailARNInvalidException" }, { "shape": "InvalidHomeRegionException" }, { "shape": "InvalidEventSelectorsException" }, { "shape": "ConflictException" }, { "shape": "ThrottlingException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" } ], "documentation": "

Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. If you want your trail to log Insights events, be sure the event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events for trails in the CloudTrail User Guide. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.

When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

Example

  1. You create an event selector for a trail and specify that you want write-only events.

  2. The EC2 GetConsoleOutput and RunInstances API operations occur in your account.

  3. CloudTrail evaluates whether the events match your event selectors.

  4. The RunInstances is a write-only event and it matches your event selector. The trail logs the event.

  5. The GetConsoleOutput is a read-only event that doesn't match your event selector. The trail doesn't log the event.

The PutEventSelectors operation must be called from the Region in which the trail was created; otherwise, an InvalidHomeRegionException exception is thrown.

You can configure up to five event selectors for each trail. For more information, see Logging management events, Logging data events, and Quotas in CloudTrail in the CloudTrail User Guide.

You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events in the CloudTrail User Guide.

", "idempotent": true }, "PutInsightSelectors": { "name": "PutInsightSelectors", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutInsightSelectorsRequest" }, "output": { "shape": "PutInsightSelectorsResponse" }, "errors": [ { "shape": "InvalidParameterException" }, { "shape": "InvalidParameterCombinationException" }, { "shape": "TrailNotFoundException" }, { "shape": "InvalidTrailNameException" }, { "shape": "CloudTrailARNInvalidException" }, { "shape": "InvalidHomeRegionException" }, { "shape": "InvalidInsightSelectorsException" }, { "shape": "InsufficientS3BucketPolicyException" }, { "shape": "InsufficientEncryptionPolicyException" }, { "shape": "S3BucketDoesNotExistException" }, { "shape": "KmsException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "ThrottlingException" } ], "documentation": "

Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail or event data store. You also use PutInsightSelectors to turn off Insights event logging, by passing an empty list of Insights types. The valid Insights event types are ApiErrorRateInsight and ApiCallRateInsight.

To enable Insights on an event data store, you must specify the ARNs (or ID suffix of the ARNs) for the source event data store (EventDataStore) and the destination event data store (InsightsDestination). The source event data store logs management events and enables Insights. The destination event data store logs Insights events based upon the management event activity of the source event data store. The source and destination event data stores must belong to the same Amazon Web Services account.

To log Insights events for a trail, you must specify the name (TrailName) of the CloudTrail trail for which you want to change or add Insights selectors.

To log CloudTrail Insights events on API call volume, the trail or event data store must log write management events. To log CloudTrail Insights events on API error rate, the trail or event data store must log read or write management events. You can call GetEventSelectors on a trail to check whether the trail logs management events. You can call GetEventDataStore on an event data store to check whether the event data store logs management events.

For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.

", "idempotent": true }, "PutResourcePolicy": { "name": "PutResourcePolicy", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutResourcePolicyRequest" }, "output": { "shape": "PutResourcePolicyResponse" }, "errors": [ { "shape": "ResourceARNNotValidException" }, { "shape": "ResourcePolicyNotValidException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ResourceTypeNotSupportedException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.

", "idempotent": true }, "RegisterOrganizationDelegatedAdmin": { "name": "RegisterOrganizationDelegatedAdmin", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterOrganizationDelegatedAdminRequest" }, "output": { "shape": "RegisterOrganizationDelegatedAdminResponse" }, "errors": [ { "shape": "AccountRegisteredException" }, { "shape": "AccountNotFoundException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" }, { "shape": "InvalidParameterException" }, { "shape": "CannotDelegateManagementAccountException" }, { "shape": "CloudTrailAccessNotEnabledException" }, { "shape": "ConflictException" }, { "shape": "DelegatedAdminAccountLimitExceededException" }, { "shape": "NotOrganizationManagementAccountException" }, { "shape": "OrganizationNotInAllFeaturesModeException" }, { "shape": "OrganizationsNotInUseException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" } ], "documentation": "

Registers an organization’s member account as the CloudTrail delegated administrator.

", "idempotent": true }, "RemoveTags": { "name": "RemoveTags", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RemoveTagsRequest" }, "output": { "shape": "RemoveTagsResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "CloudTrailARNInvalidException" }, { "shape": "EventDataStoreARNInvalidException" }, { "shape": "ChannelARNInvalidException" }, { "shape": "ResourceTypeNotSupportedException" }, { "shape": "InvalidTrailNameException" }, { "shape": "InvalidTagParameterException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "ChannelNotFoundException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" } ], "documentation": "

Removes the specified tags from a trail, event data store, or channel.

", "idempotent": true }, "RestoreEventDataStore": { "name": "RestoreEventDataStore", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RestoreEventDataStoreRequest" }, "output": { "shape": "RestoreEventDataStoreResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "EventDataStoreMaxLimitExceededException" }, { "shape": "InvalidEventDataStoreStatusException" }, { "shape": "InvalidParameterException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "CloudTrailAccessNotEnabledException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" }, { "shape": "OrganizationsNotInUseException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "OrganizationNotInAllFeaturesModeException" } ], "documentation": "

Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store.

" }, "StartEventDataStoreIngestion": { "name": "StartEventDataStoreIngestion", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartEventDataStoreIngestionRequest" }, "output": { "shape": "StartEventDataStoreIngestionResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InvalidEventDataStoreStatusException" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidEventDataStoreCategoryException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" } ], "documentation": "

Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION and the eventCategory must be Management, Data, or ConfigurationItem.

" }, "StartImport": { "name": "StartImport", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartImportRequest" }, "output": { "shape": "StartImportResponse" }, "errors": [ { "shape": "AccountHasOngoingImportException" }, { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InvalidEventDataStoreStatusException" }, { "shape": "InvalidEventDataStoreCategoryException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "InvalidImportSourceException" }, { "shape": "ImportNotFoundException" }, { "shape": "InvalidParameterException" }, { "shape": "InsufficientEncryptionPolicyException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Starts an import of logged trail events from a source S3 bucket to a destination event data store. By default, CloudTrail only imports events contained in the S3 bucket's CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services services. If you want to import CloudTrail events contained in another prefix, you must include the prefix in the S3LocationUri. For more considerations about importing trail events, see Considerations.

When you start a new import, the Destinations and ImportSource parameters are required. Before starting a new import, disable any access control lists (ACLs) attached to the source S3 bucket. For more information about disabling ACLs, see Controlling ownership of objects and disabling ACLs for your bucket.

When you retry an import, the ImportID parameter is required.

If the destination event data store is for an organization, you must use the management account to import trail events. You cannot use the delegated administrator account for the organization.

" }, "StartLogging": { "name": "StartLogging", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartLoggingRequest" }, "output": { "shape": "StartLoggingResponse" }, "errors": [ { "shape": "CloudTrailARNInvalidException" }, { "shape": "ConflictException" }, { "shape": "ThrottlingException" }, { "shape": "TrailNotFoundException" }, { "shape": "InvalidTrailNameException" }, { "shape": "InvalidHomeRegionException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" } ], "documentation": "

Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all Regions, this operation must be called from the Region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.

", "idempotent": true }, "StartQuery": { "name": "StartQuery", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartQueryRequest" }, "output": { "shape": "StartQueryResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidQueryStatementException" }, { "shape": "MaxConcurrentQueriesException" }, { "shape": "InsufficientEncryptionPolicyException" }, { "shape": "InvalidS3PrefixException" }, { "shape": "InvalidS3BucketNameException" }, { "shape": "InsufficientS3BucketPolicyException" }, { "shape": "S3BucketDoesNotExistException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "NoManagementAccountSLRExistsException" } ], "documentation": "

Starts a CloudTrail Lake query. Use the QueryStatement parameter to provide your SQL query, enclosed in single quotation marks. Use the optional DeliveryS3Uri parameter to deliver the query results to an S3 bucket.

StartQuery requires you specify either the QueryStatement parameter, or a QueryAlias and any QueryParameters. In the current release, the QueryAlias and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake dashboards.

", "idempotent": true }, "StopEventDataStoreIngestion": { "name": "StopEventDataStoreIngestion", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StopEventDataStoreIngestionRequest" }, "output": { "shape": "StopEventDataStoreIngestionResponse" }, "errors": [ { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InvalidEventDataStoreStatusException" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidEventDataStoreCategoryException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" } ], "documentation": "

Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED and the eventCategory must be Management, Data, or ConfigurationItem.

" }, "StopImport": { "name": "StopImport", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StopImportRequest" }, "output": { "shape": "StopImportResponse" }, "errors": [ { "shape": "ImportNotFoundException" }, { "shape": "InvalidParameterException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Stops a specified import.

" }, "StopLogging": { "name": "StopLogging", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StopLoggingRequest" }, "output": { "shape": "StopLoggingResponse" }, "errors": [ { "shape": "TrailNotFoundException" }, { "shape": "InvalidTrailNameException" }, { "shape": "CloudTrailARNInvalidException" }, { "shape": "ConflictException" }, { "shape": "ThrottlingException" }, { "shape": "InvalidHomeRegionException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" } ], "documentation": "

Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all Regions, this operation must be called from the Region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other Regions) of a trail enabled in all Regions.

", "idempotent": true }, "UpdateChannel": { "name": "UpdateChannel", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateChannelRequest" }, "output": { "shape": "UpdateChannelResponse" }, "errors": [ { "shape": "ChannelARNInvalidException" }, { "shape": "ChannelNotFoundException" }, { "shape": "ChannelAlreadyExistsException" }, { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InvalidEventDataStoreCategoryException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "InvalidParameterException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" } ], "documentation": "

Updates a channel specified by a required channel ARN or UUID.

", "idempotent": true }, "UpdateEventDataStore": { "name": "UpdateEventDataStore", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateEventDataStoreRequest" }, "output": { "shape": "UpdateEventDataStoreResponse" }, "errors": [ { "shape": "EventDataStoreAlreadyExistsException" }, { "shape": "EventDataStoreARNInvalidException" }, { "shape": "EventDataStoreNotFoundException" }, { "shape": "InvalidEventSelectorsException" }, { "shape": "InvalidInsightSelectorsException" }, { "shape": "EventDataStoreHasOngoingImportException" }, { "shape": "InactiveEventDataStoreException" }, { "shape": "InvalidParameterException" }, { "shape": "OperationNotPermittedException" }, { "shape": "UnsupportedOperationException" }, { "shape": "InsufficientEncryptionPolicyException" }, { "shape": "InvalidKmsKeyIdException" }, { "shape": "KmsKeyNotFoundException" }, { "shape": "KmsException" }, { "shape": "CloudTrailAccessNotEnabledException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" }, { "shape": "OrganizationsNotInUseException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "OrganizationNotInAllFeaturesModeException" } ], "documentation": "

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 7 and 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.

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

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

", "idempotent": true }, "UpdateTrail": { "name": "UpdateTrail", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateTrailRequest" }, "output": { "shape": "UpdateTrailResponse" }, "errors": [ { "shape": "S3BucketDoesNotExistException" }, { "shape": "InsufficientS3BucketPolicyException" }, { "shape": "InsufficientSnsTopicPolicyException" }, { "shape": "InsufficientEncryptionPolicyException" }, { "shape": "TrailNotFoundException" }, { "shape": "InvalidS3BucketNameException" }, { "shape": "InvalidS3PrefixException" }, { "shape": "InvalidSnsTopicNameException" }, { "shape": "InvalidKmsKeyIdException" }, { "shape": "InvalidTrailNameException" }, { "shape": "TrailNotProvidedException" }, { "shape": "InvalidEventSelectorsException" }, { "shape": "CloudTrailARNInvalidException" }, { "shape": "ConflictException" }, { "shape": "ThrottlingException" }, { "shape": "InvalidParameterCombinationException" }, { "shape": "InvalidHomeRegionException" }, { "shape": "KmsKeyNotFoundException" }, { "shape": "KmsKeyDisabledException" }, { "shape": "KmsException" }, { "shape": "InvalidCloudWatchLogsLogGroupArnException" }, { "shape": "InvalidCloudWatchLogsRoleArnException" }, { "shape": "CloudWatchLogsDeliveryUnavailableException" }, { "shape": "UnsupportedOperationException" }, { "shape": "OperationNotPermittedException" }, { "shape": "CloudTrailAccessNotEnabledException" }, { "shape": "InsufficientDependencyServiceAccessPermissionException" }, { "shape": "OrganizationsNotInUseException" }, { "shape": "NotOrganizationMasterAccountException" }, { "shape": "OrganizationNotInAllFeaturesModeException" }, { "shape": "NoManagementAccountSLRExistsException" }, { "shape": "CloudTrailInvalidClientTokenIdException" }, { "shape": "InvalidParameterException" } ], "documentation": "

Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the Region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

", "idempotent": true } }, "shapes": { "AccountId": { "type": "string", "max": 16, "min": 12, "pattern": "\\d+" }, "AddTagsRequest": { "type": "structure", "required": [ "ResourceId", "TagsList" ], "members": { "ResourceId": { "shape": "String", "documentation": "

Specifies the ARN of the trail, event data store, or channel to which one or more tags will be added.

The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The format of an event data store ARN is: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The format of a channel ARN is: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

" }, "TagsList": { "shape": "TagsList", "documentation": "

Contains a list of tags, up to a limit of 50

" } }, "documentation": "

Specifies the tags to add to a trail, event data store, or channel.

" }, "AddTagsResponse": { "type": "structure", "members": {}, "documentation": "

Returns the objects or data if successful. Otherwise, returns an error.

" }, "AdvancedEventSelector": { "type": "structure", "required": [ "FieldSelectors" ], "members": { "Name": { "shape": "SelectorName", "documentation": "

An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\".

" }, "FieldSelectors": { "shape": "AdvancedFieldSelectors", "documentation": "

Contains all selector statements in an advanced event selector.

" } }, "documentation": "

Advanced event selectors let you create fine-grained selectors for CloudTrail management and data events. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging management events and Logging data events 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

Supported CloudTrail event record fields for data events

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.

" }, "AdvancedEventSelectors": { "type": "list", "member": { "shape": "AdvancedEventSelector" } }, "AdvancedFieldSelector": { "type": "structure", "required": [ "Field" ], "members": { "Field": { "shape": "SelectorField", "documentation": "

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 readOnly, eventCategory, and eventSource.

For CloudTrail data events, supported fields include readOnly, eventCategory, eventName, resources.type, and resources.ARN.

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.

" }, "Equals": { "shape": "Operator", "documentation": "

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 the readOnly, eventCategory, and resources.type fields.

" }, "StartsWith": { "shape": "Operator", "documentation": "

An operator that includes events that match the first few characters of the event record field specified as the value of Field.

" }, "EndsWith": { "shape": "Operator", "documentation": "

An operator that includes events that match the last few characters of the event record field specified as the value of Field.

" }, "NotEquals": { "shape": "Operator", "documentation": "

An operator that excludes events that match the exact value of the event record field specified as the value of Field.

" }, "NotStartsWith": { "shape": "Operator", "documentation": "

An operator that excludes events that match the first few characters of the event record field specified as the value of Field.

" }, "NotEndsWith": { "shape": "Operator", "documentation": "

An operator that excludes events that match the last few characters of the event record field specified as the value of Field.

" } }, "documentation": "

A single selector statement in an advanced event selector.

" }, "AdvancedFieldSelectors": { "type": "list", "member": { "shape": "AdvancedFieldSelector" }, "min": 1 }, "BillingMode": { "type": "string", "enum": [ "EXTENDABLE_RETENTION_PRICING", "FIXED_RETENTION_PRICING" ] }, "Boolean": { "type": "boolean" }, "ByteBuffer": { "type": "blob" }, "CancelQueryRequest": { "type": "structure", "required": [ "QueryId" ], "members": { "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.

", "deprecated": true, "deprecatedMessage": "EventDataStore is no longer required by CancelQueryRequest" }, "QueryId": { "shape": "UUID", "documentation": "

The ID of the query that you want to cancel. The QueryId comes from the response of a StartQuery operation.

" } } }, "CancelQueryResponse": { "type": "structure", "required": [ "QueryId", "QueryStatus" ], "members": { "QueryId": { "shape": "UUID", "documentation": "

The ID of the canceled query.

" }, "QueryStatus": { "shape": "QueryStatus", "documentation": "

Shows the status of a query after a CancelQuery request. Typically, the values shown are either RUNNING or CANCELLED.

" } } }, "Channel": { "type": "structure", "members": { "ChannelArn": { "shape": "ChannelArn", "documentation": "

The Amazon Resource Name (ARN) of a channel.

" }, "Name": { "shape": "ChannelName", "documentation": "

The name of the CloudTrail channel. For service-linked channels, the name is aws-service-channel/service-name/custom-suffix where service-name represents the name of the Amazon Web Services service that created the channel and custom-suffix represents the suffix created by the Amazon Web Services service.

" } }, "documentation": "

Contains information about a returned CloudTrail channel.

" }, "ChannelArn": { "type": "string", "max": 256, "min": 3, "pattern": "^[a-zA-Z0-9._/\\-:]+$" }, "ChannelName": { "type": "string", "max": 128, "min": 3, "pattern": "^[a-zA-Z0-9._\\-]+$" }, "Channels": { "type": "list", "member": { "shape": "Channel" } }, "CreateChannelRequest": { "type": "structure", "required": [ "Name", "Source", "Destinations" ], "members": { "Name": { "shape": "ChannelName", "documentation": "

The name of the channel.

" }, "Source": { "shape": "Source", "documentation": "

The name of the partner or external event source. You cannot change this name after you create the channel. A maximum of one channel is allowed per source.

A source can be either Custom for all valid non-Amazon Web Services events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.

" }, "Destinations": { "shape": "Destinations", "documentation": "

One or more event data stores to which events arriving through a channel will be logged.

" }, "Tags": { "shape": "TagsList" } } }, "CreateChannelResponse": { "type": "structure", "members": { "ChannelArn": { "shape": "ChannelArn", "documentation": "

The Amazon Resource Name (ARN) of the new channel.

" }, "Name": { "shape": "ChannelName", "documentation": "

The name of the new channel.

" }, "Source": { "shape": "Source", "documentation": "

The partner or external event source name.

" }, "Destinations": { "shape": "Destinations", "documentation": "

The event data stores that log the events arriving through the channel.

" }, "Tags": { "shape": "TagsList" } } }, "CreateEventDataStoreRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "EventDataStoreName", "documentation": "

The name of the event data store.

" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", "documentation": "

The advanced event selectors to use to select the events for the data store. You can configure up to five advanced event selectors for each event data store.

For more information about how to use advanced event selectors to log CloudTrail events, see Log events by using advanced event selectors in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include Config configuration items in your event data store, see Create an event data store for Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

" }, "MultiRegionEnabled": { "shape": "Boolean", "documentation": "

Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

" }, "OrganizationEnabled": { "shape": "Boolean", "documentation": "

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

" }, "RetentionPeriod": { "shape": "RetentionPeriod", "documentation": "

The retention period of the event data store, in days. If BillingMode is set to EXTENDABLE_RETENTION_PRICING, you can set a retention period of up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING, you can set a retention period of up to 2557 days, the equivalent of seven years.

CloudTrail Lake determines whether to retain an event by checking if the eventTime of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the eventTime is older than 90 days.

If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.

" }, "TerminationProtectionEnabled": { "shape": "TerminationProtectionEnabled", "documentation": "

Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.

" }, "TagsList": { "shape": "TagsList" }, "KmsKeyId": { "shape": "EventDataStoreKmsKeyId", "documentation": "

Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by alias/, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

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.

CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

Examples:

" }, "StartIngestion": { "shape": "Boolean", "documentation": "

Specifies whether the event data store should start ingesting live events. The default is true.

" }, "BillingMode": { "shape": "BillingMode", "documentation": "

The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.

The following are the possible values:

The default value is EXTENDABLE_RETENTION_PRICING.

For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs.

" } } }, "CreateEventDataStoreResponse": { "type": "structure", "members": { "EventDataStoreArn": { "shape": "EventDataStoreArn", "documentation": "

The ARN of the event data store.

" }, "Name": { "shape": "EventDataStoreName", "documentation": "

The name of the event data store.

" }, "Status": { "shape": "EventDataStoreStatus", "documentation": "

The status of event data store creation.

" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", "documentation": "

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

" }, "MultiRegionEnabled": { "shape": "Boolean", "documentation": "

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

" }, "OrganizationEnabled": { "shape": "Boolean", "documentation": "

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

" }, "RetentionPeriod": { "shape": "RetentionPeriod", "documentation": "

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

" }, "TerminationProtectionEnabled": { "shape": "TerminationProtectionEnabled", "documentation": "

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

" }, "TagsList": { "shape": "TagsList" }, "CreatedTimestamp": { "shape": "Date", "documentation": "

The timestamp that shows when the event data store was created.

" }, "UpdatedTimestamp": { "shape": "Date", "documentation": "

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

" }, "KmsKeyId": { "shape": "EventDataStoreKmsKeyId", "documentation": "

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": { "shape": "BillingMode", "documentation": "

The billing mode for the event data store.

" } } }, "CreateTrailRequest": { "type": "structure", "required": [ "Name", "S3BucketName" ], "members": { "Name": { "shape": "String", "documentation": "

Specifies the name of the trail. The name must meet the following requirements:

" }, "S3BucketName": { "shape": "String", "documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

" }, "S3KeyPrefix": { "shape": "String", "documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

" }, "SnsTopicName": { "shape": "String", "documentation": "

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

" }, "IncludeGlobalServiceEvents": { "shape": "Boolean", "documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" }, "IsMultiRegionTrail": { "shape": "Boolean", "documentation": "

Specifies whether the trail is created in the current Region or in all Regions. The default is false, which creates a trail only in the Region where you are signed in. As a best practice, consider creating trails that log events in all Regions.

" }, "EnableLogFileValidation": { "shape": "Boolean", "documentation": "

Specifies whether log file integrity validation is enabled. The default is false.

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

" }, "CloudWatchLogsLogGroupArn": { "shape": "String", "documentation": "

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. You must use a log group that exists in your account.

Not required unless you specify CloudWatchLogsRoleArn.

" }, "CloudWatchLogsRoleArn": { "shape": "String", "documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.

" }, "KmsKeyId": { "shape": "String", "documentation": "

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by alias/, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

Examples:

" }, "IsOrganizationTrail": { "shape": "Boolean", "documentation": "

Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account or delegated administrator account for an organization in Organizations.

" }, "TagsList": { "shape": "TagsList" } }, "documentation": "

Specifies the settings for each trail.

" }, "CreateTrailResponse": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "

Specifies the name of the trail.

" }, "S3BucketName": { "shape": "String", "documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" }, "S3KeyPrefix": { "shape": "String", "documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" }, "SnsTopicName": { "shape": "String", "documentation": "

This field is no longer in use. Use SnsTopicARN.

", "deprecated": true }, "SnsTopicARN": { "shape": "String", "documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-2:123456789012:MyTopic

" }, "IncludeGlobalServiceEvents": { "shape": "Boolean", "documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" }, "IsMultiRegionTrail": { "shape": "Boolean", "documentation": "

Specifies whether the trail exists in one Region or in all Regions.

" }, "TrailARN": { "shape": "String", "documentation": "

Specifies the ARN of the trail that was created. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" }, "LogFileValidationEnabled": { "shape": "Boolean", "documentation": "

Specifies whether log file integrity validation is enabled.

" }, "CloudWatchLogsLogGroupArn": { "shape": "String", "documentation": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

" }, "CloudWatchLogsRoleArn": { "shape": "String", "documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" }, "KmsKeyId": { "shape": "String", "documentation": "

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

" }, "IsOrganizationTrail": { "shape": "Boolean", "documentation": "

Specifies whether the trail is an organization trail.

" } }, "documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "DataResource": { "type": "structure", "members": { "Type": { "shape": "String", "documentation": "

The resource type in which you want to log data events. You can specify the following basic event selector resource types:

Additional resource types are available through advanced event selectors. For more information about these additional resource types, see AdvancedFieldSelector.

" }, "Values": { "shape": "DataResourceValues", "documentation": "

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.

" } }, "documentation": "

The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.

The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors for the trail.

If you are using advanced event selectors, the maximum total number of values for all conditions, across all advanced event selectors for the trail, is 500.

The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named bucket-1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events.

  1. A user uploads an image file to bucket-1.

  2. The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.

  3. A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::bucket-2.

  4. The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.

The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction, but not for all Lambda functions.

  1. A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.

  2. The Invoke API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction, any invocations of that function are logged. The trail processes and logs the event.

  3. The Invoke API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.

" }, "DataResourceValues": { "type": "list", "member": { "shape": "String" } }, "DataResources": { "type": "list", "member": { "shape": "DataResource" } }, "Date": { "type": "timestamp" }, "DeleteChannelRequest": { "type": "structure", "required": [ "Channel" ], "members": { "Channel": { "shape": "ChannelArn", "documentation": "

The ARN or the UUID value of the channel that you want to delete.

" } } }, "DeleteChannelResponse": { "type": "structure", "members": {} }, "DeleteEventDataStoreRequest": { "type": "structure", "required": [ "EventDataStore" ], "members": { "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

The ARN (or the ID suffix of the ARN) of the event data store to delete.

" } } }, "DeleteEventDataStoreResponse": { "type": "structure", "members": {} }, "DeleteResourcePolicyRequest": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "

The Amazon Resource Name (ARN) of the CloudTrail channel you're deleting the resource-based policy from. The following is the format of a resource ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.

" } } }, "DeleteResourcePolicyResponse": { "type": "structure", "members": {} }, "DeleteTrailRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "String", "documentation": "

Specifies the name or the CloudTrail ARN of the trail to be deleted. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" } }, "documentation": "

The request that specifies the name of a trail to delete.

" }, "DeleteTrailResponse": { "type": "structure", "members": {}, "documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "DeliveryS3Uri": { "type": "string", "max": 1024, "pattern": "s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?" }, "DeliveryStatus": { "type": "string", "enum": [ "SUCCESS", "FAILED", "FAILED_SIGNING_FILE", "PENDING", "RESOURCE_NOT_FOUND", "ACCESS_DENIED", "ACCESS_DENIED_SIGNING_FILE", "CANCELLED", "UNKNOWN" ] }, "DeregisterOrganizationDelegatedAdminRequest": { "type": "structure", "required": [ "DelegatedAdminAccountId" ], "members": { "DelegatedAdminAccountId": { "shape": "AccountId", "documentation": "

A delegated administrator account ID. This is a member account in an organization that is currently designated as a delegated administrator.

" } }, "documentation": "

Removes CloudTrail delegated administrator permissions from a specified member account in an organization that is currently designated as a delegated administrator.

" }, "DeregisterOrganizationDelegatedAdminResponse": { "type": "structure", "members": {}, "documentation": "

Returns the following response if successful. Otherwise, returns an error.

" }, "DescribeQueryRequest": { "type": "structure", "members": { "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.

", "deprecated": true, "deprecatedMessage": "EventDataStore is no longer required by DescribeQueryRequest" }, "QueryId": { "shape": "UUID", "documentation": "

The query ID.

" }, "QueryAlias": { "shape": "QueryAlias", "documentation": "

The alias that identifies a query template.

" } } }, "DescribeQueryResponse": { "type": "structure", "members": { "QueryId": { "shape": "UUID", "documentation": "

The ID of the query.

" }, "QueryString": { "shape": "QueryStatement", "documentation": "

The SQL code of a query.

" }, "QueryStatus": { "shape": "QueryStatus", "documentation": "

The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED

" }, "QueryStatistics": { "shape": "QueryStatisticsForDescribeQuery", "documentation": "

Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

" }, "ErrorMessage": { "shape": "ErrorMessage", "documentation": "

The error message returned if a query failed.

" }, "DeliveryS3Uri": { "shape": "DeliveryS3Uri", "documentation": "

The URI for the S3 bucket where CloudTrail delivered query results, if applicable.

" }, "DeliveryStatus": { "shape": "DeliveryStatus", "documentation": "

The delivery status.

" } } }, "DescribeTrailsRequest": { "type": "structure", "members": { "trailNameList": { "shape": "TrailNameList", "documentation": "

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

If an empty list is specified, information for the trail in the current Region is returned.

If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.

" }, "includeShadowTrails": { "shape": "Boolean", "documentation": "

Specifies whether to include shadow trails in the response. A shadow trail is the replication in a Region of a trail that was created in a different Region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and Region replication trails will not be returned. The default is true.

" } }, "documentation": "

Returns information about the trail.

" }, "DescribeTrailsResponse": { "type": "structure", "members": { "trailList": { "shape": "TrailList", "documentation": "

The list of trail objects. Trail objects with string values are only returned if values for the objects exist in a trail's configuration. For example, SNSTopicName and SNSTopicARN are only returned in results if a trail is configured to send SNS notifications. Similarly, KMSKeyId only appears in results if a trail's log files are encrypted with KMS customer managed keys.

" } }, "documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "Destination": { "type": "structure", "required": [ "Type", "Location" ], "members": { "Type": { "shape": "DestinationType", "documentation": "

The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EVENT_DATA_STORE. For service-linked channels, the value is AWS_SERVICE.

" }, "Location": { "shape": "Location", "documentation": "

For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. For service-linked channels, the location is the name of the Amazon Web Services service.

" } }, "documentation": "

Contains information about the destination receiving events.

" }, "DestinationType": { "type": "string", "enum": [ "EVENT_DATA_STORE", "AWS_SERVICE" ] }, "Destinations": { "type": "list", "member": { "shape": "Destination" }, "max": 200, "min": 1 }, "DisableFederationRequest": { "type": "structure", "required": [ "EventDataStore" ], "members": { "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

The ARN (or ID suffix of the ARN) of the event data store for which you want to disable Lake query federation.

" } } }, "DisableFederationResponse": { "type": "structure", "members": { "EventDataStoreArn": { "shape": "EventDataStoreArn", "documentation": "

The ARN of the event data store for which you disabled Lake query federation.

" }, "FederationStatus": { "shape": "FederationStatus", "documentation": "

The federation status.

" } } }, "Double": { "type": "double" }, "EnableFederationRequest": { "type": "structure", "required": [ "EventDataStore", "FederationRoleArn" ], "members": { "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

The ARN (or ID suffix of the ARN) of the event data store for which you want to enable Lake query federation.

" }, "FederationRoleArn": { "shape": "FederationRoleArn", "documentation": "

The ARN of the federation role to use for the event data store. Amazon Web Services services like Lake Formation use this federation role to access data for the federated event data store. The federation role must exist in your account and provide the required minimum permissions.

" } } }, "EnableFederationResponse": { "type": "structure", "members": { "EventDataStoreArn": { "shape": "EventDataStoreArn", "documentation": "

The ARN of the event data store for which you enabled Lake query federation.

" }, "FederationStatus": { "shape": "FederationStatus", "documentation": "

The federation status.

" }, "FederationRoleArn": { "shape": "FederationRoleArn", "documentation": "

The ARN of the federation role.

" } } }, "ErrorCode": { "type": "string", "max": 128, "pattern": "^[\\w\\d\\s_.,\\-:\\[\\]]+$" }, "ErrorMessage": { "type": "string", "max": 1000, "min": 4, "pattern": ".*" }, "Event": { "type": "structure", "members": { "EventId": { "shape": "String", "documentation": "

The CloudTrail ID of the event returned.

" }, "EventName": { "shape": "String", "documentation": "

The name of the event returned.

" }, "ReadOnly": { "shape": "String", "documentation": "

Information about whether the event is a write event or a read event.

" }, "AccessKeyId": { "shape": "String", "documentation": "

The Amazon Web Services access key ID that was used to sign the request. If the request was made with temporary security credentials, this is the access key ID of the temporary credentials.

" }, "EventTime": { "shape": "Date", "documentation": "

The date and time of the event returned.

" }, "EventSource": { "shape": "String", "documentation": "

The Amazon Web Services service to which the request was made.

" }, "Username": { "shape": "String", "documentation": "

A user name or role name of the requester that called the API in the event returned.

" }, "Resources": { "shape": "ResourceList", "documentation": "

A list of resources referenced by the event returned.

" }, "CloudTrailEvent": { "shape": "String", "documentation": "

A JSON string that contains a representation of the event returned.

" } }, "documentation": "

Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.

" }, "EventCategory": { "type": "string", "enum": [ "insight" ] }, "EventDataStore": { "type": "structure", "members": { "EventDataStoreArn": { "shape": "EventDataStoreArn", "documentation": "

The ARN of the event data store.

" }, "Name": { "shape": "EventDataStoreName", "documentation": "

The name of the event data store.

" }, "TerminationProtectionEnabled": { "shape": "TerminationProtectionEnabled", "documentation": "

Indicates whether the event data store is protected from termination.

", "deprecated": true, "deprecatedMessage": "TerminationProtectionEnabled is no longer returned by ListEventDataStores" }, "Status": { "shape": "EventDataStoreStatus", "documentation": "

The status of an event data store.

", "deprecated": true, "deprecatedMessage": "Status is no longer returned by ListEventDataStores" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", "documentation": "

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

", "deprecated": true, "deprecatedMessage": "AdvancedEventSelectors is no longer returned by ListEventDataStores" }, "MultiRegionEnabled": { "shape": "Boolean", "documentation": "

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

", "deprecated": true, "deprecatedMessage": "MultiRegionEnabled is no longer returned by ListEventDataStores" }, "OrganizationEnabled": { "shape": "Boolean", "documentation": "

Indicates that an event data store is collecting logged events for an organization.

", "deprecated": true, "deprecatedMessage": "OrganizationEnabled is no longer returned by ListEventDataStores" }, "RetentionPeriod": { "shape": "RetentionPeriod", "documentation": "

The retention period, in days.

", "deprecated": true, "deprecatedMessage": "RetentionPeriod is no longer returned by ListEventDataStores" }, "CreatedTimestamp": { "shape": "Date", "documentation": "

The timestamp of the event data store's creation.

", "deprecated": true, "deprecatedMessage": "CreatedTimestamp is no longer returned by ListEventDataStores" }, "UpdatedTimestamp": { "shape": "Date", "documentation": "

The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

", "deprecated": true, "deprecatedMessage": "UpdatedTimestamp is no longer returned by ListEventDataStores" } }, "documentation": "

A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account. To select events for an event data store, use advanced event selectors.

" }, "EventDataStoreArn": { "type": "string", "max": 256, "min": 3, "pattern": "^[a-zA-Z0-9._/\\-:]+$" }, "EventDataStoreKmsKeyId": { "type": "string", "max": 350, "min": 1, "pattern": "^[a-zA-Z0-9._/\\-:]+$" }, "EventDataStoreName": { "type": "string", "max": 128, "min": 3, "pattern": "^[a-zA-Z0-9._\\-]+$" }, "EventDataStoreStatus": { "type": "string", "enum": [ "CREATED", "ENABLED", "PENDING_DELETION", "STARTING_INGESTION", "STOPPING_INGESTION", "STOPPED_INGESTION" ] }, "EventDataStores": { "type": "list", "member": { "shape": "EventDataStore" } }, "EventName": { "type": "string", "max": 128, "pattern": "^[A-Za-z0-9_]+$" }, "EventSelector": { "type": "structure", "members": { "ReadWriteType": { "shape": "ReadWriteType", "documentation": "

Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.

By default, the value is All.

" }, "IncludeManagementEvents": { "shape": "Boolean", "documentation": "

Specify if you want your event selector to include management events for your trail.

For more information, see Management Events in the CloudTrail User Guide.

By default, the value is true.

The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same Region. For more information about CloudTrail pricing, see CloudTrail Pricing.

" }, "DataResources": { "shape": "DataResources", "documentation": "

CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.

For more information, see Data Events and Limits in CloudTrail in the CloudTrail User Guide.

" }, "ExcludeManagementEventSources": { "shape": "ExcludeManagementEventSources", "documentation": "

An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com. By default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in Regions that support the event source.

" } }, "documentation": "

Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

You can configure up to five event selectors for a trail.

You cannot apply both event selectors and advanced event selectors to a trail.

" }, "EventSelectors": { "type": "list", "member": { "shape": "EventSelector" } }, "EventSource": { "type": "string", "max": 256, "pattern": "^[a-z0-9_-]+\\.amazonaws\\.com$" }, "EventsList": { "type": "list", "member": { "shape": "Event" } }, "ExcludeManagementEventSources": { "type": "list", "member": { "shape": "String" } }, "FederationRoleArn": { "type": "string", "max": 125, "min": 3, "pattern": "^[a-zA-Z0-9._/\\-:@=\\+,\\.]+$" }, "FederationStatus": { "type": "string", "enum": [ "ENABLING", "ENABLED", "DISABLING", "DISABLED" ] }, "GetChannelRequest": { "type": "structure", "required": [ "Channel" ], "members": { "Channel": { "shape": "ChannelArn", "documentation": "

The ARN or UUID of a channel.

" } } }, "GetChannelResponse": { "type": "structure", "members": { "ChannelArn": { "shape": "ChannelArn", "documentation": "

The ARN of an channel returned by a GetChannel request.

" }, "Name": { "shape": "ChannelName", "documentation": "

The name of the CloudTrail channel. For service-linked channels, the name is aws-service-channel/service-name/custom-suffix where service-name represents the name of the Amazon Web Services service that created the channel and custom-suffix represents the suffix generated by the Amazon Web Services service.

" }, "Source": { "shape": "Source", "documentation": "

The source for the CloudTrail channel.

" }, "SourceConfig": { "shape": "SourceConfig", "documentation": "

Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all Regions or a single Region.

" }, "Destinations": { "shape": "Destinations", "documentation": "

The destinations for the channel. For channels created for integrations, the destinations are the event data stores that log events arriving through the channel. For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.

" }, "IngestionStatus": { "shape": "IngestionStatus", "documentation": "

A table showing information about the most recent successful and failed attempts to ingest events.

" } } }, "GetEventDataStoreRequest": { "type": "structure", "required": [ "EventDataStore" ], "members": { "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

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

" } } }, "GetEventDataStoreResponse": { "type": "structure", "members": { "EventDataStoreArn": { "shape": "EventDataStoreArn", "documentation": "

The event data store Amazon Resource Number (ARN).

" }, "Name": { "shape": "EventDataStoreName", "documentation": "

The name of the event data store.

" }, "Status": { "shape": "EventDataStoreStatus", "documentation": "

The status of an event data store.

" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", "documentation": "

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

" }, "MultiRegionEnabled": { "shape": "Boolean", "documentation": "

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

" }, "OrganizationEnabled": { "shape": "Boolean", "documentation": "

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

" }, "RetentionPeriod": { "shape": "RetentionPeriod", "documentation": "

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

" }, "TerminationProtectionEnabled": { "shape": "TerminationProtectionEnabled", "documentation": "

Indicates that termination protection is enabled.

" }, "CreatedTimestamp": { "shape": "Date", "documentation": "

The timestamp of the event data store's creation.

" }, "UpdatedTimestamp": { "shape": "Date", "documentation": "

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.

" }, "KmsKeyId": { "shape": "EventDataStoreKmsKeyId", "documentation": "

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": { "shape": "BillingMode", "documentation": "

The billing mode for the event data store.

" }, "FederationStatus": { "shape": "FederationStatus", "documentation": "

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.

" }, "FederationRoleArn": { "shape": "FederationRoleArn", "documentation": "

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

" } } }, "GetEventSelectorsRequest": { "type": "structure", "required": [ "TrailName" ], "members": { "TrailName": { "shape": "String", "documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" } } }, "GetEventSelectorsResponse": { "type": "structure", "members": { "TrailARN": { "shape": "String", "documentation": "

The specified trail ARN that has the event selectors.

" }, "EventSelectors": { "shape": "EventSelectors", "documentation": "

The event selectors that are configured for the trail.

" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", "documentation": "

The advanced event selectors that are configured for the trail.

" } } }, "GetImportRequest": { "type": "structure", "required": [ "ImportId" ], "members": { "ImportId": { "shape": "UUID", "documentation": "

The ID for the import.

" } } }, "GetImportResponse": { "type": "structure", "members": { "ImportId": { "shape": "UUID", "documentation": "

The ID of the import.

" }, "Destinations": { "shape": "ImportDestinations", "documentation": "

The ARN of the destination event data store.

" }, "ImportSource": { "shape": "ImportSource", "documentation": "

The source S3 bucket.

" }, "StartEventTime": { "shape": "Date", "documentation": "

Used with EndEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

" }, "EndEventTime": { "shape": "Date", "documentation": "

Used with StartEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

" }, "ImportStatus": { "shape": "ImportStatus", "documentation": "

The status of the import.

" }, "CreatedTimestamp": { "shape": "Date", "documentation": "

The timestamp of the import's creation.

" }, "UpdatedTimestamp": { "shape": "Date", "documentation": "

The timestamp of when the import was updated.

" }, "ImportStatistics": { "shape": "ImportStatistics", "documentation": "

Provides statistics for the import. CloudTrail does not update import statistics in real-time. Returned values for parameters such as EventsCompleted may be lower than the actual value, because CloudTrail updates statistics incrementally over the course of the import.

" } } }, "GetInsightSelectorsRequest": { "type": "structure", "members": { "TrailName": { "shape": "String", "documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

You cannot use this parameter with the EventDataStore parameter.

" }, "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

Specifies the ARN (or ID suffix of the ARN) of the event data store for which you want to get Insights selectors.

You cannot use this parameter with the TrailName parameter.

" } } }, "GetInsightSelectorsResponse": { "type": "structure", "members": { "TrailARN": { "shape": "String", "documentation": "

The Amazon Resource Name (ARN) of a trail for which you want to get Insights selectors.

" }, "InsightSelectors": { "shape": "InsightSelectors", "documentation": "

A JSON string that contains the Insight types you want to log on a trail or event data store. ApiErrorRateInsight and ApiCallRateInsight are supported as Insights types.

" }, "EventDataStoreArn": { "shape": "EventDataStoreArn", "documentation": "

The ARN of the source event data store that enabled Insights events.

" }, "InsightsDestination": { "shape": "EventDataStoreArn", "documentation": "

The ARN of the destination event data store that logs Insights events.

" } } }, "GetQueryResultsRequest": { "type": "structure", "required": [ "QueryId" ], "members": { "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

The ARN (or ID suffix of the ARN) of the event data store against which the query was run.

", "deprecated": true, "deprecatedMessage": "EventDataStore is no longer required by GetQueryResultsRequest" }, "QueryId": { "shape": "UUID", "documentation": "

The ID of the query for which you want to get results.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

A token you can use to get the next page of query results.

" }, "MaxQueryResults": { "shape": "MaxQueryResults", "documentation": "

The maximum number of query results to display on a single page.

" } } }, "GetQueryResultsResponse": { "type": "structure", "members": { "QueryStatus": { "shape": "QueryStatus", "documentation": "

The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

" }, "QueryStatistics": { "shape": "QueryStatistics", "documentation": "

Shows the count of query results.

" }, "QueryResultRows": { "shape": "QueryResultRows", "documentation": "

Contains the individual event results of the query.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

A token you can use to get the next page of query results.

" }, "ErrorMessage": { "shape": "ErrorMessage", "documentation": "

The error message returned if a query failed.

" } } }, "GetResourcePolicyRequest": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "

The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy. The following is the format of a resource ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.

" } } }, "GetResourcePolicyResponse": { "type": "structure", "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "

The Amazon Resource Name (ARN) of the CloudTrail channel attached to resource-based policy.

" }, "ResourcePolicy": { "shape": "ResourcePolicy", "documentation": "

A JSON-formatted string that contains the resource-based policy attached to the CloudTrail channel.

" } } }, "GetTrailRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "String", "documentation": "

The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.

" } } }, "GetTrailResponse": { "type": "structure", "members": { "Trail": { "shape": "Trail" } } }, "GetTrailStatusRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "String", "documentation": "

Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another Region), you must specify its ARN. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" } }, "documentation": "

The name of a trail about which you want the current status.

" }, "GetTrailStatusResponse": { "type": "structure", "members": { "IsLogging": { "shape": "Boolean", "documentation": "

Whether the CloudTrail trail is currently logging Amazon Web Services API calls.

" }, "LatestDeliveryError": { "shape": "String", "documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information, see Error Responses in the Amazon S3 API Reference.

This error occurs only when there is a problem with the destination S3 bucket, and does not occur for requests that time out. To resolve the issue, create a new bucket, and then call UpdateTrail to specify the new bucket; or fix the existing objects so that CloudTrail can again write to the bucket.

" }, "LatestNotificationError": { "shape": "String", "documentation": "

Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.

" }, "LatestDeliveryTime": { "shape": "Date", "documentation": "

Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

" }, "LatestNotificationTime": { "shape": "Date", "documentation": "

Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.

" }, "StartLoggingTime": { "shape": "Date", "documentation": "

Specifies the most recent date and time when CloudTrail started recording API calls for an Amazon Web Services account.

" }, "StopLoggingTime": { "shape": "Date", "documentation": "

Specifies the most recent date and time when CloudTrail stopped recording API calls for an Amazon Web Services account.

" }, "LatestCloudWatchLogsDeliveryError": { "shape": "String", "documentation": "

Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.

" }, "LatestCloudWatchLogsDeliveryTime": { "shape": "Date", "documentation": "

Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

" }, "LatestDigestDeliveryTime": { "shape": "Date", "documentation": "

Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.

" }, "LatestDigestDeliveryError": { "shape": "String", "documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information, see Error Responses in the Amazon S3 API Reference.

This error occurs only when there is a problem with the destination S3 bucket, and does not occur for requests that time out. To resolve the issue, create a new bucket, and then call UpdateTrail to specify the new bucket; or fix the existing objects so that CloudTrail can again write to the bucket.

" }, "LatestDeliveryAttemptTime": { "shape": "String", "documentation": "

This field is no longer in use.

" }, "LatestNotificationAttemptTime": { "shape": "String", "documentation": "

This field is no longer in use.

" }, "LatestNotificationAttemptSucceeded": { "shape": "String", "documentation": "

This field is no longer in use.

" }, "LatestDeliveryAttemptSucceeded": { "shape": "String", "documentation": "

This field is no longer in use.

" }, "TimeLoggingStarted": { "shape": "String", "documentation": "

This field is no longer in use.

" }, "TimeLoggingStopped": { "shape": "String", "documentation": "

This field is no longer in use.

" } }, "documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "ImportDestinations": { "type": "list", "member": { "shape": "EventDataStoreArn" }, "max": 1, "min": 1 }, "ImportFailureList": { "type": "list", "member": { "shape": "ImportFailureListItem" } }, "ImportFailureListItem": { "type": "structure", "members": { "Location": { "shape": "String", "documentation": "

The location of the failure in the S3 bucket.

" }, "Status": { "shape": "ImportFailureStatus", "documentation": "

The status of the import.

" }, "ErrorType": { "shape": "String", "documentation": "

The type of import error.

" }, "ErrorMessage": { "shape": "String", "documentation": "

Provides the reason the import failed.

" }, "LastUpdatedTime": { "shape": "Date", "documentation": "

When the import was last updated.

" } }, "documentation": "

Provides information about an import failure.

" }, "ImportFailureStatus": { "type": "string", "enum": [ "FAILED", "RETRY", "SUCCEEDED" ] }, "ImportSource": { "type": "structure", "required": [ "S3" ], "members": { "S3": { "shape": "S3ImportSource", "documentation": "

The source S3 bucket.

" } }, "documentation": "

The import source.

" }, "ImportStatistics": { "type": "structure", "members": { "PrefixesFound": { "shape": "Long", "documentation": "

The number of S3 prefixes found for the import.

" }, "PrefixesCompleted": { "shape": "Long", "documentation": "

The number of S3 prefixes that completed import.

" }, "FilesCompleted": { "shape": "Long", "documentation": "

The number of log files that completed import.

" }, "EventsCompleted": { "shape": "Long", "documentation": "

The number of trail events imported into the event data store.

" }, "FailedEntries": { "shape": "Long", "documentation": "

The number of failed entries.

" } }, "documentation": "

Provides statistics for the specified ImportID. CloudTrail does not update import statistics in real-time. Returned values for parameters such as EventsCompleted may be lower than the actual value, because CloudTrail updates statistics incrementally over the course of the import.

" }, "ImportStatus": { "type": "string", "enum": [ "INITIALIZING", "IN_PROGRESS", "FAILED", "STOPPED", "COMPLETED" ] }, "ImportsList": { "type": "list", "member": { "shape": "ImportsListItem" } }, "ImportsListItem": { "type": "structure", "members": { "ImportId": { "shape": "UUID", "documentation": "

The ID of the import.

" }, "ImportStatus": { "shape": "ImportStatus", "documentation": "

The status of the import.

" }, "Destinations": { "shape": "ImportDestinations", "documentation": "

The ARN of the destination event data store.

" }, "CreatedTimestamp": { "shape": "Date", "documentation": "

The timestamp of the import's creation.

" }, "UpdatedTimestamp": { "shape": "Date", "documentation": "

The timestamp of the import's last update.

" } }, "documentation": "

Contains information about an import that was returned by a lookup request.

" }, "IngestionStatus": { "type": "structure", "members": { "LatestIngestionSuccessTime": { "shape": "Date", "documentation": "

The time stamp of the most recent successful ingestion of events for the channel.

" }, "LatestIngestionSuccessEventID": { "shape": "UUID", "documentation": "

The event ID of the most recent successful ingestion of events.

" }, "LatestIngestionErrorCode": { "shape": "ErrorMessage", "documentation": "

The error code for the most recent failure to ingest events.

" }, "LatestIngestionAttemptTime": { "shape": "Date", "documentation": "

The time stamp of the most recent attempt to ingest events on the channel.

" }, "LatestIngestionAttemptEventID": { "shape": "UUID", "documentation": "

The event ID of the most recent attempt to ingest events.

" } }, "documentation": "

A table showing information about the most recent successful and failed attempts to ingest events.

" }, "InsightSelector": { "type": "structure", "members": { "InsightType": { "shape": "InsightType", "documentation": "

The type of Insights events to log on a trail or event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.

The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.

" } }, "documentation": "

A JSON string that contains a list of Insights types that are logged on a trail or event data store.

" }, "InsightSelectors": { "type": "list", "member": { "shape": "InsightSelector" } }, "InsightType": { "type": "string", "enum": [ "ApiCallRateInsight", "ApiErrorRateInsight" ] }, "InsightsMetricDataType": { "type": "string", "enum": [ "FillWithZeros", "NonZeroData" ] }, "InsightsMetricMaxResults": { "type": "integer", "max": 21600, "min": 1 }, "InsightsMetricNextToken": { "type": "string", "max": 5000, "min": 1 }, "InsightsMetricPeriod": { "type": "integer", "max": 3600, "min": 60 }, "InsightsMetricValues": { "type": "list", "member": { "shape": "Double" } }, "Integer": { "type": "integer" }, "ListChannelsMaxResultsCount": { "type": "integer", "max": 1000, "min": 1 }, "ListChannelsRequest": { "type": "structure", "members": { "MaxResults": { "shape": "ListChannelsMaxResultsCount", "documentation": "

The maximum number of CloudTrail channels to display on a single page.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

" } } }, "ListChannelsResponse": { "type": "structure", "members": { "Channels": { "shape": "Channels", "documentation": "

The list of channels in the account.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

The token to use to get the next page of results after a previous API call.

" } } }, "ListEventDataStoresMaxResultsCount": { "type": "integer", "max": 1000, "min": 1 }, "ListEventDataStoresRequest": { "type": "structure", "members": { "NextToken": { "shape": "PaginationToken", "documentation": "

A token you can use to get the next page of event data store results.

" }, "MaxResults": { "shape": "ListEventDataStoresMaxResultsCount", "documentation": "

The maximum number of event data stores to display on a single page.

" } } }, "ListEventDataStoresResponse": { "type": "structure", "members": { "EventDataStores": { "shape": "EventDataStores", "documentation": "

Contains information about event data stores in the account, in the current Region.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

A token you can use to get the next page of results.

" } } }, "ListImportFailuresMaxResultsCount": { "type": "integer", "max": 1000, "min": 1 }, "ListImportFailuresRequest": { "type": "structure", "required": [ "ImportId" ], "members": { "ImportId": { "shape": "UUID", "documentation": "

The ID of the import.

" }, "MaxResults": { "shape": "ListImportFailuresMaxResultsCount", "documentation": "

The maximum number of failures to display on a single page.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

A token you can use to get the next page of import failures.

" } } }, "ListImportFailuresResponse": { "type": "structure", "members": { "Failures": { "shape": "ImportFailureList", "documentation": "

Contains information about the import failures.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

A token you can use to get the next page of results.

" } } }, "ListImportsMaxResultsCount": { "type": "integer", "max": 1000, "min": 1 }, "ListImportsRequest": { "type": "structure", "members": { "MaxResults": { "shape": "ListImportsMaxResultsCount", "documentation": "

The maximum number of imports to display on a single page.

" }, "Destination": { "shape": "EventDataStoreArn", "documentation": "

The ARN of the destination event data store.

" }, "ImportStatus": { "shape": "ImportStatus", "documentation": "

The status of the import.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

A token you can use to get the next page of import results.

" } } }, "ListImportsResponse": { "type": "structure", "members": { "Imports": { "shape": "ImportsList", "documentation": "

The list of returned imports.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

A token you can use to get the next page of import results.

" } } }, "ListInsightsMetricDataRequest": { "type": "structure", "required": [ "EventSource", "EventName", "InsightType" ], "members": { "EventSource": { "shape": "EventSource", "documentation": "

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

" }, "EventName": { "shape": "EventName", "documentation": "

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

" }, "InsightType": { "shape": "InsightType", "documentation": "

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

" }, "ErrorCode": { "shape": "ErrorCode", "documentation": "

Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

" }, "StartTime": { "shape": "Date", "documentation": "

Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.

The default is 90 days before the time of request.

" }, "EndTime": { "shape": "Date", "documentation": "

Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.

The default is the time of request.

" }, "Period": { "shape": "InsightsMetricPeriod", "documentation": "

Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. If you specify any other value, you will get an error. The default is 3600 seconds.

" }, "DataType": { "shape": "InsightsMetricDataType", "documentation": "

Type of datapoints to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

" }, "MaxResults": { "shape": "InsightsMetricMaxResults", "documentation": "

The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.

" }, "NextToken": { "shape": "InsightsMetricNextToken", "documentation": "

Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.

Add this parameter to the request to continue retrieving results starting from the last evaluated point.

" } } }, "ListInsightsMetricDataResponse": { "type": "structure", "members": { "EventSource": { "shape": "EventSource", "documentation": "

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

" }, "EventName": { "shape": "EventName", "documentation": "

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

" }, "InsightType": { "shape": "InsightType", "documentation": "

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

" }, "ErrorCode": { "shape": "ErrorCode", "documentation": "

Only returned if InsightType parameter was set to ApiErrorRateInsight.

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

" }, "Timestamps": { "shape": "Timestamps", "documentation": "

List of timestamps at intervals corresponding to the specified time period.

" }, "Values": { "shape": "InsightsMetricValues", "documentation": "

List of values representing the API call rate or error rate at each timestamp. The number of values is equal to the number of timestamps.

" }, "NextToken": { "shape": "InsightsMetricNextToken", "documentation": "

Only returned if the full results could not be returned in a single query. You can set the NextToken parameter in the next request to this value to continue retrieval.

" } } }, "ListPublicKeysRequest": { "type": "structure", "members": { "StartTime": { "shape": "Date", "documentation": "

Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.

" }, "EndTime": { "shape": "Date", "documentation": "

Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.

" }, "NextToken": { "shape": "String", "documentation": "

Reserved for future use.

" } }, "documentation": "

Requests the public keys for a specified time range.

" }, "ListPublicKeysResponse": { "type": "structure", "members": { "PublicKeyList": { "shape": "PublicKeyList", "documentation": "

Contains an array of PublicKey objects.

The returned public keys may have validity time ranges that overlap.

" }, "NextToken": { "shape": "String", "documentation": "

Reserved for future use.

" } }, "documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "ListQueriesMaxResultsCount": { "type": "integer", "max": 1000, "min": 1 }, "ListQueriesRequest": { "type": "structure", "required": [ "EventDataStore" ], "members": { "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

A token you can use to get the next page of results.

" }, "MaxResults": { "shape": "ListQueriesMaxResultsCount", "documentation": "

The maximum number of queries to show on a page.

" }, "StartTime": { "shape": "Date", "documentation": "

Use with EndTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.

" }, "EndTime": { "shape": "Date", "documentation": "

Use with StartTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.

" }, "QueryStatus": { "shape": "QueryStatus", "documentation": "

The status of queries that you want to return in results. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

" } } }, "ListQueriesResponse": { "type": "structure", "members": { "Queries": { "shape": "Queries", "documentation": "

Lists matching query results, and shows query ID, status, and creation time of each query.

" }, "NextToken": { "shape": "PaginationToken", "documentation": "

A token you can use to get the next page of results.

" } } }, "ListTagsRequest": { "type": "structure", "required": [ "ResourceIdList" ], "members": { "ResourceIdList": { "shape": "ResourceIdList", "documentation": "

Specifies a list of trail, event data store, or channel ARNs whose tags will be listed. The list has a limit of 20 ARNs.

Example trail ARN format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Example event data store ARN format: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

Example channel ARN format: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

" }, "NextToken": { "shape": "String", "documentation": "

Reserved for future use.

" } }, "documentation": "

Specifies a list of tags to return.

" }, "ListTagsResponse": { "type": "structure", "members": { "ResourceTagList": { "shape": "ResourceTagList", "documentation": "

A list of resource tags.

" }, "NextToken": { "shape": "String", "documentation": "

Reserved for future use.

" } }, "documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "ListTrailsRequest": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

" } } }, "ListTrailsResponse": { "type": "structure", "members": { "Trails": { "shape": "Trails", "documentation": "

Returns the name, ARN, and home Region of trails in the current account.

" }, "NextToken": { "shape": "String", "documentation": "

The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

" } } }, "Location": { "type": "string", "max": 1024, "min": 3, "pattern": "^[a-zA-Z0-9._/\\-:]+$" }, "Long": { "type": "long" }, "LookupAttribute": { "type": "structure", "required": [ "AttributeKey", "AttributeValue" ], "members": { "AttributeKey": { "shape": "LookupAttributeKey", "documentation": "

Specifies an attribute on which to filter the events returned.

" }, "AttributeValue": { "shape": "LookupAttributeValue", "documentation": "

Specifies a value for the specified AttributeKey.

The maximum length for the AttributeValue is 2000 characters. The following characters ('_', ' ', ',', '\\\\n') count as two characters towards the 2000 character limit.

" } }, "documentation": "

Specifies an attribute and value that filter the events returned.

" }, "LookupAttributeKey": { "type": "string", "enum": [ "EventId", "EventName", "ReadOnly", "Username", "ResourceType", "ResourceName", "EventSource", "AccessKeyId" ] }, "LookupAttributeValue": { "type": "string", "max": 2000, "min": 1 }, "LookupAttributesList": { "type": "list", "member": { "shape": "LookupAttribute" } }, "LookupEventsRequest": { "type": "structure", "members": { "LookupAttributes": { "shape": "LookupAttributesList", "documentation": "

Contains a list of lookup attributes. Currently the list can contain only one item.

" }, "StartTime": { "shape": "Date", "documentation": "

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

" }, "EndTime": { "shape": "Date", "documentation": "

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

" }, "EventCategory": { "shape": "EventCategory", "documentation": "

Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, if you do not specify insight as the value of EventCategory, no Insights events are returned.

" }, "MaxResults": { "shape": "MaxResults", "documentation": "

The number of events to return. Possible values are 1 through 50. The default is 50.

" }, "NextToken": { "shape": "NextToken", "documentation": "

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

" } }, "documentation": "

Contains a request for LookupEvents.

" }, "LookupEventsResponse": { "type": "structure", "members": { "Events": { "shape": "EventsList", "documentation": "

A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.

" }, "NextToken": { "shape": "NextToken", "documentation": "

The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

" } }, "documentation": "

Contains a response to a LookupEvents action.

" }, "MaxQueryResults": { "type": "integer", "max": 1000, "min": 1 }, "MaxResults": { "type": "integer", "max": 50, "min": 1 }, "NextToken": { "type": "string" }, "Operator": { "type": "list", "member": { "shape": "OperatorValue" }, "min": 1 }, "OperatorValue": { "type": "string", "max": 2048, "min": 1, "pattern": ".+" }, "PaginationToken": { "type": "string", "max": 1000, "min": 4, "pattern": ".*" }, "PublicKey": { "type": "structure", "members": { "Value": { "shape": "ByteBuffer", "documentation": "

The DER encoded public key value in PKCS#1 format.

" }, "ValidityStartTime": { "shape": "Date", "documentation": "

The starting time of validity of the public key.

" }, "ValidityEndTime": { "shape": "Date", "documentation": "

The ending time of validity of the public key.

" }, "Fingerprint": { "shape": "String", "documentation": "

The fingerprint of the public key.

" } }, "documentation": "

Contains information about a returned public key.

" }, "PublicKeyList": { "type": "list", "member": { "shape": "PublicKey" } }, "PutEventSelectorsRequest": { "type": "structure", "required": [ "TrailName" ], "members": { "TrailName": { "shape": "String", "documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

If you specify a trail ARN, it must be in the following format.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" }, "EventSelectors": { "shape": "EventSelectors", "documentation": "

Specifies the settings for your event selectors. You can configure up to five event selectors for a trail. You can use either EventSelectors or AdvancedEventSelectors in a PutEventSelectors request, but not both. If you apply EventSelectors to a trail, any existing AdvancedEventSelectors are overwritten.

" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", "documentation": "

Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events in the CloudTrail User Guide.

" } } }, "PutEventSelectorsResponse": { "type": "structure", "members": { "TrailARN": { "shape": "String", "documentation": "

Specifies the ARN of the trail that was updated with event selectors. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" }, "EventSelectors": { "shape": "EventSelectors", "documentation": "

Specifies the event selectors configured for your trail.

" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", "documentation": "

Specifies the advanced event selectors configured for your trail.

" } } }, "PutInsightSelectorsRequest": { "type": "structure", "required": [ "InsightSelectors" ], "members": { "TrailName": { "shape": "String", "documentation": "

The name of the CloudTrail trail for which you want to change or add Insights selectors.

You cannot use this parameter with the EventDataStore and InsightsDestination parameters.

" }, "InsightSelectors": { "shape": "InsightSelectors", "documentation": "

A JSON string that contains the Insights types you want to log on a trail or event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.

The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.

" }, "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

The ARN (or ID suffix of the ARN) of the source event data store for which you want to change or add Insights selectors. To enable Insights on an event data store, you must provide both the EventDataStore and InsightsDestination parameters.

You cannot use this parameter with the TrailName parameter.

" }, "InsightsDestination": { "shape": "EventDataStoreArn", "documentation": "

The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. To enable Insights on an event data store, you must provide both the EventDataStore and InsightsDestination parameters.

You cannot use this parameter with the TrailName parameter.

" } } }, "PutInsightSelectorsResponse": { "type": "structure", "members": { "TrailARN": { "shape": "String", "documentation": "

The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights selectors.

" }, "InsightSelectors": { "shape": "InsightSelectors", "documentation": "

A JSON string that contains the Insights event types that you want to log on a trail or event data store. The valid Insights types are ApiErrorRateInsight and ApiCallRateInsight.

" }, "EventDataStoreArn": { "shape": "EventDataStoreArn", "documentation": "

The Amazon Resource Name (ARN) of the source event data store for which you want to change or add Insights selectors.

" }, "InsightsDestination": { "shape": "EventDataStoreArn", "documentation": "

The ARN of the destination event data store that logs Insights events.

" } } }, "PutResourcePolicyRequest": { "type": "structure", "required": [ "ResourceArn", "ResourcePolicy" ], "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "

The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy. The following is the format of a resource ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.

" }, "ResourcePolicy": { "shape": "ResourcePolicy", "documentation": "

A JSON-formatted string for an Amazon Web Services resource-based policy.

The following are requirements for the resource policy:

" } } }, "PutResourcePolicyResponse": { "type": "structure", "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "

The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.

" }, "ResourcePolicy": { "shape": "ResourcePolicy", "documentation": "

The JSON-formatted string of the Amazon Web Services resource-based policy attached to the CloudTrail channel.

" } } }, "Queries": { "type": "list", "member": { "shape": "Query" } }, "Query": { "type": "structure", "members": { "QueryId": { "shape": "UUID", "documentation": "

The ID of a query.

" }, "QueryStatus": { "shape": "QueryStatus", "documentation": "

The status of the query. This can be QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

" }, "CreationTime": { "shape": "Date", "documentation": "

The creation time of a query.

" } }, "documentation": "

A SQL string of criteria about events that you want to collect in an event data store.

" }, "QueryAlias": { "type": "string", "max": 256, "min": 1, "pattern": "^[a-zA-Z][a-zA-Z0-9._\\-]*$" }, "QueryParameter": { "type": "string", "max": 1024, "min": 1, "pattern": ".*" }, "QueryParameters": { "type": "list", "member": { "shape": "QueryParameter" }, "max": 10, "min": 1 }, "QueryResultColumn": { "type": "map", "key": { "shape": "QueryResultKey" }, "value": { "shape": "QueryResultValue" } }, "QueryResultKey": { "type": "string" }, "QueryResultRow": { "type": "list", "member": { "shape": "QueryResultColumn" } }, "QueryResultRows": { "type": "list", "member": { "shape": "QueryResultRow" } }, "QueryResultValue": { "type": "string" }, "QueryStatement": { "type": "string", "max": 10000, "min": 1, "pattern": "(?s).*" }, "QueryStatistics": { "type": "structure", "members": { "ResultsCount": { "shape": "Integer", "documentation": "

The number of results returned.

" }, "TotalResultsCount": { "shape": "Integer", "documentation": "

The total number of results returned by a query.

" }, "BytesScanned": { "shape": "Long", "documentation": "

The total bytes that the query scanned in the event data store. This value matches the number of bytes for which your account is billed for the query, unless the query is still running.

" } }, "documentation": "

Metadata about a query, such as the number of results.

" }, "QueryStatisticsForDescribeQuery": { "type": "structure", "members": { "EventsMatched": { "shape": "Long", "documentation": "

The number of events that matched a query.

" }, "EventsScanned": { "shape": "Long", "documentation": "

The number of events that the query scanned in the event data store.

" }, "BytesScanned": { "shape": "Long", "documentation": "

The total bytes that the query scanned in the event data store. This value matches the number of bytes for which your account is billed for the query, unless the query is still running.

" }, "ExecutionTimeInMillis": { "shape": "Integer", "documentation": "

The query's run time, in milliseconds.

" }, "CreationTime": { "shape": "Date", "documentation": "

The creation time of the query.

" } }, "documentation": "

Gets metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

" }, "QueryStatus": { "type": "string", "enum": [ "QUEUED", "RUNNING", "FINISHED", "FAILED", "CANCELLED", "TIMED_OUT" ] }, "ReadWriteType": { "type": "string", "enum": [ "ReadOnly", "WriteOnly", "All" ] }, "RegisterOrganizationDelegatedAdminRequest": { "type": "structure", "required": [ "MemberAccountId" ], "members": { "MemberAccountId": { "shape": "AccountId", "documentation": "

An organization member account ID that you want to designate as a delegated administrator.

" } }, "documentation": "

Specifies an organization member account ID as a CloudTrail delegated administrator.

" }, "RegisterOrganizationDelegatedAdminResponse": { "type": "structure", "members": {}, "documentation": "

Returns the following response if successful. Otherwise, returns an error.

" }, "RemoveTagsRequest": { "type": "structure", "required": [ "ResourceId", "TagsList" ], "members": { "ResourceId": { "shape": "String", "documentation": "

Specifies the ARN of the trail, event data store, or channel from which tags should be removed.

Example trail ARN format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Example event data store ARN format: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

Example channel ARN format: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

" }, "TagsList": { "shape": "TagsList", "documentation": "

Specifies a list of tags to be removed.

" } }, "documentation": "

Specifies the tags to remove from a trail, event data store, or channel.

" }, "RemoveTagsResponse": { "type": "structure", "members": {}, "documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "Resource": { "type": "structure", "members": { "ResourceType": { "shape": "String", "documentation": "

The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for Amazon RDS, and AccessKey for IAM. To learn more about how to look up and filter events by the resource types supported for a service, see Filtering CloudTrail Events.

" }, "ResourceName": { "shape": "String", "documentation": "

The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be \"auto-scaling-test-group\" for an Auto Scaling Group or \"i-1234567\" for an EC2 Instance.

" } }, "documentation": "

Specifies the type and name of a resource referenced by an event.

" }, "ResourceArn": { "type": "string", "max": 256, "min": 3, "pattern": "^[a-zA-Z0-9._/\\-:]+$" }, "ResourceIdList": { "type": "list", "member": { "shape": "String" } }, "ResourceList": { "type": "list", "member": { "shape": "Resource" }, "documentation": "

A list of resources referenced by the event returned.

" }, "ResourcePolicy": { "type": "string", "max": 8192, "min": 1 }, "ResourceTag": { "type": "structure", "members": { "ResourceId": { "shape": "String", "documentation": "

Specifies the ARN of the resource.

" }, "TagsList": { "shape": "TagsList", "documentation": "

A list of tags.

" } }, "documentation": "

A resource tag.

" }, "ResourceTagList": { "type": "list", "member": { "shape": "ResourceTag" } }, "RestoreEventDataStoreRequest": { "type": "structure", "required": [ "EventDataStore" ], "members": { "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

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

" } } }, "RestoreEventDataStoreResponse": { "type": "structure", "members": { "EventDataStoreArn": { "shape": "EventDataStoreArn", "documentation": "

The event data store ARN.

" }, "Name": { "shape": "EventDataStoreName", "documentation": "

The name of the event data store.

" }, "Status": { "shape": "EventDataStoreStatus", "documentation": "

The status of the event data store.

" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", "documentation": "

The advanced event selectors that were used to select events.

" }, "MultiRegionEnabled": { "shape": "Boolean", "documentation": "

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

" }, "OrganizationEnabled": { "shape": "Boolean", "documentation": "

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

" }, "RetentionPeriod": { "shape": "RetentionPeriod", "documentation": "

The retention period, in days.

" }, "TerminationProtectionEnabled": { "shape": "TerminationProtectionEnabled", "documentation": "

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

" }, "CreatedTimestamp": { "shape": "Date", "documentation": "

The timestamp of an event data store's creation.

" }, "UpdatedTimestamp": { "shape": "Date", "documentation": "

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

" }, "KmsKeyId": { "shape": "EventDataStoreKmsKeyId", "documentation": "

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": { "shape": "BillingMode", "documentation": "

The billing mode for the event data store.

" } } }, "RetentionPeriod": { "type": "integer", "max": 3653, "min": 7 }, "S3ImportSource": { "type": "structure", "required": [ "S3LocationUri", "S3BucketRegion", "S3BucketAccessRoleArn" ], "members": { "S3LocationUri": { "shape": "String", "documentation": "

The URI for the source S3 bucket.

" }, "S3BucketRegion": { "shape": "String", "documentation": "

The Region associated with the source S3 bucket.

" }, "S3BucketAccessRoleArn": { "shape": "String", "documentation": "

The IAM ARN role used to access the source S3 bucket.

" } }, "documentation": "

The settings for the source S3 bucket.

" }, "SelectorField": { "type": "string", "max": 1000, "min": 1, "pattern": "[\\w|\\d|\\.|_]+" }, "SelectorName": { "type": "string", "max": 1000, "min": 0, "pattern": ".*" }, "Source": { "type": "string", "max": 256, "min": 1, "pattern": ".*" }, "SourceConfig": { "type": "structure", "members": { "ApplyToAllRegions": { "shape": "Boolean", "documentation": "

Specifies whether the channel applies to a single Region or to all Regions.

" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", "documentation": "

The advanced event selectors that are configured for the channel.

" } }, "documentation": "

Contains configuration information about the channel.

" }, "StartEventDataStoreIngestionRequest": { "type": "structure", "required": [ "EventDataStore" ], "members": { "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

The ARN (or ID suffix of the ARN) of the event data store for which you want to start ingestion.

" } } }, "StartEventDataStoreIngestionResponse": { "type": "structure", "members": {} }, "StartImportRequest": { "type": "structure", "members": { "Destinations": { "shape": "ImportDestinations", "documentation": "

The ARN of the destination event data store. Use this parameter for a new import.

" }, "ImportSource": { "shape": "ImportSource", "documentation": "

The source S3 bucket for the import. Use this parameter for a new import.

" }, "StartEventTime": { "shape": "Date", "documentation": "

Use with EndEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the prefix and log file names to verify the names contain a date between the specified StartEventTime and EndEventTime before attempting to import events.

" }, "EndEventTime": { "shape": "Date", "documentation": "

Use with StartEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the prefix and log file names to verify the names contain a date between the specified StartEventTime and EndEventTime before attempting to import events.

" }, "ImportId": { "shape": "UUID", "documentation": "

The ID of the import. Use this parameter when you are retrying an import.

" } } }, "StartImportResponse": { "type": "structure", "members": { "ImportId": { "shape": "UUID", "documentation": "

The ID of the import.

" }, "Destinations": { "shape": "ImportDestinations", "documentation": "

The ARN of the destination event data store.

" }, "ImportSource": { "shape": "ImportSource", "documentation": "

The source S3 bucket for the import.

" }, "StartEventTime": { "shape": "Date", "documentation": "

Used with EndEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

" }, "EndEventTime": { "shape": "Date", "documentation": "

Used with StartEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

" }, "ImportStatus": { "shape": "ImportStatus", "documentation": "

Shows the status of the import after a StartImport request. An import finishes with a status of COMPLETED if there were no failures, or FAILED if there were failures.

" }, "CreatedTimestamp": { "shape": "Date", "documentation": "

The timestamp for the import's creation.

" }, "UpdatedTimestamp": { "shape": "Date", "documentation": "

The timestamp of the import's last update, if applicable.

" } } }, "StartLoggingRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "String", "documentation": "

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" } }, "documentation": "

The request to CloudTrail to start logging Amazon Web Services API calls for an account.

" }, "StartLoggingResponse": { "type": "structure", "members": {}, "documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "StartQueryRequest": { "type": "structure", "members": { "QueryStatement": { "shape": "QueryStatement", "documentation": "

The SQL code of your query.

" }, "DeliveryS3Uri": { "shape": "DeliveryS3Uri", "documentation": "

The URI for the S3 bucket where CloudTrail delivers the query results.

" }, "QueryAlias": { "shape": "QueryAlias", "documentation": "

The alias that identifies a query template.

" }, "QueryParameters": { "shape": "QueryParameters", "documentation": "

The query parameters for the specified QueryAlias.

" } } }, "StartQueryResponse": { "type": "structure", "members": { "QueryId": { "shape": "UUID", "documentation": "

The ID of the started query.

" } } }, "StopEventDataStoreIngestionRequest": { "type": "structure", "required": [ "EventDataStore" ], "members": { "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

The ARN (or ID suffix of the ARN) of the event data store for which you want to stop ingestion.

" } } }, "StopEventDataStoreIngestionResponse": { "type": "structure", "members": {} }, "StopImportRequest": { "type": "structure", "required": [ "ImportId" ], "members": { "ImportId": { "shape": "UUID", "documentation": "

The ID of the import.

" } } }, "StopImportResponse": { "type": "structure", "members": { "ImportId": { "shape": "UUID", "documentation": "

The ID for the import.

" }, "ImportSource": { "shape": "ImportSource", "documentation": "

The source S3 bucket for the import.

" }, "Destinations": { "shape": "ImportDestinations", "documentation": "

The ARN of the destination event data store.

" }, "ImportStatus": { "shape": "ImportStatus", "documentation": "

The status of the import.

" }, "CreatedTimestamp": { "shape": "Date", "documentation": "

The timestamp of the import's creation.

" }, "UpdatedTimestamp": { "shape": "Date", "documentation": "

The timestamp of the import's last update.

" }, "StartEventTime": { "shape": "Date", "documentation": "

Used with EndEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

" }, "EndEventTime": { "shape": "Date", "documentation": "

Used with StartEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

" }, "ImportStatistics": { "shape": "ImportStatistics", "documentation": "

Returns information on the stopped import.

" } } }, "StopLoggingRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "String", "documentation": "

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging Amazon Web Services API calls. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" } }, "documentation": "

Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.

" }, "StopLoggingResponse": { "type": "structure", "members": {}, "documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "String": { "type": "string" }, "Tag": { "type": "structure", "required": [ "Key" ], "members": { "Key": { "shape": "TagKey", "documentation": "

The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

" }, "Value": { "shape": "TagValue", "documentation": "

The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

" } }, "documentation": "

A custom key-value pair associated with a resource such as a CloudTrail trail, event data store, or channel.

" }, "TagKey": { "type": "string", "max": 128, "min": 1 }, "TagValue": { "type": "string", "max": 256, "min": 1 }, "TagsList": { "type": "list", "member": { "shape": "Tag" }, "documentation": "

A list of tags.

", "max": 200 }, "TerminationProtectionEnabled": { "type": "boolean" }, "Timestamps": { "type": "list", "member": { "shape": "Date" } }, "Trail": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "

Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

" }, "S3BucketName": { "shape": "String", "documentation": "

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.

" }, "S3KeyPrefix": { "shape": "String", "documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

" }, "SnsTopicName": { "shape": "String", "documentation": "

This field is no longer in use. Use SnsTopicARN.

", "deprecated": true }, "SnsTopicARN": { "shape": "String", "documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.

arn:aws:sns:us-east-2:123456789012:MyTopic

" }, "IncludeGlobalServiceEvents": { "shape": "Boolean", "documentation": "

Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.

" }, "IsMultiRegionTrail": { "shape": "Boolean", "documentation": "

Specifies whether the trail exists only in one Region or exists in all Regions.

" }, "HomeRegion": { "shape": "String", "documentation": "

The Region in which the trail was created.

" }, "TrailARN": { "shape": "String", "documentation": "

Specifies the ARN of the trail. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" }, "LogFileValidationEnabled": { "shape": "Boolean", "documentation": "

Specifies whether log file validation is enabled.

" }, "CloudWatchLogsLogGroupArn": { "shape": "String", "documentation": "

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

" }, "CloudWatchLogsRoleArn": { "shape": "String", "documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" }, "KmsKeyId": { "shape": "String", "documentation": "

Specifies the KMS key ID that encrypts the logs 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

" }, "HasCustomEventSelectors": { "shape": "Boolean", "documentation": "

Specifies if the trail has custom event selectors.

" }, "HasInsightSelectors": { "shape": "Boolean", "documentation": "

Specifies whether a trail has insight types specified in an InsightSelector list.

" }, "IsOrganizationTrail": { "shape": "Boolean", "documentation": "

Specifies whether the trail is an organization trail.

" } }, "documentation": "

The settings for a trail.

" }, "TrailInfo": { "type": "structure", "members": { "TrailARN": { "shape": "String", "documentation": "

The ARN of a trail.

" }, "Name": { "shape": "String", "documentation": "

The name of a trail.

" }, "HomeRegion": { "shape": "String", "documentation": "

The Amazon Web Services Region in which a trail was created.

" } }, "documentation": "

Information about a CloudTrail trail, including the trail's name, home Region, and Amazon Resource Name (ARN).

" }, "TrailList": { "type": "list", "member": { "shape": "Trail" } }, "TrailNameList": { "type": "list", "member": { "shape": "String" } }, "Trails": { "type": "list", "member": { "shape": "TrailInfo" } }, "UUID": { "type": "string", "max": 36, "min": 36, "pattern": "^[a-f0-9\\-]+$" }, "UpdateChannelRequest": { "type": "structure", "required": [ "Channel" ], "members": { "Channel": { "shape": "ChannelArn", "documentation": "

The ARN or ID (the ARN suffix) of the channel that you want to update.

" }, "Destinations": { "shape": "Destinations", "documentation": "

The ARNs of event data stores that you want to log events arriving through the channel.

" }, "Name": { "shape": "ChannelName", "documentation": "

Changes the name of the channel.

" } } }, "UpdateChannelResponse": { "type": "structure", "members": { "ChannelArn": { "shape": "ChannelArn", "documentation": "

The ARN of the channel that was updated.

" }, "Name": { "shape": "ChannelName", "documentation": "

The name of the channel that was updated.

" }, "Source": { "shape": "Source", "documentation": "

The event source of the channel that was updated.

" }, "Destinations": { "shape": "Destinations", "documentation": "

The event data stores that log events arriving through the channel.

" } } }, "UpdateEventDataStoreRequest": { "type": "structure", "required": [ "EventDataStore" ], "members": { "EventDataStore": { "shape": "EventDataStoreArn", "documentation": "

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

" }, "Name": { "shape": "EventDataStoreName", "documentation": "

The event data store name.

" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", "documentation": "

The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.

" }, "MultiRegionEnabled": { "shape": "Boolean", "documentation": "

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

" }, "OrganizationEnabled": { "shape": "Boolean", "documentation": "

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

Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.

" }, "RetentionPeriod": { "shape": "RetentionPeriod", "documentation": "

The retention period of the event data store, in days. If BillingMode is set to EXTENDABLE_RETENTION_PRICING, you can set a retention period of up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING, you can set a retention period of up to 2557 days, the equivalent of seven years.

CloudTrail Lake determines whether to retain an event by checking if the eventTime of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the eventTime is older than 90 days.

If you decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.

" }, "TerminationProtectionEnabled": { "shape": "TerminationProtectionEnabled", "documentation": "

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

" }, "KmsKeyId": { "shape": "EventDataStoreKmsKeyId", "documentation": "

Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by alias/, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

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.

CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

Examples:

" }, "BillingMode": { "shape": "BillingMode", "documentation": "

You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING. If BillingMode is set to EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING.

The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.

The following are the possible values:

For more information about CloudTrail pricing, see CloudTrail Pricing and Managing CloudTrail Lake costs.

" } } }, "UpdateEventDataStoreResponse": { "type": "structure", "members": { "EventDataStoreArn": { "shape": "EventDataStoreArn", "documentation": "

The ARN of the event data store.

" }, "Name": { "shape": "EventDataStoreName", "documentation": "

The name of the event data store.

" }, "Status": { "shape": "EventDataStoreStatus", "documentation": "

The status of an event data store.

" }, "AdvancedEventSelectors": { "shape": "AdvancedEventSelectors", "documentation": "

The advanced event selectors that are applied to the event data store.

" }, "MultiRegionEnabled": { "shape": "Boolean", "documentation": "

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

" }, "OrganizationEnabled": { "shape": "Boolean", "documentation": "

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

" }, "RetentionPeriod": { "shape": "RetentionPeriod", "documentation": "

The retention period, in days.

" }, "TerminationProtectionEnabled": { "shape": "TerminationProtectionEnabled", "documentation": "

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

" }, "CreatedTimestamp": { "shape": "Date", "documentation": "

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

" }, "UpdatedTimestamp": { "shape": "Date", "documentation": "

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.

" }, "KmsKeyId": { "shape": "EventDataStoreKmsKeyId", "documentation": "

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": { "shape": "BillingMode", "documentation": "

The billing mode for the event data store.

" }, "FederationStatus": { "shape": "FederationStatus", "documentation": "

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.

" }, "FederationRoleArn": { "shape": "FederationRoleArn", "documentation": "

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

" } } }, "UpdateTrailRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "String", "documentation": "

Specifies the name of the trail or trail ARN. If Name is a trail name, the string must meet the following requirements:

If Name is a trail ARN, it must be in the following format.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" }, "S3BucketName": { "shape": "String", "documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

" }, "S3KeyPrefix": { "shape": "String", "documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

" }, "SnsTopicName": { "shape": "String", "documentation": "

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

" }, "IncludeGlobalServiceEvents": { "shape": "Boolean", "documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" }, "IsMultiRegionTrail": { "shape": "Boolean", "documentation": "

Specifies whether the trail applies only to the current Region or to all Regions. The default is false. If the trail exists only in the current Region and this value is set to true, shadow trails (replications of the trail) will be created in the other Regions. If the trail exists in all Regions and this value is set to false, the trail will remain in the Region where it was created, and its shadow trails in other Regions will be deleted. As a best practice, consider using trails that log events in all Regions.

" }, "EnableLogFileValidation": { "shape": "Boolean", "documentation": "

Specifies whether log file validation is enabled. The default is false.

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

" }, "CloudWatchLogsLogGroupArn": { "shape": "String", "documentation": "

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. You must use a log group that exists in your account.

Not required unless you specify CloudWatchLogsRoleArn.

" }, "CloudWatchLogsRoleArn": { "shape": "String", "documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.

" }, "KmsKeyId": { "shape": "String", "documentation": "

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

Examples:

" }, "IsOrganizationTrail": { "shape": "Boolean", "documentation": "

Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all Amazon Web Services accounts that belong to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current Amazon Web Services account but be deleted from all member accounts in the organization.

Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to an organization trail.

" } }, "documentation": "

Specifies settings to update for the trail.

" }, "UpdateTrailResponse": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "

Specifies the name of the trail.

" }, "S3BucketName": { "shape": "String", "documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" }, "S3KeyPrefix": { "shape": "String", "documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your IAM Log Files.

" }, "SnsTopicName": { "shape": "String", "documentation": "

This field is no longer in use. Use SnsTopicARN.

", "deprecated": true }, "SnsTopicARN": { "shape": "String", "documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.

arn:aws:sns:us-east-2:123456789012:MyTopic

" }, "IncludeGlobalServiceEvents": { "shape": "Boolean", "documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" }, "IsMultiRegionTrail": { "shape": "Boolean", "documentation": "

Specifies whether the trail exists in one Region or in all Regions.

" }, "TrailARN": { "shape": "String", "documentation": "

Specifies the ARN of the trail that was updated. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" }, "LogFileValidationEnabled": { "shape": "Boolean", "documentation": "

Specifies whether log file integrity validation is enabled.

" }, "CloudWatchLogsLogGroupArn": { "shape": "String", "documentation": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs are delivered.

" }, "CloudWatchLogsRoleArn": { "shape": "String", "documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" }, "KmsKeyId": { "shape": "String", "documentation": "

Specifies the KMS key ID that encrypts the logs 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

" }, "IsOrganizationTrail": { "shape": "Boolean", "documentation": "

Specifies whether the trail is an organization trail.

" } }, "documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" } }, "documentation": "CloudTrail

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.

As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.

See the CloudTrail User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

" }