Package-level declarations

Types

Link copied to clipboard

You do not have sufficient access to perform this action.

Link copied to clipboard

This exception is thrown when you start a new import and a previous import is still in progress.

Link copied to clipboard

This exception is thrown when the specified account is not found or not part of an organization.

Link copied to clipboard

This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.

Link copied to clipboard

This exception is thrown when the account is already registered as the CloudTrail delegated administrator.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the Logging data events, Logging network activity events, and Logging management events topics in the CloudTrail User Guide.

Link copied to clipboard

A single selector statement in an advanced event selector.

Link copied to clipboard
sealed class BillingMode
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This exception is thrown when the management account of an organization is registered as the CloudTrail delegated administrator.

Link copied to clipboard
class Channel

Contains information about a returned CloudTrail channel.

Link copied to clipboard

This exception is thrown when the provided channel already exists.

Link copied to clipboard

This exception is thrown when the specified value of ChannelARN is not valid.

Link copied to clipboard

This exception is thrown when the specified event data store cannot yet be deleted because it is in use by a channel.

Link copied to clipboard

This exception is thrown when the maximum number of channels limit is exceeded.

Link copied to clipboard

This exception is thrown when CloudTrail cannot find the specified channel.

Link copied to clipboard

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.

Link copied to clipboard

This exception is thrown when an operation is called with an ARN that is not valid.

Link copied to clipboard

Base class for all service related exceptions thrown by the CloudTrail client

Link copied to clipboard

This exception is thrown when a call results in the InvalidClientTokenId error code. This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is in a suspended Amazon Web Services account.

Cannot set a CloudWatch Logs delivery for this Region.

Link copied to clipboard

You are trying to update a resource when another request is in progress. Allow sufficient wait time for the previous request to complete, then retry your request.

Link copied to clipboard

This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.

Link copied to clipboard

An object that contains information types to be included in CloudTrail enriched events.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Specifies the settings for each trail.

Link copied to clipboard

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

Link copied to clipboard

Provides information about a CloudTrail Lake dashboard.

Link copied to clipboard
sealed class DashboardStatus
Link copied to clipboard
sealed class DashboardType
Link copied to clipboard

You can configure the DataResource in an EventSelector to log data events for the following three resource types:

This exception is thrown when the maximum number of CloudTrail delegated administrators is reached.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class DeliveryStatus

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

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Returns information about the trail.

Link copied to clipboard

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

Link copied to clipboard

Contains information about the destination receiving events.

Link copied to clipboard
sealed class DestinationType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Event

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

Link copied to clipboard
sealed class EventCategory
Link copied to clipboard

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.

Link copied to clipboard

An event data store with that name already exists.

Link copied to clipboard

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

Link copied to clipboard

You cannot delete the event data store because Lake query federation is enabled. To delete the event data store, run the DisableFederation operation to disable Lake query federation on the event data store.

Link copied to clipboard

This exception is thrown when you try to update or delete an event data store that currently has an import in progress.

Link copied to clipboard

Your account has used the maximum number of event data stores.

Link copied to clipboard

The specified event data store was not found.

Link copied to clipboard

The event data store cannot be deleted because termination protection is enabled for it.

Link copied to clipboard

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.

Link copied to clipboard
sealed class FederationStatus
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This exception is thrown when a valid query could not be generated for the provided prompt.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Provides information about an import failure.

Link copied to clipboard
sealed class ImportFailureStatus
Link copied to clipboard

The specified import was not found.

Link copied to clipboard

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

Link copied to clipboard

The import source.

Link copied to clipboard

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.

Link copied to clipboard
sealed class ImportStatus
Link copied to clipboard

The event data store is inactive.

Link copied to clipboard

The specified query cannot be canceled because it is in the FINISHED, FAILED, TIMED_OUT, or CANCELLED state.

Link copied to clipboard

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

Link copied to clipboard

If you run GetInsightSelectors on a trail or event data store that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
sealed class InsightType

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

Link copied to clipboard

For the CreateTrail``PutInsightSelectors, UpdateTrail, StartQuery, and StartImport operations, this exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.

Link copied to clipboard

The task can't be completed because you are signed in with an account that lacks permissions to view or create a service-linked role. Sign in with an account that has the required permissions and then try again.

Link copied to clipboard

This exception is thrown when the policy on the S3 bucket is not sufficient.

Link copied to clipboard

This exception is thrown when the policy on the Amazon SNS topic is not sufficient.

This exception is thrown when the provided CloudWatch Logs log group is not valid.

Link copied to clipboard

This exception is thrown when the provided role is not valid.

Link copied to clipboard

A date range for the query was specified that is not valid. Be sure that the start time is chronologically before the end time. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.

Link copied to clipboard

Occurs if an event category that is not valid is specified as a value of EventCategory.

Link copied to clipboard

This exception is thrown when event categories of specified event data stores are not valid.

Link copied to clipboard

The event data store is not in a status that supports the operation.

Link copied to clipboard

This exception is thrown when the PutEventSelectors operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.

Link copied to clipboard

This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.

Link copied to clipboard

This exception is thrown when the provided source S3 bucket is not valid for import.

Link copied to clipboard

For PutInsightSelectors, this exception is thrown when the formatting or syntax of the InsightSelectors JSON statement is not valid, or the specified InsightType in the InsightSelectors statement is not valid. Valid values for InsightType are ApiCallRateInsight and ApiErrorRateInsight. To enable Insights on an event data store, the destination event data store specified by the InsightsDestination parameter must log Insights events and the source event data store specified by the EventDataStore parameter must log management events.

Link copied to clipboard

This exception is thrown when the KMS key ARN is not valid.

Link copied to clipboard

Occurs when a lookup attribute is specified that is not valid.

Link copied to clipboard

This exception is thrown if the limit specified is not valid.

Link copied to clipboard

A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.

Link copied to clipboard

This exception is thrown when the combination of parameters provided is not valid.

Link copied to clipboard

The request includes a parameter that is not valid.

Link copied to clipboard

The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.

Link copied to clipboard

The query status is not valid for the operation.

Link copied to clipboard

This exception is thrown when the provided S3 bucket name is not valid.

Link copied to clipboard

This exception is thrown when the provided S3 prefix is not valid.

Link copied to clipboard

This exception is thrown when the provided SNS topic name is not valid.

Link copied to clipboard

This exception is thrown when the specified value of Source is not valid.

Link copied to clipboard

This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.

Link copied to clipboard

Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.

Link copied to clipboard

Reserved for future use.

Link copied to clipboard

This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:

Link copied to clipboard

This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.

Link copied to clipboard

This exception is no longer in use.

Link copied to clipboard

This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Requests the public keys for a specified time range.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Specifies a list of tags to return.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Specifies an attribute and value that filter the events returned.

Link copied to clipboard
sealed class LookupAttributeKey
Link copied to clipboard

Contains a request for LookupEvents.

Link copied to clipboard

Contains a response to a LookupEvents action.

Link copied to clipboard

You are already running the maximum number of concurrent queries. The maximum number of concurrent queries is 10. Wait a minute for some queries to finish, and then run the query again.

Link copied to clipboard
sealed class MaxEventSize
Link copied to clipboard

This exception is thrown when the maximum number of trails is reached.

Link copied to clipboard

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

This exception is thrown when the account making the request is not the organization's management account.

Link copied to clipboard

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

Link copied to clipboard

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

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

Link copied to clipboard

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

Link copied to clipboard

Contains information about a partition key for an event data store.

Link copied to clipboard
class PublicKey

Contains information about a returned public key.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Query

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

Link copied to clipboard

The query ID does not exist or does not map to a query.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
sealed class QueryStatus
Link copied to clipboard
sealed class ReadWriteType
Link copied to clipboard

The schedule for a dashboard refresh.

Link copied to clipboard

Specifies the frequency for a dashboard refresh schedule.

Link copied to clipboard
Link copied to clipboard

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

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Contains information about a widget on a CloudTrail Lake dashboard.

Link copied to clipboard
class Resource

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

Link copied to clipboard

This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid.

Link copied to clipboard

This exception is thrown when the specified resource is not found.

Link copied to clipboard

This exception is thrown when the specified resource policy is not found.

Link copied to clipboard

This exception is thrown when the resouce-based policy has syntax errors, or contains a principal that is not valid.

Link copied to clipboard

A resource tag.

Link copied to clipboard

This exception is thrown when the specified resource type is not supported by CloudTrail.

Link copied to clipboard

This exception is thrown when the specified S3 bucket does not exist.

Link copied to clipboard

The settings for the source S3 bucket.

Link copied to clipboard

A search result returned by the SearchSampleQueries operation.

Link copied to clipboard

This exception is thrown when the quota is exceeded. For information about CloudTrail quotas, see Service quotas in the Amazon Web Services General Reference.

Link copied to clipboard

Contains configuration information about the channel.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request to CloudTrail to start logging Amazon Web Services API calls for an account.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.

Link copied to clipboard

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

Link copied to clipboard
class Tag

A custom key-value pair associated with a resource such as a CloudTrail trail, event data store, dashboard, or channel.

Link copied to clipboard

The number of tags per trail, event data store, dashboard, or channel has exceeded the permitted amount. Currently, the limit is 50.

Link copied to clipboard

This exception is thrown when the request rate exceeds the limit.

Link copied to clipboard
class Trail

The settings for a trail.

Link copied to clipboard

This exception is thrown when the specified trail already exists.

Link copied to clipboard
class TrailInfo

Information about a CloudTrail trail, including the trail's name, home Region, and Amazon Resource Name (ARN).

Link copied to clipboard

This exception is thrown when the trail with the given name is not found.

Link copied to clipboard

This exception is no longer in use.

Link copied to clipboard
sealed class Type
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Specifies settings to update for the trail.

Link copied to clipboard

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

Link copied to clipboard
class Widget

A widget on a CloudTrail Lake dashboard.