@Generated(value="software.amazon.awssdk:codegen") public interface CloudWatchLogsAsyncClient extends SdkClient
builder()
method.
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon EC2 instances, AWS CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
You can use CloudWatch Logs to:
Monitor logs from EC2 instances in real-time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.
Monitor AWS CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.
Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AssociateKmsKeyResponse> |
associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest)
Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log
group.
|
default CompletableFuture<AssociateKmsKeyResponse> |
associateKmsKey(Consumer<AssociateKmsKeyRequest.Builder> associateKmsKeyRequest)
Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log
group.
|
static CloudWatchLogsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudWatchLogsAsyncClient . |
default CompletableFuture<CancelExportTaskResponse> |
cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)
Cancels the specified export task.
|
default CompletableFuture<CancelExportTaskResponse> |
cancelExportTask(Consumer<CancelExportTaskRequest.Builder> cancelExportTaskRequest)
Cancels the specified export task.
|
static CloudWatchLogsAsyncClient |
create()
Create a
CloudWatchLogsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateExportTaskResponse> |
createExportTask(Consumer<CreateExportTaskRequest.Builder> createExportTaskRequest)
Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
|
default CompletableFuture<CreateExportTaskResponse> |
createExportTask(CreateExportTaskRequest createExportTaskRequest)
Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
|
default CompletableFuture<CreateLogGroupResponse> |
createLogGroup(Consumer<CreateLogGroupRequest.Builder> createLogGroupRequest)
Creates a log group with the specified name.
|
default CompletableFuture<CreateLogGroupResponse> |
createLogGroup(CreateLogGroupRequest createLogGroupRequest)
Creates a log group with the specified name.
|
default CompletableFuture<CreateLogStreamResponse> |
createLogStream(Consumer<CreateLogStreamRequest.Builder> createLogStreamRequest)
Creates a log stream for the specified log group.
|
default CompletableFuture<CreateLogStreamResponse> |
createLogStream(CreateLogStreamRequest createLogStreamRequest)
Creates a log stream for the specified log group.
|
default CompletableFuture<DeleteDestinationResponse> |
deleteDestination(Consumer<DeleteDestinationRequest.Builder> deleteDestinationRequest)
Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
|
default CompletableFuture<DeleteDestinationResponse> |
deleteDestination(DeleteDestinationRequest deleteDestinationRequest)
Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
|
default CompletableFuture<DeleteLogGroupResponse> |
deleteLogGroup(Consumer<DeleteLogGroupRequest.Builder> deleteLogGroupRequest)
Deletes the specified log group and permanently deletes all the archived log events associated with the log
group.
|
default CompletableFuture<DeleteLogGroupResponse> |
deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest)
Deletes the specified log group and permanently deletes all the archived log events associated with the log
group.
|
default CompletableFuture<DeleteLogStreamResponse> |
deleteLogStream(Consumer<DeleteLogStreamRequest.Builder> deleteLogStreamRequest)
Deletes the specified log stream and permanently deletes all the archived log events associated with the log
stream.
|
default CompletableFuture<DeleteLogStreamResponse> |
deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest)
Deletes the specified log stream and permanently deletes all the archived log events associated with the log
stream.
|
default CompletableFuture<DeleteMetricFilterResponse> |
deleteMetricFilter(Consumer<DeleteMetricFilterRequest.Builder> deleteMetricFilterRequest)
Deletes the specified metric filter.
|
default CompletableFuture<DeleteMetricFilterResponse> |
deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest)
Deletes the specified metric filter.
|
default CompletableFuture<DeleteResourcePolicyResponse> |
deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
Deletes a resource policy from this account.
|
default CompletableFuture<DeleteResourcePolicyResponse> |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a resource policy from this account.
|
default CompletableFuture<DeleteRetentionPolicyResponse> |
deleteRetentionPolicy(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest)
Deletes the specified retention policy.
|
default CompletableFuture<DeleteRetentionPolicyResponse> |
deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
Deletes the specified retention policy.
|
default CompletableFuture<DeleteSubscriptionFilterResponse> |
deleteSubscriptionFilter(Consumer<DeleteSubscriptionFilterRequest.Builder> deleteSubscriptionFilterRequest)
Deletes the specified subscription filter.
|
default CompletableFuture<DeleteSubscriptionFilterResponse> |
deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest)
Deletes the specified subscription filter.
|
default CompletableFuture<DescribeDestinationsResponse> |
describeDestinations()
Lists all your destinations.
|
default CompletableFuture<DescribeDestinationsResponse> |
describeDestinations(Consumer<DescribeDestinationsRequest.Builder> describeDestinationsRequest)
Lists all your destinations.
|
default CompletableFuture<DescribeDestinationsResponse> |
describeDestinations(DescribeDestinationsRequest describeDestinationsRequest)
Lists all your destinations.
|
default DescribeDestinationsPublisher |
describeDestinationsPaginator()
Lists all your destinations.
|
default DescribeDestinationsPublisher |
describeDestinationsPaginator(Consumer<DescribeDestinationsRequest.Builder> describeDestinationsRequest)
Lists all your destinations.
|
default DescribeDestinationsPublisher |
describeDestinationsPaginator(DescribeDestinationsRequest describeDestinationsRequest)
Lists all your destinations.
|
default CompletableFuture<DescribeExportTasksResponse> |
describeExportTasks()
Lists the specified export tasks.
|
default CompletableFuture<DescribeExportTasksResponse> |
describeExportTasks(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest)
Lists the specified export tasks.
|
default CompletableFuture<DescribeExportTasksResponse> |
describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)
Lists the specified export tasks.
|
default CompletableFuture<DescribeLogGroupsResponse> |
describeLogGroups()
Lists the specified log groups.
|
default CompletableFuture<DescribeLogGroupsResponse> |
describeLogGroups(Consumer<DescribeLogGroupsRequest.Builder> describeLogGroupsRequest)
Lists the specified log groups.
|
default CompletableFuture<DescribeLogGroupsResponse> |
describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest)
Lists the specified log groups.
|
default DescribeLogGroupsPublisher |
describeLogGroupsPaginator()
Lists the specified log groups.
|
default DescribeLogGroupsPublisher |
describeLogGroupsPaginator(Consumer<DescribeLogGroupsRequest.Builder> describeLogGroupsRequest)
Lists the specified log groups.
|
default DescribeLogGroupsPublisher |
describeLogGroupsPaginator(DescribeLogGroupsRequest describeLogGroupsRequest)
Lists the specified log groups.
|
default CompletableFuture<DescribeLogStreamsResponse> |
describeLogStreams(Consumer<DescribeLogStreamsRequest.Builder> describeLogStreamsRequest)
Lists the log streams for the specified log group.
|
default CompletableFuture<DescribeLogStreamsResponse> |
describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest)
Lists the log streams for the specified log group.
|
default DescribeLogStreamsPublisher |
describeLogStreamsPaginator(Consumer<DescribeLogStreamsRequest.Builder> describeLogStreamsRequest)
Lists the log streams for the specified log group.
|
default DescribeLogStreamsPublisher |
describeLogStreamsPaginator(DescribeLogStreamsRequest describeLogStreamsRequest)
Lists the log streams for the specified log group.
|
default CompletableFuture<DescribeMetricFiltersResponse> |
describeMetricFilters()
Lists the specified metric filters.
|
default CompletableFuture<DescribeMetricFiltersResponse> |
describeMetricFilters(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest)
Lists the specified metric filters.
|
default CompletableFuture<DescribeMetricFiltersResponse> |
describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest)
Lists the specified metric filters.
|
default DescribeMetricFiltersPublisher |
describeMetricFiltersPaginator()
Lists the specified metric filters.
|
default DescribeMetricFiltersPublisher |
describeMetricFiltersPaginator(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest)
Lists the specified metric filters.
|
default DescribeMetricFiltersPublisher |
describeMetricFiltersPaginator(DescribeMetricFiltersRequest describeMetricFiltersRequest)
Lists the specified metric filters.
|
default CompletableFuture<DescribeQueriesResponse> |
describeQueries()
Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently
in this account.
|
default CompletableFuture<DescribeQueriesResponse> |
describeQueries(Consumer<DescribeQueriesRequest.Builder> describeQueriesRequest)
Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently
in this account.
|
default CompletableFuture<DescribeQueriesResponse> |
describeQueries(DescribeQueriesRequest describeQueriesRequest)
Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently
in this account.
|
default CompletableFuture<DescribeResourcePoliciesResponse> |
describeResourcePolicies()
Lists the resource policies in this account.
|
default CompletableFuture<DescribeResourcePoliciesResponse> |
describeResourcePolicies(Consumer<DescribeResourcePoliciesRequest.Builder> describeResourcePoliciesRequest)
Lists the resource policies in this account.
|
default CompletableFuture<DescribeResourcePoliciesResponse> |
describeResourcePolicies(DescribeResourcePoliciesRequest describeResourcePoliciesRequest)
Lists the resource policies in this account.
|
default CompletableFuture<DescribeSubscriptionFiltersResponse> |
describeSubscriptionFilters(Consumer<DescribeSubscriptionFiltersRequest.Builder> describeSubscriptionFiltersRequest)
Lists the subscription filters for the specified log group.
|
default CompletableFuture<DescribeSubscriptionFiltersResponse> |
describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)
Lists the subscription filters for the specified log group.
|
default DescribeSubscriptionFiltersPublisher |
describeSubscriptionFiltersPaginator(Consumer<DescribeSubscriptionFiltersRequest.Builder> describeSubscriptionFiltersRequest)
Lists the subscription filters for the specified log group.
|
default DescribeSubscriptionFiltersPublisher |
describeSubscriptionFiltersPaginator(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)
Lists the subscription filters for the specified log group.
|
default CompletableFuture<DisassociateKmsKeyResponse> |
disassociateKmsKey(Consumer<DisassociateKmsKeyRequest.Builder> disassociateKmsKeyRequest)
Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified
log group.
|
default CompletableFuture<DisassociateKmsKeyResponse> |
disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest)
Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified
log group.
|
default CompletableFuture<FilterLogEventsResponse> |
filterLogEvents(Consumer<FilterLogEventsRequest.Builder> filterLogEventsRequest)
Lists log events from the specified log group.
|
default CompletableFuture<FilterLogEventsResponse> |
filterLogEvents(FilterLogEventsRequest filterLogEventsRequest)
Lists log events from the specified log group.
|
default FilterLogEventsPublisher |
filterLogEventsPaginator(Consumer<FilterLogEventsRequest.Builder> filterLogEventsRequest)
Lists log events from the specified log group.
|
default FilterLogEventsPublisher |
filterLogEventsPaginator(FilterLogEventsRequest filterLogEventsRequest)
Lists log events from the specified log group.
|
default CompletableFuture<GetLogEventsResponse> |
getLogEvents(Consumer<GetLogEventsRequest.Builder> getLogEventsRequest)
Lists log events from the specified log stream.
|
default CompletableFuture<GetLogEventsResponse> |
getLogEvents(GetLogEventsRequest getLogEventsRequest)
Lists log events from the specified log stream.
|
default GetLogEventsPublisher |
getLogEventsPaginator(Consumer<GetLogEventsRequest.Builder> getLogEventsRequest)
Lists log events from the specified log stream.
|
default GetLogEventsPublisher |
getLogEventsPaginator(GetLogEventsRequest getLogEventsRequest)
Lists log events from the specified log stream.
|
default CompletableFuture<GetLogGroupFieldsResponse> |
getLogGroupFields(Consumer<GetLogGroupFieldsRequest.Builder> getLogGroupFieldsRequest)
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.
|
default CompletableFuture<GetLogGroupFieldsResponse> |
getLogGroupFields(GetLogGroupFieldsRequest getLogGroupFieldsRequest)
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.
|
default CompletableFuture<GetLogRecordResponse> |
getLogRecord(Consumer<GetLogRecordRequest.Builder> getLogRecordRequest)
Retrieves all the fields and values of a single log event.
|
default CompletableFuture<GetLogRecordResponse> |
getLogRecord(GetLogRecordRequest getLogRecordRequest)
Retrieves all the fields and values of a single log event.
|
default CompletableFuture<GetQueryResultsResponse> |
getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
Returns the results from the specified query.
|
default CompletableFuture<GetQueryResultsResponse> |
getQueryResults(GetQueryResultsRequest getQueryResultsRequest)
Returns the results from the specified query.
|
default CompletableFuture<ListTagsLogGroupResponse> |
listTagsLogGroup(Consumer<ListTagsLogGroupRequest.Builder> listTagsLogGroupRequest)
Lists the tags for the specified log group.
|
default CompletableFuture<ListTagsLogGroupResponse> |
listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest)
Lists the tags for the specified log group.
|
default CompletableFuture<PutDestinationResponse> |
putDestination(Consumer<PutDestinationRequest.Builder> putDestinationRequest)
Creates or updates a destination.
|
default CompletableFuture<PutDestinationResponse> |
putDestination(PutDestinationRequest putDestinationRequest)
Creates or updates a destination.
|
default CompletableFuture<PutDestinationPolicyResponse> |
putDestinationPolicy(Consumer<PutDestinationPolicyRequest.Builder> putDestinationPolicyRequest)
Creates or updates an access policy associated with an existing destination.
|
default CompletableFuture<PutDestinationPolicyResponse> |
putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest)
Creates or updates an access policy associated with an existing destination.
|
default CompletableFuture<PutLogEventsResponse> |
putLogEvents(Consumer<PutLogEventsRequest.Builder> putLogEventsRequest)
Uploads a batch of log events to the specified log stream.
|
default CompletableFuture<PutLogEventsResponse> |
putLogEvents(PutLogEventsRequest putLogEventsRequest)
Uploads a batch of log events to the specified log stream.
|
default CompletableFuture<PutMetricFilterResponse> |
putMetricFilter(Consumer<PutMetricFilterRequest.Builder> putMetricFilterRequest)
Creates or updates a metric filter and associates it with the specified log group.
|
default CompletableFuture<PutMetricFilterResponse> |
putMetricFilter(PutMetricFilterRequest putMetricFilterRequest)
Creates or updates a metric filter and associates it with the specified log group.
|
default CompletableFuture<PutResourcePolicyResponse> |
putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
Creates or updates a resource policy allowing other AWS services to put log events to this account, such as
Amazon Route 53.
|
default CompletableFuture<PutResourcePolicyResponse> |
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates a resource policy allowing other AWS services to put log events to this account, such as
Amazon Route 53.
|
default CompletableFuture<PutRetentionPolicyResponse> |
putRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest)
Sets the retention of the specified log group.
|
default CompletableFuture<PutRetentionPolicyResponse> |
putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)
Sets the retention of the specified log group.
|
default CompletableFuture<PutSubscriptionFilterResponse> |
putSubscriptionFilter(Consumer<PutSubscriptionFilterRequest.Builder> putSubscriptionFilterRequest)
Creates or updates a subscription filter and associates it with the specified log group.
|
default CompletableFuture<PutSubscriptionFilterResponse> |
putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest)
Creates or updates a subscription filter and associates it with the specified log group.
|
default CompletableFuture<StartQueryResponse> |
startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest)
Schedules a query of a log group using CloudWatch Logs Insights.
|
default CompletableFuture<StartQueryResponse> |
startQuery(StartQueryRequest startQueryRequest)
Schedules a query of a log group using CloudWatch Logs Insights.
|
default CompletableFuture<StopQueryResponse> |
stopQuery(Consumer<StopQueryRequest.Builder> stopQueryRequest)
Stops a CloudWatch Logs Insights query that is in progress.
|
default CompletableFuture<StopQueryResponse> |
stopQuery(StopQueryRequest stopQueryRequest)
Stops a CloudWatch Logs Insights query that is in progress.
|
default CompletableFuture<TagLogGroupResponse> |
tagLogGroup(Consumer<TagLogGroupRequest.Builder> tagLogGroupRequest)
Adds or updates the specified tags for the specified log group.
|
default CompletableFuture<TagLogGroupResponse> |
tagLogGroup(TagLogGroupRequest tagLogGroupRequest)
Adds or updates the specified tags for the specified log group.
|
default CompletableFuture<TestMetricFilterResponse> |
testMetricFilter(Consumer<TestMetricFilterRequest.Builder> testMetricFilterRequest)
Tests the filter pattern of a metric filter against a sample of log event messages.
|
default CompletableFuture<TestMetricFilterResponse> |
testMetricFilter(TestMetricFilterRequest testMetricFilterRequest)
Tests the filter pattern of a metric filter against a sample of log event messages.
|
default CompletableFuture<UntagLogGroupResponse> |
untagLogGroup(Consumer<UntagLogGroupRequest.Builder> untagLogGroupRequest)
Removes the specified tags from the specified log group.
|
default CompletableFuture<UntagLogGroupResponse> |
untagLogGroup(UntagLogGroupRequest untagLogGroupRequest)
Removes the specified tags from the specified log group.
|
serviceName
close
static final String SERVICE_NAME
static CloudWatchLogsAsyncClient create()
CloudWatchLogsAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CloudWatchLogsAsyncClientBuilder builder()
CloudWatchLogsAsyncClient
.default CompletableFuture<AssociateKmsKeyResponse> associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest)
Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.
Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
Note that it can take up to 5 minutes for this operation to take effect.
If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will
receive an InvalidParameterException
error.
associateKmsKeyRequest
- default CompletableFuture<AssociateKmsKeyResponse> associateKmsKey(Consumer<AssociateKmsKeyRequest.Builder> associateKmsKeyRequest)
Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.
Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
Note that it can take up to 5 minutes for this operation to take effect.
If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will
receive an InvalidParameterException
error.
This is a convenience which creates an instance of the AssociateKmsKeyRequest.Builder
avoiding the need
to create one manually via AssociateKmsKeyRequest.builder()
associateKmsKeyRequest
- A Consumer
that will call methods on AssociateKmsKeyRequest.Builder
to create a request.default CompletableFuture<CancelExportTaskResponse> cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)
Cancels the specified export task.
The task must be in the PENDING
or RUNNING
state.
cancelExportTaskRequest
- default CompletableFuture<CancelExportTaskResponse> cancelExportTask(Consumer<CancelExportTaskRequest.Builder> cancelExportTaskRequest)
Cancels the specified export task.
The task must be in the PENDING
or RUNNING
state.
This is a convenience which creates an instance of the CancelExportTaskRequest.Builder
avoiding the need
to create one manually via CancelExportTaskRequest.builder()
cancelExportTaskRequest
- A Consumer
that will call methods on CancelExportTaskRequest.Builder
to create a request.default CompletableFuture<CreateExportTaskResponse> createExportTask(CreateExportTaskRequest createExportTaskRequest)
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.
createExportTaskRequest
- default CompletableFuture<CreateExportTaskResponse> createExportTask(Consumer<CreateExportTaskRequest.Builder> createExportTaskRequest)
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.
This is a convenience which creates an instance of the CreateExportTaskRequest.Builder
avoiding the need
to create one manually via CreateExportTaskRequest.builder()
createExportTaskRequest
- A Consumer
that will call methods on CreateExportTaskRequest.Builder
to create a request.default CompletableFuture<CreateLogGroupResponse> createLogGroup(CreateLogGroupRequest createLogGroupRequest)
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.
createLogGroupRequest
- default CompletableFuture<CreateLogGroupResponse> createLogGroup(Consumer<CreateLogGroupRequest.Builder> createLogGroupRequest)
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.
This is a convenience which creates an instance of the CreateLogGroupRequest.Builder
avoiding the need to
create one manually via CreateLogGroupRequest.builder()
createLogGroupRequest
- A Consumer
that will call methods on CreateLogGroupRequest.Builder
to create a request.default CompletableFuture<CreateLogStreamResponse> createLogStream(CreateLogStreamRequest createLogStreamRequest)
Creates a log stream for the specified log group.
There is no limit on the number of log streams that you can create for a log group.
You must use the following guidelines when naming a log stream:
Log stream names must be unique within the log group.
Log stream names can be between 1 and 512 characters long.
The ':' (colon) and '*' (asterisk) characters are not allowed.
createLogStreamRequest
- default CompletableFuture<CreateLogStreamResponse> createLogStream(Consumer<CreateLogStreamRequest.Builder> createLogStreamRequest)
Creates a log stream for the specified log group.
There is no limit on the number of log streams that you can create for a log group.
You must use the following guidelines when naming a log stream:
Log stream names must be unique within the log group.
Log stream names can be between 1 and 512 characters long.
The ':' (colon) and '*' (asterisk) characters are not allowed.
This is a convenience which creates an instance of the CreateLogStreamRequest.Builder
avoiding the need
to create one manually via CreateLogStreamRequest.builder()
createLogStreamRequest
- A Consumer
that will call methods on CreateLogStreamRequest.Builder
to create a request.default CompletableFuture<DeleteDestinationResponse> deleteDestination(DeleteDestinationRequest deleteDestinationRequest)
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.
deleteDestinationRequest
- default CompletableFuture<DeleteDestinationResponse> deleteDestination(Consumer<DeleteDestinationRequest.Builder> deleteDestinationRequest)
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.
This is a convenience which creates an instance of the DeleteDestinationRequest.Builder
avoiding the need
to create one manually via DeleteDestinationRequest.builder()
deleteDestinationRequest
- A Consumer
that will call methods on DeleteDestinationRequest.Builder
to create a request.default CompletableFuture<DeleteLogGroupResponse> deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest)
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
deleteLogGroupRequest
- default CompletableFuture<DeleteLogGroupResponse> deleteLogGroup(Consumer<DeleteLogGroupRequest.Builder> deleteLogGroupRequest)
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
This is a convenience which creates an instance of the DeleteLogGroupRequest.Builder
avoiding the need to
create one manually via DeleteLogGroupRequest.builder()
deleteLogGroupRequest
- A Consumer
that will call methods on DeleteLogGroupRequest.Builder
to create a request.default CompletableFuture<DeleteLogStreamResponse> deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest)
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
deleteLogStreamRequest
- default CompletableFuture<DeleteLogStreamResponse> deleteLogStream(Consumer<DeleteLogStreamRequest.Builder> deleteLogStreamRequest)
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
This is a convenience which creates an instance of the DeleteLogStreamRequest.Builder
avoiding the need
to create one manually via DeleteLogStreamRequest.builder()
deleteLogStreamRequest
- A Consumer
that will call methods on DeleteLogStreamRequest.Builder
to create a request.default CompletableFuture<DeleteMetricFilterResponse> deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest)
Deletes the specified metric filter.
deleteMetricFilterRequest
- default CompletableFuture<DeleteMetricFilterResponse> deleteMetricFilter(Consumer<DeleteMetricFilterRequest.Builder> deleteMetricFilterRequest)
Deletes the specified metric filter.
This is a convenience which creates an instance of the DeleteMetricFilterRequest.Builder
avoiding the
need to create one manually via DeleteMetricFilterRequest.builder()
deleteMetricFilterRequest
- A Consumer
that will call methods on DeleteMetricFilterRequest.Builder
to create a
request.default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
deleteResourcePolicyRequest
- default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder
avoiding the
need to create one manually via DeleteResourcePolicyRequest.builder()
deleteResourcePolicyRequest
- A Consumer
that will call methods on DeleteResourcePolicyRequest.Builder
to create a
request.default CompletableFuture<DeleteRetentionPolicyResponse> deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
deleteRetentionPolicyRequest
- default CompletableFuture<DeleteRetentionPolicyResponse> deleteRetentionPolicy(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest)
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
This is a convenience which creates an instance of the DeleteRetentionPolicyRequest.Builder
avoiding the
need to create one manually via DeleteRetentionPolicyRequest.builder()
deleteRetentionPolicyRequest
- A Consumer
that will call methods on DeleteRetentionPolicyRequest.Builder
to create a
request.default CompletableFuture<DeleteSubscriptionFilterResponse> deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest)
Deletes the specified subscription filter.
deleteSubscriptionFilterRequest
- default CompletableFuture<DeleteSubscriptionFilterResponse> deleteSubscriptionFilter(Consumer<DeleteSubscriptionFilterRequest.Builder> deleteSubscriptionFilterRequest)
Deletes the specified subscription filter.
This is a convenience which creates an instance of the DeleteSubscriptionFilterRequest.Builder
avoiding
the need to create one manually via DeleteSubscriptionFilterRequest.builder()
deleteSubscriptionFilterRequest
- A Consumer
that will call methods on DeleteSubscriptionFilterRequest.Builder
to create a
request.default CompletableFuture<DescribeDestinationsResponse> describeDestinations(DescribeDestinationsRequest describeDestinationsRequest)
Lists all your destinations. The results are ASCII-sorted by destination name.
describeDestinationsRequest
- default CompletableFuture<DescribeDestinationsResponse> describeDestinations(Consumer<DescribeDestinationsRequest.Builder> describeDestinationsRequest)
Lists all your destinations. The results are ASCII-sorted by destination name.
This is a convenience which creates an instance of the DescribeDestinationsRequest.Builder
avoiding the
need to create one manually via DescribeDestinationsRequest.builder()
describeDestinationsRequest
- A Consumer
that will call methods on DescribeDestinationsRequest.Builder
to create a
request.default CompletableFuture<DescribeDestinationsResponse> describeDestinations()
Lists all your destinations. The results are ASCII-sorted by destination name.
default DescribeDestinationsPublisher describeDestinationsPaginator()
Lists all your destinations. The results are ASCII-sorted by destination name.
This is a variant of
describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation.
default DescribeDestinationsPublisher describeDestinationsPaginator(DescribeDestinationsRequest describeDestinationsRequest)
Lists all your destinations. The results are ASCII-sorted by destination name.
This is a variant of
describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation.
describeDestinationsRequest
- default DescribeDestinationsPublisher describeDestinationsPaginator(Consumer<DescribeDestinationsRequest.Builder> describeDestinationsRequest)
Lists all your destinations. The results are ASCII-sorted by destination name.
This is a variant of
describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)
operation.
This is a convenience which creates an instance of the DescribeDestinationsRequest.Builder
avoiding the
need to create one manually via DescribeDestinationsRequest.builder()
describeDestinationsRequest
- A Consumer
that will call methods on DescribeDestinationsRequest.Builder
to create a
request.default CompletableFuture<DescribeExportTasksResponse> describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
describeExportTasksRequest
- default CompletableFuture<DescribeExportTasksResponse> describeExportTasks(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest)
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
This is a convenience which creates an instance of the DescribeExportTasksRequest.Builder
avoiding the
need to create one manually via DescribeExportTasksRequest.builder()
describeExportTasksRequest
- A Consumer
that will call methods on DescribeExportTasksRequest.Builder
to create a
request.default CompletableFuture<DescribeExportTasksResponse> describeExportTasks()
Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
default CompletableFuture<DescribeLogGroupsResponse> describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest)
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.
describeLogGroupsRequest
- default CompletableFuture<DescribeLogGroupsResponse> describeLogGroups(Consumer<DescribeLogGroupsRequest.Builder> describeLogGroupsRequest)
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.
This is a convenience which creates an instance of the DescribeLogGroupsRequest.Builder
avoiding the need
to create one manually via DescribeLogGroupsRequest.builder()
describeLogGroupsRequest
- A Consumer
that will call methods on DescribeLogGroupsRequest.Builder
to create a request.default CompletableFuture<DescribeLogGroupsResponse> describeLogGroups()
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.
default DescribeLogGroupsPublisher describeLogGroupsPaginator()
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.
This is a variant of
describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation.
default DescribeLogGroupsPublisher describeLogGroupsPaginator(DescribeLogGroupsRequest describeLogGroupsRequest)
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.
This is a variant of
describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation.
describeLogGroupsRequest
- default DescribeLogGroupsPublisher describeLogGroupsPaginator(Consumer<DescribeLogGroupsRequest.Builder> describeLogGroupsRequest)
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.
This is a variant of
describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeLogGroupsRequest.Builder
avoiding the need
to create one manually via DescribeLogGroupsRequest.builder()
describeLogGroupsRequest
- A Consumer
that will call methods on DescribeLogGroupsRequest.Builder
to create a request.default CompletableFuture<DescribeLogStreamsResponse> describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest)
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.
describeLogStreamsRequest
- default CompletableFuture<DescribeLogStreamsResponse> describeLogStreams(Consumer<DescribeLogStreamsRequest.Builder> describeLogStreamsRequest)
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.
This is a convenience which creates an instance of the DescribeLogStreamsRequest.Builder
avoiding the
need to create one manually via DescribeLogStreamsRequest.builder()
describeLogStreamsRequest
- A Consumer
that will call methods on DescribeLogStreamsRequest.Builder
to create a
request.default DescribeLogStreamsPublisher describeLogStreamsPaginator(DescribeLogStreamsRequest describeLogStreamsRequest)
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.
This is a variant of
describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)
operation.
describeLogStreamsRequest
- default DescribeLogStreamsPublisher describeLogStreamsPaginator(Consumer<DescribeLogStreamsRequest.Builder> describeLogStreamsRequest)
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.
This is a variant of
describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)
operation.
This is a convenience which creates an instance of the DescribeLogStreamsRequest.Builder
avoiding the
need to create one manually via DescribeLogStreamsRequest.builder()
describeLogStreamsRequest
- A Consumer
that will call methods on DescribeLogStreamsRequest.Builder
to create a
request.default CompletableFuture<DescribeMetricFiltersResponse> describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest)
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.
describeMetricFiltersRequest
- default CompletableFuture<DescribeMetricFiltersResponse> describeMetricFilters(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest)
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.
This is a convenience which creates an instance of the DescribeMetricFiltersRequest.Builder
avoiding the
need to create one manually via DescribeMetricFiltersRequest.builder()
describeMetricFiltersRequest
- A Consumer
that will call methods on DescribeMetricFiltersRequest.Builder
to create a
request.default CompletableFuture<DescribeMetricFiltersResponse> describeMetricFilters()
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.
default DescribeMetricFiltersPublisher describeMetricFiltersPaginator()
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.
This is a variant of
describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation.
default DescribeMetricFiltersPublisher describeMetricFiltersPaginator(DescribeMetricFiltersRequest describeMetricFiltersRequest)
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.
This is a variant of
describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation.
describeMetricFiltersRequest
- default DescribeMetricFiltersPublisher describeMetricFiltersPaginator(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest)
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.
This is a variant of
describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)
operation.
This is a convenience which creates an instance of the DescribeMetricFiltersRequest.Builder
avoiding the
need to create one manually via DescribeMetricFiltersRequest.builder()
describeMetricFiltersRequest
- A Consumer
that will call methods on DescribeMetricFiltersRequest.Builder
to create a
request.default CompletableFuture<DescribeQueriesResponse> describeQueries(DescribeQueriesRequest describeQueriesRequest)
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.
describeQueriesRequest
- default CompletableFuture<DescribeQueriesResponse> describeQueries(Consumer<DescribeQueriesRequest.Builder> describeQueriesRequest)
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.
This is a convenience which creates an instance of the DescribeQueriesRequest.Builder
avoiding the need
to create one manually via DescribeQueriesRequest.builder()
describeQueriesRequest
- A Consumer
that will call methods on DescribeQueriesRequest.Builder
to create a request.default CompletableFuture<DescribeQueriesResponse> describeQueries()
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.
default CompletableFuture<DescribeResourcePoliciesResponse> describeResourcePolicies(DescribeResourcePoliciesRequest describeResourcePoliciesRequest)
Lists the resource policies in this account.
describeResourcePoliciesRequest
- default CompletableFuture<DescribeResourcePoliciesResponse> describeResourcePolicies(Consumer<DescribeResourcePoliciesRequest.Builder> describeResourcePoliciesRequest)
Lists the resource policies in this account.
This is a convenience which creates an instance of the DescribeResourcePoliciesRequest.Builder
avoiding
the need to create one manually via DescribeResourcePoliciesRequest.builder()
describeResourcePoliciesRequest
- A Consumer
that will call methods on DescribeResourcePoliciesRequest.Builder
to create a
request.default CompletableFuture<DescribeResourcePoliciesResponse> describeResourcePolicies()
Lists the resource policies in this account.
default CompletableFuture<DescribeSubscriptionFiltersResponse> describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)
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.
describeSubscriptionFiltersRequest
- default CompletableFuture<DescribeSubscriptionFiltersResponse> describeSubscriptionFilters(Consumer<DescribeSubscriptionFiltersRequest.Builder> describeSubscriptionFiltersRequest)
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.
This is a convenience which creates an instance of the DescribeSubscriptionFiltersRequest.Builder
avoiding the need to create one manually via DescribeSubscriptionFiltersRequest.builder()
describeSubscriptionFiltersRequest
- A Consumer
that will call methods on DescribeSubscriptionFiltersRequest.Builder
to create
a request.default DescribeSubscriptionFiltersPublisher describeSubscriptionFiltersPaginator(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)
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.
This is a variant of
describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)
operation.
describeSubscriptionFiltersRequest
- default DescribeSubscriptionFiltersPublisher describeSubscriptionFiltersPaginator(Consumer<DescribeSubscriptionFiltersRequest.Builder> describeSubscriptionFiltersRequest)
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.
This is a variant of
describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)
operation.
This is a convenience which creates an instance of the DescribeSubscriptionFiltersRequest.Builder
avoiding the need to create one manually via DescribeSubscriptionFiltersRequest.builder()
describeSubscriptionFiltersRequest
- A Consumer
that will call methods on DescribeSubscriptionFiltersRequest.Builder
to create
a request.default CompletableFuture<DisassociateKmsKeyResponse> disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest)
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.
disassociateKmsKeyRequest
- default CompletableFuture<DisassociateKmsKeyResponse> disassociateKmsKey(Consumer<DisassociateKmsKeyRequest.Builder> disassociateKmsKeyRequest)
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.
This is a convenience which creates an instance of the DisassociateKmsKeyRequest.Builder
avoiding the
need to create one manually via DisassociateKmsKeyRequest.builder()
disassociateKmsKeyRequest
- A Consumer
that will call methods on DisassociateKmsKeyRequest.Builder
to create a
request.default CompletableFuture<FilterLogEventsResponse> filterLogEvents(FilterLogEventsRequest filterLogEventsRequest)
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.
filterLogEventsRequest
- default CompletableFuture<FilterLogEventsResponse> filterLogEvents(Consumer<FilterLogEventsRequest.Builder> filterLogEventsRequest)
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.
This is a convenience which creates an instance of the FilterLogEventsRequest.Builder
avoiding the need
to create one manually via FilterLogEventsRequest.builder()
filterLogEventsRequest
- A Consumer
that will call methods on FilterLogEventsRequest.Builder
to create a request.default FilterLogEventsPublisher filterLogEventsPaginator(FilterLogEventsRequest filterLogEventsRequest)
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.
This is a variant of
filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)
operation.
filterLogEventsRequest
- default FilterLogEventsPublisher filterLogEventsPaginator(Consumer<FilterLogEventsRequest.Builder> filterLogEventsRequest)
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.
This is a variant of
filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)
operation.
This is a convenience which creates an instance of the FilterLogEventsRequest.Builder
avoiding the need
to create one manually via FilterLogEventsRequest.builder()
filterLogEventsRequest
- A Consumer
that will call methods on FilterLogEventsRequest.Builder
to create a request.default CompletableFuture<GetLogEventsResponse> getLogEvents(GetLogEventsRequest getLogEventsRequest)
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.
getLogEventsRequest
- default CompletableFuture<GetLogEventsResponse> getLogEvents(Consumer<GetLogEventsRequest.Builder> getLogEventsRequest)
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.
This is a convenience which creates an instance of the GetLogEventsRequest.Builder
avoiding the need to
create one manually via GetLogEventsRequest.builder()
getLogEventsRequest
- A Consumer
that will call methods on GetLogEventsRequest.Builder
to create a request.default GetLogEventsPublisher getLogEventsPaginator(GetLogEventsRequest getLogEventsRequest)
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.
This is a variant of
getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest)
operation.
getLogEventsRequest
- default GetLogEventsPublisher getLogEventsPaginator(Consumer<GetLogEventsRequest.Builder> getLogEventsRequest)
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.
This is a variant of
getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest)
operation.
This is a convenience which creates an instance of the GetLogEventsRequest.Builder
avoiding the need to
create one manually via GetLogEventsRequest.builder()
getLogEventsRequest
- A Consumer
that will call methods on GetLogEventsRequest.Builder
to create a request.default CompletableFuture<GetLogGroupFieldsResponse> getLogGroupFields(GetLogGroupFieldsRequest getLogGroupFieldsRequest)
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.
getLogGroupFieldsRequest
- default CompletableFuture<GetLogGroupFieldsResponse> getLogGroupFields(Consumer<GetLogGroupFieldsRequest.Builder> getLogGroupFieldsRequest)
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.
This is a convenience which creates an instance of the GetLogGroupFieldsRequest.Builder
avoiding the need
to create one manually via GetLogGroupFieldsRequest.builder()
getLogGroupFieldsRequest
- A Consumer
that will call methods on GetLogGroupFieldsRequest.Builder
to create a request.default CompletableFuture<GetLogRecordResponse> getLogRecord(GetLogRecordRequest getLogRecordRequest)
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
.
getLogRecordRequest
- default CompletableFuture<GetLogRecordResponse> getLogRecord(Consumer<GetLogRecordRequest.Builder> getLogRecordRequest)
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
.
This is a convenience which creates an instance of the GetLogRecordRequest.Builder
avoiding the need to
create one manually via GetLogRecordRequest.builder()
getLogRecordRequest
- A Consumer
that will call methods on GetLogRecordRequest.Builder
to create a request.default CompletableFuture<GetQueryResultsResponse> getQueryResults(GetQueryResultsRequest getQueryResultsRequest)
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.
getQueryResultsRequest
- default CompletableFuture<GetQueryResultsResponse> getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
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.
This is a convenience which creates an instance of the GetQueryResultsRequest.Builder
avoiding the need
to create one manually via GetQueryResultsRequest.builder()
getQueryResultsRequest
- A Consumer
that will call methods on GetQueryResultsRequest.Builder
to create a request.default CompletableFuture<ListTagsLogGroupResponse> listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest)
Lists the tags for the specified log group.
listTagsLogGroupRequest
- default CompletableFuture<ListTagsLogGroupResponse> listTagsLogGroup(Consumer<ListTagsLogGroupRequest.Builder> listTagsLogGroupRequest)
Lists the tags for the specified log group.
This is a convenience which creates an instance of the ListTagsLogGroupRequest.Builder
avoiding the need
to create one manually via ListTagsLogGroupRequest.builder()
listTagsLogGroupRequest
- A Consumer
that will call methods on ListTagsLogGroupRequest.Builder
to create a request.default CompletableFuture<PutDestinationResponse> putDestination(PutDestinationRequest putDestinationRequest)
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
.
putDestinationRequest
- default CompletableFuture<PutDestinationResponse> putDestination(Consumer<PutDestinationRequest.Builder> putDestinationRequest)
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
.
This is a convenience which creates an instance of the PutDestinationRequest.Builder
avoiding the need to
create one manually via PutDestinationRequest.builder()
putDestinationRequest
- A Consumer
that will call methods on PutDestinationRequest.Builder
to create a request.default CompletableFuture<PutDestinationPolicyResponse> putDestinationPolicy(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
- default CompletableFuture<PutDestinationPolicyResponse> putDestinationPolicy(Consumer<PutDestinationPolicyRequest.Builder> 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.
This is a convenience which creates an instance of the PutDestinationPolicyRequest.Builder
avoiding the
need to create one manually via PutDestinationPolicyRequest.builder()
putDestinationPolicyRequest
- A Consumer
that will call methods on PutDestinationPolicyRequest.Builder
to create a
request.default CompletableFuture<PutLogEventsResponse> putLogEvents(PutLogEventsRequest putLogEventsRequest)
Uploads a batch of log events to the specified log stream.
You must include the sequence token obtained from the response of the previous call. An upload in a newly created
log stream does not require a sequence token. You can also get the sequence token using
DescribeLogStreams. If you call PutLogEvents
twice within a narrow time period using the same
value for sequenceToken
, both calls may be successful, or one may be rejected.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be older than 14 days or 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.)
The maximum number of log events in a batch is 10,000.
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.
putLogEventsRequest
- default CompletableFuture<PutLogEventsResponse> putLogEvents(Consumer<PutLogEventsRequest.Builder> putLogEventsRequest)
Uploads a batch of log events to the specified log stream.
You must include the sequence token obtained from the response of the previous call. An upload in a newly created
log stream does not require a sequence token. You can also get the sequence token using
DescribeLogStreams. If you call PutLogEvents
twice within a narrow time period using the same
value for sequenceToken
, both calls may be successful, or one may be rejected.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be older than 14 days or 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.)
The maximum number of log events in a batch is 10,000.
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.
This is a convenience which creates an instance of the PutLogEventsRequest.Builder
avoiding the need to
create one manually via PutLogEventsRequest.builder()
putLogEventsRequest
- A Consumer
that will call methods on PutLogEventsRequest.Builder
to create a request.default CompletableFuture<PutMetricFilterResponse> putMetricFilter(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.
The maximum number of metric filters that can be associated with a log group is 100.
putMetricFilterRequest
- default CompletableFuture<PutMetricFilterResponse> putMetricFilter(Consumer<PutMetricFilterRequest.Builder> 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.
The maximum number of metric filters that can be associated with a log group is 100.
This is a convenience which creates an instance of the PutMetricFilterRequest.Builder
avoiding the need
to create one manually via PutMetricFilterRequest.builder()
putMetricFilterRequest
- A Consumer
that will call methods on PutMetricFilterRequest.Builder
to create a request.default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per region.
putResourcePolicyRequest
- default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
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.
This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder
avoiding the need
to create one manually via PutResourcePolicyRequest.builder()
putResourcePolicyRequest
- A Consumer
that will call methods on PutResourcePolicyRequest.Builder
to create a request.default CompletableFuture<PutRetentionPolicyResponse> putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)
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.
putRetentionPolicyRequest
- default CompletableFuture<PutRetentionPolicyResponse> putRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest)
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.
This is a convenience which creates an instance of the PutRetentionPolicyRequest.Builder
avoiding the
need to create one manually via PutRetentionPolicyRequest.builder()
putRetentionPolicyRequest
- A Consumer
that will call methods on PutRetentionPolicyRequest.Builder
to create a
request.default CompletableFuture<PutSubscriptionFilterResponse> putSubscriptionFilter(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 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.
putSubscriptionFilterRequest
- default CompletableFuture<PutSubscriptionFilterResponse> putSubscriptionFilter(Consumer<PutSubscriptionFilterRequest.Builder> 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 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.
This is a convenience which creates an instance of the PutSubscriptionFilterRequest.Builder
avoiding the
need to create one manually via PutSubscriptionFilterRequest.builder()
putSubscriptionFilterRequest
- A Consumer
that will call methods on PutSubscriptionFilterRequest.Builder
to create a
request.default CompletableFuture<StartQueryResponse> startQuery(StartQueryRequest startQueryRequest)
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.
startQueryRequest
- QueryCompileError
object. For more information, see .
For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax.
default CompletableFuture<StartQueryResponse> startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest)
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.
This is a convenience which creates an instance of the StartQueryRequest.Builder
avoiding the need to
create one manually via StartQueryRequest.builder()
startQueryRequest
- A Consumer
that will call methods on StartQueryRequest.Builder
to create a request.QueryCompileError
object. For more information, see .
For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax.
default CompletableFuture<StopQueryResponse> stopQuery(StopQueryRequest stopQueryRequest)
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.
stopQueryRequest
- default CompletableFuture<StopQueryResponse> stopQuery(Consumer<StopQueryRequest.Builder> stopQueryRequest)
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.
This is a convenience which creates an instance of the StopQueryRequest.Builder
avoiding the need to
create one manually via StopQueryRequest.builder()
stopQueryRequest
- A Consumer
that will call methods on StopQueryRequest.Builder
to create a request.default CompletableFuture<TagLogGroupResponse> tagLogGroup(TagLogGroupRequest tagLogGroupRequest)
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.
tagLogGroupRequest
- default CompletableFuture<TagLogGroupResponse> tagLogGroup(Consumer<TagLogGroupRequest.Builder> tagLogGroupRequest)
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.
This is a convenience which creates an instance of the TagLogGroupRequest.Builder
avoiding the need to
create one manually via TagLogGroupRequest.builder()
tagLogGroupRequest
- A Consumer
that will call methods on TagLogGroupRequest.Builder
to create a request.default CompletableFuture<TestMetricFilterResponse> testMetricFilter(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
- default CompletableFuture<TestMetricFilterResponse> testMetricFilter(Consumer<TestMetricFilterRequest.Builder> 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.
This is a convenience which creates an instance of the TestMetricFilterRequest.Builder
avoiding the need
to create one manually via TestMetricFilterRequest.builder()
testMetricFilterRequest
- A Consumer
that will call methods on TestMetricFilterRequest.Builder
to create a request.default CompletableFuture<UntagLogGroupResponse> untagLogGroup(UntagLogGroupRequest untagLogGroupRequest)
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.
untagLogGroupRequest
- default CompletableFuture<UntagLogGroupResponse> untagLogGroup(Consumer<UntagLogGroupRequest.Builder> untagLogGroupRequest)
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.
This is a convenience which creates an instance of the UntagLogGroupRequest.Builder
avoiding the need to
create one manually via UntagLogGroupRequest.builder()
untagLogGroupRequest
- A Consumer
that will call methods on UntagLogGroupRequest.Builder
to create a request.Copyright © 2019. All rights reserved.