Package software.amazon.awssdk.services.cloudtraildata

Interface CloudTrailDataClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

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 Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static CloudTrailDataClientBuilder	builder()	Create a builder that can be used to configure and create a CloudTrailDataClient.
static CloudTrailDataClient	create()	Create a CloudTrailDataClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default PutAuditEventsResponse	putAuditEvents(Consumer<PutAuditEventsRequest.Builder> putAuditEventsRequest)	Ingests your application events into CloudTrail Lake.
default PutAuditEventsResponse	putAuditEvents(PutAuditEventsRequest putAuditEventsRequest)	Ingests your application events into CloudTrail Lake.
default CloudTrailDataServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()

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

close

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

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

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

See Also:

Constant Field Values

Method Detail

putAuditEvents

default PutAuditEventsResponse putAuditEvents(PutAuditEventsRequest putAuditEventsRequest)
                                       throws ChannelInsufficientPermissionException,
                                              ChannelNotFoundException,
                                              InvalidChannelArnException,
                                              ChannelUnsupportedSchemaException,
                                              DuplicatedAuditEventIdException,
                                              UnsupportedOperationException,
                                              AwsServiceException,
                                              SdkClientException,
                                              CloudTrailDataException

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:

Result of the PutAuditEvents operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

putAuditEvents

default PutAuditEventsResponse putAuditEvents(Consumer<PutAuditEventsRequest.Builder> putAuditEventsRequest)
                                       throws ChannelInsufficientPermissionException,
                                              ChannelNotFoundException,
                                              InvalidChannelArnException,
                                              ChannelUnsupportedSchemaException,
                                              DuplicatedAuditEventIdException,
                                              UnsupportedOperationException,
                                              AwsServiceException,
                                              SdkClientException,
                                              CloudTrailDataException

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:

Result of the PutAuditEvents operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

create

static CloudTrailDataClient create()

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

builder

static CloudTrailDataClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default CloudTrailDataServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient