com.amazonaws.services.logs

Interface AmazonCloudWatchLogs

All Known Implementing Classes:

AmazonCloudWatchLogsClient

public interface AmazonCloudWatchLogs

Interface for accessing Amazon CloudWatch Logs

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

You can use CloudWatch Logs to:

• Monitor logs from 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 that 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 CloudWatch metric that you specify.

• Monitor AWS CloudTrail logged events: You can create alarms in 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.

Method Summary

Modifier and Type	Method and Description
void	associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest) Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.
void	cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) Cancels the specified export task.
CreateExportTaskResult	createExportTask(CreateExportTaskRequest createExportTaskRequest) Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
void	createLogGroup(CreateLogGroupRequest createLogGroupRequest) Creates a log group with the specified name.
void	createLogStream(CreateLogStreamRequest createLogStreamRequest) Creates a log stream for the specified log group.
void	deleteDestination(DeleteDestinationRequest deleteDestinationRequest) Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
void	deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest) Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
void	deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest) Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
void	deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest) Deletes the specified metric filter.
void	deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes a resource policy from this account.
void	deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) Deletes the specified retention policy.
void	deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest) Deletes the specified subscription filter.
DescribeDestinationsResult	describeDestinations(DescribeDestinationsRequest describeDestinationsRequest) Lists all your destinations.
DescribeExportTasksResult	describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) Lists the specified export tasks.
DescribeLogGroupsResult	describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest) Lists the specified log groups.
DescribeLogStreamsResult	describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest) Lists the log streams for the specified log group.
DescribeMetricFiltersResult	describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest) Lists the specified metric filters.
DescribeResourcePoliciesResult	describeResourcePolicies(DescribeResourcePoliciesRequest describeResourcePoliciesRequest) Lists the resource policies in this account.
DescribeSubscriptionFiltersResult	describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest) Lists the subscription filters for the specified log group.
void	disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest) Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.
FilterLogEventsResult	filterLogEvents(FilterLogEventsRequest filterLogEventsRequest) Lists log events 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) Lists log events from the specified log stream.
ListTagsLogGroupResult	listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest) Lists the tags for the specified log group.
PutDestinationResult	putDestination(PutDestinationRequest putDestinationRequest) Creates or updates a destination.
void	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.
void	putMetricFilter(PutMetricFilterRequest putMetricFilterRequest) Creates or updates a metric filter and associates it with the specified log group.
PutResourcePolicyResult	putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53.
void	putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) Sets the retention of the specified log group.
void	putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest) Creates or updates a subscription filter and associates it with the specified log group.
void	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client ("https://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.
void	tagLogGroup(TagLogGroupRequest tagLogGroupRequest) Adds or updates the specified tags for the specified log group.
TestMetricFilterResult	testMetricFilter(TestMetricFilterRequest testMetricFilterRequest) Tests the filter pattern of a metric filter against a sample of log event messages.
void	untagLogGroup(UntagLogGroupRequest untagLogGroupRequest) Removes the specified tags from the specified log group.

Method Detail

setEndpoint

void setEndpoint(java.lang.String endpoint)
          throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://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: "https://logs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://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: "https://logs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://https://logs.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

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

setRegion

void setRegion(Region region)
        throws java.lang.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:

java.lang.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)

associateKmsKey

void associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest)
              throws AmazonClientException,
                     AmazonServiceException

Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.

Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

Note that it can take up to 5 minutes for this operation to take effect.

If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

Parameters:

associateKmsKeyRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

cancelExportTask

void cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)
               throws AmazonClientException,
                      AmazonServiceException

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

Parameters:

cancelExportTaskRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

InvalidOperationException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

createExportTask

CreateExportTaskResult createExportTask(CreateExportTaskRequest createExportTaskRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

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

Parameters:

createExportTaskRequest -

Returns:

createExportTaskResult The response from the CreateExportTask service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

LimitExceededException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

createLogGroup

void createLogGroup(CreateLogGroupRequest createLogGroupRequest)
             throws AmazonClientException,
                    AmazonServiceException

Creates a log group with the specified name.

You can create up to 5000 log groups per account.

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

• Log group names must be unique within a region for an AWS account.

• Log group names can be between 1 and 512 characters long.

• Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

Parameters:

createLogGroupRequest -

Throws:

InvalidParameterException

ResourceAlreadyExistsException

LimitExceededException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

createLogStream

void createLogStream(CreateLogStreamRequest createLogStreamRequest)
              throws AmazonClientException,
                     AmazonServiceException

Creates a log stream for the specified log group.

There is no limit on the number of log streams that you can create for a log group.

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

• Log stream names must be unique within the log group.

• Log stream names can be between 1 and 512 characters long.

• The ':' (colon) and '*' (asterisk) characters are not allowed.

Parameters:

createLogStreamRequest -

Throws:

InvalidParameterException

ResourceAlreadyExistsException

ResourceNotFoundException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

deleteDestination

void deleteDestination(DeleteDestinationRequest deleteDestinationRequest)
                throws AmazonClientException,
                       AmazonServiceException

Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.

Parameters:

deleteDestinationRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

deleteLogGroup

void deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest)
             throws AmazonClientException,
                    AmazonServiceException

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

Parameters:

deleteLogGroupRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

deleteLogStream

void deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest)
              throws AmazonClientException,
                     AmazonServiceException

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

Parameters:

deleteLogStreamRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

deleteMetricFilter

void deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest)
                 throws AmazonClientException,
                        AmazonServiceException

Deletes the specified metric filter.

Parameters:

deleteMetricFilterRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

deleteResourcePolicy

void deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
                   throws AmazonClientException,
                          AmazonServiceException

Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.

Parameters:

deleteResourcePolicyRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

deleteRetentionPolicy

void deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
                    throws AmazonClientException,
                           AmazonServiceException

Deletes the specified retention policy.

Log events do not expire if they belong to log groups without a retention policy.

Parameters:

deleteRetentionPolicyRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

deleteSubscriptionFilter

void deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest)
                       throws AmazonClientException,
                              AmazonServiceException

Deletes the specified subscription filter.

Parameters:

deleteSubscriptionFilterRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

describeDestinations

DescribeDestinationsResult describeDestinations(DescribeDestinationsRequest describeDestinationsRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Lists all your destinations. The results are ASCII-sorted by destination name.

Parameters:

describeDestinationsRequest -

Returns:

describeDestinationsResult The response from the DescribeDestinations service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

describeExportTasks

DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)
                                       throws AmazonClientException,
                                              AmazonServiceException

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

Parameters:

describeExportTasksRequest -

Returns:

describeExportTasksResult The response from the DescribeExportTasks service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

describeLogGroups

DescribeLogGroupsResult describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

Parameters:

describeLogGroupsRequest -

Returns:

describeLogGroupsResult The response from the DescribeLogGroups service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

describeLogStreams

DescribeLogStreamsResult describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

This operation has a limit of five transactions per second, after which transactions are throttled.

Parameters:

describeLogStreamsRequest -

Returns:

describeLogStreamsResult The response from the DescribeLogStreams service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

ResourceNotFoundException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

describeMetricFilters

DescribeMetricFiltersResult describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

Parameters:

describeMetricFiltersRequest -

Returns:

describeMetricFiltersResult The response from the DescribeMetricFilters service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

ResourceNotFoundException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

describeResourcePolicies

DescribeResourcePoliciesResult describeResourcePolicies(DescribeResourcePoliciesRequest describeResourcePoliciesRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

Lists the resource policies in this account.

Parameters:

describeResourcePoliciesRequest -

Returns:

describeResourcePoliciesResult The response from the DescribeResourcePolicies service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

describeSubscriptionFilters

DescribeSubscriptionFiltersResult describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)
                                                       throws AmazonClientException,
                                                              AmazonServiceException

Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.

Parameters:

describeSubscriptionFiltersRequest -

Returns:

describeSubscriptionFiltersResult The response from the DescribeSubscriptionFilters service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

ResourceNotFoundException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

disassociateKmsKey

void disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest)
                 throws AmazonClientException,
                        AmazonServiceException

Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.

After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.

Note that it can take up to 5 minutes for this operation to take effect.

Parameters:

disassociateKmsKeyRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

filterLogEvents

FilterLogEventsResult filterLogEvents(FilterLogEventsRequest filterLogEventsRequest)
                               throws AmazonClientException,
                                      AmazonServiceException

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

Parameters:

filterLogEventsRequest -

Returns:

filterLogEventsResult The response from the FilterLogEvents service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

ResourceNotFoundException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

getLogEvents

GetLogEventsResult getLogEvents(GetLogEventsRequest getLogEventsRequest)
                         throws AmazonClientException,
                                AmazonServiceException

Lists log events from the specified log stream. You can list all the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.

Parameters:

getLogEventsRequest -

Returns:

getLogEventsResult The response from the GetLogEvents service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

ResourceNotFoundException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

listTagsLogGroup

ListTagsLogGroupResult listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Lists the tags for the specified log group.

Parameters:

listTagsLogGroupRequest -

Returns:

listTagsLogGroupResult The response from the ListTagsLogGroup service method, as returned by Amazon CloudWatch Logs.

Throws:

ResourceNotFoundException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

putDestination

PutDestinationResult putDestination(PutDestinationRequest putDestinationRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

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

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

Parameters:

putDestinationRequest -

Returns:

putDestinationResult The response from the PutDestination service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

putDestinationPolicy

void putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest)
                   throws AmazonClientException,
                          AmazonServiceException

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.

Parameters:

putDestinationPolicyRequest -

Throws:

InvalidParameterException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

putLogEvents

PutLogEventsResult putLogEvents(PutLogEventsRequest putLogEventsRequest)
                         throws AmazonClientException,
                                AmazonServiceException

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

You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected.

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 time stamp. The time stamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)

• The maximum number of log events in a batch is 10,000.

• A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.

Parameters:

putLogEventsRequest -

Returns:

putLogEventsResult The response from the PutLogEvents service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

InvalidSequenceTokenException

DataAlreadyAcceptedException

ResourceNotFoundException

ServiceUnavailableException

UnrecognizedClientException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

putMetricFilter

void putMetricFilter(PutMetricFilterRequest putMetricFilterRequest)
              throws AmazonClientException,
                     AmazonServiceException

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.

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

Parameters:

putMetricFilterRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

OperationAbortedException

LimitExceededException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

putResourcePolicy

PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per region.

Parameters:

putResourcePolicyRequest -

Returns:

putResourcePolicyResult The response from the PutResourcePolicy service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

LimitExceededException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

putRetentionPolicy

void putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)
                 throws AmazonClientException,
                        AmazonServiceException

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

Parameters:

putRetentionPolicyRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

OperationAbortedException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

putSubscriptionFilter

void putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest)
                    throws AmazonClientException,
                           AmazonServiceException

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 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 that belongs to a different account, for cross-account delivery.

• An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.

• An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group.

Parameters:

putSubscriptionFilterRequest -

Throws:

InvalidParameterException

ResourceNotFoundException

OperationAbortedException

LimitExceededException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

tagLogGroup

void tagLogGroup(TagLogGroupRequest tagLogGroupRequest)
          throws AmazonClientException,
                 AmazonServiceException

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

Parameters:

tagLogGroupRequest -

Throws:

ResourceNotFoundException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

testMetricFilter

TestMetricFilterResult testMetricFilter(TestMetricFilterRequest testMetricFilterRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

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 -

Returns:

testMetricFilterResult The response from the TestMetricFilter service method, as returned by Amazon CloudWatch Logs.

Throws:

InvalidParameterException

ServiceUnavailableException

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 Amazon CloudWatch Logs indicating either a problem with the data in the request, or a server side issue.

untagLogGroup

void untagLogGroup(UntagLogGroupRequest untagLogGroupRequest)
            throws AmazonClientException,
                   AmazonServiceException

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.

Parameters:

untagLogGroupRequest -

Throws:

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 Amazon CloudWatch Logs 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.