@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CloudWatchLogsAsyncClient extends AwsClient
builder()
method.
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services 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. Then, it can 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"). You can also 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 CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can 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 earlier than this setting are automatically deleted. The CloudWatch Logs agent helps 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_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AssociateKmsKeyResponse> |
associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest)
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs
query insights results in the account.
|
default CompletableFuture<AssociateKmsKeyResponse> |
associateKmsKey(Consumer<AssociateKmsKeyRequest.Builder> associateKmsKeyRequest)
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs
query insights results in the account.
|
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 so that you can efficiently export data from a log group to an Amazon S3 bucket.
|
default CompletableFuture<CreateExportTaskResponse> |
createExportTask(CreateExportTaskRequest createExportTaskRequest)
Creates an export task so that you can 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<DeleteAccountPolicyResponse> |
deleteAccountPolicy(Consumer<DeleteAccountPolicyRequest.Builder> deleteAccountPolicyRequest)
Deletes a CloudWatch Logs account policy.
|
default CompletableFuture<DeleteAccountPolicyResponse> |
deleteAccountPolicy(DeleteAccountPolicyRequest deleteAccountPolicyRequest)
Deletes a CloudWatch Logs account policy.
|
default CompletableFuture<DeleteDataProtectionPolicyResponse> |
deleteDataProtectionPolicy(Consumer<DeleteDataProtectionPolicyRequest.Builder> deleteDataProtectionPolicyRequest)
Deletes the data protection policy from the specified log group.
|
default CompletableFuture<DeleteDataProtectionPolicyResponse> |
deleteDataProtectionPolicy(DeleteDataProtectionPolicyRequest deleteDataProtectionPolicyRequest)
Deletes the data protection policy from 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<DeleteQueryDefinitionResponse> |
deleteQueryDefinition(Consumer<DeleteQueryDefinitionRequest.Builder> deleteQueryDefinitionRequest)
Deletes a saved CloudWatch Logs Insights query definition.
|
default CompletableFuture<DeleteQueryDefinitionResponse> |
deleteQueryDefinition(DeleteQueryDefinitionRequest deleteQueryDefinitionRequest)
Deletes a saved CloudWatch Logs Insights query definition.
|
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<DescribeAccountPoliciesResponse> |
describeAccountPolicies(Consumer<DescribeAccountPoliciesRequest.Builder> describeAccountPoliciesRequest)
Returns a list of all CloudWatch Logs account policies in the account.
|
default CompletableFuture<DescribeAccountPoliciesResponse> |
describeAccountPolicies(DescribeAccountPoliciesRequest describeAccountPoliciesRequest)
Returns a list of all CloudWatch Logs account policies in the account.
|
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, running, or have been run recently in this
account.
|
default CompletableFuture<DescribeQueriesResponse> |
describeQueries(Consumer<DescribeQueriesRequest.Builder> describeQueriesRequest)
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this
account.
|
default CompletableFuture<DescribeQueriesResponse> |
describeQueries(DescribeQueriesRequest describeQueriesRequest)
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this
account.
|
default CompletableFuture<DescribeQueryDefinitionsResponse> |
describeQueryDefinitions(Consumer<DescribeQueryDefinitionsRequest.Builder> describeQueryDefinitionsRequest)
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
|
default CompletableFuture<DescribeQueryDefinitionsResponse> |
describeQueryDefinitions(DescribeQueryDefinitionsRequest describeQueryDefinitionsRequest)
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
|
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 specified KMS key from the specified log group or from all CloudWatch Logs Insights query
results in the account.
|
default CompletableFuture<DisassociateKmsKeyResponse> |
disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest)
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query
results in the account.
|
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<GetDataProtectionPolicyResponse> |
getDataProtectionPolicy(Consumer<GetDataProtectionPolicyRequest.Builder> getDataProtectionPolicyRequest)
Returns information about a log group data protection policy.
|
default CompletableFuture<GetDataProtectionPolicyResponse> |
getDataProtectionPolicy(GetDataProtectionPolicyRequest getDataProtectionPolicyRequest)
Returns information about a log group data protection policy.
|
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.
|
default CompletableFuture<GetLogGroupFieldsResponse> |
getLogGroupFields(GetLogGroupFieldsRequest getLogGroupFieldsRequest)
Returns a list of the fields that are included in log events in the specified log group.
|
default CompletableFuture<GetLogRecordResponse> |
getLogRecord(Consumer<GetLogRecordRequest.Builder> getLogRecordRequest)
Retrieves all of the fields and values of a single log event.
|
default CompletableFuture<GetLogRecordResponse> |
getLogRecord(GetLogRecordRequest getLogRecordRequest)
Retrieves all of 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<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with a CloudWatch Logs resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a CloudWatch Logs resource.
|
default CompletableFuture<ListTagsLogGroupResponse> |
listTagsLogGroup(Consumer<ListTagsLogGroupRequest.Builder> listTagsLogGroupRequest)
Deprecated.
Please use the generic tagging API ListTagsForResource
|
default CompletableFuture<ListTagsLogGroupResponse> |
listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest)
Deprecated.
Please use the generic tagging API ListTagsForResource
|
default CompletableFuture<PutAccountPolicyResponse> |
putAccountPolicy(Consumer<PutAccountPolicyRequest.Builder> putAccountPolicyRequest)
Creates an account-level data protection policy that applies to all log groups in the account.
|
default CompletableFuture<PutAccountPolicyResponse> |
putAccountPolicy(PutAccountPolicyRequest putAccountPolicyRequest)
Creates an account-level data protection policy that applies to all log groups in the account.
|
default CompletableFuture<PutDataProtectionPolicyResponse> |
putDataProtectionPolicy(Consumer<PutDataProtectionPolicyRequest.Builder> putDataProtectionPolicyRequest)
Creates a data protection policy for the specified log group.
|
default CompletableFuture<PutDataProtectionPolicyResponse> |
putDataProtectionPolicy(PutDataProtectionPolicyRequest putDataProtectionPolicyRequest)
Creates a data protection policy 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<PutQueryDefinitionResponse> |
putQueryDefinition(Consumer<PutQueryDefinitionRequest.Builder> putQueryDefinitionRequest)
Creates or updates a query definition for CloudWatch Logs Insights.
|
default CompletableFuture<PutQueryDefinitionResponse> |
putQueryDefinition(PutQueryDefinitionRequest putQueryDefinitionRequest)
Creates or updates a query definition for CloudWatch Logs Insights.
|
default CompletableFuture<PutResourcePolicyResponse> |
putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
Creates or updates a resource policy allowing other Amazon Web Services 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 Amazon Web Services 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 CloudWatchLogsServiceClientConfiguration |
serviceClientConfiguration() |
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)
Deprecated.
Please use the generic tagging API TagResource
|
default CompletableFuture<TagLogGroupResponse> |
tagLogGroup(TagLogGroupRequest tagLogGroupRequest)
Deprecated.
Please use the generic tagging API TagResource
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource.
|
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)
Deprecated.
Please use the generic tagging API UntagResource
|
default CompletableFuture<UntagLogGroupResponse> |
untagLogGroup(UntagLogGroupRequest untagLogGroupRequest)
Deprecated.
Please use the generic tagging API UntagResource
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.default CompletableFuture<AssociateKmsKeyResponse> associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest)
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use AssociateKmsKey
, you specify either the logGroupName
parameter or the
resourceIdentifier
parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName
parameter to cause all log events stored in the log group to be encrypted
with that key. Only the log events ingested after the key is associated are encrypted with that key.
Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log group to be encrypted with
that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey
operation
with the resourceIdentifier
parameter that specifies a query-result
resource.
Specify the resourceIdentifier
parameter with a query-result
resource, to use that key
to encrypt the stored results of all future StartQuery
operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.
Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled,
you receive an InvalidParameterException
error.
associateKmsKeyRequest
- default CompletableFuture<AssociateKmsKeyResponse> associateKmsKey(Consumer<AssociateKmsKeyRequest.Builder> associateKmsKeyRequest)
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use AssociateKmsKey
, you specify either the logGroupName
parameter or the
resourceIdentifier
parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName
parameter to cause all log events stored in the log group to be encrypted
with that key. Only the log events ingested after the key is associated are encrypted with that key.
Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log group to be encrypted with
that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey
operation
with the resourceIdentifier
parameter that specifies a query-result
resource.
Specify the resourceIdentifier
parameter with a query-result
resource, to use that key
to encrypt the stored results of all future StartQuery
operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.
Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled,
you receive an InvalidParameterException
error.
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 so that you can efficiently export data from a log group to an Amazon S3 bucket. When you
perform a CreateExportTask
operation, you must use credentials that have permission to write to the
S3 bucket that you specify as the destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
This is an asynchronous call. If all the required information is provided, this operation initiates an export
task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (
RUNNING
or PENDING
) export task at a time. To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
createExportTaskRequest
- default CompletableFuture<CreateExportTaskResponse> createExportTask(Consumer<CreateExportTaskRequest.Builder> createExportTaskRequest)
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you
perform a CreateExportTask
operation, you must use credentials that have permission to write to the
S3 bucket that you specify as the destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
This is an asynchronous call. If all the required information is provided, this operation initiates an export
task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (
RUNNING
or PENDING
) export task at a time. To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
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 Amazon Web Services account.
Log group names can be between 1 and 512 characters long.
Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign)
When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is
disabled, you receive an InvalidParameterException
error.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
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 Amazon Web Services account.
Log group names can be between 1 and 512 characters long.
Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign)
When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is
disabled, you receive an InvalidParameterException
error.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
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. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on
CreateLogStream
operations, after which transactions are throttled.
You must use the following guidelines when naming a log stream:
Log stream names must be unique within the log group.
Log stream names can be between 1 and 512 characters long.
Don't use ':' (colon) or '*' (asterisk) characters.
createLogStreamRequest
- default CompletableFuture<CreateLogStreamResponse> createLogStream(Consumer<CreateLogStreamRequest.Builder> createLogStreamRequest)
Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on
CreateLogStream
operations, after which transactions are throttled.
You must use the following guidelines when naming a log stream:
Log stream names must be unique within the log group.
Log stream names can be between 1 and 512 characters long.
Don't use ':' (colon) or '*' (asterisk) characters.
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<DeleteAccountPolicyResponse> deleteAccountPolicy(DeleteAccountPolicyRequest deleteAccountPolicyRequest)
Deletes a CloudWatch Logs account policy.
To use this operation, you must be signed on with the logs:DeleteDataProtectionPolicy
and
logs:DeleteAccountPolicy
permissions.
deleteAccountPolicyRequest
- default CompletableFuture<DeleteAccountPolicyResponse> deleteAccountPolicy(Consumer<DeleteAccountPolicyRequest.Builder> deleteAccountPolicyRequest)
Deletes a CloudWatch Logs account policy.
To use this operation, you must be signed on with the logs:DeleteDataProtectionPolicy
and
logs:DeleteAccountPolicy
permissions.
This is a convenience which creates an instance of the DeleteAccountPolicyRequest.Builder
avoiding the
need to create one manually via DeleteAccountPolicyRequest.builder()
deleteAccountPolicyRequest
- A Consumer
that will call methods on
DeleteAccountPolicyRequest.Builder
to create
a request.default CompletableFuture<DeleteDataProtectionPolicyResponse> deleteDataProtectionPolicy(DeleteDataProtectionPolicyRequest deleteDataProtectionPolicyRequest)
Deletes the data protection policy from the specified log group.
For more information about data protection policies, see PutDataProtectionPolicy.
deleteDataProtectionPolicyRequest
- default CompletableFuture<DeleteDataProtectionPolicyResponse> deleteDataProtectionPolicy(Consumer<DeleteDataProtectionPolicyRequest.Builder> deleteDataProtectionPolicyRequest)
Deletes the data protection policy from the specified log group.
For more information about data protection policies, see PutDataProtectionPolicy.
This is a convenience which creates an instance of the DeleteDataProtectionPolicyRequest.Builder
avoiding
the need to create one manually via DeleteDataProtectionPolicyRequest.builder()
deleteDataProtectionPolicyRequest
- A Consumer
that will call methods on
DeleteDataProtectionPolicyRequest.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<DeleteQueryDefinitionResponse> deleteQueryDefinition(DeleteQueryDefinitionRequest deleteQueryDefinitionRequest)
Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
Each DeleteQueryDefinition
operation can delete one query definition.
You must have the logs:DeleteQueryDefinition
permission to be able to perform this operation.
deleteQueryDefinitionRequest
- default CompletableFuture<DeleteQueryDefinitionResponse> deleteQueryDefinition(Consumer<DeleteQueryDefinitionRequest.Builder> deleteQueryDefinitionRequest)
Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
Each DeleteQueryDefinition
operation can delete one query definition.
You must have the logs:DeleteQueryDefinition
permission to be able to perform this operation.
This is a convenience which creates an instance of the DeleteQueryDefinitionRequest.Builder
avoiding the
need to create one manually via DeleteQueryDefinitionRequest.builder()
deleteQueryDefinitionRequest
- A Consumer
that will call methods on
DeleteQueryDefinitionRequest.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<DescribeAccountPoliciesResponse> describeAccountPolicies(DescribeAccountPoliciesRequest describeAccountPoliciesRequest)
Returns a list of all CloudWatch Logs account policies in the account.
describeAccountPoliciesRequest
- default CompletableFuture<DescribeAccountPoliciesResponse> describeAccountPolicies(Consumer<DescribeAccountPoliciesRequest.Builder> describeAccountPoliciesRequest)
Returns a list of all CloudWatch Logs account policies in the account.
This is a convenience which creates an instance of the DescribeAccountPoliciesRequest.Builder
avoiding
the need to create one manually via DescribeAccountPoliciesRequest.builder()
describeAccountPoliciesRequest
- A Consumer
that will call methods on
DescribeAccountPoliciesRequest.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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups
action by
using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name
condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups
action by
using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name
condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups
action by
using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name
condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups
action by
using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name
condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups
action by
using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name
condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups
action by
using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support
the use of the aws:ResourceTag/key-name
condition key to control access. For more
information about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
describeMetricFiltersRequest
- default CompletableFuture<DescribeMetricFiltersResponse> describeMetricFilters(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest)
Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
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 of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
default DescribeMetricFiltersPublisher describeMetricFiltersPaginator()
Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
describeQueriesRequest
- default CompletableFuture<DescribeQueriesResponse> describeQueries(Consumer<DescribeQueriesRequest.Builder> describeQueriesRequest)
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
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, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
default CompletableFuture<DescribeQueryDefinitionsResponse> describeQueryDefinitions(DescribeQueryDefinitionsRequest describeQueryDefinitionsRequest)
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
You can use the queryDefinitionNamePrefix
parameter to limit the results to only the query
definitions that have names that start with a certain string.
describeQueryDefinitionsRequest
- default CompletableFuture<DescribeQueryDefinitionsResponse> describeQueryDefinitions(Consumer<DescribeQueryDefinitionsRequest.Builder> describeQueryDefinitionsRequest)
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
You can use the queryDefinitionNamePrefix
parameter to limit the results to only the query
definitions that have names that start with a certain string.
This is a convenience which creates an instance of the DescribeQueryDefinitionsRequest.Builder
avoiding
the need to create one manually via DescribeQueryDefinitionsRequest.builder()
describeQueryDefinitionsRequest
- A Consumer
that will call methods on
DescribeQueryDefinitionsRequest.Builder
to
create a request.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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
When you use DisassociateKmsKey
, you specify either the logGroupName
parameter or the
resourceIdentifier
parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName
parameter to stop using the KMS key to encrypt future log events ingested
and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log
events that were ingested while the key was associated with the log group are still encrypted with that key.
Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.
Specify the resourceIdentifier
parameter with the query-result
resource to stop using
the KMS key to encrypt the results of all future StartQuery
operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results
from queries that ran while the key was associated with the account are still encrypted with that key. Therefore,
CloudWatch Logs will need permissions for the key whenever that data is accessed.
It can take up to 5 minutes for this operation to take effect.
disassociateKmsKeyRequest
- default CompletableFuture<DisassociateKmsKeyResponse> disassociateKmsKey(Consumer<DisassociateKmsKeyRequest.Builder> disassociateKmsKeyRequest)
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
When you use DisassociateKmsKey
, you specify either the logGroupName
parameter or the
resourceIdentifier
parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName
parameter to stop using the KMS key to encrypt future log events ingested
and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log
events that were ingested while the key was associated with the log group are still encrypted with that key.
Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.
Specify the resourceIdentifier
parameter with the query-result
resource to stop using
the KMS key to encrypt the results of all future StartQuery
operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results
from queries that ran while the key was associated with the account are still encrypted with that key. Therefore,
CloudWatch Logs will need permissions for the key whenever that data is accessed.
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.
You must have the logs:FilterLogEvents
permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
Logs, and the ID of the PutLogEvents
request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
You must have the logs:FilterLogEvents
permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
Logs, and the ID of the PutLogEvents
request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
You must have the logs:FilterLogEvents
permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
Logs, and the ID of the PutLogEvents
request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
You must have the logs:FilterLogEvents
permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
Logs, and the ID of the PutLogEvents
request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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<GetDataProtectionPolicyResponse> getDataProtectionPolicy(GetDataProtectionPolicyRequest getDataProtectionPolicyRequest)
Returns information about a log group data protection policy.
getDataProtectionPolicyRequest
- default CompletableFuture<GetDataProtectionPolicyResponse> getDataProtectionPolicy(Consumer<GetDataProtectionPolicyRequest.Builder> getDataProtectionPolicyRequest)
Returns information about a log group data protection policy.
This is a convenience which creates an instance of the GetDataProtectionPolicyRequest.Builder
avoiding
the need to create one manually via GetDataProtectionPolicyRequest.builder()
getDataProtectionPolicyRequest
- A Consumer
that will call methods on
GetDataProtectionPolicyRequest.Builder
to
create a request.default CompletableFuture<GetLogEventsResponse> getLogEvents(GetLogEventsRequest getLogEventsRequest)
Lists log events from the specified log stream. You can list all of the log events or filter using a time range.
By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
getLogEventsRequest
- default CompletableFuture<GetLogEventsResponse> getLogEvents(Consumer<GetLogEventsRequest.Builder> getLogEventsRequest)
Lists log events from the specified log stream. You can list all of the log events or filter using a time range.
By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
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 of the log events or filter using a time range.
By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 of the log events or filter using a time range.
By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must include one of these two parameters, but you can't include both.
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.
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must specify one of these parameters, but you can't specify both.
In the results, fields that start with @
are fields generated by CloudWatch Logs. For example,
@timestamp
is the timestamp of each log event. For more information about the fields that are
generated by CloudWatch logs, see Supported Logs and Discovered Fields.
The response results are sorted by the frequency percentage, starting with the highest percentage.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.
You can specify the log group to search by using either logGroupIdentifier
or
logGroupName
. You must specify one of these parameters, but you can't specify both.
In the results, fields that start with @
are fields generated by CloudWatch Logs. For example,
@timestamp
is the timestamp of each log event. For more information about the fields that are
generated by CloudWatch logs, see Supported Logs and Discovered Fields.
The response results are sorted by the frequency percentage, starting with the highest percentage.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
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 of the fields and values of a single log event. All fields are retrieved, even if the original
query that produced the logRecordPointer
retrieved only a subset of fields. Fields are returned as
field name/field value pairs.
The full unparsed log event is returned within @message
.
getLogRecordRequest
- default CompletableFuture<GetLogRecordResponse> getLogRecord(Consumer<GetLogRecordRequest.Builder> getLogRecordRequest)
Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original
query that produced the logRecordPointer
retrieved only a subset of fields. Fields are returned as
field name/field value pairs.
The full unparsed log event is returned within @message
.
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 GetLogRecord operation to get the full log record.
GetQueryResults
does not start running a query. To run a query, use StartQuery.
If the value of the Status
field in the output is Running
, this operation returns only
partial results. If you see a value of Scheduled
or Running
for the status, you can
retry the operation later to see the final results.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
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 GetLogRecord operation to get the full log record.
GetQueryResults
does not start running a query. To run a query, use StartQuery.
If the value of the Status
field in the output is Running
, this operation returns only
partial results. If you see a value of Scheduled
or Running
for the status, you can
retry the operation later to see the final results.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
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<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
listTagsForResourceRequest
- default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on
ListTagsForResourceRequest.Builder
to create
a request.@Deprecated default CompletableFuture<ListTagsLogGroupResponse> listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest)
The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
Lists the tags for the specified log group.
listTagsLogGroupRequest
- @Deprecated default CompletableFuture<ListTagsLogGroupResponse> listTagsLogGroup(Consumer<ListTagsLogGroupRequest.Builder> listTagsLogGroupRequest)
The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
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<PutAccountPolicyResponse> putAccountPolicy(PutAccountPolicyRequest putAccountPolicyRequest)
Creates an account-level data protection policy that applies to all log groups in the account. A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level policy.
Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.
If you use PutAccountPolicy
to create a data protection policy for your whole account, it applies to
both existing log groups and all log groups that are created later in this account. The account policy is applied
to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing
log groups begins to be masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.
A user who has the logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with the unmask
parameter set to true
to view the
unmasked log events. Users with the logs:Unmask
can also view unmasked data in the CloudWatch Logs
console by running a CloudWatch Logs Insights query with the unmask
query command.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
To use the PutAccountPolicy
operation, you must be signed on with the
logs:PutDataProtectionPolicy
and logs:PutAccountPolicy
permissions.
The PutAccountPolicy
operation applies to all log groups in the account. You can also use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log
group has its own data protection policy and the account also has an account-level data protection policy, then
the two policies are cumulative. Any sensitive term specified in either policy is masked.
putAccountPolicyRequest
- default CompletableFuture<PutAccountPolicyResponse> putAccountPolicy(Consumer<PutAccountPolicyRequest.Builder> putAccountPolicyRequest)
Creates an account-level data protection policy that applies to all log groups in the account. A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level policy.
Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.
If you use PutAccountPolicy
to create a data protection policy for your whole account, it applies to
both existing log groups and all log groups that are created later in this account. The account policy is applied
to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing
log groups begins to be masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.
A user who has the logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with the unmask
parameter set to true
to view the
unmasked log events. Users with the logs:Unmask
can also view unmasked data in the CloudWatch Logs
console by running a CloudWatch Logs Insights query with the unmask
query command.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
To use the PutAccountPolicy
operation, you must be signed on with the
logs:PutDataProtectionPolicy
and logs:PutAccountPolicy
permissions.
The PutAccountPolicy
operation applies to all log groups in the account. You can also use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log
group has its own data protection policy and the account also has an account-level data protection policy, then
the two policies are cumulative. Any sensitive term specified in either policy is masked.
This is a convenience which creates an instance of the PutAccountPolicyRequest.Builder
avoiding the need
to create one manually via PutAccountPolicyRequest.builder()
putAccountPolicyRequest
- A Consumer
that will call methods on
PutAccountPolicyRequest.Builder
to create a
request.default CompletableFuture<PutDataProtectionPolicyResponse> putDataProtectionPolicy(PutDataProtectionPolicyRequest putDataProtectionPolicyRequest)
Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.
Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.
A user who has the logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with the unmask
parameter set to true
to view the
unmasked log events. Users with the logs:Unmask
can also view unmasked data in the CloudWatch Logs
console by running a CloudWatch Logs Insights query with the unmask
query command.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
The PutDataProtectionPolicy
operation applies to only the specified log group. You can also use
PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the
account, including both existing log groups and log groups that are created level. If a log group has its own
data protection policy and the account also has an account-level data protection policy, then the two policies
are cumulative. Any sensitive term specified in either policy is masked.
putDataProtectionPolicyRequest
- default CompletableFuture<PutDataProtectionPolicyResponse> putDataProtectionPolicy(Consumer<PutDataProtectionPolicyRequest.Builder> putDataProtectionPolicyRequest)
Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.
Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.
A user who has the logs:Unmask
permission can use a GetLogEvents or FilterLogEvents operation with the unmask
parameter set to true
to view the
unmasked log events. Users with the logs:Unmask
can also view unmasked data in the CloudWatch Logs
console by running a CloudWatch Logs Insights query with the unmask
query command.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
The PutDataProtectionPolicy
operation applies to only the specified log group. You can also use
PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the
account, including both existing log groups and log groups that are created level. If a log group has its own
data protection policy and the account also has an account-level data protection policy, then the two policies
are cumulative. Any sensitive term specified in either policy is masked.
This is a convenience which creates an instance of the PutDataProtectionPolicyRequest.Builder
avoiding
the need to create one manually via PutDataProtectionPolicyRequest.builder()
putDataProtectionPolicyRequest
- A Consumer
that will call methods on
PutDataProtectionPolicyRequest.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). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.
Through an access policy, a destination controls what is written to it. By default, PutDestination
does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination
.
To perform a PutDestination
operation, you must also have the iam:PassRole
permission.
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). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.
Through an access policy, a destination controls what is written to it. By default, PutDestination
does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination
.
To perform a PutDestination
operation, you must also have the iam:PassRole
permission.
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.
The sequence token is now ignored in PutLogEvents
actions. PutLogEvents
actions are
always accepted and never return InvalidSequenceTokenException
or
DataAlreadyAcceptedException
even if the sequence token is not valid. You can use parallel
PutLogEvents
actions on the same log stream.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the
event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
. (In Amazon
Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET
format: yyyy-mm-ddThh:mm:ss
. For example, 2017-09-15T13:45:30
.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
Each log event can be no larger than 256 KB.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead, PutLogEvents
actions
are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling
quota by using the Service Quotas service.
If a call to PutLogEvents
returns "UnrecognizedClientException" the most likely cause is a non-valid
Amazon Web Services access key ID or secret key.
putLogEventsRequest
- expectedSequenceToken
field in the InvalidSequenceTokenException
message.
PutLogEvents
actions are now always accepted and never return
InvalidSequenceTokenException
regardless of receiving an invalid sequence token.
PutLogEvents
actions are now always accepted and never return
DataAlreadyAcceptedException
regardless of whether a given batch of log events has already
been accepted.
default CompletableFuture<PutLogEventsResponse> putLogEvents(Consumer<PutLogEventsRequest.Builder> putLogEventsRequest)
Uploads a batch of log events to the specified log stream.
The sequence token is now ignored in PutLogEvents
actions. PutLogEvents
actions are
always accepted and never return InvalidSequenceTokenException
or
DataAlreadyAcceptedException
even if the sequence token is not valid. You can use parallel
PutLogEvents
actions on the same log stream.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the
event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
. (In Amazon
Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET
format: yyyy-mm-ddThh:mm:ss
. For example, 2017-09-15T13:45:30
.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
Each log event can be no larger than 256 KB.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead, PutLogEvents
actions
are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling
quota by using the Service Quotas service.
If a call to PutLogEvents
returns "UnrecognizedClientException" the most likely cause is a non-valid
Amazon Web Services access key ID or secret key.
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.expectedSequenceToken
field in the InvalidSequenceTokenException
message.
PutLogEvents
actions are now always accepted and never return
InvalidSequenceTokenException
regardless of receiving an invalid sequence token.
PutLogEvents
actions are now always accepted and never return
DataAlreadyAcceptedException
regardless of whether a given batch of log events has already
been accepted.
default CompletableFuture<PutMetricFilterResponse> putMetricFilter(PutMetricFilterRequest putMetricFilterRequest)
Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.
The maximum number of metric filters that can be associated with a log group is 100.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not
specify high-cardinality fields such as IPAddress
or requestID
as dimensions. Each
different value found for a dimension is treated as a separate metric and accrues charges as a separate custom
metric.
CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
putMetricFilterRequest
- default CompletableFuture<PutMetricFilterResponse> putMetricFilter(Consumer<PutMetricFilterRequest.Builder> putMetricFilterRequest)
Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.
The maximum number of metric filters that can be associated with a log group is 100.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not
specify high-cardinality fields such as IPAddress
or requestID
as dimensions. Each
different value found for a dimension is treated as a separate metric and accrues charges as a separate custom
metric.
CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
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<PutQueryDefinitionResponse> putQueryDefinition(PutQueryDefinitionRequest putQueryDefinitionRequest)
Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its queryDefinitionId
in your request. The values of
name
, queryString
, and logGroupNames
are changed to the values that you
specify in your update operation. No current values are retained from the current query definition. For example,
imagine updating a current query definition that includes log groups. If you don't specify the
logGroupNames
parameter in your update operation, the query definition changes to contain no log
groups.
You must have the logs:PutQueryDefinition
permission to be able to perform this operation.
putQueryDefinitionRequest
- default CompletableFuture<PutQueryDefinitionResponse> putQueryDefinition(Consumer<PutQueryDefinitionRequest.Builder> putQueryDefinitionRequest)
Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its queryDefinitionId
in your request. The values of
name
, queryString
, and logGroupNames
are changed to the values that you
specify in your update operation. No current values are retained from the current query definition. For example,
imagine updating a current query definition that includes log groups. If you don't specify the
logGroupNames
parameter in your update operation, the query definition changes to contain no log
groups.
You must have the logs:PutQueryDefinition
permission to be able to perform this operation.
This is a convenience which creates an instance of the PutQueryDefinitionRequest.Builder
avoiding the
need to create one manually via PutQueryDefinitionRequest.builder()
putQueryDefinitionRequest
- A Consumer
that will call methods on
PutQueryDefinitionRequest.Builder
to create a
request.default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.
putResourcePolicyRequest
- default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.
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. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.
To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
putRetentionPolicyRequest
- default CompletableFuture<PutRetentionPolicyResponse> putRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest)
Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.
To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
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. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Kinesis Data Firehose as logical destinations.
An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
Each log group can have up to two subscription filters associated with it. If you are updating an existing
filter, you must specify the correct name in filterName
.
To perform a PutSubscriptionFilter
operation for any destination except a Lambda function, you must
also have the iam:PassRole
permission.
putSubscriptionFilterRequest
- default CompletableFuture<PutSubscriptionFilterResponse> putSubscriptionFilter(Consumer<PutSubscriptionFilterRequest.Builder> putSubscriptionFilterRequest)
Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Kinesis Data Firehose as logical destinations.
An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
Each log group can have up to two subscription filters associated with it. If you are updating an existing
filter, you must specify the correct name in filterName
.
To perform a PutSubscriptionFilter
operation for any destination except a Lambda function, you must
also have the iam:PassRole
permission.
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.
After you run a query using StartQuery
, the query results are stored by CloudWatch Logs. You can use
GetQueryResults to retrieve the results of a query, using the queryId
that
StartQuery
returns.
If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.
Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to
start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery
operation, the query
definition must be defined in the monitoring account.
You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
startQueryRequest
- QueryCompileError
object. For more information, see QueryCompileError.
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.
After you run a query using StartQuery
, the query results are stored by CloudWatch Logs. You can use
GetQueryResults to retrieve the results of a query, using the queryId
that
StartQuery
returns.
If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.
Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to
start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery
operation, the query
definition must be defined in the monitoring account.
You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
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 QueryCompileError.
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.@Deprecated default CompletableFuture<TagLogGroupResponse> tagLogGroup(TagLogGroupRequest tagLogGroupRequest)
The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using
the aws:Resource/key-name
or aws:TagKeys
condition keys. For more information
about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
tagLogGroupRequest
- @Deprecated default CompletableFuture<TagLogGroupResponse> tagLogGroup(Consumer<TagLogGroupRequest.Builder> tagLogGroupRequest)
The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using
the aws:Resource/key-name
or aws:TagKeys
condition keys. For more information
about using tags to control access, see Controlling access to Amazon Web
Services resources using tags.
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<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource
action with a resource that already has tags. If you specify a new tag
key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key
that is already associated with the alarm, the new tag value that you specify replaces the previous value for
that tag.
You can associate as many as 50 tags with a CloudWatch Logs resource.
tagResourceRequest
- default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource
action with a resource that already has tags. If you specify a new tag
key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key
that is already associated with the alarm, the new tag value that you specify replaces the previous value for
that tag.
You can associate as many as 50 tags with a CloudWatch Logs resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on
TagResourceRequest.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.@Deprecated default CompletableFuture<UntagLogGroupResponse> untagLogGroup(UntagLogGroupRequest untagLogGroupRequest)
The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using
the aws:Resource/key-name
or aws:TagKeys
condition keys.
untagLogGroupRequest
- @Deprecated default CompletableFuture<UntagLogGroupResponse> untagLogGroup(Consumer<UntagLogGroupRequest.Builder> untagLogGroupRequest)
The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using
the aws:Resource/key-name
or aws:TagKeys
condition keys.
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.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
untagResourceRequest
- default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on
UntagResourceRequest.Builder
to create a
request.default CloudWatchLogsServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration
in interface AwsClient
serviceClientConfiguration
in interface SdkClient
static CloudWatchLogsAsyncClient create()
CloudWatchLogsAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CloudWatchLogsAsyncClientBuilder builder()
CloudWatchLogsAsyncClient
.Copyright © 2023. All rights reserved.