@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSLogsAsync extends AbstractAWSLogs implements AWSLogsAsync
AWSLogsAsync. Convenient method forms pass through to the corresponding overload
that takes a request object and an AsyncHandler, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAWSLogsAsync() |
associateKmsKey, cancelExportTask, createExportTask, createLogGroup, createLogStream, deleteDataProtectionPolicy, deleteDestination, deleteLogGroup, deleteLogStream, deleteMetricFilter, deleteQueryDefinition, deleteResourcePolicy, deleteRetentionPolicy, deleteSubscriptionFilter, describeDestinations, describeDestinations, describeExportTasks, describeLogGroups, describeLogGroups, describeLogStreams, describeMetricFilters, describeQueries, describeQueryDefinitions, describeResourcePolicies, describeSubscriptionFilters, disassociateKmsKey, filterLogEvents, getCachedResponseMetadata, getDataProtectionPolicy, getLogEvents, getLogGroupFields, getLogRecord, getQueryResults, listTagsForResource, listTagsLogGroup, putDataProtectionPolicy, putDestination, putDestinationPolicy, putLogEvents, putMetricFilter, putQueryDefinition, putResourcePolicy, putRetentionPolicy, putSubscriptionFilter, setEndpoint, setRegion, shutdown, startQuery, stopQuery, tagLogGroup, tagResource, testMetricFilter, untagLogGroup, untagResourceclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitassociateKmsKey, cancelExportTask, createExportTask, createLogGroup, createLogStream, deleteDataProtectionPolicy, deleteDestination, deleteLogGroup, deleteLogStream, deleteMetricFilter, deleteQueryDefinition, deleteResourcePolicy, deleteRetentionPolicy, deleteSubscriptionFilter, describeDestinations, describeDestinations, describeExportTasks, describeLogGroups, describeLogGroups, describeLogStreams, describeMetricFilters, describeQueries, describeQueryDefinitions, describeResourcePolicies, describeSubscriptionFilters, disassociateKmsKey, filterLogEvents, getCachedResponseMetadata, getDataProtectionPolicy, getLogEvents, getLogGroupFields, getLogRecord, getQueryResults, listTagsForResource, listTagsLogGroup, putDataProtectionPolicy, putDestination, putDestinationPolicy, putLogEvents, putMetricFilter, putQueryDefinition, putResourcePolicy, putRetentionPolicy, putSubscriptionFilter, setEndpoint, setRegion, shutdown, startQuery, stopQuery, tagLogGroup, tagResource, testMetricFilter, untagLogGroup, untagResourcepublic Future<AssociateKmsKeyResult> associateKmsKeyAsync(AssociateKmsKeyRequest request)
AWSLogsAsyncAssociates the specified KMS key with the specified log group.
Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS keyis still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled,
you receive an InvalidParameterException error.
associateKmsKeyAsync in interface AWSLogsAsyncpublic Future<AssociateKmsKeyResult> associateKmsKeyAsync(AssociateKmsKeyRequest request, AsyncHandler<AssociateKmsKeyRequest,AssociateKmsKeyResult> asyncHandler)
AWSLogsAsyncAssociates the specified KMS key with the specified log group.
Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS keyis still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled,
you receive an InvalidParameterException error.
associateKmsKeyAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CancelExportTaskResult> cancelExportTaskAsync(CancelExportTaskRequest request)
AWSLogsAsyncCancels the specified export task.
The task must be in the PENDING or RUNNING state.
cancelExportTaskAsync in interface AWSLogsAsyncpublic Future<CancelExportTaskResult> cancelExportTaskAsync(CancelExportTaskRequest request, AsyncHandler<CancelExportTaskRequest,CancelExportTaskResult> asyncHandler)
AWSLogsAsyncCancels the specified export task.
The task must be in the PENDING or RUNNING state.
cancelExportTaskAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateExportTaskResult> createExportTaskAsync(CreateExportTaskRequest request)
AWSLogsAsync
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you
perform a CreateExportTask operation, you must use credentials that have permission to write to the
S3 bucket that you specify as the destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
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 log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
createExportTaskAsync in interface AWSLogsAsyncpublic Future<CreateExportTaskResult> createExportTaskAsync(CreateExportTaskRequest request, AsyncHandler<CreateExportTaskRequest,CreateExportTaskResult> asyncHandler)
AWSLogsAsync
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you
perform a CreateExportTask operation, you must use credentials that have permission to write to the
S3 bucket that you specify as the destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
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 log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
createExportTaskAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLogGroupResult> createLogGroupAsync(CreateLogGroupRequest request)
AWSLogsAsyncCreates a log group with the specified name. You can create up to 20,000 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 Amazon Web Services 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), '.' (period), and '#' (number sign)
When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a KMS key with the log group but the KMS keydoes not exist or the KMS key is
disabled, you receive an InvalidParameterException error.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
createLogGroupAsync in interface AWSLogsAsyncpublic Future<CreateLogGroupResult> createLogGroupAsync(CreateLogGroupRequest request, AsyncHandler<CreateLogGroupRequest,CreateLogGroupResult> asyncHandler)
AWSLogsAsyncCreates a log group with the specified name. You can create up to 20,000 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 Amazon Web Services 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), '.' (period), and '#' (number sign)
When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a KMS key with the log group but the KMS keydoes not exist or the KMS key is
disabled, you receive an InvalidParameterException error.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
createLogGroupAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLogStreamResult> createLogStreamAsync(CreateLogStreamRequest request)
AWSLogsAsyncCreates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on
CreateLogStream operations, after which transactions are throttled.
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.
Don't use ':' (colon) or '*' (asterisk) characters.
createLogStreamAsync in interface AWSLogsAsyncpublic Future<CreateLogStreamResult> createLogStreamAsync(CreateLogStreamRequest request, AsyncHandler<CreateLogStreamRequest,CreateLogStreamResult> asyncHandler)
AWSLogsAsyncCreates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on
CreateLogStream operations, after which transactions are throttled.
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.
Don't use ':' (colon) or '*' (asterisk) characters.
createLogStreamAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDataProtectionPolicyResult> deleteDataProtectionPolicyAsync(DeleteDataProtectionPolicyRequest request)
AWSLogsAsyncDeletes the data protection policy from the specified log group.
For more information about data protection policies, see PutDataProtectionPolicy.
deleteDataProtectionPolicyAsync in interface AWSLogsAsyncpublic Future<DeleteDataProtectionPolicyResult> deleteDataProtectionPolicyAsync(DeleteDataProtectionPolicyRequest request, AsyncHandler<DeleteDataProtectionPolicyRequest,DeleteDataProtectionPolicyResult> asyncHandler)
AWSLogsAsyncDeletes the data protection policy from the specified log group.
For more information about data protection policies, see PutDataProtectionPolicy.
deleteDataProtectionPolicyAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDestinationResult> deleteDestinationAsync(DeleteDestinationRequest request)
AWSLogsAsyncDeletes 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.
deleteDestinationAsync in interface AWSLogsAsyncpublic Future<DeleteDestinationResult> deleteDestinationAsync(DeleteDestinationRequest request, AsyncHandler<DeleteDestinationRequest,DeleteDestinationResult> asyncHandler)
AWSLogsAsyncDeletes 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.
deleteDestinationAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteLogGroupResult> deleteLogGroupAsync(DeleteLogGroupRequest request)
AWSLogsAsyncDeletes the specified log group and permanently deletes all the archived log events associated with the log group.
deleteLogGroupAsync in interface AWSLogsAsyncpublic Future<DeleteLogGroupResult> deleteLogGroupAsync(DeleteLogGroupRequest request, AsyncHandler<DeleteLogGroupRequest,DeleteLogGroupResult> asyncHandler)
AWSLogsAsyncDeletes the specified log group and permanently deletes all the archived log events associated with the log group.
deleteLogGroupAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteLogStreamResult> deleteLogStreamAsync(DeleteLogStreamRequest request)
AWSLogsAsyncDeletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
deleteLogStreamAsync in interface AWSLogsAsyncpublic Future<DeleteLogStreamResult> deleteLogStreamAsync(DeleteLogStreamRequest request, AsyncHandler<DeleteLogStreamRequest,DeleteLogStreamResult> asyncHandler)
AWSLogsAsyncDeletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
deleteLogStreamAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteMetricFilterResult> deleteMetricFilterAsync(DeleteMetricFilterRequest request)
AWSLogsAsyncDeletes the specified metric filter.
deleteMetricFilterAsync in interface AWSLogsAsyncpublic Future<DeleteMetricFilterResult> deleteMetricFilterAsync(DeleteMetricFilterRequest request, AsyncHandler<DeleteMetricFilterRequest,DeleteMetricFilterResult> asyncHandler)
AWSLogsAsyncDeletes the specified metric filter.
deleteMetricFilterAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteQueryDefinitionResult> deleteQueryDefinitionAsync(DeleteQueryDefinitionRequest request)
AWSLogsAsyncDeletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
Each DeleteQueryDefinition operation can delete one query definition.
You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.
deleteQueryDefinitionAsync in interface AWSLogsAsyncpublic Future<DeleteQueryDefinitionResult> deleteQueryDefinitionAsync(DeleteQueryDefinitionRequest request, AsyncHandler<DeleteQueryDefinitionRequest,DeleteQueryDefinitionResult> asyncHandler)
AWSLogsAsyncDeletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
Each DeleteQueryDefinition operation can delete one query definition.
You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.
deleteQueryDefinitionAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest request)
AWSLogsAsyncDeletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
deleteResourcePolicyAsync in interface AWSLogsAsyncpublic Future<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest request, AsyncHandler<DeleteResourcePolicyRequest,DeleteResourcePolicyResult> asyncHandler)
AWSLogsAsyncDeletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
deleteResourcePolicyAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteRetentionPolicyResult> deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest request)
AWSLogsAsyncDeletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
deleteRetentionPolicyAsync in interface AWSLogsAsyncpublic Future<DeleteRetentionPolicyResult> deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest request, AsyncHandler<DeleteRetentionPolicyRequest,DeleteRetentionPolicyResult> asyncHandler)
AWSLogsAsyncDeletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
deleteRetentionPolicyAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteSubscriptionFilterResult> deleteSubscriptionFilterAsync(DeleteSubscriptionFilterRequest request)
AWSLogsAsyncDeletes the specified subscription filter.
deleteSubscriptionFilterAsync in interface AWSLogsAsyncpublic Future<DeleteSubscriptionFilterResult> deleteSubscriptionFilterAsync(DeleteSubscriptionFilterRequest request, AsyncHandler<DeleteSubscriptionFilterRequest,DeleteSubscriptionFilterResult> asyncHandler)
AWSLogsAsyncDeletes the specified subscription filter.
deleteSubscriptionFilterAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDestinationsResult> describeDestinationsAsync(DescribeDestinationsRequest request)
AWSLogsAsyncLists all your destinations. The results are ASCII-sorted by destination name.
describeDestinationsAsync in interface AWSLogsAsyncpublic Future<DescribeDestinationsResult> describeDestinationsAsync(DescribeDestinationsRequest request, AsyncHandler<DescribeDestinationsRequest,DescribeDestinationsResult> asyncHandler)
AWSLogsAsyncLists all your destinations. The results are ASCII-sorted by destination name.
describeDestinationsAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDestinationsResult> describeDestinationsAsync()
describeDestinationsAsync in interface AWSLogsAsyncdescribeDestinationsAsync(DescribeDestinationsRequest)public Future<DescribeDestinationsResult> describeDestinationsAsync(AsyncHandler<DescribeDestinationsRequest,DescribeDestinationsResult> asyncHandler)
describeDestinationsAsync in interface AWSLogsAsyncdescribeDestinationsAsync(DescribeDestinationsRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeExportTasksResult> describeExportTasksAsync(DescribeExportTasksRequest request)
AWSLogsAsyncLists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
describeExportTasksAsync in interface AWSLogsAsyncpublic Future<DescribeExportTasksResult> describeExportTasksAsync(DescribeExportTasksRequest request, AsyncHandler<DescribeExportTasksRequest,DescribeExportTasksResult> asyncHandler)
AWSLogsAsyncLists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
describeExportTasksAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLogGroupsResult> describeLogGroupsAsync(DescribeLogGroupsRequest request)
AWSLogsAsyncLists 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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by
using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
describeLogGroupsAsync in interface AWSLogsAsyncpublic Future<DescribeLogGroupsResult> describeLogGroupsAsync(DescribeLogGroupsRequest request, AsyncHandler<DescribeLogGroupsRequest,DescribeLogGroupsResult> asyncHandler)
AWSLogsAsyncLists 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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by
using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
describeLogGroupsAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLogGroupsResult> describeLogGroupsAsync()
describeLogGroupsAsync in interface AWSLogsAsyncdescribeLogGroupsAsync(DescribeLogGroupsRequest)public Future<DescribeLogGroupsResult> describeLogGroupsAsync(AsyncHandler<DescribeLogGroupsRequest,DescribeLogGroupsResult> asyncHandler)
describeLogGroupsAsync in interface AWSLogsAsyncdescribeLogGroupsAsync(DescribeLogGroupsRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeLogStreamsResult> describeLogStreamsAsync(DescribeLogStreamsRequest request)
AWSLogsAsyncLists 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.
You can specify the log group to search by using either logGroupIdentifier or
logGroupName. You must include one of these two parameters, but you can't include both.
This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
describeLogStreamsAsync in interface AWSLogsAsyncpublic Future<DescribeLogStreamsResult> describeLogStreamsAsync(DescribeLogStreamsRequest request, AsyncHandler<DescribeLogStreamsRequest,DescribeLogStreamsResult> asyncHandler)
AWSLogsAsyncLists 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.
You can specify the log group to search by using either logGroupIdentifier or
logGroupName. You must include one of these two parameters, but you can't include both.
This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
describeLogStreamsAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeMetricFiltersResult> describeMetricFiltersAsync(DescribeMetricFiltersRequest request)
AWSLogsAsyncLists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
describeMetricFiltersAsync in interface AWSLogsAsyncpublic Future<DescribeMetricFiltersResult> describeMetricFiltersAsync(DescribeMetricFiltersRequest request, AsyncHandler<DescribeMetricFiltersRequest,DescribeMetricFiltersResult> asyncHandler)
AWSLogsAsyncLists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
describeMetricFiltersAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeQueriesResult> describeQueriesAsync(DescribeQueriesRequest request)
AWSLogsAsyncReturns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
describeQueriesAsync in interface AWSLogsAsyncpublic Future<DescribeQueriesResult> describeQueriesAsync(DescribeQueriesRequest request, AsyncHandler<DescribeQueriesRequest,DescribeQueriesResult> asyncHandler)
AWSLogsAsyncReturns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
describeQueriesAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeQueryDefinitionsResult> describeQueryDefinitionsAsync(DescribeQueryDefinitionsRequest request)
AWSLogsAsyncThis operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
You can use the queryDefinitionNamePrefix parameter to limit the results to only the query
definitions that have names that start with a certain string.
describeQueryDefinitionsAsync in interface AWSLogsAsyncpublic Future<DescribeQueryDefinitionsResult> describeQueryDefinitionsAsync(DescribeQueryDefinitionsRequest request, AsyncHandler<DescribeQueryDefinitionsRequest,DescribeQueryDefinitionsResult> asyncHandler)
AWSLogsAsyncThis operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
You can use the queryDefinitionNamePrefix parameter to limit the results to only the query
definitions that have names that start with a certain string.
describeQueryDefinitionsAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeResourcePoliciesResult> describeResourcePoliciesAsync(DescribeResourcePoliciesRequest request)
AWSLogsAsyncLists the resource policies in this account.
describeResourcePoliciesAsync in interface AWSLogsAsyncpublic Future<DescribeResourcePoliciesResult> describeResourcePoliciesAsync(DescribeResourcePoliciesRequest request, AsyncHandler<DescribeResourcePoliciesRequest,DescribeResourcePoliciesResult> asyncHandler)
AWSLogsAsyncLists the resource policies in this account.
describeResourcePoliciesAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeSubscriptionFiltersResult> describeSubscriptionFiltersAsync(DescribeSubscriptionFiltersRequest request)
AWSLogsAsyncLists 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.
describeSubscriptionFiltersAsync in interface AWSLogsAsyncpublic Future<DescribeSubscriptionFiltersResult> describeSubscriptionFiltersAsync(DescribeSubscriptionFiltersRequest request, AsyncHandler<DescribeSubscriptionFiltersRequest,DescribeSubscriptionFiltersResult> asyncHandler)
AWSLogsAsyncLists 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.
describeSubscriptionFiltersAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateKmsKeyResult> disassociateKmsKeyAsync(DisassociateKmsKeyRequest request)
AWSLogsAsyncDisassociates the associated KMS key from the specified log group.
After the KMS key is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the KMS key whenever the encrypted data is requested.
Note that it can take up to 5 minutes for this operation to take effect.
disassociateKmsKeyAsync in interface AWSLogsAsyncpublic Future<DisassociateKmsKeyResult> disassociateKmsKeyAsync(DisassociateKmsKeyRequest request, AsyncHandler<DisassociateKmsKeyRequest,DisassociateKmsKeyResult> asyncHandler)
AWSLogsAsyncDisassociates the associated KMS key from the specified log group.
After the KMS key is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the KMS key whenever the encrypted data is requested.
Note that it can take up to 5 minutes for this operation to take effect.
disassociateKmsKeyAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<FilterLogEventsResult> filterLogEventsAsync(FilterLogEventsRequest request)
AWSLogsAsyncLists 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.
You must have the logs;FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or
logGroupName. You must include one of these two parameters, but you can't include both.
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 specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
Logs, and the ID of the PutLogEvents request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
filterLogEventsAsync in interface AWSLogsAsyncpublic Future<FilterLogEventsResult> filterLogEventsAsync(FilterLogEventsRequest request, AsyncHandler<FilterLogEventsRequest,FilterLogEventsResult> asyncHandler)
AWSLogsAsyncLists 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.
You must have the logs;FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or
logGroupName. You must include one of these two parameters, but you can't include both.
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 specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
Logs, and the ID of the PutLogEvents request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
filterLogEventsAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDataProtectionPolicyResult> getDataProtectionPolicyAsync(GetDataProtectionPolicyRequest request)
AWSLogsAsyncReturns information about a log group data protection policy.
getDataProtectionPolicyAsync in interface AWSLogsAsyncpublic Future<GetDataProtectionPolicyResult> getDataProtectionPolicyAsync(GetDataProtectionPolicyRequest request, AsyncHandler<GetDataProtectionPolicyRequest,GetDataProtectionPolicyResult> asyncHandler)
AWSLogsAsyncReturns information about a log group data protection policy.
getDataProtectionPolicyAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetLogEventsResult> getLogEventsAsync(GetLogEventsRequest request)
AWSLogsAsyncLists log events from the specified log stream. You can list all of 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. This operation can return empty results while there are more log events available through the token.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
You can specify the log group to search by using either logGroupIdentifier or
logGroupName. You must include one of these two parameters, but you can't include both.
getLogEventsAsync in interface AWSLogsAsyncpublic Future<GetLogEventsResult> getLogEventsAsync(GetLogEventsRequest request, AsyncHandler<GetLogEventsRequest,GetLogEventsResult> asyncHandler)
AWSLogsAsyncLists log events from the specified log stream. You can list all of 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. This operation can return empty results while there are more log events available through the token.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
You can specify the log group to search by using either logGroupIdentifier or
logGroupName. You must include one of these two parameters, but you can't include both.
getLogEventsAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetLogGroupFieldsResult> getLogGroupFieldsAsync(GetLogGroupFieldsRequest request)
AWSLogsAsyncReturns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.
You can specify the log group to search by using either logGroupIdentifier or
logGroupName. You must specify one of these parameters, but you can't specify both.
In the results, fields that start with @ are fields generated by CloudWatch Logs. For example,
@timestamp is the timestamp of each log event. For more information about the fields that are
generated by CloudWatch logs, see Supported Logs and Discovered Fields.
The response results are sorted by the frequency percentage, starting with the highest percentage.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
getLogGroupFieldsAsync in interface AWSLogsAsyncpublic Future<GetLogGroupFieldsResult> getLogGroupFieldsAsync(GetLogGroupFieldsRequest request, AsyncHandler<GetLogGroupFieldsRequest,GetLogGroupFieldsResult> asyncHandler)
AWSLogsAsyncReturns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.
You can specify the log group to search by using either logGroupIdentifier or
logGroupName. You must specify one of these parameters, but you can't specify both.
In the results, fields that start with @ are fields generated by CloudWatch Logs. For example,
@timestamp is the timestamp of each log event. For more information about the fields that are
generated by CloudWatch logs, see Supported Logs and Discovered Fields.
The response results are sorted by the frequency percentage, starting with the highest percentage.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
getLogGroupFieldsAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetLogRecordResult> getLogRecordAsync(GetLogRecordRequest request)
AWSLogsAsync
Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original
query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as
field name/field value pairs.
The full unparsed log event is returned within @message.
getLogRecordAsync in interface AWSLogsAsyncpublic Future<GetLogRecordResult> getLogRecordAsync(GetLogRecordRequest request, AsyncHandler<GetLogRecordRequest,GetLogRecordResult> asyncHandler)
AWSLogsAsync
Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original
query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as
field name/field value pairs.
The full unparsed log event is returned within @message.
getLogRecordAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetQueryResultsResult> getQueryResultsAsync(GetQueryResultsRequest request)
AWSLogsAsyncReturns the results from the specified query.
Only the fields requested in the query are returned, along with a @ptr field, which is the
identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.
GetQueryResults does not start running a query. To run a query, use StartQuery.
If the value of the Status field in the output is Running, this operation returns only
partial results. If you see a value of Scheduled or Running for the status, you can
retry the operation later to see the final results.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
getQueryResultsAsync in interface AWSLogsAsyncpublic Future<GetQueryResultsResult> getQueryResultsAsync(GetQueryResultsRequest request, AsyncHandler<GetQueryResultsRequest,GetQueryResultsResult> asyncHandler)
AWSLogsAsyncReturns the results from the specified query.
Only the fields requested in the query are returned, along with a @ptr field, which is the
identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.
GetQueryResults does not start running a query. To run a query, use StartQuery.
If the value of the Status field in the output is Running, this operation returns only
partial results. If you see a value of Scheduled or Running for the status, you can
retry the operation later to see the final results.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
getQueryResultsAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSLogsAsyncDisplays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
listTagsForResourceAsync in interface AWSLogsAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSLogsAsyncDisplays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
listTagsForResourceAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.@Deprecated public Future<ListTagsLogGroupResult> listTagsLogGroupAsync(ListTagsLogGroupRequest request)
AWSLogsAsyncThe ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
Lists the tags for the specified log group.
listTagsLogGroupAsync in interface AWSLogsAsync@Deprecated public Future<ListTagsLogGroupResult> listTagsLogGroupAsync(ListTagsLogGroupRequest request, AsyncHandler<ListTagsLogGroupRequest,ListTagsLogGroupResult> asyncHandler)
AWSLogsAsyncThe ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
Lists the tags for the specified log group.
listTagsLogGroupAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutDataProtectionPolicyResult> putDataProtectionPolicyAsync(PutDataProtectionPolicyRequest request)
AWSLogsAsyncCreates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.
Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.
A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the
unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs
console by running a CloudWatch Logs Insights query with the unmask query command.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
putDataProtectionPolicyAsync in interface AWSLogsAsyncpublic Future<PutDataProtectionPolicyResult> putDataProtectionPolicyAsync(PutDataProtectionPolicyRequest request, AsyncHandler<PutDataProtectionPolicyRequest,PutDataProtectionPolicyResult> asyncHandler)
AWSLogsAsyncCreates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.
Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.
A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the
unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs
console by running a CloudWatch Logs Insights query with the unmask query command.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
putDataProtectionPolicyAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutDestinationResult> putDestinationAsync(PutDestinationRequest request)
AWSLogsAsyncCreates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.
Through an access policy, a destination controls what is written to it. 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.
To perform a PutDestination operation, you must also have the iam:PassRole permission.
putDestinationAsync in interface AWSLogsAsyncpublic Future<PutDestinationResult> putDestinationAsync(PutDestinationRequest request, AsyncHandler<PutDestinationRequest,PutDestinationResult> asyncHandler)
AWSLogsAsyncCreates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.
Through an access policy, a destination controls what is written to it. 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.
To perform a PutDestination operation, you must also have the iam:PassRole permission.
putDestinationAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutDestinationPolicyResult> putDestinationPolicyAsync(PutDestinationPolicyRequest request)
AWSLogsAsyncCreates 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.
putDestinationPolicyAsync in interface AWSLogsAsyncpublic Future<PutDestinationPolicyResult> putDestinationPolicyAsync(PutDestinationPolicyRequest request, AsyncHandler<PutDestinationPolicyRequest,PutDestinationPolicyResult> asyncHandler)
AWSLogsAsyncCreates 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.
putDestinationPolicyAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutLogEventsResult> putLogEventsAsync(PutLogEventsRequest request)
AWSLogsAsyncUploads a batch of log events to the specified log stream.
The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are
always accepted and never return InvalidSequenceTokenException or
DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel
PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. 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 more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the
event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon
Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET
format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions
are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling
quota by using the Service Quotas service.
If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid
Amazon Web Services access key ID or secret key.
putLogEventsAsync in interface AWSLogsAsyncpublic Future<PutLogEventsResult> putLogEventsAsync(PutLogEventsRequest request, AsyncHandler<PutLogEventsRequest,PutLogEventsResult> asyncHandler)
AWSLogsAsyncUploads a batch of log events to the specified log stream.
The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are
always accepted and never return InvalidSequenceTokenException or
DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel
PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. 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 more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the
event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon
Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET
format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions
are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling
quota by using the Service Quotas service.
If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid
Amazon Web Services access key ID or secret key.
putLogEventsAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutMetricFilterResult> putMetricFilterAsync(PutMetricFilterRequest request)
AWSLogsAsyncCreates or updates a metric filter and associates it with the specified log group. With metric filters, you can 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.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not
specify high-cardinality fields such as IPAddress or requestID as dimensions. Each
different value found for a dimension is treated as a separate metric and accrues charges as a separate custom
metric.
CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
putMetricFilterAsync in interface AWSLogsAsyncpublic Future<PutMetricFilterResult> putMetricFilterAsync(PutMetricFilterRequest request, AsyncHandler<PutMetricFilterRequest,PutMetricFilterResult> asyncHandler)
AWSLogsAsyncCreates or updates a metric filter and associates it with the specified log group. With metric filters, you can 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.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not
specify high-cardinality fields such as IPAddress or requestID as dimensions. Each
different value found for a dimension is treated as a separate metric and accrues charges as a separate custom
metric.
CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
putMetricFilterAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutQueryDefinitionResult> putQueryDefinitionAsync(PutQueryDefinitionRequest request)
AWSLogsAsyncCreates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its queryDefinitionId in your request. The values of
name, queryString, and logGroupNames are changed to the values that you
specify in your update operation. No current values are retained from the current query definition. For example,
imagine updating a current query definition that includes log groups. If you don't specify the
logGroupNames parameter in your update operation, the query definition changes to contain no log
groups.
You must have the logs:PutQueryDefinition permission to be able to perform this operation.
putQueryDefinitionAsync in interface AWSLogsAsyncpublic Future<PutQueryDefinitionResult> putQueryDefinitionAsync(PutQueryDefinitionRequest request, AsyncHandler<PutQueryDefinitionRequest,PutQueryDefinitionResult> asyncHandler)
AWSLogsAsyncCreates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its queryDefinitionId in your request. The values of
name, queryString, and logGroupNames are changed to the values that you
specify in your update operation. No current values are retained from the current query definition. For example,
imagine updating a current query definition that includes log groups. If you don't specify the
logGroupNames parameter in your update operation, the query definition changes to contain no log
groups.
You must have the logs:PutQueryDefinition permission to be able to perform this operation.
putQueryDefinitionAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest request)
AWSLogsAsyncCreates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.
putResourcePolicyAsync in interface AWSLogsAsyncpublic Future<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest request, AsyncHandler<PutResourcePolicyRequest,PutResourcePolicyResult> asyncHandler)
AWSLogsAsyncCreates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.
putResourcePolicyAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutRetentionPolicyResult> putRetentionPolicyAsync(PutRetentionPolicyRequest request)
AWSLogsAsyncSets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.
To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
putRetentionPolicyAsync in interface AWSLogsAsyncpublic Future<PutRetentionPolicyResult> putRetentionPolicyAsync(PutRetentionPolicyRequest request, AsyncHandler<PutRetentionPolicyRequest,PutRetentionPolicyResult> asyncHandler)
AWSLogsAsyncSets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.
To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
putRetentionPolicyAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutSubscriptionFilterResult> putSubscriptionFilterAsync(PutSubscriptionFilterRequest request)
AWSLogsAsyncCreates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Amazon Kinesis data 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 Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
Each log group can have up to two subscription filters associated with it. If you are updating an existing
filter, you must specify the correct name in filterName.
To perform a PutSubscriptionFilter operation, you must also have the iam:PassRole
permission.
putSubscriptionFilterAsync in interface AWSLogsAsyncpublic Future<PutSubscriptionFilterResult> putSubscriptionFilterAsync(PutSubscriptionFilterRequest request, AsyncHandler<PutSubscriptionFilterRequest,PutSubscriptionFilterResult> asyncHandler)
AWSLogsAsyncCreates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Amazon Kinesis data 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 Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
Each log group can have up to two subscription filters associated with it. If you are updating an existing
filter, you must specify the correct name in filterName.
To perform a PutSubscriptionFilter operation, you must also have the iam:PassRole
permission.
putSubscriptionFilterAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartQueryResult> startQueryAsync(StartQueryRequest request)
AWSLogsAsyncSchedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.
For more information, see CloudWatch Logs Insights Query Syntax.
Queries time out after 15 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to
start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query
definition must be defined in the monitoring account.
You can have up to 20 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
startQueryAsync in interface AWSLogsAsyncpublic Future<StartQueryResult> startQueryAsync(StartQueryRequest request, AsyncHandler<StartQueryRequest,StartQueryResult> asyncHandler)
AWSLogsAsyncSchedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.
For more information, see CloudWatch Logs Insights Query Syntax.
Queries time out after 15 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to
start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query
definition must be defined in the monitoring account.
You can have up to 20 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
startQueryAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopQueryResult> stopQueryAsync(StopQueryRequest request)
AWSLogsAsyncStops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.
stopQueryAsync in interface AWSLogsAsyncpublic Future<StopQueryResult> stopQueryAsync(StopQueryRequest request, AsyncHandler<StopQueryRequest,StopQueryResult> asyncHandler)
AWSLogsAsyncStops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.
stopQueryAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.@Deprecated public Future<TagLogGroupResult> tagLogGroupAsync(TagLogGroupRequest request)
AWSLogsAsyncThe TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using
the aws:Resource/key-name or aws:TagKeys condition keys. For more information
about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
tagLogGroupAsync in interface AWSLogsAsync@Deprecated public Future<TagLogGroupResult> tagLogGroupAsync(TagLogGroupRequest request, AsyncHandler<TagLogGroupRequest,TagLogGroupResult> asyncHandler)
AWSLogsAsyncThe TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using
the aws:Resource/key-name or aws:TagKeys condition keys. For more information
about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
tagLogGroupAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSLogsAsyncAssigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag
key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key
that is already associated with the alarm, the new tag value that you specify replaces the previous value for
that tag.
You can associate as many as 50 tags with a CloudWatch Logs resource.
tagResourceAsync in interface AWSLogsAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSLogsAsyncAssigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag
key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key
that is already associated with the alarm, the new tag value that you specify replaces the previous value for
that tag.
You can associate as many as 50 tags with a CloudWatch Logs resource.
tagResourceAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TestMetricFilterResult> testMetricFilterAsync(TestMetricFilterRequest request)
AWSLogsAsyncTests 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.
testMetricFilterAsync in interface AWSLogsAsyncpublic Future<TestMetricFilterResult> testMetricFilterAsync(TestMetricFilterRequest request, AsyncHandler<TestMetricFilterRequest,TestMetricFilterResult> asyncHandler)
AWSLogsAsyncTests 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.
testMetricFilterAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.@Deprecated public Future<UntagLogGroupResult> untagLogGroupAsync(UntagLogGroupRequest request)
AWSLogsAsyncThe UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using
the aws:Resource/key-name or aws:TagKeys condition keys.
untagLogGroupAsync in interface AWSLogsAsync@Deprecated public Future<UntagLogGroupResult> untagLogGroupAsync(UntagLogGroupRequest request, AsyncHandler<UntagLogGroupRequest,UntagLogGroupResult> asyncHandler)
AWSLogsAsyncThe UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using
the aws:Resource/key-name or aws:TagKeys condition keys.
untagLogGroupAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSLogsAsyncRemoves one or more tags from the specified resource.
untagResourceAsync in interface AWSLogsAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSLogsAsyncRemoves one or more tags from the specified resource.
untagResourceAsync in interface AWSLogsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2023. All rights reserved.