Interface CloudTrailClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
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
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault AddTagsResponseaddTags(Consumer<AddTagsRequest.Builder> addTagsRequest) Adds one or more tags to a trail, event data store, dashboard, or channel, up to a limit of 50.default AddTagsResponseaddTags(AddTagsRequest addTagsRequest) Adds one or more tags to a trail, event data store, dashboard, or channel, up to a limit of 50.static CloudTrailClientBuilderbuilder()Create a builder that can be used to configure and create aCloudTrailClient.default CancelQueryResponsecancelQuery(Consumer<CancelQueryRequest.Builder> cancelQueryRequest) Cancels a query if the query is not in a terminated state, such asCANCELLED,FAILED,TIMED_OUT, orFINISHED.default CancelQueryResponsecancelQuery(CancelQueryRequest cancelQueryRequest) Cancels a query if the query is not in a terminated state, such asCANCELLED,FAILED,TIMED_OUT, orFINISHED.static CloudTrailClientcreate()Create aCloudTrailClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateChannelResponsecreateChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest) Creates a channel for CloudTrail to ingest events from a partner or external source.default CreateChannelResponsecreateChannel(CreateChannelRequest createChannelRequest) Creates a channel for CloudTrail to ingest events from a partner or external source.default CreateDashboardResponsecreateDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest) Creates a custom dashboard or the Highlights dashboard.default CreateDashboardResponsecreateDashboard(CreateDashboardRequest createDashboardRequest) Creates a custom dashboard or the Highlights dashboard.default CreateEventDataStoreResponsecreateEventDataStore(Consumer<CreateEventDataStoreRequest.Builder> createEventDataStoreRequest) Creates a new event data store.default CreateEventDataStoreResponsecreateEventDataStore(CreateEventDataStoreRequest createEventDataStoreRequest) Creates a new event data store.default CreateTrailResponsecreateTrail(Consumer<CreateTrailRequest.Builder> createTrailRequest) Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.default CreateTrailResponsecreateTrail(CreateTrailRequest createTrailRequest) Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.default DeleteChannelResponsedeleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) Deletes a channel.default DeleteChannelResponsedeleteChannel(DeleteChannelRequest deleteChannelRequest) Deletes a channel.default DeleteDashboardResponsedeleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest) Deletes the specified dashboard.default DeleteDashboardResponsedeleteDashboard(DeleteDashboardRequest deleteDashboardRequest) Deletes the specified dashboard.default DeleteEventDataStoreResponsedeleteEventDataStore(Consumer<DeleteEventDataStoreRequest.Builder> deleteEventDataStoreRequest) Disables the event data store specified byEventDataStore, which accepts an event data store ARN.default DeleteEventDataStoreResponsedeleteEventDataStore(DeleteEventDataStoreRequest deleteEventDataStoreRequest) Disables the event data store specified byEventDataStore, which accepts an event data store ARN.default DeleteResourcePolicyResponsedeleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.default DeleteResourcePolicyResponsedeleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.default DeleteTrailResponsedeleteTrail(Consumer<DeleteTrailRequest.Builder> deleteTrailRequest) Deletes a trail.default DeleteTrailResponsedeleteTrail(DeleteTrailRequest deleteTrailRequest) Deletes a trail.deregisterOrganizationDelegatedAdmin(Consumer<DeregisterOrganizationDelegatedAdminRequest.Builder> deregisterOrganizationDelegatedAdminRequest) Removes CloudTrail delegated administrator permissions from a member account in an organization.deregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest deregisterOrganizationDelegatedAdminRequest) Removes CloudTrail delegated administrator permissions from a member account in an organization.default DescribeQueryResponsedescribeQuery(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 DescribeQueryResponsedescribeQuery(DescribeQueryRequest describeQueryRequest) Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status.default DescribeTrailsResponseRetrieves settings for one or more trails associated with the current Region for your account.default DescribeTrailsResponsedescribeTrails(Consumer<DescribeTrailsRequest.Builder> describeTrailsRequest) Retrieves settings for one or more trails associated with the current Region for your account.default DescribeTrailsResponsedescribeTrails(DescribeTrailsRequest describeTrailsRequest) Retrieves settings for one or more trails associated with the current Region for your account.default DisableFederationResponsedisableFederation(Consumer<DisableFederationRequest.Builder> disableFederationRequest) Disables Lake query federation on the specified event data store.default DisableFederationResponsedisableFederation(DisableFederationRequest disableFederationRequest) Disables Lake query federation on the specified event data store.default EnableFederationResponseenableFederation(Consumer<EnableFederationRequest.Builder> enableFederationRequest) Enables Lake query federation on the specified event data store.default EnableFederationResponseenableFederation(EnableFederationRequest enableFederationRequest) Enables Lake query federation on the specified event data store.default GenerateQueryResponsegenerateQuery(Consumer<GenerateQueryRequest.Builder> generateQueryRequest) Generates a query from a natural language prompt.default GenerateQueryResponsegenerateQuery(GenerateQueryRequest generateQueryRequest) Generates a query from a natural language prompt.default GetChannelResponsegetChannel(Consumer<GetChannelRequest.Builder> getChannelRequest) Returns information about a specific channel.default GetChannelResponsegetChannel(GetChannelRequest getChannelRequest) Returns information about a specific channel.default GetDashboardResponsegetDashboard(Consumer<GetDashboardRequest.Builder> getDashboardRequest) Returns the specified dashboard.default GetDashboardResponsegetDashboard(GetDashboardRequest getDashboardRequest) Returns the specified dashboard.default GetEventConfigurationResponsegetEventConfiguration(Consumer<GetEventConfigurationRequest.Builder> getEventConfigurationRequest) Retrieves the current event configuration settings for the specified event data store, including details about maximum event size and context key selectors configured for the event data store.default GetEventConfigurationResponsegetEventConfiguration(GetEventConfigurationRequest getEventConfigurationRequest) Retrieves the current event configuration settings for the specified event data store, including details about maximum event size and context key selectors configured for the event data store.default GetEventDataStoreResponsegetEventDataStore(Consumer<GetEventDataStoreRequest.Builder> getEventDataStoreRequest) Returns information about an event data store specified as either an ARN or the ID portion of the ARN.default GetEventDataStoreResponsegetEventDataStore(GetEventDataStoreRequest getEventDataStoreRequest) Returns information about an event data store specified as either an ARN or the ID portion of the ARN.default GetEventSelectorsResponsegetEventSelectors(Consumer<GetEventSelectorsRequest.Builder> getEventSelectorsRequest) Describes the settings for the event selectors that you configured for your trail.default GetEventSelectorsResponsegetEventSelectors(GetEventSelectorsRequest getEventSelectorsRequest) Describes the settings for the event selectors that you configured for your trail.default GetImportResponsegetImport(Consumer<GetImportRequest.Builder> getImportRequest) Returns information about a specific import.default GetImportResponsegetImport(GetImportRequest getImportRequest) Returns information about a specific import.default GetInsightSelectorsResponsegetInsightSelectors(Consumer<GetInsightSelectorsRequest.Builder> getInsightSelectorsRequest) Describes the settings for the Insights event selectors that you configured for your trail or event data store.default GetInsightSelectorsResponsegetInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest) Describes the settings for the Insights event selectors that you configured for your trail or event data store.default GetQueryResultsResponsegetQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) Gets event data results of a query.default GetQueryResultsResponsegetQueryResults(GetQueryResultsRequest getQueryResultsRequest) Gets event data results of a query.default GetQueryResultsIterablegetQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) This is a variant ofgetQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest)operation.default GetQueryResultsIterablegetQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest) This is a variant ofgetQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest)operation.default GetResourcePolicyResponsegetResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Retrieves the JSON text of the resource-based policy document attached to the CloudTrail event data store, dashboard, or channel.default GetResourcePolicyResponsegetResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) Retrieves the JSON text of the resource-based policy document attached to the CloudTrail event data store, dashboard, or channel.default GetTrailResponsegetTrail(Consumer<GetTrailRequest.Builder> getTrailRequest) Returns settings information for a specified trail.default GetTrailResponsegetTrail(GetTrailRequest getTrailRequest) Returns settings information for a specified trail.default GetTrailStatusResponsegetTrailStatus(Consumer<GetTrailStatusRequest.Builder> getTrailStatusRequest) Returns a JSON-formatted list of information about the specified trail.default GetTrailStatusResponsegetTrailStatus(GetTrailStatusRequest getTrailStatusRequest) Returns a JSON-formatted list of information about the specified trail.default ListChannelsResponselistChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest) Lists the channels in the current account, and their source names.default ListChannelsResponselistChannels(ListChannelsRequest listChannelsRequest) Lists the channels in the current account, and their source names.default ListChannelsIterablelistChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest)operation.default ListChannelsIterablelistChannelsPaginator(ListChannelsRequest listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest)operation.default ListDashboardsResponselistDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) Returns information about all dashboards in the account, in the current Region.default ListDashboardsResponselistDashboards(ListDashboardsRequest listDashboardsRequest) Returns information about all dashboards in the account, in the current Region.default ListEventDataStoresResponselistEventDataStores(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest) Returns information about all event data stores in the account, in the current Region.default ListEventDataStoresResponselistEventDataStores(ListEventDataStoresRequest listEventDataStoresRequest) Returns information about all event data stores in the account, in the current Region.default ListEventDataStoresIterablelistEventDataStoresPaginator(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest) This is a variant oflistEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest)operation.default ListEventDataStoresIterablelistEventDataStoresPaginator(ListEventDataStoresRequest listEventDataStoresRequest) This is a variant oflistEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest)operation.default ListImportFailuresResponselistImportFailures(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest) Returns a list of failures for the specified import.default ListImportFailuresResponselistImportFailures(ListImportFailuresRequest listImportFailuresRequest) Returns a list of failures for the specified import.default ListImportFailuresIterablelistImportFailuresPaginator(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest) This is a variant oflistImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest)operation.default ListImportFailuresIterablelistImportFailuresPaginator(ListImportFailuresRequest listImportFailuresRequest) This is a variant oflistImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest)operation.default ListImportsResponselistImports(Consumer<ListImportsRequest.Builder> listImportsRequest) Returns information on all imports, or a select set of imports byImportStatusorDestination.default ListImportsResponselistImports(ListImportsRequest listImportsRequest) Returns information on all imports, or a select set of imports byImportStatusorDestination.default ListImportsIterablelistImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest) This is a variant oflistImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest)operation.default ListImportsIterablelistImportsPaginator(ListImportsRequest listImportsRequest) This is a variant oflistImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest)operation.default ListInsightsMetricDataResponselistInsightsMetricData(Consumer<ListInsightsMetricDataRequest.Builder> listInsightsMetricDataRequest) Returns Insights metrics data for trails that have enabled Insights.default ListInsightsMetricDataResponselistInsightsMetricData(ListInsightsMetricDataRequest listInsightsMetricDataRequest) Returns Insights metrics data for trails that have enabled Insights.default ListInsightsMetricDataIterablelistInsightsMetricDataPaginator(Consumer<ListInsightsMetricDataRequest.Builder> listInsightsMetricDataRequest) This is a variant oflistInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest)operation.default ListInsightsMetricDataIterablelistInsightsMetricDataPaginator(ListInsightsMetricDataRequest listInsightsMetricDataRequest) This is a variant oflistInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest)operation.default ListPublicKeysResponseReturns all public keys whose private keys were used to sign the digest files within the specified time range.default ListPublicKeysResponselistPublicKeys(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest) Returns all public keys whose private keys were used to sign the digest files within the specified time range.default ListPublicKeysResponselistPublicKeys(ListPublicKeysRequest listPublicKeysRequest) Returns all public keys whose private keys were used to sign the digest files within the specified time range.default ListPublicKeysIterableThis is a variant oflistPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest)operation.default ListPublicKeysIterablelistPublicKeysPaginator(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest) This is a variant oflistPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest)operation.default ListPublicKeysIterablelistPublicKeysPaginator(ListPublicKeysRequest listPublicKeysRequest) This is a variant oflistPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest)operation.default ListQueriesResponselistQueries(Consumer<ListQueriesRequest.Builder> listQueriesRequest) Returns a list of queries and query statuses for the past seven days.default ListQueriesResponselistQueries(ListQueriesRequest listQueriesRequest) Returns a list of queries and query statuses for the past seven days.default ListQueriesIterablelistQueriesPaginator(Consumer<ListQueriesRequest.Builder> listQueriesRequest) This is a variant oflistQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest)operation.default ListQueriesIterablelistQueriesPaginator(ListQueriesRequest listQueriesRequest) This is a variant oflistQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest)operation.default ListTagsResponselistTags(Consumer<ListTagsRequest.Builder> listTagsRequest) Lists the tags for the specified trails, event data stores, dashboards, or channels in the current Region.default ListTagsResponselistTags(ListTagsRequest listTagsRequest) Lists the tags for the specified trails, event data stores, dashboards, or channels in the current Region.default ListTagsIterablelistTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest) This is a variant oflistTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest)operation.default ListTagsIterablelistTagsPaginator(ListTagsRequest listTagsRequest) This is a variant oflistTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest)operation.default ListTrailsResponselistTrails(Consumer<ListTrailsRequest.Builder> listTrailsRequest) Lists trails that are in the current account.default ListTrailsResponselistTrails(ListTrailsRequest listTrailsRequest) Lists trails that are in the current account.default ListTrailsIterablelistTrailsPaginator(Consumer<ListTrailsRequest.Builder> listTrailsRequest) This is a variant oflistTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest)operation.default ListTrailsIterablelistTrailsPaginator(ListTrailsRequest listTrailsRequest) This is a variant oflistTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest)operation.default LookupEventsResponseLooks up management events or CloudTrail Insights events that are captured by CloudTrail.default LookupEventsResponselookupEvents(Consumer<LookupEventsRequest.Builder> lookupEventsRequest) Looks up management events or CloudTrail Insights events that are captured by CloudTrail.default LookupEventsResponselookupEvents(LookupEventsRequest lookupEventsRequest) Looks up management events or CloudTrail Insights events that are captured by CloudTrail.default LookupEventsIterableThis is a variant oflookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)operation.default LookupEventsIterablelookupEventsPaginator(Consumer<LookupEventsRequest.Builder> lookupEventsRequest) This is a variant oflookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)operation.default LookupEventsIterablelookupEventsPaginator(LookupEventsRequest lookupEventsRequest) This is a variant oflookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)operation.default PutEventConfigurationResponseputEventConfiguration(Consumer<PutEventConfigurationRequest.Builder> putEventConfigurationRequest) Updates the event configuration settings for the specified event data store.default PutEventConfigurationResponseputEventConfiguration(PutEventConfigurationRequest putEventConfigurationRequest) Updates the event configuration settings for the specified event data store.default PutEventSelectorsResponseputEventSelectors(Consumer<PutEventSelectorsRequest.Builder> putEventSelectorsRequest) Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail.default PutEventSelectorsResponseputEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest) Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail.default PutInsightSelectorsResponseputInsightSelectors(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 PutInsightSelectorsResponseputInsightSelectors(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 PutResourcePolicyResponseputResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel.default PutResourcePolicyResponseputResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel.registerOrganizationDelegatedAdmin(Consumer<RegisterOrganizationDelegatedAdminRequest.Builder> registerOrganizationDelegatedAdminRequest) Registers an organization’s member account as the CloudTrail delegated administrator.registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest) Registers an organization’s member account as the CloudTrail delegated administrator.default RemoveTagsResponseremoveTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) Removes the specified tags from a trail, event data store, dashboard, or channel.default RemoveTagsResponseremoveTags(RemoveTagsRequest removeTagsRequest) Removes the specified tags from a trail, event data store, dashboard, or channel.default RestoreEventDataStoreResponserestoreEventDataStore(Consumer<RestoreEventDataStoreRequest.Builder> restoreEventDataStoreRequest) Restores a deleted event data store specified byEventDataStore, which accepts an event data store ARN.default RestoreEventDataStoreResponserestoreEventDataStore(RestoreEventDataStoreRequest restoreEventDataStoreRequest) Restores a deleted event data store specified byEventDataStore, which accepts an event data store ARN.default SearchSampleQueriesResponsesearchSampleQueries(Consumer<SearchSampleQueriesRequest.Builder> searchSampleQueriesRequest) Searches sample queries and returns a list of sample queries that are sorted by relevance.default SearchSampleQueriesResponsesearchSampleQueries(SearchSampleQueriesRequest searchSampleQueriesRequest) Searches sample queries and returns a list of sample queries that are sorted by relevance.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault StartDashboardRefreshResponsestartDashboardRefresh(Consumer<StartDashboardRefreshRequest.Builder> startDashboardRefreshRequest) Starts a refresh of the specified dashboard.default StartDashboardRefreshResponsestartDashboardRefresh(StartDashboardRefreshRequest startDashboardRefreshRequest) Starts a refresh of the specified dashboard.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.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 StartImportResponsestartImport(Consumer<StartImportRequest.Builder> startImportRequest) Starts an import of logged trail events from a source S3 bucket to a destination event data store.default StartImportResponsestartImport(StartImportRequest startImportRequest) Starts an import of logged trail events from a source S3 bucket to a destination event data store.default StartLoggingResponsestartLogging(Consumer<StartLoggingRequest.Builder> startLoggingRequest) Starts the recording of Amazon Web Services API calls and log file delivery for a trail.default StartLoggingResponsestartLogging(StartLoggingRequest startLoggingRequest) Starts the recording of Amazon Web Services API calls and log file delivery for a trail.default StartQueryResponsestartQuery(Consumer<StartQueryRequest.Builder> startQueryRequest) Starts a CloudTrail Lake query.default StartQueryResponsestartQuery(StartQueryRequest startQueryRequest) Starts a CloudTrail Lake query.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.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 StopImportResponsestopImport(Consumer<StopImportRequest.Builder> stopImportRequest) Stops a specified import.default StopImportResponsestopImport(StopImportRequest stopImportRequest) Stops a specified import.default StopLoggingResponsestopLogging(Consumer<StopLoggingRequest.Builder> stopLoggingRequest) Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.default StopLoggingResponsestopLogging(StopLoggingRequest stopLoggingRequest) Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.default UpdateChannelResponseupdateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) Updates a channel specified by a required channel ARN or UUID.default UpdateChannelResponseupdateChannel(UpdateChannelRequest updateChannelRequest) Updates a channel specified by a required channel ARN or UUID.default UpdateDashboardResponseupdateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest) Updates the specified dashboard.default UpdateDashboardResponseupdateDashboard(UpdateDashboardRequest updateDashboardRequest) Updates the specified dashboard.default UpdateEventDataStoreResponseupdateEventDataStore(Consumer<UpdateEventDataStoreRequest.Builder> updateEventDataStoreRequest) Updates an event data store.default UpdateEventDataStoreResponseupdateEventDataStore(UpdateEventDataStoreRequest updateEventDataStoreRequest) Updates an event data store.default UpdateTrailResponseupdateTrail(Consumer<UpdateTrailRequest.Builder> updateTrailRequest) Updates trail settings that control what events you are logging, and how to handle log files.default UpdateTrailResponseupdateTrail(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
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
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, dashboard, 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, dashboard, or channel.- Returns:
- Result of the AddTags operation returned by the service.
- See Also:
-
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, dashboard, 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.Builderavoiding the need to create one manually viaAddTagsRequest.builder()- Parameters:
addTagsRequest- AConsumerthat will call methods onAddTagsRequest.Builderto create a request. Specifies the tags to add to a trail, event data store, dashboard, or channel.- Returns:
- Result of the AddTags operation returned by the service.
- See Also:
-
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, orFINISHED. You must specify an ARN value forEventDataStore. The ID of the query that you want to cancel is also required. When you runCancelQuery, the query status might show asCANCELLEDeven if the operation is not yet finished.- Parameters:
cancelQueryRequest-- Returns:
- Result of the CancelQuery operation returned by the service.
- See Also:
-
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, orFINISHED. You must specify an ARN value forEventDataStore. The ID of the query that you want to cancel is also required. When you runCancelQuery, the query status might show asCANCELLEDeven if the operation is not yet finished.
This is a convenience which creates an instance of the
CancelQueryRequest.Builderavoiding the need to create one manually viaCancelQueryRequest.builder()- Parameters:
cancelQueryRequest- AConsumerthat will call methods onCancelQueryRequest.Builderto create a request.- Returns:
- Result of the CancelQuery operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaCreateChannelRequest.builder()- Parameters:
createChannelRequest- AConsumerthat will call methods onCreateChannelRequest.Builderto create a request.- Returns:
- Result of the CreateChannel operation returned by the service.
- See Also:
-
createDashboard
default CreateDashboardResponse createDashboard(CreateDashboardRequest createDashboardRequest) throws ConflictException, InvalidTagParameterException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InsufficientEncryptionPolicyException, InvalidQueryStatementException, ServiceQuotaExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Creates a custom dashboard or the Highlights dashboard.
-
Custom dashboards - Custom dashboards allow you to query events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule.
-
Highlights dashboard - You can create the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule.
CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the
StartQueryoperation on your behalf. To provide permissions, run thePutResourcePolicyoperation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.To set a refresh schedule, CloudTrail must be granted permissions to run the
StartDashboardRefreshoperation to refresh the dashboard on your behalf. To provide permissions, run thePutResourcePolicyoperation to attach a resource-based policy to the dashboard. For more information, see Resource-based policy example for a dashboard in the CloudTrail User Guide.For more information about dashboards, see CloudTrail Lake dashboards in the CloudTrail User Guide.
- Parameters:
createDashboardRequest-- Returns:
- Result of the CreateDashboard operation returned by the service.
- See Also:
-
-
createDashboard
default CreateDashboardResponse createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest) throws ConflictException, InvalidTagParameterException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InsufficientEncryptionPolicyException, InvalidQueryStatementException, ServiceQuotaExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Creates a custom dashboard or the Highlights dashboard.
-
Custom dashboards - Custom dashboards allow you to query events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule.
-
Highlights dashboard - You can create the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule.
CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the
StartQueryoperation on your behalf. To provide permissions, run thePutResourcePolicyoperation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.To set a refresh schedule, CloudTrail must be granted permissions to run the
StartDashboardRefreshoperation to refresh the dashboard on your behalf. To provide permissions, run thePutResourcePolicyoperation to attach a resource-based policy to the dashboard. For more information, see Resource-based policy example for a dashboard in the CloudTrail User Guide.For more information about dashboards, see CloudTrail Lake dashboards in the CloudTrail User Guide.
This is a convenience which creates an instance of the
CreateDashboardRequest.Builderavoiding the need to create one manually viaCreateDashboardRequest.builder()- Parameters:
createDashboardRequest- AConsumerthat will call methods onCreateDashboardRequest.Builderto create a request.- Returns:
- Result of the CreateDashboard operation returned by the service.
- See Also:
-
-
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:
-
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.Builderavoiding the need to create one manually viaCreateEventDataStoreRequest.builder()- Parameters:
createEventDataStoreRequest- AConsumerthat will call methods onCreateEventDataStoreRequest.Builderto create a request.- Returns:
- Result of the CreateEventDataStore operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaCreateTrailRequest.builder()- Parameters:
createTrailRequest- AConsumerthat will call methods onCreateTrailRequest.Builderto create a request. Specifies the settings for each trail.- Returns:
- Result of the CreateTrail operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaDeleteChannelRequest.builder()- Parameters:
deleteChannelRequest- AConsumerthat will call methods onDeleteChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteChannel operation returned by the service.
- See Also:
-
deleteDashboard
default DeleteDashboardResponse deleteDashboard(DeleteDashboardRequest deleteDashboardRequest) throws ConflictException, ResourceNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Deletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.
- Parameters:
deleteDashboardRequest-- Returns:
- Result of the DeleteDashboard operation returned by the service.
- See Also:
-
deleteDashboard
default DeleteDashboardResponse deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest) throws ConflictException, ResourceNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Deletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.
This is a convenience which creates an instance of the
DeleteDashboardRequest.Builderavoiding the need to create one manually viaDeleteDashboardRequest.builder()- Parameters:
deleteDashboardRequest- AConsumerthat will call methods onDeleteDashboardRequest.Builderto create a request.- Returns:
- Result of the DeleteDashboard operation returned by the service.
- See Also:
-
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 runDeleteEventDataStore, the event data store enters aPENDING_DELETIONstate, and is automatically deleted after a wait period of seven days.TerminationProtectionEnabledmust be set toFalseon the event data store and theFederationStatusmust beDISABLED. You cannot delete an event data store ifTerminationProtectionEnabledisTrueor theFederationStatusisENABLED.After you run
DeleteEventDataStoreon an event data store, you cannot runListQueries,DescribeQuery, orGetQueryResultson queries that are using an event data store in aPENDING_DELETIONstate. An event data store in thePENDING_DELETIONstate does not incur costs.- Parameters:
deleteEventDataStoreRequest-- Returns:
- Result of the DeleteEventDataStore operation returned by the service.
- See Also:
-
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 runDeleteEventDataStore, the event data store enters aPENDING_DELETIONstate, and is automatically deleted after a wait period of seven days.TerminationProtectionEnabledmust be set toFalseon the event data store and theFederationStatusmust beDISABLED. You cannot delete an event data store ifTerminationProtectionEnabledisTrueor theFederationStatusisENABLED.After you run
DeleteEventDataStoreon an event data store, you cannot runListQueries,DescribeQuery, orGetQueryResultson queries that are using an event data store in aPENDING_DELETIONstate. An event data store in thePENDING_DELETIONstate does not incur costs.
This is a convenience which creates an instance of the
DeleteEventDataStoreRequest.Builderavoiding the need to create one manually viaDeleteEventDataStoreRequest.builder()- Parameters:
deleteEventDataStoreRequest- AConsumerthat will call methods onDeleteEventDataStoreRequest.Builderto create a request.- Returns:
- Result of the DeleteEventDataStore operation returned by the service.
- See Also:
-
deleteResourcePolicy
default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws ResourceArnNotValidException, ResourceNotFoundException, ResourcePolicyNotFoundException, ResourceTypeNotSupportedException, ConflictException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Deletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.
- Parameters:
deleteResourcePolicyRequest-- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- See Also:
-
deleteResourcePolicy
default DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) throws ResourceArnNotValidException, ResourceNotFoundException, ResourcePolicyNotFoundException, ResourceTypeNotSupportedException, ConflictException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Deletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.
This is a convenience which creates an instance of the
DeleteResourcePolicyRequest.Builderavoiding the need to create one manually viaDeleteResourcePolicyRequest.builder()- Parameters:
deleteResourcePolicyRequest- AConsumerthat will call methods onDeleteResourcePolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- See Also:
-
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.
DeleteTrailcannot 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:
-
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.
DeleteTrailcannot 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.Builderavoiding the need to create one manually viaDeleteTrailRequest.builder()- Parameters:
deleteTrailRequest- AConsumerthat will call methods onDeleteTrailRequest.Builderto 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:
-
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:
-
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.Builderavoiding the need to create one manually viaDeregisterOrganizationDelegatedAdminRequest.builder()- Parameters:
deregisterOrganizationDelegatedAdminRequest- AConsumerthat will call methods onDeregisterOrganizationDelegatedAdminRequest.Builderto 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:
-
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
QueryIdorQueryAlias. Specifying theQueryAliasparameter returns information about the last query run for the alias. You can provideRefreshIdalong withQueryAliasto view the query results of a dashboard query for the specifiedRefreshId.- Parameters:
describeQueryRequest-- Returns:
- Result of the DescribeQuery operation returned by the service.
- See Also:
-
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
QueryIdorQueryAlias. Specifying theQueryAliasparameter returns information about the last query run for the alias. You can provideRefreshIdalong withQueryAliasto view the query results of a dashboard query for the specifiedRefreshId.
This is a convenience which creates an instance of the
DescribeQueryRequest.Builderavoiding the need to create one manually viaDescribeQueryRequest.builder()- Parameters:
describeQueryRequest- AConsumerthat will call methods onDescribeQueryRequest.Builderto create a request.- Returns:
- Result of the DescribeQuery operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaDescribeTrailsRequest.builder()- Parameters:
describeTrailsRequest- AConsumerthat will call methods onDescribeTrailsRequest.Builderto create a request. Returns information about the trail.- Returns:
- Result of the DescribeTrails operation returned by the service.
- See Also:
-
describeTrails
default DescribeTrailsResponse describeTrails() throws UnsupportedOperationException, OperationNotPermittedException, InvalidTrailNameException, CloudTrailArnInvalidException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailExceptionRetrieves 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:
-
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:
-
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.Builderavoiding the need to create one manually viaDisableFederationRequest.builder()- Parameters:
disableFederationRequest- AConsumerthat will call methods onDisableFederationRequest.Builderto create a request.- Returns:
- Result of the DisableFederation operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaEnableFederationRequest.builder()- Parameters:
enableFederationRequest- AConsumerthat will call methods onEnableFederationRequest.Builderto create a request.- Returns:
- Result of the EnableFederation operation returned by the service.
- See Also:
-
generateQuery
default GenerateQueryResponse generateQuery(GenerateQueryRequest generateQueryRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidParameterException, GenerateResponseException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException Generates a query from a natural language prompt. This operation uses generative artificial intelligence (generative AI) to produce a ready-to-use SQL query from the prompt.
The prompt can be a question or a statement about the event data in your event data store. For example, you can enter prompts like "What are my top errors in the past month?" and “Give me a list of users that used SNS.”
The prompt must be in English. For information about limitations, permissions, and supported Regions, see Create CloudTrail Lake queries from natural language prompts in the CloudTrail user guide.
Do not include any personally identifying, confidential, or sensitive information in your prompts.
This feature uses generative AI large language models (LLMs); we recommend double-checking the LLM response.
- Parameters:
generateQueryRequest-- Returns:
- Result of the GenerateQuery operation returned by the service.
- See Also:
-
generateQuery
default GenerateQueryResponse generateQuery(Consumer<GenerateQueryRequest.Builder> generateQueryRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidParameterException, GenerateResponseException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException Generates a query from a natural language prompt. This operation uses generative artificial intelligence (generative AI) to produce a ready-to-use SQL query from the prompt.
The prompt can be a question or a statement about the event data in your event data store. For example, you can enter prompts like "What are my top errors in the past month?" and “Give me a list of users that used SNS.”
The prompt must be in English. For information about limitations, permissions, and supported Regions, see Create CloudTrail Lake queries from natural language prompts in the CloudTrail user guide.
Do not include any personally identifying, confidential, or sensitive information in your prompts.
This feature uses generative AI large language models (LLMs); we recommend double-checking the LLM response.
This is a convenience which creates an instance of the
GenerateQueryRequest.Builderavoiding the need to create one manually viaGenerateQueryRequest.builder()- Parameters:
generateQueryRequest- AConsumerthat will call methods onGenerateQueryRequest.Builderto create a request.- Returns:
- Result of the GenerateQuery operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaGetChannelRequest.builder()- Parameters:
getChannelRequest- AConsumerthat will call methods onGetChannelRequest.Builderto create a request.- Returns:
- Result of the GetChannel operation returned by the service.
- See Also:
-
getDashboard
default GetDashboardResponse getDashboard(GetDashboardRequest getDashboardRequest) throws ResourceNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Returns the specified dashboard.
- Parameters:
getDashboardRequest-- Returns:
- Result of the GetDashboard operation returned by the service.
- See Also:
-
getDashboard
default GetDashboardResponse getDashboard(Consumer<GetDashboardRequest.Builder> getDashboardRequest) throws ResourceNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Returns the specified dashboard.
This is a convenience which creates an instance of the
GetDashboardRequest.Builderavoiding the need to create one manually viaGetDashboardRequest.builder()- Parameters:
getDashboardRequest- AConsumerthat will call methods onGetDashboardRequest.Builderto create a request.- Returns:
- Result of the GetDashboard operation returned by the service.
- See Also:
-
getEventConfiguration
default GetEventConfigurationResponse getEventConfiguration(GetEventConfigurationRequest getEventConfigurationRequest) throws CloudTrailArnInvalidException, UnsupportedOperationException, OperationNotPermittedException, EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidParameterException, InvalidEventDataStoreCategoryException, NoManagementAccountSlrExistsException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudTrailException Retrieves the current event configuration settings for the specified event data store, including details about maximum event size and context key selectors configured for the event data store.
- Parameters:
getEventConfigurationRequest-- Returns:
- Result of the GetEventConfiguration operation returned by the service.
- See Also:
-
getEventConfiguration
default GetEventConfigurationResponse getEventConfiguration(Consumer<GetEventConfigurationRequest.Builder> getEventConfigurationRequest) throws CloudTrailArnInvalidException, UnsupportedOperationException, OperationNotPermittedException, EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidParameterException, InvalidEventDataStoreCategoryException, NoManagementAccountSlrExistsException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudTrailException Retrieves the current event configuration settings for the specified event data store, including details about maximum event size and context key selectors configured for the event data store.
This is a convenience which creates an instance of the
GetEventConfigurationRequest.Builderavoiding the need to create one manually viaGetEventConfigurationRequest.builder()- Parameters:
getEventConfigurationRequest- AConsumerthat will call methods onGetEventConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetEventConfiguration operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaGetEventDataStoreRequest.builder()- Parameters:
getEventDataStoreRequest- AConsumerthat will call methods onGetEventDataStoreRequest.Builderto create a request.- Returns:
- Result of the GetEventDataStore operation returned by the service.
- See Also:
-
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:
- Parameters:
getEventSelectorsRequest-- Returns:
- Result of the GetEventSelectors operation returned by the service.
- See Also:
-
-
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:
This is a convenience which creates an instance of the
GetEventSelectorsRequest.Builderavoiding the need to create one manually viaGetEventSelectorsRequest.builder()- Parameters:
getEventSelectorsRequest- AConsumerthat will call methods onGetEventSelectorsRequest.Builderto create a request.- Returns:
- Result of the GetEventSelectors operation returned by the service.
- See Also:
-
-
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:
-
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.Builderavoiding the need to create one manually viaGetImportRequest.builder()- Parameters:
getImportRequest- AConsumerthat will call methods onGetImportRequest.Builderto create a request.- Returns:
- Result of the GetImport operation returned by the service.
- See Also:
-
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.
GetInsightSelectorsshows 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 runGetInsightSelectorson a trail or event data store that does not have Insights events enabled, the operation throws the exceptionInsightNotEnabledExceptionSpecify either the
EventDataStoreparameter to get Insights event selectors for an event data store, or theTrailNameparameter to the get Insights event selectors for a trail. You cannot specify these parameters together.For more information, see Working with CloudTrail Insights in the CloudTrail User Guide.
- Parameters:
getInsightSelectorsRequest-- Returns:
- Result of the GetInsightSelectors operation returned by the service.
- See Also:
-
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.
GetInsightSelectorsshows 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 runGetInsightSelectorson a trail or event data store that does not have Insights events enabled, the operation throws the exceptionInsightNotEnabledExceptionSpecify either the
EventDataStoreparameter to get Insights event selectors for an event data store, or theTrailNameparameter to the get Insights event selectors for a trail. You cannot specify these parameters together.For more information, see Working with CloudTrail Insights in the CloudTrail User Guide.
This is a convenience which creates an instance of the
GetInsightSelectorsRequest.Builderavoiding the need to create one manually viaGetInsightSelectorsRequest.builder()- Parameters:
getInsightSelectorsRequest- AConsumerthat will call methods onGetInsightSelectorsRequest.Builderto create a request.- Returns:
- Result of the GetInsightSelectors operation returned by the service.
- See Also:
-
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
QueryIDvalue returned by theStartQueryoperation.- Parameters:
getQueryResultsRequest-- Returns:
- Result of the GetQueryResults operation returned by the service.
- See Also:
-
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
QueryIDvalue returned by theStartQueryoperation.
This is a convenience which creates an instance of the
GetQueryResultsRequest.Builderavoiding the need to create one manually viaGetQueryResultsRequest.builder()- Parameters:
getQueryResultsRequest- AConsumerthat will call methods onGetQueryResultsRequest.Builderto create a request.- Returns:
- Result of the GetQueryResults operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetQueryResultsRequest.builder()- Parameters:
getQueryResultsRequest- AConsumerthat will call methods onGetQueryResultsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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 event data store, dashboard, or channel.
- Parameters:
getResourcePolicyRequest-- Returns:
- Result of the GetResourcePolicy operation returned by the service.
- See Also:
-
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 event data store, dashboard, or channel.
This is a convenience which creates an instance of the
GetResourcePolicyRequest.Builderavoiding the need to create one manually viaGetResourcePolicyRequest.builder()- Parameters:
getResourcePolicyRequest- AConsumerthat will call methods onGetResourcePolicyRequest.Builderto create a request.- Returns:
- Result of the GetResourcePolicy operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaGetTrailRequest.builder()- Parameters:
getTrailRequest- AConsumerthat will call methods onGetTrailRequest.Builderto create a request.- Returns:
- Result of the GetTrail operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaGetTrailStatusRequest.builder()- Parameters:
getTrailStatusRequest- AConsumerthat will call methods onGetTrailStatusRequest.Builderto 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:
-
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:
-
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.Builderavoiding the need to create one manually viaListChannelsRequest.builder()- Parameters:
listChannelsRequest- AConsumerthat will call methods onListChannelsRequest.Builderto create a request.- Returns:
- Result of the ListChannels operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListChannelsRequest.builder()- Parameters:
listChannelsRequest- AConsumerthat will call methods onListChannelsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDashboards
default ListDashboardsResponse listDashboards(ListDashboardsRequest listDashboardsRequest) throws UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Returns information about all dashboards in the account, in the current Region.
- Parameters:
listDashboardsRequest-- Returns:
- Result of the ListDashboards operation returned by the service.
- See Also:
-
listDashboards
default ListDashboardsResponse listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Returns information about all dashboards in the account, in the current Region.
This is a convenience which creates an instance of the
ListDashboardsRequest.Builderavoiding the need to create one manually viaListDashboardsRequest.builder()- Parameters:
listDashboardsRequest- AConsumerthat will call methods onListDashboardsRequest.Builderto create a request.- Returns:
- Result of the ListDashboards operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaListEventDataStoresRequest.builder()- Parameters:
listEventDataStoresRequest- AConsumerthat will call methods onListEventDataStoresRequest.Builderto create a request.- Returns:
- Result of the ListEventDataStores operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client.listEventDataStoresPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client.listEventDataStoresPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListEventDataStoresRequest.builder()- Parameters:
listEventDataStoresRequest- AConsumerthat will call methods onListEventDataStoresRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaListImportFailuresRequest.builder()- Parameters:
listImportFailuresRequest- AConsumerthat will call methods onListImportFailuresRequest.Builderto create a request.- Returns:
- Result of the ListImportFailures operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client.listImportFailuresPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client.listImportFailuresPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListImportFailuresRequest.builder()- Parameters:
listImportFailuresRequest- AConsumerthat will call methods onListImportFailuresRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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
ImportStatusorDestination.- Parameters:
listImportsRequest-- Returns:
- Result of the ListImports operation returned by the service.
- See Also:
-
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
ImportStatusorDestination.
This is a convenience which creates an instance of the
ListImportsRequest.Builderavoiding the need to create one manually viaListImportsRequest.builder()- Parameters:
listImportsRequest- AConsumerthat will call methods onListImportsRequest.Builderto create a request.- Returns:
- Result of the ListImports operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListImportsRequest.builder()- Parameters:
listImportsRequest- AConsumerthat will call methods onListImportsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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, andInsightTypeparameters.If the
InsightTypeis set toApiErrorRateInsight, the request must also include theErrorCodeparameter.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
ListInsightsMetricDataAPI operation is linked to thecloudtrail:LookupEventsaction. To use this operation, you must have permissions to perform thecloudtrail:LookupEventsaction.- Parameters:
listInsightsMetricDataRequest-- Returns:
- Result of the ListInsightsMetricData operation returned by the service.
- See Also:
-
-
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, andInsightTypeparameters.If the
InsightTypeis set toApiErrorRateInsight, the request must also include theErrorCodeparameter.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
ListInsightsMetricDataAPI operation is linked to thecloudtrail:LookupEventsaction. To use this operation, you must have permissions to perform thecloudtrail:LookupEventsaction.
This is a convenience which creates an instance of the
ListInsightsMetricDataRequest.Builderavoiding the need to create one manually viaListInsightsMetricDataRequest.builder()- Parameters:
listInsightsMetricDataRequest- AConsumerthat will call methods onListInsightsMetricDataRequest.Builderto create a request.- Returns:
- Result of the ListInsightsMetricData operation returned by the service.
- See Also:
-
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListInsightsMetricDataIterable responses = client.listInsightsMetricDataPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListInsightsMetricDataIterable responses = client.listInsightsMetricDataPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListInsightsMetricDataRequest.builder()- Parameters:
listInsightsMetricDataRequest- AConsumerthat will call methods onListInsightsMetricDataRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaListPublicKeysRequest.builder()- Parameters:
listPublicKeysRequest- AConsumerthat will call methods onListPublicKeysRequest.Builderto create a request. Requests the public keys for a specified time range.- Returns:
- Result of the ListPublicKeys operation returned by the service.
- See Also:
-
listPublicKeys
default ListPublicKeysResponse listPublicKeys() throws InvalidTimeRangeException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailExceptionReturns 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:
-
listPublicKeysPaginator
default ListPublicKeysIterable listPublicKeysPaginator() throws InvalidTimeRangeException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailExceptionThis 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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListPublicKeysRequest.builder()- Parameters:
listPublicKeysRequest- AConsumerthat will call methods onListPublicKeysRequest.Builderto 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:
-
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 addingStartTimeandEndTimeparameters, and aQueryStatusvalue. Valid values forQueryStatusincludeQUEUED,RUNNING,FINISHED,FAILED,TIMED_OUT, orCANCELLED.- Parameters:
listQueriesRequest-- Returns:
- Result of the ListQueries operation returned by the service.
- See Also:
-
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 addingStartTimeandEndTimeparameters, and aQueryStatusvalue. Valid values forQueryStatusincludeQUEUED,RUNNING,FINISHED,FAILED,TIMED_OUT, orCANCELLED.
This is a convenience which creates an instance of the
ListQueriesRequest.Builderavoiding the need to create one manually viaListQueriesRequest.builder()- Parameters:
listQueriesRequest- AConsumerthat will call methods onListQueriesRequest.Builderto create a request.- Returns:
- Result of the ListQueries operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListQueriesRequest.builder()- Parameters:
listQueriesRequest- AConsumerthat will call methods onListQueriesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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, dashboards, 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:
-
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, dashboards, or channels in the current Region.
This is a convenience which creates an instance of the
ListTagsRequest.Builderavoiding the need to create one manually viaListTagsRequest.builder()- Parameters:
listTagsRequest- AConsumerthat will call methods onListTagsRequest.Builderto create a request. Specifies a list of tags to return.- Returns:
- Result of the ListTags operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListTagsRequest.builder()- Parameters:
listTagsRequest- AConsumerthat will call methods onListTagsRequest.Builderto 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:
-
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:
-
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.Builderavoiding the need to create one manually viaListTrailsRequest.builder()- Parameters:
listTrailsRequest- AConsumerthat will call methods onListTrailsRequest.Builderto create a request.- Returns:
- Result of the ListTrails operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListTrailsRequest.builder()- Parameters:
listTrailsRequest- AConsumerthat will call methods onListTrailsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
LookupEventsreturns 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:
-
-
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.
LookupEventsreturns 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.Builderavoiding the need to create one manually viaLookupEventsRequest.builder()- Parameters:
lookupEventsRequest- AConsumerthat will call methods onLookupEventsRequest.Builderto create a request. Contains a request for LookupEvents.- Returns:
- Result of the LookupEvents operation returned by the service.
- See Also:
-
-
lookupEvents
default LookupEventsResponse lookupEvents() throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailExceptionLooks 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.
LookupEventsreturns 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:
-
-
lookupEventsPaginator
default LookupEventsIterable lookupEventsPaginator() throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailExceptionThis 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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaLookupEventsRequest.builder()- Parameters:
lookupEventsRequest- AConsumerthat will call methods onLookupEventsRequest.Builderto 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:
-
putEventConfiguration
default PutEventConfigurationResponse putEventConfiguration(PutEventConfigurationRequest putEventConfigurationRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidEventDataStoreCategoryException, InactiveEventDataStoreException, UnsupportedOperationException, OperationNotPermittedException, ThrottlingException, InvalidParameterException, InvalidParameterCombinationException, CloudTrailArnInvalidException, ConflictException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, InsufficientIamAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException Updates the event configuration settings for the specified event data store. You can update the maximum event size and context key selectors.
- Parameters:
putEventConfigurationRequest-- Returns:
- Result of the PutEventConfiguration operation returned by the service.
- See Also:
-
putEventConfiguration
default PutEventConfigurationResponse putEventConfiguration(Consumer<PutEventConfigurationRequest.Builder> putEventConfigurationRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidEventDataStoreCategoryException, InactiveEventDataStoreException, UnsupportedOperationException, OperationNotPermittedException, ThrottlingException, InvalidParameterException, InvalidParameterCombinationException, CloudTrailArnInvalidException, ConflictException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, InsufficientIamAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException Updates the event configuration settings for the specified event data store. You can update the maximum event size and context key selectors.
This is a convenience which creates an instance of the
PutEventConfigurationRequest.Builderavoiding the need to create one manually viaPutEventConfigurationRequest.builder()- Parameters:
putEventConfigurationRequest- AConsumerthat will call methods onPutEventConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutEventConfiguration operation returned by the service.
- See Also:
-
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
AdvancedEventSelectorsorEventSelectors, but not both. If you applyAdvancedEventSelectorsto a trail, any existingEventSelectorsare overwritten.You can use
AdvancedEventSelectorsto log management events, data events for all resource types, and network activity events.You can use
EventSelectorsto log management events and data events for the following resource types:-
AWS::DynamoDB::Table -
AWS::Lambda::Function -
AWS::S3::Object
You can't use
EventSelectorsto 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 Working with CloudTrail Insights 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
-
You create an event selector for a trail and specify that you want to log write-only events.
-
The EC2
GetConsoleOutputandRunInstancesAPI operations occur in your account. -
CloudTrail evaluates whether the events match your event selectors.
-
The
RunInstancesis a write-only event and it matches your event selector. The trail logs the event. -
The
GetConsoleOutputis a read-only event that doesn't match your event selector. The trail doesn't log the event.
The
PutEventSelectorsoperation must be called from the Region in which the trail was created; otherwise, anInvalidHomeRegionExceptionexception 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:
-
-
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
AdvancedEventSelectorsorEventSelectors, but not both. If you applyAdvancedEventSelectorsto a trail, any existingEventSelectorsare overwritten.You can use
AdvancedEventSelectorsto log management events, data events for all resource types, and network activity events.You can use
EventSelectorsto log management events and data events for the following resource types:-
AWS::DynamoDB::Table -
AWS::Lambda::Function -
AWS::S3::Object
You can't use
EventSelectorsto 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 Working with CloudTrail Insights 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
-
You create an event selector for a trail and specify that you want to log write-only events.
-
The EC2
GetConsoleOutputandRunInstancesAPI operations occur in your account. -
CloudTrail evaluates whether the events match your event selectors.
-
The
RunInstancesis a write-only event and it matches your event selector. The trail logs the event. -
The
GetConsoleOutputis a read-only event that doesn't match your event selector. The trail doesn't log the event.
The
PutEventSelectorsoperation must be called from the Region in which the trail was created; otherwise, anInvalidHomeRegionExceptionexception 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.Builderavoiding the need to create one manually viaPutEventSelectorsRequest.builder()- Parameters:
putEventSelectorsRequest- AConsumerthat will call methods onPutEventSelectorsRequest.Builderto create a request.- Returns:
- Result of the PutEventSelectors operation returned by the service.
- See Also:
-
-
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
PutInsightSelectorsto turn off Insights event logging, by passing an empty list of Insights types. The valid Insights event types areApiErrorRateInsightandApiCallRateInsight.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
writemanagement events. To log CloudTrail Insights events on API error rate, the trail or event data store must logreadorwritemanagement events. You can callGetEventSelectorson a trail to check whether the trail logs management events. You can callGetEventDataStoreon an event data store to check whether the event data store logs management events.For more information, see Working with CloudTrail Insights in the CloudTrail User Guide.
- Parameters:
putInsightSelectorsRequest-- Returns:
- Result of the PutInsightSelectors operation returned by the service.
- See Also:
-
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
PutInsightSelectorsto turn off Insights event logging, by passing an empty list of Insights types. The valid Insights event types areApiErrorRateInsightandApiCallRateInsight.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
writemanagement events. To log CloudTrail Insights events on API error rate, the trail or event data store must logreadorwritemanagement events. You can callGetEventSelectorson a trail to check whether the trail logs management events. You can callGetEventDataStoreon an event data store to check whether the event data store logs management events.For more information, see Working with CloudTrail Insights in the CloudTrail User Guide.
This is a convenience which creates an instance of the
PutInsightSelectorsRequest.Builderavoiding the need to create one manually viaPutInsightSelectorsRequest.builder()- Parameters:
putInsightSelectorsRequest- AConsumerthat will call methods onPutInsightSelectorsRequest.Builderto create a request.- Returns:
- Result of the PutInsightSelectors operation returned by the service.
- See Also:
-
putResourcePolicy
default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws ResourceArnNotValidException, ResourcePolicyNotValidException, ResourceNotFoundException, ResourceTypeNotSupportedException, ConflictException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. 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:
-
putResourcePolicy
default PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) throws ResourceArnNotValidException, ResourcePolicyNotValidException, ResourceNotFoundException, ResourceTypeNotSupportedException, ConflictException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. 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.Builderavoiding the need to create one manually viaPutResourcePolicyRequest.builder()- Parameters:
putResourcePolicyRequest- AConsumerthat will call methods onPutResourcePolicyRequest.Builderto create a request.- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- See Also:
-
registerOrganizationDelegatedAdmin
default RegisterOrganizationDelegatedAdminResponse registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest) throws AccountRegisteredException, AccountNotFoundException, InsufficientDependencyServiceAccessPermissionException, InvalidParameterException, CannotDelegateManagementAccountException, CloudTrailAccessNotEnabledException, ConflictException, DelegatedAdminAccountLimitExceededException, NotOrganizationManagementAccountException, OrganizationNotInAllFeaturesModeException, OrganizationsNotInUseException, UnsupportedOperationException, OperationNotPermittedException, InsufficientIamAccessPermissionException, 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:
-
registerOrganizationDelegatedAdmin
default RegisterOrganizationDelegatedAdminResponse registerOrganizationDelegatedAdmin(Consumer<RegisterOrganizationDelegatedAdminRequest.Builder> registerOrganizationDelegatedAdminRequest) throws AccountRegisteredException, AccountNotFoundException, InsufficientDependencyServiceAccessPermissionException, InvalidParameterException, CannotDelegateManagementAccountException, CloudTrailAccessNotEnabledException, ConflictException, DelegatedAdminAccountLimitExceededException, NotOrganizationManagementAccountException, OrganizationNotInAllFeaturesModeException, OrganizationsNotInUseException, UnsupportedOperationException, OperationNotPermittedException, InsufficientIamAccessPermissionException, 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.Builderavoiding the need to create one manually viaRegisterOrganizationDelegatedAdminRequest.builder()- Parameters:
registerOrganizationDelegatedAdminRequest- AConsumerthat will call methods onRegisterOrganizationDelegatedAdminRequest.Builderto 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:
-
removeTags
default RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, EventDataStoreArnInvalidException, ChannelArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, InvalidTagParameterException, InactiveEventDataStoreException, EventDataStoreNotFoundException, ChannelNotFoundException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, ConflictException, AwsServiceException, SdkClientException, CloudTrailException Removes the specified tags from a trail, event data store, dashboard, or channel.
- Parameters:
removeTagsRequest- Specifies the tags to remove from a trail, event data store, dashboard, or channel.- Returns:
- Result of the RemoveTags operation returned by the service.
- See Also:
-
removeTags
default RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, EventDataStoreArnInvalidException, ChannelArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, InvalidTagParameterException, InactiveEventDataStoreException, EventDataStoreNotFoundException, ChannelNotFoundException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, ConflictException, AwsServiceException, SdkClientException, CloudTrailException Removes the specified tags from a trail, event data store, dashboard, or channel.
This is a convenience which creates an instance of the
RemoveTagsRequest.Builderavoiding the need to create one manually viaRemoveTagsRequest.builder()- Parameters:
removeTagsRequest- AConsumerthat will call methods onRemoveTagsRequest.Builderto create a request. Specifies the tags to remove from a trail, event data store, dashboard, or channel.- Returns:
- Result of the RemoveTags operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaRestoreEventDataStoreRequest.builder()- Parameters:
restoreEventDataStoreRequest- AConsumerthat will call methods onRestoreEventDataStoreRequest.Builderto create a request.- Returns:
- Result of the RestoreEventDataStore operation returned by the service.
- See Also:
-
searchSampleQueries
default SearchSampleQueriesResponse searchSampleQueries(SearchSampleQueriesRequest searchSampleQueriesRequest) throws InvalidParameterException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException Searches sample queries and returns a list of sample queries that are sorted by relevance. To search for sample queries, provide a natural language
SearchPhrasein English.- Parameters:
searchSampleQueriesRequest-- Returns:
- Result of the SearchSampleQueries operation returned by the service.
- See Also:
-
searchSampleQueries
default SearchSampleQueriesResponse searchSampleQueries(Consumer<SearchSampleQueriesRequest.Builder> searchSampleQueriesRequest) throws InvalidParameterException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException Searches sample queries and returns a list of sample queries that are sorted by relevance. To search for sample queries, provide a natural language
SearchPhrasein English.
This is a convenience which creates an instance of the
SearchSampleQueriesRequest.Builderavoiding the need to create one manually viaSearchSampleQueriesRequest.builder()- Parameters:
searchSampleQueriesRequest- AConsumerthat will call methods onSearchSampleQueriesRequest.Builderto create a request.- Returns:
- Result of the SearchSampleQueries operation returned by the service.
- See Also:
-
startDashboardRefresh
default StartDashboardRefreshResponse startDashboardRefresh(StartDashboardRefreshRequest startDashboardRefreshRequest) throws ResourceNotFoundException, EventDataStoreNotFoundException, InactiveEventDataStoreException, ServiceQuotaExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Starts a refresh of the specified dashboard.
Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the
StartQueryoperation on your behalf. To provide permissions, run thePutResourcePolicyoperation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.- Parameters:
startDashboardRefreshRequest-- Returns:
- Result of the StartDashboardRefresh operation returned by the service.
- See Also:
-
startDashboardRefresh
default StartDashboardRefreshResponse startDashboardRefresh(Consumer<StartDashboardRefreshRequest.Builder> startDashboardRefreshRequest) throws ResourceNotFoundException, EventDataStoreNotFoundException, InactiveEventDataStoreException, ServiceQuotaExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Starts a refresh of the specified dashboard.
Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the
StartQueryoperation on your behalf. To provide permissions, run thePutResourcePolicyoperation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.
This is a convenience which creates an instance of the
StartDashboardRefreshRequest.Builderavoiding the need to create one manually viaStartDashboardRefreshRequest.builder()- Parameters:
startDashboardRefreshRequest- AConsumerthat will call methods onStartDashboardRefreshRequest.Builderto create a request.- Returns:
- Result of the StartDashboardRefresh operation returned by the service.
- See Also:
-
startEventDataStoreIngestion
default StartEventDataStoreIngestionResponse startEventDataStoreIngestion(StartEventDataStoreIngestionRequest startEventDataStoreIngestionRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidParameterException, InvalidEventDataStoreCategoryException, OperationNotPermittedException, UnsupportedOperationException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, ConflictException, 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
Statusmust beSTOPPED_INGESTIONand theeventCategorymust beManagement,Data,NetworkActivity, orConfigurationItem.- Parameters:
startEventDataStoreIngestionRequest-- Returns:
- Result of the StartEventDataStoreIngestion operation returned by the service.
- See Also:
-
startEventDataStoreIngestion
default StartEventDataStoreIngestionResponse startEventDataStoreIngestion(Consumer<StartEventDataStoreIngestionRequest.Builder> startEventDataStoreIngestionRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidParameterException, InvalidEventDataStoreCategoryException, OperationNotPermittedException, UnsupportedOperationException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, ConflictException, 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
Statusmust beSTOPPED_INGESTIONand theeventCategorymust beManagement,Data,NetworkActivity, orConfigurationItem.
This is a convenience which creates an instance of the
StartEventDataStoreIngestionRequest.Builderavoiding the need to create one manually viaStartEventDataStoreIngestionRequest.builder()- Parameters:
startEventDataStoreIngestionRequest- AConsumerthat will call methods onStartEventDataStoreIngestionRequest.Builderto create a request.- Returns:
- Result of the StartEventDataStoreIngestion operation returned by the service.
- See Also:
-
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
CloudTrailprefix and the prefixes inside theCloudTrailprefix, 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 theS3LocationUri. 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
DestinationsandImportSourceparameters 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
ImportIDparameter 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:
-
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
CloudTrailprefix and the prefixes inside theCloudTrailprefix, 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 theS3LocationUri. 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
DestinationsandImportSourceparameters 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
ImportIDparameter 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.Builderavoiding the need to create one manually viaStartImportRequest.builder()- Parameters:
startImportRequest- AConsumerthat will call methods onStartImportRequest.Builderto create a request.- Returns:
- Result of the StartImport operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaStartLoggingRequest.builder()- Parameters:
startLoggingRequest- AConsumerthat will call methods onStartLoggingRequest.Builderto 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:
-
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
QueryStatementparameter to provide your SQL query, enclosed in single quotation marks. Use the optionalDeliveryS3Uriparameter to deliver the query results to an S3 bucket.StartQueryrequires you specify either theQueryStatementparameter, or aQueryAliasand anyQueryParameters. In the current release, theQueryAliasandQueryParametersparameters 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:
-
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
QueryStatementparameter to provide your SQL query, enclosed in single quotation marks. Use the optionalDeliveryS3Uriparameter to deliver the query results to an S3 bucket.StartQueryrequires you specify either theQueryStatementparameter, or aQueryAliasand anyQueryParameters. In the current release, theQueryAliasandQueryParametersparameters are used only for the queries that populate the CloudTrail Lake dashboards.
This is a convenience which creates an instance of the
StartQueryRequest.Builderavoiding the need to create one manually viaStartQueryRequest.builder()- Parameters:
startQueryRequest- AConsumerthat will call methods onStartQueryRequest.Builderto create a request.- Returns:
- Result of the StartQuery operation returned by the service.
- See Also:
-
stopEventDataStoreIngestion
default StopEventDataStoreIngestionResponse stopEventDataStoreIngestion(StopEventDataStoreIngestionRequest stopEventDataStoreIngestionRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidParameterException, InvalidEventDataStoreCategoryException, OperationNotPermittedException, UnsupportedOperationException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, ConflictException, 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
Statusmust beENABLEDand theeventCategorymust beManagement,Data,NetworkActivity, orConfigurationItem.- Parameters:
stopEventDataStoreIngestionRequest-- Returns:
- Result of the StopEventDataStoreIngestion operation returned by the service.
- See Also:
-
stopEventDataStoreIngestion
default StopEventDataStoreIngestionResponse stopEventDataStoreIngestion(Consumer<StopEventDataStoreIngestionRequest.Builder> stopEventDataStoreIngestionRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidParameterException, InvalidEventDataStoreCategoryException, OperationNotPermittedException, UnsupportedOperationException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, ConflictException, 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
Statusmust beENABLEDand theeventCategorymust beManagement,Data,NetworkActivity, orConfigurationItem.
This is a convenience which creates an instance of the
StopEventDataStoreIngestionRequest.Builderavoiding the need to create one manually viaStopEventDataStoreIngestionRequest.builder()- Parameters:
stopEventDataStoreIngestionRequest- AConsumerthat will call methods onStopEventDataStoreIngestionRequest.Builderto create a request.- Returns:
- Result of the StopEventDataStoreIngestion operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaStopImportRequest.builder()- Parameters:
stopImportRequest- AConsumerthat will call methods onStopImportRequest.Builderto create a request.- Returns:
- Result of the StopImport operation returned by the service.
- See Also:
-
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
InvalidHomeRegionExceptionwill 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:
-
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
InvalidHomeRegionExceptionwill 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.Builderavoiding the need to create one manually viaStopLoggingRequest.builder()- Parameters:
stopLoggingRequest- AConsumerthat will call methods onStopLoggingRequest.Builderto 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:
-
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:
-
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.Builderavoiding the need to create one manually viaUpdateChannelRequest.builder()- Parameters:
updateChannelRequest- AConsumerthat will call methods onUpdateChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateChannel operation returned by the service.
- See Also:
-
updateDashboard
default UpdateDashboardResponse updateDashboard(UpdateDashboardRequest updateDashboardRequest) throws ConflictException, ResourceNotFoundException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InsufficientEncryptionPolicyException, InvalidQueryStatementException, ServiceQuotaExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Updates the specified dashboard.
To set a refresh schedule, CloudTrail must be granted permissions to run the
StartDashboardRefreshoperation to refresh the dashboard on your behalf. To provide permissions, run thePutResourcePolicyoperation to attach a resource-based policy to the dashboard. For more information, see Resource-based policy example for a dashboard in the CloudTrail User Guide.CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the
StartQueryoperation on your behalf. To provide permissions, run thePutResourcePolicyoperation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.- Parameters:
updateDashboardRequest-- Returns:
- Result of the UpdateDashboard operation returned by the service.
- See Also:
-
updateDashboard
default UpdateDashboardResponse updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest) throws ConflictException, ResourceNotFoundException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InsufficientEncryptionPolicyException, InvalidQueryStatementException, ServiceQuotaExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException Updates the specified dashboard.
To set a refresh schedule, CloudTrail must be granted permissions to run the
StartDashboardRefreshoperation to refresh the dashboard on your behalf. To provide permissions, run thePutResourcePolicyoperation to attach a resource-based policy to the dashboard. For more information, see Resource-based policy example for a dashboard in the CloudTrail User Guide.CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the
StartQueryoperation on your behalf. To provide permissions, run thePutResourcePolicyoperation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.
This is a convenience which creates an instance of the
UpdateDashboardRequest.Builderavoiding the need to create one manually viaUpdateDashboardRequest.builder()- Parameters:
updateDashboardRequest- AConsumerthat will call methods onUpdateDashboardRequest.Builderto create a request.- Returns:
- Result of the UpdateDashboard operation returned by the service.
- See Also:
-
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
EventDataStorevalue 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.RetentionPeriodis in days, and valid values are integers between 7 and 3653 if theBillingModeis set toEXTENDABLE_RETENTION_PRICING, or between 7 and 2557 ifBillingModeis set toFIXED_RETENTION_PRICING. By default,TerminationProtectionis enabled.For event data stores for CloudTrail events,
AdvancedEventSelectorsincludes or excludes management, data, or network activity events in your event data store. For more information aboutAdvancedEventSelectors, see AdvancedEventSelectors.For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
AdvancedEventSelectorsincludes events of that type in your event data store.- Parameters:
updateEventDataStoreRequest-- Returns:
- Result of the UpdateEventDataStore operation returned by the service.
- See Also:
-
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
EventDataStorevalue 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.RetentionPeriodis in days, and valid values are integers between 7 and 3653 if theBillingModeis set toEXTENDABLE_RETENTION_PRICING, or between 7 and 2557 ifBillingModeis set toFIXED_RETENTION_PRICING. By default,TerminationProtectionis enabled.For event data stores for CloudTrail events,
AdvancedEventSelectorsincludes or excludes management, data, or network activity events in your event data store. For more information aboutAdvancedEventSelectors, see AdvancedEventSelectors.For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
AdvancedEventSelectorsincludes events of that type in your event data store.
This is a convenience which creates an instance of the
UpdateEventDataStoreRequest.Builderavoiding the need to create one manually viaUpdateEventDataStoreRequest.builder()- Parameters:
updateEventDataStoreRequest- AConsumerthat will call methods onUpdateEventDataStoreRequest.Builderto create a request.- Returns:
- Result of the UpdateEventDataStore operation returned by the service.
- See Also:
-
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.
UpdateTrailmust be called from the Region in which the trail was created; otherwise, anInvalidHomeRegionExceptionis thrown.- Parameters:
updateTrailRequest- Specifies settings to update for the trail.- Returns:
- Result of the UpdateTrail operation returned by the service.
- See Also:
-
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.
UpdateTrailmust be called from the Region in which the trail was created; otherwise, anInvalidHomeRegionExceptionis thrown.
This is a convenience which creates an instance of the
UpdateTrailRequest.Builderavoiding the need to create one manually viaUpdateTrailRequest.builder()- Parameters:
updateTrailRequest- AConsumerthat will call methods onUpdateTrailRequest.Builderto create a request. Specifies settings to update for the trail.- Returns:
- Result of the UpdateTrail operation returned by the service.
- See Also:
-
create
Create aCloudTrailClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aCloudTrailClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-