@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, deleteDestination, deleteLogGroup, deleteLogStream, deleteMetricFilter, deleteResourcePolicy, deleteRetentionPolicy, deleteSubscriptionFilter, describeDestinations, describeDestinations, describeExportTasks, describeLogGroups, describeLogGroups, describeLogStreams, describeMetricFilters, describeQueries, describeResourcePolicies, describeSubscriptionFilters, disassociateKmsKey, filterLogEvents, getCachedResponseMetadata, getLogEvents, getLogGroupFields, getLogRecord, getQueryResults, listTagsLogGroup, putDestination, putDestinationPolicy, putLogEvents, putMetricFilter, putResourcePolicy, putRetentionPolicy, putSubscriptionFilter, setEndpoint, setRegion, shutdown, startQuery, stopQuery, tagLogGroup, testMetricFilter, untagLogGroup
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
associateKmsKey, cancelExportTask, createExportTask, createLogGroup, createLogStream, deleteDestination, deleteLogGroup, deleteLogStream, deleteMetricFilter, deleteResourcePolicy, deleteRetentionPolicy, deleteSubscriptionFilter, describeDestinations, describeDestinations, describeExportTasks, describeLogGroups, describeLogGroups, describeLogStreams, describeMetricFilters, describeQueries, describeResourcePolicies, describeSubscriptionFilters, disassociateKmsKey, filterLogEvents, getCachedResponseMetadata, getLogEvents, getLogGroupFields, getLogRecord, getQueryResults, listTagsLogGroup, putDestination, putDestinationPolicy, putLogEvents, putMetricFilter, putResourcePolicy, putRetentionPolicy, putSubscriptionFilter, setEndpoint, setRegion, shutdown, startQuery, stopQuery, tagLogGroup, testMetricFilter, untagLogGroup
public Future<AssociateKmsKeyResult> associateKmsKeyAsync(AssociateKmsKeyRequest request)
AWSLogsAsync
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.
Important: CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys.
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.
associateKmsKeyAsync
in interface AWSLogsAsync
public Future<AssociateKmsKeyResult> associateKmsKeyAsync(AssociateKmsKeyRequest request, AsyncHandler<AssociateKmsKeyRequest,AssociateKmsKeyResult> asyncHandler)
AWSLogsAsync
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.
Important: CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys.
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.
associateKmsKeyAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Cancels the specified export task.
The task must be in the PENDING
or RUNNING
state.
cancelExportTaskAsync
in interface AWSLogsAsync
public Future<CancelExportTaskResult> cancelExportTaskAsync(CancelExportTaskRequest request, AsyncHandler<CancelExportTaskRequest,CancelExportTaskResult> asyncHandler)
AWSLogsAsync
Cancels the specified export task.
The task must be in the PENDING
or RUNNING
state.
cancelExportTaskAsync
in interface AWSLogsAsync
asyncHandler
- 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, 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.
Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets encrypted with SSE-KMS is not supported.
createExportTaskAsync
in interface AWSLogsAsync
public Future<CreateExportTaskResult> createExportTaskAsync(CreateExportTaskRequest request, AsyncHandler<CreateExportTaskRequest,CreateExportTaskResult> asyncHandler)
AWSLogsAsync
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.
Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets encrypted with SSE-KMS is not supported.
createExportTaskAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Creates 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 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), '.' (period), and '#' (number sign)
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.
Important: CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys.
createLogGroupAsync
in interface AWSLogsAsync
public Future<CreateLogGroupResult> createLogGroupAsync(CreateLogGroupRequest request, AsyncHandler<CreateLogGroupRequest,CreateLogGroupResult> asyncHandler)
AWSLogsAsync
Creates 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 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), '.' (period), and '#' (number sign)
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.
Important: CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys.
createLogGroupAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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. 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.
The ':' (colon) and '*' (asterisk) characters are not allowed.
createLogStreamAsync
in interface AWSLogsAsync
public Future<CreateLogStreamResult> createLogStreamAsync(CreateLogStreamRequest request, AsyncHandler<CreateLogStreamRequest,CreateLogStreamResult> asyncHandler)
AWSLogsAsync
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. 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.
The ':' (colon) and '*' (asterisk) characters are not allowed.
createLogStreamAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
deleteDestinationAsync
in interface AWSLogsAsync
public Future<DeleteDestinationResult> deleteDestinationAsync(DeleteDestinationRequest request, AsyncHandler<DeleteDestinationRequest,DeleteDestinationResult> asyncHandler)
AWSLogsAsync
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.
deleteDestinationAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
deleteLogGroupAsync
in interface AWSLogsAsync
public Future<DeleteLogGroupResult> deleteLogGroupAsync(DeleteLogGroupRequest request, AsyncHandler<DeleteLogGroupRequest,DeleteLogGroupResult> asyncHandler)
AWSLogsAsync
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
deleteLogGroupAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
deleteLogStreamAsync
in interface AWSLogsAsync
public Future<DeleteLogStreamResult> deleteLogStreamAsync(DeleteLogStreamRequest request, AsyncHandler<DeleteLogStreamRequest,DeleteLogStreamResult> asyncHandler)
AWSLogsAsync
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
deleteLogStreamAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Deletes the specified metric filter.
deleteMetricFilterAsync
in interface AWSLogsAsync
public Future<DeleteMetricFilterResult> deleteMetricFilterAsync(DeleteMetricFilterRequest request, AsyncHandler<DeleteMetricFilterRequest,DeleteMetricFilterResult> asyncHandler)
AWSLogsAsync
Deletes the specified metric filter.
deleteMetricFilterAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Deletes 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 AWSLogsAsync
public Future<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest request, AsyncHandler<DeleteResourcePolicyRequest,DeleteResourcePolicyResult> asyncHandler)
AWSLogsAsync
Deletes 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 AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
deleteRetentionPolicyAsync
in interface AWSLogsAsync
public Future<DeleteRetentionPolicyResult> deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest request, AsyncHandler<DeleteRetentionPolicyRequest,DeleteRetentionPolicyResult> asyncHandler)
AWSLogsAsync
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
deleteRetentionPolicyAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Deletes the specified subscription filter.
deleteSubscriptionFilterAsync
in interface AWSLogsAsync
public Future<DeleteSubscriptionFilterResult> deleteSubscriptionFilterAsync(DeleteSubscriptionFilterRequest request, AsyncHandler<DeleteSubscriptionFilterRequest,DeleteSubscriptionFilterResult> asyncHandler)
AWSLogsAsync
Deletes the specified subscription filter.
deleteSubscriptionFilterAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Lists all your destinations. The results are ASCII-sorted by destination name.
describeDestinationsAsync
in interface AWSLogsAsync
public Future<DescribeDestinationsResult> describeDestinationsAsync(DescribeDestinationsRequest request, AsyncHandler<DescribeDestinationsRequest,DescribeDestinationsResult> asyncHandler)
AWSLogsAsync
Lists all your destinations. The results are ASCII-sorted by destination name.
describeDestinationsAsync
in interface AWSLogsAsync
asyncHandler
- 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 AWSLogsAsync
describeDestinationsAsync(DescribeDestinationsRequest)
public Future<DescribeDestinationsResult> describeDestinationsAsync(AsyncHandler<DescribeDestinationsRequest,DescribeDestinationsResult> asyncHandler)
describeDestinationsAsync
in interface AWSLogsAsync
describeDestinationsAsync(DescribeDestinationsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<DescribeExportTasksResult> describeExportTasksAsync(DescribeExportTasksRequest request)
AWSLogsAsync
Lists 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 AWSLogsAsync
public Future<DescribeExportTasksResult> describeExportTasksAsync(DescribeExportTasksRequest request, AsyncHandler<DescribeExportTasksRequest,DescribeExportTasksResult> asyncHandler)
AWSLogsAsync
Lists 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 AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
describeLogGroupsAsync
in interface AWSLogsAsync
public Future<DescribeLogGroupsResult> describeLogGroupsAsync(DescribeLogGroupsRequest request, AsyncHandler<DescribeLogGroupsRequest,DescribeLogGroupsResult> asyncHandler)
AWSLogsAsync
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.
describeLogGroupsAsync
in interface AWSLogsAsync
asyncHandler
- 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 AWSLogsAsync
describeLogGroupsAsync(DescribeLogGroupsRequest)
public Future<DescribeLogGroupsResult> describeLogGroupsAsync(AsyncHandler<DescribeLogGroupsRequest,DescribeLogGroupsResult> asyncHandler)
describeLogGroupsAsync
in interface AWSLogsAsync
describeLogGroupsAsync(DescribeLogGroupsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<DescribeLogStreamsResult> describeLogStreamsAsync(DescribeLogStreamsRequest request)
AWSLogsAsync
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.
describeLogStreamsAsync
in interface AWSLogsAsync
public Future<DescribeLogStreamsResult> describeLogStreamsAsync(DescribeLogStreamsRequest request, AsyncHandler<DescribeLogStreamsRequest,DescribeLogStreamsResult> asyncHandler)
AWSLogsAsync
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.
describeLogStreamsAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
describeMetricFiltersAsync
in interface AWSLogsAsync
public Future<DescribeMetricFiltersResult> describeMetricFiltersAsync(DescribeMetricFiltersRequest request, AsyncHandler<DescribeMetricFiltersRequest,DescribeMetricFiltersResult> asyncHandler)
AWSLogsAsync
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.
describeMetricFiltersAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed 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 AWSLogsAsync
public Future<DescribeQueriesResult> describeQueriesAsync(DescribeQueriesRequest request, AsyncHandler<DescribeQueriesRequest,DescribeQueriesResult> asyncHandler)
AWSLogsAsync
Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed 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 AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Lists the resource policies in this account.
describeResourcePoliciesAsync
in interface AWSLogsAsync
public Future<DescribeResourcePoliciesResult> describeResourcePoliciesAsync(DescribeResourcePoliciesRequest request, AsyncHandler<DescribeResourcePoliciesRequest,DescribeResourcePoliciesResult> asyncHandler)
AWSLogsAsync
Lists the resource policies in this account.
describeResourcePoliciesAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
describeSubscriptionFiltersAsync
in interface AWSLogsAsync
public Future<DescribeSubscriptionFiltersResult> describeSubscriptionFiltersAsync(DescribeSubscriptionFiltersRequest request, AsyncHandler<DescribeSubscriptionFiltersRequest,DescribeSubscriptionFiltersResult> asyncHandler)
AWSLogsAsync
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.
describeSubscriptionFiltersAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
disassociateKmsKeyAsync
in interface AWSLogsAsync
public Future<DisassociateKmsKeyResult> disassociateKmsKeyAsync(DisassociateKmsKeyRequest request, AsyncHandler<DisassociateKmsKeyRequest,DisassociateKmsKeyResult> asyncHandler)
AWSLogsAsync
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.
disassociateKmsKeyAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
filterLogEventsAsync
in interface AWSLogsAsync
public Future<FilterLogEventsResult> filterLogEventsAsync(FilterLogEventsRequest request, AsyncHandler<FilterLogEventsRequest,FilterLogEventsResult> asyncHandler)
AWSLogsAsync
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.
filterLogEventsAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
getLogEventsAsync
in interface AWSLogsAsync
public Future<GetLogEventsResult> getLogEventsAsync(GetLogEventsRequest request, AsyncHandler<GetLogEventsRequest,GetLogEventsResult> asyncHandler)
AWSLogsAsync
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.
getLogEventsAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field. The search is limited to a time period that you specify.
In the results, fields that start with @ are fields generated by CloudWatch Logs. For example,
@timestamp
is the timestamp of each log event.
The response results are sorted by the frequency percentage, starting with the highest percentage.
getLogGroupFieldsAsync
in interface AWSLogsAsync
public Future<GetLogGroupFieldsResult> getLogGroupFieldsAsync(GetLogGroupFieldsRequest request, AsyncHandler<GetLogGroupFieldsRequest,GetLogGroupFieldsResult> asyncHandler)
AWSLogsAsync
Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field. The search is limited to a time period that you specify.
In the results, fields that start with @ are fields generated by CloudWatch Logs. For example,
@timestamp
is the timestamp of each log event.
The response results are sorted by the frequency percentage, starting with the highest percentage.
getLogGroupFieldsAsync
in interface AWSLogsAsync
asyncHandler
- 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 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.
Additionally, the entire unparsed log event is returned within @message
.
getLogRecordAsync
in interface AWSLogsAsync
public Future<GetLogRecordResult> getLogRecordAsync(GetLogRecordRequest request, AsyncHandler<GetLogRecordRequest,GetLogRecordResult> asyncHandler)
AWSLogsAsync
Retrieves all 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.
Additionally, the entire unparsed log event is returned within @message
.
getLogRecordAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Returns 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 operation to get the full log record.
GetQueryResults
does not start a query execution. To run a query, use .
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.
getQueryResultsAsync
in interface AWSLogsAsync
public Future<GetQueryResultsResult> getQueryResultsAsync(GetQueryResultsRequest request, AsyncHandler<GetQueryResultsRequest,GetQueryResultsResult> asyncHandler)
AWSLogsAsync
Returns 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 operation to get the full log record.
GetQueryResults
does not start a query execution. To run a query, use .
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.
getQueryResultsAsync
in interface AWSLogsAsync
asyncHandler
- 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<ListTagsLogGroupResult> listTagsLogGroupAsync(ListTagsLogGroupRequest request)
AWSLogsAsync
Lists the tags for the specified log group.
listTagsLogGroupAsync
in interface AWSLogsAsync
public Future<ListTagsLogGroupResult> listTagsLogGroupAsync(ListTagsLogGroupRequest request, AsyncHandler<ListTagsLogGroupRequest,ListTagsLogGroupResult> asyncHandler)
AWSLogsAsync
Lists the tags for the specified log group.
listTagsLogGroupAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Creates 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) and enables you to 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
.
putDestinationAsync
in interface AWSLogsAsync
public Future<PutDestinationResult> putDestinationAsync(PutDestinationRequest request, AsyncHandler<PutDestinationRequest,PutDestinationResult> asyncHandler)
AWSLogsAsync
Creates 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) and enables you to 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
.
putDestinationAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
putDestinationPolicyAsync
in interface AWSLogsAsync
public Future<PutDestinationPolicyResult> putDestinationPolicyAsync(PutDestinationPolicyRequest request, AsyncHandler<PutDestinationPolicyRequest,PutDestinationPolicyResult> asyncHandler)
AWSLogsAsync
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.
putDestinationPolicyAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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 in the
expectedSequenceToken
field from InvalidSequenceTokenException
. 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 older than the retention period of the log group.
The log events in the batch must be in chronological ordered by their timestamp. The timestamp 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.)
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.
There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.
If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.
putLogEventsAsync
in interface AWSLogsAsync
public Future<PutLogEventsResult> putLogEventsAsync(PutLogEventsRequest request, AsyncHandler<PutLogEventsRequest,PutLogEventsResult> asyncHandler)
AWSLogsAsync
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 in the
expectedSequenceToken
field from InvalidSequenceTokenException
. 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 older than the retention period of the log group.
The log events in the batch must be in chronological ordered by their timestamp. The timestamp 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.)
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.
There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.
If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.
putLogEventsAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
putMetricFilterAsync
in interface AWSLogsAsync
public Future<PutMetricFilterResult> putMetricFilterAsync(PutMetricFilterRequest request, AsyncHandler<PutMetricFilterRequest,PutMetricFilterResult> asyncHandler)
AWSLogsAsync
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.
putMetricFilterAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
putResourcePolicyAsync
in interface AWSLogsAsync
public Future<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest request, AsyncHandler<PutResourcePolicyRequest,PutResourcePolicyResult> asyncHandler)
AWSLogsAsync
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.
putResourcePolicyAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
putRetentionPolicyAsync
in interface AWSLogsAsync
public Future<PutRetentionPolicyResult> putRetentionPolicyAsync(PutRetentionPolicyRequest request, AsyncHandler<PutRetentionPolicyRequest,PutRetentionPolicyResult> asyncHandler)
AWSLogsAsync
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.
putRetentionPolicyAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
putSubscriptionFilterAsync
in interface AWSLogsAsync
public Future<PutSubscriptionFilterResult> putSubscriptionFilterAsync(PutSubscriptionFilterRequest request, AsyncHandler<PutSubscriptionFilterRequest,PutSubscriptionFilterResult> asyncHandler)
AWSLogsAsync
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.
putSubscriptionFilterAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Schedules 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 execution. If your queries are timing out, reduce the time range being searched, or partition your query into a number of queries.
startQueryAsync
in interface AWSLogsAsync
public Future<StartQueryResult> startQueryAsync(StartQueryRequest request, AsyncHandler<StartQueryRequest,StartQueryResult> asyncHandler)
AWSLogsAsync
Schedules 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 execution. If your queries are timing out, reduce the time range being searched, or partition your query into a number of queries.
startQueryAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
Stops 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 AWSLogsAsync
public Future<StopQueryResult> stopQueryAsync(StopQueryRequest request, AsyncHandler<StopQueryRequest,StopQueryResult> asyncHandler)
AWSLogsAsync
Stops 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 AWSLogsAsync
asyncHandler
- 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<TagLogGroupResult> tagLogGroupAsync(TagLogGroupRequest request)
AWSLogsAsync
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.
tagLogGroupAsync
in interface AWSLogsAsync
public Future<TagLogGroupResult> tagLogGroupAsync(TagLogGroupRequest request, AsyncHandler<TagLogGroupRequest,TagLogGroupResult> asyncHandler)
AWSLogsAsync
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.
tagLogGroupAsync
in interface AWSLogsAsync
asyncHandler
- 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)
AWSLogsAsync
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.
testMetricFilterAsync
in interface AWSLogsAsync
public Future<TestMetricFilterResult> testMetricFilterAsync(TestMetricFilterRequest request, AsyncHandler<TestMetricFilterRequest,TestMetricFilterResult> asyncHandler)
AWSLogsAsync
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.
testMetricFilterAsync
in interface AWSLogsAsync
asyncHandler
- 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<UntagLogGroupResult> untagLogGroupAsync(UntagLogGroupRequest request)
AWSLogsAsync
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.
untagLogGroupAsync
in interface AWSLogsAsync
public Future<UntagLogGroupResult> untagLogGroupAsync(UntagLogGroupRequest request, AsyncHandler<UntagLogGroupRequest,UntagLogGroupResult> asyncHandler)
AWSLogsAsync
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.
untagLogGroupAsync
in interface AWSLogsAsync
asyncHandler
- 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 © 2020. All rights reserved.