software.amazon.awssdk.services.cloudwatchlogs.CloudWatchLogsAsyncClient Maven / Gradle / Ivy
Show all versions of cloudwatchlogs Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cloudwatchlogs;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.cloudwatchlogs.model.AssociateKmsKeyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.AssociateKmsKeyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.CancelExportTaskRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.CancelExportTaskResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateDeliveryRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateDeliveryResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateExportTaskRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateExportTaskResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogAnomalyDetectorRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogAnomalyDetectorResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogGroupRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogGroupResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogStreamRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogStreamResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteAccountPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteAccountPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDataProtectionPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDataProtectionPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDeliveryDestinationPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDeliveryDestinationPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDeliveryDestinationRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDeliveryDestinationResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDeliveryRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDeliveryResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDeliverySourceRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDeliverySourceResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDestinationRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDestinationResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogAnomalyDetectorRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogAnomalyDetectorResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogGroupRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogGroupResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogStreamRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogStreamResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteMetricFilterRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteMetricFilterResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteQueryDefinitionRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteQueryDefinitionResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteResourcePolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteResourcePolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteRetentionPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteRetentionPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteSubscriptionFilterRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteSubscriptionFilterResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeAccountPoliciesRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeAccountPoliciesResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeExportTasksRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeExportTasksResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeQueriesRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeQueriesResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeQueryDefinitionsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeQueryDefinitionsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeResourcePoliciesRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeResourcePoliciesResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DisassociateKmsKeyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DisassociateKmsKeyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetDataProtectionPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetDataProtectionPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetDeliveryDestinationPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetDeliveryDestinationPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetDeliveryDestinationRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetDeliveryDestinationResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetDeliveryRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetDeliveryResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetDeliverySourceRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetDeliverySourceResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogAnomalyDetectorRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogAnomalyDetectorResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogGroupFieldsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogGroupFieldsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogRecordRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogRecordResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetQueryResultsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetQueryResultsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.ListTagsLogGroupRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.ListTagsLogGroupResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutAccountPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutAccountPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDataProtectionPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDataProtectionPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDeliveryDestinationPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDeliveryDestinationPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDeliveryDestinationRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDeliveryDestinationResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDeliverySourceRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDeliverySourceResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDestinationPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDestinationPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDestinationRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDestinationResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutLogEventsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutLogEventsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutMetricFilterRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutMetricFilterResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutQueryDefinitionRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutQueryDefinitionResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutResourcePolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutResourcePolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutRetentionPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutRetentionPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutSubscriptionFilterRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutSubscriptionFilterResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.StartLiveTailRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.StartLiveTailResponseHandler;
import software.amazon.awssdk.services.cloudwatchlogs.model.StartQueryRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.StartQueryResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.StopQueryRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.StopQueryResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.TagLogGroupRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.TagLogGroupResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.TagResourceRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.TagResourceResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.TestMetricFilterRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.TestMetricFilterResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.UntagLogGroupRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.UntagLogGroupResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.UntagResourceRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.UntagResourceResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.UpdateAnomalyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.UpdateAnomalyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.UpdateLogAnomalyDetectorRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.UpdateLogAnomalyDetectorResponse;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsPublisher;
/**
* Service client for accessing Amazon CloudWatch Logs asynchronously. This can be created using the static
* {@link #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.
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface CloudWatchLogsAsyncClient extends AwsClient {
String SERVICE_NAME = "logs";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "logs";
/**
*
* 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.
*
*
* @param associateKmsKeyRequest
* @return A Java Future containing the result of the AssociateKmsKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.AssociateKmsKey
* @see AWS API
* Documentation
*/
default CompletableFuture associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link AssociateKmsKeyRequest.Builder} avoiding the need
* to create one manually via {@link AssociateKmsKeyRequest#builder()}
*
*
* @param associateKmsKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.AssociateKmsKeyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the AssociateKmsKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.AssociateKmsKey
* @see AWS API
* Documentation
*/
default CompletableFuture associateKmsKey(
Consumer associateKmsKeyRequest) {
return associateKmsKey(AssociateKmsKeyRequest.builder().applyMutation(associateKmsKeyRequest).build());
}
/**
*
* Cancels the specified export task.
*
*
* The task must be in the PENDING or RUNNING state.
*
*
* @param cancelExportTaskRequest
* @return A Java Future containing the result of the CancelExportTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - InvalidOperationException The operation is not valid on the specified resource.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CancelExportTask
* @see AWS API
* Documentation
*/
default CompletableFuture cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CancelExportTaskRequest.Builder} avoiding the need
* to create one manually via {@link CancelExportTaskRequest#builder()}
*
*
* @param cancelExportTaskRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.CancelExportTaskRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CancelExportTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - InvalidOperationException The operation is not valid on the specified resource.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CancelExportTask
* @see AWS API
* Documentation
*/
default CompletableFuture cancelExportTask(
Consumer cancelExportTaskRequest) {
return cancelExportTask(CancelExportTaskRequest.builder().applyMutation(cancelExportTaskRequest).build());
}
/**
*
* Creates a delivery. A delivery is a connection between a logical delivery source and a logical
* delivery destination that you have already created.
*
*
* Only some Amazon Web Services services support being configured as a delivery source using this operation. These
* services are listed as Supported [V2 Permissions] in the table at Enabling
* logging from Amazon Web Services services.
*
*
* A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in
* Kinesis Data Firehose.
*
*
* To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the
* following:
*
*
* -
*
* Create a delivery source, which is a logical object that represents the resource that is actually sending the
* logs. For more information, see PutDeliverySource.
*
*
* -
*
* Create a delivery destination, which is a logical object that represents the actual delivery destination.
* For more information, see PutDeliveryDestination.
*
*
* -
*
* If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This
* policy allows delivery to that destination.
*
*
* -
*
* Use CreateDelivery to create a delivery by pairing exactly one delivery source and one
* delivery destination.
*
*
*
*
* You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries.
* You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery
* destination.
*
*
* You can't update an existing delivery. You can only create and delete deliveries.
*
*
* @param createDeliveryRequest
* @return A Java Future containing the result of the CreateDelivery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ConflictException This operation attempted to create a resource that already exists.
* - ResourceNotFoundException The specified resource does not exist.
* - ValidationException One of the parameters for the request is not valid.
* - AccessDeniedException You don't have sufficient permissions to perform this action.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateDelivery
* @see AWS API
* Documentation
*/
default CompletableFuture createDelivery(CreateDeliveryRequest createDeliveryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a delivery. A delivery is a connection between a logical delivery source and a logical
* delivery destination that you have already created.
*
*
* Only some Amazon Web Services services support being configured as a delivery source using this operation. These
* services are listed as Supported [V2 Permissions] in the table at Enabling
* logging from Amazon Web Services services.
*
*
* A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in
* Kinesis Data Firehose.
*
*
* To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the
* following:
*
*
* -
*
* Create a delivery source, which is a logical object that represents the resource that is actually sending the
* logs. For more information, see PutDeliverySource.
*
*
* -
*
* Create a delivery destination, which is a logical object that represents the actual delivery destination.
* For more information, see PutDeliveryDestination.
*
*
* -
*
* If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This
* policy allows delivery to that destination.
*
*
* -
*
* Use CreateDelivery to create a delivery by pairing exactly one delivery source and one
* delivery destination.
*
*
*
*
* You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries.
* You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery
* destination.
*
*
* You can't update an existing delivery. You can only create and delete deliveries.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDeliveryRequest.Builder} avoiding the need to
* create one manually via {@link CreateDeliveryRequest#builder()}
*
*
* @param createDeliveryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.CreateDeliveryRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateDelivery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ConflictException This operation attempted to create a resource that already exists.
* - ResourceNotFoundException The specified resource does not exist.
* - ValidationException One of the parameters for the request is not valid.
* - AccessDeniedException You don't have sufficient permissions to perform this action.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateDelivery
* @see AWS API
* Documentation
*/
default CompletableFuture createDelivery(Consumer createDeliveryRequest) {
return createDelivery(CreateDeliveryRequest.builder().applyMutation(createDeliveryRequest).build());
}
/**
*
* 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.
*
*
*
* @param createExportTaskRequest
* @return A Java Future containing the result of the CreateExportTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - ResourceNotFoundException The specified resource does not exist.
* - ResourceAlreadyExistsException The specified resource already exists.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateExportTask
* @see AWS API
* Documentation
*/
default CompletableFuture createExportTask(CreateExportTaskRequest createExportTaskRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateExportTaskRequest.Builder} avoiding the need
* to create one manually via {@link CreateExportTaskRequest#builder()}
*
*
* @param createExportTaskRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.CreateExportTaskRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateExportTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - ResourceNotFoundException The specified resource does not exist.
* - ResourceAlreadyExistsException The specified resource already exists.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateExportTask
* @see AWS API
* Documentation
*/
default CompletableFuture createExportTask(
Consumer createExportTaskRequest) {
return createExportTask(CreateExportTaskRequest.builder().applyMutation(createExportTaskRequest).build());
}
/**
*
* Creates an anomaly detector that regularly scans one or more log groups and look for patterns and
* anomalies in the logs.
*
*
* An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An
* anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a
* shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets
* of logs because a large number of log events can often be compressed into a few patterns.
*
*
* The anomaly detector uses pattern recognition to find anomalies, which are unusual log events. It
* uses the evaluationFrequency to compare current log events and patterns with trained baselines.
*
*
* Fields within a pattern are called tokens. Fields that vary within a pattern, such as a request ID or
* timestamp, are referred to as dynamic tokens and represented by <*>.
*
*
* The following is an example of a pattern:
*
*
* [INFO] Request time: <*> ms
*
*
* This pattern represents log events like [INFO] Request time: 327 ms and other similar log events
* that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are
* replaced by <*>
*
*
*
* Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information
* about masking sensitive data, see Help protect
* sensitive log data with masking.
*
*
*
* @param createLogAnomalyDetectorRequest
* @return A Java Future containing the result of the CreateLogAnomalyDetector operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateLogAnomalyDetector
* @see AWS
* API Documentation
*/
default CompletableFuture createLogAnomalyDetector(
CreateLogAnomalyDetectorRequest createLogAnomalyDetectorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an anomaly detector that regularly scans one or more log groups and look for patterns and
* anomalies in the logs.
*
*
* An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An
* anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a
* shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets
* of logs because a large number of log events can often be compressed into a few patterns.
*
*
* The anomaly detector uses pattern recognition to find anomalies, which are unusual log events. It
* uses the evaluationFrequency to compare current log events and patterns with trained baselines.
*
*
* Fields within a pattern are called tokens. Fields that vary within a pattern, such as a request ID or
* timestamp, are referred to as dynamic tokens and represented by <*>.
*
*
* The following is an example of a pattern:
*
*
* [INFO] Request time: <*> ms
*
*
* This pattern represents log events like [INFO] Request time: 327 ms and other similar log events
* that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are
* replaced by <*>
*
*
*
* Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information
* about masking sensitive data, see Help protect
* sensitive log data with masking.
*
*
*
* This is a convenience which creates an instance of the {@link CreateLogAnomalyDetectorRequest.Builder} avoiding
* the need to create one manually via {@link CreateLogAnomalyDetectorRequest#builder()}
*
*
* @param createLogAnomalyDetectorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogAnomalyDetectorRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the CreateLogAnomalyDetector operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateLogAnomalyDetector
* @see AWS
* API Documentation
*/
default CompletableFuture createLogAnomalyDetector(
Consumer createLogAnomalyDetectorRequest) {
return createLogAnomalyDetector(CreateLogAnomalyDetectorRequest.builder().applyMutation(createLogAnomalyDetectorRequest)
.build());
}
/**
*
* Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region 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.
*
*
*
* @param createLogGroupRequest
* @return A Java Future containing the result of the CreateLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture createLogGroup(CreateLogGroupRequest createLogGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region 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 {@link CreateLogGroupRequest.Builder} avoiding the need to
* create one manually via {@link CreateLogGroupRequest#builder()}
*
*
* @param createLogGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture createLogGroup(Consumer createLogGroupRequest) {
return createLogGroup(CreateLogGroupRequest.builder().applyMutation(createLogGroupRequest).build());
}
/**
*
* 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.
*
*
*
*
* @param createLogStreamRequest
* @return A Java Future containing the result of the CreateLogStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateLogStream
* @see AWS API
* Documentation
*/
default CompletableFuture createLogStream(CreateLogStreamRequest createLogStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateLogStreamRequest.Builder} avoiding the need
* to create one manually via {@link CreateLogStreamRequest#builder()}
*
*
* @param createLogStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogStreamRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateLogStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateLogStream
* @see AWS API
* Documentation
*/
default CompletableFuture createLogStream(
Consumer createLogStreamRequest) {
return createLogStream(CreateLogStreamRequest.builder().applyMutation(createLogStreamRequest).build());
}
/**
*
* Deletes a CloudWatch Logs account policy.
*
*
* To use this operation, you must be signed on with the logs:DeleteDataProtectionPolicy and
* logs:DeleteAccountPolicy permissions.
*
*
* @param deleteAccountPolicyRequest
* @return A Java Future containing the result of the DeleteAccountPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteAccountPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture deleteAccountPolicy(
DeleteAccountPolicyRequest deleteAccountPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteAccountPolicyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteAccountPolicyRequest#builder()}
*
*
* @param deleteAccountPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteAccountPolicyRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DeleteAccountPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteAccountPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture deleteAccountPolicy(
Consumer deleteAccountPolicyRequest) {
return deleteAccountPolicy(DeleteAccountPolicyRequest.builder().applyMutation(deleteAccountPolicyRequest).build());
}
/**
*
* Deletes the data protection policy from the specified log group.
*
*
* For more information about data protection policies, see PutDataProtectionPolicy.
*
*
* @param deleteDataProtectionPolicyRequest
* @return A Java Future containing the result of the DeleteDataProtectionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDataProtectionPolicy
* @see AWS API Documentation
*/
default CompletableFuture deleteDataProtectionPolicy(
DeleteDataProtectionPolicyRequest deleteDataProtectionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDataProtectionPolicyRequest.Builder} avoiding
* the need to create one manually via {@link DeleteDataProtectionPolicyRequest#builder()}
*
*
* @param deleteDataProtectionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDataProtectionPolicyRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteDataProtectionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDataProtectionPolicy
* @see AWS API Documentation
*/
default CompletableFuture deleteDataProtectionPolicy(
Consumer deleteDataProtectionPolicyRequest) {
return deleteDataProtectionPolicy(DeleteDataProtectionPolicyRequest.builder()
.applyMutation(deleteDataProtectionPolicyRequest).build());
}
/**
*
* Deletes s delivery. A delivery is a connection between a logical delivery source and a logical
* delivery destination. Deleting a delivery only deletes the connection between the delivery source and
* delivery destination. It does not delete the delivery destination or the delivery source.
*
*
* @param deleteDeliveryRequest
* @return A Java Future containing the result of the DeleteDelivery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - ConflictException This operation attempted to create a resource that already exists.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDelivery
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDelivery(DeleteDeliveryRequest deleteDeliveryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes s delivery. A delivery is a connection between a logical delivery source and a logical
* delivery destination. Deleting a delivery only deletes the connection between the delivery source and
* delivery destination. It does not delete the delivery destination or the delivery source.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDeliveryRequest.Builder} avoiding the need to
* create one manually via {@link DeleteDeliveryRequest#builder()}
*
*
* @param deleteDeliveryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDeliveryRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteDelivery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - ConflictException This operation attempted to create a resource that already exists.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDelivery
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDelivery(Consumer deleteDeliveryRequest) {
return deleteDelivery(DeleteDeliveryRequest.builder().applyMutation(deleteDeliveryRequest).build());
}
/**
*
* Deletes a delivery destination. A delivery is a connection between a logical delivery source and a
* logical delivery destination.
*
*
* You can't delete a delivery destination if any current deliveries are associated with it. To find whether any
* deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the deliveryDestinationArn field in the results.
*
*
* @param deleteDeliveryDestinationRequest
* @return A Java Future containing the result of the DeleteDeliveryDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - ConflictException This operation attempted to create a resource that already exists.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDeliveryDestination
* @see AWS API Documentation
*/
default CompletableFuture deleteDeliveryDestination(
DeleteDeliveryDestinationRequest deleteDeliveryDestinationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a delivery destination. A delivery is a connection between a logical delivery source and a
* logical delivery destination.
*
*
* You can't delete a delivery destination if any current deliveries are associated with it. To find whether any
* deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the deliveryDestinationArn field in the results.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDeliveryDestinationRequest.Builder} avoiding
* the need to create one manually via {@link DeleteDeliveryDestinationRequest#builder()}
*
*
* @param deleteDeliveryDestinationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDeliveryDestinationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteDeliveryDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - ConflictException This operation attempted to create a resource that already exists.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDeliveryDestination
* @see AWS API Documentation
*/
default CompletableFuture deleteDeliveryDestination(
Consumer deleteDeliveryDestinationRequest) {
return deleteDeliveryDestination(DeleteDeliveryDestinationRequest.builder()
.applyMutation(deleteDeliveryDestinationRequest).build());
}
/**
*
* Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.
*
*
* @param deleteDeliveryDestinationPolicyRequest
* @return A Java Future containing the result of the DeleteDeliveryDestinationPolicy operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ValidationException One of the parameters for the request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - ConflictException This operation attempted to create a resource that already exists.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDeliveryDestinationPolicy
* @see AWS API Documentation
*/
default CompletableFuture deleteDeliveryDestinationPolicy(
DeleteDeliveryDestinationPolicyRequest deleteDeliveryDestinationPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDeliveryDestinationPolicyRequest.Builder}
* avoiding the need to create one manually via {@link DeleteDeliveryDestinationPolicyRequest#builder()}
*
*
* @param deleteDeliveryDestinationPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDeliveryDestinationPolicyRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the DeleteDeliveryDestinationPolicy operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ValidationException One of the parameters for the request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - ConflictException This operation attempted to create a resource that already exists.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDeliveryDestinationPolicy
* @see AWS API Documentation
*/
default CompletableFuture deleteDeliveryDestinationPolicy(
Consumer deleteDeliveryDestinationPolicyRequest) {
return deleteDeliveryDestinationPolicy(DeleteDeliveryDestinationPolicyRequest.builder()
.applyMutation(deleteDeliveryDestinationPolicyRequest).build());
}
/**
*
* Deletes a delivery source. A delivery is a connection between a logical delivery source and a
* logical delivery destination.
*
*
* You can't delete a delivery source if any current deliveries are associated with it. To find whether any
* deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the deliverySourceName field in the results.
*
*
* @param deleteDeliverySourceRequest
* @return A Java Future containing the result of the DeleteDeliverySource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - ConflictException This operation attempted to create a resource that already exists.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDeliverySource
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDeliverySource(
DeleteDeliverySourceRequest deleteDeliverySourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a delivery source. A delivery is a connection between a logical delivery source and a
* logical delivery destination.
*
*
* You can't delete a delivery source if any current deliveries are associated with it. To find whether any
* deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the deliverySourceName field in the results.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDeliverySourceRequest.Builder} avoiding the
* need to create one manually via {@link DeleteDeliverySourceRequest#builder()}
*
*
* @param deleteDeliverySourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDeliverySourceRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DeleteDeliverySource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - ConflictException This operation attempted to create a resource that already exists.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDeliverySource
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDeliverySource(
Consumer deleteDeliverySourceRequest) {
return deleteDeliverySource(DeleteDeliverySourceRequest.builder().applyMutation(deleteDeliverySourceRequest).build());
}
/**
*
* 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.
*
*
* @param deleteDestinationRequest
* @return A Java Future containing the result of the DeleteDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDestination
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDestination(DeleteDestinationRequest deleteDestinationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDestinationRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDestinationRequest#builder()}
*
*
* @param deleteDestinationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDestinationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDestination
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDestination(
Consumer deleteDestinationRequest) {
return deleteDestination(DeleteDestinationRequest.builder().applyMutation(deleteDestinationRequest).build());
}
/**
*
* Deletes the specified CloudWatch Logs anomaly detector.
*
*
* @param deleteLogAnomalyDetectorRequest
* @return A Java Future containing the result of the DeleteLogAnomalyDetector operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteLogAnomalyDetector
* @see AWS
* API Documentation
*/
default CompletableFuture deleteLogAnomalyDetector(
DeleteLogAnomalyDetectorRequest deleteLogAnomalyDetectorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified CloudWatch Logs anomaly detector.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteLogAnomalyDetectorRequest.Builder} avoiding
* the need to create one manually via {@link DeleteLogAnomalyDetectorRequest#builder()}
*
*
* @param deleteLogAnomalyDetectorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogAnomalyDetectorRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteLogAnomalyDetector operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteLogAnomalyDetector
* @see AWS
* API Documentation
*/
default CompletableFuture deleteLogAnomalyDetector(
Consumer deleteLogAnomalyDetectorRequest) {
return deleteLogAnomalyDetector(DeleteLogAnomalyDetectorRequest.builder().applyMutation(deleteLogAnomalyDetectorRequest)
.build());
}
/**
*
* Deletes the specified log group and permanently deletes all the archived log events associated with the log
* group.
*
*
* @param deleteLogGroupRequest
* @return A Java Future containing the result of the DeleteLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteLogGroupRequest.Builder} avoiding the need to
* create one manually via {@link DeleteLogGroupRequest#builder()}
*
*
* @param deleteLogGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture deleteLogGroup(Consumer deleteLogGroupRequest) {
return deleteLogGroup(DeleteLogGroupRequest.builder().applyMutation(deleteLogGroupRequest).build());
}
/**
*
* Deletes the specified log stream and permanently deletes all the archived log events associated with the log
* stream.
*
*
* @param deleteLogStreamRequest
* @return A Java Future containing the result of the DeleteLogStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteLogStream
* @see AWS API
* Documentation
*/
default CompletableFuture deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteLogStreamRequest.Builder} avoiding the need
* to create one manually via {@link DeleteLogStreamRequest#builder()}
*
*
* @param deleteLogStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogStreamRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteLogStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteLogStream
* @see AWS API
* Documentation
*/
default CompletableFuture deleteLogStream(
Consumer deleteLogStreamRequest) {
return deleteLogStream(DeleteLogStreamRequest.builder().applyMutation(deleteLogStreamRequest).build());
}
/**
*
* Deletes the specified metric filter.
*
*
* @param deleteMetricFilterRequest
* @return A Java Future containing the result of the DeleteMetricFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteMetricFilter
* @see AWS API
* Documentation
*/
default CompletableFuture deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified metric filter.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMetricFilterRequest.Builder} avoiding the
* need to create one manually via {@link DeleteMetricFilterRequest#builder()}
*
*
* @param deleteMetricFilterRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteMetricFilterRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteMetricFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteMetricFilter
* @see AWS API
* Documentation
*/
default CompletableFuture deleteMetricFilter(
Consumer deleteMetricFilterRequest) {
return deleteMetricFilter(DeleteMetricFilterRequest.builder().applyMutation(deleteMetricFilterRequest).build());
}
/**
*
* 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.
*
*
* @param deleteQueryDefinitionRequest
* @return A Java Future containing the result of the DeleteQueryDefinition operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteQueryDefinition
* @see AWS
* API Documentation
*/
default CompletableFuture deleteQueryDefinition(
DeleteQueryDefinitionRequest deleteQueryDefinitionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteQueryDefinitionRequest.Builder} avoiding the
* need to create one manually via {@link DeleteQueryDefinitionRequest#builder()}
*
*
* @param deleteQueryDefinitionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteQueryDefinitionRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteQueryDefinition operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteQueryDefinition
* @see AWS
* API Documentation
*/
default CompletableFuture deleteQueryDefinition(
Consumer deleteQueryDefinitionRequest) {
return deleteQueryDefinition(DeleteQueryDefinitionRequest.builder().applyMutation(deleteQueryDefinitionRequest).build());
}
/**
*
* Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log
* events to this account.
*
*
* @param deleteResourcePolicyRequest
* @return A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteResourcePolicy
* @see AWS API
* Documentation
*/
default CompletableFuture deleteResourcePolicy(
DeleteResourcePolicyRequest deleteResourcePolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteResourcePolicyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteResourcePolicyRequest#builder()}
*
*
* @param deleteResourcePolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteResourcePolicyRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteResourcePolicy
* @see AWS API
* Documentation
*/
default CompletableFuture deleteResourcePolicy(
Consumer deleteResourcePolicyRequest) {
return deleteResourcePolicy(DeleteResourcePolicyRequest.builder().applyMutation(deleteResourcePolicyRequest).build());
}
/**
*
* Deletes the specified retention policy.
*
*
* Log events do not expire if they belong to log groups without a retention policy.
*
*
* @param deleteRetentionPolicyRequest
* @return A Java Future containing the result of the DeleteRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteRetentionPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture deleteRetentionPolicy(
DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteRetentionPolicyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteRetentionPolicyRequest#builder()}
*
*
* @param deleteRetentionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteRetentionPolicyRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteRetentionPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture deleteRetentionPolicy(
Consumer deleteRetentionPolicyRequest) {
return deleteRetentionPolicy(DeleteRetentionPolicyRequest.builder().applyMutation(deleteRetentionPolicyRequest).build());
}
/**
*
* Deletes the specified subscription filter.
*
*
* @param deleteSubscriptionFilterRequest
* @return A Java Future containing the result of the DeleteSubscriptionFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteSubscriptionFilter
* @see AWS
* API Documentation
*/
default CompletableFuture deleteSubscriptionFilter(
DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified subscription filter.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteSubscriptionFilterRequest.Builder} avoiding
* the need to create one manually via {@link DeleteSubscriptionFilterRequest#builder()}
*
*
* @param deleteSubscriptionFilterRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DeleteSubscriptionFilterRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteSubscriptionFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteSubscriptionFilter
* @see AWS
* API Documentation
*/
default CompletableFuture deleteSubscriptionFilter(
Consumer deleteSubscriptionFilterRequest) {
return deleteSubscriptionFilter(DeleteSubscriptionFilterRequest.builder().applyMutation(deleteSubscriptionFilterRequest)
.build());
}
/**
*
* Returns a list of all CloudWatch Logs account policies in the account.
*
*
* @param describeAccountPoliciesRequest
* @return A Java Future containing the result of the DescribeAccountPolicies operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeAccountPolicies
* @see AWS
* API Documentation
*/
default CompletableFuture describeAccountPolicies(
DescribeAccountPoliciesRequest describeAccountPoliciesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of all CloudWatch Logs account policies in the account.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAccountPoliciesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeAccountPoliciesRequest#builder()}
*
*
* @param describeAccountPoliciesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeAccountPoliciesRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeAccountPolicies operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeAccountPolicies
* @see AWS
* API Documentation
*/
default CompletableFuture describeAccountPolicies(
Consumer describeAccountPoliciesRequest) {
return describeAccountPolicies(DescribeAccountPoliciesRequest.builder().applyMutation(describeAccountPoliciesRequest)
.build());
}
/**
*
* Retrieves a list of the deliveries that have been created in the account.
*
*
* @param describeDeliveriesRequest
* @return A Java Future containing the result of the DescribeDeliveries operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ValidationException One of the parameters for the request is not valid.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDeliveries
* @see AWS API
* Documentation
*/
default CompletableFuture describeDeliveries(DescribeDeliveriesRequest describeDeliveriesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of the deliveries that have been created in the account.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDeliveriesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDeliveriesRequest#builder()}
*
*
* @param describeDeliveriesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeDeliveries operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ValidationException One of the parameters for the request is not valid.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDeliveries
* @see AWS API
* Documentation
*/
default CompletableFuture describeDeliveries(
Consumer describeDeliveriesRequest) {
return describeDeliveries(DescribeDeliveriesRequest.builder().applyMutation(describeDeliveriesRequest).build());
}
/**
*
* Retrieves a list of the deliveries that have been created in the account.
*
*
*
* This is a variant of
* {@link #describeDeliveries(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesPublisher publisher = client.describeDeliveriesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesPublisher publisher = client.describeDeliveriesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesResponse 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
* {@link #describeDeliveries(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest)}
* operation.
*
*
* @param describeDeliveriesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ValidationException One of the parameters for the request is not valid.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDeliveries
* @see AWS API
* Documentation
*/
default DescribeDeliveriesPublisher describeDeliveriesPaginator(DescribeDeliveriesRequest describeDeliveriesRequest) {
return new DescribeDeliveriesPublisher(this, describeDeliveriesRequest);
}
/**
*
* Retrieves a list of the deliveries that have been created in the account.
*
*
*
* This is a variant of
* {@link #describeDeliveries(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesPublisher publisher = client.describeDeliveriesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesPublisher publisher = client.describeDeliveriesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesResponse 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
* {@link #describeDeliveries(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDeliveriesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDeliveriesRequest#builder()}
*
*
* @param describeDeliveriesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ValidationException One of the parameters for the request is not valid.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDeliveries
* @see AWS API
* Documentation
*/
default DescribeDeliveriesPublisher describeDeliveriesPaginator(
Consumer describeDeliveriesRequest) {
return describeDeliveriesPaginator(DescribeDeliveriesRequest.builder().applyMutation(describeDeliveriesRequest).build());
}
/**
*
* Retrieves a list of the delivery destinations that have been created in the account.
*
*
* @param describeDeliveryDestinationsRequest
* @return A Java Future containing the result of the DescribeDeliveryDestinations operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ValidationException One of the parameters for the request is not valid.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDeliveryDestinations
* @see AWS API Documentation
*/
default CompletableFuture describeDeliveryDestinations(
DescribeDeliveryDestinationsRequest describeDeliveryDestinationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of the delivery destinations that have been created in the account.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDeliveryDestinationsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDeliveryDestinationsRequest#builder()}
*
*
* @param describeDeliveryDestinationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the DescribeDeliveryDestinations operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ValidationException One of the parameters for the request is not valid.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDeliveryDestinations
* @see AWS API Documentation
*/
default CompletableFuture describeDeliveryDestinations(
Consumer describeDeliveryDestinationsRequest) {
return describeDeliveryDestinations(DescribeDeliveryDestinationsRequest.builder()
.applyMutation(describeDeliveryDestinationsRequest).build());
}
/**
*
* Retrieves a list of the delivery destinations that have been created in the account.
*
*
*
* This is a variant of
* {@link #describeDeliveryDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsPublisher publisher = client.describeDeliveryDestinationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsPublisher publisher = client.describeDeliveryDestinationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsResponse 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
* {@link #describeDeliveryDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest)}
* operation.
*
*
* @param describeDeliveryDestinationsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ValidationException One of the parameters for the request is not valid.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDeliveryDestinations
* @see AWS API Documentation
*/
default DescribeDeliveryDestinationsPublisher describeDeliveryDestinationsPaginator(
DescribeDeliveryDestinationsRequest describeDeliveryDestinationsRequest) {
return new DescribeDeliveryDestinationsPublisher(this, describeDeliveryDestinationsRequest);
}
/**
*
* Retrieves a list of the delivery destinations that have been created in the account.
*
*
*
* This is a variant of
* {@link #describeDeliveryDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsPublisher publisher = client.describeDeliveryDestinationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsPublisher publisher = client.describeDeliveryDestinationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsResponse 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
* {@link #describeDeliveryDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDeliveryDestinationsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDeliveryDestinationsRequest#builder()}
*
*
* @param describeDeliveryDestinationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest.Builder}
* to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ValidationException One of the parameters for the request is not valid.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDeliveryDestinations
* @see AWS API Documentation
*/
default DescribeDeliveryDestinationsPublisher describeDeliveryDestinationsPaginator(
Consumer describeDeliveryDestinationsRequest) {
return describeDeliveryDestinationsPaginator(DescribeDeliveryDestinationsRequest.builder()
.applyMutation(describeDeliveryDestinationsRequest).build());
}
/**
*
* Retrieves a list of the delivery sources that have been created in the account.
*
*
* @param describeDeliverySourcesRequest
* @return A Java Future containing the result of the DescribeDeliverySources operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ValidationException One of the parameters for the request is not valid.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDeliverySources
* @see AWS
* API Documentation
*/
default CompletableFuture describeDeliverySources(
DescribeDeliverySourcesRequest describeDeliverySourcesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of the delivery sources that have been created in the account.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDeliverySourcesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDeliverySourcesRequest#builder()}
*
*
* @param describeDeliverySourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeDeliverySources operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ValidationException One of the parameters for the request is not valid.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDeliverySources
* @see AWS
* API Documentation
*/
default CompletableFuture describeDeliverySources(
Consumer describeDeliverySourcesRequest) {
return describeDeliverySources(DescribeDeliverySourcesRequest.builder().applyMutation(describeDeliverySourcesRequest)
.build());
}
/**
*
* Retrieves a list of the delivery sources that have been created in the account.
*
*
*
* This is a variant of
* {@link #describeDeliverySources(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesPublisher publisher = client.describeDeliverySourcesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesPublisher publisher = client.describeDeliverySourcesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesResponse 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
* {@link #describeDeliverySources(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest)}
* operation.
*
*
* @param describeDeliverySourcesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ValidationException One of the parameters for the request is not valid.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDeliverySources
* @see AWS
* API Documentation
*/
default DescribeDeliverySourcesPublisher describeDeliverySourcesPaginator(
DescribeDeliverySourcesRequest describeDeliverySourcesRequest) {
return new DescribeDeliverySourcesPublisher(this, describeDeliverySourcesRequest);
}
/**
*
* Retrieves a list of the delivery sources that have been created in the account.
*
*
*
* This is a variant of
* {@link #describeDeliverySources(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesPublisher publisher = client.describeDeliverySourcesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesPublisher publisher = client.describeDeliverySourcesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesResponse 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
* {@link #describeDeliverySources(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDeliverySourcesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDeliverySourcesRequest#builder()}
*
*
* @param describeDeliverySourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest.Builder} to
* create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ValidationException One of the parameters for the request is not valid.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDeliverySources
* @see AWS
* API Documentation
*/
default DescribeDeliverySourcesPublisher describeDeliverySourcesPaginator(
Consumer describeDeliverySourcesRequest) {
return describeDeliverySourcesPaginator(DescribeDeliverySourcesRequest.builder()
.applyMutation(describeDeliverySourcesRequest).build());
}
/**
*
* Lists all your destinations. The results are ASCII-sorted by destination name.
*
*
* @param describeDestinationsRequest
* @return A Java Future containing the result of the DescribeDestinations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDestinations
* @see AWS API
* Documentation
*/
default CompletableFuture describeDestinations(
DescribeDestinationsRequest describeDestinationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all your destinations. The results are ASCII-sorted by destination name.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDestinationsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDestinationsRequest#builder()}
*
*
* @param describeDestinationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DescribeDestinations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDestinations
* @see AWS API
* Documentation
*/
default CompletableFuture describeDestinations(
Consumer describeDestinationsRequest) {
return describeDestinations(DescribeDestinationsRequest.builder().applyMutation(describeDestinationsRequest).build());
}
/**
*
* Lists all your destinations. The results are ASCII-sorted by destination name.
*
*
* @return A Java Future containing the result of the DescribeDestinations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDestinations
* @see AWS API
* Documentation
*/
default CompletableFuture describeDestinations() {
return describeDestinations(DescribeDestinationsRequest.builder().build());
}
/**
*
* Lists all your destinations. The results are ASCII-sorted by destination name.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDestinations
* @see AWS API
* Documentation
*/
default DescribeDestinationsPublisher describeDestinationsPaginator() {
return describeDestinationsPaginator(DescribeDestinationsRequest.builder().build());
}
/**
*
* Lists all your destinations. The results are ASCII-sorted by destination name.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)}
* operation.
*
*
* @param describeDestinationsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDestinations
* @see AWS API
* Documentation
*/
default DescribeDestinationsPublisher describeDestinationsPaginator(DescribeDestinationsRequest describeDestinationsRequest) {
return new DescribeDestinationsPublisher(this, describeDestinationsRequest);
}
/**
*
* Lists all your destinations. The results are ASCII-sorted by destination name.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDestinationsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDestinationsRequest#builder()}
*
*
* @param describeDestinationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest.Builder} to create
* a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDestinations
* @see AWS API
* Documentation
*/
default DescribeDestinationsPublisher describeDestinationsPaginator(
Consumer describeDestinationsRequest) {
return describeDestinationsPaginator(DescribeDestinationsRequest.builder().applyMutation(describeDestinationsRequest)
.build());
}
/**
*
* Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or
* task status.
*
*
* @param describeExportTasksRequest
* @return A Java Future containing the result of the DescribeExportTasks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeExportTasks
* @see AWS API
* Documentation
*/
default CompletableFuture describeExportTasks(
DescribeExportTasksRequest describeExportTasksRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeExportTasksRequest.Builder} avoiding the
* need to create one manually via {@link DescribeExportTasksRequest#builder()}
*
*
* @param describeExportTasksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeExportTasksRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DescribeExportTasks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeExportTasks
* @see AWS API
* Documentation
*/
default CompletableFuture describeExportTasks(
Consumer describeExportTasksRequest) {
return describeExportTasks(DescribeExportTasksRequest.builder().applyMutation(describeExportTasksRequest).build());
}
/**
*
* Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or
* task status.
*
*
* @return A Java Future containing the result of the DescribeExportTasks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeExportTasks
* @see AWS API
* Documentation
*/
default CompletableFuture describeExportTasks() {
return describeExportTasks(DescribeExportTasksRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeLogGroupsRequest
* @return A Java Future containing the result of the DescribeLogGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogGroups
* @see AWS API
* Documentation
*/
default CompletableFuture describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeLogGroupsRequest.Builder} avoiding the need
* to create one manually via {@link DescribeLogGroupsRequest#builder()}
*
*
* @param describeLogGroupsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeLogGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogGroups
* @see AWS API
* Documentation
*/
default CompletableFuture describeLogGroups(
Consumer describeLogGroupsRequest) {
return describeLogGroups(DescribeLogGroupsRequest.builder().applyMutation(describeLogGroupsRequest).build());
}
/**
*
* 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.
*
*
* @return A Java Future containing the result of the DescribeLogGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogGroups
* @see AWS API
* Documentation
*/
default CompletableFuture describeLogGroups() {
return describeLogGroups(DescribeLogGroupsRequest.builder().build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogGroups
* @see AWS API
* Documentation
*/
default DescribeLogGroupsPublisher describeLogGroupsPaginator() {
return describeLogGroupsPaginator(DescribeLogGroupsRequest.builder().build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)}
* operation.
*
*
* @param describeLogGroupsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogGroups
* @see AWS API
* Documentation
*/
default DescribeLogGroupsPublisher describeLogGroupsPaginator(DescribeLogGroupsRequest describeLogGroupsRequest) {
return new DescribeLogGroupsPublisher(this, 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeLogGroupsRequest.Builder} avoiding the need
* to create one manually via {@link DescribeLogGroupsRequest#builder()}
*
*
* @param describeLogGroupsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogGroups
* @see AWS API
* Documentation
*/
default DescribeLogGroupsPublisher describeLogGroupsPaginator(
Consumer describeLogGroupsRequest) {
return describeLogGroupsPaginator(DescribeLogGroupsRequest.builder().applyMutation(describeLogGroupsRequest).build());
}
/**
*
* 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.
*
*
* @param describeLogStreamsRequest
* @return A Java Future containing the result of the DescribeLogStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogStreams
* @see AWS API
* Documentation
*/
default CompletableFuture describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeLogStreamsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeLogStreamsRequest#builder()}
*
*
* @param describeLogStreamsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeLogStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogStreams
* @see AWS API
* Documentation
*/
default CompletableFuture describeLogStreams(
Consumer describeLogStreamsRequest) {
return describeLogStreams(DescribeLogStreamsRequest.builder().applyMutation(describeLogStreamsRequest).build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)}
* operation.
*
*
* @param describeLogStreamsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogStreams
* @see AWS API
* Documentation
*/
default DescribeLogStreamsPublisher describeLogStreamsPaginator(DescribeLogStreamsRequest describeLogStreamsRequest) {
return new DescribeLogStreamsPublisher(this, 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeLogStreamsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeLogStreamsRequest#builder()}
*
*
* @param describeLogStreamsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogStreams
* @see AWS API
* Documentation
*/
default DescribeLogStreamsPublisher describeLogStreamsPaginator(
Consumer describeLogStreamsRequest) {
return describeLogStreamsPaginator(DescribeLogStreamsRequest.builder().applyMutation(describeLogStreamsRequest).build());
}
/**
*
* 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.
*
*
* @param describeMetricFiltersRequest
* @return A Java Future containing the result of the DescribeMetricFilters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeMetricFilters
* @see AWS
* API Documentation
*/
default CompletableFuture describeMetricFilters(
DescribeMetricFiltersRequest describeMetricFiltersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeMetricFiltersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeMetricFiltersRequest#builder()}
*
*
* @param describeMetricFiltersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeMetricFilters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeMetricFilters
* @see AWS
* API Documentation
*/
default CompletableFuture describeMetricFilters(
Consumer describeMetricFiltersRequest) {
return describeMetricFilters(DescribeMetricFiltersRequest.builder().applyMutation(describeMetricFiltersRequest).build());
}
/**
*
* 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.
*
*
* @return A Java Future containing the result of the DescribeMetricFilters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeMetricFilters
* @see AWS
* API Documentation
*/
default CompletableFuture describeMetricFilters() {
return describeMetricFilters(DescribeMetricFiltersRequest.builder().build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeMetricFilters
* @see AWS
* API Documentation
*/
default DescribeMetricFiltersPublisher describeMetricFiltersPaginator() {
return describeMetricFiltersPaginator(DescribeMetricFiltersRequest.builder().build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)}
* operation.
*
*
* @param describeMetricFiltersRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeMetricFilters
* @see AWS
* API Documentation
*/
default DescribeMetricFiltersPublisher describeMetricFiltersPaginator(
DescribeMetricFiltersRequest describeMetricFiltersRequest) {
return new DescribeMetricFiltersPublisher(this, 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeMetricFiltersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeMetricFiltersRequest#builder()}
*
*
* @param describeMetricFiltersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest.Builder} to
* create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeMetricFilters
* @see AWS
* API Documentation
*/
default DescribeMetricFiltersPublisher describeMetricFiltersPaginator(
Consumer describeMetricFiltersRequest) {
return describeMetricFiltersPaginator(DescribeMetricFiltersRequest.builder().applyMutation(describeMetricFiltersRequest)
.build());
}
/**
*
* 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.
*
*
* @param describeQueriesRequest
* @return A Java Future containing the result of the DescribeQueries operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeQueries
* @see AWS API
* Documentation
*/
default CompletableFuture describeQueries(DescribeQueriesRequest describeQueriesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeQueriesRequest.Builder} avoiding the need
* to create one manually via {@link DescribeQueriesRequest#builder()}
*
*
* @param describeQueriesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeQueriesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeQueries operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeQueries
* @see AWS API
* Documentation
*/
default CompletableFuture describeQueries(
Consumer describeQueriesRequest) {
return describeQueries(DescribeQueriesRequest.builder().applyMutation(describeQueriesRequest).build());
}
/**
*
* 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.
*
*
* @return A Java Future containing the result of the DescribeQueries operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeQueries
* @see AWS API
* Documentation
*/
default CompletableFuture describeQueries() {
return describeQueries(DescribeQueriesRequest.builder().build());
}
/**
*
* This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can
* retrieve query definitions from the current account or from a source account that is linked to the current
* account.
*
*
* You can use the queryDefinitionNamePrefix parameter to limit the results to only the query
* definitions that have names that start with a certain string.
*
*
* @param describeQueryDefinitionsRequest
* @return A Java Future containing the result of the DescribeQueryDefinitions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeQueryDefinitions
* @see AWS
* API Documentation
*/
default CompletableFuture describeQueryDefinitions(
DescribeQueryDefinitionsRequest describeQueryDefinitionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can
* retrieve query definitions from the current account or from a source account that is linked to the current
* account.
*
*
* 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 {@link DescribeQueryDefinitionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeQueryDefinitionsRequest#builder()}
*
*
* @param describeQueryDefinitionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeQueryDefinitionsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeQueryDefinitions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeQueryDefinitions
* @see AWS
* API Documentation
*/
default CompletableFuture describeQueryDefinitions(
Consumer describeQueryDefinitionsRequest) {
return describeQueryDefinitions(DescribeQueryDefinitionsRequest.builder().applyMutation(describeQueryDefinitionsRequest)
.build());
}
/**
*
* Lists the resource policies in this account.
*
*
* @param describeResourcePoliciesRequest
* @return A Java Future containing the result of the DescribeResourcePolicies operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeResourcePolicies
* @see AWS
* API Documentation
*/
default CompletableFuture describeResourcePolicies(
DescribeResourcePoliciesRequest describeResourcePoliciesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the resource policies in this account.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeResourcePoliciesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeResourcePoliciesRequest#builder()}
*
*
* @param describeResourcePoliciesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeResourcePoliciesRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeResourcePolicies operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeResourcePolicies
* @see AWS
* API Documentation
*/
default CompletableFuture describeResourcePolicies(
Consumer describeResourcePoliciesRequest) {
return describeResourcePolicies(DescribeResourcePoliciesRequest.builder().applyMutation(describeResourcePoliciesRequest)
.build());
}
/**
*
* Lists the resource policies in this account.
*
*
* @return A Java Future containing the result of the DescribeResourcePolicies operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeResourcePolicies
* @see AWS
* API Documentation
*/
default CompletableFuture describeResourcePolicies() {
return describeResourcePolicies(DescribeResourcePoliciesRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeSubscriptionFiltersRequest
* @return A Java Future containing the result of the DescribeSubscriptionFilters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeSubscriptionFilters
* @see AWS API Documentation
*/
default CompletableFuture describeSubscriptionFilters(
DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeSubscriptionFiltersRequest.Builder}
* avoiding the need to create one manually via {@link DescribeSubscriptionFiltersRequest#builder()}
*
*
* @param describeSubscriptionFiltersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeSubscriptionFilters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeSubscriptionFilters
* @see AWS API Documentation
*/
default CompletableFuture describeSubscriptionFilters(
Consumer describeSubscriptionFiltersRequest) {
return describeSubscriptionFilters(DescribeSubscriptionFiltersRequest.builder()
.applyMutation(describeSubscriptionFiltersRequest).build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)}
* operation.
*
*
* @param describeSubscriptionFiltersRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeSubscriptionFilters
* @see AWS API Documentation
*/
default DescribeSubscriptionFiltersPublisher describeSubscriptionFiltersPaginator(
DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest) {
return new DescribeSubscriptionFiltersPublisher(this, 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeSubscriptionFiltersRequest.Builder}
* avoiding the need to create one manually via {@link DescribeSubscriptionFiltersRequest#builder()}
*
*
* @param describeSubscriptionFiltersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest.Builder} to
* create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeSubscriptionFilters
* @see AWS API Documentation
*/
default DescribeSubscriptionFiltersPublisher describeSubscriptionFiltersPaginator(
Consumer describeSubscriptionFiltersRequest) {
return describeSubscriptionFiltersPaginator(DescribeSubscriptionFiltersRequest.builder()
.applyMutation(describeSubscriptionFiltersRequest).build());
}
/**
*
* 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.
*
*
* @param disassociateKmsKeyRequest
* @return A Java Future containing the result of the DisassociateKmsKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DisassociateKmsKey
* @see AWS API
* Documentation
*/
default CompletableFuture disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DisassociateKmsKeyRequest.Builder} avoiding the
* need to create one manually via {@link DisassociateKmsKeyRequest#builder()}
*
*
* @param disassociateKmsKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.DisassociateKmsKeyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DisassociateKmsKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DisassociateKmsKey
* @see AWS API
* Documentation
*/
default CompletableFuture disassociateKmsKey(
Consumer disassociateKmsKeyRequest) {
return disassociateKmsKey(DisassociateKmsKeyRequest.builder().applyMutation(disassociateKmsKeyRequest).build());
}
/**
*
* 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.
*
*
* @param filterLogEventsRequest
* @return A Java Future containing the result of the FilterLogEvents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.FilterLogEvents
* @see AWS API
* Documentation
*/
default CompletableFuture filterLogEvents(FilterLogEventsRequest filterLogEventsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link FilterLogEventsRequest.Builder} avoiding the need
* to create one manually via {@link FilterLogEventsRequest#builder()}
*
*
* @param filterLogEventsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the FilterLogEvents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.FilterLogEvents
* @see AWS API
* Documentation
*/
default CompletableFuture filterLogEvents(
Consumer filterLogEventsRequest) {
return filterLogEvents(FilterLogEventsRequest.builder().applyMutation(filterLogEventsRequest).build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)}
* operation.
*
*
* @param filterLogEventsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.FilterLogEvents
* @see AWS API
* Documentation
*/
default FilterLogEventsPublisher filterLogEventsPaginator(FilterLogEventsRequest filterLogEventsRequest) {
return new FilterLogEventsPublisher(this, 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link FilterLogEventsRequest.Builder} avoiding the need
* to create one manually via {@link FilterLogEventsRequest#builder()}
*
*
* @param filterLogEventsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.FilterLogEvents
* @see AWS API
* Documentation
*/
default FilterLogEventsPublisher filterLogEventsPaginator(Consumer filterLogEventsRequest) {
return filterLogEventsPaginator(FilterLogEventsRequest.builder().applyMutation(filterLogEventsRequest).build());
}
/**
*
* Returns information about a log group data protection policy.
*
*
* @param getDataProtectionPolicyRequest
* @return A Java Future containing the result of the GetDataProtectionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetDataProtectionPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture getDataProtectionPolicy(
GetDataProtectionPolicyRequest getDataProtectionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about a log group data protection policy.
*
*
*
* This is a convenience which creates an instance of the {@link GetDataProtectionPolicyRequest.Builder} avoiding
* the need to create one manually via {@link GetDataProtectionPolicyRequest#builder()}
*
*
* @param getDataProtectionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.GetDataProtectionPolicyRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetDataProtectionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetDataProtectionPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture getDataProtectionPolicy(
Consumer getDataProtectionPolicyRequest) {
return getDataProtectionPolicy(GetDataProtectionPolicyRequest.builder().applyMutation(getDataProtectionPolicyRequest)
.build());
}
/**
*
* Returns complete information about one delivery. A delivery is a connection between a logical delivery
* source and a logical delivery destination
*
*
* You need to specify the delivery id in this operation. You can find the IDs of the deliveries in
* your account with the DescribeDeliveries operation.
*
*
* @param getDeliveryRequest
* @return A Java Future containing the result of the GetDelivery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetDelivery
* @see AWS API
* Documentation
*/
default CompletableFuture getDelivery(GetDeliveryRequest getDeliveryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns complete information about one delivery. A delivery is a connection between a logical delivery
* source and a logical delivery destination
*
*
* You need to specify the delivery id in this operation. You can find the IDs of the deliveries in
* your account with the DescribeDeliveries operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetDeliveryRequest.Builder} avoiding the need to
* create one manually via {@link GetDeliveryRequest#builder()}
*
*
* @param getDeliveryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.GetDeliveryRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetDelivery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetDelivery
* @see AWS API
* Documentation
*/
default CompletableFuture getDelivery(Consumer getDeliveryRequest) {
return getDelivery(GetDeliveryRequest.builder().applyMutation(getDeliveryRequest).build());
}
/**
*
* Retrieves complete information about one delivery destination.
*
*
* @param getDeliveryDestinationRequest
* @return A Java Future containing the result of the GetDeliveryDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetDeliveryDestination
* @see AWS
* API Documentation
*/
default CompletableFuture getDeliveryDestination(
GetDeliveryDestinationRequest getDeliveryDestinationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves complete information about one delivery destination.
*
*
*
* This is a convenience which creates an instance of the {@link GetDeliveryDestinationRequest.Builder} avoiding the
* need to create one manually via {@link GetDeliveryDestinationRequest#builder()}
*
*
* @param getDeliveryDestinationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.GetDeliveryDestinationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetDeliveryDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetDeliveryDestination
* @see AWS
* API Documentation
*/
default CompletableFuture getDeliveryDestination(
Consumer getDeliveryDestinationRequest) {
return getDeliveryDestination(GetDeliveryDestinationRequest.builder().applyMutation(getDeliveryDestinationRequest)
.build());
}
/**
*
* Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more
* information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.
*
*
* @param getDeliveryDestinationPolicyRequest
* @return A Java Future containing the result of the GetDeliveryDestinationPolicy operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ValidationException One of the parameters for the request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetDeliveryDestinationPolicy
* @see AWS API Documentation
*/
default CompletableFuture getDeliveryDestinationPolicy(
GetDeliveryDestinationPolicyRequest getDeliveryDestinationPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more
* information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.
*
*
*
* This is a convenience which creates an instance of the {@link GetDeliveryDestinationPolicyRequest.Builder}
* avoiding the need to create one manually via {@link GetDeliveryDestinationPolicyRequest#builder()}
*
*
* @param getDeliveryDestinationPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.GetDeliveryDestinationPolicyRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the GetDeliveryDestinationPolicy operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ValidationException One of the parameters for the request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetDeliveryDestinationPolicy
* @see AWS API Documentation
*/
default CompletableFuture getDeliveryDestinationPolicy(
Consumer getDeliveryDestinationPolicyRequest) {
return getDeliveryDestinationPolicy(GetDeliveryDestinationPolicyRequest.builder()
.applyMutation(getDeliveryDestinationPolicyRequest).build());
}
/**
*
* Retrieves complete information about one delivery source.
*
*
* @param getDeliverySourceRequest
* @return A Java Future containing the result of the GetDeliverySource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetDeliverySource
* @see AWS API
* Documentation
*/
default CompletableFuture getDeliverySource(GetDeliverySourceRequest getDeliverySourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves complete information about one delivery source.
*
*
*
* This is a convenience which creates an instance of the {@link GetDeliverySourceRequest.Builder} avoiding the need
* to create one manually via {@link GetDeliverySourceRequest#builder()}
*
*
* @param getDeliverySourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.GetDeliverySourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetDeliverySource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetDeliverySource
* @see AWS API
* Documentation
*/
default CompletableFuture getDeliverySource(
Consumer getDeliverySourceRequest) {
return getDeliverySource(GetDeliverySourceRequest.builder().applyMutation(getDeliverySourceRequest).build());
}
/**
*
* Retrieves information about the log anomaly detector that you specify.
*
*
* @param getLogAnomalyDetectorRequest
* @return A Java Future containing the result of the GetLogAnomalyDetector operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogAnomalyDetector
* @see AWS
* API Documentation
*/
default CompletableFuture getLogAnomalyDetector(
GetLogAnomalyDetectorRequest getLogAnomalyDetectorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves information about the log anomaly detector that you specify.
*
*
*
* This is a convenience which creates an instance of the {@link GetLogAnomalyDetectorRequest.Builder} avoiding the
* need to create one manually via {@link GetLogAnomalyDetectorRequest#builder()}
*
*
* @param getLogAnomalyDetectorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.GetLogAnomalyDetectorRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetLogAnomalyDetector operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogAnomalyDetector
* @see AWS
* API Documentation
*/
default CompletableFuture getLogAnomalyDetector(
Consumer getLogAnomalyDetectorRequest) {
return getLogAnomalyDetector(GetLogAnomalyDetectorRequest.builder().applyMutation(getLogAnomalyDetectorRequest).build());
}
/**
*
* 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.
*
*
* @param getLogEventsRequest
* @return A Java Future containing the result of the GetLogEvents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogEvents
* @see AWS API
* Documentation
*/
default CompletableFuture getLogEvents(GetLogEventsRequest getLogEventsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetLogEventsRequest.Builder} avoiding the need to
* create one manually via {@link GetLogEventsRequest#builder()}
*
*
* @param getLogEventsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetLogEvents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogEvents
* @see AWS API
* Documentation
*/
default CompletableFuture getLogEvents(Consumer getLogEventsRequest) {
return getLogEvents(GetLogEventsRequest.builder().applyMutation(getLogEventsRequest).build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest)} operation.
*
*
* @param getLogEventsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogEvents
* @see AWS API
* Documentation
*/
default GetLogEventsPublisher getLogEventsPaginator(GetLogEventsRequest getLogEventsRequest) {
return new GetLogEventsPublisher(this, 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link GetLogEventsRequest.Builder} avoiding the need to
* create one manually via {@link GetLogEventsRequest#builder()}
*
*
* @param getLogEventsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogEvents
* @see AWS API
* Documentation
*/
default GetLogEventsPublisher getLogEventsPaginator(Consumer getLogEventsRequest) {
return getLogEventsPaginator(GetLogEventsRequest.builder().applyMutation(getLogEventsRequest).build());
}
/**
*
* 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.
*
*
* @param getLogGroupFieldsRequest
* @return A Java Future containing the result of the GetLogGroupFields operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogGroupFields
* @see AWS API
* Documentation
*/
default CompletableFuture getLogGroupFields(GetLogGroupFieldsRequest getLogGroupFieldsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetLogGroupFieldsRequest.Builder} avoiding the need
* to create one manually via {@link GetLogGroupFieldsRequest#builder()}
*
*
* @param getLogGroupFieldsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.GetLogGroupFieldsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetLogGroupFields operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogGroupFields
* @see AWS API
* Documentation
*/
default CompletableFuture getLogGroupFields(
Consumer getLogGroupFieldsRequest) {
return getLogGroupFields(GetLogGroupFieldsRequest.builder().applyMutation(getLogGroupFieldsRequest).build());
}
/**
*
* 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.
*
*
* @param getLogRecordRequest
* @return A Java Future containing the result of the GetLogRecord operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogRecord
* @see AWS API
* Documentation
*/
default CompletableFuture getLogRecord(GetLogRecordRequest getLogRecordRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetLogRecordRequest.Builder} avoiding the need to
* create one manually via {@link GetLogRecordRequest#builder()}
*
*
* @param getLogRecordRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.GetLogRecordRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetLogRecord operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogRecord
* @see AWS API
* Documentation
*/
default CompletableFuture getLogRecord(Consumer getLogRecordRequest) {
return getLogRecord(GetLogRecordRequest.builder().applyMutation(getLogRecordRequest).build());
}
/**
*
* 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.
* For more information about how long results of previous queries are available, see CloudWatch Logs
* quotas.
*
*
* 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.
*
*
* @param getQueryResultsRequest
* @return A Java Future containing the result of the GetQueryResults operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetQueryResults
* @see AWS API
* Documentation
*/
default CompletableFuture getQueryResults(GetQueryResultsRequest getQueryResultsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
* For more information about how long results of previous queries are available, see CloudWatch Logs
* quotas.
*
*
* 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 {@link GetQueryResultsRequest.Builder} avoiding the need
* to create one manually via {@link GetQueryResultsRequest#builder()}
*
*
* @param getQueryResultsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.GetQueryResultsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetQueryResults operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetQueryResults
* @see AWS API
* Documentation
*/
default CompletableFuture getQueryResults(
Consumer getQueryResultsRequest) {
return getQueryResults(GetQueryResultsRequest.builder().applyMutation(getQueryResultsRequest).build());
}
/**
*
* Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each
* anomaly object that is returned, see the example in this section.
*
*
* @param listAnomaliesRequest
* @return A Java Future containing the result of the ListAnomalies operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListAnomalies
* @see AWS API
* Documentation
*/
default CompletableFuture listAnomalies(ListAnomaliesRequest listAnomaliesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each
* anomaly object that is returned, see the example in this section.
*
*
*
* This is a convenience which creates an instance of the {@link ListAnomaliesRequest.Builder} avoiding the need to
* create one manually via {@link ListAnomaliesRequest#builder()}
*
*
* @param listAnomaliesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListAnomalies operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListAnomalies
* @see AWS API
* Documentation
*/
default CompletableFuture listAnomalies(Consumer listAnomaliesRequest) {
return listAnomalies(ListAnomaliesRequest.builder().applyMutation(listAnomaliesRequest).build());
}
/**
*
* Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each
* anomaly object that is returned, see the example in this section.
*
*
*
* This is a variant of
* {@link #listAnomalies(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesPublisher publisher = client.listAnomaliesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesPublisher publisher = client.listAnomaliesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesResponse 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
* {@link #listAnomalies(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest)} operation.
*
*
* @param listAnomaliesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListAnomalies
* @see AWS API
* Documentation
*/
default ListAnomaliesPublisher listAnomaliesPaginator(ListAnomaliesRequest listAnomaliesRequest) {
return new ListAnomaliesPublisher(this, listAnomaliesRequest);
}
/**
*
* Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each
* anomaly object that is returned, see the example in this section.
*
*
*
* This is a variant of
* {@link #listAnomalies(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesPublisher publisher = client.listAnomaliesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesPublisher publisher = client.listAnomaliesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesResponse 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
* {@link #listAnomalies(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListAnomaliesRequest.Builder} avoiding the need to
* create one manually via {@link ListAnomaliesRequest#builder()}
*
*
* @param listAnomaliesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListAnomalies
* @see AWS API
* Documentation
*/
default ListAnomaliesPublisher listAnomaliesPaginator(Consumer listAnomaliesRequest) {
return listAnomaliesPaginator(ListAnomaliesRequest.builder().applyMutation(listAnomaliesRequest).build());
}
/**
*
* Retrieves a list of the log anomaly detectors in the account.
*
*
* @param listLogAnomalyDetectorsRequest
* @return A Java Future containing the result of the ListLogAnomalyDetectors operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListLogAnomalyDetectors
* @see AWS
* API Documentation
*/
default CompletableFuture listLogAnomalyDetectors(
ListLogAnomalyDetectorsRequest listLogAnomalyDetectorsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of the log anomaly detectors in the account.
*
*
*
* This is a convenience which creates an instance of the {@link ListLogAnomalyDetectorsRequest.Builder} avoiding
* the need to create one manually via {@link ListLogAnomalyDetectorsRequest#builder()}
*
*
* @param listLogAnomalyDetectorsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListLogAnomalyDetectors operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListLogAnomalyDetectors
* @see AWS
* API Documentation
*/
default CompletableFuture listLogAnomalyDetectors(
Consumer listLogAnomalyDetectorsRequest) {
return listLogAnomalyDetectors(ListLogAnomalyDetectorsRequest.builder().applyMutation(listLogAnomalyDetectorsRequest)
.build());
}
/**
*
* Retrieves a list of the log anomaly detectors in the account.
*
*
*
* This is a variant of
* {@link #listLogAnomalyDetectors(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsPublisher publisher = client.listLogAnomalyDetectorsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsPublisher publisher = client.listLogAnomalyDetectorsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsResponse 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
* {@link #listLogAnomalyDetectors(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest)}
* operation.
*
*
* @param listLogAnomalyDetectorsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListLogAnomalyDetectors
* @see AWS
* API Documentation
*/
default ListLogAnomalyDetectorsPublisher listLogAnomalyDetectorsPaginator(
ListLogAnomalyDetectorsRequest listLogAnomalyDetectorsRequest) {
return new ListLogAnomalyDetectorsPublisher(this, listLogAnomalyDetectorsRequest);
}
/**
*
* Retrieves a list of the log anomaly detectors in the account.
*
*
*
* This is a variant of
* {@link #listLogAnomalyDetectors(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsPublisher publisher = client.listLogAnomalyDetectorsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsPublisher publisher = client.listLogAnomalyDetectorsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsResponse 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
* {@link #listLogAnomalyDetectors(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListLogAnomalyDetectorsRequest.Builder} avoiding
* the need to create one manually via {@link ListLogAnomalyDetectorsRequest#builder()}
*
*
* @param listLogAnomalyDetectorsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest.Builder} to
* create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListLogAnomalyDetectors
* @see AWS
* API Documentation
*/
default ListLogAnomalyDetectorsPublisher listLogAnomalyDetectorsPaginator(
Consumer listLogAnomalyDetectorsRequest) {
return listLogAnomalyDetectorsPaginator(ListLogAnomalyDetectorsRequest.builder()
.applyMutation(listLogAnomalyDetectorsRequest).build());
}
/**
*
* Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support
* tagging.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.ListTagsForResourceRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
*
* The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
*
*
*
* Lists the tags for the specified log group.
*
*
* @param listTagsLogGroupRequest
* @return A Java Future containing the result of the ListTagsLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListTagsLogGroup
* @see AWS API
* Documentation
*
* @deprecated Please use the generic tagging API ListTagsForResource
*/
@Deprecated
default CompletableFuture listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
*
* 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 {@link ListTagsLogGroupRequest.Builder} avoiding the need
* to create one manually via {@link ListTagsLogGroupRequest#builder()}
*
*
* @param listTagsLogGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.ListTagsLogGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListTagsLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListTagsLogGroup
* @see AWS API
* Documentation
*
* @deprecated Please use the generic tagging API ListTagsForResource
*/
@Deprecated
default CompletableFuture listTagsLogGroup(
Consumer listTagsLogGroupRequest) {
return listTagsLogGroup(ListTagsLogGroupRequest.builder().applyMutation(listTagsLogGroupRequest).build());
}
/**
*
* 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.
*
*
* @param putAccountPolicyRequest
* @return A Java Future containing the result of the PutAccountPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutAccountPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putAccountPolicy(PutAccountPolicyRequest putAccountPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutAccountPolicyRequest.Builder} avoiding the need
* to create one manually via {@link PutAccountPolicyRequest#builder()}
*
*
* @param putAccountPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutAccountPolicyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutAccountPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutAccountPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putAccountPolicy(
Consumer putAccountPolicyRequest) {
return putAccountPolicy(PutAccountPolicyRequest.builder().applyMutation(putAccountPolicyRequest).build());
}
/**
*
* 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.
*
*
* @param putDataProtectionPolicyRequest
* @return A Java Future containing the result of the PutDataProtectionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDataProtectionPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture putDataProtectionPolicy(
PutDataProtectionPolicyRequest putDataProtectionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutDataProtectionPolicyRequest.Builder} avoiding
* the need to create one manually via {@link PutDataProtectionPolicyRequest#builder()}
*
*
* @param putDataProtectionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutDataProtectionPolicyRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the PutDataProtectionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDataProtectionPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture putDataProtectionPolicy(
Consumer putDataProtectionPolicyRequest) {
return putDataProtectionPolicy(PutDataProtectionPolicyRequest.builder().applyMutation(putDataProtectionPolicyRequest)
.build());
}
/**
*
* Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services
* resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and
* Kinesis Data Firehose are supported as logs delivery destinations.
*
*
* To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the
* following:
*
*
* -
*
* Create a delivery source, which is a logical object that represents the resource that is actually sending the
* logs. For more information, see PutDeliverySource.
*
*
* -
*
* Use PutDeliveryDestination to create a delivery destination, which is a logical object that
* represents the actual delivery destination.
*
*
* -
*
* If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This
* policy allows delivery to that destination.
*
*
* -
*
* Use CreateDelivery to create a delivery by pairing exactly one delivery source and one
* delivery destination. For more information, see CreateDelivery.
*
*
*
*
* You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries.
* You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery
* destination.
*
*
* Only some Amazon Web Services services support being configured as a delivery source. These services are listed
* as Supported [V2 Permissions] in the table at Enabling
* logging from Amazon Web Services services.
*
*
* If you use this operation to update an existing delivery destination, all the current delivery destination
* parameters are overwritten with the new parameter values that you specify.
*
*
* @param putDeliveryDestinationRequest
* @return A Java Future containing the result of the PutDeliveryDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ConflictException This operation attempted to create a resource that already exists.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDeliveryDestination
* @see AWS
* API Documentation
*/
default CompletableFuture putDeliveryDestination(
PutDeliveryDestinationRequest putDeliveryDestinationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services
* resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and
* Kinesis Data Firehose are supported as logs delivery destinations.
*
*
* To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the
* following:
*
*
* -
*
* Create a delivery source, which is a logical object that represents the resource that is actually sending the
* logs. For more information, see PutDeliverySource.
*
*
* -
*
* Use PutDeliveryDestination to create a delivery destination, which is a logical object that
* represents the actual delivery destination.
*
*
* -
*
* If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This
* policy allows delivery to that destination.
*
*
* -
*
* Use CreateDelivery to create a delivery by pairing exactly one delivery source and one
* delivery destination. For more information, see CreateDelivery.
*
*
*
*
* You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries.
* You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery
* destination.
*
*
* Only some Amazon Web Services services support being configured as a delivery source. These services are listed
* as Supported [V2 Permissions] in the table at Enabling
* logging from Amazon Web Services services.
*
*
* If you use this operation to update an existing delivery destination, all the current delivery destination
* parameters are overwritten with the new parameter values that you specify.
*
*
*
* This is a convenience which creates an instance of the {@link PutDeliveryDestinationRequest.Builder} avoiding the
* need to create one manually via {@link PutDeliveryDestinationRequest#builder()}
*
*
* @param putDeliveryDestinationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutDeliveryDestinationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the PutDeliveryDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ConflictException This operation attempted to create a resource that already exists.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ThrottlingException The request was throttled because of quota limits.
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDeliveryDestination
* @see AWS
* API Documentation
*/
default CompletableFuture putDeliveryDestination(
Consumer putDeliveryDestinationRequest) {
return putDeliveryDestination(PutDeliveryDestinationRequest.builder().applyMutation(putDeliveryDestinationRequest)
.build());
}
/**
*
* Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a
* specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in
* another account to a logs delivery destination in the current account, you must do the following:
*
*
* -
*
* Create a delivery source, which is a logical object that represents the resource that is actually sending the
* logs. For more information, see PutDeliverySource.
*
*
* -
*
* Create a delivery destination, which is a logical object that represents the actual delivery destination.
* For more information, see PutDeliveryDestination.
*
*
* -
*
* Use this operation in the destination account to assign an IAM policy to the destination. This policy allows
* delivery to that destination.
*
*
* -
*
* Create a delivery by pairing exactly one delivery source and one delivery destination. For more
* information, see CreateDelivery.
*
*
*
*
* Only some Amazon Web Services services support being configured as a delivery source. These services are listed
* as Supported [V2 Permissions] in the table at Enabling
* logging from Amazon Web Services services.
*
*
* The contents of the policy must include two statements. One statement enables general logs delivery, and the
* other allows delivery to the chosen destination. See the examples for the needed policies.
*
*
* @param putDeliveryDestinationPolicyRequest
* @return A Java Future containing the result of the PutDeliveryDestinationPolicy operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ValidationException One of the parameters for the request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - ConflictException This operation attempted to create a resource that already exists.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDeliveryDestinationPolicy
* @see AWS API Documentation
*/
default CompletableFuture putDeliveryDestinationPolicy(
PutDeliveryDestinationPolicyRequest putDeliveryDestinationPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a
* specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in
* another account to a logs delivery destination in the current account, you must do the following:
*
*
* -
*
* Create a delivery source, which is a logical object that represents the resource that is actually sending the
* logs. For more information, see PutDeliverySource.
*
*
* -
*
* Create a delivery destination, which is a logical object that represents the actual delivery destination.
* For more information, see PutDeliveryDestination.
*
*
* -
*
* Use this operation in the destination account to assign an IAM policy to the destination. This policy allows
* delivery to that destination.
*
*
* -
*
* Create a delivery by pairing exactly one delivery source and one delivery destination. For more
* information, see CreateDelivery.
*
*
*
*
* Only some Amazon Web Services services support being configured as a delivery source. These services are listed
* as Supported [V2 Permissions] in the table at Enabling
* logging from Amazon Web Services services.
*
*
* The contents of the policy must include two statements. One statement enables general logs delivery, and the
* other allows delivery to the chosen destination. See the examples for the needed policies.
*
*
*
* This is a convenience which creates an instance of the {@link PutDeliveryDestinationPolicyRequest.Builder}
* avoiding the need to create one manually via {@link PutDeliveryDestinationPolicyRequest#builder()}
*
*
* @param putDeliveryDestinationPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutDeliveryDestinationPolicyRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the PutDeliveryDestinationPolicy operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ValidationException One of the parameters for the request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - ConflictException This operation attempted to create a resource that already exists.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDeliveryDestinationPolicy
* @see AWS API Documentation
*/
default CompletableFuture putDeliveryDestinationPolicy(
Consumer putDeliveryDestinationPolicyRequest) {
return putDeliveryDestinationPolicy(PutDeliveryDestinationPolicyRequest.builder()
.applyMutation(putDeliveryDestinationPolicyRequest).build());
}
/**
*
* Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource
* that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis
* Data Firehose.
*
*
* To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as
* a delivery source, you must do the following:
*
*
* -
*
* Use PutDeliverySource to create a delivery source, which is a logical object that represents the
* resource that is actually sending the logs.
*
*
* -
*
* Use PutDeliveryDestination to create a delivery destination, which is a logical object that
* represents the actual delivery destination. For more information, see PutDeliveryDestination.
*
*
* -
*
* If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This
* policy allows delivery to that destination.
*
*
* -
*
* Use CreateDelivery to create a delivery by pairing exactly one delivery source and one
* delivery destination. For more information, see CreateDelivery.
*
*
*
*
* You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries.
* You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery
* destination.
*
*
* Only some Amazon Web Services services support being configured as a delivery source. These services are listed
* as Supported [V2 Permissions] in the table at Enabling
* logging from Amazon Web Services services.
*
*
* If you use this operation to update an existing delivery source, all the current delivery source parameters are
* overwritten with the new parameter values that you specify.
*
*
* @param putDeliverySourceRequest
* @return A Java Future containing the result of the PutDeliverySource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ConflictException This operation attempted to create a resource that already exists.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ResourceNotFoundException The specified resource does not exist.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDeliverySource
* @see AWS API
* Documentation
*/
default CompletableFuture putDeliverySource(PutDeliverySourceRequest putDeliverySourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource
* that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis
* Data Firehose.
*
*
* To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as
* a delivery source, you must do the following:
*
*
* -
*
* Use PutDeliverySource to create a delivery source, which is a logical object that represents the
* resource that is actually sending the logs.
*
*
* -
*
* Use PutDeliveryDestination to create a delivery destination, which is a logical object that
* represents the actual delivery destination. For more information, see PutDeliveryDestination.
*
*
* -
*
* If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This
* policy allows delivery to that destination.
*
*
* -
*
* Use CreateDelivery to create a delivery by pairing exactly one delivery source and one
* delivery destination. For more information, see CreateDelivery.
*
*
*
*
* You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries.
* You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery
* destination.
*
*
* Only some Amazon Web Services services support being configured as a delivery source. These services are listed
* as Supported [V2 Permissions] in the table at Enabling
* logging from Amazon Web Services services.
*
*
* If you use this operation to update an existing delivery source, all the current delivery source parameters are
* overwritten with the new parameter values that you specify.
*
*
*
* This is a convenience which creates an instance of the {@link PutDeliverySourceRequest.Builder} avoiding the need
* to create one manually via {@link PutDeliverySourceRequest#builder()}
*
*
* @param putDeliverySourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutDeliverySourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutDeliverySource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceUnavailableException The service cannot complete the request.
* - ConflictException This operation attempted to create a resource that already exists.
* - ValidationException One of the parameters for the request is not valid.
* - ServiceQuotaExceededException This request exceeds a service quota.
* - ResourceNotFoundException The specified resource does not exist.
* - ThrottlingException The request was throttled because of quota limits.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDeliverySource
* @see AWS API
* Documentation
*/
default CompletableFuture putDeliverySource(
Consumer putDeliverySourceRequest) {
return putDeliverySource(PutDeliverySourceRequest.builder().applyMutation(putDeliverySourceRequest).build());
}
/**
*
* 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.
*
*
* @param putDestinationRequest
* @return A Java Future containing the result of the PutDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDestination
* @see AWS API
* Documentation
*/
default CompletableFuture putDestination(PutDestinationRequest putDestinationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutDestinationRequest.Builder} avoiding the need to
* create one manually via {@link PutDestinationRequest#builder()}
*
*
* @param putDestinationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutDestinationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDestination
* @see AWS API
* Documentation
*/
default CompletableFuture putDestination(Consumer putDestinationRequest) {
return putDestination(PutDestinationRequest.builder().applyMutation(putDestinationRequest).build());
}
/**
*
* 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.
*
*
* @param putDestinationPolicyRequest
* @return A Java Future containing the result of the PutDestinationPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDestinationPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putDestinationPolicy(
PutDestinationPolicyRequest putDestinationPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutDestinationPolicyRequest.Builder} avoiding the
* need to create one manually via {@link PutDestinationPolicyRequest#builder()}
*
*
* @param putDestinationPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutDestinationPolicyRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the PutDestinationPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDestinationPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putDestinationPolicy(
Consumer putDestinationPolicyRequest) {
return putDestinationPolicy(PutDestinationPolicyRequest.builder().applyMutation(putDestinationPolicyRequest).build());
}
/**
*
* 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.
*
*
* @param putLogEventsRequest
* @return A Java Future containing the result of the PutLogEvents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - InvalidSequenceTokenException The sequence token is not valid. You can get the correct sequence token
* in the
expectedSequenceToken field in the InvalidSequenceTokenException
* message.
*
* PutLogEvents actions are now always accepted and never return
* InvalidSequenceTokenException regardless of receiving an invalid sequence token.
*
*
* - DataAlreadyAcceptedException The event was already logged.
*
* PutLogEvents actions are now always accepted and never return
* DataAlreadyAcceptedException regardless of whether a given batch of log events has already
* been accepted.
*
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - UnrecognizedClientException The most likely cause is an Amazon Web Services access key ID or secret
* key that's not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutLogEvents
* @see AWS API
* Documentation
*/
default CompletableFuture putLogEvents(PutLogEventsRequest putLogEventsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutLogEventsRequest.Builder} avoiding the need to
* create one manually via {@link PutLogEventsRequest#builder()}
*
*
* @param putLogEventsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutLogEventsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutLogEvents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - InvalidSequenceTokenException The sequence token is not valid. You can get the correct sequence token
* in the
expectedSequenceToken field in the InvalidSequenceTokenException
* message.
*
* PutLogEvents actions are now always accepted and never return
* InvalidSequenceTokenException regardless of receiving an invalid sequence token.
*
*
* - DataAlreadyAcceptedException The event was already logged.
*
* PutLogEvents actions are now always accepted and never return
* DataAlreadyAcceptedException regardless of whether a given batch of log events has already
* been accepted.
*
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - UnrecognizedClientException The most likely cause is an Amazon Web Services access key ID or secret
* key that's not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutLogEvents
* @see AWS API
* Documentation
*/
default CompletableFuture putLogEvents(Consumer putLogEventsRequest) {
return putLogEvents(PutLogEventsRequest.builder().applyMutation(putLogEventsRequest).build());
}
/**
*
* 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 might disable a metric filter if it generates 1,000 different name/value pairs for your specified
* dimensions within one hour.
*
*
* 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.
*
*
*
* @param putMetricFilterRequest
* @return A Java Future containing the result of the PutMetricFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutMetricFilter
* @see AWS API
* Documentation
*/
default CompletableFuture putMetricFilter(PutMetricFilterRequest putMetricFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 might disable a metric filter if it generates 1,000 different name/value pairs for your specified
* dimensions within one hour.
*
*
* 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 {@link PutMetricFilterRequest.Builder} avoiding the need
* to create one manually via {@link PutMetricFilterRequest#builder()}
*
*
* @param putMetricFilterRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutMetricFilterRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutMetricFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutMetricFilter
* @see AWS API
* Documentation
*/
default CompletableFuture putMetricFilter(
Consumer putMetricFilterRequest) {
return putMetricFilter(PutMetricFilterRequest.builder().applyMutation(putMetricFilterRequest).build());
}
/**
*
* 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.
*
*
* @param putQueryDefinitionRequest
* @return A Java Future containing the result of the PutQueryDefinition operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutQueryDefinition
* @see AWS API
* Documentation
*/
default CompletableFuture putQueryDefinition(PutQueryDefinitionRequest putQueryDefinitionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutQueryDefinitionRequest.Builder} avoiding the
* need to create one manually via {@link PutQueryDefinitionRequest#builder()}
*
*
* @param putQueryDefinitionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutQueryDefinitionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutQueryDefinition operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutQueryDefinition
* @see AWS API
* Documentation
*/
default CompletableFuture putQueryDefinition(
Consumer putQueryDefinitionRequest) {
return putQueryDefinition(PutQueryDefinitionRequest.builder().applyMutation(putQueryDefinitionRequest).build());
}
/**
*
* 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.
*
*
* @param putResourcePolicyRequest
* @return A Java Future containing the result of the PutResourcePolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutResourcePolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutResourcePolicyRequest.Builder} avoiding the need
* to create one manually via {@link PutResourcePolicyRequest#builder()}
*
*
* @param putResourcePolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutResourcePolicyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutResourcePolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutResourcePolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putResourcePolicy(
Consumer putResourcePolicyRequest) {
return putResourcePolicy(PutResourcePolicyRequest.builder().applyMutation(putResourcePolicyRequest).build());
}
/**
*
* 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.
*
*
* When log events reach their retention setting they are marked for deletion. After they are marked for deletion,
* they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These
* log events marked for deletion are also not included when you use an API to retrieve the storedBytes
* value to see how many bytes a log group is storing.
*
*
*
* @param putRetentionPolicyRequest
* @return A Java Future containing the result of the PutRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutRetentionPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
* When log events reach their retention setting they are marked for deletion. After they are marked for deletion,
* they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These
* log events marked for deletion are also not included when you use an API to retrieve the storedBytes
* value to see how many bytes a log group is storing.
*
*
*
* This is a convenience which creates an instance of the {@link PutRetentionPolicyRequest.Builder} avoiding the
* need to create one manually via {@link PutRetentionPolicyRequest#builder()}
*
*
* @param putRetentionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutRetentionPolicyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutRetentionPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putRetentionPolicy(
Consumer putRetentionPolicyRequest) {
return putRetentionPolicy(PutRetentionPolicyRequest.builder().applyMutation(putRetentionPolicyRequest).build());
}
/**
*
* 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.
*
*
* @param putSubscriptionFilterRequest
* @return A Java Future containing the result of the PutSubscriptionFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutSubscriptionFilter
* @see AWS
* API Documentation
*/
default CompletableFuture putSubscriptionFilter(
PutSubscriptionFilterRequest putSubscriptionFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutSubscriptionFilterRequest.Builder} avoiding the
* need to create one manually via {@link PutSubscriptionFilterRequest#builder()}
*
*
* @param putSubscriptionFilterRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.PutSubscriptionFilterRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the PutSubscriptionFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutSubscriptionFilter
* @see AWS
* API Documentation
*/
default CompletableFuture putSubscriptionFilter(
Consumer putSubscriptionFilterRequest) {
return putSubscriptionFilter(PutSubscriptionFilterRequest.builder().applyMutation(putSubscriptionFilterRequest).build());
}
/**
*
* Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log
* events that have been recently ingested in the log groups. For more information, see Use Live Tail to
* view logs in near real time.
*
*
* The response to this operation is a response stream, over which the server sends live log events and the client
* receives them.
*
*
* The following objects are sent over the stream:
*
*
* -
*
* A single LiveTailSessionStart object is sent at the start of the session.
*
*
* -
*
* Every second, a LiveTailSessionUpdate object is sent. Each of these objects contains an array of the actual log events.
*
*
* If no new log events were ingested in the past second, the LiveTailSessionUpdate object will contain
* an empty array.
*
*
* The array of log events contained in a LiveTailSessionUpdate can include as many as 500 log events.
* If the number of log events matching the request exceeds 500 per second, the log events are sampled down to 500
* log events to be included in each LiveTailSessionUpdate object.
*
*
* If your client consumes the log events slower than the server produces them, CloudWatch Logs buffers up to 10
* LiveTailSessionUpdate events or 5000 log events, after which it starts dropping the oldest events.
*
*
* -
*
* A SessionStreamingException object is returned if an unknown error occurs on the server side.
*
*
* -
*
* A
* SessionTimeoutException object is returned when the session times out, after it has been kept open for three
* hours.
*
*
*
*
*
* You can end a session before it times out by closing the session stream or by closing the client that is
* receiving the stream. The session also ends if the established connection between the client and the server
* breaks.
*
*
*
* @param startLiveTailRequest
* @return A Java Future containing the result of the StartLiveTail operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException You don't have sufficient permissions to perform this action.
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - InvalidOperationException The operation is not valid on the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.StartLiveTail
* @see AWS API
* Documentation
*/
default CompletableFuture startLiveTail(StartLiveTailRequest startLiveTailRequest,
StartLiveTailResponseHandler asyncResponseHandler) {
throw new UnsupportedOperationException();
}
/**
*
* Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log
* events that have been recently ingested in the log groups. For more information, see Use Live Tail to
* view logs in near real time.
*
*
* The response to this operation is a response stream, over which the server sends live log events and the client
* receives them.
*
*
* The following objects are sent over the stream:
*
*
* -
*
* A single LiveTailSessionStart object is sent at the start of the session.
*
*
* -
*
* Every second, a LiveTailSessionUpdate object is sent. Each of these objects contains an array of the actual log events.
*
*
* If no new log events were ingested in the past second, the LiveTailSessionUpdate object will contain
* an empty array.
*
*
* The array of log events contained in a LiveTailSessionUpdate can include as many as 500 log events.
* If the number of log events matching the request exceeds 500 per second, the log events are sampled down to 500
* log events to be included in each LiveTailSessionUpdate object.
*
*
* If your client consumes the log events slower than the server produces them, CloudWatch Logs buffers up to 10
* LiveTailSessionUpdate events or 5000 log events, after which it starts dropping the oldest events.
*
*
* -
*
* A SessionStreamingException object is returned if an unknown error occurs on the server side.
*
*
* -
*
* A
* SessionTimeoutException object is returned when the session times out, after it has been kept open for three
* hours.
*
*
*
*
*
* You can end a session before it times out by closing the session stream or by closing the client that is
* receiving the stream. The session also ends if the established connection between the client and the server
* breaks.
*
*
*
* This is a convenience which creates an instance of the {@link StartLiveTailRequest.Builder} avoiding the need to
* create one manually via {@link StartLiveTailRequest#builder()}
*
*
* @param startLiveTailRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.StartLiveTailRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the StartLiveTail operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException You don't have sufficient permissions to perform this action.
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - InvalidOperationException The operation is not valid on the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.StartLiveTail
* @see AWS API
* Documentation
*/
default CompletableFuture startLiveTail(Consumer startLiveTailRequest,
StartLiveTailResponseHandler asyncResponseHandler) {
return startLiveTail(StartLiveTailRequest.builder().applyMutation(startLiveTailRequest).build(), asyncResponseHandler);
}
/**
*
* 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.
*
*
* @param startQueryRequest
* @return A Java Future containing the result of the StartQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - MalformedQueryException The query string is not valid. Details about this error are displayed in a
*
QueryCompileError object. For more information, see QueryCompileError.
*
* For more information about valid query syntax, see CloudWatch Logs
* Insights Query Syntax.
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.StartQuery
* @see AWS API
* Documentation
*/
default CompletableFuture startQuery(StartQueryRequest startQueryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartQueryRequest.Builder} avoiding the need to
* create one manually via {@link StartQueryRequest#builder()}
*
*
* @param startQueryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.StartQueryRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the StartQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - MalformedQueryException The query string is not valid. Details about this error are displayed in a
*
QueryCompileError object. For more information, see QueryCompileError.
*
* For more information about valid query syntax, see CloudWatch Logs
* Insights Query Syntax.
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.StartQuery
* @see AWS API
* Documentation
*/
default CompletableFuture startQuery(Consumer startQueryRequest) {
return startQuery(StartQueryRequest.builder().applyMutation(startQueryRequest).build());
}
/**
*
* 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.
*
*
* @param stopQueryRequest
* @return A Java Future containing the result of the StopQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.StopQuery
* @see AWS API
* Documentation
*/
default CompletableFuture stopQuery(StopQueryRequest stopQueryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StopQueryRequest.Builder} avoiding the need to
* create one manually via {@link StopQueryRequest#builder()}
*
*
* @param stopQueryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.StopQueryRequest.Builder} to create a request.
* @return A Java Future containing the result of the StopQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.StopQuery
* @see AWS API
* Documentation
*/
default CompletableFuture stopQuery(Consumer stopQueryRequest) {
return stopQuery(StopQueryRequest.builder().applyMutation(stopQueryRequest).build());
}
/**
*
*
* 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.
*
*
* @param tagLogGroupRequest
* @return A Java Future containing the result of the TagLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - InvalidParameterException A parameter is specified incorrectly.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.TagLogGroup
* @see AWS API
* Documentation
*
* @deprecated Please use the generic tagging API TagResource
*/
@Deprecated
default CompletableFuture tagLogGroup(TagLogGroupRequest tagLogGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
*
* 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 {@link TagLogGroupRequest.Builder} avoiding the need to
* create one manually via {@link TagLogGroupRequest#builder()}
*
*
* @param tagLogGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.TagLogGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the TagLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - InvalidParameterException A parameter is specified incorrectly.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.TagLogGroup
* @see AWS API
* Documentation
*
* @deprecated Please use the generic tagging API TagResource
*/
@Deprecated
default CompletableFuture tagLogGroup(Consumer tagLogGroupRequest) {
return tagLogGroup(TagLogGroupRequest.builder().applyMutation(tagLogGroupRequest).build());
}
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - TooManyTagsException A resource can have no more than 50 tags.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.TagResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - TooManyTagsException A resource can have no more than 50 tags.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* 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.
*
*
* @param testMetricFilterRequest
* @return A Java Future containing the result of the TestMetricFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.TestMetricFilter
* @see AWS API
* Documentation
*/
default CompletableFuture testMetricFilter(TestMetricFilterRequest testMetricFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TestMetricFilterRequest.Builder} avoiding the need
* to create one manually via {@link TestMetricFilterRequest#builder()}
*
*
* @param testMetricFilterRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.TestMetricFilterRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the TestMetricFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.TestMetricFilter
* @see AWS API
* Documentation
*/
default CompletableFuture testMetricFilter(
Consumer testMetricFilterRequest) {
return testMetricFilter(TestMetricFilterRequest.builder().applyMutation(testMetricFilterRequest).build());
}
/**
*
*
* 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.
*
*
* @param untagLogGroupRequest
* @return A Java Future containing the result of the UntagLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.UntagLogGroup
* @see AWS API
* Documentation
*
* @deprecated Please use the generic tagging API UntagResource
*/
@Deprecated
default CompletableFuture untagLogGroup(UntagLogGroupRequest untagLogGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
*
* 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 {@link UntagLogGroupRequest.Builder} avoiding the need to
* create one manually via {@link UntagLogGroupRequest#builder()}
*
*
* @param untagLogGroupRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.UntagLogGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UntagLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.UntagLogGroup
* @see AWS API
* Documentation
*
* @deprecated Please use the generic tagging API UntagResource
*/
@Deprecated
default CompletableFuture untagLogGroup(Consumer untagLogGroupRequest) {
return untagLogGroup(UntagLogGroupRequest.builder().applyMutation(untagLogGroupRequest).build());
}
/**
*
* Removes one or more tags from the specified resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes one or more tags from the specified resource.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.UntagResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an
* anomaly, CloudWatch Logs won’t report new occurrences of that anomaly and won't update that anomaly with new
* data. If you suppress a pattern, CloudWatch Logs won’t report any anomalies related to that pattern.
*
*
* You must specify either anomalyId or patternId, but you can't specify both parameters
* in the same operation.
*
*
* If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to
* cause CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern
* to stop suppressing, and omit the suppressionType and suppressionPeriod parameters.
*
*
* @param updateAnomalyRequest
* @return A Java Future containing the result of the UpdateAnomaly operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.UpdateAnomaly
* @see AWS API
* Documentation
*/
default CompletableFuture updateAnomaly(UpdateAnomalyRequest updateAnomalyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an
* anomaly, CloudWatch Logs won’t report new occurrences of that anomaly and won't update that anomaly with new
* data. If you suppress a pattern, CloudWatch Logs won’t report any anomalies related to that pattern.
*
*
* You must specify either anomalyId or patternId, but you can't specify both parameters
* in the same operation.
*
*
* If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to
* cause CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern
* to stop suppressing, and omit the suppressionType and suppressionPeriod parameters.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateAnomalyRequest.Builder} avoiding the need to
* create one manually via {@link UpdateAnomalyRequest#builder()}
*
*
* @param updateAnomalyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.UpdateAnomalyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateAnomaly operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.UpdateAnomaly
* @see AWS API
* Documentation
*/
default CompletableFuture updateAnomaly(Consumer updateAnomalyRequest) {
return updateAnomaly(UpdateAnomalyRequest.builder().applyMutation(updateAnomalyRequest).build());
}
/**
*
* Updates an existing log anomaly detector.
*
*
* @param updateLogAnomalyDetectorRequest
* @return A Java Future containing the result of the UpdateLogAnomalyDetector operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.UpdateLogAnomalyDetector
* @see AWS
* API Documentation
*/
default CompletableFuture updateLogAnomalyDetector(
UpdateLogAnomalyDetectorRequest updateLogAnomalyDetectorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates an existing log anomaly detector.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateLogAnomalyDetectorRequest.Builder} avoiding
* the need to create one manually via {@link UpdateLogAnomalyDetectorRequest#builder()}
*
*
* @param updateLogAnomalyDetectorRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatchlogs.model.UpdateLogAnomalyDetectorRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the UpdateLogAnomalyDetector operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - OperationAbortedException Multiple concurrent requests to update the same resource were in conflict.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.UpdateLogAnomalyDetector
* @see AWS
* API Documentation
*/
default CompletableFuture updateLogAnomalyDetector(
Consumer updateLogAnomalyDetectorRequest) {
return updateLogAnomalyDetector(UpdateLogAnomalyDetectorRequest.builder().applyMutation(updateLogAnomalyDetectorRequest)
.build());
}
@Override
default CloudWatchLogsServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link CloudWatchLogsAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static CloudWatchLogsAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link CloudWatchLogsAsyncClient}.
*/
static CloudWatchLogsAsyncClientBuilder builder() {
return new DefaultCloudWatchLogsAsyncClientBuilder();
}
}