com.amazonaws.services.logs

Class AWSLogsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.logs.AWSLogsClient

All Implemented Interfaces:

AWSLogs

Direct Known Subclasses:

AWSLogsAsyncClient

@ThreadSafe
public class AWSLogsClient
extends AmazonWebServiceClient
implements AWSLogs

Client for accessing Amazon CloudWatch Logs. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon CloudWatch Logs API Reference

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon Elastic Compute Cloud (Amazon EC2) instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK.

You can use CloudWatch Logs to:

• Monitor Logs from Amazon EC2 Instances in Real-time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify.

• Monitor Amazon CloudTrail Logged Events: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.

• Archive Log Data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSLogsClient() Constructs a new client to invoke service methods on Amazon CloudWatch Logs.
AWSLogsClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials.
AWSLogsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials and client configuration options.
AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials provider.
AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials provider and client configuration options.
AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials provider, client configuration options, and request metric collector.
AWSLogsClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon CloudWatch Logs.

Method Summary

Modifier and Type	Method and Description
CancelExportTaskResult	cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) Cancels an export task if it is in PENDING or RUNNING state.
CreateExportTaskResult	createExportTask(CreateExportTaskRequest createExportTaskRequest) Creates an ExportTask which allows you to efficiently export data from a Log Group to your Amazon S3 bucket.
CreateLogGroupResult	createLogGroup(CreateLogGroupRequest createLogGroupRequest) Creates a new log group with the specified name.
CreateLogStreamResult	createLogStream(CreateLogStreamRequest createLogStreamRequest) Creates a new log stream in the specified log group.
DeleteDestinationResult	deleteDestination(DeleteDestinationRequest deleteDestinationRequest) Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it.
DeleteLogGroupResult	deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest) Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
DeleteLogStreamResult	deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest) Deletes a log stream and permanently deletes all the archived log events associated with it.
DeleteMetricFilterResult	deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest) Deletes a metric filter associated with the specified log group.
DeleteRetentionPolicyResult	deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) Deletes the retention policy of the specified log group.
DeleteSubscriptionFilterResult	deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest) Deletes a subscription filter associated with the specified log group.
DescribeDestinationsResult	describeDestinations() Simplified method form for invoking the DescribeDestinations operation.
DescribeDestinationsResult	describeDestinations(DescribeDestinationsRequest describeDestinationsRequest) Returns all the destinations that are associated with the AWS account making the request.
DescribeExportTasksResult	describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) Returns all the export tasks that are associated with the AWS account making the request.
DescribeLogGroupsResult	describeLogGroups() Simplified method form for invoking the DescribeLogGroups operation.
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.
DescribeSubscriptionFiltersResult	describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest) Returns all the subscription filters associated with the specified log group.
FilterLogEventsResult	filterLogEvents(FilterLogEventsRequest filterLogEventsRequest) Retrieves log events, optionally filtered by a filter pattern from 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.
PutDestinationResult	putDestination(PutDestinationRequest putDestinationRequest) Creates or updates a Destination.
PutDestinationPolicyResult	putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest) Creates or updates an access policy associated with an existing Destination.
PutLogEventsResult	putLogEvents(PutLogEventsRequest putLogEventsRequest) Uploads a batch of log events to the specified log stream.
PutMetricFilterResult	putMetricFilter(PutMetricFilterRequest putMetricFilterRequest) Creates or updates a metric filter and associates it with the specified log group.
PutRetentionPolicyResult	putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) Sets the retention of the specified log group.
PutSubscriptionFilterResult	putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest) Creates or updates a subscription filter and associates it with the specified log group.
TestMetricFilterResult	testMetricFilter(TestMetricFilterRequest testMetricFilterRequest) Tests the filter pattern of a metric filter against a sample of log event messages.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion, shutdown

Constructor Detail

AWSLogsClient

public AWSLogsClient()

Constructs a new client to invoke service methods on Amazon CloudWatch Logs. 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

AWSLogsClient

public AWSLogsClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Amazon CloudWatch Logs. 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 Amazon CloudWatch Logs (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSLogsClient

public AWSLogsClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on Amazon CloudWatch Logs 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.

Parameters:

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

AWSLogsClient

public AWSLogsClient(AWSCredentials awsCredentials,
                     ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Amazon CloudWatch Logs 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.

Parameters:

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

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

AWSLogsClient

public AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on Amazon CloudWatch Logs 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.

Parameters:

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

AWSLogsClient

public AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider,
                     ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Amazon CloudWatch Logs 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.

Parameters:

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

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

AWSLogsClient

public AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider,
                     ClientConfiguration clientConfiguration,
                     RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on Amazon CloudWatch Logs 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.

Parameters:

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

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

requestMetricCollector - optional request metric collector

Method Detail

cancelExportTask

public CancelExportTaskResult cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)

Cancels an export task if it is in PENDING or RUNNING state.

Specified by:

cancelExportTask in interface AWSLogs

Parameters:

cancelExportTaskRequest -

Returns:

Result of the CancelExportTask operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

InvalidOperationException - Returned if the operation is not valid on the specified resource

ServiceUnavailableException - Returned if the service cannot complete the request.

createExportTask

public CreateExportTaskResult createExportTask(CreateExportTaskRequest createExportTaskRequest)

Creates an ExportTask which allows you to efficiently export data from a Log Group to your Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, DescribeExportTasks can be used to get the status of an export task. You can only have one active ( RUNNING or PENDING) export task at a time, per account.

You can export logs from multiple log groups or multiple time ranges to the same Amazon S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects.

Specified by:

createExportTask in interface AWSLogs

Parameters:

createExportTaskRequest -

Returns:

Result of the CreateExportTask operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

LimitExceededException - Returned if you have reached the maximum number of resources that can be created.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

ServiceUnavailableException - Returned if the service cannot complete the request.

ResourceNotFoundException - Returned if the specified resource does not exist.

ResourceAlreadyExistsException - Returned if the specified resource already exists.

createLogGroup

public CreateLogGroupResult createLogGroup(CreateLogGroupRequest createLogGroupRequest)

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:

createLogGroup in interface AWSLogs

Parameters:

createLogGroupRequest -

Returns:

Result of the CreateLogGroup operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceAlreadyExistsException - Returned if the specified resource already exists.

LimitExceededException - Returned if you have reached the maximum number of resources that can be created.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

ServiceUnavailableException - Returned if the service cannot complete the request.

createLogStream

public CreateLogStreamResult createLogStream(CreateLogStreamRequest createLogStreamRequest)

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:

createLogStream in interface AWSLogs

Parameters:

createLogStreamRequest -

Returns:

Result of the CreateLogStream operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceAlreadyExistsException - Returned if the specified resource already exists.

ResourceNotFoundException - Returned if the specified resource does not exist.

ServiceUnavailableException - Returned if the service cannot complete the request.

deleteDestination

public DeleteDestinationResult deleteDestination(DeleteDestinationRequest deleteDestinationRequest)

Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination.

Specified by:

deleteDestination in interface AWSLogs

Parameters:

deleteDestinationRequest -

Returns:

Result of the DeleteDestination operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

ServiceUnavailableException - Returned if the service cannot complete the request.

deleteLogGroup

public DeleteLogGroupResult deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest)

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

Specified by:

deleteLogGroup in interface AWSLogs

Parameters:

deleteLogGroupRequest -

Returns:

Result of the DeleteLogGroup operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

ServiceUnavailableException - Returned if the service cannot complete the request.

deleteLogStream

public DeleteLogStreamResult deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest)

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

Specified by:

deleteLogStream in interface AWSLogs

Parameters:

deleteLogStreamRequest -

Returns:

Result of the DeleteLogStream operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

ServiceUnavailableException - Returned if the service cannot complete the request.

deleteMetricFilter

public DeleteMetricFilterResult deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest)

Deletes a metric filter associated with the specified log group.

Specified by:

deleteMetricFilter in interface AWSLogs

Parameters:

deleteMetricFilterRequest -

Returns:

Result of the DeleteMetricFilter operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

ServiceUnavailableException - Returned if the service cannot complete the request.

deleteRetentionPolicy

public DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)

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:

deleteRetentionPolicy in interface AWSLogs

Parameters:

deleteRetentionPolicyRequest -

Returns:

Result of the DeleteRetentionPolicy operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

ServiceUnavailableException - Returned if the service cannot complete the request.

deleteSubscriptionFilter

public DeleteSubscriptionFilterResult deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest)

Deletes a subscription filter associated with the specified log group.

Specified by:

deleteSubscriptionFilter in interface AWSLogs

Parameters:

deleteSubscriptionFilterRequest -

Returns:

Result of the DeleteSubscriptionFilter operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

ServiceUnavailableException - Returned if the service cannot complete the request.

describeDestinations

public DescribeDestinationsResult describeDestinations(DescribeDestinationsRequest describeDestinationsRequest)

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

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

Specified by:

describeDestinations in interface AWSLogs

Parameters:

describeDestinationsRequest -

Returns:

Result of the DescribeDestinations operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ServiceUnavailableException - Returned if the service cannot complete the request.

describeDestinations

public DescribeDestinationsResult describeDestinations()

Description copied from interface: AWSLogs

Simplified method form for invoking the DescribeDestinations operation.

Specified by:

describeDestinations in interface AWSLogs

See Also:

AWSLogs.describeDestinations(DescribeDestinationsRequest)

describeExportTasks

public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)

Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on TaskId or TaskStatus.

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

Specified by:

describeExportTasks in interface AWSLogs

Parameters:

describeExportTasksRequest -

Returns:

Result of the DescribeExportTasks operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ServiceUnavailableException - Returned if the service cannot complete the request.

describeLogGroups

public DescribeLogGroupsResult describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest)

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:

describeLogGroups in interface AWSLogs

Parameters:

describeLogGroupsRequest -

Returns:

Result of the DescribeLogGroups operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ServiceUnavailableException - Returned if the service cannot complete the request.

describeLogGroups

public DescribeLogGroupsResult describeLogGroups()

Description copied from interface: AWSLogs

Simplified method form for invoking the DescribeLogGroups operation.

Specified by:

describeLogGroups in interface AWSLogs

See Also:

AWSLogs.describeLogGroups(DescribeLogGroupsRequest)

describeLogStreams

public DescribeLogStreamsResult describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest)

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. This operation has a limit of five transactions per second, after which transactions are throttled.

Specified by:

describeLogStreams in interface AWSLogs

Parameters:

describeLogStreamsRequest -

Returns:

Result of the DescribeLogStreams operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

ServiceUnavailableException - Returned if the service cannot complete the request.

describeMetricFilters

public DescribeMetricFiltersResult describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest)

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:

describeMetricFilters in interface AWSLogs

Parameters:

describeMetricFiltersRequest -

Returns:

Result of the DescribeMetricFilters operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

ServiceUnavailableException - Returned if the service cannot complete the request.

describeSubscriptionFilters

public DescribeSubscriptionFiltersResult describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)

Returns all the subscription 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 subscription filters. If there are more subscription filters to list, the response would contain a nextToken value in the response body. You can also limit the number of subscription filters returned in the response by specifying the limit parameter in the request.

Specified by:

describeSubscriptionFilters in interface AWSLogs

Parameters:

describeSubscriptionFiltersRequest -

Returns:

Result of the DescribeSubscriptionFilters operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

ServiceUnavailableException - Returned if the service cannot complete the request.

filterLogEvents

public FilterLogEventsResult filterLogEvents(FilterLogEventsRequest filterLogEventsRequest)

Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event timestamp. You can limit the streams searched to an explicit list of logStreamNames.

By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a nextToken, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of searchedLogStreams that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The limit parameter in the request. can be used to specify the maximum number of events to return in a page.

Specified by:

filterLogEvents in interface AWSLogs

Parameters:

filterLogEventsRequest -

Returns:

Result of the FilterLogEvents operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

ServiceUnavailableException - Returned if the service cannot complete the request.

getLogEvents

public GetLogEventsResult getLogEvents(GetLogEventsRequest getLogEventsRequest)

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:

getLogEvents in interface AWSLogs

Parameters:

getLogEventsRequest -

Returns:

Result of the GetLogEvents operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

ServiceUnavailableException - Returned if the service cannot complete the request.

putDestination

public PutDestinationResult putDestination(PutDestinationRequest putDestinationRequest)

Creates or updates a Destination. A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through PutLogEvents requests. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination.

A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user will not be able to call PutSubscriptionFilter against this destination. To enable that, the destination owner must call PutDestinationPolicy after PutDestination.

Specified by:

putDestination in interface AWSLogs

Parameters:

putDestinationRequest -

Returns:

Result of the PutDestination operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

ServiceUnavailableException - Returned if the service cannot complete the request.

putDestinationPolicy

public PutDestinationPolicyResult putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest)

Creates or updates an access policy associated with an existing Destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.

Specified by:

putDestinationPolicy in interface AWSLogs

Parameters:

putDestinationPolicyRequest -

Returns:

Result of the PutDestinationPolicy operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

ServiceUnavailableException - Returned if the service cannot complete the request.

putLogEvents

public PutLogEventsResult putLogEvents(PutLogEventsRequest putLogEventsRequest)

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 1,048,576 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 10,000.
• A batch of log events in a single PutLogEvents request cannot span more than 24 hours. Otherwise, the PutLogEvents operation will fail.

Specified by:

putLogEvents in interface AWSLogs

Parameters:

putLogEventsRequest -

Returns:

Result of the PutLogEvents operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

InvalidSequenceTokenException

DataAlreadyAcceptedException

ResourceNotFoundException - Returned if the specified resource does not exist.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

ServiceUnavailableException - Returned if the service cannot complete the request.

putMetricFilter

public PutMetricFilterResult putMetricFilter(PutMetricFilterRequest putMetricFilterRequest)

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.

The maximum number of metric filters that can be associated with a log group is 100.

Specified by:

putMetricFilter in interface AWSLogs

Parameters:

putMetricFilterRequest -

Returns:

Result of the PutMetricFilter operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

LimitExceededException - Returned if you have reached the maximum number of resources that can be created.

ServiceUnavailableException - Returned if the service cannot complete the request.

putRetentionPolicy

public PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)

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:

putRetentionPolicy in interface AWSLogs

Parameters:

putRetentionPolicyRequest -

Returns:

Result of the PutRetentionPolicy operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

ServiceUnavailableException - Returned if the service cannot complete the request.

putSubscriptionFilter

public PutSubscriptionFilterResult putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest)

Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents requests and have them delivered to a specific destination. Currently, the supported destinations are:

• An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
• A logical destination (used via an ARN of Destination) belonging to a different account, for cross-account delivery.
• An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery.
• An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.

Currently there can only be one subscription filter associated with a log group.

Specified by:

putSubscriptionFilter in interface AWSLogs

Parameters:

putSubscriptionFilterRequest -

Returns:

Result of the PutSubscriptionFilter operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ResourceNotFoundException - Returned if the specified resource does not exist.

OperationAbortedException - Returned if multiple requests to update the same resource were in conflict.

LimitExceededException - Returned if you have reached the maximum number of resources that can be created.

ServiceUnavailableException - Returned if the service cannot complete the request.

testMetricFilter

public TestMetricFilterResult testMetricFilter(TestMetricFilterRequest testMetricFilterRequest)

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:

testMetricFilter in interface AWSLogs

Parameters:

testMetricFilterRequest -

Returns:

Result of the TestMetricFilter operation returned by the service.

Throws:

InvalidParameterException - Returned if a parameter of the request is incorrectly specified.

ServiceUnavailableException - Returned if the service cannot complete the request.

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSLogs

Parameters:

request - The originally executed request

Returns:

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