public interface AWSLogsAsync extends AWSLogs
AsyncHandler
can be
used to receive notification when an asynchronous operation completes.
This is the Amazon CloudWatch Logs API Reference. Amazon CloudWatch Logs enables you to monitor, store, and access your system, application, and custom log files. This guide provides detailed information about Amazon CloudWatch Logs actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch Logs features and their associated API calls, go to the Amazon CloudWatch Developer Guide.
Use the following links to get started using the Amazon CloudWatch Logs API Reference:
In addition to using the Amazon CloudWatch Logs API, you can also use the following SDKs and third-party libraries to access Amazon CloudWatch Logs programmatically.
Developers in the AWS developer community also provide their own libraries, which you can find at the following AWS developer centers:
Modifier and Type | Method and Description |
---|---|
Future<Void> |
cancelExportTaskAsync(CancelExportTaskRequest cancelExportTaskRequest)
Cancels an export task if it is in
PENDING or
RUNNING state. |
Future<Void> |
cancelExportTaskAsync(CancelExportTaskRequest cancelExportTaskRequest,
AsyncHandler<CancelExportTaskRequest,Void> asyncHandler)
Cancels an export task if it is in
PENDING or
RUNNING state. |
Future<CreateExportTaskResult> |
createExportTaskAsync(CreateExportTaskRequest createExportTaskRequest)
Creates an
ExportTask which allows you to efficiently export
data from a Log Group to your Amazon S3 bucket. |
Future<CreateExportTaskResult> |
createExportTaskAsync(CreateExportTaskRequest createExportTaskRequest,
AsyncHandler<CreateExportTaskRequest,CreateExportTaskResult> asyncHandler)
Creates an
ExportTask which allows you to efficiently export
data from a Log Group to your Amazon S3 bucket. |
Future<Void> |
createLogGroupAsync(CreateLogGroupRequest createLogGroupRequest)
Creates a new log group with the specified name.
|
Future<Void> |
createLogGroupAsync(CreateLogGroupRequest createLogGroupRequest,
AsyncHandler<CreateLogGroupRequest,Void> asyncHandler)
Creates a new log group with the specified name.
|
Future<Void> |
createLogStreamAsync(CreateLogStreamRequest createLogStreamRequest)
Creates a new log stream in the specified log group.
|
Future<Void> |
createLogStreamAsync(CreateLogStreamRequest createLogStreamRequest,
AsyncHandler<CreateLogStreamRequest,Void> asyncHandler)
Creates a new log stream in the specified log group.
|
Future<Void> |
deleteDestinationAsync(DeleteDestinationRequest deleteDestinationRequest)
Deletes the destination with the specified name and eventually disables
all the subscription filters that publish to it.
|
Future<Void> |
deleteDestinationAsync(DeleteDestinationRequest deleteDestinationRequest,
AsyncHandler<DeleteDestinationRequest,Void> asyncHandler)
Deletes the destination with the specified name and eventually disables
all the subscription filters that publish to it.
|
Future<Void> |
deleteLogGroupAsync(DeleteLogGroupRequest deleteLogGroupRequest)
Deletes the log group with the specified name and permanently deletes all
the archived log events associated with it.
|
Future<Void> |
deleteLogGroupAsync(DeleteLogGroupRequest deleteLogGroupRequest,
AsyncHandler<DeleteLogGroupRequest,Void> asyncHandler)
Deletes the log group with the specified name and permanently deletes all
the archived log events associated with it.
|
Future<Void> |
deleteLogStreamAsync(DeleteLogStreamRequest deleteLogStreamRequest)
Deletes a log stream and permanently deletes all the archived log events
associated with it.
|
Future<Void> |
deleteLogStreamAsync(DeleteLogStreamRequest deleteLogStreamRequest,
AsyncHandler<DeleteLogStreamRequest,Void> asyncHandler)
Deletes a log stream and permanently deletes all the archived log events
associated with it.
|
Future<Void> |
deleteMetricFilterAsync(DeleteMetricFilterRequest deleteMetricFilterRequest)
Deletes a metric filter associated with the specified log group.
|
Future<Void> |
deleteMetricFilterAsync(DeleteMetricFilterRequest deleteMetricFilterRequest,
AsyncHandler<DeleteMetricFilterRequest,Void> asyncHandler)
Deletes a metric filter associated with the specified log group.
|
Future<Void> |
deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
Deletes the retention policy of the specified log group.
|
Future<Void> |
deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest,
AsyncHandler<DeleteRetentionPolicyRequest,Void> asyncHandler)
Deletes the retention policy of the specified log group.
|
Future<Void> |
deleteSubscriptionFilterAsync(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest)
Deletes a subscription filter associated with the specified log group.
|
Future<Void> |
deleteSubscriptionFilterAsync(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest,
AsyncHandler<DeleteSubscriptionFilterRequest,Void> asyncHandler)
Deletes a subscription filter associated with the specified log group.
|
Future<DescribeDestinationsResult> |
describeDestinationsAsync()
Simplified method form for invoking the DescribeDestinations operation.
|
Future<DescribeDestinationsResult> |
describeDestinationsAsync(AsyncHandler<DescribeDestinationsRequest,DescribeDestinationsResult> asyncHandler)
Simplified method form for invoking the DescribeDestinations operation
with an AsyncHandler.
|
Future<DescribeDestinationsResult> |
describeDestinationsAsync(DescribeDestinationsRequest describeDestinationsRequest)
Returns all the destinations that are associated with the AWS account
making the request.
|
Future<DescribeDestinationsResult> |
describeDestinationsAsync(DescribeDestinationsRequest describeDestinationsRequest,
AsyncHandler<DescribeDestinationsRequest,DescribeDestinationsResult> asyncHandler)
Returns all the destinations that are associated with the AWS account
making the request.
|
Future<DescribeExportTasksResult> |
describeExportTasksAsync(DescribeExportTasksRequest describeExportTasksRequest)
Returns all the export tasks that are associated with the AWS account
making the request.
|
Future<DescribeExportTasksResult> |
describeExportTasksAsync(DescribeExportTasksRequest describeExportTasksRequest,
AsyncHandler<DescribeExportTasksRequest,DescribeExportTasksResult> asyncHandler)
Returns all the export tasks that are associated with the AWS account
making the request.
|
Future<DescribeLogGroupsResult> |
describeLogGroupsAsync()
Simplified method form for invoking the DescribeLogGroups operation.
|
Future<DescribeLogGroupsResult> |
describeLogGroupsAsync(AsyncHandler<DescribeLogGroupsRequest,DescribeLogGroupsResult> asyncHandler)
Simplified method form for invoking the DescribeLogGroups operation with
an AsyncHandler.
|
Future<DescribeLogGroupsResult> |
describeLogGroupsAsync(DescribeLogGroupsRequest describeLogGroupsRequest)
Returns all the log groups that are associated with the AWS account
making the request.
|
Future<DescribeLogGroupsResult> |
describeLogGroupsAsync(DescribeLogGroupsRequest describeLogGroupsRequest,
AsyncHandler<DescribeLogGroupsRequest,DescribeLogGroupsResult> asyncHandler)
Returns all the log groups that are associated with the AWS account
making the request.
|
Future<DescribeLogStreamsResult> |
describeLogStreamsAsync(DescribeLogStreamsRequest describeLogStreamsRequest)
Returns all the log streams that are associated with the specified log
group.
|
Future<DescribeLogStreamsResult> |
describeLogStreamsAsync(DescribeLogStreamsRequest describeLogStreamsRequest,
AsyncHandler<DescribeLogStreamsRequest,DescribeLogStreamsResult> asyncHandler)
Returns all the log streams that are associated with the specified log
group.
|
Future<DescribeMetricFiltersResult> |
describeMetricFiltersAsync(DescribeMetricFiltersRequest describeMetricFiltersRequest)
Returns all the metrics filters associated with the specified log group.
|
Future<DescribeMetricFiltersResult> |
describeMetricFiltersAsync(DescribeMetricFiltersRequest describeMetricFiltersRequest,
AsyncHandler<DescribeMetricFiltersRequest,DescribeMetricFiltersResult> asyncHandler)
Returns all the metrics filters associated with the specified log group.
|
Future<DescribeSubscriptionFiltersResult> |
describeSubscriptionFiltersAsync(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)
Returns all the subscription filters associated with the specified log
group.
|
Future<DescribeSubscriptionFiltersResult> |
describeSubscriptionFiltersAsync(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest,
AsyncHandler<DescribeSubscriptionFiltersRequest,DescribeSubscriptionFiltersResult> asyncHandler)
Returns all the subscription filters associated with the specified log
group.
|
Future<FilterLogEventsResult> |
filterLogEventsAsync(FilterLogEventsRequest filterLogEventsRequest)
Retrieves log events, optionally filtered by a filter pattern from the
specified log group.
|
Future<FilterLogEventsResult> |
filterLogEventsAsync(FilterLogEventsRequest filterLogEventsRequest,
AsyncHandler<FilterLogEventsRequest,FilterLogEventsResult> asyncHandler)
Retrieves log events, optionally filtered by a filter pattern from the
specified log group.
|
Future<GetLogEventsResult> |
getLogEventsAsync(GetLogEventsRequest getLogEventsRequest)
Retrieves log events from the specified log stream.
|
Future<GetLogEventsResult> |
getLogEventsAsync(GetLogEventsRequest getLogEventsRequest,
AsyncHandler<GetLogEventsRequest,GetLogEventsResult> asyncHandler)
Retrieves log events from the specified log stream.
|
Future<PutDestinationResult> |
putDestinationAsync(PutDestinationRequest putDestinationRequest)
Creates or updates a
Destination . |
Future<PutDestinationResult> |
putDestinationAsync(PutDestinationRequest putDestinationRequest,
AsyncHandler<PutDestinationRequest,PutDestinationResult> asyncHandler)
Creates or updates a
Destination . |
Future<Void> |
putDestinationPolicyAsync(PutDestinationPolicyRequest putDestinationPolicyRequest)
Creates or updates an access policy associated with an existing
Destination . |
Future<Void> |
putDestinationPolicyAsync(PutDestinationPolicyRequest putDestinationPolicyRequest,
AsyncHandler<PutDestinationPolicyRequest,Void> asyncHandler)
Creates or updates an access policy associated with an existing
Destination . |
Future<PutLogEventsResult> |
putLogEventsAsync(PutLogEventsRequest putLogEventsRequest)
Uploads a batch of log events to the specified log stream.
|
Future<PutLogEventsResult> |
putLogEventsAsync(PutLogEventsRequest putLogEventsRequest,
AsyncHandler<PutLogEventsRequest,PutLogEventsResult> asyncHandler)
Uploads a batch of log events to the specified log stream.
|
Future<Void> |
putMetricFilterAsync(PutMetricFilterRequest putMetricFilterRequest)
Creates or updates a metric filter and associates it with the specified
log group.
|
Future<Void> |
putMetricFilterAsync(PutMetricFilterRequest putMetricFilterRequest,
AsyncHandler<PutMetricFilterRequest,Void> asyncHandler)
Creates or updates a metric filter and associates it with the specified
log group.
|
Future<Void> |
putRetentionPolicyAsync(PutRetentionPolicyRequest putRetentionPolicyRequest)
Sets the retention of the specified log group.
|
Future<Void> |
putRetentionPolicyAsync(PutRetentionPolicyRequest putRetentionPolicyRequest,
AsyncHandler<PutRetentionPolicyRequest,Void> asyncHandler)
Sets the retention of the specified log group.
|
Future<Void> |
putSubscriptionFilterAsync(PutSubscriptionFilterRequest putSubscriptionFilterRequest)
Creates or updates a subscription filter and associates it with the
specified log group.
|
Future<Void> |
putSubscriptionFilterAsync(PutSubscriptionFilterRequest putSubscriptionFilterRequest,
AsyncHandler<PutSubscriptionFilterRequest,Void> asyncHandler)
Creates or updates a subscription filter and associates it with the
specified log group.
|
Future<TestMetricFilterResult> |
testMetricFilterAsync(TestMetricFilterRequest testMetricFilterRequest)
Tests the filter pattern of a metric filter against a sample of log event
messages.
|
Future<TestMetricFilterResult> |
testMetricFilterAsync(TestMetricFilterRequest testMetricFilterRequest,
AsyncHandler<TestMetricFilterRequest,TestMetricFilterResult> asyncHandler)
Tests the filter pattern of a metric filter against a sample of log event
messages.
|
cancelExportTask, createExportTask, createLogGroup, createLogStream, deleteDestination, deleteLogGroup, deleteLogStream, deleteMetricFilter, deleteRetentionPolicy, deleteSubscriptionFilter, describeDestinations, describeDestinations, describeExportTasks, describeLogGroups, describeLogGroups, describeLogStreams, describeMetricFilters, describeSubscriptionFilters, filterLogEvents, getCachedResponseMetadata, getLogEvents, putDestination, putDestinationPolicy, putLogEvents, putMetricFilter, putRetentionPolicy, putSubscriptionFilter, setEndpoint, setRegion, shutdown, testMetricFilter
Future<Void> cancelExportTaskAsync(CancelExportTaskRequest cancelExportTaskRequest)
Cancels an export task if it is in PENDING
or
RUNNING
state.
cancelExportTaskRequest
- Future<Void> cancelExportTaskAsync(CancelExportTaskRequest cancelExportTaskRequest, AsyncHandler<CancelExportTaskRequest,Void> asyncHandler)
Cancels an export task if it is in PENDING
or
RUNNING
state.
cancelExportTaskRequest
- 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.Future<CreateExportTaskResult> createExportTaskAsync(CreateExportTaskRequest createExportTaskRequest)
Creates an ExportTask
which allows you to efficiently export
data from a Log Group to your Amazon S3 bucket.
This is an asynchronous call. If all the required information is
provided, this API will initiate an export task and respond with the task
Id. Once started, DescribeExportTasks
can be used to get the
status of an export task.
createExportTaskRequest
- Future<CreateExportTaskResult> createExportTaskAsync(CreateExportTaskRequest createExportTaskRequest, AsyncHandler<CreateExportTaskRequest,CreateExportTaskResult> asyncHandler)
Creates an ExportTask
which allows you to efficiently export
data from a Log Group to your Amazon S3 bucket.
This is an asynchronous call. If all the required information is
provided, this API will initiate an export task and respond with the task
Id. Once started, DescribeExportTasks
can be used to get the
status of an export task.
createExportTaskRequest
- 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.Future<Void> createLogGroupAsync(CreateLogGroupRequest createLogGroupRequest)
Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.
You must use the following guidelines when naming a log group:
createLogGroupRequest
- Future<Void> createLogGroupAsync(CreateLogGroupRequest createLogGroupRequest, AsyncHandler<CreateLogGroupRequest,Void> asyncHandler)
Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.
You must use the following guidelines when naming a log group:
createLogGroupRequest
- 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.Future<Void> createLogStreamAsync(CreateLogStreamRequest createLogStreamRequest)
Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.
You must use the following guidelines when naming a log stream:
createLogStreamRequest
- Future<Void> createLogStreamAsync(CreateLogStreamRequest createLogStreamRequest, AsyncHandler<CreateLogStreamRequest,Void> asyncHandler)
Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.
You must use the following guidelines when naming a log stream:
createLogStreamRequest
- 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.Future<Void> deleteDestinationAsync(DeleteDestinationRequest deleteDestinationRequest)
Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination.
deleteDestinationRequest
- Future<Void> deleteDestinationAsync(DeleteDestinationRequest deleteDestinationRequest, AsyncHandler<DeleteDestinationRequest,Void> asyncHandler)
Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination.
deleteDestinationRequest
- 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.Future<Void> deleteLogGroupAsync(DeleteLogGroupRequest deleteLogGroupRequest)
Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
deleteLogGroupRequest
- Future<Void> deleteLogGroupAsync(DeleteLogGroupRequest deleteLogGroupRequest, AsyncHandler<DeleteLogGroupRequest,Void> asyncHandler)
Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
deleteLogGroupRequest
- 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.Future<Void> deleteLogStreamAsync(DeleteLogStreamRequest deleteLogStreamRequest)
Deletes a log stream and permanently deletes all the archived log events associated with it.
deleteLogStreamRequest
- Future<Void> deleteLogStreamAsync(DeleteLogStreamRequest deleteLogStreamRequest, AsyncHandler<DeleteLogStreamRequest,Void> asyncHandler)
Deletes a log stream and permanently deletes all the archived log events associated with it.
deleteLogStreamRequest
- 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.Future<Void> deleteMetricFilterAsync(DeleteMetricFilterRequest deleteMetricFilterRequest)
Deletes a metric filter associated with the specified log group.
deleteMetricFilterRequest
- Future<Void> deleteMetricFilterAsync(DeleteMetricFilterRequest deleteMetricFilterRequest, AsyncHandler<DeleteMetricFilterRequest,Void> asyncHandler)
Deletes a metric filter associated with the specified log group.
deleteMetricFilterRequest
- 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.Future<Void> deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.
deleteRetentionPolicyRequest
- Future<Void> deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest, AsyncHandler<DeleteRetentionPolicyRequest,Void> asyncHandler)
Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.
deleteRetentionPolicyRequest
- 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.Future<Void> deleteSubscriptionFilterAsync(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest)
Deletes a subscription filter associated with the specified log group.
deleteSubscriptionFilterRequest
- Future<Void> deleteSubscriptionFilterAsync(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest, AsyncHandler<DeleteSubscriptionFilterRequest,Void> asyncHandler)
Deletes a subscription filter associated with the specified log group.
deleteSubscriptionFilterRequest
- 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.Future<DescribeDestinationsResult> describeDestinationsAsync(DescribeDestinationsRequest describeDestinationsRequest)
Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name.
By default, this operation returns up to 50 destinations. If there are
more destinations to list, the response would contain a
nextToken
value in the response body. You can
also limit the number of destinations returned in the response by
specifying the limit
parameter in the request.
describeDestinationsRequest
- Future<DescribeDestinationsResult> describeDestinationsAsync(DescribeDestinationsRequest describeDestinationsRequest, AsyncHandler<DescribeDestinationsRequest,DescribeDestinationsResult> asyncHandler)
Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name.
By default, this operation returns up to 50 destinations. If there are
more destinations to list, the response would contain a
nextToken
value in the response body. You can
also limit the number of destinations returned in the response by
specifying the limit
parameter in the request.
describeDestinationsRequest
- 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.Future<DescribeDestinationsResult> describeDestinationsAsync()
Future<DescribeDestinationsResult> describeDestinationsAsync(AsyncHandler<DescribeDestinationsRequest,DescribeDestinationsResult> asyncHandler)
Future<DescribeExportTasksResult> describeExportTasksAsync(DescribeExportTasksRequest describeExportTasksRequest)
Returns all the export tasks that are associated with the AWS account
making the request. The export tasks can be filtered based on
TaskId
or TaskStatus
.
By default, this operation returns up to 50 export tasks that satisfy the
specified filters. If there are more export tasks to list, the response
would contain a nextToken
value in the response
body. You can also limit the number of export tasks returned in the
response by specifying the limit
parameter in
the request.
describeExportTasksRequest
- Future<DescribeExportTasksResult> describeExportTasksAsync(DescribeExportTasksRequest describeExportTasksRequest, AsyncHandler<DescribeExportTasksRequest,DescribeExportTasksResult> asyncHandler)
Returns all the export tasks that are associated with the AWS account
making the request. The export tasks can be filtered based on
TaskId
or TaskStatus
.
By default, this operation returns up to 50 export tasks that satisfy the
specified filters. If there are more export tasks to list, the response
would contain a nextToken
value in the response
body. You can also limit the number of export tasks returned in the
response by specifying the limit
parameter in
the request.
describeExportTasksRequest
- 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.Future<DescribeLogGroupsResult> describeLogGroupsAsync(DescribeLogGroupsRequest describeLogGroupsRequest)
Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.
By default, this operation returns up to 50 log groups. If there are more
log groups to list, the response would contain a
nextToken
value in the response body. You can
also limit the number of log groups returned in the response by
specifying the limit
parameter in the request.
describeLogGroupsRequest
- Future<DescribeLogGroupsResult> describeLogGroupsAsync(DescribeLogGroupsRequest describeLogGroupsRequest, AsyncHandler<DescribeLogGroupsRequest,DescribeLogGroupsResult> asyncHandler)
Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.
By default, this operation returns up to 50 log groups. If there are more
log groups to list, the response would contain a
nextToken
value in the response body. You can
also limit the number of log groups returned in the response by
specifying the limit
parameter in the request.
describeLogGroupsRequest
- 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.Future<DescribeLogGroupsResult> describeLogGroupsAsync()
Future<DescribeLogGroupsResult> describeLogGroupsAsync(AsyncHandler<DescribeLogGroupsRequest,DescribeLogGroupsResult> asyncHandler)
Future<DescribeLogStreamsResult> describeLogStreamsAsync(DescribeLogStreamsRequest describeLogStreamsRequest)
Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.
By default, this operation returns up to 50 log streams. If there are
more log streams to list, the response would contain a
nextToken
value in the response body. You can
also limit the number of log streams returned in the response by
specifying the limit
parameter in the request.
This operation has a limit of five transactions per second, after which
transactions are throttled.
describeLogStreamsRequest
- Future<DescribeLogStreamsResult> describeLogStreamsAsync(DescribeLogStreamsRequest describeLogStreamsRequest, AsyncHandler<DescribeLogStreamsRequest,DescribeLogStreamsResult> asyncHandler)
Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.
By default, this operation returns up to 50 log streams. If there are
more log streams to list, the response would contain a
nextToken
value in the response body. You can
also limit the number of log streams returned in the response by
specifying the limit
parameter in the request.
This operation has a limit of five transactions per second, after which
transactions are throttled.
describeLogStreamsRequest
- 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.Future<DescribeMetricFiltersResult> describeMetricFiltersAsync(DescribeMetricFiltersRequest describeMetricFiltersRequest)
Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.
By default, this operation returns up to 50 metric filters. If there are
more metric filters to list, the response would contain a
nextToken
value in the response body. You can
also limit the number of metric filters returned in the response by
specifying the limit
parameter in the request.
describeMetricFiltersRequest
- Future<DescribeMetricFiltersResult> describeMetricFiltersAsync(DescribeMetricFiltersRequest describeMetricFiltersRequest, AsyncHandler<DescribeMetricFiltersRequest,DescribeMetricFiltersResult> asyncHandler)
Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.
By default, this operation returns up to 50 metric filters. If there are
more metric filters to list, the response would contain a
nextToken
value in the response body. You can
also limit the number of metric filters returned in the response by
specifying the limit
parameter in the request.
describeMetricFiltersRequest
- 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.Future<DescribeSubscriptionFiltersResult> describeSubscriptionFiltersAsync(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)
Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.
By default, this operation returns up to 50 subscription filters. If
there are more subscription filters to list, the response would contain a
nextToken
value in the response body. You can
also limit the number of subscription filters returned in the response by
specifying the limit
parameter in the request.
describeSubscriptionFiltersRequest
- Future<DescribeSubscriptionFiltersResult> describeSubscriptionFiltersAsync(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest, AsyncHandler<DescribeSubscriptionFiltersRequest,DescribeSubscriptionFiltersResult> asyncHandler)
Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.
By default, this operation returns up to 50 subscription filters. If
there are more subscription filters to list, the response would contain a
nextToken
value in the response body. You can
also limit the number of subscription filters returned in the response by
specifying the limit
parameter in the request.
describeSubscriptionFiltersRequest
- 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.Future<FilterLogEventsResult> filterLogEventsAsync(FilterLogEventsRequest filterLogEventsRequest)
Retrieves log events, optionally filtered by a filter pattern from the
specified log group. You can provide an optional time range to filter the
results on the event timestamp
. You can limit
the streams searched to an explicit list of
logStreamNames
.
By default, this operation returns as much matching log events as can fit
in a response size of 1MB, up to 10,000 log events, or all the events
found within a time-bounded scan window. If the response includes a
nextToken
, then there is more data to search,
and the search can be resumed with a new request providing the nextToken.
The response will contain a list of
searchedLogStreams
that contains information
about which streams were searched in the request and whether they have
been searched completely or require further pagination. The
limit
parameter in the request. can be used to
specify the maximum number of events to return in a page.
filterLogEventsRequest
- Future<FilterLogEventsResult> filterLogEventsAsync(FilterLogEventsRequest filterLogEventsRequest, AsyncHandler<FilterLogEventsRequest,FilterLogEventsResult> asyncHandler)
Retrieves log events, optionally filtered by a filter pattern from the
specified log group. You can provide an optional time range to filter the
results on the event timestamp
. You can limit
the streams searched to an explicit list of
logStreamNames
.
By default, this operation returns as much matching log events as can fit
in a response size of 1MB, up to 10,000 log events, or all the events
found within a time-bounded scan window. If the response includes a
nextToken
, then there is more data to search,
and the search can be resumed with a new request providing the nextToken.
The response will contain a list of
searchedLogStreams
that contains information
about which streams were searched in the request and whether they have
been searched completely or require further pagination. The
limit
parameter in the request. can be used to
specify the maximum number of events to return in a page.
filterLogEventsRequest
- 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.Future<GetLogEventsResult> getLogEventsAsync(GetLogEventsRequest getLogEventsRequest)
Retrieves log events from the specified log stream. You can provide an
optional time range to filter the results on the event
timestamp
.
By default, this operation returns as much log events as can fit in a
response size of 1MB, up to 10,000 log events. The response will always
include a nextForwardToken
and a
nextBackwardToken
in the response body. You can
use any of these tokens in subsequent
GetLogEvents
requests to paginate through
events in either forward or backward direction. You can also limit the
number of log events returned in the response by specifying the
limit
parameter in the request.
getLogEventsRequest
- Future<GetLogEventsResult> getLogEventsAsync(GetLogEventsRequest getLogEventsRequest, AsyncHandler<GetLogEventsRequest,GetLogEventsResult> asyncHandler)
Retrieves log events from the specified log stream. You can provide an
optional time range to filter the results on the event
timestamp
.
By default, this operation returns as much log events as can fit in a
response size of 1MB, up to 10,000 log events. The response will always
include a nextForwardToken
and a
nextBackwardToken
in the response body. You can
use any of these tokens in subsequent
GetLogEvents
requests to paginate through
events in either forward or backward direction. You can also limit the
number of log events returned in the response by specifying the
limit
parameter in the request.
getLogEventsRequest
- 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.Future<PutDestinationResult> putDestinationAsync(PutDestinationRequest putDestinationRequest)
Creates or updates a Destination
. A destination encapsulates
a physical resource (such as a Kinesis stream) and allows you to
subscribe to a real-time stream of log events of a different account,
ingested through PutLogEvents
requests.
Currently, the only supported physical resource is a Amazon Kinesis
stream belonging to the same account as the destination.
A destination controls what is written to its Amazon Kinesis stream
through an access policy. By default, PutDestination does not set any
access policy with the destination, which means a cross-account user will
not be able to call PutSubscriptionFilter
against this
destination. To enable that, the destination owner must call
PutDestinationPolicy
after PutDestination.
putDestinationRequest
- Future<PutDestinationResult> putDestinationAsync(PutDestinationRequest putDestinationRequest, AsyncHandler<PutDestinationRequest,PutDestinationResult> asyncHandler)
Creates or updates a Destination
. A destination encapsulates
a physical resource (such as a Kinesis stream) and allows you to
subscribe to a real-time stream of log events of a different account,
ingested through PutLogEvents
requests.
Currently, the only supported physical resource is a Amazon Kinesis
stream belonging to the same account as the destination.
A destination controls what is written to its Amazon Kinesis stream
through an access policy. By default, PutDestination does not set any
access policy with the destination, which means a cross-account user will
not be able to call PutSubscriptionFilter
against this
destination. To enable that, the destination owner must call
PutDestinationPolicy
after PutDestination.
putDestinationRequest
- 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.Future<Void> putDestinationPolicyAsync(PutDestinationPolicyRequest putDestinationPolicyRequest)
Creates or updates an access policy associated with an existing
Destination
. An access policy is an IAM policy document that is used to authorize claims to register a
subscription filter against a given destination.
putDestinationPolicyRequest
- Future<Void> putDestinationPolicyAsync(PutDestinationPolicyRequest putDestinationPolicyRequest, AsyncHandler<PutDestinationPolicyRequest,Void> asyncHandler)
Creates or updates an access policy associated with an existing
Destination
. An access policy is an IAM policy document that is used to authorize claims to register a
subscription filter against a given destination.
putDestinationPolicyRequest
- 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.Future<PutLogEventsResult> putLogEventsAsync(PutLogEventsRequest putLogEventsRequest)
Uploads a batch of log events to the specified log stream.
Every PutLogEvents request must include the
sequenceToken
obtained from the response of the
previous request. An upload in a newly created log stream does not
require a sequenceToken
.
The batch of events must satisfy the following constraints:
timestamp
.putLogEventsRequest
- Future<PutLogEventsResult> putLogEventsAsync(PutLogEventsRequest putLogEventsRequest, AsyncHandler<PutLogEventsRequest,PutLogEventsResult> asyncHandler)
Uploads a batch of log events to the specified log stream.
Every PutLogEvents request must include the
sequenceToken
obtained from the response of the
previous request. An upload in a newly created log stream does not
require a sequenceToken
.
The batch of events must satisfy the following constraints:
timestamp
.putLogEventsRequest
- 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.Future<Void> putMetricFilterAsync(PutMetricFilterRequest putMetricFilterRequest)
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
requests.
The maximum number of metric filters that can be associated with a log group is 100.
putMetricFilterRequest
- Future<Void> putMetricFilterAsync(PutMetricFilterRequest putMetricFilterRequest, AsyncHandler<PutMetricFilterRequest,Void> asyncHandler)
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
requests.
The maximum number of metric filters that can be associated with a log group is 100.
putMetricFilterRequest
- 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.Future<Void> putRetentionPolicyAsync(PutRetentionPolicyRequest putRetentionPolicyRequest)
Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.
putRetentionPolicyRequest
- Future<Void> putRetentionPolicyAsync(PutRetentionPolicyRequest putRetentionPolicyRequest, AsyncHandler<PutRetentionPolicyRequest,Void> asyncHandler)
Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.
putRetentionPolicyRequest
- 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.Future<Void> putSubscriptionFilterAsync(PutSubscriptionFilterRequest putSubscriptionFilterRequest)
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
requests and have them delivered
to a specific destination. Currently, the supported destinations are:
Destination
)
belonging to a different account, for cross-account delivery.Currently there can only be one subscription filter associated with a log group.
putSubscriptionFilterRequest
- Future<Void> putSubscriptionFilterAsync(PutSubscriptionFilterRequest putSubscriptionFilterRequest, AsyncHandler<PutSubscriptionFilterRequest,Void> asyncHandler)
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
requests and have them delivered
to a specific destination. Currently, the supported destinations are:
Destination
)
belonging to a different account, for cross-account delivery.Currently there can only be one subscription filter associated with a log group.
putSubscriptionFilterRequest
- 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.Future<TestMetricFilterResult> testMetricFilterAsync(TestMetricFilterRequest testMetricFilterRequest)
Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.
testMetricFilterRequest
- Future<TestMetricFilterResult> testMetricFilterAsync(TestMetricFilterRequest testMetricFilterRequest, AsyncHandler<TestMetricFilterRequest,TestMetricFilterResult> asyncHandler)
Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.
testMetricFilterRequest
- 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 © 2015. All rights reserved.