Package software.amazon.awssdk.services.cloudtraildata

Interface CloudTrailDataAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface CloudTrailDataAsyncClient extends AwsClient
Service client for accessing AWS CloudTrail Data Service asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

The CloudTrail Data Service lets you ingest events into CloudTrail from any source in your hybrid environments, such as in-house or SaaS applications hosted on-premises or in the cloud, virtual machines, or containers. You can store, access, analyze, troubleshoot and take action on this data without maintaining multiple log aggregators and reporting tools. After you run PutAuditEvents to ingest your application activity into CloudTrail, you can use CloudTrail Lake to search, query, and analyze the data that is logged from your applications.

  • Field Details

  • Method Details

    • putAuditEvents

      default CompletableFuture<PutAuditEventsResponse> putAuditEvents(PutAuditEventsRequest putAuditEventsRequest)

      Ingests your application events into CloudTrail Lake. A required parameter, auditEvents, accepts the JSON records (also called payload) of events that you want CloudTrail to ingest. You can add up to 100 of these events (or up to 1 MB) per PutAuditEvents request.

      Parameters:
      putAuditEventsRequest -
      Returns:
      A Java Future containing the result of the PutAuditEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ChannelInsufficientPermissionException The caller's account ID must be the same as the channel owner's account ID.
      • ChannelNotFoundException The channel could not be found.
      • InvalidChannelArnException The specified channel ARN is not a valid channel ARN.
      • ChannelUnsupportedSchemaException The schema type of the event is not supported.
      • DuplicatedAuditEventIdException Two or more entries in the request have the same event ID.
      • UnsupportedOperationException The operation requested is not supported in this region or account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudTrailDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAuditEvents

      default CompletableFuture<PutAuditEventsResponse> putAuditEvents(Consumer<PutAuditEventsRequest.Builder> putAuditEventsRequest)

      Ingests your application events into CloudTrail Lake. A required parameter, auditEvents, accepts the JSON records (also called payload) of events that you want CloudTrail to ingest. You can add up to 100 of these events (or up to 1 MB) per PutAuditEvents request.


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

      Parameters:
      putAuditEventsRequest - A Consumer that will call methods on PutAuditEventsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutAuditEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ChannelInsufficientPermissionException The caller's account ID must be the same as the channel owner's account ID.
      • ChannelNotFoundException The channel could not be found.
      • InvalidChannelArnException The specified channel ARN is not a valid channel ARN.
      • ChannelUnsupportedSchemaException The schema type of the event is not supported.
      • DuplicatedAuditEventIdException Two or more entries in the request have the same event ID.
      • UnsupportedOperationException The operation requested is not supported in this region or account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudTrailDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default CloudTrailDataServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static CloudTrailDataAsyncClient create()
      Create a CloudTrailDataAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static CloudTrailDataAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a CloudTrailDataAsyncClient.