Interface CloudTrailClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface CloudTrailClient
extends AwsClient

Service client for accessing CloudTrail. This can be created using the static builder() method. CloudTrail

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.

As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.

See the CloudTrail User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AddTagsResponse	addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)	Adds one or more tags to a trail, event data store, or channel, up to a limit of 50.
default AddTagsResponse	addTags(AddTagsRequest addTagsRequest)	Adds one or more tags to a trail, event data store, or channel, up to a limit of 50.
static CloudTrailClientBuilder	builder()	Create a builder that can be used to configure and create a CloudTrailClient.
default CancelQueryResponse	cancelQuery(Consumer<CancelQueryRequest.Builder> cancelQueryRequest)	Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED.
default CancelQueryResponse	cancelQuery(CancelQueryRequest cancelQueryRequest)	Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED.
static CloudTrailClient	create()	Create a CloudTrailClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateChannelResponse	createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)	Creates a channel for CloudTrail to ingest events from a partner or external source.
default CreateChannelResponse	createChannel(CreateChannelRequest createChannelRequest)	Creates a channel for CloudTrail to ingest events from a partner or external source.
default CreateEventDataStoreResponse	createEventDataStore(Consumer<CreateEventDataStoreRequest.Builder> createEventDataStoreRequest)	Creates a new event data store.
default CreateEventDataStoreResponse	createEventDataStore(CreateEventDataStoreRequest createEventDataStoreRequest)	Creates a new event data store.
default CreateTrailResponse	createTrail(Consumer<CreateTrailRequest.Builder> createTrailRequest)	Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
default CreateTrailResponse	createTrail(CreateTrailRequest createTrailRequest)	Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
default DeleteChannelResponse	deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)	Deletes a channel.
default DeleteChannelResponse	deleteChannel(DeleteChannelRequest deleteChannelRequest)	Deletes a channel.
default DeleteEventDataStoreResponse	deleteEventDataStore(Consumer<DeleteEventDataStoreRequest.Builder> deleteEventDataStoreRequest)	Disables the event data store specified by EventDataStore, which accepts an event data store ARN.
default DeleteEventDataStoreResponse	deleteEventDataStore(DeleteEventDataStoreRequest deleteEventDataStoreRequest)	Disables the event data store specified by EventDataStore, which accepts an event data store ARN.
default DeleteResourcePolicyResponse	deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)	Deletes the resource-based policy attached to the CloudTrail channel.
default DeleteResourcePolicyResponse	deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)	Deletes the resource-based policy attached to the CloudTrail channel.
default DeleteTrailResponse	deleteTrail(Consumer<DeleteTrailRequest.Builder> deleteTrailRequest)	Deletes a trail.
default DeleteTrailResponse	deleteTrail(DeleteTrailRequest deleteTrailRequest)	Deletes a trail.
default DeregisterOrganizationDelegatedAdminResponse	deregisterOrganizationDelegatedAdmin(Consumer<DeregisterOrganizationDelegatedAdminRequest.Builder> deregisterOrganizationDelegatedAdminRequest)	Removes CloudTrail delegated administrator permissions from a member account in an organization.
default DeregisterOrganizationDelegatedAdminResponse	deregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest deregisterOrganizationDelegatedAdminRequest)	Removes CloudTrail delegated administrator permissions from a member account in an organization.
default DescribeQueryResponse	describeQuery(Consumer<DescribeQueryRequest.Builder> describeQueryRequest)	Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status.
default DescribeQueryResponse	describeQuery(DescribeQueryRequest describeQueryRequest)	Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status.
default DescribeTrailsResponse	describeTrails()	Retrieves settings for one or more trails associated with the current Region for your account.
default DescribeTrailsResponse	describeTrails(Consumer<DescribeTrailsRequest.Builder> describeTrailsRequest)	Retrieves settings for one or more trails associated with the current Region for your account.
default DescribeTrailsResponse	describeTrails(DescribeTrailsRequest describeTrailsRequest)	Retrieves settings for one or more trails associated with the current Region for your account.
default DisableFederationResponse	disableFederation(Consumer<DisableFederationRequest.Builder> disableFederationRequest)	Disables Lake query federation on the specified event data store.
default DisableFederationResponse	disableFederation(DisableFederationRequest disableFederationRequest)	Disables Lake query federation on the specified event data store.
default EnableFederationResponse	enableFederation(Consumer<EnableFederationRequest.Builder> enableFederationRequest)	Enables Lake query federation on the specified event data store.
default EnableFederationResponse	enableFederation(EnableFederationRequest enableFederationRequest)	Enables Lake query federation on the specified event data store.
default GetChannelResponse	getChannel(Consumer<GetChannelRequest.Builder> getChannelRequest)	Returns information about a specific channel.
default GetChannelResponse	getChannel(GetChannelRequest getChannelRequest)	Returns information about a specific channel.
default GetEventDataStoreResponse	getEventDataStore(Consumer<GetEventDataStoreRequest.Builder> getEventDataStoreRequest)	Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
default GetEventDataStoreResponse	getEventDataStore(GetEventDataStoreRequest getEventDataStoreRequest)	Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
default GetEventSelectorsResponse	getEventSelectors(Consumer<GetEventSelectorsRequest.Builder> getEventSelectorsRequest)	Describes the settings for the event selectors that you configured for your trail.
default GetEventSelectorsResponse	getEventSelectors(GetEventSelectorsRequest getEventSelectorsRequest)	Describes the settings for the event selectors that you configured for your trail.
default GetImportResponse	getImport(Consumer<GetImportRequest.Builder> getImportRequest)	Returns information about a specific import.
default GetImportResponse	getImport(GetImportRequest getImportRequest)	Returns information about a specific import.
default GetInsightSelectorsResponse	getInsightSelectors(Consumer<GetInsightSelectorsRequest.Builder> getInsightSelectorsRequest)	Describes the settings for the Insights event selectors that you configured for your trail or event data store.
default GetInsightSelectorsResponse	getInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest)	Describes the settings for the Insights event selectors that you configured for your trail or event data store.
default GetQueryResultsResponse	getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)	Gets event data results of a query.
default GetQueryResultsResponse	getQueryResults(GetQueryResultsRequest getQueryResultsRequest)	Gets event data results of a query.
default GetQueryResultsIterable	getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)	This is a variant of getQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest) operation.
default GetQueryResultsIterable	getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest)	This is a variant of getQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest) operation.
default GetResourcePolicyResponse	getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)	Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
default GetResourcePolicyResponse	getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)	Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
default GetTrailResponse	getTrail(Consumer<GetTrailRequest.Builder> getTrailRequest)	Returns settings information for a specified trail.
default GetTrailResponse	getTrail(GetTrailRequest getTrailRequest)	Returns settings information for a specified trail.
default GetTrailStatusResponse	getTrailStatus(Consumer<GetTrailStatusRequest.Builder> getTrailStatusRequest)	Returns a JSON-formatted list of information about the specified trail.
default GetTrailStatusResponse	getTrailStatus(GetTrailStatusRequest getTrailStatusRequest)	Returns a JSON-formatted list of information about the specified trail.
default ListChannelsResponse	listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)	Lists the channels in the current account, and their source names.
default ListChannelsResponse	listChannels(ListChannelsRequest listChannelsRequest)	Lists the channels in the current account, and their source names.
default ListChannelsIterable	listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)	This is a variant of listChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest) operation.
default ListChannelsIterable	listChannelsPaginator(ListChannelsRequest listChannelsRequest)	This is a variant of listChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest) operation.
default ListEventDataStoresResponse	listEventDataStores(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest)	Returns information about all event data stores in the account, in the current Region.
default ListEventDataStoresResponse	listEventDataStores(ListEventDataStoresRequest listEventDataStoresRequest)	Returns information about all event data stores in the account, in the current Region.
default ListEventDataStoresIterable	listEventDataStoresPaginator(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest)	This is a variant of listEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest) operation.
default ListEventDataStoresIterable	listEventDataStoresPaginator(ListEventDataStoresRequest listEventDataStoresRequest)	This is a variant of listEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest) operation.
default ListImportFailuresResponse	listImportFailures(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest)	Returns a list of failures for the specified import.
default ListImportFailuresResponse	listImportFailures(ListImportFailuresRequest listImportFailuresRequest)	Returns a list of failures for the specified import.
default ListImportFailuresIterable	listImportFailuresPaginator(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest)	This is a variant of listImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest) operation.
default ListImportFailuresIterable	listImportFailuresPaginator(ListImportFailuresRequest listImportFailuresRequest)	This is a variant of listImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest) operation.
default ListImportsResponse	listImports(Consumer<ListImportsRequest.Builder> listImportsRequest)	Returns information on all imports, or a select set of imports by ImportStatus or Destination.
default ListImportsResponse	listImports(ListImportsRequest listImportsRequest)	Returns information on all imports, or a select set of imports by ImportStatus or Destination.
default ListImportsIterable	listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest)	This is a variant of listImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest) operation.
default ListImportsIterable	listImportsPaginator(ListImportsRequest listImportsRequest)	This is a variant of listImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest) operation.
default ListInsightsMetricDataResponse	listInsightsMetricData(Consumer<ListInsightsMetricDataRequest.Builder> listInsightsMetricDataRequest)	Returns Insights metrics data for trails that have enabled Insights.
default ListInsightsMetricDataResponse	listInsightsMetricData(ListInsightsMetricDataRequest listInsightsMetricDataRequest)	Returns Insights metrics data for trails that have enabled Insights.
default ListInsightsMetricDataIterable	listInsightsMetricDataPaginator(Consumer<ListInsightsMetricDataRequest.Builder> listInsightsMetricDataRequest)	This is a variant of listInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest) operation.
default ListInsightsMetricDataIterable	listInsightsMetricDataPaginator(ListInsightsMetricDataRequest listInsightsMetricDataRequest)	This is a variant of listInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest) operation.
default ListPublicKeysResponse	listPublicKeys()	Returns all public keys whose private keys were used to sign the digest files within the specified time range.
default ListPublicKeysResponse	listPublicKeys(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest)	Returns all public keys whose private keys were used to sign the digest files within the specified time range.
default ListPublicKeysResponse	listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)	Returns all public keys whose private keys were used to sign the digest files within the specified time range.
default ListPublicKeysIterable	listPublicKeysPaginator()	This is a variant of listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation.
default ListPublicKeysIterable	listPublicKeysPaginator(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest)	This is a variant of listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation.
default ListPublicKeysIterable	listPublicKeysPaginator(ListPublicKeysRequest listPublicKeysRequest)	This is a variant of listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation.
default ListQueriesResponse	listQueries(Consumer<ListQueriesRequest.Builder> listQueriesRequest)	Returns a list of queries and query statuses for the past seven days.
default ListQueriesResponse	listQueries(ListQueriesRequest listQueriesRequest)	Returns a list of queries and query statuses for the past seven days.
default ListQueriesIterable	listQueriesPaginator(Consumer<ListQueriesRequest.Builder> listQueriesRequest)	This is a variant of listQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest) operation.
default ListQueriesIterable	listQueriesPaginator(ListQueriesRequest listQueriesRequest)	This is a variant of listQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest) operation.
default ListTagsResponse	listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)	Lists the tags for the specified trails, event data stores, or channels in the current Region.
default ListTagsResponse	listTags(ListTagsRequest listTagsRequest)	Lists the tags for the specified trails, event data stores, or channels in the current Region.
default ListTagsIterable	listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)	This is a variant of listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest) operation.
default ListTagsIterable	listTagsPaginator(ListTagsRequest listTagsRequest)	This is a variant of listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest) operation.
default ListTrailsResponse	listTrails(Consumer<ListTrailsRequest.Builder> listTrailsRequest)	Lists trails that are in the current account.
default ListTrailsResponse	listTrails(ListTrailsRequest listTrailsRequest)	Lists trails that are in the current account.
default ListTrailsIterable	listTrailsPaginator(Consumer<ListTrailsRequest.Builder> listTrailsRequest)	This is a variant of listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest) operation.
default ListTrailsIterable	listTrailsPaginator(ListTrailsRequest listTrailsRequest)	This is a variant of listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest) operation.
default LookupEventsResponse	lookupEvents()	Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
default LookupEventsResponse	lookupEvents(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)	Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
default LookupEventsResponse	lookupEvents(LookupEventsRequest lookupEventsRequest)	Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
default LookupEventsIterable	lookupEventsPaginator()	This is a variant of lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest) operation.
default LookupEventsIterable	lookupEventsPaginator(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)	This is a variant of lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest) operation.
default LookupEventsIterable	lookupEventsPaginator(LookupEventsRequest lookupEventsRequest)	This is a variant of lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest) operation.
default PutEventSelectorsResponse	putEventSelectors(Consumer<PutEventSelectorsRequest.Builder> putEventSelectorsRequest)	Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail.
default PutEventSelectorsResponse	putEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest)	Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail.
default PutInsightSelectorsResponse	putInsightSelectors(Consumer<PutInsightSelectorsRequest.Builder> putInsightSelectorsRequest)	Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail or event data store.
default PutInsightSelectorsResponse	putInsightSelectors(PutInsightSelectorsRequest putInsightSelectorsRequest)	Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail or event data store.
default PutResourcePolicyResponse	putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)	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.
default PutResourcePolicyResponse	putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)	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.
default RegisterOrganizationDelegatedAdminResponse	registerOrganizationDelegatedAdmin(Consumer<RegisterOrganizationDelegatedAdminRequest.Builder> registerOrganizationDelegatedAdminRequest)	Registers an organization’s member account as the CloudTrail delegated administrator.
default RegisterOrganizationDelegatedAdminResponse	registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest)	Registers an organization’s member account as the CloudTrail delegated administrator.
default RemoveTagsResponse	removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)	Removes the specified tags from a trail, event data store, or channel.
default RemoveTagsResponse	removeTags(RemoveTagsRequest removeTagsRequest)	Removes the specified tags from a trail, event data store, or channel.
default RestoreEventDataStoreResponse	restoreEventDataStore(Consumer<RestoreEventDataStoreRequest.Builder> restoreEventDataStoreRequest)	Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN.
default RestoreEventDataStoreResponse	restoreEventDataStore(RestoreEventDataStoreRequest restoreEventDataStoreRequest)	Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN.
default CloudTrailServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartEventDataStoreIngestionResponse	startEventDataStoreIngestion(Consumer<StartEventDataStoreIngestionRequest.Builder> startEventDataStoreIngestionRequest)	Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN.
default StartEventDataStoreIngestionResponse	startEventDataStoreIngestion(StartEventDataStoreIngestionRequest startEventDataStoreIngestionRequest)	Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN.
default StartImportResponse	startImport(Consumer<StartImportRequest.Builder> startImportRequest)	Starts an import of logged trail events from a source S3 bucket to a destination event data store.
default StartImportResponse	startImport(StartImportRequest startImportRequest)	Starts an import of logged trail events from a source S3 bucket to a destination event data store.
default StartLoggingResponse	startLogging(Consumer<StartLoggingRequest.Builder> startLoggingRequest)	Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
default StartLoggingResponse	startLogging(StartLoggingRequest startLoggingRequest)	Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
default StartQueryResponse	startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest)	Starts a CloudTrail Lake query.
default StartQueryResponse	startQuery(StartQueryRequest startQueryRequest)	Starts a CloudTrail Lake query.
default StopEventDataStoreIngestionResponse	stopEventDataStoreIngestion(Consumer<StopEventDataStoreIngestionRequest.Builder> stopEventDataStoreIngestionRequest)	Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN.
default StopEventDataStoreIngestionResponse	stopEventDataStoreIngestion(StopEventDataStoreIngestionRequest stopEventDataStoreIngestionRequest)	Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN.
default StopImportResponse	stopImport(Consumer<StopImportRequest.Builder> stopImportRequest)	Stops a specified import.
default StopImportResponse	stopImport(StopImportRequest stopImportRequest)	Stops a specified import.
default StopLoggingResponse	stopLogging(Consumer<StopLoggingRequest.Builder> stopLoggingRequest)	Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
default StopLoggingResponse	stopLogging(StopLoggingRequest stopLoggingRequest)	Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
default UpdateChannelResponse	updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)	Updates a channel specified by a required channel ARN or UUID.
default UpdateChannelResponse	updateChannel(UpdateChannelRequest updateChannelRequest)	Updates a channel specified by a required channel ARN or UUID.
default UpdateEventDataStoreResponse	updateEventDataStore(Consumer<UpdateEventDataStoreRequest.Builder> updateEventDataStoreRequest)	Updates an event data store.
default UpdateEventDataStoreResponse	updateEventDataStore(UpdateEventDataStoreRequest updateEventDataStoreRequest)	Updates an event data store.
default UpdateTrailResponse	updateTrail(Consumer<UpdateTrailRequest.Builder> updateTrailRequest)	Updates trail settings that control what events you are logging, and how to handle log files.
default UpdateTrailResponse	updateTrail(UpdateTrailRequest updateTrailRequest)	Updates trail settings that control what events you are logging, and how to handle log files.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

addTags

default AddTagsResponse addTags(AddTagsRequest addTagsRequest)
                         throws ResourceNotFoundException,
CloudTrailArnInvalidException,
EventDataStoreArnInvalidException,
ChannelArnInvalidException,
ResourceTypeNotSupportedException,
TagsLimitExceededException,
InvalidTrailNameException,
InvalidTagParameterException,
InactiveEventDataStoreException,
EventDataStoreNotFoundException,
ChannelNotFoundException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
ConflictException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

addTagsRequest - 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

addTags

default AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
                         throws ResourceNotFoundException,
CloudTrailArnInvalidException,
EventDataStoreArnInvalidException,
ChannelArnInvalidException,
ResourceTypeNotSupportedException,
TagsLimitExceededException,
InvalidTrailNameException,
InvalidTagParameterException,
InactiveEventDataStoreException,
EventDataStoreNotFoundException,
ChannelNotFoundException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
ConflictException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the AddTagsRequest.Builder avoiding the need to create one manually via AddTagsRequest.builder()

Parameters:

addTagsRequest - A Consumer that will call methods on AddTagsRequest.Builder to create a 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

default CancelQueryResponse cancelQuery(CancelQueryRequest cancelQueryRequest)
                                 throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InactiveQueryException,
InvalidParameterException,
QueryIdNotFoundException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
ConflictException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

cancelQueryRequest -

Returns:

Result of the CancelQuery operation returned by the service.

See Also:

• AWS API Documentation

cancelQuery

default CancelQueryResponse cancelQuery(Consumer<CancelQueryRequest.Builder> cancelQueryRequest)
                                 throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InactiveQueryException,
InvalidParameterException,
QueryIdNotFoundException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
ConflictException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the CancelQueryRequest.Builder avoiding the need to create one manually via CancelQueryRequest.builder()

Parameters:

cancelQueryRequest - A Consumer that will call methods on CancelQueryRequest.Builder to create a request.

Returns:

Result of the CancelQuery operation returned by the service.

See Also:

• AWS API Documentation

createChannel

default CreateChannelResponse createChannel(CreateChannelRequest createChannelRequest)
                                     throws ChannelMaxLimitExceededException,
InvalidSourceException,
ChannelAlreadyExistsException,
EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidEventDataStoreCategoryException,
InactiveEventDataStoreException,
InvalidParameterException,
InvalidTagParameterException,
TagsLimitExceededException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

createChannelRequest -

Returns:

Result of the CreateChannel operation returned by the service.

See Also:

• AWS API Documentation

createChannel

default CreateChannelResponse createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)
                                     throws ChannelMaxLimitExceededException,
InvalidSourceException,
ChannelAlreadyExistsException,
EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidEventDataStoreCategoryException,
InactiveEventDataStoreException,
InvalidParameterException,
InvalidTagParameterException,
TagsLimitExceededException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the CreateChannelRequest.Builder avoiding the need to create one manually via CreateChannelRequest.builder()

Parameters:

createChannelRequest - A Consumer that will call methods on CreateChannelRequest.Builder to create a request.

Returns:

Result of the CreateChannel operation returned by the service.

See Also:

• AWS API Documentation

createEventDataStore

default CreateEventDataStoreResponse createEventDataStore(CreateEventDataStoreRequest createEventDataStoreRequest)
                                                   throws EventDataStoreAlreadyExistsException,
EventDataStoreMaxLimitExceededException,
InvalidEventSelectorsException,
InvalidParameterException,
InvalidTagParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
ConflictException,
InsufficientEncryptionPolicyException,
InvalidKmsKeyIdException,
KmsKeyNotFoundException,
KmsException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
NotOrganizationMasterAccountException,
OrganizationsNotInUseException,
OrganizationNotInAllFeaturesModeException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

Creates a new event data store.

Parameters:

createEventDataStoreRequest -

Returns:

Result of the CreateEventDataStore operation returned by the service.

See Also:

• AWS API Documentation

createEventDataStore

default CreateEventDataStoreResponse createEventDataStore(Consumer<CreateEventDataStoreRequest.Builder> createEventDataStoreRequest)
                                                   throws EventDataStoreAlreadyExistsException,
EventDataStoreMaxLimitExceededException,
InvalidEventSelectorsException,
InvalidParameterException,
InvalidTagParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
ConflictException,
InsufficientEncryptionPolicyException,
InvalidKmsKeyIdException,
KmsKeyNotFoundException,
KmsException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
NotOrganizationMasterAccountException,
OrganizationsNotInUseException,
OrganizationNotInAllFeaturesModeException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

Creates a new event data store.

This is a convenience which creates an instance of the CreateEventDataStoreRequest.Builder avoiding the need to create one manually via CreateEventDataStoreRequest.builder()

Parameters:

createEventDataStoreRequest - A Consumer that will call methods on CreateEventDataStoreRequest.Builder to create a request.

Returns:

Result of the CreateEventDataStore operation returned by the service.

See Also:

• AWS API Documentation

createTrail

default CreateTrailResponse createTrail(CreateTrailRequest createTrailRequest)
                                 throws MaximumNumberOfTrailsExceededException,
TrailAlreadyExistsException,
S3BucketDoesNotExistException,
InsufficientS3BucketPolicyException,
InsufficientSnsTopicPolicyException,
InsufficientEncryptionPolicyException,
InvalidS3BucketNameException,
InvalidS3PrefixException,
InvalidSnsTopicNameException,
InvalidKmsKeyIdException,
InvalidTrailNameException,
TrailNotProvidedException,
TagsLimitExceededException,
InvalidParameterCombinationException,
InvalidParameterException,
KmsKeyNotFoundException,
KmsException,
InvalidCloudWatchLogsLogGroupArnException,
InvalidCloudWatchLogsRoleArnException,
CloudWatchLogsDeliveryUnavailableException,
InvalidTagParameterException,
UnsupportedOperationException,
OperationNotPermittedException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
NotOrganizationMasterAccountException,
OrganizationsNotInUseException,
OrganizationNotInAllFeaturesModeException,
NoManagementAccountSlrExistsException,
CloudTrailInvalidClientTokenIdException,
ConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

createTrailRequest - Specifies the settings for each trail.

Returns:

Result of the CreateTrail operation returned by the service.

See Also:

• AWS API Documentation

createTrail

default CreateTrailResponse createTrail(Consumer<CreateTrailRequest.Builder> createTrailRequest)
                                 throws MaximumNumberOfTrailsExceededException,
TrailAlreadyExistsException,
S3BucketDoesNotExistException,
InsufficientS3BucketPolicyException,
InsufficientSnsTopicPolicyException,
InsufficientEncryptionPolicyException,
InvalidS3BucketNameException,
InvalidS3PrefixException,
InvalidSnsTopicNameException,
InvalidKmsKeyIdException,
InvalidTrailNameException,
TrailNotProvidedException,
TagsLimitExceededException,
InvalidParameterCombinationException,
InvalidParameterException,
KmsKeyNotFoundException,
KmsException,
InvalidCloudWatchLogsLogGroupArnException,
InvalidCloudWatchLogsRoleArnException,
CloudWatchLogsDeliveryUnavailableException,
InvalidTagParameterException,
UnsupportedOperationException,
OperationNotPermittedException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
NotOrganizationMasterAccountException,
OrganizationsNotInUseException,
OrganizationNotInAllFeaturesModeException,
NoManagementAccountSlrExistsException,
CloudTrailInvalidClientTokenIdException,
ConflictException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the CreateTrailRequest.Builder avoiding the need to create one manually via CreateTrailRequest.builder()

Parameters:

createTrailRequest - A Consumer that will call methods on CreateTrailRequest.Builder to create a request. Specifies the settings for each trail.

Returns:

Result of the CreateTrail operation returned by the service.

See Also:

• AWS API Documentation

deleteChannel

default DeleteChannelResponse deleteChannel(DeleteChannelRequest deleteChannelRequest)
                                     throws ChannelArnInvalidException,
ChannelNotFoundException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

Deletes a channel.

Parameters:

deleteChannelRequest -

Returns:

Result of the DeleteChannel operation returned by the service.

See Also:

• AWS API Documentation

deleteChannel

default DeleteChannelResponse deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)
                                     throws ChannelArnInvalidException,
ChannelNotFoundException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

Deletes a channel.

This is a convenience which creates an instance of the DeleteChannelRequest.Builder avoiding the need to create one manually via DeleteChannelRequest.builder()

Parameters:

deleteChannelRequest - A Consumer that will call methods on DeleteChannelRequest.Builder to create a request.

Returns:

Result of the DeleteChannel operation returned by the service.

See Also:

• AWS API Documentation

deleteEventDataStore

default DeleteEventDataStoreResponse deleteEventDataStore(DeleteEventDataStoreRequest deleteEventDataStoreRequest)
                                                   throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
EventDataStoreTerminationProtectedException,
EventDataStoreHasOngoingImportException,
InactiveEventDataStoreException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
ChannelExistsForEdsException,
InsufficientDependencyServiceAccessPermissionException,
ConflictException,
EventDataStoreFederationEnabledException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

deleteEventDataStoreRequest -

Returns:

Result of the DeleteEventDataStore operation returned by the service.

See Also:

• AWS API Documentation

deleteEventDataStore

default DeleteEventDataStoreResponse deleteEventDataStore(Consumer<DeleteEventDataStoreRequest.Builder> deleteEventDataStoreRequest)
                                                   throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
EventDataStoreTerminationProtectedException,
EventDataStoreHasOngoingImportException,
InactiveEventDataStoreException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
ChannelExistsForEdsException,
InsufficientDependencyServiceAccessPermissionException,
ConflictException,
EventDataStoreFederationEnabledException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the DeleteEventDataStoreRequest.Builder avoiding the need to create one manually via DeleteEventDataStoreRequest.builder()

Parameters:

deleteEventDataStoreRequest - A Consumer that will call methods on DeleteEventDataStoreRequest.Builder to create a request.

Returns:

Result of the DeleteEventDataStore operation returned by the service.

See Also:

• AWS API Documentation

deleteResourcePolicy

default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
                                                   throws ResourceArnNotValidException,
ResourceNotFoundException,
ResourcePolicyNotFoundException,
ResourceTypeNotSupportedException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

deleteResourcePolicyRequest -

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteResourcePolicy

default DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
                                                   throws ResourceArnNotValidException,
ResourceNotFoundException,
ResourcePolicyNotFoundException,
ResourceTypeNotSupportedException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the need to create one manually via DeleteResourcePolicyRequest.builder()

Parameters:

deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a request.

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteTrail

default DeleteTrailResponse deleteTrail(DeleteTrailRequest deleteTrailRequest)
                                 throws TrailNotFoundException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
ConflictException,
ThrottlingException,
InvalidHomeRegionException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
InsufficientDependencyServiceAccessPermissionException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

deleteTrailRequest - 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

deleteTrail

default DeleteTrailResponse deleteTrail(Consumer<DeleteTrailRequest.Builder> deleteTrailRequest)
                                 throws TrailNotFoundException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
ConflictException,
ThrottlingException,
InvalidHomeRegionException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
InsufficientDependencyServiceAccessPermissionException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the DeleteTrailRequest.Builder avoiding the need to create one manually via DeleteTrailRequest.builder()

Parameters:

deleteTrailRequest - A Consumer that will call methods on DeleteTrailRequest.Builder to create a 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

default DeregisterOrganizationDelegatedAdminResponse deregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest deregisterOrganizationDelegatedAdminRequest)
                                                                                   throws AccountNotFoundException,
AccountNotRegisteredException,
CloudTrailAccessNotEnabledException,
ConflictException,
InsufficientDependencyServiceAccessPermissionException,
InvalidParameterException,
NotOrganizationManagementAccountException,
OrganizationNotInAllFeaturesModeException,
OrganizationsNotInUseException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

deregisterOrganizationDelegatedAdminRequest - 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

deregisterOrganizationDelegatedAdmin

default DeregisterOrganizationDelegatedAdminResponse deregisterOrganizationDelegatedAdmin(Consumer<DeregisterOrganizationDelegatedAdminRequest.Builder> deregisterOrganizationDelegatedAdminRequest)
                                                                                   throws AccountNotFoundException,
AccountNotRegisteredException,
CloudTrailAccessNotEnabledException,
ConflictException,
InsufficientDependencyServiceAccessPermissionException,
InvalidParameterException,
NotOrganizationManagementAccountException,
OrganizationNotInAllFeaturesModeException,
OrganizationsNotInUseException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the DeregisterOrganizationDelegatedAdminRequest.Builder avoiding the need to create one manually via DeregisterOrganizationDelegatedAdminRequest.builder()

Parameters:

deregisterOrganizationDelegatedAdminRequest - A Consumer that will call methods on DeregisterOrganizationDelegatedAdminRequest.Builder to create a 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

default DescribeQueryResponse describeQuery(DescribeQueryRequest describeQueryRequest)
                                     throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InvalidParameterException,
QueryIdNotFoundException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

describeQueryRequest -

Returns:

Result of the DescribeQuery operation returned by the service.

See Also:

• AWS API Documentation

describeQuery

default DescribeQueryResponse describeQuery(Consumer<DescribeQueryRequest.Builder> describeQueryRequest)
                                     throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InvalidParameterException,
QueryIdNotFoundException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the DescribeQueryRequest.Builder avoiding the need to create one manually via DescribeQueryRequest.builder()

Parameters:

describeQueryRequest - A Consumer that will call methods on DescribeQueryRequest.Builder to create a request.

Returns:

Result of the DescribeQuery operation returned by the service.

See Also:

• AWS API Documentation

describeTrails

default DescribeTrailsResponse describeTrails(DescribeTrailsRequest describeTrailsRequest)
                                       throws UnsupportedOperationException,
OperationNotPermittedException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

describeTrailsRequest - Returns information about the trail.

Returns:

Result of the DescribeTrails operation returned by the service.

See Also:

• AWS API Documentation

describeTrails

default DescribeTrailsResponse describeTrails(Consumer<DescribeTrailsRequest.Builder> describeTrailsRequest)
                                       throws UnsupportedOperationException,
OperationNotPermittedException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the DescribeTrailsRequest.Builder avoiding the need to create one manually via DescribeTrailsRequest.builder()

Parameters:

describeTrailsRequest - A Consumer that will call methods on DescribeTrailsRequest.Builder to create a request. Returns information about the trail.

Returns:

Result of the DescribeTrails operation returned by the service.

See Also:

• AWS API Documentation

describeTrails

default DescribeTrailsResponse describeTrails()
                                       throws UnsupportedOperationException,
OperationNotPermittedException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Returns:

Result of the DescribeTrails operation returned by the service.

See Also:

• describeTrails(DescribeTrailsRequest)
• AWS API Documentation

disableFederation

default DisableFederationResponse disableFederation(DisableFederationRequest disableFederationRequest)
                                             throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidParameterException,
InactiveEventDataStoreException,
OperationNotPermittedException,
UnsupportedOperationException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
OrganizationsNotInUseException,
OrganizationNotInAllFeaturesModeException,
ConcurrentModificationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

disableFederationRequest -

Returns:

Result of the DisableFederation operation returned by the service.

See Also:

• AWS API Documentation

disableFederation

default DisableFederationResponse disableFederation(Consumer<DisableFederationRequest.Builder> disableFederationRequest)
                                             throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidParameterException,
InactiveEventDataStoreException,
OperationNotPermittedException,
UnsupportedOperationException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
OrganizationsNotInUseException,
OrganizationNotInAllFeaturesModeException,
ConcurrentModificationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the DisableFederationRequest.Builder avoiding the need to create one manually via DisableFederationRequest.builder()

Parameters:

disableFederationRequest - A Consumer that will call methods on DisableFederationRequest.Builder to create a request.

Returns:

Result of the DisableFederation operation returned by the service.

See Also:

• AWS API Documentation

enableFederation

default EnableFederationResponse enableFederation(EnableFederationRequest enableFederationRequest)
                                           throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidParameterException,
InactiveEventDataStoreException,
OperationNotPermittedException,
UnsupportedOperationException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
OrganizationsNotInUseException,
OrganizationNotInAllFeaturesModeException,
ConcurrentModificationException,
AccessDeniedException,
EventDataStoreFederationEnabledException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

enableFederationRequest -

Returns:

Result of the EnableFederation operation returned by the service.

See Also:

• AWS API Documentation

enableFederation

default EnableFederationResponse enableFederation(Consumer<EnableFederationRequest.Builder> enableFederationRequest)
                                           throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidParameterException,
InactiveEventDataStoreException,
OperationNotPermittedException,
UnsupportedOperationException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
OrganizationsNotInUseException,
OrganizationNotInAllFeaturesModeException,
ConcurrentModificationException,
AccessDeniedException,
EventDataStoreFederationEnabledException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the EnableFederationRequest.Builder avoiding the need to create one manually via EnableFederationRequest.builder()

Parameters:

enableFederationRequest - A Consumer that will call methods on EnableFederationRequest.Builder to create a request.

Returns:

Result of the EnableFederation operation returned by the service.

See Also:

• AWS API Documentation

getChannel

default GetChannelResponse getChannel(GetChannelRequest getChannelRequest)
                               throws ChannelArnInvalidException,
ChannelNotFoundException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

Returns information about a specific channel.

Parameters:

getChannelRequest -

Returns:

Result of the GetChannel operation returned by the service.

See Also:

• AWS API Documentation

getChannel

default GetChannelResponse getChannel(Consumer<GetChannelRequest.Builder> getChannelRequest)
                               throws ChannelArnInvalidException,
ChannelNotFoundException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

Returns information about a specific channel.

This is a convenience which creates an instance of the GetChannelRequest.Builder avoiding the need to create one manually via GetChannelRequest.builder()

Parameters:

getChannelRequest - A Consumer that will call methods on GetChannelRequest.Builder to create a request.

Returns:

Result of the GetChannel operation returned by the service.

See Also:

• AWS API Documentation

getEventDataStore

default GetEventDataStoreResponse getEventDataStore(GetEventDataStoreRequest getEventDataStoreRequest)
                                             throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

getEventDataStoreRequest -

Returns:

Result of the GetEventDataStore operation returned by the service.

See Also:

• AWS API Documentation

getEventDataStore

default GetEventDataStoreResponse getEventDataStore(Consumer<GetEventDataStoreRequest.Builder> getEventDataStoreRequest)
                                             throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the GetEventDataStoreRequest.Builder avoiding the need to create one manually via GetEventDataStoreRequest.builder()

Parameters:

getEventDataStoreRequest - A Consumer that will call methods on GetEventDataStoreRequest.Builder to create a request.

Returns:

Result of the GetEventDataStore operation returned by the service.

See Also:

• AWS API Documentation

getEventSelectors

default GetEventSelectorsResponse getEventSelectors(GetEventSelectorsRequest getEventSelectorsRequest)
                                             throws TrailNotFoundException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
UnsupportedOperationException,
OperationNotPermittedException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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 management events, data events, and network activity events.

• If your event selector includes management events.

• If your event selector includes network activity events, the event sources for which you are logging network activity events.

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

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

• Logging management events

• Logging data events

• Logging network activity events

Parameters:

getEventSelectorsRequest -

Returns:

Result of the GetEventSelectors operation returned by the service.

See Also:

• AWS API Documentation

getEventSelectors

default GetEventSelectorsResponse getEventSelectors(Consumer<GetEventSelectorsRequest.Builder> getEventSelectorsRequest)
                                             throws TrailNotFoundException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
UnsupportedOperationException,
OperationNotPermittedException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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 management events, data events, and network activity events.

• If your event selector includes management events.

• If your event selector includes network activity events, the event sources for which you are logging network activity events.

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

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

• Logging management events

• Logging data events

• Logging network activity events

This is a convenience which creates an instance of the GetEventSelectorsRequest.Builder avoiding the need to create one manually via GetEventSelectorsRequest.builder()

Parameters:

getEventSelectorsRequest - A Consumer that will call methods on GetEventSelectorsRequest.Builder to create a request.

Returns:

Result of the GetEventSelectors operation returned by the service.

See Also:

• AWS API Documentation

getImport

default GetImportResponse getImport(GetImportRequest getImportRequest)
                             throws ImportNotFoundException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

Returns information about a specific import.

Parameters:

getImportRequest -

Returns:

Result of the GetImport operation returned by the service.

See Also:

• AWS API Documentation

getImport

default GetImportResponse getImport(Consumer<GetImportRequest.Builder> getImportRequest)
                             throws ImportNotFoundException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

Returns information about a specific import.

This is a convenience which creates an instance of the GetImportRequest.Builder avoiding the need to create one manually via GetImportRequest.builder()

Parameters:

getImportRequest - A Consumer that will call methods on GetImportRequest.Builder to create a request.

Returns:

Result of the GetImport operation returned by the service.

See Also:

• AWS API Documentation

getInsightSelectors

default GetInsightSelectorsResponse getInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest)
                                                 throws InvalidParameterException,
InvalidParameterCombinationException,
TrailNotFoundException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
UnsupportedOperationException,
OperationNotPermittedException,
InsightNotEnabledException,
NoManagementAccountSlrExistsException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

getInsightSelectorsRequest -

Returns:

Result of the GetInsightSelectors operation returned by the service.

See Also:

• AWS API Documentation

getInsightSelectors

default GetInsightSelectorsResponse getInsightSelectors(Consumer<GetInsightSelectorsRequest.Builder> getInsightSelectorsRequest)
                                                 throws InvalidParameterException,
InvalidParameterCombinationException,
TrailNotFoundException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
UnsupportedOperationException,
OperationNotPermittedException,
InsightNotEnabledException,
NoManagementAccountSlrExistsException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the GetInsightSelectorsRequest.Builder avoiding the need to create one manually via GetInsightSelectorsRequest.builder()

Parameters:

getInsightSelectorsRequest - A Consumer that will call methods on GetInsightSelectorsRequest.Builder to create a request.

Returns:

Result of the GetInsightSelectors operation returned by the service.

See Also:

• AWS API Documentation

getQueryResults

default GetQueryResultsResponse getQueryResults(GetQueryResultsRequest getQueryResultsRequest)
                                         throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidParameterException,
QueryIdNotFoundException,
InsufficientEncryptionPolicyException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

getQueryResultsRequest -

Returns:

Result of the GetQueryResults operation returned by the service.

See Also:

• AWS API Documentation

getQueryResults

default GetQueryResultsResponse getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
                                         throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidParameterException,
QueryIdNotFoundException,
InsufficientEncryptionPolicyException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the GetQueryResultsRequest.Builder avoiding the need to create one manually via GetQueryResultsRequest.builder()

Parameters:

getQueryResultsRequest - A Consumer that will call methods on GetQueryResultsRequest.Builder to create a request.

Returns:

Result of the GetQueryResults operation returned by the service.

See Also:

• AWS API Documentation

getQueryResultsPaginator

default GetQueryResultsIterable getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest)
                                                  throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidParameterException,
QueryIdNotFoundException,
InsufficientEncryptionPolicyException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of getQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client
             .getQueryResultsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest) operation.

Parameters:

getQueryResultsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getQueryResultsPaginator

default GetQueryResultsIterable getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
                                                  throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidParameterException,
QueryIdNotFoundException,
InsufficientEncryptionPolicyException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of getQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client
             .getQueryResultsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest) operation.

This is a convenience which creates an instance of the GetQueryResultsRequest.Builder avoiding the need to create one manually via GetQueryResultsRequest.builder()

Parameters:

getQueryResultsRequest - A Consumer that will call methods on GetQueryResultsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
                                             throws ResourceArnNotValidException,
ResourceNotFoundException,
ResourcePolicyNotFoundException,
ResourceTypeNotSupportedException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

getResourcePolicyRequest -

Returns:

Result of the GetResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
                                             throws ResourceArnNotValidException,
ResourceNotFoundException,
ResourcePolicyNotFoundException,
ResourceTypeNotSupportedException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the GetResourcePolicyRequest.Builder avoiding the need to create one manually via GetResourcePolicyRequest.builder()

Parameters:

getResourcePolicyRequest - A Consumer that will call methods on GetResourcePolicyRequest.Builder to create a request.

Returns:

Result of the GetResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

getTrail

default GetTrailResponse getTrail(GetTrailRequest getTrailRequest)
                           throws CloudTrailArnInvalidException,
TrailNotFoundException,
InvalidTrailNameException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

Returns settings information for a specified trail.

Parameters:

getTrailRequest -

Returns:

Result of the GetTrail operation returned by the service.

See Also:

• AWS API Documentation

getTrail

default GetTrailResponse getTrail(Consumer<GetTrailRequest.Builder> getTrailRequest)
                           throws CloudTrailArnInvalidException,
TrailNotFoundException,
InvalidTrailNameException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

Returns settings information for a specified trail.

This is a convenience which creates an instance of the GetTrailRequest.Builder avoiding the need to create one manually via GetTrailRequest.builder()

Parameters:

getTrailRequest - A Consumer that will call methods on GetTrailRequest.Builder to create a request.

Returns:

Result of the GetTrail operation returned by the service.

See Also:

• AWS API Documentation

getTrailStatus

default GetTrailStatusResponse getTrailStatus(GetTrailStatusRequest getTrailStatusRequest)
                                       throws CloudTrailArnInvalidException,
TrailNotFoundException,
InvalidTrailNameException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

getTrailStatusRequest - 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

getTrailStatus

default GetTrailStatusResponse getTrailStatus(Consumer<GetTrailStatusRequest.Builder> getTrailStatusRequest)
                                       throws CloudTrailArnInvalidException,
TrailNotFoundException,
InvalidTrailNameException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the GetTrailStatusRequest.Builder avoiding the need to create one manually via GetTrailStatusRequest.builder()

Parameters:

getTrailStatusRequest - A Consumer that will call methods on GetTrailStatusRequest.Builder to create a 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

default ListChannelsResponse listChannels(ListChannelsRequest listChannelsRequest)
                                   throws InvalidNextTokenException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

listChannelsRequest -

Returns:

Result of the ListChannels operation returned by the service.

See Also:

• AWS API Documentation

listChannels

default ListChannelsResponse listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
                                   throws InvalidNextTokenException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to create one manually via ListChannelsRequest.builder()

Parameters:

listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.

Returns:

Result of the ListChannels operation returned by the service.

See Also:

• AWS API Documentation

listChannelsPaginator

default ListChannelsIterable listChannelsPaginator(ListChannelsRequest listChannelsRequest)
                                            throws InvalidNextTokenException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListChannelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest) operation.

Parameters:

listChannelsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listChannelsPaginator

default ListChannelsIterable listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
                                            throws InvalidNextTokenException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListChannelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest) operation.

This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to create one manually via ListChannelsRequest.builder()

Parameters:

listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEventDataStores

default ListEventDataStoresResponse listEventDataStores(ListEventDataStoresRequest listEventDataStoresRequest)
                                                 throws InvalidMaxResultsException,
InvalidNextTokenException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

listEventDataStoresRequest -

Returns:

Result of the ListEventDataStores operation returned by the service.

See Also:

• AWS API Documentation

listEventDataStores

default ListEventDataStoresResponse listEventDataStores(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest)
                                                 throws InvalidMaxResultsException,
InvalidNextTokenException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the ListEventDataStoresRequest.Builder avoiding the need to create one manually via ListEventDataStoresRequest.builder()

Parameters:

listEventDataStoresRequest - A Consumer that will call methods on ListEventDataStoresRequest.Builder to create a request.

Returns:

Result of the ListEventDataStores operation returned by the service.

See Also:

• AWS API Documentation

listEventDataStoresPaginator

default ListEventDataStoresIterable listEventDataStoresPaginator(ListEventDataStoresRequest listEventDataStoresRequest)
                                                          throws InvalidMaxResultsException,
InvalidNextTokenException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client.listEventDataStoresPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client
             .listEventDataStoresPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client.listEventDataStoresPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest) operation.

Parameters:

listEventDataStoresRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEventDataStoresPaginator

default ListEventDataStoresIterable listEventDataStoresPaginator(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest)
                                                          throws InvalidMaxResultsException,
InvalidNextTokenException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client.listEventDataStoresPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client
             .listEventDataStoresPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client.listEventDataStoresPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest) operation.

This is a convenience which creates an instance of the ListEventDataStoresRequest.Builder avoiding the need to create one manually via ListEventDataStoresRequest.builder()

Parameters:

listEventDataStoresRequest - A Consumer that will call methods on ListEventDataStoresRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listImportFailures

default ListImportFailuresResponse listImportFailures(ListImportFailuresRequest listImportFailuresRequest)
                                               throws InvalidNextTokenException,
OperationNotPermittedException,
UnsupportedOperationException,
InvalidParameterException,
AwsServiceException,
SdkClientException,
CloudTrailException

Returns a list of failures for the specified import.

Parameters:

listImportFailuresRequest -

Returns:

Result of the ListImportFailures operation returned by the service.

See Also:

• AWS API Documentation

listImportFailures

default ListImportFailuresResponse listImportFailures(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest)
                                               throws InvalidNextTokenException,
OperationNotPermittedException,
UnsupportedOperationException,
InvalidParameterException,
AwsServiceException,
SdkClientException,
CloudTrailException

Returns a list of failures for the specified import.

This is a convenience which creates an instance of the ListImportFailuresRequest.Builder avoiding the need to create one manually via ListImportFailuresRequest.builder()

Parameters:

listImportFailuresRequest - A Consumer that will call methods on ListImportFailuresRequest.Builder to create a request.

Returns:

Result of the ListImportFailures operation returned by the service.

See Also:

• AWS API Documentation

listImportFailuresPaginator

default ListImportFailuresIterable listImportFailuresPaginator(ListImportFailuresRequest listImportFailuresRequest)
                                                        throws InvalidNextTokenException,
OperationNotPermittedException,
UnsupportedOperationException,
InvalidParameterException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client.listImportFailuresPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client
             .listImportFailuresPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client.listImportFailuresPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest) operation.

Parameters:

listImportFailuresRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listImportFailuresPaginator

default ListImportFailuresIterable listImportFailuresPaginator(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest)
                                                        throws InvalidNextTokenException,
OperationNotPermittedException,
UnsupportedOperationException,
InvalidParameterException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client.listImportFailuresPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client
             .listImportFailuresPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client.listImportFailuresPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest) operation.

This is a convenience which creates an instance of the ListImportFailuresRequest.Builder avoiding the need to create one manually via ListImportFailuresRequest.builder()

Parameters:

listImportFailuresRequest - A Consumer that will call methods on ListImportFailuresRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listImports

default ListImportsResponse listImports(ListImportsRequest listImportsRequest)
                                 throws EventDataStoreArnInvalidException,
InvalidNextTokenException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

listImportsRequest -

Returns:

Result of the ListImports operation returned by the service.

See Also:

• AWS API Documentation

listImports

default ListImportsResponse listImports(Consumer<ListImportsRequest.Builder> listImportsRequest)
                                 throws EventDataStoreArnInvalidException,
InvalidNextTokenException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the ListImportsRequest.Builder avoiding the need to create one manually via ListImportsRequest.builder()

Parameters:

listImportsRequest - A Consumer that will call methods on ListImportsRequest.Builder to create a request.

Returns:

Result of the ListImports operation returned by the service.

See Also:

• AWS API Documentation

listImportsPaginator

default ListImportsIterable listImportsPaginator(ListImportsRequest listImportsRequest)
                                          throws EventDataStoreArnInvalidException,
InvalidNextTokenException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListImportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest) operation.

Parameters:

listImportsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listImportsPaginator

default ListImportsIterable listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest)
                                          throws EventDataStoreArnInvalidException,
InvalidNextTokenException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListImportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest) operation.

This is a convenience which creates an instance of the ListImportsRequest.Builder avoiding the need to create one manually via ListImportsRequest.builder()

Parameters:

listImportsRequest - A Consumer that will call methods on ListImportsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listInsightsMetricData

default ListInsightsMetricDataResponse listInsightsMetricData(ListInsightsMetricDataRequest listInsightsMetricDataRequest)
                                                       throws InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

listInsightsMetricDataRequest -

Returns:

Result of the ListInsightsMetricData operation returned by the service.

See Also:

• AWS API Documentation

listInsightsMetricData

default ListInsightsMetricDataResponse listInsightsMetricData(Consumer<ListInsightsMetricDataRequest.Builder> listInsightsMetricDataRequest)
                                                       throws InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the ListInsightsMetricDataRequest.Builder avoiding the need to create one manually via ListInsightsMetricDataRequest.builder()

Parameters:

listInsightsMetricDataRequest - A Consumer that will call methods on ListInsightsMetricDataRequest.Builder to create a request.

Returns:

Result of the ListInsightsMetricData operation returned by the service.

See Also:

• AWS API Documentation

listInsightsMetricDataPaginator

default ListInsightsMetricDataIterable listInsightsMetricDataPaginator(ListInsightsMetricDataRequest listInsightsMetricDataRequest)
                                                                throws InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListInsightsMetricDataIterable responses = client.listInsightsMetricDataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListInsightsMetricDataIterable responses = client
             .listInsightsMetricDataPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListInsightsMetricDataIterable responses = client.listInsightsMetricDataPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest) operation.

Parameters:

listInsightsMetricDataRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listInsightsMetricDataPaginator

default ListInsightsMetricDataIterable listInsightsMetricDataPaginator(Consumer<ListInsightsMetricDataRequest.Builder> listInsightsMetricDataRequest)
                                                                throws InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListInsightsMetricDataIterable responses = client.listInsightsMetricDataPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListInsightsMetricDataIterable responses = client
             .listInsightsMetricDataPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListInsightsMetricDataIterable responses = client.listInsightsMetricDataPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest) operation.

This is a convenience which creates an instance of the ListInsightsMetricDataRequest.Builder avoiding the need to create one manually via ListInsightsMetricDataRequest.builder()

Parameters:

listInsightsMetricDataRequest - A Consumer that will call methods on ListInsightsMetricDataRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPublicKeys

default ListPublicKeysResponse listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
                                       throws InvalidTimeRangeException,
UnsupportedOperationException,
OperationNotPermittedException,
InvalidTokenException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

listPublicKeysRequest - 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

default ListPublicKeysResponse listPublicKeys(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest)
                                       throws InvalidTimeRangeException,
UnsupportedOperationException,
OperationNotPermittedException,
InvalidTokenException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the ListPublicKeysRequest.Builder avoiding the need to create one manually via ListPublicKeysRequest.builder()

Parameters:

listPublicKeysRequest - A Consumer that will call methods on ListPublicKeysRequest.Builder to create a 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

default ListPublicKeysResponse listPublicKeys()
                                       throws InvalidTimeRangeException,
UnsupportedOperationException,
OperationNotPermittedException,
InvalidTokenException,
AwsServiceException,
SdkClientException,
CloudTrailException

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:

Result of the ListPublicKeys operation returned by the service.

See Also:

• listPublicKeys(ListPublicKeysRequest)
• AWS API Documentation

listPublicKeysPaginator

default ListPublicKeysIterable listPublicKeysPaginator()
                                                throws InvalidTimeRangeException,
UnsupportedOperationException,
OperationNotPermittedException,
InvalidTokenException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client
             .listPublicKeysPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listPublicKeysPaginator(ListPublicKeysRequest)
• AWS API Documentation

listPublicKeysPaginator

default ListPublicKeysIterable listPublicKeysPaginator(ListPublicKeysRequest listPublicKeysRequest)
                                                throws InvalidTimeRangeException,
UnsupportedOperationException,
OperationNotPermittedException,
InvalidTokenException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client
             .listPublicKeysPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation.

Parameters:

listPublicKeysRequest - Requests the public keys for a specified time range.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPublicKeysPaginator

default ListPublicKeysIterable listPublicKeysPaginator(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest)
                                                throws InvalidTimeRangeException,
UnsupportedOperationException,
OperationNotPermittedException,
InvalidTokenException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client
             .listPublicKeysPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation.

This is a convenience which creates an instance of the ListPublicKeysRequest.Builder avoiding the need to create one manually via ListPublicKeysRequest.builder()

Parameters:

listPublicKeysRequest - A Consumer that will call methods on ListPublicKeysRequest.Builder to create a request. Requests the public keys for a specified time range.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listQueries

default ListQueriesResponse listQueries(ListQueriesRequest listQueriesRequest)
                                 throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InvalidDateRangeException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidParameterException,
InvalidQueryStatusException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

listQueriesRequest -

Returns:

Result of the ListQueries operation returned by the service.

See Also:

• AWS API Documentation

listQueries

default ListQueriesResponse listQueries(Consumer<ListQueriesRequest.Builder> listQueriesRequest)
                                 throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InvalidDateRangeException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidParameterException,
InvalidQueryStatusException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the ListQueriesRequest.Builder avoiding the need to create one manually via ListQueriesRequest.builder()

Parameters:

listQueriesRequest - A Consumer that will call methods on ListQueriesRequest.Builder to create a request.

Returns:

Result of the ListQueries operation returned by the service.

See Also:

• AWS API Documentation

listQueriesPaginator

default ListQueriesIterable listQueriesPaginator(ListQueriesRequest listQueriesRequest)
                                          throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InvalidDateRangeException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidParameterException,
InvalidQueryStatusException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListQueriesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest) operation.

Parameters:

listQueriesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listQueriesPaginator

default ListQueriesIterable listQueriesPaginator(Consumer<ListQueriesRequest.Builder> listQueriesRequest)
                                          throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InvalidDateRangeException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidParameterException,
InvalidQueryStatusException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListQueriesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest) operation.

This is a convenience which creates an instance of the ListQueriesRequest.Builder avoiding the need to create one manually via ListQueriesRequest.builder()

Parameters:

listQueriesRequest - A Consumer that will call methods on ListQueriesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTags

default ListTagsResponse listTags(ListTagsRequest listTagsRequest)
                           throws ResourceNotFoundException,
CloudTrailArnInvalidException,
EventDataStoreArnInvalidException,
ChannelArnInvalidException,
ResourceTypeNotSupportedException,
InvalidTrailNameException,
InactiveEventDataStoreException,
EventDataStoreNotFoundException,
UnsupportedOperationException,
OperationNotPermittedException,
InvalidTokenException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

listTagsRequest - Specifies a list of tags to return.

Returns:

Result of the ListTags operation returned by the service.

See Also:

• AWS API Documentation

listTags

default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
                           throws ResourceNotFoundException,
CloudTrailArnInvalidException,
EventDataStoreArnInvalidException,
ChannelArnInvalidException,
ResourceTypeNotSupportedException,
InvalidTrailNameException,
InactiveEventDataStoreException,
EventDataStoreNotFoundException,
UnsupportedOperationException,
OperationNotPermittedException,
InvalidTokenException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to create one manually via ListTagsRequest.builder()

Parameters:

listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request. Specifies a list of tags to return.

Returns:

Result of the ListTags operation returned by the service.

See Also:

• AWS API Documentation

listTagsPaginator

default ListTagsIterable listTagsPaginator(ListTagsRequest listTagsRequest)
                                    throws ResourceNotFoundException,
CloudTrailArnInvalidException,
EventDataStoreArnInvalidException,
ChannelArnInvalidException,
ResourceTypeNotSupportedException,
InvalidTrailNameException,
InactiveEventDataStoreException,
EventDataStoreNotFoundException,
UnsupportedOperationException,
OperationNotPermittedException,
InvalidTokenException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListTagsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest) operation.

Parameters:

listTagsRequest - Specifies a list of tags to return.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsPaginator

default ListTagsIterable listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)
                                    throws ResourceNotFoundException,
CloudTrailArnInvalidException,
EventDataStoreArnInvalidException,
ChannelArnInvalidException,
ResourceTypeNotSupportedException,
InvalidTrailNameException,
InactiveEventDataStoreException,
EventDataStoreNotFoundException,
UnsupportedOperationException,
OperationNotPermittedException,
InvalidTokenException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListTagsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest) operation.

This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to create one manually via ListTagsRequest.builder()

Parameters:

listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request. Specifies a list of tags to return.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTrails

default ListTrailsResponse listTrails(ListTrailsRequest listTrailsRequest)
                               throws UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

Lists trails that are in the current account.

Parameters:

listTrailsRequest -

Returns:

Result of the ListTrails operation returned by the service.

See Also:

• AWS API Documentation

listTrails

default ListTrailsResponse listTrails(Consumer<ListTrailsRequest.Builder> listTrailsRequest)
                               throws UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

Lists trails that are in the current account.

This is a convenience which creates an instance of the ListTrailsRequest.Builder avoiding the need to create one manually via ListTrailsRequest.builder()

Parameters:

listTrailsRequest - A Consumer that will call methods on ListTrailsRequest.Builder to create a request.

Returns:

Result of the ListTrails operation returned by the service.

See Also:

• AWS API Documentation

listTrailsPaginator

default ListTrailsIterable listTrailsPaginator(ListTrailsRequest listTrailsRequest)
                                        throws UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListTrailsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest) operation.

Parameters:

listTrailsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTrailsPaginator

default ListTrailsIterable listTrailsPaginator(Consumer<ListTrailsRequest.Builder> listTrailsRequest)
                                        throws UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.ListTrailsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest) operation.

This is a convenience which creates an instance of the ListTrailsRequest.Builder avoiding the need to create one manually via ListTrailsRequest.builder()

Parameters:

listTrailsRequest - A Consumer that will call methods on ListTrailsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

lookupEvents

default LookupEventsResponse lookupEvents(LookupEventsRequest lookupEventsRequest)
                                   throws InvalidLookupAttributesException,
InvalidTimeRangeException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidEventCategoryException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

lookupEventsRequest - Contains a request for LookupEvents.

Returns:

Result of the LookupEvents operation returned by the service.

See Also:

• AWS API Documentation

lookupEvents

default LookupEventsResponse lookupEvents(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)
                                   throws InvalidLookupAttributesException,
InvalidTimeRangeException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidEventCategoryException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the LookupEventsRequest.Builder avoiding the need to create one manually via LookupEventsRequest.builder()

Parameters:

lookupEventsRequest - A Consumer that will call methods on LookupEventsRequest.Builder to create a request. Contains a request for LookupEvents.

Returns:

Result of the LookupEvents operation returned by the service.

See Also:

• AWS API Documentation

lookupEvents

default LookupEventsResponse lookupEvents()
                                   throws InvalidLookupAttributesException,
InvalidTimeRangeException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidEventCategoryException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Returns:

Result of the LookupEvents operation returned by the service.

See Also:

• lookupEvents(LookupEventsRequest)
• AWS API Documentation

lookupEventsPaginator

default LookupEventsIterable lookupEventsPaginator()
                                            throws InvalidLookupAttributesException,
InvalidTimeRangeException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidEventCategoryException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• lookupEventsPaginator(LookupEventsRequest)
• AWS API Documentation

lookupEventsPaginator

default LookupEventsIterable lookupEventsPaginator(LookupEventsRequest lookupEventsRequest)
                                            throws InvalidLookupAttributesException,
InvalidTimeRangeException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidEventCategoryException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest) operation.

Parameters:

lookupEventsRequest - Contains a request for LookupEvents.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

lookupEventsPaginator

default LookupEventsIterable lookupEventsPaginator(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)
                                            throws InvalidLookupAttributesException,
InvalidTimeRangeException,
InvalidMaxResultsException,
InvalidNextTokenException,
InvalidEventCategoryException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

This is a variant of lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
     for (software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest) operation.

This is a convenience which creates an instance of the LookupEventsRequest.Builder avoiding the need to create one manually via LookupEventsRequest.builder()

Parameters:

lookupEventsRequest - A Consumer that will call methods on LookupEventsRequest.Builder to create a request. Contains a request for LookupEvents.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

putEventSelectors

default PutEventSelectorsResponse putEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest)
                                             throws TrailNotFoundException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
InvalidHomeRegionException,
InvalidEventSelectorsException,
ConflictException,
ThrottlingException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
InsufficientDependencyServiceAccessPermissionException,
AwsServiceException,
SdkClientException,
CloudTrailException

Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten.

You can use AdvancedEventSelectors to log management events, data events for all resource types, and network activity events.

You can use EventSelectors to log management events and data events for the following resource types:

• AWS::DynamoDB::Table

• AWS::Lambda::Function

• AWS::S3::Object

You can't use EventSelectors to log network activity events.

If you want your trail to log Insights events, be sure the event selector or advanced 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 or network activity 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 to log 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.

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. For more information, see Logging management events, Logging data events, Logging network activity events, and Quotas in CloudTrail in the CloudTrail User Guide.

Parameters:

putEventSelectorsRequest -

Returns:

Result of the PutEventSelectors operation returned by the service.

See Also:

• AWS API Documentation

putEventSelectors

default PutEventSelectorsResponse putEventSelectors(Consumer<PutEventSelectorsRequest.Builder> putEventSelectorsRequest)
                                             throws TrailNotFoundException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
InvalidHomeRegionException,
InvalidEventSelectorsException,
ConflictException,
ThrottlingException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
InsufficientDependencyServiceAccessPermissionException,
AwsServiceException,
SdkClientException,
CloudTrailException

Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten.

You can use AdvancedEventSelectors to log management events, data events for all resource types, and network activity events.

You can use EventSelectors to log management events and data events for the following resource types:

• AWS::DynamoDB::Table

• AWS::Lambda::Function

• AWS::S3::Object

You can't use EventSelectors to log network activity events.

If you want your trail to log Insights events, be sure the event selector or advanced 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 or network activity 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 to log 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.

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. For more information, see Logging management events, Logging data events, Logging network activity events, and Quotas in CloudTrail in the CloudTrail User Guide.

This is a convenience which creates an instance of the PutEventSelectorsRequest.Builder avoiding the need to create one manually via PutEventSelectorsRequest.builder()

Parameters:

putEventSelectorsRequest - A Consumer that will call methods on PutEventSelectorsRequest.Builder to create a request.

Returns:

Result of the PutEventSelectors operation returned by the service.

See Also:

• AWS API Documentation

putInsightSelectors

default PutInsightSelectorsResponse putInsightSelectors(PutInsightSelectorsRequest putInsightSelectorsRequest)
                                                 throws InvalidParameterException,
InvalidParameterCombinationException,
TrailNotFoundException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
InvalidHomeRegionException,
InvalidInsightSelectorsException,
InsufficientS3BucketPolicyException,
InsufficientEncryptionPolicyException,
S3BucketDoesNotExistException,
KmsException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

putInsightSelectorsRequest -

Returns:

Result of the PutInsightSelectors operation returned by the service.

See Also:

• AWS API Documentation

putInsightSelectors

default PutInsightSelectorsResponse putInsightSelectors(Consumer<PutInsightSelectorsRequest.Builder> putInsightSelectorsRequest)
                                                 throws InvalidParameterException,
InvalidParameterCombinationException,
TrailNotFoundException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
InvalidHomeRegionException,
InvalidInsightSelectorsException,
InsufficientS3BucketPolicyException,
InsufficientEncryptionPolicyException,
S3BucketDoesNotExistException,
KmsException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the PutInsightSelectorsRequest.Builder avoiding the need to create one manually via PutInsightSelectorsRequest.builder()

Parameters:

putInsightSelectorsRequest - A Consumer that will call methods on PutInsightSelectorsRequest.Builder to create a request.

Returns:

Result of the PutInsightSelectors operation returned by the service.

See Also:

• AWS API Documentation

putResourcePolicy

default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
                                             throws ResourceArnNotValidException,
ResourcePolicyNotValidException,
ResourceNotFoundException,
ResourceTypeNotSupportedException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

putResourcePolicyRequest -

Returns:

Result of the PutResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

putResourcePolicy

default PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
                                             throws ResourceArnNotValidException,
ResourcePolicyNotValidException,
ResourceNotFoundException,
ResourceTypeNotSupportedException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need to create one manually via PutResourcePolicyRequest.builder()

Parameters:

putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.

Returns:

Result of the PutResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

registerOrganizationDelegatedAdmin

default RegisterOrganizationDelegatedAdminResponse registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest)
                                                                               throws AccountRegisteredException,
AccountNotFoundException,
InsufficientDependencyServiceAccessPermissionException,
InvalidParameterException,
CannotDelegateManagementAccountException,
CloudTrailAccessNotEnabledException,
ConflictException,
DelegatedAdminAccountLimitExceededException,
NotOrganizationManagementAccountException,
OrganizationNotInAllFeaturesModeException,
OrganizationsNotInUseException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

registerOrganizationDelegatedAdminRequest - 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

registerOrganizationDelegatedAdmin

default RegisterOrganizationDelegatedAdminResponse registerOrganizationDelegatedAdmin(Consumer<RegisterOrganizationDelegatedAdminRequest.Builder> registerOrganizationDelegatedAdminRequest)
                                                                               throws AccountRegisteredException,
AccountNotFoundException,
InsufficientDependencyServiceAccessPermissionException,
InvalidParameterException,
CannotDelegateManagementAccountException,
CloudTrailAccessNotEnabledException,
ConflictException,
DelegatedAdminAccountLimitExceededException,
NotOrganizationManagementAccountException,
OrganizationNotInAllFeaturesModeException,
OrganizationsNotInUseException,
UnsupportedOperationException,
OperationNotPermittedException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the RegisterOrganizationDelegatedAdminRequest.Builder avoiding the need to create one manually via RegisterOrganizationDelegatedAdminRequest.builder()

Parameters:

registerOrganizationDelegatedAdminRequest - A Consumer that will call methods on RegisterOrganizationDelegatedAdminRequest.Builder to create a 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

default RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest)
                               throws ResourceNotFoundException,
CloudTrailArnInvalidException,
EventDataStoreArnInvalidException,
ChannelArnInvalidException,
ResourceTypeNotSupportedException,
InvalidTrailNameException,
InvalidTagParameterException,
InactiveEventDataStoreException,
EventDataStoreNotFoundException,
ChannelNotFoundException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

removeTagsRequest - 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

removeTags

default RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
                               throws ResourceNotFoundException,
CloudTrailArnInvalidException,
EventDataStoreArnInvalidException,
ChannelArnInvalidException,
ResourceTypeNotSupportedException,
InvalidTrailNameException,
InvalidTagParameterException,
InactiveEventDataStoreException,
EventDataStoreNotFoundException,
ChannelNotFoundException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the RemoveTagsRequest.Builder avoiding the need to create one manually via RemoveTagsRequest.builder()

Parameters:

removeTagsRequest - A Consumer that will call methods on RemoveTagsRequest.Builder to create a 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

default RestoreEventDataStoreResponse restoreEventDataStore(RestoreEventDataStoreRequest restoreEventDataStoreRequest)
                                                     throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
EventDataStoreMaxLimitExceededException,
InvalidEventDataStoreStatusException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
OrganizationsNotInUseException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
OrganizationNotInAllFeaturesModeException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

restoreEventDataStoreRequest -

Returns:

Result of the RestoreEventDataStore operation returned by the service.

See Also:

• AWS API Documentation

restoreEventDataStore

default RestoreEventDataStoreResponse restoreEventDataStore(Consumer<RestoreEventDataStoreRequest.Builder> restoreEventDataStoreRequest)
                                                     throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
EventDataStoreMaxLimitExceededException,
InvalidEventDataStoreStatusException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
OrganizationsNotInUseException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
OrganizationNotInAllFeaturesModeException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the RestoreEventDataStoreRequest.Builder avoiding the need to create one manually via RestoreEventDataStoreRequest.builder()

Parameters:

restoreEventDataStoreRequest - A Consumer that will call methods on RestoreEventDataStoreRequest.Builder to create a request.

Returns:

Result of the RestoreEventDataStore operation returned by the service.

See Also:

• AWS API Documentation

startEventDataStoreIngestion

default StartEventDataStoreIngestionResponse startEventDataStoreIngestion(StartEventDataStoreIngestionRequest startEventDataStoreIngestionRequest)
                                                                   throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidEventDataStoreStatusException,
InvalidParameterException,
InvalidEventDataStoreCategoryException,
OperationNotPermittedException,
UnsupportedOperationException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
InsufficientDependencyServiceAccessPermissionException,
AwsServiceException,
SdkClientException,
CloudTrailException

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, NetworkActivity, or ConfigurationItem.

Parameters:

startEventDataStoreIngestionRequest -

Returns:

Result of the StartEventDataStoreIngestion operation returned by the service.

See Also:

• AWS API Documentation

startEventDataStoreIngestion

default StartEventDataStoreIngestionResponse startEventDataStoreIngestion(Consumer<StartEventDataStoreIngestionRequest.Builder> startEventDataStoreIngestionRequest)
                                                                   throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidEventDataStoreStatusException,
InvalidParameterException,
InvalidEventDataStoreCategoryException,
OperationNotPermittedException,
UnsupportedOperationException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
InsufficientDependencyServiceAccessPermissionException,
AwsServiceException,
SdkClientException,
CloudTrailException

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, NetworkActivity, or ConfigurationItem.

This is a convenience which creates an instance of the StartEventDataStoreIngestionRequest.Builder avoiding the need to create one manually via StartEventDataStoreIngestionRequest.builder()

Parameters:

startEventDataStoreIngestionRequest - A Consumer that will call methods on StartEventDataStoreIngestionRequest.Builder to create a request.

Returns:

Result of the StartEventDataStoreIngestion operation returned by the service.

See Also:

• AWS API Documentation

startImport

default StartImportResponse startImport(StartImportRequest startImportRequest)
                                 throws AccountHasOngoingImportException,
EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidEventDataStoreStatusException,
InvalidEventDataStoreCategoryException,
InactiveEventDataStoreException,
InvalidImportSourceException,
ImportNotFoundException,
InvalidParameterException,
InsufficientEncryptionPolicyException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

startImportRequest -

Returns:

Result of the StartImport operation returned by the service.

See Also:

• AWS API Documentation

startImport

default StartImportResponse startImport(Consumer<StartImportRequest.Builder> startImportRequest)
                                 throws AccountHasOngoingImportException,
EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidEventDataStoreStatusException,
InvalidEventDataStoreCategoryException,
InactiveEventDataStoreException,
InvalidImportSourceException,
ImportNotFoundException,
InvalidParameterException,
InsufficientEncryptionPolicyException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the StartImportRequest.Builder avoiding the need to create one manually via StartImportRequest.builder()

Parameters:

startImportRequest - A Consumer that will call methods on StartImportRequest.Builder to create a request.

Returns:

Result of the StartImport operation returned by the service.

See Also:

• AWS API Documentation

startLogging

default StartLoggingResponse startLogging(StartLoggingRequest startLoggingRequest)
                                   throws CloudTrailArnInvalidException,
ConflictException,
ThrottlingException,
TrailNotFoundException,
InvalidTrailNameException,
InvalidHomeRegionException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
InsufficientDependencyServiceAccessPermissionException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

startLoggingRequest - 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

startLogging

default StartLoggingResponse startLogging(Consumer<StartLoggingRequest.Builder> startLoggingRequest)
                                   throws CloudTrailArnInvalidException,
ConflictException,
ThrottlingException,
TrailNotFoundException,
InvalidTrailNameException,
InvalidHomeRegionException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
InsufficientDependencyServiceAccessPermissionException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the StartLoggingRequest.Builder avoiding the need to create one manually via StartLoggingRequest.builder()

Parameters:

startLoggingRequest - A Consumer that will call methods on StartLoggingRequest.Builder to create a 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

default StartQueryResponse startQuery(StartQueryRequest startQueryRequest)
                               throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InvalidParameterException,
InvalidQueryStatementException,
MaxConcurrentQueriesException,
InsufficientEncryptionPolicyException,
InvalidS3PrefixException,
InvalidS3BucketNameException,
InsufficientS3BucketPolicyException,
S3BucketDoesNotExistException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

startQueryRequest -

Returns:

Result of the StartQuery operation returned by the service.

See Also:

• AWS API Documentation

startQuery

default StartQueryResponse startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest)
                               throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InactiveEventDataStoreException,
InvalidParameterException,
InvalidQueryStatementException,
MaxConcurrentQueriesException,
InsufficientEncryptionPolicyException,
InvalidS3PrefixException,
InvalidS3BucketNameException,
InsufficientS3BucketPolicyException,
S3BucketDoesNotExistException,
OperationNotPermittedException,
UnsupportedOperationException,
NoManagementAccountSlrExistsException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the StartQueryRequest.Builder avoiding the need to create one manually via StartQueryRequest.builder()

Parameters:

startQueryRequest - A Consumer that will call methods on StartQueryRequest.Builder to create a request.

Returns:

Result of the StartQuery operation returned by the service.

See Also:

• AWS API Documentation

stopEventDataStoreIngestion

default StopEventDataStoreIngestionResponse stopEventDataStoreIngestion(StopEventDataStoreIngestionRequest stopEventDataStoreIngestionRequest)
                                                                 throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidEventDataStoreStatusException,
InvalidParameterException,
InvalidEventDataStoreCategoryException,
OperationNotPermittedException,
UnsupportedOperationException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
InsufficientDependencyServiceAccessPermissionException,
AwsServiceException,
SdkClientException,
CloudTrailException

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, NetworkActivity, or ConfigurationItem.

Parameters:

stopEventDataStoreIngestionRequest -

Returns:

Result of the StopEventDataStoreIngestion operation returned by the service.

See Also:

• AWS API Documentation

stopEventDataStoreIngestion

default StopEventDataStoreIngestionResponse stopEventDataStoreIngestion(Consumer<StopEventDataStoreIngestionRequest.Builder> stopEventDataStoreIngestionRequest)
                                                                 throws EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidEventDataStoreStatusException,
InvalidParameterException,
InvalidEventDataStoreCategoryException,
OperationNotPermittedException,
UnsupportedOperationException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
InsufficientDependencyServiceAccessPermissionException,
AwsServiceException,
SdkClientException,
CloudTrailException

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, NetworkActivity, or ConfigurationItem.

This is a convenience which creates an instance of the StopEventDataStoreIngestionRequest.Builder avoiding the need to create one manually via StopEventDataStoreIngestionRequest.builder()

Parameters:

stopEventDataStoreIngestionRequest - A Consumer that will call methods on StopEventDataStoreIngestionRequest.Builder to create a request.

Returns:

Result of the StopEventDataStoreIngestion operation returned by the service.

See Also:

• AWS API Documentation

stopImport

default StopImportResponse stopImport(StopImportRequest stopImportRequest)
                               throws ImportNotFoundException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

Stops a specified import.

Parameters:

stopImportRequest -

Returns:

Result of the StopImport operation returned by the service.

See Also:

• AWS API Documentation

stopImport

default StopImportResponse stopImport(Consumer<StopImportRequest.Builder> stopImportRequest)
                               throws ImportNotFoundException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

Stops a specified import.

This is a convenience which creates an instance of the StopImportRequest.Builder avoiding the need to create one manually via StopImportRequest.builder()

Parameters:

stopImportRequest - A Consumer that will call methods on StopImportRequest.Builder to create a request.

Returns:

Result of the StopImport operation returned by the service.

See Also:

• AWS API Documentation

stopLogging

default StopLoggingResponse stopLogging(StopLoggingRequest stopLoggingRequest)
                                 throws TrailNotFoundException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
ConflictException,
ThrottlingException,
InvalidHomeRegionException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
InsufficientDependencyServiceAccessPermissionException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

stopLoggingRequest - 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

stopLogging

default StopLoggingResponse stopLogging(Consumer<StopLoggingRequest.Builder> stopLoggingRequest)
                                 throws TrailNotFoundException,
InvalidTrailNameException,
CloudTrailArnInvalidException,
ConflictException,
ThrottlingException,
InvalidHomeRegionException,
UnsupportedOperationException,
OperationNotPermittedException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
InsufficientDependencyServiceAccessPermissionException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the StopLoggingRequest.Builder avoiding the need to create one manually via StopLoggingRequest.builder()

Parameters:

stopLoggingRequest - A Consumer that will call methods on StopLoggingRequest.Builder to create a 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

default UpdateChannelResponse updateChannel(UpdateChannelRequest updateChannelRequest)
                                     throws ChannelArnInvalidException,
ChannelNotFoundException,
ChannelAlreadyExistsException,
EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidEventDataStoreCategoryException,
InactiveEventDataStoreException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

Parameters:

updateChannelRequest -

Returns:

Result of the UpdateChannel operation returned by the service.

See Also:

• AWS API Documentation

updateChannel

default UpdateChannelResponse updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)
                                     throws ChannelArnInvalidException,
ChannelNotFoundException,
ChannelAlreadyExistsException,
EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidEventDataStoreCategoryException,
InactiveEventDataStoreException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
CloudTrailException

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

This is a convenience which creates an instance of the UpdateChannelRequest.Builder avoiding the need to create one manually via UpdateChannelRequest.builder()

Parameters:

updateChannelRequest - A Consumer that will call methods on UpdateChannelRequest.Builder to create a request.

Returns:

Result of the UpdateChannel operation returned by the service.

See Also:

• AWS API Documentation

updateEventDataStore

default UpdateEventDataStoreResponse updateEventDataStore(UpdateEventDataStoreRequest updateEventDataStoreRequest)
                                                   throws EventDataStoreAlreadyExistsException,
EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidEventSelectorsException,
InvalidInsightSelectorsException,
EventDataStoreHasOngoingImportException,
InactiveEventDataStoreException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
InsufficientEncryptionPolicyException,
InvalidKmsKeyIdException,
KmsKeyNotFoundException,
KmsException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
OrganizationsNotInUseException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
OrganizationNotInAllFeaturesModeException,
AwsServiceException,
SdkClientException,
CloudTrailException

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, data, or network activity 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.

Parameters:

updateEventDataStoreRequest -

Returns:

Result of the UpdateEventDataStore operation returned by the service.

See Also:

• AWS API Documentation

updateEventDataStore

default UpdateEventDataStoreResponse updateEventDataStore(Consumer<UpdateEventDataStoreRequest.Builder> updateEventDataStoreRequest)
                                                   throws EventDataStoreAlreadyExistsException,
EventDataStoreArnInvalidException,
EventDataStoreNotFoundException,
InvalidEventSelectorsException,
InvalidInsightSelectorsException,
EventDataStoreHasOngoingImportException,
InactiveEventDataStoreException,
InvalidParameterException,
OperationNotPermittedException,
UnsupportedOperationException,
InsufficientEncryptionPolicyException,
InvalidKmsKeyIdException,
KmsKeyNotFoundException,
KmsException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
OrganizationsNotInUseException,
NotOrganizationMasterAccountException,
NoManagementAccountSlrExistsException,
OrganizationNotInAllFeaturesModeException,
AwsServiceException,
SdkClientException,
CloudTrailException

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, data, or network activity 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.

This is a convenience which creates an instance of the UpdateEventDataStoreRequest.Builder avoiding the need to create one manually via UpdateEventDataStoreRequest.builder()

Parameters:

updateEventDataStoreRequest - A Consumer that will call methods on UpdateEventDataStoreRequest.Builder to create a request.

Returns:

Result of the UpdateEventDataStore operation returned by the service.

See Also:

• AWS API Documentation

updateTrail

default UpdateTrailResponse updateTrail(UpdateTrailRequest updateTrailRequest)
                                 throws S3BucketDoesNotExistException,
InsufficientS3BucketPolicyException,
InsufficientSnsTopicPolicyException,
InsufficientEncryptionPolicyException,
TrailNotFoundException,
InvalidS3BucketNameException,
InvalidS3PrefixException,
InvalidSnsTopicNameException,
InvalidKmsKeyIdException,
InvalidTrailNameException,
TrailNotProvidedException,
InvalidEventSelectorsException,
CloudTrailArnInvalidException,
ConflictException,
ThrottlingException,
InvalidParameterCombinationException,
InvalidHomeRegionException,
KmsKeyNotFoundException,
KmsException,
InvalidCloudWatchLogsLogGroupArnException,
InvalidCloudWatchLogsRoleArnException,
CloudWatchLogsDeliveryUnavailableException,
UnsupportedOperationException,
OperationNotPermittedException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
OrganizationsNotInUseException,
NotOrganizationMasterAccountException,
OrganizationNotInAllFeaturesModeException,
NoManagementAccountSlrExistsException,
CloudTrailInvalidClientTokenIdException,
InvalidParameterException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

Parameters:

updateTrailRequest - Specifies settings to update for the trail.

Returns:

Result of the UpdateTrail operation returned by the service.

See Also:

• AWS API Documentation

updateTrail

default UpdateTrailResponse updateTrail(Consumer<UpdateTrailRequest.Builder> updateTrailRequest)
                                 throws S3BucketDoesNotExistException,
InsufficientS3BucketPolicyException,
InsufficientSnsTopicPolicyException,
InsufficientEncryptionPolicyException,
TrailNotFoundException,
InvalidS3BucketNameException,
InvalidS3PrefixException,
InvalidSnsTopicNameException,
InvalidKmsKeyIdException,
InvalidTrailNameException,
TrailNotProvidedException,
InvalidEventSelectorsException,
CloudTrailArnInvalidException,
ConflictException,
ThrottlingException,
InvalidParameterCombinationException,
InvalidHomeRegionException,
KmsKeyNotFoundException,
KmsException,
InvalidCloudWatchLogsLogGroupArnException,
InvalidCloudWatchLogsRoleArnException,
CloudWatchLogsDeliveryUnavailableException,
UnsupportedOperationException,
OperationNotPermittedException,
CloudTrailAccessNotEnabledException,
InsufficientDependencyServiceAccessPermissionException,
OrganizationsNotInUseException,
NotOrganizationMasterAccountException,
OrganizationNotInAllFeaturesModeException,
NoManagementAccountSlrExistsException,
CloudTrailInvalidClientTokenIdException,
InvalidParameterException,
AwsServiceException,
SdkClientException,
CloudTrailException

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.

This is a convenience which creates an instance of the UpdateTrailRequest.Builder avoiding the need to create one manually via UpdateTrailRequest.builder()

Parameters:

updateTrailRequest - A Consumer that will call methods on UpdateTrailRequest.Builder to create a request. Specifies settings to update for the trail.

Returns:

Result of the UpdateTrail operation returned by the service.

See Also:

• AWS API Documentation

create

static CloudTrailClient create()

Create a CloudTrailClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CloudTrailClientBuilder builder()

Create a builder that can be used to configure and create a CloudTrailClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default CloudTrailServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration