AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessDeniedException

You do not have sufficient access to perform this action.

Class AccountHasOngoingImportException

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

Class AccountNotFoundException

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

Class AccountNotRegisteredException

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

Class AccountRegisteredException

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

Class AddTagsRequest

Container for the parameters to the AddTags operation. 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).

Class AddTagsResponse

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

Class AdvancedEventSelector

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

  • eventCategory (required)

  • eventSource

  • readOnly

Supported CloudTrail event record fields for data events

  • eventCategory (required)

  • resources.type (required)

  • readOnly

  • eventName

  • 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.

Class AdvancedFieldSelector

A single selector statement in an advanced event selector.

Class CancelQueryRequest

Container for the parameters to the CancelQuery operation. 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.

Class CancelQueryResponse

This is the response object from the CancelQuery operation.

Class CannotDelegateManagementAccountException

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

Class Channel

Contains information about a returned CloudTrail channel.

Class ChannelAlreadyExistsException

This exception is thrown when the provided channel already exists.

Class ChannelARNInvalidException

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

Class ChannelExistsForEDSException

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

Class ChannelMaxLimitExceededException

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

Class ChannelNotFoundException

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

Class CloudTrailAccessNotEnabledException

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

Class CloudTrailARNInvalidException

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

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

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

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

Class CloudTrailInvalidClientTokenIdException

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.

Class CloudTrailPaginatorFactory

Paginators for the CloudTrail service

Class CloudWatchLogsDeliveryUnavailableException

Cannot set a CloudWatch Logs delivery for this Region.

Class ConcurrentModificationException

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.

Class ConflictException

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.

Class CreateChannelRequest

Container for the parameters to the CreateChannel operation. 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.

Class CreateChannelResponse

This is the response object from the CreateChannel operation.

Class CreateEventDataStoreRequest

Container for the parameters to the CreateEventDataStore operation. Creates a new event data store.

Class CreateEventDataStoreResponse

This is the response object from the CreateEventDataStore operation.

Class CreateTrailRequest

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

Class CreateTrailResponse

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

Class DataResource

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.

Class DelegatedAdminAccountLimitExceededException

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

Class DeleteChannelRequest

Container for the parameters to the DeleteChannel operation. Deletes a channel.

Class DeleteChannelResponse

This is the response object from the DeleteChannel operation.

Class DeleteEventDataStoreRequest

Container for the parameters to the DeleteEventDataStore operation. 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.

Class DeleteEventDataStoreResponse

This is the response object from the DeleteEventDataStore operation.

Class DeleteResourcePolicyRequest

Container for the parameters to the DeleteResourcePolicy operation. Deletes the resource-based policy attached to the CloudTrail channel.

Class DeleteResourcePolicyResponse

This is the response object from the DeleteResourcePolicy operation.

Class DeleteTrailRequest

Container for the parameters to the DeleteTrail operation. 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.

Class DeleteTrailResponse

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

Class DeregisterOrganizationDelegatedAdminRequest

Container for the parameters to the DeregisterOrganizationDelegatedAdmin operation. Removes CloudTrail delegated administrator permissions from a member account in an organization.

Class DeregisterOrganizationDelegatedAdminResponse

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

Class DescribeQueryRequest

Container for the parameters to the DescribeQuery operation. 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.

Class DescribeQueryResponse

This is the response object from the DescribeQuery operation.

Class DescribeTrailsRequest

Container for the parameters to the DescribeTrails operation. Retrieves settings for one or more trails associated with the current Region for your account.

Class DescribeTrailsResponse

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

Class Destination

Contains information about the destination receiving events.

Class DisableFederationRequest

Container for the parameters to the DisableFederation operation. 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.

Class DisableFederationResponse

This is the response object from the DisableFederation operation.

Class EnableFederationRequest

Container for the parameters to the EnableFederation operation. 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.

Class EnableFederationResponse

This is the response object from the EnableFederation operation.

Class Event

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

Class EventDataStore

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.

Class EventDataStoreAlreadyExistsException

An event data store with that name already exists.

Class EventDataStoreARNInvalidException

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

Class EventDataStoreFederationEnabledException

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.

Class EventDataStoreHasOngoingImportException

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

Class EventDataStoreMaxLimitExceededException

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

Class EventDataStoreNotFoundException

The specified event data store was not found.

Class EventDataStoreTerminationProtectedException

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

Class EventSelector

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.

Class GetChannelRequest

Container for the parameters to the GetChannel operation. Returns information about a specific channel.

Class GetChannelResponse

This is the response object from the GetChannel operation.

Class GetEventDataStoreRequest

Container for the parameters to the GetEventDataStore operation. Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

Class GetEventDataStoreResponse

This is the response object from the GetEventDataStore operation.

Class GetEventSelectorsRequest

Container for the parameters to the GetEventSelectors operation. Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

  • If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.

  • If your event selector includes management events.

  • If your event selector includes data events, the resources on which you are logging data events.

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

Class GetEventSelectorsResponse

This is the response object from the GetEventSelectors operation.

Class GetImportRequest

Container for the parameters to the GetImport operation. Returns information about a specific import.

Class GetImportResponse

This is the response object from the GetImport operation.

Class GetInsightSelectorsRequest

Container for the parameters to the GetInsightSelectors operation. 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.

Class GetInsightSelectorsResponse

This is the response object from the GetInsightSelectors operation.

Class GetQueryResultsRequest

Container for the parameters to the GetQueryResults operation. Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation.

Class GetQueryResultsResponse

This is the response object from the GetQueryResults operation.

Class GetResourcePolicyRequest

Container for the parameters to the GetResourcePolicy operation. Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.

Class GetResourcePolicyResponse

This is the response object from the GetResourcePolicy operation.

Class GetTrailRequest

Container for the parameters to the GetTrail operation. Returns settings information for a specified trail.

Class GetTrailResponse

This is the response object from the GetTrail operation.

Class GetTrailStatusRequest

Container for the parameters to the GetTrailStatus operation. 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.

Class GetTrailStatusResponse

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

Class ImportFailureListItem

Provides information about an import failure.

Class ImportNotFoundException

The specified import was not found.

Class ImportsListItem

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

Class ImportSource

The import source.

Class ImportStatistics

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.

Class InactiveEventDataStoreException

The event data store is inactive.

Class InactiveQueryException

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

Class IngestionStatus

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

Class InsightNotEnabledException

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

Class InsightSelector

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

Class InsufficientDependencyServiceAccessPermissionException

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.

Class InsufficientEncryptionPolicyException

This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.

Class InsufficientS3BucketPolicyException

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

Class InsufficientSnsTopicPolicyException

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

Class InvalidCloudWatchLogsLogGroupArnException

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

Class InvalidCloudWatchLogsRoleArnException

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

Class InvalidDateRangeException

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.

Class InvalidEventCategoryException

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

Class InvalidEventDataStoreCategoryException

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

Class InvalidEventDataStoreStatusException

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

Class InvalidEventSelectorsException

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.

You can:

  • Specify a valid number of event selectors (1 to 5) for a trail.

  • Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.

  • Specify up to 500 values for all conditions in all advanced event selectors for a trail.

  • Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is not valid.

Class InvalidHomeRegionException

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.

Class InvalidImportSourceException

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

Class InvalidInsightSelectorsException

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.

For UpdateEventDataStore, this exception is thrown if Insights are enabled on the event data store and the updated advanced event selectors are not compatible with the configured InsightSelectors. If the InsightSelectors includes an InsightType of ApiCallRateInsight, the source event data store must log write management events. If the InsightSelectors includes an InsightType of ApiErrorRateInsight, the source event data store must log management events.

Class InvalidKmsKeyIdException

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

Class InvalidLookupAttributesException

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

Class InvalidMaxResultsException

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

Class InvalidNextTokenException

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.

Class InvalidParameterCombinationException

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

Class InvalidParameterException

The request includes a parameter that is not valid.

Class InvalidQueryStatementException

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.

Class InvalidQueryStatusException

The query status is not valid for the operation.

Class InvalidS3BucketNameException

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

Class InvalidS3PrefixException

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

Class InvalidSnsTopicNameException

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

Class InvalidSourceException

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

Class InvalidTagParameterException

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.

Class InvalidTimeRangeException

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.

Class InvalidTokenException

Reserved for future use.

Class InvalidTrailNameException

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

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.

  • Not be in IP address format (for example, 192.168.5.4)

Class KmsException

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.

Class KmsKeyDisabledException

This exception is no longer in use.

Class KmsKeyNotFoundException

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.

Class ListChannelsRequest

Container for the parameters to the ListChannels operation. Lists the channels in the current account, and their source names.

Class ListChannelsResponse

This is the response object from the ListChannels operation.

Class ListEventDataStoresRequest

Container for the parameters to the ListEventDataStores operation. Returns information about all event data stores in the account, in the current Region.

Class ListEventDataStoresResponse

This is the response object from the ListEventDataStores operation.

Class ListImportFailuresRequest

Container for the parameters to the ListImportFailures operation. Returns a list of failures for the specified import.

Class ListImportFailuresResponse

This is the response object from the ListImportFailures operation.

Class ListImportsRequest

Container for the parameters to the ListImports operation. Returns information on all imports, or a select set of imports by ImportStatus or Destination.

Class ListImportsResponse

This is the response object from the ListImports operation.

Class ListInsightsMetricDataRequest

Container for the parameters to the ListInsightsMetricData operation. 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.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 90 days.

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.

Class ListInsightsMetricDataResponse

This is the response object from the ListInsightsMetricData operation.

Class ListPublicKeysRequest

Container for the parameters to the ListPublicKeys operation. 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.

Class ListPublicKeysResponse

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

Class ListQueriesRequest

Container for the parameters to the ListQueries operation. 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.

Class ListQueriesResponse

This is the response object from the ListQueries operation.

Class ListTagsRequest

Container for the parameters to the ListTags operation. Lists the tags for the specified trails, event data stores, or channels in the current Region.

Class ListTagsResponse

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

Class ListTrailsRequest

Container for the parameters to the ListTrails operation. Lists trails that are in the current account.

Class ListTrailsResponse

This is the response object from the ListTrails operation.

Class LookupAttribute

Specifies an attribute and value that filter the events returned.

Class LookupEventsRequest

Container for the parameters to the LookupEvents operation. 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:

  • Amazon Web Services access key

  • Event ID

  • Event name

  • Event source

  • Read only

  • Resource name

  • Resource type

  • User name

Lookup supports the following attributes for Insights events:

  • Event ID

  • Event name

  • Event source

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.

Class LookupEventsResponse

Contains a response to a LookupEvents action.

Class MaxConcurrentQueriesException

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.

Class MaximumNumberOfTrailsExceededException

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

Class NoManagementAccountSLRExistsException

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

Class NotOrganizationManagementAccountException

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

Class NotOrganizationMasterAccountException

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

Class OperationNotPermittedException

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

Class OrganizationNotInAllFeaturesModeException

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.

Class OrganizationsNotInUseException

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

Class PublicKey

Contains information about a returned public key.

Class PutEventSelectorsRequest

Container for the parameters to the PutEventSelectors operation. 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.

Class PutEventSelectorsResponse

This is the response object from the PutEventSelectors operation.

Class PutInsightSelectorsRequest

Container for the parameters to the PutInsightSelectors operation. 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.

Class PutInsightSelectorsResponse

This is the response object from the PutInsightSelectors operation.

Class PutResourcePolicyRequest

Container for the parameters to the PutResourcePolicy operation. 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.

Class PutResourcePolicyResponse

This is the response object from the PutResourcePolicy operation.

Class Query

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

Class QueryIdNotFoundException

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

Class QueryStatistics

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

Class QueryStatisticsForDescribeQuery

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.

Class RegisterOrganizationDelegatedAdminRequest

Container for the parameters to the RegisterOrganizationDelegatedAdmin operation. Registers an organization’s member account as the CloudTrail delegated administrator.

Class RegisterOrganizationDelegatedAdminResponse

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

Class RemoveTagsRequest

Container for the parameters to the RemoveTags operation. Removes the specified tags from a trail, event data store, or channel.

Class RemoveTagsResponse

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

Class Resource

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

Class ResourceARNNotValidException

This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid. The following is the valid format for a resource ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.

Class ResourceNotFoundException

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

Class ResourcePolicyNotFoundException

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

Class ResourcePolicyNotValidException

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

The following are requirements for the resource policy:

  • Contains only one action: cloudtrail-data:PutAuditEvents

  • Contains at least one statement. The policy can have a maximum of 20 statements.

  • Each statement contains at least one principal. A statement can have a maximum of 50 principals.

Class ResourceTag

A resource tag.

Class ResourceTypeNotSupportedException

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

Class RestoreEventDataStoreRequest

Container for the parameters to the RestoreEventDataStore operation. 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.

Class RestoreEventDataStoreResponse

This is the response object from the RestoreEventDataStore operation.

Class S3BucketDoesNotExistException

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

Class S3ImportSource

The settings for the source S3 bucket.

Class SourceConfig

Contains configuration information about the channel.

Class StartEventDataStoreIngestionRequest

Container for the parameters to the StartEventDataStoreIngestion operation. 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.

Class StartEventDataStoreIngestionResponse

This is the response object from the StartEventDataStoreIngestion operation.

Class StartImportRequest

Container for the parameters to the StartImport operation. 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.

Class StartImportResponse

This is the response object from the StartImport operation.

Class StartLoggingRequest

Container for the parameters to the StartLogging operation. 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.

Class StartLoggingResponse

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

Class StartQueryRequest

Container for the parameters to the StartQuery operation. 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.

Class StartQueryResponse

This is the response object from the StartQuery operation.

Class StopEventDataStoreIngestionRequest

Container for the parameters to the StopEventDataStoreIngestion operation. 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.

Class StopEventDataStoreIngestionResponse

This is the response object from the StopEventDataStoreIngestion operation.

Class StopImportRequest

Container for the parameters to the StopImport operation. Stops a specified import.

Class StopImportResponse

This is the response object from the StopImport operation.

Class StopLoggingRequest

Container for the parameters to the StopLogging operation. 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.

Class StopLoggingResponse

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

Class Tag

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

Class TagsLimitExceededException

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

Class ThrottlingException

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

Class Trail

The settings for a trail.

Class TrailAlreadyExistsException

This exception is thrown when the specified trail already exists.

Class TrailInfo

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

Class TrailNotFoundException

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

Class TrailNotProvidedException

This exception is no longer in use.

Class UnsupportedOperationException

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

Class UpdateChannelRequest

Container for the parameters to the UpdateChannel operation. Updates a channel specified by a required channel ARN or UUID.

Class UpdateChannelResponse

This is the response object from the UpdateChannel operation.

Class UpdateEventDataStoreRequest

Container for the parameters to the UpdateEventDataStore operation. 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.

Class UpdateEventDataStoreResponse

This is the response object from the UpdateEventDataStore operation.

Class UpdateTrailRequest

Container for the parameters to the UpdateTrail operation. 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.

Class UpdateTrailResponse

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

Interfaces

NameDescription
Interface ICloudTrailPaginatorFactory

Paginators for the CloudTrail service

Interface IGetQueryResultsPaginator

Paginator for the GetQueryResults operation

Interface IListChannelsPaginator

Paginator for the ListChannels operation

Interface IListEventDataStoresPaginator

Paginator for the ListEventDataStores operation

Interface IListImportFailuresPaginator

Paginator for the ListImportFailures operation

Interface IListImportsPaginator

Paginator for the ListImports operation

Interface IListInsightsMetricDataPaginator

Paginator for the ListInsightsMetricData operation

Interface IListPublicKeysPaginator

Paginator for the ListPublicKeys operation

Interface IListQueriesPaginator

Paginator for the ListQueries operation

Interface IListTagsPaginator

Paginator for the ListTags operation

Interface IListTrailsPaginator

Paginator for the ListTrails operation

Interface ILookupEventsPaginator

Paginator for the LookupEvents operation