AbstractAWSCloudTrail (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudtrail.AbstractAWSCloudTrail

All Implemented Interfaces:

AWSCloudTrail

Direct Known Subclasses:

AbstractAWSCloudTrailAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSCloudTrail
extends Object
implements AWSCloudTrail
```
Abstract implementation of AWSCloudTrail. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.cloudtrail.AWSCloudTrail
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddTagsResult`	`addTags(AddTagsRequest request)` Adds one or more tags to a trail, event data store, or channel, up to a limit of 50.
`CancelQueryResult`	`cancelQuery(CancelQueryRequest request)` Cancels a query if the query is not in a terminated state, such as `CANCELLED`, `FAILED`, `TIMED_OUT`, or `FINISHED`.
`CreateChannelResult`	`createChannel(CreateChannelRequest request)` Creates a channel for CloudTrail to ingest events from a partner or external source.
`CreateEventDataStoreResult`	`createEventDataStore(CreateEventDataStoreRequest request)` Creates a new event data store.
`CreateTrailResult`	`createTrail(CreateTrailRequest request)` Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
`DeleteChannelResult`	`deleteChannel(DeleteChannelRequest request)` Deletes a channel.
`DeleteEventDataStoreResult`	`deleteEventDataStore(DeleteEventDataStoreRequest request)` Disables the event data store specified by `EventDataStore`, which accepts an event data store ARN.
`DeleteResourcePolicyResult`	`deleteResourcePolicy(DeleteResourcePolicyRequest request)` Deletes the resource-based policy attached to the CloudTrail channel.
`DeleteTrailResult`	`deleteTrail(DeleteTrailRequest request)` Deletes a trail.
`DeregisterOrganizationDelegatedAdminResult`	`deregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest request)` Removes CloudTrail delegated administrator permissions from a member account in an organization.
`DescribeQueryResult`	`describeQuery(DescribeQueryRequest request)` Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status.
`DescribeTrailsResult`	`describeTrails()` Simplified method form for invoking the DescribeTrails operation.
`DescribeTrailsResult`	`describeTrails(DescribeTrailsRequest request)` Retrieves settings for one or more trails associated with the current Region for your account.
`DisableFederationResult`	`disableFederation(DisableFederationRequest request)` Disables Lake query federation on the specified event data store.
`EnableFederationResult`	`enableFederation(EnableFederationRequest request)` Enables Lake query federation on the specified event data store.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetChannelResult`	`getChannel(GetChannelRequest request)` Returns information about a specific channel.
`GetEventDataStoreResult`	`getEventDataStore(GetEventDataStoreRequest request)` Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
`GetEventSelectorsResult`	`getEventSelectors(GetEventSelectorsRequest request)` Describes the settings for the event selectors that you configured for your trail.
`GetImportResult`	`getImport(GetImportRequest request)` Returns information about a specific import.
`GetInsightSelectorsResult`	`getInsightSelectors(GetInsightSelectorsRequest request)` Describes the settings for the Insights event selectors that you configured for your trail or event data store.
`GetQueryResultsResult`	`getQueryResults(GetQueryResultsRequest request)` Gets event data results of a query.
`GetResourcePolicyResult`	`getResourcePolicy(GetResourcePolicyRequest request)` Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
`GetTrailResult`	`getTrail(GetTrailRequest request)` Returns settings information for a specified trail.
`GetTrailStatusResult`	`getTrailStatus(GetTrailStatusRequest request)` Returns a JSON-formatted list of information about the specified trail.
`ListChannelsResult`	`listChannels(ListChannelsRequest request)` Lists the channels in the current account, and their source names.
`ListEventDataStoresResult`	`listEventDataStores(ListEventDataStoresRequest request)` Returns information about all event data stores in the account, in the current Region.
`ListImportFailuresResult`	`listImportFailures(ListImportFailuresRequest request)` Returns a list of failures for the specified import.
`ListImportsResult`	`listImports(ListImportsRequest request)` Returns information on all imports, or a select set of imports by `ImportStatus` or `Destination`.
`ListInsightsMetricDataResult`	`listInsightsMetricData(ListInsightsMetricDataRequest request)` Returns Insights metrics data for trails that have enabled Insights.
`ListPublicKeysResult`	`listPublicKeys()` Simplified method form for invoking the ListPublicKeys operation.
`ListPublicKeysResult`	`listPublicKeys(ListPublicKeysRequest request)` Returns all public keys whose private keys were used to sign the digest files within the specified time range.
`ListQueriesResult`	`listQueries(ListQueriesRequest request)` Returns a list of queries and query statuses for the past seven days.
`ListTagsResult`	`listTags(ListTagsRequest request)` Lists the tags for the specified trails, event data stores, or channels in the current Region.
`ListTrailsResult`	`listTrails(ListTrailsRequest request)` Lists trails that are in the current account.
`LookupEventsResult`	`lookupEvents()` Simplified method form for invoking the LookupEvents operation.
`LookupEventsResult`	`lookupEvents(LookupEventsRequest request)` Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
`PutEventSelectorsResult`	`putEventSelectors(PutEventSelectorsRequest request)` Configures an event selector or advanced event selectors for your trail.
`PutInsightSelectorsResult`	`putInsightSelectors(PutInsightSelectorsRequest request)` Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail or event data store.
`PutResourcePolicyResult`	`putResourcePolicy(PutResourcePolicyRequest request)` 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.
`RegisterOrganizationDelegatedAdminResult`	`registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest request)` Registers an organization’s member account as the CloudTrail delegated administrator.
`RemoveTagsResult`	`removeTags(RemoveTagsRequest request)` Removes the specified tags from a trail, event data store, or channel.
`RestoreEventDataStoreResult`	`restoreEventDataStore(RestoreEventDataStoreRequest request)` Restores a deleted event data store specified by `EventDataStore`, which accepts an event data store ARN.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("cloudtrail.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSCloudTrail.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartEventDataStoreIngestionResult`	`startEventDataStoreIngestion(StartEventDataStoreIngestionRequest request)` Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN.
`StartImportResult`	`startImport(StartImportRequest request)` Starts an import of logged trail events from a source S3 bucket to a destination event data store.
`StartLoggingResult`	`startLogging(StartLoggingRequest request)` Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
`StartQueryResult`	`startQuery(StartQueryRequest request)` Starts a CloudTrail Lake query.
`StopEventDataStoreIngestionResult`	`stopEventDataStoreIngestion(StopEventDataStoreIngestionRequest request)` Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN.
`StopImportResult`	`stopImport(StopImportRequest request)` Stops a specified import.
`StopLoggingResult`	`stopLogging(StopLoggingRequest request)` Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
`UpdateChannelResult`	`updateChannel(UpdateChannelRequest request)` Updates a channel specified by a required channel ARN or UUID.
`UpdateEventDataStoreResult`	`updateEventDataStore(UpdateEventDataStoreRequest request)` Updates an event data store.
`UpdateTrailResult`	`updateTrail(UpdateTrailRequest request)` Updates trail settings that control what events you are logging, and how to handle log files.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSCloudTrail
    
    Overrides the default endpoint for this client ("cloudtrail.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "cloudtrail.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "cloudtrail.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AWSCloudTrail
    
    Parameters:
    
    endpoint - The endpoint (ex: "cloudtrail.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "cloudtrail.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSCloudTrail
    
    An alternative to AWSCloudTrail.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AWSCloudTrail
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addTags
```
public AddTagsResult addTags(AddTagsRequest request)
```
    Description copied from interface: 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).
    
    Specified by:
    
    addTags in interface AWSCloudTrail
    
    Parameters:
    
    request - Specifies the tags to add to a trail, event data store, or channel.
    
    Returns:
    
    Result of the AddTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelQuery
```
public CancelQueryResult cancelQuery(CancelQueryRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    cancelQuery in interface AWSCloudTrail
    
    Returns:
    
    Result of the CancelQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createChannel
```
public CreateChannelResult createChannel(CreateChannelRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    createChannel in interface AWSCloudTrail
    
    Returns:
    
    Result of the CreateChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createEventDataStore
```
public CreateEventDataStoreResult createEventDataStore(CreateEventDataStoreRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Creates a new event data store.
    
    Specified by:
    
    createEventDataStore in interface AWSCloudTrail
    
    Returns:
    
    Result of the CreateEventDataStore operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTrail
```
public CreateTrailResult createTrail(CreateTrailRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
    
    Specified by:
    
    createTrail in interface AWSCloudTrail
    
    Parameters:
    
    request - Specifies the settings for each trail.
    
    Returns:
    
    Result of the CreateTrail operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteChannel
```
public DeleteChannelResult deleteChannel(DeleteChannelRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Deletes a channel.
    
    Specified by:
    
    deleteChannel in interface AWSCloudTrail
    
    Returns:
    
    Result of the DeleteChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteEventDataStore
```
public DeleteEventDataStoreResult deleteEventDataStore(DeleteEventDataStoreRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    deleteEventDataStore in interface AWSCloudTrail
    
    Returns:
    
    Result of the DeleteEventDataStore operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteResourcePolicy
```
public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Deletes the resource-based policy attached to the CloudTrail channel.
    
    Specified by:
    
    deleteResourcePolicy in interface AWSCloudTrail
    
    Returns:
    
    Result of the DeleteResourcePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTrail
```
public DeleteTrailResult deleteTrail(DeleteTrailRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    deleteTrail in interface AWSCloudTrail
    
    Parameters:
    
    request - The request that specifies the name of a trail to delete.
    
    Returns:
    
    Result of the DeleteTrail operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deregisterOrganizationDelegatedAdmin
```
public DeregisterOrganizationDelegatedAdminResult deregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Removes CloudTrail delegated administrator permissions from a member account in an organization.
    
    Specified by:
    
    deregisterOrganizationDelegatedAdmin in interface AWSCloudTrail
    
    Parameters:
    
    request - Removes CloudTrail delegated administrator permissions from a specified member account in an organization that is currently designated as a delegated administrator.
    
    Returns:
    
    Result of the DeregisterOrganizationDelegatedAdmin operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeQuery
```
public DescribeQueryResult describeQuery(DescribeQueryRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    describeQuery in interface AWSCloudTrail
    
    Returns:
    
    Result of the DescribeQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTrails
```
public DescribeTrailsResult describeTrails(DescribeTrailsRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Retrieves settings for one or more trails associated with the current Region for your account.
    
    Specified by:
    
    describeTrails in interface AWSCloudTrail
    
    Parameters:
    
    request - Returns information about the trail.
    
    Returns:
    
    Result of the DescribeTrails operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTrails
```
public DescribeTrailsResult describeTrails()
```
    Description copied from interface: AWSCloudTrail
    
    Simplified method form for invoking the DescribeTrails operation.
    
    Specified by:
    
    describeTrails in interface AWSCloudTrail
    
    See Also:
    
    AWSCloudTrail.describeTrails(DescribeTrailsRequest)
  - disableFederation
```
public DisableFederationResult disableFederation(DisableFederationRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    disableFederation in interface AWSCloudTrail
    
    Returns:
    
    Result of the DisableFederation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - enableFederation
```
public EnableFederationResult enableFederation(EnableFederationRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    enableFederation in interface AWSCloudTrail
    
    Returns:
    
    Result of the EnableFederation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getChannel
```
public GetChannelResult getChannel(GetChannelRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Returns information about a specific channel.
    
    Specified by:
    
    getChannel in interface AWSCloudTrail
    
    Returns:
    
    Result of the GetChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getEventDataStore
```
public GetEventDataStoreResult getEventDataStore(GetEventDataStoreRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
    
    Specified by:
    
    getEventDataStore in interface AWSCloudTrail
    
    Returns:
    
    Result of the GetEventDataStore operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getEventSelectors
```
public GetEventSelectorsResult getEventSelectors(GetEventSelectorsRequest request)
```
    Description copied from interface: AWSCloudTrail
    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:
    - Logging management events
    - Logging data events
    Specified by:
    
    getEventSelectors in interface AWSCloudTrail
    
    Returns:
    
    Result of the GetEventSelectors operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getImport
```
public GetImportResult getImport(GetImportRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Returns information about a specific import.
    
    Specified by:
    
    getImport in interface AWSCloudTrail
    
    Returns:
    
    Result of the GetImport operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getInsightSelectors
```
public GetInsightSelectorsResult getInsightSelectors(GetInsightSelectorsRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    getInsightSelectors in interface AWSCloudTrail
    
    Returns:
    
    Result of the GetInsightSelectors operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getQueryResults
```
public GetQueryResultsResult getQueryResults(GetQueryResultsRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation.
    
    Specified by:
    
    getQueryResults in interface AWSCloudTrail
    
    Returns:
    
    Result of the GetQueryResults operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getResourcePolicy
```
public GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
    
    Specified by:
    
    getResourcePolicy in interface AWSCloudTrail
    
    Returns:
    
    Result of the GetResourcePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTrail
```
public GetTrailResult getTrail(GetTrailRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Returns settings information for a specified trail.
    
    Specified by:
    
    getTrail in interface AWSCloudTrail
    
    Returns:
    
    Result of the GetTrail operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTrailStatus
```
public GetTrailStatusResult getTrailStatus(GetTrailStatusRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    getTrailStatus in interface AWSCloudTrail
    
    Parameters:
    
    request - The name of a trail about which you want the current status.
    
    Returns:
    
    Result of the GetTrailStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listChannels
```
public ListChannelsResult listChannels(ListChannelsRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Lists the channels in the current account, and their source names.
    
    Specified by:
    
    listChannels in interface AWSCloudTrail
    
    Returns:
    
    Result of the ListChannels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEventDataStores
```
public ListEventDataStoresResult listEventDataStores(ListEventDataStoresRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Returns information about all event data stores in the account, in the current Region.
    
    Specified by:
    
    listEventDataStores in interface AWSCloudTrail
    
    Returns:
    
    Result of the ListEventDataStores operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listImportFailures
```
public ListImportFailuresResult listImportFailures(ListImportFailuresRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Returns a list of failures for the specified import.
    
    Specified by:
    
    listImportFailures in interface AWSCloudTrail
    
    Returns:
    
    Result of the ListImportFailures operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listImports
```
public ListImportsResult listImports(ListImportsRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Returns information on all imports, or a select set of imports by ImportStatus or Destination.
    
    Specified by:
    
    listImports in interface AWSCloudTrail
    
    Returns:
    
    Result of the ListImports operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listInsightsMetricData
```
public ListInsightsMetricDataResult listInsightsMetricData(ListInsightsMetricDataRequest request)
```
    Description copied from interface: AWSCloudTrail
    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.
    Specified by:
    
    listInsightsMetricData in interface AWSCloudTrail
    
    Returns:
    
    Result of the ListInsightsMetricData operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPublicKeys
```
public ListPublicKeysResult listPublicKeys(ListPublicKeysRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    listPublicKeys in interface AWSCloudTrail
    
    Parameters:
    
    request - Requests the public keys for a specified time range.
    
    Returns:
    
    Result of the ListPublicKeys operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPublicKeys
```
public ListPublicKeysResult listPublicKeys()
```
    Description copied from interface: AWSCloudTrail
    
    Simplified method form for invoking the ListPublicKeys operation.
    
    Specified by:
    
    listPublicKeys in interface AWSCloudTrail
    
    See Also:
    
    AWSCloudTrail.listPublicKeys(ListPublicKeysRequest)
  - listQueries
```
public ListQueriesResult listQueries(ListQueriesRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    listQueries in interface AWSCloudTrail
    
    Returns:
    
    Result of the ListQueries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTags
```
public ListTagsResult listTags(ListTagsRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Lists the tags for the specified trails, event data stores, or channels in the current Region.
    
    Specified by:
    
    listTags in interface AWSCloudTrail
    
    Parameters:
    
    request - Specifies a list of tags to return.
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTrails
```
public ListTrailsResult listTrails(ListTrailsRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Lists trails that are in the current account.
    
    Specified by:
    
    listTrails in interface AWSCloudTrail
    
    Returns:
    
    Result of the ListTrails operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - lookupEvents
```
public LookupEventsResult lookupEvents(LookupEventsRequest request)
```
    Description copied from interface: AWSCloudTrail
    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.
    Specified by:
    
    lookupEvents in interface AWSCloudTrail
    
    Parameters:
    
    request - Contains a request for LookupEvents.
    
    Returns:
    
    Result of the LookupEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - lookupEvents
```
public LookupEventsResult lookupEvents()
```
    Description copied from interface: AWSCloudTrail
    
    Simplified method form for invoking the LookupEvents operation.
    
    Specified by:
    
    lookupEvents in interface AWSCloudTrail
    
    See Also:
    
    AWSCloudTrail.lookupEvents(LookupEventsRequest)
  - putEventSelectors
```
public PutEventSelectorsResult putEventSelectors(PutEventSelectorsRequest request)
```
    Description copied from interface: AWSCloudTrail
    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 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.
    Specified by:
    
    putEventSelectors in interface AWSCloudTrail
    
    Returns:
    
    Result of the PutEventSelectors operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putInsightSelectors
```
public PutInsightSelectorsResult putInsightSelectors(PutInsightSelectorsRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    putInsightSelectors in interface AWSCloudTrail
    
    Returns:
    
    Result of the PutInsightSelectors operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putResourcePolicy
```
public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    putResourcePolicy in interface AWSCloudTrail
    
    Returns:
    
    Result of the PutResourcePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - registerOrganizationDelegatedAdmin
```
public RegisterOrganizationDelegatedAdminResult registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Registers an organization’s member account as the CloudTrail delegated administrator.
    
    Specified by:
    
    registerOrganizationDelegatedAdmin in interface AWSCloudTrail
    
    Parameters:
    
    request - Specifies an organization member account ID as a CloudTrail delegated administrator.
    
    Returns:
    
    Result of the RegisterOrganizationDelegatedAdmin operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeTags
```
public RemoveTagsResult removeTags(RemoveTagsRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Removes the specified tags from a trail, event data store, or channel.
    
    Specified by:
    
    removeTags in interface AWSCloudTrail
    
    Parameters:
    
    request - Specifies the tags to remove from a trail, event data store, or channel.
    
    Returns:
    
    Result of the RemoveTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - restoreEventDataStore
```
public RestoreEventDataStoreResult restoreEventDataStore(RestoreEventDataStoreRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    restoreEventDataStore in interface AWSCloudTrail
    
    Returns:
    
    Result of the RestoreEventDataStore operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startEventDataStoreIngestion
```
public StartEventDataStoreIngestionResult startEventDataStoreIngestion(StartEventDataStoreIngestionRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    startEventDataStoreIngestion in interface AWSCloudTrail
    
    Returns:
    
    Result of the StartEventDataStoreIngestion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startImport
```
public StartImportResult startImport(StartImportRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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 for copying trail events in the CloudTrail User Guide.
    
    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.
    
    Specified by:
    
    startImport in interface AWSCloudTrail
    
    Returns:
    
    Result of the StartImport operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startLogging
```
public StartLoggingResult startLogging(StartLoggingRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    startLogging in interface AWSCloudTrail
    
    Parameters:
    
    request - The request to CloudTrail to start logging Amazon Web Services API calls for an account.
    
    Returns:
    
    Result of the StartLogging operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startQuery
```
public StartQueryResult startQuery(StartQueryRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    startQuery in interface AWSCloudTrail
    
    Returns:
    
    Result of the StartQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopEventDataStoreIngestion
```
public StopEventDataStoreIngestionResult stopEventDataStoreIngestion(StopEventDataStoreIngestionRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    stopEventDataStoreIngestion in interface AWSCloudTrail
    
    Returns:
    
    Result of the StopEventDataStoreIngestion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopImport
```
public StopImportResult stopImport(StopImportRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Stops a specified import.
    
    Specified by:
    
    stopImport in interface AWSCloudTrail
    
    Returns:
    
    Result of the StopImport operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopLogging
```
public StopLoggingResult stopLogging(StopLoggingRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    stopLogging in interface AWSCloudTrail
    
    Parameters:
    
    request - Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.
    
    Returns:
    
    Result of the StopLogging operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateChannel
```
public UpdateChannelResult updateChannel(UpdateChannelRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Updates a channel specified by a required channel ARN or UUID.
    
    Specified by:
    
    updateChannel in interface AWSCloudTrail
    
    Returns:
    
    Result of the UpdateChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateEventDataStore
```
public UpdateEventDataStoreResult updateEventDataStore(UpdateEventDataStoreRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    updateEventDataStore in interface AWSCloudTrail
    
    Returns:
    
    Result of the UpdateEventDataStore operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTrail
```
public UpdateTrailResult updateTrail(UpdateTrailRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    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.
    
    Specified by:
    
    updateTrail in interface AWSCloudTrail
    
    Parameters:
    
    request - Specifies settings to update for the trail.
    
    Returns:
    
    Result of the UpdateTrail operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSCloudTrail
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSCloudTrail
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSCloudTrail
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSCloudTrail
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.779

Class AbstractAWSCloudTrail

Field Summary

Fields inherited from interface com.amazonaws.services.cloudtrail.AWSCloudTrail

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

addTags

cancelQuery

createChannel

createEventDataStore

createTrail

deleteChannel

deleteEventDataStore

deleteResourcePolicy

deleteTrail

deregisterOrganizationDelegatedAdmin

describeQuery

describeTrails

describeTrails

disableFederation

enableFederation

getChannel

getEventDataStore

getEventSelectors

getImport

getInsightSelectors

getQueryResults

getResourcePolicy

getTrail

getTrailStatus

listChannels

listEventDataStores

listImportFailures

listImports

listInsightsMetricData

listPublicKeys

listPublicKeys

listQueries

listTags

listTrails

lookupEvents

lookupEvents

putEventSelectors

putInsightSelectors

putResourcePolicy

registerOrganizationDelegatedAdmin

removeTags

restoreEventDataStore

startEventDataStoreIngestion

startImport

startLogging

startQuery

stopEventDataStoreIngestion

stopImport

stopLogging

updateChannel

updateEventDataStore

updateTrail

shutdown

getCachedResponseMetadata