com.amazonaws.services.logs

Interface AWSLogs

All Known Subinterfaces:

AWSLogsAsync

All Known Implementing Classes:

AWSLogsAsyncClient, AWSLogsClient

public interface AWSLogs

Interface for accessing AWSLogs. 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

Method Summary

Methods

Modifier and Type	Method and Description
void	createLogGroup(CreateLogGroupRequest createLogGroupRequest) Creates a new log group with the specified name.
void	createLogStream(CreateLogStreamRequest createLogStreamRequest) Creates a new log stream in the specified log group.
void	deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest) Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
void	deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest) Deletes a log stream and permanently deletes all the archived log events associated with it.
void	deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest) Deletes a metric filter associated with the specified log group.
void	deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) Deletes the retention policy of the specified log group.
DescribeLogGroupsResult	describeLogGroups() Returns all the log groups that are associated with the AWS account making the request.
DescribeLogGroupsResult	describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest) Returns all the log groups that are associated with the AWS account making the request.
DescribeLogStreamsResult	describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest) Returns all the log streams that are associated with the specified log group.
DescribeMetricFiltersResult	describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest) Returns all the metrics filters associated with the specified log group.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetLogEventsResult	getLogEvents(GetLogEventsRequest getLogEventsRequest) Retrieves log events from the specified log stream.
PutLogEventsResult	putLogEvents(PutLogEventsRequest putLogEventsRequest) Uploads a batch of log events to the specified log stream.
void	putMetricFilter(PutMetricFilterRequest putMetricFilterRequest) Creates or updates a metric filter and associates it with the specified log group.
void	putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) Sets the retention of the specified log group.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://logs.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TestMetricFilterResult	testMetricFilter(TestMetricFilterRequest testMetricFilterRequest) Tests the filter pattern of a metric filter against a sample of log event messages.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://logs.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "logs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://logs.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "logs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://logs.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

putRetentionPolicy

void putRetentionPolicy(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.

Parameters:

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

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceNotFoundException

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.

describeMetricFilters

DescribeMetricFiltersResult describeMetricFilters(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.

Parameters:

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

Returns:

The response from the DescribeMetricFilters service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

ResourceNotFoundException

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.

describeLogStreams

DescribeLogStreamsResult describeLogStreams(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.

Parameters:

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

Returns:

The response from the DescribeLogStreams service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

ResourceNotFoundException

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.

deleteLogGroup

void deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest)
                    throws AmazonServiceException,
                           AmazonClientException

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

Parameters:

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

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceNotFoundException

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.

createLogGroup

void createLogGroup(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).

Parameters:

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

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceAlreadyExistsException

LimitExceededException

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.

putMetricFilter

void putMetricFilter(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.

Parameters:

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

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceNotFoundException

LimitExceededException

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.

deleteMetricFilter

void deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Deletes a metric filter associated with the specified log group.

Parameters:

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

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceNotFoundException

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.

testMetricFilter

TestMetricFilterResult testMetricFilter(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.

Parameters:

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

Returns:

The response from the TestMetricFilter service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

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.

putLogEvents

PutLogEventsResult putLogEvents(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.

Parameters:

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

Returns:

The response from the PutLogEvents service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

InvalidSequenceTokenException

DataAlreadyAcceptedException

ResourceNotFoundException

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.

deleteRetentionPolicy

void deleteRetentionPolicy(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.

Parameters:

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

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceNotFoundException

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.

getLogEvents

GetLogEventsResult getLogEvents(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.

Parameters:

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

Returns:

The response from the GetLogEvents service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

ResourceNotFoundException

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.

createLogStream

void createLogStream(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.

Parameters:

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

Throws:

ServiceUnavailableException

InvalidParameterException

ResourceNotFoundException

ResourceAlreadyExistsException

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.

deleteLogStream

void deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest)
                     throws AmazonServiceException,
                            AmazonClientException

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

Parameters:

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

Throws:

ServiceUnavailableException

InvalidParameterException

OperationAbortedException

ResourceNotFoundException

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.

describeLogGroups

DescribeLogGroupsResult describeLogGroups(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.

Parameters:

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

Returns:

The response from the DescribeLogGroups service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

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.

describeLogGroups

DescribeLogGroupsResult describeLogGroups()
                                          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.

Returns:

The response from the DescribeLogGroups service method, as returned by AWSLogs.

Throws:

ServiceUnavailableException

InvalidParameterException

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.

shutdown

void shutdown()

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

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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

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

Parameters:

request - The originally executed request.

Returns:

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