com.amazonaws.services.cloudtraildata

Interface AWSCloudTrailData

All Known Subinterfaces:

AWSCloudTrailDataAsync

All Known Implementing Classes:

AbstractAWSCloudTrailData, AbstractAWSCloudTrailDataAsync, AWSCloudTrailDataAsyncClient, AWSCloudTrailDataClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCloudTrailData

Interface for accessing AWS CloudTrail Data Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCloudTrailData instead.

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 and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
PutAuditEventsResult	putAuditEvents(PutAuditEventsRequest putAuditEventsRequest) Ingests your application events into CloudTrail Lake.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

putAuditEvents

PutAuditEventsResult 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:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.