/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.cloudtrail; import javax.annotation.Generated; import com.amazonaws.services.cloudtrail.model.*; /** * Interface for accessing CloudTrail asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.cloudtrail.AbstractAWSCloudTrailAsync} instead. *
*
*
* 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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSCloudTrailAsync extends AWSCloudTrail { /** ** 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). *
* * @param addTagsRequest * Specifies the tags to add to a trail, event data store, or channel. * @return A Java Future containing the result of the AddTags operation returned by the service. * @sample AWSCloudTrailAsync.AddTags * @see AWS API * Documentation */ java.util.concurrent.Future* 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). *
* * @param addTagsRequest * Specifies the tags to add to a trail, event data store, or channel. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AddTags operation returned by the service. * @sample AWSCloudTrailAsyncHandler.AddTags * @see AWS API * Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* 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. *
* * @param createChannelRequest * @return A Java Future containing the result of the CreateChannel operation returned by the service. * @sample AWSCloudTrailAsync.CreateChannel * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param createChannelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateChannel operation returned by the service. * @sample AWSCloudTrailAsyncHandler.CreateChannel * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a new event data store. *
* * @param createEventDataStoreRequest * @return A Java Future containing the result of the CreateEventDataStore operation returned by the service. * @sample AWSCloudTrailAsync.CreateEventDataStore * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new event data store. *
* * @param createEventDataStoreRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateEventDataStore operation returned by the service. * @sample AWSCloudTrailAsyncHandler.CreateEventDataStore * @see AWS API Documentation */ java.util.concurrent.Future* Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. *
* * @param createTrailRequest * Specifies the settings for each trail. * @return A Java Future containing the result of the CreateTrail operation returned by the service. * @sample AWSCloudTrailAsync.CreateTrail * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. *
* * @param createTrailRequest * Specifies the settings for each trail. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateTrail operation returned by the service. * @sample AWSCloudTrailAsyncHandler.CreateTrail * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes a channel. *
* * @param deleteChannelRequest * @return A Java Future containing the result of the DeleteChannel operation returned by the service. * @sample AWSCloudTrailAsync.DeleteChannel * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes a channel. *
* * @param deleteChannelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteChannel operation returned by the service. * @sample AWSCloudTrailAsyncHandler.DeleteChannel * @see AWS API * Documentation */ java.util.concurrent.Future
* 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; this operation cannot work if
* TerminationProtectionEnabled
is True
.
*
* 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.
*
* 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; this operation cannot work if
* TerminationProtectionEnabled
is True
.
*
* 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.
*
* Deletes the resource-based policy attached to the CloudTrail channel. *
* * @param deleteResourcePolicyRequest * @return A Java Future containing the result of the DeleteResourcePolicy operation returned by the service. * @sample AWSCloudTrailAsync.DeleteResourcePolicy * @see AWS API Documentation */ java.util.concurrent.Future* Deletes the resource-based policy attached to the CloudTrail channel. *
* * @param deleteResourcePolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteResourcePolicy operation returned by the service. * @sample AWSCloudTrailAsyncHandler.DeleteResourcePolicy * @see AWS API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Removes CloudTrail delegated administrator permissions from a member account in an organization. *
* * @param deregisterOrganizationDelegatedAdminRequest * Removes CloudTrail delegated administrator permissions from a specified member account in an organization * that is currently designated as a delegated administrator. * @return A Java Future containing the result of the DeregisterOrganizationDelegatedAdmin operation returned by the * service. * @sample AWSCloudTrailAsync.DeregisterOrganizationDelegatedAdmin * @see AWS API Documentation */ java.util.concurrent.Future* Removes CloudTrail delegated administrator permissions from a member account in an organization. *
* * @param deregisterOrganizationDelegatedAdminRequest * Removes CloudTrail delegated administrator permissions from a specified member account in an organization * that is currently designated as a delegated administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeregisterOrganizationDelegatedAdmin operation returned by the * service. * @sample AWSCloudTrailAsyncHandler.DeregisterOrganizationDelegatedAdmin * @see AWS API Documentation */ java.util.concurrent.Future* 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.
*
* 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.
*
* Retrieves settings for one or more trails associated with the current Region for your account. *
* * @param describeTrailsRequest * Returns information about the trail. * @return A Java Future containing the result of the DescribeTrails operation returned by the service. * @sample AWSCloudTrailAsync.DescribeTrails * @see AWS API * Documentation */ java.util.concurrent.Future* Retrieves settings for one or more trails associated with the current Region for your account. *
* * @param describeTrailsRequest * Returns information about the trail. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeTrails operation returned by the service. * @sample AWSCloudTrailAsyncHandler.DescribeTrails * @see AWS API * Documentation */ java.util.concurrent.Future* Returns information about a specific channel. *
* * @param getChannelRequest * @return A Java Future containing the result of the GetChannel operation returned by the service. * @sample AWSCloudTrailAsync.GetChannel * @see AWS API * Documentation */ java.util.concurrent.Future* Returns information about a specific channel. *
* * @param getChannelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetChannel operation returned by the service. * @sample AWSCloudTrailAsyncHandler.GetChannel * @see AWS API * Documentation */ java.util.concurrent.Future* Returns information about an event data store specified as either an ARN or the ID portion of the ARN. *
* * @param getEventDataStoreRequest * @return A Java Future containing the result of the GetEventDataStore operation returned by the service. * @sample AWSCloudTrailAsync.GetEventDataStore * @see AWS * API Documentation */ java.util.concurrent.Future* Returns information about an event data store specified as either an ARN or the ID portion of the ARN. *
* * @param getEventDataStoreRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetEventDataStore operation returned by the service. * @sample AWSCloudTrailAsyncHandler.GetEventDataStore * @see AWS * API Documentation */ java.util.concurrent.Future* 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: *
** 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: *
** Returns information about a specific import. *
* * @param getImportRequest * @return A Java Future containing the result of the GetImport operation returned by the service. * @sample AWSCloudTrailAsync.GetImport * @see AWS API * Documentation */ java.util.concurrent.Future* Returns information about a specific import. *
* * @param getImportRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetImport operation returned by the service. * @sample AWSCloudTrailAsyncHandler.GetImport * @see AWS API * Documentation */ java.util.concurrent.Future
* Describes the settings for the Insights event selectors that you configured for your trail.
* GetInsightSelectors
shows if CloudTrail Insights event logging is enabled on the trail, and if it
* is, which insight types are enabled. If you run GetInsightSelectors
on a trail that does not have
* Insights events enabled, the operation throws the exception InsightNotEnabledException
*
* For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide. *
* * @param getInsightSelectorsRequest * @return A Java Future containing the result of the GetInsightSelectors operation returned by the service. * @sample AWSCloudTrailAsync.GetInsightSelectors * @see AWS * API Documentation */ java.util.concurrent.Future
* Describes the settings for the Insights event selectors that you configured for your trail.
* GetInsightSelectors
shows if CloudTrail Insights event logging is enabled on the trail, and if it
* is, which insight types are enabled. If you run GetInsightSelectors
on a trail that does not have
* Insights events enabled, the operation throws the exception InsightNotEnabledException
*
* For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide. *
* * @param getInsightSelectorsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetInsightSelectors operation returned by the service. * @sample AWSCloudTrailAsyncHandler.GetInsightSelectors * @see AWS * API Documentation */ java.util.concurrent.Future
* Gets event data results of a query. You must specify the QueryID
value returned by the
* StartQuery
operation.
*
* Gets event data results of a query. You must specify the QueryID
value returned by the
* StartQuery
operation.
*
* Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel. *
* * @param getResourcePolicyRequest * @return A Java Future containing the result of the GetResourcePolicy operation returned by the service. * @sample AWSCloudTrailAsync.GetResourcePolicy * @see AWS * API Documentation */ java.util.concurrent.Future* Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel. *
* * @param getResourcePolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetResourcePolicy operation returned by the service. * @sample AWSCloudTrailAsyncHandler.GetResourcePolicy * @see AWS * API Documentation */ java.util.concurrent.Future* Returns settings information for a specified trail. *
* * @param getTrailRequest * @return A Java Future containing the result of the GetTrail operation returned by the service. * @sample AWSCloudTrailAsync.GetTrail * @see AWS API * Documentation */ java.util.concurrent.Future* Returns settings information for a specified trail. *
* * @param getTrailRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetTrail operation returned by the service. * @sample AWSCloudTrailAsyncHandler.GetTrail * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param getTrailStatusRequest * The name of a trail about which you want the current status. * @return A Java Future containing the result of the GetTrailStatus operation returned by the service. * @sample AWSCloudTrailAsync.GetTrailStatus * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param getTrailStatusRequest * The name of a trail about which you want the current status. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetTrailStatus operation returned by the service. * @sample AWSCloudTrailAsyncHandler.GetTrailStatus * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the channels in the current account, and their source names. *
* * @param listChannelsRequest * @return A Java Future containing the result of the ListChannels operation returned by the service. * @sample AWSCloudTrailAsync.ListChannels * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the channels in the current account, and their source names. *
* * @param listChannelsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListChannels operation returned by the service. * @sample AWSCloudTrailAsyncHandler.ListChannels * @see AWS API * Documentation */ java.util.concurrent.Future* Returns information about all event data stores in the account, in the current Region. *
* * @param listEventDataStoresRequest * @return A Java Future containing the result of the ListEventDataStores operation returned by the service. * @sample AWSCloudTrailAsync.ListEventDataStores * @see AWS * API Documentation */ java.util.concurrent.Future* Returns information about all event data stores in the account, in the current Region. *
* * @param listEventDataStoresRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListEventDataStores operation returned by the service. * @sample AWSCloudTrailAsyncHandler.ListEventDataStores * @see AWS * API Documentation */ java.util.concurrent.Future* Returns a list of failures for the specified import. *
* * @param listImportFailuresRequest * @return A Java Future containing the result of the ListImportFailures operation returned by the service. * @sample AWSCloudTrailAsync.ListImportFailures * @see AWS * API Documentation */ java.util.concurrent.Future* Returns a list of failures for the specified import. *
* * @param listImportFailuresRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListImportFailures operation returned by the service. * @sample AWSCloudTrailAsyncHandler.ListImportFailures * @see AWS * API Documentation */ java.util.concurrent.Future
* Returns information on all imports, or a select set of imports by ImportStatus
or
* Destination
.
*
* Returns information on all imports, or a select set of imports by ImportStatus
or
* Destination
.
*
* 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. *
** 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. *
*
* 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
.
*
* 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
.
*
* Lists the tags for the specified trails, event data stores, or channels in the current Region. *
* * @param listTagsRequest * Specifies a list of tags to return. * @return A Java Future containing the result of the ListTags operation returned by the service. * @sample AWSCloudTrailAsync.ListTags * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the tags for the specified trails, event data stores, or channels in the current Region. *
* * @param listTagsRequest * Specifies a list of tags to return. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTags operation returned by the service. * @sample AWSCloudTrailAsyncHandler.ListTags * @see AWS API * Documentation */ java.util.concurrent.Future* Lists trails that are in the current account. *
* * @param listTrailsRequest * @return A Java Future containing the result of the ListTrails operation returned by the service. * @sample AWSCloudTrailAsync.ListTrails * @see AWS API * Documentation */ java.util.concurrent.Future* Lists trails that are in the current account. *
* * @param listTrailsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTrails operation returned by the service. * @sample AWSCloudTrailAsyncHandler.ListTrails * @see AWS API * Documentation */ java.util.concurrent.Future* 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. 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. *
** 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. 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. *
** 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 *
** You create an event selector for a trail and specify that you want write-only events. *
*
* The EC2 GetConsoleOutput
and RunInstances
API operations occur in your account.
*
* CloudTrail evaluates whether the events match your event selectors. *
*
* The RunInstances
is a write-only event and it matches your event selector. The trail logs the event.
*
* 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.
*
* 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 *
** You create an event selector for a trail and specify that you want write-only events. *
*
* The EC2 GetConsoleOutput
and RunInstances
API operations occur in your account.
*
* CloudTrail evaluates whether the events match your event selectors. *
*
* The RunInstances
is a write-only event and it matches your event selector. The trail logs the event.
*
* 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.
*
* Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
* existing trail. You also use PutInsightSelectors
to turn off Insights event logging, by passing an
* empty list of insight types. The valid Insights event types in this release are ApiErrorRateInsight
* and ApiCallRateInsight
.
*
* To log CloudTrail Insights events on API call volume, the trail must log write
management events. To
* log CloudTrail Insights events on API error rate, the trail must log read
or write
* management events. You can call GetEventSelectors
on a trail to check whether the trail logs
* management events.
*
* Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
* existing trail. You also use PutInsightSelectors
to turn off Insights event logging, by passing an
* empty list of insight types. The valid Insights event types in this release are ApiErrorRateInsight
* and ApiCallRateInsight
.
*
* To log CloudTrail Insights events on API call volume, the trail must log write
management events. To
* log CloudTrail Insights events on API error rate, the trail must log read
or write
* management events. You can call GetEventSelectors
on a trail to check whether the trail logs
* management events.
*
* 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. *
* * @param putResourcePolicyRequest * @return A Java Future containing the result of the PutResourcePolicy operation returned by the service. * @sample AWSCloudTrailAsync.PutResourcePolicy * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param putResourcePolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the PutResourcePolicy operation returned by the service. * @sample AWSCloudTrailAsyncHandler.PutResourcePolicy * @see AWS * API Documentation */ java.util.concurrent.Future* Registers an organization’s member account as the CloudTrail delegated administrator. *
* * @param registerOrganizationDelegatedAdminRequest * Specifies an organization member account ID as a CloudTrail delegated administrator. * @return A Java Future containing the result of the RegisterOrganizationDelegatedAdmin operation returned by the * service. * @sample AWSCloudTrailAsync.RegisterOrganizationDelegatedAdmin * @see AWS API Documentation */ java.util.concurrent.Future* Registers an organization’s member account as the CloudTrail delegated administrator. *
* * @param registerOrganizationDelegatedAdminRequest * Specifies an organization member account ID as a CloudTrail delegated administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the RegisterOrganizationDelegatedAdmin operation returned by the * service. * @sample AWSCloudTrailAsyncHandler.RegisterOrganizationDelegatedAdmin * @see AWS API Documentation */ java.util.concurrent.Future* Removes the specified tags from a trail, event data store, or channel. *
* * @param removeTagsRequest * Specifies the tags to remove from a trail, event data store, or channel. * @return A Java Future containing the result of the RemoveTags operation returned by the service. * @sample AWSCloudTrailAsync.RemoveTags * @see AWS API * Documentation */ java.util.concurrent.Future* Removes the specified tags from a trail, event data store, or channel. *
* * @param removeTagsRequest * Specifies the tags to remove from a trail, event data store, or channel. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the RemoveTags operation returned by the service. * @sample AWSCloudTrailAsyncHandler.RemoveTags * @see AWS API * Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* 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
.
*
* 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
.
*
* 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. *
*
* 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. *
** 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. *
* * @param startLoggingRequest * The request to CloudTrail to start logging Amazon Web Services API calls for an account. * @return A Java Future containing the result of the StartLogging operation returned by the service. * @sample AWSCloudTrailAsync.StartLogging * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param startLoggingRequest * The request to CloudTrail to start logging Amazon Web Services API calls for an account. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartLogging operation returned by the service. * @sample AWSCloudTrailAsyncHandler.StartLogging * @see AWS API * Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* 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
.
*
* 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
.
*
* Stops a specified import. *
* * @param stopImportRequest * @return A Java Future containing the result of the StopImport operation returned by the service. * @sample AWSCloudTrailAsync.StopImport * @see AWS API * Documentation */ java.util.concurrent.Future* Stops a specified import. *
* * @param stopImportRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopImport operation returned by the service. * @sample AWSCloudTrailAsyncHandler.StopImport * @see AWS API * Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Updates a channel specified by a required channel ARN or UUID. *
* * @param updateChannelRequest * @return A Java Future containing the result of the UpdateChannel operation returned by the service. * @sample AWSCloudTrailAsync.UpdateChannel * @see AWS API * Documentation */ java.util.concurrent.Future* Updates a channel specified by a required channel ARN or UUID. *
* * @param updateChannelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateChannel operation returned by the service. * @sample AWSCloudTrailAsyncHandler.UpdateChannel * @see AWS API * Documentation */ java.util.concurrent.Future
* Updates an event data store. The required EventDataStore
value is an ARN or the ID portion of the
* ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws
* an error. RetentionPeriod
is in days, and valid values are integers between 90 and 2557. By default,
* TerminationProtection
is enabled.
*
* For event data stores for CloudTrail events, AdvancedEventSelectors
includes or excludes management
* and data events in your event data store. For more information about AdvancedEventSelectors
, see
* AdvancedEventSelectors.
*
* For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
* AdvancedEventSelectors
includes events of that type in your event data store.
*
* Updates an event data store. The required EventDataStore
value is an ARN or the ID portion of the
* ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws
* an error. RetentionPeriod
is in days, and valid values are integers between 90 and 2557. By default,
* TerminationProtection
is enabled.
*
* For event data stores for CloudTrail events, AdvancedEventSelectors
includes or excludes management
* and data events in your event data store. For more information about AdvancedEventSelectors
, see
* AdvancedEventSelectors.
*
* For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
* AdvancedEventSelectors
includes events of that type in your event data store.
*
* 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.
*
* 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.
*