public interface AWSLogsAsync extends AWSLogs
This is the Amazon CloudWatch Logs API Reference . Amazon CloudWatch Logs is a managed service for real time monitoring and archival of application logs. 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 Logs 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> |
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> |
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<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<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<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<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.
|
createLogGroup, createLogStream, deleteLogGroup, deleteLogStream, deleteMetricFilter, deleteRetentionPolicy, describeLogGroups, describeLogGroups, describeLogStreams, describeMetricFilters, getCachedResponseMetadata, getLogEvents, putLogEvents, putMetricFilter, putRetentionPolicy, setEndpoint, setRegion, shutdown, testMetricFilter
Future<Void> putRetentionPolicyAsync(PutRetentionPolicyRequest putRetentionPolicyRequest) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary
parameters to execute the PutRetentionPolicy operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> putRetentionPolicyAsync(PutRetentionPolicyRequest putRetentionPolicyRequest, AsyncHandler<PutRetentionPolicyRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary
parameters to execute the PutRetentionPolicy operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<DescribeMetricFiltersResult> describeMetricFiltersAsync(DescribeMetricFiltersRequest describeMetricFiltersRequest) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary
parameters to execute the DescribeMetricFilters operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<DescribeMetricFiltersResult> describeMetricFiltersAsync(DescribeMetricFiltersRequest describeMetricFiltersRequest, AsyncHandler<DescribeMetricFiltersRequest,DescribeMetricFiltersResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary
parameters to execute the DescribeMetricFilters operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<DescribeLogStreamsResult> describeLogStreamsAsync(DescribeLogStreamsRequest describeLogStreamsRequest) throws AmazonServiceException, AmazonClientException
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.
describeLogStreamsRequest
- Container for the necessary
parameters to execute the DescribeLogStreams operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<DescribeLogStreamsResult> describeLogStreamsAsync(DescribeLogStreamsRequest describeLogStreamsRequest, AsyncHandler<DescribeLogStreamsRequest,DescribeLogStreamsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
describeLogStreamsRequest
- Container for the necessary
parameters to execute the DescribeLogStreams operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteLogGroupAsync(DeleteLogGroupRequest deleteLogGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
deleteLogGroupRequest
- Container for the necessary parameters to
execute the DeleteLogGroup operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteLogGroupAsync(DeleteLogGroupRequest deleteLogGroupRequest, AsyncHandler<DeleteLogGroupRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
deleteLogGroupRequest
- Container for the necessary parameters to
execute the DeleteLogGroup operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> createLogGroupAsync(CreateLogGroupRequest createLogGroupRequest) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters to
execute the CreateLogGroup operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> createLogGroupAsync(CreateLogGroupRequest createLogGroupRequest, AsyncHandler<CreateLogGroupRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters to
execute the CreateLogGroup operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> putMetricFilterAsync(PutMetricFilterRequest putMetricFilterRequest) throws AmazonServiceException, AmazonClientException
Creates or updates a metric filter and associates it with the
specified log group. Metric filters allow you to configure rules to
extract metric data from log events ingested through
PutLogEvents
requests.
putMetricFilterRequest
- Container for the necessary parameters
to execute the PutMetricFilter operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> putMetricFilterAsync(PutMetricFilterRequest putMetricFilterRequest, AsyncHandler<PutMetricFilterRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates or updates a metric filter and associates it with the
specified log group. Metric filters allow you to configure rules to
extract metric data from log events ingested through
PutLogEvents
requests.
putMetricFilterRequest
- Container for the necessary parameters
to execute the PutMetricFilter operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteMetricFilterAsync(DeleteMetricFilterRequest deleteMetricFilterRequest) throws AmazonServiceException, AmazonClientException
Deletes a metric filter associated with the specified log group.
deleteMetricFilterRequest
- Container for the necessary
parameters to execute the DeleteMetricFilter operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteMetricFilterAsync(DeleteMetricFilterRequest deleteMetricFilterRequest, AsyncHandler<DeleteMetricFilterRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a metric filter associated with the specified log group.
deleteMetricFilterRequest
- Container for the necessary
parameters to execute the DeleteMetricFilter operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<TestMetricFilterResult> testMetricFilterAsync(TestMetricFilterRequest testMetricFilterRequest) throws AmazonServiceException, AmazonClientException
Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.
testMetricFilterRequest
- Container for the necessary parameters
to execute the TestMetricFilter operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<TestMetricFilterResult> testMetricFilterAsync(TestMetricFilterRequest testMetricFilterRequest, AsyncHandler<TestMetricFilterRequest,TestMetricFilterResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.
testMetricFilterRequest
- Container for the necessary parameters
to execute the TestMetricFilter operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<PutLogEventsResult> putLogEventsAsync(PutLogEventsRequest putLogEventsRequest) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters to
execute the PutLogEvents operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<PutLogEventsResult> putLogEventsAsync(PutLogEventsRequest putLogEventsRequest, AsyncHandler<PutLogEventsRequest,PutLogEventsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters to
execute the PutLogEvents operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary
parameters to execute the DeleteRetentionPolicy operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteRetentionPolicyAsync(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest, AsyncHandler<DeleteRetentionPolicyRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary
parameters to execute the DeleteRetentionPolicy operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<GetLogEventsResult> getLogEventsAsync(GetLogEventsRequest getLogEventsRequest) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters to
execute the GetLogEvents operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<GetLogEventsResult> getLogEventsAsync(GetLogEventsRequest getLogEventsRequest, AsyncHandler<GetLogEventsRequest,GetLogEventsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters to
execute the GetLogEvents operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> createLogStreamAsync(CreateLogStreamRequest createLogStreamRequest) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters
to execute the CreateLogStream operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> createLogStreamAsync(CreateLogStreamRequest createLogStreamRequest, AsyncHandler<CreateLogStreamRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters
to execute the CreateLogStream operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteLogStreamAsync(DeleteLogStreamRequest deleteLogStreamRequest) throws AmazonServiceException, AmazonClientException
Deletes a log stream and permanently deletes all the archived log events associated with it.
deleteLogStreamRequest
- Container for the necessary parameters
to execute the DeleteLogStream operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<Void> deleteLogStreamAsync(DeleteLogStreamRequest deleteLogStreamRequest, AsyncHandler<DeleteLogStreamRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a log stream and permanently deletes all the archived log events associated with it.
deleteLogStreamRequest
- Container for the necessary parameters
to execute the DeleteLogStream operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<DescribeLogGroupsResult> describeLogGroupsAsync(DescribeLogGroupsRequest describeLogGroupsRequest) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters
to execute the DescribeLogGroups operation on AWSLogs.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Future<DescribeLogGroupsResult> describeLogGroupsAsync(DescribeLogGroupsRequest describeLogGroupsRequest, AsyncHandler<DescribeLogGroupsRequest,DescribeLogGroupsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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
- Container for the necessary parameters
to execute the DescribeLogGroups operation on AWSLogs.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSLogs indicating
either a problem with the data in the request, or a server side issue.Copyright © 2014. All rights reserved.