com.amazonaws.services.logs

Class AWSLogsAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.logs.AWSLogsClient

com.amazonaws.services.logs.AWSLogsAsyncClient

All Implemented Interfaces:

AWSLogs, AWSLogsAsync

public class AWSLogsAsyncClient
extends AWSLogsClient
implements AWSLogsAsync

Asynchronous client for accessing AWSLogs. All asynchronous calls made using this client are non-blocking. Callers could either process the result and handle the exceptions in the worker thread by providing a callback handler when making the call, or use the returned Future object to check the result of the call in the calling thread. Amazon CloudWatch Logs Service API Reference

This is the Amazon CloudWatch Logs API Reference . Amazon CloudWatch Logs is a managed service for real time monitoring and archival of application logs. This guide provides detailed information about Amazon CloudWatch Logs actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch Logs features and their associated API calls, go to the Amazon CloudWatch Logs Developer Guide .

Use the following links to get started using the Amazon CloudWatch Logs API Reference :

• Actions : An alphabetical list of all Amazon CloudWatch Logs actions.
• Data Types : An alphabetical list of all Amazon CloudWatch Logs data types.
• Common Parameters : Parameters that all Query actions can use.
• Common Errors : Client and server errors that all actions can return.
• Regions and Endpoints : Itemized regions and endpoints for all AWS products.

In addition to using the Amazon CloudWatch Logs API, you can also use the following SDKs and third-party libraries to access Amazon CloudWatch Logs programmatically.

• AWS SDK for Java Documentation
• AWS SDK for .NET Documentation
• AWS SDK for PHP Documentation
• AWS SDK for Ruby Documentation

Developers in the AWS developer community also provide their own libraries, which you can find at the following AWS developer centers:

• AWS Java Developer Center
• AWS PHP Developer Center
• AWS Python Developer Center
• AWS Ruby Developer Center
• AWS Windows and .NET Developer Center

Field Summary

Fields inherited from class com.amazonaws.services.logs.AWSLogsClient

jsonErrorUnmarshallers

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSLogsAsyncClient() Constructs a new asynchronous client to invoke service methods on AWSLogs.
AWSLogsAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials.
AWSLogsAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials, executor service, and client configuration options.
AWSLogsAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials and executor service.
AWSLogsAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials provider.
AWSLogsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials provider and client configuration options.
AWSLogsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials provider, executor service, and client configuration options.
AWSLogsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials provider and executor service.
AWSLogsAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AWSLogs.

Method Summary

Methods

Modifier and Type	Method and Description
Future<Void>	createLogGroupAsync(CreateLogGroupRequest createLogGroupRequest) Creates a new log group with the specified name.
Future<Void>	createLogGroupAsync(CreateLogGroupRequest createLogGroupRequest, AsyncHandler<CreateLogGroupRequest,Void> asyncHandler) Creates a new log group with the specified name.
Future<Void>	createLogStreamAsync(CreateLogStreamRequest createLogStreamRequest) Creates a new log stream in the specified log group.
Future<Void>	createLogStreamAsync(CreateLogStreamRequest createLogStreamRequest, AsyncHandler<CreateLogStreamRequest,Void> asyncHandler) Creates a new log stream in the specified log group.
Future<Void>	deleteLogGroupAsync(DeleteLogGroupRequest deleteLogGroupRequest) Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
Future<Void>	deleteLogGroupAsync(DeleteLogGroupRequest deleteLogGroupRequest, AsyncHandler<DeleteLogGroupRequest,Void> asyncHandler) Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
Future<Void>	deleteLogStreamAsync(DeleteLogStreamRequest deleteLogStreamRequest) Deletes a log stream and permanently deletes all the archived log events associated with it.
Future<Void>	deleteLogStreamAsync(DeleteLogStreamRequest deleteLogStreamRequest, AsyncHandler<DeleteLogStreamRequest,Void> asyncHandler) Deletes a log stream and permanently deletes all the archived log events associated with it.
Future<Void>	deleteMetricFilterAsync(DeleteMetricFilterRequest deleteMetricFilterRequest) Deletes a metric filter associated with the specified log group.
Future<Void>	deleteMetricFilterAsync(DeleteMetricFilterRequest deleteMetricFilterRequest, AsyncHandler<DeleteMetricFilterRequest,Void> asyncHandler) Deletes a metric filter associated with the specified log group.
Future<Void>	deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) Deletes the retention policy of the specified log group.
Future<Void>	deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest, AsyncHandler<DeleteRetentionPolicyRequest,Void> asyncHandler) Deletes the retention policy of the specified log group.
Future<DescribeLogGroupsResult>	describeLogGroupsAsync(DescribeLogGroupsRequest describeLogGroupsRequest) Returns all the log groups that are associated with the AWS account making the request.
Future<DescribeLogGroupsResult>	describeLogGroupsAsync(DescribeLogGroupsRequest describeLogGroupsRequest, AsyncHandler<DescribeLogGroupsRequest,DescribeLogGroupsResult> asyncHandler) Returns all the log groups that are associated with the AWS account making the request.
Future<DescribeLogStreamsResult>	describeLogStreamsAsync(DescribeLogStreamsRequest describeLogStreamsRequest) Returns all the log streams that are associated with the specified log group.
Future<DescribeLogStreamsResult>	describeLogStreamsAsync(DescribeLogStreamsRequest describeLogStreamsRequest, AsyncHandler<DescribeLogStreamsRequest,DescribeLogStreamsResult> asyncHandler) Returns all the log streams that are associated with the specified log group.
Future<DescribeMetricFiltersResult>	describeMetricFiltersAsync(DescribeMetricFiltersRequest describeMetricFiltersRequest) Returns all the metrics filters associated with the specified log group.
Future<DescribeMetricFiltersResult>	describeMetricFiltersAsync(DescribeMetricFiltersRequest describeMetricFiltersRequest, AsyncHandler<DescribeMetricFiltersRequest,DescribeMetricFiltersResult> asyncHandler) Returns all the metrics filters associated with the specified log group.
ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
Future<GetLogEventsResult>	getLogEventsAsync(GetLogEventsRequest getLogEventsRequest) Retrieves log events from the specified log stream.
Future<GetLogEventsResult>	getLogEventsAsync(GetLogEventsRequest getLogEventsRequest, AsyncHandler<GetLogEventsRequest,GetLogEventsResult> asyncHandler) Retrieves log events from the specified log stream.
Future<PutLogEventsResult>	putLogEventsAsync(PutLogEventsRequest putLogEventsRequest) Uploads a batch of log events to the specified log stream.
Future<PutLogEventsResult>	putLogEventsAsync(PutLogEventsRequest putLogEventsRequest, AsyncHandler<PutLogEventsRequest,PutLogEventsResult> asyncHandler) Uploads a batch of log events to the specified log stream.
Future<Void>	putMetricFilterAsync(PutMetricFilterRequest putMetricFilterRequest) Creates or updates a metric filter and associates it with the specified log group.
Future<Void>	putMetricFilterAsync(PutMetricFilterRequest putMetricFilterRequest, AsyncHandler<PutMetricFilterRequest,Void> asyncHandler) Creates or updates a metric filter and associates it with the specified log group.
Future<Void>	putRetentionPolicyAsync(PutRetentionPolicyRequest putRetentionPolicyRequest) Sets the retention of the specified log group.
Future<Void>	putRetentionPolicyAsync(PutRetentionPolicyRequest putRetentionPolicyRequest, AsyncHandler<PutRetentionPolicyRequest,Void> asyncHandler) Sets the retention of the specified log group.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TestMetricFilterResult>	testMetricFilterAsync(TestMetricFilterRequest testMetricFilterRequest) Tests the filter pattern of a metric filter against a sample of log event messages.
Future<TestMetricFilterResult>	testMetricFilterAsync(TestMetricFilterRequest testMetricFilterRequest, AsyncHandler<TestMetricFilterRequest,TestMetricFilterResult> asyncHandler) Tests the filter pattern of a metric filter against a sample of log event messages.

Methods inherited from class com.amazonaws.services.logs.AWSLogsClient

createLogGroup, createLogStream, deleteLogGroup, deleteLogStream, deleteMetricFilter, deleteRetentionPolicy, describeLogGroups, describeLogGroups, describeLogStreams, describeMetricFilters, getCachedResponseMetadata, getLogEvents, putLogEvents, putMetricFilter, putRetentionPolicy, setEndpoint, setEndpoint, testMetricFilter

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.logs.AWSLogs

createLogGroup, createLogStream, deleteLogGroup, deleteLogStream, deleteMetricFilter, deleteRetentionPolicy, describeLogGroups, describeLogGroups, describeLogStreams, describeMetricFilters, getCachedResponseMetadata, getLogEvents, putLogEvents, putMetricFilter, putRetentionPolicy, setEndpoint, setRegion, testMetricFilter

Constructor Detail

AWSLogsAsyncClient

public AWSLogsAsyncClient()

Constructs a new asynchronous client to invoke service methods on AWSLogs. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSLogsAsyncClient

public AWSLogsAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AWSLogs. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWSLogs (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSLogsAsyncClient

public AWSLogsAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSLogsAsyncClient

public AWSLogsAsyncClient(AWSCredentials awsCredentials,
                  ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSLogsAsyncClient

public AWSLogsAsyncClient(AWSCredentials awsCredentials,
                  ClientConfiguration clientConfiguration,
                  ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AWSLogsAsyncClient

public AWSLogsAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials provider. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSLogsAsyncClient

public AWSLogsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                  ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials provider and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSLogsAsyncClient

public AWSLogsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                  ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials provider and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

AWSLogsAsyncClient

public AWSLogsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                  ClientConfiguration clientConfiguration,
                  ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AWSLogs using the specified AWS account credentials provider, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this async client to execute requests.

Returns:

The executor service used by this async client to execute requests.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSLogs

Overrides:

shutdown in class AmazonWebServiceClient

putRetentionPolicyAsync

public Future<Void> putRetentionPolicyAsync(PutRetentionPolicyRequest putRetentionPolicyRequest)
                                     throws AmazonServiceException,
                                            AmazonClientException

Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.

Specified by:

putRetentionPolicyAsync in interface AWSLogsAsync

Parameters:

putRetentionPolicyRequest - Container for the necessary parameters to execute the PutRetentionPolicy operation on AWSLogs.

Returns:

A Java Future object containing the response from the PutRetentionPolicy service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

putRetentionPolicyAsync

public Future<Void> putRetentionPolicyAsync(PutRetentionPolicyRequest putRetentionPolicyRequest,
                                   AsyncHandler<PutRetentionPolicyRequest,Void> asyncHandler)
                                     throws AmazonServiceException,
                                            AmazonClientException

Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.

Specified by:

putRetentionPolicyAsync in interface AWSLogsAsync

Parameters:

putRetentionPolicyRequest - Container for the necessary parameters to execute the PutRetentionPolicy operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the PutRetentionPolicy service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

describeMetricFiltersAsync

public Future<DescribeMetricFiltersResult> describeMetricFiltersAsync(DescribeMetricFiltersRequest describeMetricFiltersRequest)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.

By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a nextToken value in the response body. You can also limit the number of metric filters returned in the response by specifying the limit parameter in the request.

Specified by:

describeMetricFiltersAsync in interface AWSLogsAsync

Parameters:

describeMetricFiltersRequest - Container for the necessary parameters to execute the DescribeMetricFilters operation on AWSLogs.

Returns:

A Java Future object containing the response from the DescribeMetricFilters service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

describeMetricFiltersAsync

public Future<DescribeMetricFiltersResult> describeMetricFiltersAsync(DescribeMetricFiltersRequest describeMetricFiltersRequest,
                                                             AsyncHandler<DescribeMetricFiltersRequest,DescribeMetricFiltersResult> asyncHandler)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.

By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a nextToken value in the response body. You can also limit the number of metric filters returned in the response by specifying the limit parameter in the request.

Specified by:

describeMetricFiltersAsync in interface AWSLogsAsync

Parameters:

describeMetricFiltersRequest - Container for the necessary parameters to execute the DescribeMetricFilters operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DescribeMetricFilters service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

describeLogStreamsAsync

public Future<DescribeLogStreamsResult> describeLogStreamsAsync(DescribeLogStreamsRequest describeLogStreamsRequest)
                                                         throws AmazonServiceException,
                                                                AmazonClientException

Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.

By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a nextToken value in the response body. You can also limit the number of log streams returned in the response by specifying the limit parameter in the request.

Specified by:

describeLogStreamsAsync in interface AWSLogsAsync

Parameters:

describeLogStreamsRequest - Container for the necessary parameters to execute the DescribeLogStreams operation on AWSLogs.

Returns:

A Java Future object containing the response from the DescribeLogStreams service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

describeLogStreamsAsync

public Future<DescribeLogStreamsResult> describeLogStreamsAsync(DescribeLogStreamsRequest describeLogStreamsRequest,
                                                       AsyncHandler<DescribeLogStreamsRequest,DescribeLogStreamsResult> asyncHandler)
                                                         throws AmazonServiceException,
                                                                AmazonClientException

Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.

By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a nextToken value in the response body. You can also limit the number of log streams returned in the response by specifying the limit parameter in the request.

Specified by:

describeLogStreamsAsync in interface AWSLogsAsync

Parameters:

describeLogStreamsRequest - Container for the necessary parameters to execute the DescribeLogStreams operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DescribeLogStreams service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

deleteLogGroupAsync

public Future<Void> deleteLogGroupAsync(DeleteLogGroupRequest deleteLogGroupRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.

Specified by:

deleteLogGroupAsync in interface AWSLogsAsync

Parameters:

deleteLogGroupRequest - Container for the necessary parameters to execute the DeleteLogGroup operation on AWSLogs.

Returns:

A Java Future object containing the response from the DeleteLogGroup service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

deleteLogGroupAsync

public Future<Void> deleteLogGroupAsync(DeleteLogGroupRequest deleteLogGroupRequest,
                               AsyncHandler<DeleteLogGroupRequest,Void> asyncHandler)
                                 throws AmazonServiceException,
                                        AmazonClientException

Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.

Specified by:

deleteLogGroupAsync in interface AWSLogsAsync

Parameters:

deleteLogGroupRequest - Container for the necessary parameters to execute the DeleteLogGroup operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DeleteLogGroup service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

createLogGroupAsync

public Future<Void> createLogGroupAsync(CreateLogGroupRequest createLogGroupRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.

You must use the following guidelines when naming a log group:

• Log group names can be between 1 and 512 characters long.
• Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Specified by:

createLogGroupAsync in interface AWSLogsAsync

Parameters:

createLogGroupRequest - Container for the necessary parameters to execute the CreateLogGroup operation on AWSLogs.

Returns:

A Java Future object containing the response from the CreateLogGroup service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

createLogGroupAsync

public Future<Void> createLogGroupAsync(CreateLogGroupRequest createLogGroupRequest,
                               AsyncHandler<CreateLogGroupRequest,Void> asyncHandler)
                                 throws AmazonServiceException,
                                        AmazonClientException

Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.

You must use the following guidelines when naming a log group:

• Log group names can be between 1 and 512 characters long.
• Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Specified by:

createLogGroupAsync in interface AWSLogsAsync

Parameters:

createLogGroupRequest - Container for the necessary parameters to execute the CreateLogGroup operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the CreateLogGroup service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

putMetricFilterAsync

public Future<Void> putMetricFilterAsync(PutMetricFilterRequest putMetricFilterRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents requests.

Specified by:

putMetricFilterAsync in interface AWSLogsAsync

Parameters:

putMetricFilterRequest - Container for the necessary parameters to execute the PutMetricFilter operation on AWSLogs.

Returns:

A Java Future object containing the response from the PutMetricFilter service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

putMetricFilterAsync

public Future<Void> putMetricFilterAsync(PutMetricFilterRequest putMetricFilterRequest,
                                AsyncHandler<PutMetricFilterRequest,Void> asyncHandler)
                                  throws AmazonServiceException,
                                         AmazonClientException

Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents requests.

Specified by:

putMetricFilterAsync in interface AWSLogsAsync

Parameters:

putMetricFilterRequest - Container for the necessary parameters to execute the PutMetricFilter operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the PutMetricFilter service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

deleteMetricFilterAsync

public Future<Void> deleteMetricFilterAsync(DeleteMetricFilterRequest deleteMetricFilterRequest)
                                     throws AmazonServiceException,
                                            AmazonClientException

Deletes a metric filter associated with the specified log group.

Specified by:

deleteMetricFilterAsync in interface AWSLogsAsync

Parameters:

deleteMetricFilterRequest - Container for the necessary parameters to execute the DeleteMetricFilter operation on AWSLogs.

Returns:

A Java Future object containing the response from the DeleteMetricFilter service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

deleteMetricFilterAsync

public Future<Void> deleteMetricFilterAsync(DeleteMetricFilterRequest deleteMetricFilterRequest,
                                   AsyncHandler<DeleteMetricFilterRequest,Void> asyncHandler)
                                     throws AmazonServiceException,
                                            AmazonClientException

Deletes a metric filter associated with the specified log group.

Specified by:

deleteMetricFilterAsync in interface AWSLogsAsync

Parameters:

deleteMetricFilterRequest - Container for the necessary parameters to execute the DeleteMetricFilter operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DeleteMetricFilter service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

testMetricFilterAsync

public Future<TestMetricFilterResult> testMetricFilterAsync(TestMetricFilterRequest testMetricFilterRequest)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

Specified by:

testMetricFilterAsync in interface AWSLogsAsync

Parameters:

testMetricFilterRequest - Container for the necessary parameters to execute the TestMetricFilter operation on AWSLogs.

Returns:

A Java Future object containing the response from the TestMetricFilter service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

testMetricFilterAsync

public Future<TestMetricFilterResult> testMetricFilterAsync(TestMetricFilterRequest testMetricFilterRequest,
                                                   AsyncHandler<TestMetricFilterRequest,TestMetricFilterResult> asyncHandler)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

Specified by:

testMetricFilterAsync in interface AWSLogsAsync

Parameters:

testMetricFilterRequest - Container for the necessary parameters to execute the TestMetricFilter operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the TestMetricFilter service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

putLogEventsAsync

public Future<PutLogEventsResult> putLogEventsAsync(PutLogEventsRequest putLogEventsRequest)
                                             throws AmazonServiceException,
                                                    AmazonClientException

Uploads a batch of log events to the specified log stream.

Every PutLogEvents request must include the sequenceToken obtained from the response of the previous request. An upload in a newly created log stream does not require a sequenceToken .

The batch of events must satisfy the following constraints:

• The maximum batch size is 32,768 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
• None of the log events in the batch can be more than 2 hours in the future.
• None of the log events in the batch can be older than 14 days or the retention period of the log group.
• The log events in the batch must be in chronological ordered by their timestamp .
• The maximum number of log events in a batch is 1,000.

Specified by:

putLogEventsAsync in interface AWSLogsAsync

Parameters:

putLogEventsRequest - Container for the necessary parameters to execute the PutLogEvents operation on AWSLogs.

Returns:

A Java Future object containing the response from the PutLogEvents service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

putLogEventsAsync

public Future<PutLogEventsResult> putLogEventsAsync(PutLogEventsRequest putLogEventsRequest,
                                           AsyncHandler<PutLogEventsRequest,PutLogEventsResult> asyncHandler)
                                             throws AmazonServiceException,
                                                    AmazonClientException

Uploads a batch of log events to the specified log stream.

Every PutLogEvents request must include the sequenceToken obtained from the response of the previous request. An upload in a newly created log stream does not require a sequenceToken .

The batch of events must satisfy the following constraints:

• The maximum batch size is 32,768 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
• None of the log events in the batch can be more than 2 hours in the future.
• None of the log events in the batch can be older than 14 days or the retention period of the log group.
• The log events in the batch must be in chronological ordered by their timestamp .
• The maximum number of log events in a batch is 1,000.

Specified by:

putLogEventsAsync in interface AWSLogsAsync

Parameters:

putLogEventsRequest - Container for the necessary parameters to execute the PutLogEvents operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the PutLogEvents service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

deleteRetentionPolicyAsync

public Future<Void> deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.

Specified by:

deleteRetentionPolicyAsync in interface AWSLogsAsync

Parameters:

deleteRetentionPolicyRequest - Container for the necessary parameters to execute the DeleteRetentionPolicy operation on AWSLogs.

Returns:

A Java Future object containing the response from the DeleteRetentionPolicy service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

deleteRetentionPolicyAsync

public Future<Void> deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest,
                                      AsyncHandler<DeleteRetentionPolicyRequest,Void> asyncHandler)
                                        throws AmazonServiceException,
                                               AmazonClientException

Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.

Specified by:

deleteRetentionPolicyAsync in interface AWSLogsAsync

Parameters:

deleteRetentionPolicyRequest - Container for the necessary parameters to execute the DeleteRetentionPolicy operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DeleteRetentionPolicy service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

getLogEventsAsync

public Future<GetLogEventsResult> getLogEventsAsync(GetLogEventsRequest getLogEventsRequest)
                                             throws AmazonServiceException,
                                                    AmazonClientException

Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp .

By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken and a nextBackwardToken in the response body. You can use any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit parameter in the request.

Specified by:

getLogEventsAsync in interface AWSLogsAsync

Parameters:

getLogEventsRequest - Container for the necessary parameters to execute the GetLogEvents operation on AWSLogs.

Returns:

A Java Future object containing the response from the GetLogEvents service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

getLogEventsAsync

public Future<GetLogEventsResult> getLogEventsAsync(GetLogEventsRequest getLogEventsRequest,
                                           AsyncHandler<GetLogEventsRequest,GetLogEventsResult> asyncHandler)
                                             throws AmazonServiceException,
                                                    AmazonClientException

Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp .

By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken and a nextBackwardToken in the response body. You can use any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit parameter in the request.

Specified by:

getLogEventsAsync in interface AWSLogsAsync

Parameters:

getLogEventsRequest - Container for the necessary parameters to execute the GetLogEvents operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the GetLogEvents service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

createLogStreamAsync

public Future<Void> createLogStreamAsync(CreateLogStreamRequest createLogStreamRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.

You must use the following guidelines when naming a log stream:

• Log stream names can be between 1 and 512 characters long.
• The ':' colon character is not allowed.

Specified by:

createLogStreamAsync in interface AWSLogsAsync

Parameters:

createLogStreamRequest - Container for the necessary parameters to execute the CreateLogStream operation on AWSLogs.

Returns:

A Java Future object containing the response from the CreateLogStream service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

createLogStreamAsync

public Future<Void> createLogStreamAsync(CreateLogStreamRequest createLogStreamRequest,
                                AsyncHandler<CreateLogStreamRequest,Void> asyncHandler)
                                  throws AmazonServiceException,
                                         AmazonClientException

Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.

You must use the following guidelines when naming a log stream:

• Log stream names can be between 1 and 512 characters long.
• The ':' colon character is not allowed.

Specified by:

createLogStreamAsync in interface AWSLogsAsync

Parameters:

createLogStreamRequest - Container for the necessary parameters to execute the CreateLogStream operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the CreateLogStream service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

deleteLogStreamAsync

public Future<Void> deleteLogStreamAsync(DeleteLogStreamRequest deleteLogStreamRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Deletes a log stream and permanently deletes all the archived log events associated with it.

Specified by:

deleteLogStreamAsync in interface AWSLogsAsync

Parameters:

deleteLogStreamRequest - Container for the necessary parameters to execute the DeleteLogStream operation on AWSLogs.

Returns:

A Java Future object containing the response from the DeleteLogStream service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

deleteLogStreamAsync

public Future<Void> deleteLogStreamAsync(DeleteLogStreamRequest deleteLogStreamRequest,
                                AsyncHandler<DeleteLogStreamRequest,Void> asyncHandler)
                                  throws AmazonServiceException,
                                         AmazonClientException

Deletes a log stream and permanently deletes all the archived log events associated with it.

Specified by:

deleteLogStreamAsync in interface AWSLogsAsync

Parameters:

deleteLogStreamRequest - Container for the necessary parameters to execute the DeleteLogStream operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DeleteLogStream service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

describeLogGroupsAsync

public Future<DescribeLogGroupsResult> describeLogGroupsAsync(DescribeLogGroupsRequest describeLogGroupsRequest)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.

By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a nextToken value in the response body. You can also limit the number of log groups returned in the response by specifying the limit parameter in the request.

Specified by:

describeLogGroupsAsync in interface AWSLogsAsync

Parameters:

describeLogGroupsRequest - Container for the necessary parameters to execute the DescribeLogGroups operation on AWSLogs.

Returns:

A Java Future object containing the response from the DescribeLogGroups service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.

describeLogGroupsAsync

public Future<DescribeLogGroupsResult> describeLogGroupsAsync(DescribeLogGroupsRequest describeLogGroupsRequest,
                                                     AsyncHandler<DescribeLogGroupsRequest,DescribeLogGroupsResult> asyncHandler)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.

By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a nextToken value in the response body. You can also limit the number of log groups returned in the response by specifying the limit parameter in the request.

Specified by:

describeLogGroupsAsync in interface AWSLogsAsync

Parameters:

describeLogGroupsRequest - Container for the necessary parameters to execute the DescribeLogGroups operation on AWSLogs.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DescribeLogGroups service method, as returned by AWSLogs.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSLogs indicating either a problem with the data in the request, or a server side issue.