com.amazonaws.services.logs.AWSLogsClient Maven / Gradle / Ivy
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.logs;
import java.net.*;
import java.util.*;
import org.apache.commons.logging.*;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.auth.*;
import com.amazonaws.handlers.*;
import com.amazonaws.http.*;
import com.amazonaws.regions.*;
import com.amazonaws.internal.*;
import com.amazonaws.metrics.*;
import com.amazonaws.transform.*;
import com.amazonaws.util.*;
import static com.amazonaws.util.IOUtils.*;
import com.amazonaws.util.AWSRequestMetrics.Field;
import com.amazonaws.util.json.*;
import com.amazonaws.services.logs.model.*;
import com.amazonaws.services.logs.model.transform.*;
/**
* Client for accessing AWSLogs. All service calls made
* using this client are blocking, and will not return until the service call
* completes.
*
* 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
*
*
*
*/
public class AWSLogsClient extends AmazonWebServiceClient implements AWSLogs {
/** Provider for AWS credentials. */
private AWSCredentialsProvider awsCredentialsProvider;
private static final Log log = LogFactory.getLog(AWSLogs.class);
/**
* List of exception unmarshallers for all AWSLogs exceptions.
*/
protected List jsonErrorUnmarshallers;
/**
* Constructs a new 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 DefaultAWSCredentialsProviderChain
*/
public AWSLogsClient() {
this(new DefaultAWSCredentialsProviderChain(), new ClientConfiguration());
}
/**
* Constructs a new 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.
*
* @param clientConfiguration The client configuration options controlling how this
* client connects to AWSLogs
* (ex: proxy settings, retry counts, etc.).
*
* @see DefaultAWSCredentialsProviderChain
*/
public AWSLogsClient(ClientConfiguration clientConfiguration) {
this(new DefaultAWSCredentialsProviderChain(), clientConfiguration);
}
/**
* Constructs a new client to invoke service methods on
* AWSLogs using the specified AWS account credentials.
*
*
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentials The AWS credentials (access key ID and secret key) to use
* when authenticating with AWS services.
*/
public AWSLogsClient(AWSCredentials awsCredentials) {
this(awsCredentials, new ClientConfiguration());
}
/**
* Constructs a new client to invoke service methods on
* AWSLogs using the specified AWS account credentials
* and client configuration options.
*
*
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentials The AWS credentials (access key ID and secret key) to use
* when authenticating with AWS services.
* @param clientConfiguration The client configuration options controlling how this
* client connects to AWSLogs
* (ex: proxy settings, retry counts, etc.).
*/
public AWSLogsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) {
super(adjustClientConfiguration(clientConfiguration));
this.awsCredentialsProvider = new StaticCredentialsProvider(awsCredentials);
init();
}
/**
* Constructs a new client to invoke service methods on
* AWSLogs using the specified AWS account credentials provider.
*
*
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials
* to authenticate requests with AWS services.
*/
public AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider) {
this(awsCredentialsProvider, new ClientConfiguration());
}
/**
* Constructs a new client to invoke service methods on
* AWSLogs using the specified AWS account credentials
* provider and client configuration options.
*
*
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials
* to authenticate requests with AWS services.
* @param clientConfiguration The client configuration options controlling how this
* client connects to AWSLogs
* (ex: proxy settings, retry counts, etc.).
*/
public AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) {
this(awsCredentialsProvider, clientConfiguration, null);
}
/**
* Constructs a new client to invoke service methods on
* AWSLogs using the specified AWS account credentials
* provider, client configuration options and request metric collector.
*
*
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials
* to authenticate requests with AWS services.
* @param clientConfiguration The client configuration options controlling how this
* client connects to AWSLogs
* (ex: proxy settings, retry counts, etc.).
* @param requestMetricCollector optional request metric collector
*/
public AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector) {
super(adjustClientConfiguration(clientConfiguration), requestMetricCollector);
this.awsCredentialsProvider = awsCredentialsProvider;
init();
}
private void init() {
jsonErrorUnmarshallers = new ArrayList();
jsonErrorUnmarshallers.add(new InvalidParameterExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new OperationAbortedExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new ResourceAlreadyExistsExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new ResourceNotFoundExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new InvalidSequenceTokenExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new ServiceUnavailableExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new DataAlreadyAcceptedExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new LimitExceededExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new JsonErrorUnmarshaller());
// calling this.setEndPoint(...) will also modify the signer accordingly
this.setEndpoint("logs.us-east-1.amazonaws.com");
HandlerChainFactory chainFactory = new HandlerChainFactory();
requestHandler2s.addAll(chainFactory.newRequestHandlerChain(
"/com/amazonaws/services/logs/request.handlers"));
requestHandler2s.addAll(chainFactory.newRequestHandler2Chain(
"/com/amazonaws/services/logs/request.handler2s"));
}
private static ClientConfiguration adjustClientConfiguration(ClientConfiguration orig) {
ClientConfiguration config = orig;
return config;
}
/**
*
* 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.
*
*
* @param putRetentionPolicyRequest Container for the necessary
* parameters to execute the PutRetentionPolicy service method on
* AWSLogs.
*
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
* @throws OperationAbortedException
* @throws ResourceNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public void putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) {
ExecutionContext executionContext = createExecutionContext(putRetentionPolicyRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
Request request;
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new PutRetentionPolicyRequestMarshaller().marshall(putRetentionPolicyRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
JsonResponseHandler responseHandler = new JsonResponseHandler(null);
invoke(request, responseHandler, executionContext);
}
/**
*
* 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.
*
*
* @param describeMetricFiltersRequest Container for the necessary
* parameters to execute the DescribeMetricFilters service method on
* AWSLogs.
*
* @return The response from the DescribeMetricFilters service method, as
* returned by AWSLogs.
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
* @throws ResourceNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeMetricFiltersResult describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest) {
ExecutionContext executionContext = createExecutionContext(describeMetricFiltersRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeMetricFiltersRequestMarshaller().marshall(describeMetricFiltersRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller =
new DescribeMetricFiltersResultJsonUnmarshaller();
JsonResponseHandler responseHandler =
new JsonResponseHandler(unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* 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.
*
*
* @param describeLogStreamsRequest Container for the necessary
* parameters to execute the DescribeLogStreams service method on
* AWSLogs.
*
* @return The response from the DescribeLogStreams service method, as
* returned by AWSLogs.
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
* @throws ResourceNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLogStreamsResult describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest) {
ExecutionContext executionContext = createExecutionContext(describeLogStreamsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeLogStreamsRequestMarshaller().marshall(describeLogStreamsRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller =
new DescribeLogStreamsResultJsonUnmarshaller();
JsonResponseHandler responseHandler =
new JsonResponseHandler(unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* Deletes the log group with the specified name and permanently deletes
* all the archived log events associated with it.
*
*
* @param deleteLogGroupRequest Container for the necessary parameters to
* execute the DeleteLogGroup service method on AWSLogs.
*
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
* @throws OperationAbortedException
* @throws ResourceNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest) {
ExecutionContext executionContext = createExecutionContext(deleteLogGroupRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
Request request;
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DeleteLogGroupRequestMarshaller().marshall(deleteLogGroupRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
JsonResponseHandler responseHandler = new JsonResponseHandler(null);
invoke(request, responseHandler, executionContext);
}
/**
*
* 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).
*
*
*
*
*
* @param createLogGroupRequest Container for the necessary parameters to
* execute the CreateLogGroup service method on AWSLogs.
*
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
* @throws OperationAbortedException
* @throws ResourceAlreadyExistsException
* @throws LimitExceededException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public void createLogGroup(CreateLogGroupRequest createLogGroupRequest) {
ExecutionContext executionContext = createExecutionContext(createLogGroupRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
Request request;
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateLogGroupRequestMarshaller().marshall(createLogGroupRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
JsonResponseHandler responseHandler = new JsonResponseHandler(null);
invoke(request, responseHandler, executionContext);
}
/**
*
* 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.
*
*
* @param putMetricFilterRequest Container for the necessary parameters
* to execute the PutMetricFilter service method on AWSLogs.
*
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
* @throws OperationAbortedException
* @throws ResourceNotFoundException
* @throws LimitExceededException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public void putMetricFilter(PutMetricFilterRequest putMetricFilterRequest) {
ExecutionContext executionContext = createExecutionContext(putMetricFilterRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
Request request;
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new PutMetricFilterRequestMarshaller().marshall(putMetricFilterRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
JsonResponseHandler responseHandler = new JsonResponseHandler(null);
invoke(request, responseHandler, executionContext);
}
/**
*
* Deletes a metric filter associated with the specified log group.
*
*
* @param deleteMetricFilterRequest Container for the necessary
* parameters to execute the DeleteMetricFilter service method on
* AWSLogs.
*
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
* @throws OperationAbortedException
* @throws ResourceNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest) {
ExecutionContext executionContext = createExecutionContext(deleteMetricFilterRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
Request request;
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DeleteMetricFilterRequestMarshaller().marshall(deleteMetricFilterRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
JsonResponseHandler responseHandler = new JsonResponseHandler(null);
invoke(request, responseHandler, executionContext);
}
/**
*
* 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.
*
*
* @param testMetricFilterRequest Container for the necessary parameters
* to execute the TestMetricFilter service method on AWSLogs.
*
* @return The response from the TestMetricFilter service method, as
* returned by AWSLogs.
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public TestMetricFilterResult testMetricFilter(TestMetricFilterRequest testMetricFilterRequest) {
ExecutionContext executionContext = createExecutionContext(testMetricFilterRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new TestMetricFilterRequestMarshaller().marshall(testMetricFilterRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller =
new TestMetricFilterResultJsonUnmarshaller();
JsonResponseHandler responseHandler =
new JsonResponseHandler(unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* 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.
*
*
*
*
*
* @param putLogEventsRequest Container for the necessary parameters to
* execute the PutLogEvents service method on AWSLogs.
*
* @return The response from the PutLogEvents service method, as returned
* by AWSLogs.
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
* @throws OperationAbortedException
* @throws InvalidSequenceTokenException
* @throws DataAlreadyAcceptedException
* @throws ResourceNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public PutLogEventsResult putLogEvents(PutLogEventsRequest putLogEventsRequest) {
ExecutionContext executionContext = createExecutionContext(putLogEventsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new PutLogEventsRequestMarshaller().marshall(putLogEventsRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller =
new PutLogEventsResultJsonUnmarshaller();
JsonResponseHandler responseHandler =
new JsonResponseHandler(unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* Deletes the retention policy of the specified log group. Log events
* would not expire if they belong to log groups without a retention
* policy.
*
*
* @param deleteRetentionPolicyRequest Container for the necessary
* parameters to execute the DeleteRetentionPolicy service method on
* AWSLogs.
*
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
* @throws OperationAbortedException
* @throws ResourceNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) {
ExecutionContext executionContext = createExecutionContext(deleteRetentionPolicyRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
Request request;
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DeleteRetentionPolicyRequestMarshaller().marshall(deleteRetentionPolicyRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
JsonResponseHandler responseHandler = new JsonResponseHandler(null);
invoke(request, responseHandler, executionContext);
}
/**
*
* 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.
*
*
* @param getLogEventsRequest Container for the necessary parameters to
* execute the GetLogEvents service method on AWSLogs.
*
* @return The response from the GetLogEvents service method, as returned
* by AWSLogs.
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
* @throws ResourceNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public GetLogEventsResult getLogEvents(GetLogEventsRequest getLogEventsRequest) {
ExecutionContext executionContext = createExecutionContext(getLogEventsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetLogEventsRequestMarshaller().marshall(getLogEventsRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller =
new GetLogEventsResultJsonUnmarshaller();
JsonResponseHandler responseHandler =
new JsonResponseHandler(unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* 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.
*
*
*
*
*
* @param createLogStreamRequest Container for the necessary parameters
* to execute the CreateLogStream service method on AWSLogs.
*
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
* @throws ResourceNotFoundException
* @throws ResourceAlreadyExistsException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public void createLogStream(CreateLogStreamRequest createLogStreamRequest) {
ExecutionContext executionContext = createExecutionContext(createLogStreamRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
Request request;
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateLogStreamRequestMarshaller().marshall(createLogStreamRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
JsonResponseHandler responseHandler = new JsonResponseHandler(null);
invoke(request, responseHandler, executionContext);
}
/**
*
* Deletes a log stream and permanently deletes all the archived log
* events associated with it.
*
*
* @param deleteLogStreamRequest Container for the necessary parameters
* to execute the DeleteLogStream service method on AWSLogs.
*
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
* @throws OperationAbortedException
* @throws ResourceNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest) {
ExecutionContext executionContext = createExecutionContext(deleteLogStreamRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
Request request;
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DeleteLogStreamRequestMarshaller().marshall(deleteLogStreamRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
JsonResponseHandler responseHandler = new JsonResponseHandler(null);
invoke(request, responseHandler, executionContext);
}
/**
*
* 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.
*
*
* @param describeLogGroupsRequest Container for the necessary parameters
* to execute the DescribeLogGroups service method on AWSLogs.
*
* @return The response from the DescribeLogGroups service method, as
* returned by AWSLogs.
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLogGroupsResult describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest) {
ExecutionContext executionContext = createExecutionContext(describeLogGroupsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeLogGroupsRequestMarshaller().marshall(describeLogGroupsRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller =
new DescribeLogGroupsResultJsonUnmarshaller();
JsonResponseHandler responseHandler =
new JsonResponseHandler(unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* 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.
*
*
* @return The response from the DescribeLogGroups service method, as
* returned by AWSLogs.
*
* @throws ServiceUnavailableException
* @throws InvalidParameterException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AWSLogs indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLogGroupsResult describeLogGroups() throws AmazonServiceException, AmazonClientException {
return describeLogGroups(new DescribeLogGroupsRequest());
}
@Override
public void setEndpoint(String endpoint) {
super.setEndpoint(endpoint);
}
@Override
public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException {
super.setEndpoint(endpoint, serviceName, regionId);
}
/**
* 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 the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
private Response invoke(Request request,
HttpResponseHandler> responseHandler,
ExecutionContext executionContext) {
request.setEndpoint(endpoint);
request.setTimeOffset(timeOffset);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
AWSCredentials credentials;
awsRequestMetrics.startEvent(Field.CredentialsRequestTime);
try {
credentials = awsCredentialsProvider.getCredentials();
} finally {
awsRequestMetrics.endEvent(Field.CredentialsRequestTime);
}
AmazonWebServiceRequest originalRequest = request.getOriginalRequest();
if (originalRequest != null && originalRequest.getRequestCredentials() != null) {
credentials = originalRequest.getRequestCredentials();
}
executionContext.setCredentials(credentials);
JsonErrorResponseHandler errorResponseHandler = new JsonErrorResponseHandler(jsonErrorUnmarshallers);
Response result = client.execute(request, responseHandler,
errorResponseHandler, executionContext);
return result;
}
}