public class AmazonCloudWatchLogsClient extends AmazonWebServiceClient implements AmazonCloudWatchLogs
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.
LOGGING_AWS_REQUEST_METRIC| Constructor and Description |
|---|
AmazonCloudWatchLogsClient()
Deprecated.
|
AmazonCloudWatchLogsClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonCloudWatchLogs
using the specified AWS account credentials.
|
AmazonCloudWatchLogsClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonCloudWatchLogs
using the specified AWS account credentials and client configuration
options.
|
AmazonCloudWatchLogsClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonCloudWatchLogs
using the specified AWS account credentials provider.
|
AmazonCloudWatchLogsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonCloudWatchLogs
using the specified AWS account credentials provider and client
configuration options.
|
AmazonCloudWatchLogsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
HttpClient httpClient)
Constructs a new client to invoke service methods on AmazonCloudWatchLogs
using the specified AWS account credentials provider, client
configuration options and request metric collector.
|
AmazonCloudWatchLogsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
Deprecated.
|
AmazonCloudWatchLogsClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| 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)
Deprecated.
ResponseMetadata cache can hold up to 50 requests and
responses in memory and will cause memory issue. This method
now always returns null.
|
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 |
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.
|
addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@Deprecated public AmazonCloudWatchLogsClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonCloudWatchLogsClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling
how this client connects to AmazonCloudWatchLogs (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AmazonCloudWatchLogsClient(AWSCredentials awsCredentials)
The client requests are authenticated using the AWSCredentials
provided in this constructor. Static AWSCredentials can be passed for
quick testing. However, it is strongly recommended to use Amazon Cognito
vended temporary credentials for use in production. This can be achieved
by using AWSMobileClient. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
@Override
public void onResult(final UserStateDetails details) {
AmazonCloudWatchLogsClient client = new AmazonCloudWatchLogsClient(AWSMobileClient.getInstance());
}
@Override
public void onError(final Exception e) {
e.printStackTrace();
}
});
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.public AmazonCloudWatchLogsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
The client requests are authenticated using the AWSCredentials
provided in this constructor. Static AWSCredentials can be passed for
quick testing. However, it is strongly recommended to use Amazon Cognito
vended temporary credentials for use in production. This can be achieved
by using AWSMobileClient. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
@Override
public void onResult(final UserStateDetails details) {
AmazonCloudWatchLogsClient client = new AmazonCloudWatchLogsClient(AWSMobileClient.getInstance());
}
@Override
public void onError(final Exception e) {
e.printStackTrace();
}
});
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonCloudWatchLogs (ex: proxy
settings, retry counts, etc.).public AmazonCloudWatchLogsClient(AWSCredentialsProvider awsCredentialsProvider)
The client requests are authenticated using the AWSCredentials
provided in this constructor. Static AWSCredentials can be passed for
quick testing. However, it is strongly recommended to use Amazon Cognito
vended temporary credentials for use in production. This can be achieved
by using AWSMobileClient. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
@Override
public void onResult(final UserStateDetails details) {
AmazonCloudWatchLogsClient client = new AmazonCloudWatchLogsClient(AWSMobileClient.getInstance());
}
@Override
public void onError(final Exception e) {
e.printStackTrace();
}
});
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.public AmazonCloudWatchLogsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
The client requests are authenticated using the AWSCredentials
provided in this constructor. Static AWSCredentials can be passed for
quick testing. However, it is strongly recommended to use Amazon Cognito
vended temporary credentials for use in production. This can be achieved
by using AWSMobileClient. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
@Override
public void onResult(final UserStateDetails details) {
AmazonCloudWatchLogsClient client = new AmazonCloudWatchLogsClient(AWSMobileClient.getInstance());
}
@Override
public void onError(final Exception e) {
e.printStackTrace();
}
});
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonCloudWatchLogs (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonCloudWatchLogsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonCloudWatchLogs (ex: proxy
settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic AmazonCloudWatchLogsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonCloudWatchLogs (ex: proxy
settings, retry counts, etc.).httpClient - A http clientpublic void associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest) throws AmazonServiceException, AmazonClientException
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.
associateKmsKey in interface AmazonCloudWatchLogsassociateKmsKeyRequest - InvalidParameterExceptionResourceNotFoundExceptionOperationAbortedExceptionServiceUnavailableExceptionAmazonClientException - 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.public void cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) throws AmazonServiceException, AmazonClientException
Cancels the specified export task.
The task must be in the PENDING or RUNNING
state.
cancelExportTask in interface AmazonCloudWatchLogscancelExportTaskRequest - InvalidParameterExceptionResourceNotFoundExceptionInvalidOperationExceptionServiceUnavailableExceptionAmazonClientException - 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.public CreateExportTaskResult createExportTask(CreateExportTaskRequest createExportTaskRequest) throws AmazonServiceException, AmazonClientException
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.
createExportTask in interface AmazonCloudWatchLogscreateExportTaskRequest - InvalidParameterExceptionLimitExceededExceptionOperationAbortedExceptionServiceUnavailableExceptionResourceNotFoundExceptionResourceAlreadyExistsExceptionAmazonClientException - 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.public void createLogGroup(CreateLogGroupRequest createLogGroupRequest) throws AmazonServiceException, AmazonClientException
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.
createLogGroup in interface AmazonCloudWatchLogscreateLogGroupRequest - InvalidParameterExceptionResourceAlreadyExistsExceptionLimitExceededExceptionOperationAbortedExceptionServiceUnavailableExceptionAmazonClientException - 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.public void createLogStream(CreateLogStreamRequest createLogStreamRequest) throws AmazonServiceException, AmazonClientException
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.
createLogStream in interface AmazonCloudWatchLogscreateLogStreamRequest - InvalidParameterExceptionResourceAlreadyExistsExceptionResourceNotFoundExceptionServiceUnavailableExceptionAmazonClientException - 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.public void deleteDestination(DeleteDestinationRequest deleteDestinationRequest) throws AmazonServiceException, AmazonClientException
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.
deleteDestination in interface AmazonCloudWatchLogsdeleteDestinationRequest - InvalidParameterExceptionResourceNotFoundExceptionOperationAbortedExceptionServiceUnavailableExceptionAmazonClientException - 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.public void deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
deleteLogGroup in interface AmazonCloudWatchLogsdeleteLogGroupRequest - InvalidParameterExceptionResourceNotFoundExceptionOperationAbortedExceptionServiceUnavailableExceptionAmazonClientException - 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.public void deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
deleteLogStream in interface AmazonCloudWatchLogsdeleteLogStreamRequest - InvalidParameterExceptionResourceNotFoundExceptionOperationAbortedExceptionServiceUnavailableExceptionAmazonClientException - 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.public void deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified metric filter.
deleteMetricFilter in interface AmazonCloudWatchLogsdeleteMetricFilterRequest - InvalidParameterExceptionResourceNotFoundExceptionOperationAbortedExceptionServiceUnavailableExceptionAmazonClientException - 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.public void deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws AmazonServiceException, AmazonClientException
Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
deleteResourcePolicy in interface AmazonCloudWatchLogsdeleteResourcePolicyRequest - InvalidParameterExceptionResourceNotFoundExceptionServiceUnavailableExceptionAmazonClientException - 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.public void deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
deleteRetentionPolicy in interface AmazonCloudWatchLogsdeleteRetentionPolicyRequest - InvalidParameterExceptionResourceNotFoundExceptionOperationAbortedExceptionServiceUnavailableExceptionAmazonClientException - 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.public void deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified subscription filter.
deleteSubscriptionFilter in interface AmazonCloudWatchLogsdeleteSubscriptionFilterRequest - InvalidParameterExceptionResourceNotFoundExceptionOperationAbortedExceptionServiceUnavailableExceptionAmazonClientException - 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.public DescribeDestinationsResult describeDestinations(DescribeDestinationsRequest describeDestinationsRequest) throws AmazonServiceException, AmazonClientException
Lists all your destinations. The results are ASCII-sorted by destination name.
describeDestinations in interface AmazonCloudWatchLogsdescribeDestinationsRequest - InvalidParameterExceptionServiceUnavailableExceptionAmazonClientException - 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.public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest) throws AmazonServiceException, AmazonClientException
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
describeExportTasks in interface AmazonCloudWatchLogsdescribeExportTasksRequest - InvalidParameterExceptionServiceUnavailableExceptionAmazonClientException - 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.public DescribeLogGroupsResult describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest) throws AmazonServiceException, AmazonClientException
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.
describeLogGroups in interface AmazonCloudWatchLogsdescribeLogGroupsRequest - InvalidParameterExceptionServiceUnavailableExceptionAmazonClientException - 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.public DescribeLogStreamsResult describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest) throws AmazonServiceException, AmazonClientException
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.
describeLogStreams in interface AmazonCloudWatchLogsdescribeLogStreamsRequest - InvalidParameterExceptionResourceNotFoundExceptionServiceUnavailableExceptionAmazonClientException - 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.public DescribeMetricFiltersResult describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest) throws AmazonServiceException, AmazonClientException
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.
describeMetricFilters in interface AmazonCloudWatchLogsdescribeMetricFiltersRequest - InvalidParameterExceptionResourceNotFoundExceptionServiceUnavailableExceptionAmazonClientException - 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.public DescribeResourcePoliciesResult describeResourcePolicies(DescribeResourcePoliciesRequest describeResourcePoliciesRequest) throws AmazonServiceException, AmazonClientException
Lists the resource policies in this account.
describeResourcePolicies in interface AmazonCloudWatchLogsdescribeResourcePoliciesRequest - InvalidParameterExceptionServiceUnavailableExceptionAmazonClientException - 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.public DescribeSubscriptionFiltersResult describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest) throws AmazonServiceException, AmazonClientException
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.
describeSubscriptionFilters in interface AmazonCloudWatchLogsdescribeSubscriptionFiltersRequest - InvalidParameterExceptionResourceNotFoundExceptionServiceUnavailableExceptionAmazonClientException - 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.public void disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest) throws AmazonServiceException, AmazonClientException
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.
disassociateKmsKey in interface AmazonCloudWatchLogsdisassociateKmsKeyRequest - InvalidParameterExceptionResourceNotFoundExceptionOperationAbortedExceptionServiceUnavailableExceptionAmazonClientException - 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.public FilterLogEventsResult filterLogEvents(FilterLogEventsRequest filterLogEventsRequest) throws AmazonServiceException, AmazonClientException
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.
filterLogEvents in interface AmazonCloudWatchLogsfilterLogEventsRequest - InvalidParameterExceptionResourceNotFoundExceptionServiceUnavailableExceptionAmazonClientException - 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.public GetLogEventsResult getLogEvents(GetLogEventsRequest getLogEventsRequest) throws AmazonServiceException, AmazonClientException
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.
getLogEvents in interface AmazonCloudWatchLogsgetLogEventsRequest - InvalidParameterExceptionResourceNotFoundExceptionServiceUnavailableExceptionAmazonClientException - 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.public ListTagsLogGroupResult listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest) throws AmazonServiceException, AmazonClientException
Lists the tags for the specified log group.
listTagsLogGroup in interface AmazonCloudWatchLogslistTagsLogGroupRequest - ResourceNotFoundExceptionServiceUnavailableExceptionAmazonClientException - 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.public PutDestinationResult putDestination(PutDestinationRequest putDestinationRequest) throws AmazonServiceException, AmazonClientException
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.
putDestination in interface AmazonCloudWatchLogsputDestinationRequest - InvalidParameterExceptionOperationAbortedExceptionServiceUnavailableExceptionAmazonClientException - 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.public void putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest) throws AmazonServiceException, AmazonClientException
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.
putDestinationPolicy in interface AmazonCloudWatchLogsputDestinationPolicyRequest - InvalidParameterExceptionOperationAbortedExceptionServiceUnavailableExceptionAmazonClientException - 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.public PutLogEventsResult putLogEvents(PutLogEventsRequest putLogEventsRequest) throws AmazonServiceException, AmazonClientException
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.
putLogEvents in interface AmazonCloudWatchLogsputLogEventsRequest - InvalidParameterExceptionInvalidSequenceTokenExceptionDataAlreadyAcceptedExceptionResourceNotFoundExceptionServiceUnavailableExceptionUnrecognizedClientExceptionAmazonClientException - 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.public void putMetricFilter(PutMetricFilterRequest putMetricFilterRequest) throws AmazonServiceException, AmazonClientException
Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents.
The maximum number of metric filters that can be associated with a log group is 100.
putMetricFilter in interface AmazonCloudWatchLogsputMetricFilterRequest - InvalidParameterExceptionResourceNotFoundExceptionOperationAbortedExceptionLimitExceededExceptionServiceUnavailableExceptionAmazonClientException - 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.public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws AmazonServiceException, AmazonClientException
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.
putResourcePolicy in interface AmazonCloudWatchLogsputResourcePolicyRequest - InvalidParameterExceptionLimitExceededExceptionServiceUnavailableExceptionAmazonClientException - 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.public void putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) throws AmazonServiceException, AmazonClientException
Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group.
putRetentionPolicy in interface AmazonCloudWatchLogsputRetentionPolicyRequest - InvalidParameterExceptionResourceNotFoundExceptionOperationAbortedExceptionServiceUnavailableExceptionAmazonClientException - 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.public void putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest) throws AmazonServiceException, AmazonClientException
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.
putSubscriptionFilter in interface AmazonCloudWatchLogsputSubscriptionFilterRequest - InvalidParameterExceptionResourceNotFoundExceptionOperationAbortedExceptionLimitExceededExceptionServiceUnavailableExceptionAmazonClientException - 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.public void tagLogGroup(TagLogGroupRequest tagLogGroupRequest) throws AmazonServiceException, AmazonClientException
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.
tagLogGroup in interface AmazonCloudWatchLogstagLogGroupRequest - ResourceNotFoundExceptionInvalidParameterExceptionAmazonClientException - 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.public TestMetricFilterResult testMetricFilter(TestMetricFilterRequest testMetricFilterRequest) throws AmazonServiceException, AmazonClientException
Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.
testMetricFilter in interface AmazonCloudWatchLogstestMetricFilterRequest - InvalidParameterExceptionServiceUnavailableExceptionAmazonClientException - 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.public void untagLogGroup(UntagLogGroupRequest untagLogGroupRequest) throws AmazonServiceException, AmazonClientException
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.
untagLogGroup in interface AmazonCloudWatchLogsuntagLogGroupRequest - ResourceNotFoundExceptionAmazonClientException - 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.@Deprecated public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AmazonCloudWatchLogsrequest - The originally executed requestCopyright © 2018 Amazon Web Services, Inc. All Rights Reserved.