AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface CloudWatchLogsClient extends AutoCloseable
builder() method.
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from 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.
| Modifier and Type | Field | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
static CloudWatchLogsClientBuilder |
builder() |
Create a builder that can be used to configure and create a
CloudWatchLogsClient. |
default CancelExportTaskResponse |
cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) |
Cancels the specified export task.
|
static CloudWatchLogsClient |
create() |
Create a
CloudWatchLogsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateExportTaskResponse |
createExportTask(CreateExportTaskRequest createExportTaskRequest) |
Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
|
default CreateLogGroupResponse |
createLogGroup(CreateLogGroupRequest createLogGroupRequest) |
Creates a log group with the specified name.
|
default CreateLogStreamResponse |
createLogStream(CreateLogStreamRequest createLogStreamRequest) |
Creates a log stream for the specified log group.
|
default DeleteDestinationResponse |
deleteDestination(DeleteDestinationRequest deleteDestinationRequest) |
Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
|
default DeleteLogGroupResponse |
deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest) |
Deletes the specified log group and permanently deletes all the archived log events associated with the log
group.
|
default DeleteLogStreamResponse |
deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest) |
Deletes the specified log stream and permanently deletes all the archived log events associated with the log
stream.
|
default DeleteMetricFilterResponse |
deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest) |
Deletes the specified metric filter.
|
default DeleteRetentionPolicyResponse |
deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) |
Deletes the specified retention policy.
|
default DeleteSubscriptionFilterResponse |
deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest) |
Deletes the specified subscription filter.
|
default DescribeDestinationsResponse |
describeDestinations(DescribeDestinationsRequest describeDestinationsRequest) |
Lists all your destinations.
|
default DescribeExportTasksResponse |
describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) |
Lists the specified export tasks.
|
default DescribeLogGroupsResponse |
describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest) |
Lists the specified log groups.
|
default DescribeLogStreamsResponse |
describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest) |
Lists the log streams for the specified log group.
|
default DescribeMetricFiltersResponse |
describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest) |
Lists the specified metric filters.
|
default DescribeSubscriptionFiltersResponse |
describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest) |
Lists the subscription filters for the specified log group.
|
default FilterLogEventsResponse |
filterLogEvents(FilterLogEventsRequest filterLogEventsRequest) |
Lists log events from the specified log group.
|
default GetLogEventsResponse |
getLogEvents(GetLogEventsRequest getLogEventsRequest) |
Lists log events from the specified log stream.
|
default ListTagsLogGroupResponse |
listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest) |
Lists the tags for the specified log group.
|
default PutDestinationResponse |
putDestination(PutDestinationRequest putDestinationRequest) |
Creates or updates a destination.
|
default PutDestinationPolicyResponse |
putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest) |
Creates or updates an access policy associated with an existing destination.
|
default PutLogEventsResponse |
putLogEvents(PutLogEventsRequest putLogEventsRequest) |
Uploads a batch of log events to the specified log stream.
|
default PutMetricFilterResponse |
putMetricFilter(PutMetricFilterRequest putMetricFilterRequest) |
Creates or updates a metric filter and associates it with the specified log group.
|
default PutRetentionPolicyResponse |
putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) |
Sets the retention of the specified log group.
|
default PutSubscriptionFilterResponse |
putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest) |
Creates or updates a subscription filter and associates it with the specified log group.
|
static ServiceMetadata |
serviceMetadata() |
|
default TagLogGroupResponse |
tagLogGroup(TagLogGroupRequest tagLogGroupRequest) |
Adds or updates the specified tags for the specified log group.
|
default TestMetricFilterResponse |
testMetricFilter(TestMetricFilterRequest testMetricFilterRequest) |
Tests the filter pattern of a metric filter against a sample of log event messages.
|
default UntagLogGroupResponse |
untagLogGroup(UntagLogGroupRequest untagLogGroupRequest) |
Removes the specified tags from the specified log group.
|
closestatic final String SERVICE_NAME
static CloudWatchLogsClient create()
CloudWatchLogsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudWatchLogsClientBuilder builder()
CloudWatchLogsClient.default CancelExportTaskResponse cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidOperationException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
Cancels the specified export task.
The task must be in the PENDING or RUNNING state.
cancelExportTaskRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.InvalidOperationException - The operation is not valid on the specified resource.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateExportTaskResponse createExportTask(CreateExportTaskRequest createExportTaskRequest) throws InvalidParameterException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, ResourceNotFoundException, ResourceAlreadyExistsException, SdkBaseException, SdkClientException, CloudWatchLogsException
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 that will be used as the Amazon S3 key prefix for all exported objects.
createExportTaskRequest - InvalidParameterException - A parameter is specified incorrectly.LimitExceededException - You have reached the maximum number of resources that can be created.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.ResourceNotFoundException - The specified resource does not exist.ResourceAlreadyExistsException - The specified resource already exists.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateLogGroupResponse createLogGroup(CreateLogGroupRequest createLogGroupRequest) throws InvalidParameterException, ResourceAlreadyExistsException, LimitExceededException, OperationAbortedException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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).
createLogGroupRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - You have reached the maximum number of resources that can be created.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateLogStreamResponse createLogStream(CreateLogStreamRequest createLogStreamRequest) throws InvalidParameterException, ResourceAlreadyExistsException, ResourceNotFoundException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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.
createLogStreamRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteDestinationResponse deleteDestination(DeleteDestinationRequest deleteDestinationRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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.
deleteDestinationRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteLogGroupResponse deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
deleteLogGroupRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteLogStreamResponse deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
deleteLogStreamRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteMetricFilterResponse deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
Deletes the specified metric filter.
deleteMetricFilterRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteRetentionPolicyResponse deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
deleteRetentionPolicyRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteSubscriptionFilterResponse deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
Deletes the specified subscription filter.
deleteSubscriptionFilterRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDestinationsResponse describeDestinations(DescribeDestinationsRequest describeDestinationsRequest) throws InvalidParameterException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
Lists all your destinations. The results are ASCII-sorted by destination name.
describeDestinationsRequest - InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeExportTasksResponse describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) throws InvalidParameterException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
describeExportTasksRequest - InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeLogGroupsResponse describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest) throws InvalidParameterException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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.
describeLogGroupsRequest - InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeLogStreamsResponse describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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.
describeLogStreamsRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeMetricFiltersResponse describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, and metric namespace. The results are ASCII-sorted by filter name.
describeMetricFiltersRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeSubscriptionFiltersResponse describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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.
describeSubscriptionFiltersRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault FilterLogEventsResponse filterLogEvents(FilterLogEventsRequest filterLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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 1MB (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.
filterLogEventsRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetLogEventsResponse getLogEvents(GetLogEventsRequest getLogEventsRequest) throws InvalidParameterException, ResourceNotFoundException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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). If the results include tokens, there are more log events available. You can get additional log events by specifying one of the tokens in a subsequent call.
getLogEventsRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTagsLogGroupResponse listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest) throws ResourceNotFoundException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
Lists the tags for the specified log group.
To add tags, use TagLogGroup. To remove tags, use UntagLogGroup.
listTagsLogGroupRequest - ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutDestinationResponse putDestination(PutDestinationRequest putDestinationRequest) throws InvalidParameterException, OperationAbortedException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
Creates or updates a destination. A destination encapsulates a physical resource (such as a Kinesis stream) and enables you to subscribe to a real-time stream of log events of a different account, ingested using PutLogEvents. 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
cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must
call PutDestinationPolicy after PutDestination.
putDestinationRequest - InvalidParameterException - A parameter is specified incorrectly.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutDestinationPolicyResponse putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest) throws InvalidParameterException, OperationAbortedException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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.
putDestinationPolicyRequest - InvalidParameterException - A parameter is specified incorrectly.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutLogEventsResponse putLogEvents(PutLogEventsRequest putLogEventsRequest) throws InvalidParameterException, InvalidSequenceTokenException, DataAlreadyAcceptedException, ResourceNotFoundException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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.
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 time the event occurred, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC).
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.
putLogEventsRequest - InvalidParameterException - A parameter is specified incorrectly.InvalidSequenceTokenException - The sequence token is not valid.DataAlreadyAcceptedException - The event was already logged.ResourceNotFoundException - The specified resource does not exist.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutMetricFilterResponse putMetricFilter(PutMetricFilterRequest putMetricFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, LimitExceededException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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.
putMetricFilterRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.LimitExceededException - You have reached the maximum number of resources that can be created.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutRetentionPolicyResponse putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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.
putRetentionPolicyRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutSubscriptionFilterResponse putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest) throws InvalidParameterException, ResourceNotFoundException, OperationAbortedException, LimitExceededException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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 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 will fail because you cannot
associate a second filter with a log group.
putSubscriptionFilterRequest - InvalidParameterException - A parameter is specified incorrectly.ResourceNotFoundException - The specified resource does not exist.OperationAbortedException - Multiple requests to update the same resource were in conflict.LimitExceededException - You have reached the maximum number of resources that can be created.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault TagLogGroupResponse tagLogGroup(TagLogGroupRequest tagLogGroupRequest) throws ResourceNotFoundException, InvalidParameterException, SdkBaseException, SdkClientException, CloudWatchLogsException
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.
tagLogGroupRequest - ResourceNotFoundException - The specified resource does not exist.InvalidParameterException - A parameter is specified incorrectly.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault TestMetricFilterResponse testMetricFilter(TestMetricFilterRequest testMetricFilterRequest) throws InvalidParameterException, ServiceUnavailableException, SdkBaseException, SdkClientException, CloudWatchLogsException
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.
testMetricFilterRequest - InvalidParameterException - A parameter is specified incorrectly.ServiceUnavailableException - The service cannot complete the request.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UntagLogGroupResponse untagLogGroup(UntagLogGroupRequest untagLogGroupRequest) throws ResourceNotFoundException, SdkBaseException, SdkClientException, CloudWatchLogsException
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.
untagLogGroupRequest - ResourceNotFoundException - The specified resource does not exist.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudWatchLogsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.