Package software.amazon.awssdk.services.cloudwatchlogs

Interface CloudWatchLogsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface CloudWatchLogsAsyncClient extends AwsClient
Service client for accessing Amazon CloudWatch Logs asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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.

  • Field Details

  • Method Details

    • associateKmsKey

      default CompletableFuture<AssociateKmsKeyResponse> associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest)

      Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.

      When you use AssociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.

      • Specify the logGroupName parameter to cause all log events stored in the log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.

        Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

        Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier parameter that specifies a query-result resource.

      • Specify the resourceIdentifier parameter with a query-result resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.

        Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.

        If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.

      If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.

      CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.

      It can take up to 5 minutes for this operation to take effect.

      If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

      Parameters:
      associateKmsKeyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • associateKmsKey

      default CompletableFuture<AssociateKmsKeyResponse> associateKmsKey(Consumer<AssociateKmsKeyRequest.Builder> associateKmsKeyRequest)

      Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.

      When you use AssociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.

      • Specify the logGroupName parameter to cause all log events stored in the log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.

        Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

        Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier parameter that specifies a query-result resource.

      • Specify the resourceIdentifier parameter with a query-result resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.

        Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.

        If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.

      If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.

      CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.

      It can take up to 5 minutes for this operation to take effect.

      If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.


      This is a convenience which creates an instance of the AssociateKmsKeyRequest.Builder avoiding the need to create one manually via AssociateKmsKeyRequest.builder()

      Parameters:
      associateKmsKeyRequest - A Consumer that will call methods on AssociateKmsKeyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • cancelExportTask

      default CompletableFuture<CancelExportTaskResponse> cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)

      Cancels the specified export task.

      The task must be in the PENDING or RUNNING state.

      Parameters:
      cancelExportTaskRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • cancelExportTask

      default CompletableFuture<CancelExportTaskResponse> cancelExportTask(Consumer<CancelExportTaskRequest.Builder> cancelExportTaskRequest)

      Cancels the specified export task.

      The task must be in the PENDING or RUNNING state.


      This is a convenience which creates an instance of the CancelExportTaskRequest.Builder avoiding the need to create one manually via CancelExportTaskRequest.builder()

      Parameters:
      cancelExportTaskRequest - A Consumer that will call methods on CancelExportTaskRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDelivery

      default CompletableFuture<CreateDeliveryResponse> createDelivery(CreateDeliveryRequest createDeliveryRequest)

      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 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.

      Parameters:
      createDeliveryRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDelivery

      default CompletableFuture<CreateDeliveryResponse> createDelivery(Consumer<CreateDeliveryRequest.Builder> createDeliveryRequest)

      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 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 CreateDeliveryRequest.Builder avoiding the need to create one manually via CreateDeliveryRequest.builder()

      Parameters:
      createDeliveryRequest - A Consumer that will call methods on CreateDeliveryRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createExportTask

      default CompletableFuture<CreateExportTaskResponse> createExportTask(CreateExportTaskRequest createExportTaskRequest)

      Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.

      Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.

      Exporting to S3 buckets that are encrypted with AES-256 is supported.

      This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active ( RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

      You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

      Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.

      Parameters:
      createExportTaskRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createExportTask

      default CompletableFuture<CreateExportTaskResponse> createExportTask(Consumer<CreateExportTaskRequest.Builder> createExportTaskRequest)

      Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.

      Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.

      Exporting to S3 buckets that are encrypted with AES-256 is supported.

      This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active ( RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

      You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

      Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.


      This is a convenience which creates an instance of the CreateExportTaskRequest.Builder avoiding the need to create one manually via CreateExportTaskRequest.builder()

      Parameters:
      createExportTaskRequest - A Consumer that will call methods on CreateExportTaskRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createLogAnomalyDetector

      default CompletableFuture<CreateLogAnomalyDetectorResponse> createLogAnomalyDetector(CreateLogAnomalyDetectorRequest createLogAnomalyDetectorRequest)

      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.

      Parameters:
      createLogAnomalyDetectorRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createLogAnomalyDetector

      default CompletableFuture<CreateLogAnomalyDetectorResponse> createLogAnomalyDetector(Consumer<CreateLogAnomalyDetectorRequest.Builder> createLogAnomalyDetectorRequest)

      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 CreateLogAnomalyDetectorRequest.Builder avoiding the need to create one manually via CreateLogAnomalyDetectorRequest.builder()

      Parameters:
      createLogAnomalyDetectorRequest - A Consumer that will call methods on CreateLogAnomalyDetectorRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createLogGroup

      default CompletableFuture<CreateLogGroupResponse> createLogGroup(CreateLogGroupRequest createLogGroupRequest)

      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)

      • Log group names can't start with the string aws/

      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.

      Parameters:
      createLogGroupRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createLogGroup

      default CompletableFuture<CreateLogGroupResponse> createLogGroup(Consumer<CreateLogGroupRequest.Builder> createLogGroupRequest)

      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)

      • Log group names can't start with the string aws/

      When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.

      If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

      If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

      CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.


      This is a convenience which creates an instance of the CreateLogGroupRequest.Builder avoiding the need to create one manually via CreateLogGroupRequest.builder()

      Parameters:
      createLogGroupRequest - A Consumer that will call methods on CreateLogGroupRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createLogStream

      default CompletableFuture<CreateLogStreamResponse> createLogStream(CreateLogStreamRequest createLogStreamRequest)

      Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.

      There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.

      You must use the following guidelines when naming a log stream:

      • Log stream names must be unique within the log group.

      • Log stream names can be between 1 and 512 characters long.

      • Don't use ':' (colon) or '*' (asterisk) characters.

      Parameters:
      createLogStreamRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createLogStream

      default CompletableFuture<CreateLogStreamResponse> createLogStream(Consumer<CreateLogStreamRequest.Builder> createLogStreamRequest)

      Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.

      There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.

      You must use the following guidelines when naming a log stream:

      • Log stream names must be unique within the log group.

      • Log stream names can be between 1 and 512 characters long.

      • Don't use ':' (colon) or '*' (asterisk) characters.


      This is a convenience which creates an instance of the CreateLogStreamRequest.Builder avoiding the need to create one manually via CreateLogStreamRequest.builder()

      Parameters:
      createLogStreamRequest - A Consumer that will call methods on CreateLogStreamRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteAccountPolicy

      default CompletableFuture<DeleteAccountPolicyResponse> deleteAccountPolicy(DeleteAccountPolicyRequest deleteAccountPolicyRequest)

      Deletes a CloudWatch Logs account policy. This stops the policy from applying to all log groups or a subset of log groups in the account. Log-group level policies will still be in effect.

      To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are deleting.

      • To delete a data protection policy, you must have the logs:DeleteDataProtectionPolicy and logs:DeleteAccountPolicy permissions.

      • To delete a subscription filter policy, you must have the logs:DeleteSubscriptionFilter and logs:DeleteAccountPolicy permissions.

      Parameters:
      deleteAccountPolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteAccountPolicy

      default CompletableFuture<DeleteAccountPolicyResponse> deleteAccountPolicy(Consumer<DeleteAccountPolicyRequest.Builder> deleteAccountPolicyRequest)

      Deletes a CloudWatch Logs account policy. This stops the policy from applying to all log groups or a subset of log groups in the account. Log-group level policies will still be in effect.

      To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are deleting.

      • To delete a data protection policy, you must have the logs:DeleteDataProtectionPolicy and logs:DeleteAccountPolicy permissions.

      • To delete a subscription filter policy, you must have the logs:DeleteSubscriptionFilter and logs:DeleteAccountPolicy permissions.


      This is a convenience which creates an instance of the DeleteAccountPolicyRequest.Builder avoiding the need to create one manually via DeleteAccountPolicyRequest.builder()

      Parameters:
      deleteAccountPolicyRequest - A Consumer that will call methods on DeleteAccountPolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDataProtectionPolicy

      default CompletableFuture<DeleteDataProtectionPolicyResponse> deleteDataProtectionPolicy(DeleteDataProtectionPolicyRequest deleteDataProtectionPolicyRequest)

      Deletes the data protection policy from the specified log group.

      For more information about data protection policies, see PutDataProtectionPolicy.

      Parameters:
      deleteDataProtectionPolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDataProtectionPolicy

      default CompletableFuture<DeleteDataProtectionPolicyResponse> deleteDataProtectionPolicy(Consumer<DeleteDataProtectionPolicyRequest.Builder> deleteDataProtectionPolicyRequest)

      Deletes the data protection policy from the specified log group.

      For more information about data protection policies, see PutDataProtectionPolicy.


      This is a convenience which creates an instance of the DeleteDataProtectionPolicyRequest.Builder avoiding the need to create one manually via DeleteDataProtectionPolicyRequest.builder()

      Parameters:
      deleteDataProtectionPolicyRequest - A Consumer that will call methods on DeleteDataProtectionPolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDelivery

      default CompletableFuture<DeleteDeliveryResponse> deleteDelivery(DeleteDeliveryRequest deleteDeliveryRequest)

      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.

      Parameters:
      deleteDeliveryRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDelivery

      default CompletableFuture<DeleteDeliveryResponse> deleteDelivery(Consumer<DeleteDeliveryRequest.Builder> deleteDeliveryRequest)

      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 DeleteDeliveryRequest.Builder avoiding the need to create one manually via DeleteDeliveryRequest.builder()

      Parameters:
      deleteDeliveryRequest - A Consumer that will call methods on DeleteDeliveryRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDeliveryDestination

      default CompletableFuture<DeleteDeliveryDestinationResponse> deleteDeliveryDestination(DeleteDeliveryDestinationRequest deleteDeliveryDestinationRequest)

      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.

      Parameters:
      deleteDeliveryDestinationRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDeliveryDestination

      default CompletableFuture<DeleteDeliveryDestinationResponse> deleteDeliveryDestination(Consumer<DeleteDeliveryDestinationRequest.Builder> deleteDeliveryDestinationRequest)

      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 DeleteDeliveryDestinationRequest.Builder avoiding the need to create one manually via DeleteDeliveryDestinationRequest.builder()

      Parameters:
      deleteDeliveryDestinationRequest - A Consumer that will call methods on DeleteDeliveryDestinationRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDeliveryDestinationPolicy

      default CompletableFuture<DeleteDeliveryDestinationPolicyResponse> deleteDeliveryDestinationPolicy(DeleteDeliveryDestinationPolicyRequest deleteDeliveryDestinationPolicyRequest)

      Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.

      Parameters:
      deleteDeliveryDestinationPolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDeliveryDestinationPolicy

      default CompletableFuture<DeleteDeliveryDestinationPolicyResponse> deleteDeliveryDestinationPolicy(Consumer<DeleteDeliveryDestinationPolicyRequest.Builder> deleteDeliveryDestinationPolicyRequest)

      Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.


      This is a convenience which creates an instance of the DeleteDeliveryDestinationPolicyRequest.Builder avoiding the need to create one manually via DeleteDeliveryDestinationPolicyRequest.builder()

      Parameters:
      deleteDeliveryDestinationPolicyRequest - A Consumer that will call methods on DeleteDeliveryDestinationPolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDeliverySource

      default CompletableFuture<DeleteDeliverySourceResponse> deleteDeliverySource(DeleteDeliverySourceRequest deleteDeliverySourceRequest)

      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.

      Parameters:
      deleteDeliverySourceRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDeliverySource

      default CompletableFuture<DeleteDeliverySourceResponse> deleteDeliverySource(Consumer<DeleteDeliverySourceRequest.Builder> deleteDeliverySourceRequest)

      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 DeleteDeliverySourceRequest.Builder avoiding the need to create one manually via DeleteDeliverySourceRequest.builder()

      Parameters:
      deleteDeliverySourceRequest - A Consumer that will call methods on DeleteDeliverySourceRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDestination

      default CompletableFuture<DeleteDestinationResponse> deleteDestination(DeleteDestinationRequest deleteDestinationRequest)

      Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.

      Parameters:
      deleteDestinationRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDestination

      default CompletableFuture<DeleteDestinationResponse> deleteDestination(Consumer<DeleteDestinationRequest.Builder> deleteDestinationRequest)

      Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.


      This is a convenience which creates an instance of the DeleteDestinationRequest.Builder avoiding the need to create one manually via DeleteDestinationRequest.builder()

      Parameters:
      deleteDestinationRequest - A Consumer that will call methods on DeleteDestinationRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteLogAnomalyDetector

      default CompletableFuture<DeleteLogAnomalyDetectorResponse> deleteLogAnomalyDetector(DeleteLogAnomalyDetectorRequest deleteLogAnomalyDetectorRequest)

      Deletes the specified CloudWatch Logs anomaly detector.

      Parameters:
      deleteLogAnomalyDetectorRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteLogAnomalyDetector

      default CompletableFuture<DeleteLogAnomalyDetectorResponse> deleteLogAnomalyDetector(Consumer<DeleteLogAnomalyDetectorRequest.Builder> deleteLogAnomalyDetectorRequest)

      Deletes the specified CloudWatch Logs anomaly detector.


      This is a convenience which creates an instance of the DeleteLogAnomalyDetectorRequest.Builder avoiding the need to create one manually via DeleteLogAnomalyDetectorRequest.builder()

      Parameters:
      deleteLogAnomalyDetectorRequest - A Consumer that will call methods on DeleteLogAnomalyDetectorRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteLogGroup

      default CompletableFuture<DeleteLogGroupResponse> deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest)

      Deletes the specified log group and permanently deletes all the archived log events associated with the log group.

      Parameters:
      deleteLogGroupRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteLogGroup

      default CompletableFuture<DeleteLogGroupResponse> deleteLogGroup(Consumer<DeleteLogGroupRequest.Builder> deleteLogGroupRequest)

      Deletes the specified log group and permanently deletes all the archived log events associated with the log group.


      This is a convenience which creates an instance of the DeleteLogGroupRequest.Builder avoiding the need to create one manually via DeleteLogGroupRequest.builder()

      Parameters:
      deleteLogGroupRequest - A Consumer that will call methods on DeleteLogGroupRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteLogStream

      default CompletableFuture<DeleteLogStreamResponse> deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest)

      Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.

      Parameters:
      deleteLogStreamRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteLogStream

      default CompletableFuture<DeleteLogStreamResponse> deleteLogStream(Consumer<DeleteLogStreamRequest.Builder> deleteLogStreamRequest)

      Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.


      This is a convenience which creates an instance of the DeleteLogStreamRequest.Builder avoiding the need to create one manually via DeleteLogStreamRequest.builder()

      Parameters:
      deleteLogStreamRequest - A Consumer that will call methods on DeleteLogStreamRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteMetricFilter

      default CompletableFuture<DeleteMetricFilterResponse> deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest)

      Deletes the specified metric filter.

      Parameters:
      deleteMetricFilterRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteMetricFilter

      default CompletableFuture<DeleteMetricFilterResponse> deleteMetricFilter(Consumer<DeleteMetricFilterRequest.Builder> deleteMetricFilterRequest)

      Deletes the specified metric filter.


      This is a convenience which creates an instance of the DeleteMetricFilterRequest.Builder avoiding the need to create one manually via DeleteMetricFilterRequest.builder()

      Parameters:
      deleteMetricFilterRequest - A Consumer that will call methods on DeleteMetricFilterRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteQueryDefinition

      default CompletableFuture<DeleteQueryDefinitionResponse> deleteQueryDefinition(DeleteQueryDefinitionRequest deleteQueryDefinitionRequest)

      Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.

      Each DeleteQueryDefinition operation can delete one query definition.

      You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.

      Parameters:
      deleteQueryDefinitionRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteQueryDefinition

      default CompletableFuture<DeleteQueryDefinitionResponse> deleteQueryDefinition(Consumer<DeleteQueryDefinitionRequest.Builder> deleteQueryDefinitionRequest)

      Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.

      Each DeleteQueryDefinition operation can delete one query definition.

      You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.


      This is a convenience which creates an instance of the DeleteQueryDefinitionRequest.Builder avoiding the need to create one manually via DeleteQueryDefinitionRequest.builder()

      Parameters:
      deleteQueryDefinitionRequest - A Consumer that will call methods on DeleteQueryDefinitionRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteResourcePolicy

      default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)

      Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.

      Parameters:
      deleteResourcePolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteResourcePolicy

      default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)

      Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.


      This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the need to create one manually via DeleteResourcePolicyRequest.builder()

      Parameters:
      deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteRetentionPolicy

      default CompletableFuture<DeleteRetentionPolicyResponse> deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)

      Deletes the specified retention policy.

      Log events do not expire if they belong to log groups without a retention policy.

      Parameters:
      deleteRetentionPolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteRetentionPolicy

      default CompletableFuture<DeleteRetentionPolicyResponse> deleteRetentionPolicy(Consumer<DeleteRetentionPolicyRequest.Builder> deleteRetentionPolicyRequest)

      Deletes the specified retention policy.

      Log events do not expire if they belong to log groups without a retention policy.


      This is a convenience which creates an instance of the DeleteRetentionPolicyRequest.Builder avoiding the need to create one manually via DeleteRetentionPolicyRequest.builder()

      Parameters:
      deleteRetentionPolicyRequest - A Consumer that will call methods on DeleteRetentionPolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteSubscriptionFilter

      default CompletableFuture<DeleteSubscriptionFilterResponse> deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest)

      Deletes the specified subscription filter.

      Parameters:
      deleteSubscriptionFilterRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteSubscriptionFilter

      default CompletableFuture<DeleteSubscriptionFilterResponse> deleteSubscriptionFilter(Consumer<DeleteSubscriptionFilterRequest.Builder> deleteSubscriptionFilterRequest)

      Deletes the specified subscription filter.


      This is a convenience which creates an instance of the DeleteSubscriptionFilterRequest.Builder avoiding the need to create one manually via DeleteSubscriptionFilterRequest.builder()

      Parameters:
      deleteSubscriptionFilterRequest - A Consumer that will call methods on DeleteSubscriptionFilterRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeAccountPolicies

      default CompletableFuture<DescribeAccountPoliciesResponse> describeAccountPolicies(DescribeAccountPoliciesRequest describeAccountPoliciesRequest)

      Returns a list of all CloudWatch Logs account policies in the account.

      Parameters:
      describeAccountPoliciesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeAccountPolicies

      default CompletableFuture<DescribeAccountPoliciesResponse> describeAccountPolicies(Consumer<DescribeAccountPoliciesRequest.Builder> describeAccountPoliciesRequest)

      Returns a list of all CloudWatch Logs account policies in the account.


      This is a convenience which creates an instance of the DescribeAccountPoliciesRequest.Builder avoiding the need to create one manually via DescribeAccountPoliciesRequest.builder()

      Parameters:
      describeAccountPoliciesRequest - A Consumer that will call methods on DescribeAccountPoliciesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDeliveries

      default CompletableFuture<DescribeDeliveriesResponse> describeDeliveries(DescribeDeliveriesRequest describeDeliveriesRequest)

      Retrieves a list of the deliveries that have been created in the account.

      A delivery is a connection between a delivery source and a delivery destination .

      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 Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.

      Parameters:
      describeDeliveriesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDeliveries

      default CompletableFuture<DescribeDeliveriesResponse> describeDeliveries(Consumer<DescribeDeliveriesRequest.Builder> describeDeliveriesRequest)

      Retrieves a list of the deliveries that have been created in the account.

      A delivery is a connection between a delivery source and a delivery destination .

      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 Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.


      This is a convenience which creates an instance of the DescribeDeliveriesRequest.Builder avoiding the need to create one manually via DescribeDeliveriesRequest.builder()

      Parameters:
      describeDeliveriesRequest - A Consumer that will call methods on DescribeDeliveriesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDeliveriesPaginator

      default DescribeDeliveriesPublisher describeDeliveriesPaginator(DescribeDeliveriesRequest describeDeliveriesRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesPublisher publisher = client.describeDeliveriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesPublisher publisher = client.describeDeliveriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesResponse>() {
 
 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 describeDeliveries(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest) operation.

      Parameters:
      describeDeliveriesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDeliveriesPaginator

      default DescribeDeliveriesPublisher describeDeliveriesPaginator(Consumer<DescribeDeliveriesRequest.Builder> describeDeliveriesRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesPublisher publisher = client.describeDeliveriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveriesPublisher publisher = client.describeDeliveriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesResponse>() {
 
 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 describeDeliveries(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveriesRequest) operation.


      This is a convenience which creates an instance of the DescribeDeliveriesRequest.Builder avoiding the need to create one manually via DescribeDeliveriesRequest.builder()

      Parameters:
      describeDeliveriesRequest - A Consumer that will call methods on DescribeDeliveriesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDeliveryDestinations

      default CompletableFuture<DescribeDeliveryDestinationsResponse> describeDeliveryDestinations(DescribeDeliveryDestinationsRequest describeDeliveryDestinationsRequest)

      Retrieves a list of the delivery destinations that have been created in the account.

      Parameters:
      describeDeliveryDestinationsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDeliveryDestinations

      default CompletableFuture<DescribeDeliveryDestinationsResponse> describeDeliveryDestinations(Consumer<DescribeDeliveryDestinationsRequest.Builder> describeDeliveryDestinationsRequest)

      Retrieves a list of the delivery destinations that have been created in the account.


      This is a convenience which creates an instance of the DescribeDeliveryDestinationsRequest.Builder avoiding the need to create one manually via DescribeDeliveryDestinationsRequest.builder()

      Parameters:
      describeDeliveryDestinationsRequest - A Consumer that will call methods on DescribeDeliveryDestinationsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDeliveryDestinationsPaginator

      default DescribeDeliveryDestinationsPublisher describeDeliveryDestinationsPaginator(DescribeDeliveryDestinationsRequest describeDeliveryDestinationsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsPublisher publisher = client.describeDeliveryDestinationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsPublisher publisher = client.describeDeliveryDestinationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsResponse>() {
 
 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 describeDeliveryDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest) operation.

      Parameters:
      describeDeliveryDestinationsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDeliveryDestinationsPaginator

      default DescribeDeliveryDestinationsPublisher describeDeliveryDestinationsPaginator(Consumer<DescribeDeliveryDestinationsRequest.Builder> describeDeliveryDestinationsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsPublisher publisher = client.describeDeliveryDestinationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliveryDestinationsPublisher publisher = client.describeDeliveryDestinationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsResponse>() {
 
 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 describeDeliveryDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliveryDestinationsRequest) operation.


      This is a convenience which creates an instance of the DescribeDeliveryDestinationsRequest.Builder avoiding the need to create one manually via DescribeDeliveryDestinationsRequest.builder()

      Parameters:
      describeDeliveryDestinationsRequest - A Consumer that will call methods on DescribeDeliveryDestinationsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDeliverySources

      default CompletableFuture<DescribeDeliverySourcesResponse> describeDeliverySources(DescribeDeliverySourcesRequest describeDeliverySourcesRequest)

      Retrieves a list of the delivery sources that have been created in the account.

      Parameters:
      describeDeliverySourcesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDeliverySources

      default CompletableFuture<DescribeDeliverySourcesResponse> describeDeliverySources(Consumer<DescribeDeliverySourcesRequest.Builder> describeDeliverySourcesRequest)

      Retrieves a list of the delivery sources that have been created in the account.


      This is a convenience which creates an instance of the DescribeDeliverySourcesRequest.Builder avoiding the need to create one manually via DescribeDeliverySourcesRequest.builder()

      Parameters:
      describeDeliverySourcesRequest - A Consumer that will call methods on DescribeDeliverySourcesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDeliverySourcesPaginator

      default DescribeDeliverySourcesPublisher describeDeliverySourcesPaginator(DescribeDeliverySourcesRequest describeDeliverySourcesRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesPublisher publisher = client.describeDeliverySourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesPublisher publisher = client.describeDeliverySourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesResponse>() {
 
 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 describeDeliverySources(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest) operation.

      Parameters:
      describeDeliverySourcesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDeliverySourcesPaginator

      default DescribeDeliverySourcesPublisher describeDeliverySourcesPaginator(Consumer<DescribeDeliverySourcesRequest.Builder> describeDeliverySourcesRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesPublisher publisher = client.describeDeliverySourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDeliverySourcesPublisher publisher = client.describeDeliverySourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesResponse>() {
 
 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 describeDeliverySources(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDeliverySourcesRequest) operation.


      This is a convenience which creates an instance of the DescribeDeliverySourcesRequest.Builder avoiding the need to create one manually via DescribeDeliverySourcesRequest.builder()

      Parameters:
      describeDeliverySourcesRequest - A Consumer that will call methods on DescribeDeliverySourcesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDestinations

      default CompletableFuture<DescribeDestinationsResponse> describeDestinations(DescribeDestinationsRequest describeDestinationsRequest)

      Lists all your destinations. The results are ASCII-sorted by destination name.

      Parameters:
      describeDestinationsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDestinations

      default CompletableFuture<DescribeDestinationsResponse> describeDestinations(Consumer<DescribeDestinationsRequest.Builder> describeDestinationsRequest)

      Lists all your destinations. The results are ASCII-sorted by destination name.


      This is a convenience which creates an instance of the DescribeDestinationsRequest.Builder avoiding the need to create one manually via DescribeDestinationsRequest.builder()

      Parameters:
      describeDestinationsRequest - A Consumer that will call methods on DescribeDestinationsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDestinations

      default CompletableFuture<DescribeDestinationsResponse> describeDestinations()

      Lists all your destinations. The results are ASCII-sorted by destination name.

      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDestinationsPaginator

      default DescribeDestinationsPublisher describeDestinationsPaginator()

      This is a variant of describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest) operation.

      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDestinationsPaginator

      default DescribeDestinationsPublisher describeDestinationsPaginator(DescribeDestinationsRequest describeDestinationsRequest)

      This is a variant of describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest) operation.

      Parameters:
      describeDestinationsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDestinationsPaginator

      default DescribeDestinationsPublisher describeDestinationsPaginator(Consumer<DescribeDestinationsRequest.Builder> describeDestinationsRequest)

      This is a variant of describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest) operation.


      This is a convenience which creates an instance of the DescribeDestinationsRequest.Builder avoiding the need to create one manually via DescribeDestinationsRequest.builder()

      Parameters:
      describeDestinationsRequest - A Consumer that will call methods on DescribeDestinationsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeExportTasks

      default CompletableFuture<DescribeExportTasksResponse> describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)

      Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

      Parameters:
      describeExportTasksRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeExportTasks

      default CompletableFuture<DescribeExportTasksResponse> describeExportTasks(Consumer<DescribeExportTasksRequest.Builder> describeExportTasksRequest)

      Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.


      This is a convenience which creates an instance of the DescribeExportTasksRequest.Builder avoiding the need to create one manually via DescribeExportTasksRequest.builder()

      Parameters:
      describeExportTasksRequest - A Consumer that will call methods on DescribeExportTasksRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeExportTasks

      default CompletableFuture<DescribeExportTasksResponse> describeExportTasks()

      Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeLogGroups

      default CompletableFuture<DescribeLogGroupsResponse> describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest)

      Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

      CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

      Parameters:
      describeLogGroupsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeLogGroups

      default CompletableFuture<DescribeLogGroupsResponse> describeLogGroups(Consumer<DescribeLogGroupsRequest.Builder> describeLogGroupsRequest)

      Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

      CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.


      This is a convenience which creates an instance of the DescribeLogGroupsRequest.Builder avoiding the need to create one manually via DescribeLogGroupsRequest.builder()

      Parameters:
      describeLogGroupsRequest - A Consumer that will call methods on DescribeLogGroupsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeLogGroups

      default CompletableFuture<DescribeLogGroupsResponse> describeLogGroups()

      Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

      CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeLogGroupsPaginator

      default DescribeLogGroupsPublisher describeLogGroupsPaginator()

      This is a variant of describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest) operation.

      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeLogGroupsPaginator

      default DescribeLogGroupsPublisher describeLogGroupsPaginator(DescribeLogGroupsRequest describeLogGroupsRequest)

      This is a variant of describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest) operation.

      Parameters:
      describeLogGroupsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeLogGroupsPaginator

      default DescribeLogGroupsPublisher describeLogGroupsPaginator(Consumer<DescribeLogGroupsRequest.Builder> describeLogGroupsRequest)

      This is a variant of describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest) operation.


      This is a convenience which creates an instance of the DescribeLogGroupsRequest.Builder avoiding the need to create one manually via DescribeLogGroupsRequest.builder()

      Parameters:
      describeLogGroupsRequest - A Consumer that will call methods on DescribeLogGroupsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeLogStreams

      default CompletableFuture<DescribeLogStreamsResponse> describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest)

      Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

      You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

      This operation has a limit of five transactions per second, after which transactions are throttled.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

      Parameters:
      describeLogStreamsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeLogStreams

      default CompletableFuture<DescribeLogStreamsResponse> describeLogStreams(Consumer<DescribeLogStreamsRequest.Builder> describeLogStreamsRequest)

      Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

      You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

      This operation has a limit of five transactions per second, after which transactions are throttled.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.


      This is a convenience which creates an instance of the DescribeLogStreamsRequest.Builder avoiding the need to create one manually via DescribeLogStreamsRequest.builder()

      Parameters:
      describeLogStreamsRequest - A Consumer that will call methods on DescribeLogStreamsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeLogStreamsPaginator

      default DescribeLogStreamsPublisher describeLogStreamsPaginator(DescribeLogStreamsRequest describeLogStreamsRequest)

      This is a variant of describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest) operation.

      Parameters:
      describeLogStreamsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeLogStreamsPaginator

      default DescribeLogStreamsPublisher describeLogStreamsPaginator(Consumer<DescribeLogStreamsRequest.Builder> describeLogStreamsRequest)

      This is a variant of describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest) operation.


      This is a convenience which creates an instance of the DescribeLogStreamsRequest.Builder avoiding the need to create one manually via DescribeLogStreamsRequest.builder()

      Parameters:
      describeLogStreamsRequest - A Consumer that will call methods on DescribeLogStreamsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeMetricFilters

      default CompletableFuture<DescribeMetricFiltersResponse> describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest)

      Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

      Parameters:
      describeMetricFiltersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeMetricFilters

      default CompletableFuture<DescribeMetricFiltersResponse> describeMetricFilters(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest)

      Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.


      This is a convenience which creates an instance of the DescribeMetricFiltersRequest.Builder avoiding the need to create one manually via DescribeMetricFiltersRequest.builder()

      Parameters:
      describeMetricFiltersRequest - A Consumer that will call methods on DescribeMetricFiltersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeMetricFilters

      default CompletableFuture<DescribeMetricFiltersResponse> describeMetricFilters()

      Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeMetricFiltersPaginator

      default DescribeMetricFiltersPublisher describeMetricFiltersPaginator()

      This is a variant of describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest) operation.

      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeMetricFiltersPaginator

      default DescribeMetricFiltersPublisher describeMetricFiltersPaginator(DescribeMetricFiltersRequest describeMetricFiltersRequest)

      This is a variant of describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest) operation.

      Parameters:
      describeMetricFiltersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeMetricFiltersPaginator

      default DescribeMetricFiltersPublisher describeMetricFiltersPaginator(Consumer<DescribeMetricFiltersRequest.Builder> describeMetricFiltersRequest)

      This is a variant of describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest) operation.


      This is a convenience which creates an instance of the DescribeMetricFiltersRequest.Builder avoiding the need to create one manually via DescribeMetricFiltersRequest.builder()

      Parameters:
      describeMetricFiltersRequest - A Consumer that will call methods on DescribeMetricFiltersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeQueries

      default CompletableFuture<DescribeQueriesResponse> describeQueries(DescribeQueriesRequest describeQueriesRequest)

      Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.

      Parameters:
      describeQueriesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeQueries

      default CompletableFuture<DescribeQueriesResponse> describeQueries(Consumer<DescribeQueriesRequest.Builder> describeQueriesRequest)

      Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.


      This is a convenience which creates an instance of the DescribeQueriesRequest.Builder avoiding the need to create one manually via DescribeQueriesRequest.builder()

      Parameters:
      describeQueriesRequest - A Consumer that will call methods on DescribeQueriesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeQueries

      default CompletableFuture<DescribeQueriesResponse> describeQueries()

      Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.

      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeQueryDefinitions

      default CompletableFuture<DescribeQueryDefinitionsResponse> describeQueryDefinitions(DescribeQueryDefinitionsRequest describeQueryDefinitionsRequest)

      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.

      Parameters:
      describeQueryDefinitionsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeQueryDefinitions

      default CompletableFuture<DescribeQueryDefinitionsResponse> describeQueryDefinitions(Consumer<DescribeQueryDefinitionsRequest.Builder> describeQueryDefinitionsRequest)

      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 DescribeQueryDefinitionsRequest.Builder avoiding the need to create one manually via DescribeQueryDefinitionsRequest.builder()

      Parameters:
      describeQueryDefinitionsRequest - A Consumer that will call methods on DescribeQueryDefinitionsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeResourcePolicies

      default CompletableFuture<DescribeResourcePoliciesResponse> describeResourcePolicies(DescribeResourcePoliciesRequest describeResourcePoliciesRequest)

      Lists the resource policies in this account.

      Parameters:
      describeResourcePoliciesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeResourcePolicies

      default CompletableFuture<DescribeResourcePoliciesResponse> describeResourcePolicies(Consumer<DescribeResourcePoliciesRequest.Builder> describeResourcePoliciesRequest)

      Lists the resource policies in this account.


      This is a convenience which creates an instance of the DescribeResourcePoliciesRequest.Builder avoiding the need to create one manually via DescribeResourcePoliciesRequest.builder()

      Parameters:
      describeResourcePoliciesRequest - A Consumer that will call methods on DescribeResourcePoliciesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeResourcePolicies

      default CompletableFuture<DescribeResourcePoliciesResponse> describeResourcePolicies()

      Lists the resource policies in this account.

      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSubscriptionFilters

      default CompletableFuture<DescribeSubscriptionFiltersResponse> describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)

      Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.

      Parameters:
      describeSubscriptionFiltersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSubscriptionFilters

      default CompletableFuture<DescribeSubscriptionFiltersResponse> describeSubscriptionFilters(Consumer<DescribeSubscriptionFiltersRequest.Builder> describeSubscriptionFiltersRequest)

      Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.


      This is a convenience which creates an instance of the DescribeSubscriptionFiltersRequest.Builder avoiding the need to create one manually via DescribeSubscriptionFiltersRequest.builder()

      Parameters:
      describeSubscriptionFiltersRequest - A Consumer that will call methods on DescribeSubscriptionFiltersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSubscriptionFiltersPaginator

      default DescribeSubscriptionFiltersPublisher describeSubscriptionFiltersPaginator(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)

      This is a variant of describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest) operation.

      Parameters:
      describeSubscriptionFiltersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSubscriptionFiltersPaginator

      default DescribeSubscriptionFiltersPublisher describeSubscriptionFiltersPaginator(Consumer<DescribeSubscriptionFiltersRequest.Builder> describeSubscriptionFiltersRequest)

      This is a variant of describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest) operation.


      This is a convenience which creates an instance of the DescribeSubscriptionFiltersRequest.Builder avoiding the need to create one manually via DescribeSubscriptionFiltersRequest.builder()

      Parameters:
      describeSubscriptionFiltersRequest - A Consumer that will call methods on DescribeSubscriptionFiltersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • disassociateKmsKey

      default CompletableFuture<DisassociateKmsKeyResponse> disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest)

      Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.

      When you use DisassociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.

      • Specify the logGroupName parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log events that were ingested while the key was associated with the log group are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.

      • Specify the resourceIdentifier parameter with the query-result resource to stop using the KMS key to encrypt the results of all future StartQuery operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with the account are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.

      It can take up to 5 minutes for this operation to take effect.

      Parameters:
      disassociateKmsKeyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • disassociateKmsKey

      default CompletableFuture<DisassociateKmsKeyResponse> disassociateKmsKey(Consumer<DisassociateKmsKeyRequest.Builder> disassociateKmsKeyRequest)

      Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.

      When you use DisassociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.

      • Specify the logGroupName parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log events that were ingested while the key was associated with the log group are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.

      • Specify the resourceIdentifier parameter with the query-result resource to stop using the KMS key to encrypt the results of all future StartQuery operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with the account are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.

      It can take up to 5 minutes for this operation to take effect.


      This is a convenience which creates an instance of the DisassociateKmsKeyRequest.Builder avoiding the need to create one manually via DisassociateKmsKeyRequest.builder()

      Parameters:
      disassociateKmsKeyRequest - A Consumer that will call methods on DisassociateKmsKeyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • filterLogEvents

      default CompletableFuture<FilterLogEventsResponse> filterLogEvents(FilterLogEventsRequest filterLogEventsRequest)

      Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

      You must have the logs:FilterLogEvents permission to perform this operation.

      You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

      By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.

      The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

      Parameters:
      filterLogEventsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • filterLogEvents

      default CompletableFuture<FilterLogEventsResponse> filterLogEvents(Consumer<FilterLogEventsRequest.Builder> filterLogEventsRequest)

      Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

      You must have the logs:FilterLogEvents permission to perform this operation.

      You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

      By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.

      The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.


      This is a convenience which creates an instance of the FilterLogEventsRequest.Builder avoiding the need to create one manually via FilterLogEventsRequest.builder()

      Parameters:
      filterLogEventsRequest - A Consumer that will call methods on FilterLogEventsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • filterLogEventsPaginator

      default FilterLogEventsPublisher filterLogEventsPaginator(FilterLogEventsRequest filterLogEventsRequest)

      This is a variant of filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest) operation.

      Parameters:
      filterLogEventsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • filterLogEventsPaginator

      default FilterLogEventsPublisher filterLogEventsPaginator(Consumer<FilterLogEventsRequest.Builder> filterLogEventsRequest)

      This is a variant of filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest) operation.


      This is a convenience which creates an instance of the FilterLogEventsRequest.Builder avoiding the need to create one manually via FilterLogEventsRequest.builder()

      Parameters:
      filterLogEventsRequest - A Consumer that will call methods on FilterLogEventsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDataProtectionPolicy

      default CompletableFuture<GetDataProtectionPolicyResponse> getDataProtectionPolicy(GetDataProtectionPolicyRequest getDataProtectionPolicyRequest)

      Returns information about a log group data protection policy.

      Parameters:
      getDataProtectionPolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDataProtectionPolicy

      default CompletableFuture<GetDataProtectionPolicyResponse> getDataProtectionPolicy(Consumer<GetDataProtectionPolicyRequest.Builder> getDataProtectionPolicyRequest)

      Returns information about a log group data protection policy.


      This is a convenience which creates an instance of the GetDataProtectionPolicyRequest.Builder avoiding the need to create one manually via GetDataProtectionPolicyRequest.builder()

      Parameters:
      getDataProtectionPolicyRequest - A Consumer that will call methods on GetDataProtectionPolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDelivery

      default CompletableFuture<GetDeliveryResponse> getDelivery(GetDeliveryRequest getDeliveryRequest)

      Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination .

      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 Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.

      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.

      Parameters:
      getDeliveryRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDelivery

      default CompletableFuture<GetDeliveryResponse> getDelivery(Consumer<GetDeliveryRequest.Builder> getDeliveryRequest)

      Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination .

      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 Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.

      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 GetDeliveryRequest.Builder avoiding the need to create one manually via GetDeliveryRequest.builder()

      Parameters:
      getDeliveryRequest - A Consumer that will call methods on GetDeliveryRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDeliveryDestination

      default CompletableFuture<GetDeliveryDestinationResponse> getDeliveryDestination(GetDeliveryDestinationRequest getDeliveryDestinationRequest)

      Retrieves complete information about one delivery destination.

      Parameters:
      getDeliveryDestinationRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDeliveryDestination

      default CompletableFuture<GetDeliveryDestinationResponse> getDeliveryDestination(Consumer<GetDeliveryDestinationRequest.Builder> getDeliveryDestinationRequest)

      Retrieves complete information about one delivery destination.


      This is a convenience which creates an instance of the GetDeliveryDestinationRequest.Builder avoiding the need to create one manually via GetDeliveryDestinationRequest.builder()

      Parameters:
      getDeliveryDestinationRequest - A Consumer that will call methods on GetDeliveryDestinationRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDeliveryDestinationPolicy

      default CompletableFuture<GetDeliveryDestinationPolicyResponse> getDeliveryDestinationPolicy(GetDeliveryDestinationPolicyRequest getDeliveryDestinationPolicyRequest)

      Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.

      Parameters:
      getDeliveryDestinationPolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDeliveryDestinationPolicy

      default CompletableFuture<GetDeliveryDestinationPolicyResponse> getDeliveryDestinationPolicy(Consumer<GetDeliveryDestinationPolicyRequest.Builder> getDeliveryDestinationPolicyRequest)

      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 GetDeliveryDestinationPolicyRequest.Builder avoiding the need to create one manually via GetDeliveryDestinationPolicyRequest.builder()

      Parameters:
      getDeliveryDestinationPolicyRequest - A Consumer that will call methods on GetDeliveryDestinationPolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDeliverySource

      default CompletableFuture<GetDeliverySourceResponse> getDeliverySource(GetDeliverySourceRequest getDeliverySourceRequest)

      Retrieves complete information about one delivery source.

      Parameters:
      getDeliverySourceRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDeliverySource

      default CompletableFuture<GetDeliverySourceResponse> getDeliverySource(Consumer<GetDeliverySourceRequest.Builder> getDeliverySourceRequest)

      Retrieves complete information about one delivery source.


      This is a convenience which creates an instance of the GetDeliverySourceRequest.Builder avoiding the need to create one manually via GetDeliverySourceRequest.builder()

      Parameters:
      getDeliverySourceRequest - A Consumer that will call methods on GetDeliverySourceRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLogAnomalyDetector

      default CompletableFuture<GetLogAnomalyDetectorResponse> getLogAnomalyDetector(GetLogAnomalyDetectorRequest getLogAnomalyDetectorRequest)

      Retrieves information about the log anomaly detector that you specify.

      Parameters:
      getLogAnomalyDetectorRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLogAnomalyDetector

      default CompletableFuture<GetLogAnomalyDetectorResponse> getLogAnomalyDetector(Consumer<GetLogAnomalyDetectorRequest.Builder> getLogAnomalyDetectorRequest)

      Retrieves information about the log anomaly detector that you specify.


      This is a convenience which creates an instance of the GetLogAnomalyDetectorRequest.Builder avoiding the need to create one manually via GetLogAnomalyDetectorRequest.builder()

      Parameters:
      getLogAnomalyDetectorRequest - A Consumer that will call methods on GetLogAnomalyDetectorRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLogEvents

      default CompletableFuture<GetLogEventsResponse> getLogEvents(GetLogEventsRequest getLogEventsRequest)

      Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

      By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

      You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

      Parameters:
      getLogEventsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLogEvents

      default CompletableFuture<GetLogEventsResponse> getLogEvents(Consumer<GetLogEventsRequest.Builder> getLogEventsRequest)

      Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

      By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

      You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.


      This is a convenience which creates an instance of the GetLogEventsRequest.Builder avoiding the need to create one manually via GetLogEventsRequest.builder()

      Parameters:
      getLogEventsRequest - A Consumer that will call methods on GetLogEventsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLogEventsPaginator

      default GetLogEventsPublisher getLogEventsPaginator(GetLogEventsRequest getLogEventsRequest)

      This is a variant of getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest) operation.

      Parameters:
      getLogEventsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLogEventsPaginator

      default GetLogEventsPublisher getLogEventsPaginator(Consumer<GetLogEventsRequest.Builder> getLogEventsRequest)

      This is a variant of getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest) operation.


      This is a convenience which creates an instance of the GetLogEventsRequest.Builder avoiding the need to create one manually via GetLogEventsRequest.builder()

      Parameters:
      getLogEventsRequest - A Consumer that will call methods on GetLogEventsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLogGroupFields

      default CompletableFuture<GetLogGroupFieldsResponse> getLogGroupFields(GetLogGroupFieldsRequest getLogGroupFieldsRequest)

      Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.

      You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must specify one of these parameters, but you can't specify both.

      In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.

      The response results are sorted by the frequency percentage, starting with the highest percentage.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

      Parameters:
      getLogGroupFieldsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLogGroupFields

      default CompletableFuture<GetLogGroupFieldsResponse> getLogGroupFields(Consumer<GetLogGroupFieldsRequest.Builder> getLogGroupFieldsRequest)

      Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.

      You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must specify one of these parameters, but you can't specify both.

      In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.

      The response results are sorted by the frequency percentage, starting with the highest percentage.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.


      This is a convenience which creates an instance of the GetLogGroupFieldsRequest.Builder avoiding the need to create one manually via GetLogGroupFieldsRequest.builder()

      Parameters:
      getLogGroupFieldsRequest - A Consumer that will call methods on GetLogGroupFieldsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLogRecord

      default CompletableFuture<GetLogRecordResponse> getLogRecord(GetLogRecordRequest getLogRecordRequest)

      Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.

      The full unparsed log event is returned within @message.

      Parameters:
      getLogRecordRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLogRecord

      default CompletableFuture<GetLogRecordResponse> getLogRecord(Consumer<GetLogRecordRequest.Builder> getLogRecordRequest)

      Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.

      The full unparsed log event is returned within @message.


      This is a convenience which creates an instance of the GetLogRecordRequest.Builder avoiding the need to create one manually via GetLogRecordRequest.builder()

      Parameters:
      getLogRecordRequest - A Consumer that will call methods on GetLogRecordRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getQueryResults

      default CompletableFuture<GetQueryResultsResponse> getQueryResults(GetQueryResultsRequest getQueryResultsRequest)

      Returns the results from the specified query.

      Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.

      GetQueryResults does not start running a query. To run a query, use StartQuery. 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.

      Parameters:
      getQueryResultsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getQueryResults

      default CompletableFuture<GetQueryResultsResponse> getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)

      Returns the results from the specified query.

      Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.

      GetQueryResults does not start running a query. To run a query, use StartQuery. 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 GetQueryResultsRequest.Builder avoiding the need to create one manually via GetQueryResultsRequest.builder()

      Parameters:
      getQueryResultsRequest - A Consumer that will call methods on GetQueryResultsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAnomalies

      default CompletableFuture<ListAnomaliesResponse> listAnomalies(ListAnomaliesRequest 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.

      Parameters:
      listAnomaliesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAnomalies

      default CompletableFuture<ListAnomaliesResponse> listAnomalies(Consumer<ListAnomaliesRequest.Builder> 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 convenience which creates an instance of the ListAnomaliesRequest.Builder avoiding the need to create one manually via ListAnomaliesRequest.builder()

      Parameters:
      listAnomaliesRequest - A Consumer that will call methods on ListAnomaliesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAnomaliesPaginator

      default ListAnomaliesPublisher listAnomaliesPaginator(ListAnomaliesRequest listAnomaliesRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesPublisher publisher = client.listAnomaliesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesPublisher publisher = client.listAnomaliesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesResponse>() {
 
 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 listAnomalies(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest) operation.

      Parameters:
      listAnomaliesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAnomaliesPaginator

      default ListAnomaliesPublisher listAnomaliesPaginator(Consumer<ListAnomaliesRequest.Builder> listAnomaliesRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesPublisher publisher = client.listAnomaliesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.ListAnomaliesPublisher publisher = client.listAnomaliesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesResponse>() {
 
 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 listAnomalies(software.amazon.awssdk.services.cloudwatchlogs.model.ListAnomaliesRequest) operation.


      This is a convenience which creates an instance of the ListAnomaliesRequest.Builder avoiding the need to create one manually via ListAnomaliesRequest.builder()

      Parameters:
      listAnomaliesRequest - A Consumer that will call methods on ListAnomaliesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listLogAnomalyDetectors

      default CompletableFuture<ListLogAnomalyDetectorsResponse> listLogAnomalyDetectors(ListLogAnomalyDetectorsRequest listLogAnomalyDetectorsRequest)

      Retrieves a list of the log anomaly detectors in the account.

      Parameters:
      listLogAnomalyDetectorsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listLogAnomalyDetectors

      default CompletableFuture<ListLogAnomalyDetectorsResponse> listLogAnomalyDetectors(Consumer<ListLogAnomalyDetectorsRequest.Builder> listLogAnomalyDetectorsRequest)

      Retrieves a list of the log anomaly detectors in the account.


      This is a convenience which creates an instance of the ListLogAnomalyDetectorsRequest.Builder avoiding the need to create one manually via ListLogAnomalyDetectorsRequest.builder()

      Parameters:
      listLogAnomalyDetectorsRequest - A Consumer that will call methods on ListLogAnomalyDetectorsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listLogAnomalyDetectorsPaginator

      default ListLogAnomalyDetectorsPublisher listLogAnomalyDetectorsPaginator(ListLogAnomalyDetectorsRequest listLogAnomalyDetectorsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsPublisher publisher = client.listLogAnomalyDetectorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsPublisher publisher = client.listLogAnomalyDetectorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsResponse>() {
 
 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 listLogAnomalyDetectors(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest) operation.

      Parameters:
      listLogAnomalyDetectorsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listLogAnomalyDetectorsPaginator

      default ListLogAnomalyDetectorsPublisher listLogAnomalyDetectorsPaginator(Consumer<ListLogAnomalyDetectorsRequest.Builder> listLogAnomalyDetectorsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsPublisher publisher = client.listLogAnomalyDetectorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.cloudwatchlogs.paginators.ListLogAnomalyDetectorsPublisher publisher = client.listLogAnomalyDetectorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsResponse>() {
 
 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 listLogAnomalyDetectors(software.amazon.awssdk.services.cloudwatchlogs.model.ListLogAnomalyDetectorsRequest) operation.


      This is a convenience which creates an instance of the ListLogAnomalyDetectorsRequest.Builder avoiding the need to create one manually via ListLogAnomalyDetectorsRequest.builder()

      Parameters:
      listLogAnomalyDetectorsRequest - A Consumer that will call methods on ListLogAnomalyDetectorsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsLogGroup

      @Deprecated default CompletableFuture<ListTagsLogGroupResponse> listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest)
      Deprecated.
      Please use the generic tagging API ListTagsForResource

      The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.

      Lists the tags for the specified log group.

      Parameters:
      listTagsLogGroupRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsLogGroup

      @Deprecated default CompletableFuture<ListTagsLogGroupResponse> listTagsLogGroup(Consumer<ListTagsLogGroupRequest.Builder> listTagsLogGroupRequest)
      Deprecated.
      Please use the generic tagging API ListTagsForResource

      The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.

      Lists the tags for the specified log group.


      This is a convenience which creates an instance of the ListTagsLogGroupRequest.Builder avoiding the need to create one manually via ListTagsLogGroupRequest.builder()

      Parameters:
      listTagsLogGroupRequest - A Consumer that will call methods on ListTagsLogGroupRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putAccountPolicy

      default CompletableFuture<PutAccountPolicyResponse> putAccountPolicy(PutAccountPolicyRequest putAccountPolicyRequest)

      Creates an account-level data protection policy or subscription filter policy that applies to all log groups or a subset of log groups in the account.

      Data protection policy

      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 data protection 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-level 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 for a data protection policy, 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 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.

      Subscription filter policy

      A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. 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 Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.

      • An Firehose data stream in the same account as the subscription policy, for same-account delivery.

      • A Lambda function in the same account as the subscription policy, for same-account delivery.

      • A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.

      Each account can have one account-level subscription filter policy. If you are updating an existing filter, you must specify the correct name in PolicyName. To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.

      Parameters:
      putAccountPolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putAccountPolicy

      default CompletableFuture<PutAccountPolicyResponse> putAccountPolicy(Consumer<PutAccountPolicyRequest.Builder> putAccountPolicyRequest)

      Creates an account-level data protection policy or subscription filter policy that applies to all log groups or a subset of log groups in the account.

      Data protection policy

      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 data protection 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-level 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 for a data protection policy, 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 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.

      Subscription filter policy

      A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. 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 Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.

      • An Firehose data stream in the same account as the subscription policy, for same-account delivery.

      • A Lambda function in the same account as the subscription policy, for same-account delivery.

      • A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.

      Each account can have one account-level subscription filter policy. If you are updating an existing filter, you must specify the correct name in PolicyName. To perform a PutAccountPolicy subscription filter 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 PutAccountPolicyRequest.Builder avoiding the need to create one manually via PutAccountPolicyRequest.builder()

      Parameters:
      putAccountPolicyRequest - A Consumer that will call methods on PutAccountPolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putDataProtectionPolicy

      default CompletableFuture<PutDataProtectionPolicyResponse> putDataProtectionPolicy(PutDataProtectionPolicyRequest putDataProtectionPolicyRequest)

      Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.

      Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.

      By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

      For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.

      The PutDataProtectionPolicy operation applies to only the specified log group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

      Parameters:
      putDataProtectionPolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putDataProtectionPolicy

      default CompletableFuture<PutDataProtectionPolicyResponse> putDataProtectionPolicy(Consumer<PutDataProtectionPolicyRequest.Builder> putDataProtectionPolicyRequest)

      Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.

      Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.

      By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

      For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.

      The PutDataProtectionPolicy operation applies to only the specified log group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.


      This is a convenience which creates an instance of the PutDataProtectionPolicyRequest.Builder avoiding the need to create one manually via PutDataProtectionPolicyRequest.builder()

      Parameters:
      putDataProtectionPolicyRequest - A Consumer that will call methods on PutDataProtectionPolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putDeliveryDestination

      default CompletableFuture<PutDeliveryDestinationResponse> putDeliveryDestination(PutDeliveryDestinationRequest putDeliveryDestinationRequest)

      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 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.

      Parameters:
      putDeliveryDestinationRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putDeliveryDestination

      default CompletableFuture<PutDeliveryDestinationResponse> putDeliveryDestination(Consumer<PutDeliveryDestinationRequest.Builder> putDeliveryDestinationRequest)

      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 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 PutDeliveryDestinationRequest.Builder avoiding the need to create one manually via PutDeliveryDestinationRequest.builder()

      Parameters:
      putDeliveryDestinationRequest - A Consumer that will call methods on PutDeliveryDestinationRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putDeliveryDestinationPolicy

      default CompletableFuture<PutDeliveryDestinationPolicyResponse> putDeliveryDestinationPolicy(PutDeliveryDestinationPolicyRequest putDeliveryDestinationPolicyRequest)

      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.

      Parameters:
      putDeliveryDestinationPolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putDeliveryDestinationPolicy

      default CompletableFuture<PutDeliveryDestinationPolicyResponse> putDeliveryDestinationPolicy(Consumer<PutDeliveryDestinationPolicyRequest.Builder> putDeliveryDestinationPolicyRequest)

      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 PutDeliveryDestinationPolicyRequest.Builder avoiding the need to create one manually via PutDeliveryDestinationPolicyRequest.builder()

      Parameters:
      putDeliveryDestinationPolicyRequest - A Consumer that will call methods on PutDeliveryDestinationPolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putDeliverySource

      default CompletableFuture<PutDeliverySourceResponse> putDeliverySource(PutDeliverySourceRequest putDeliverySourceRequest)

      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 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.

      Parameters:
      putDeliverySourceRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putDeliverySource

      default CompletableFuture<PutDeliverySourceResponse> putDeliverySource(Consumer<PutDeliverySourceRequest.Builder> putDeliverySourceRequest)

      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 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 PutDeliverySourceRequest.Builder avoiding the need to create one manually via PutDeliverySourceRequest.builder()

      Parameters:
      putDeliverySourceRequest - A Consumer that will call methods on PutDeliverySourceRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putDestination

      default CompletableFuture<PutDestinationResponse> putDestination(PutDestinationRequest putDestinationRequest)

      Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

      A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.

      Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

      To perform a PutDestination operation, you must also have the iam:PassRole permission.

      Parameters:
      putDestinationRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putDestination

      default CompletableFuture<PutDestinationResponse> putDestination(Consumer<PutDestinationRequest.Builder> putDestinationRequest)

      Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

      A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.

      Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

      To perform a PutDestination operation, you must also have the iam:PassRole permission.


      This is a convenience which creates an instance of the PutDestinationRequest.Builder avoiding the need to create one manually via PutDestinationRequest.builder()

      Parameters:
      putDestinationRequest - A Consumer that will call methods on PutDestinationRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putDestinationPolicy

      default CompletableFuture<PutDestinationPolicyResponse> putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest)

      Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.

      Parameters:
      putDestinationPolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putDestinationPolicy

      default CompletableFuture<PutDestinationPolicyResponse> putDestinationPolicy(Consumer<PutDestinationPolicyRequest.Builder> putDestinationPolicyRequest)

      Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.


      This is a convenience which creates an instance of the PutDestinationPolicyRequest.Builder avoiding the need to create one manually via PutDestinationPolicyRequest.builder()

      Parameters:
      putDestinationPolicyRequest - A Consumer that will call methods on PutDestinationPolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putLogEvents

      default CompletableFuture<PutLogEventsResponse> putLogEvents(PutLogEventsRequest putLogEventsRequest)

      Uploads a batch of log events to the specified log stream.

      The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream.

      The batch of events must satisfy the following constraints:

      • The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

      • None of the log events in the batch can be more than 2 hours in the future.

      • None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.

      • The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)

      • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

      • Each log event can be no larger than 256 KB.

      • The maximum number of log events in a batch is 10,000.

      • The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.

      If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.

      Parameters:
      putLogEventsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putLogEvents

      default CompletableFuture<PutLogEventsResponse> putLogEvents(Consumer<PutLogEventsRequest.Builder> putLogEventsRequest)

      Uploads a batch of log events to the specified log stream.

      The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream.

      The batch of events must satisfy the following constraints:

      • The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

      • None of the log events in the batch can be more than 2 hours in the future.

      • None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.

      • The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)

      • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

      • Each log event can be no larger than 256 KB.

      • The maximum number of log events in a batch is 10,000.

      • The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.

      If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.


      This is a convenience which creates an instance of the PutLogEventsRequest.Builder avoiding the need to create one manually via PutLogEventsRequest.builder()

      Parameters:
      putLogEventsRequest - A Consumer that will call methods on PutLogEventsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putMetricFilter

      default CompletableFuture<PutMetricFilterResponse> putMetricFilter(PutMetricFilterRequest putMetricFilterRequest)

      Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.

      The maximum number of metric filters that can be associated with a log group is 100.

      When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.

      Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

      CloudWatch Logs 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.

      Parameters:
      putMetricFilterRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putMetricFilter

      default CompletableFuture<PutMetricFilterResponse> putMetricFilter(Consumer<PutMetricFilterRequest.Builder> putMetricFilterRequest)

      Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.

      The maximum number of metric filters that can be associated with a log group is 100.

      When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.

      Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

      CloudWatch Logs 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 PutMetricFilterRequest.Builder avoiding the need to create one manually via PutMetricFilterRequest.builder()

      Parameters:
      putMetricFilterRequest - A Consumer that will call methods on PutMetricFilterRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putQueryDefinition

      default CompletableFuture<PutQueryDefinitionResponse> putQueryDefinition(PutQueryDefinitionRequest putQueryDefinitionRequest)

      Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.

      To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups.

      You must have the logs:PutQueryDefinition permission to be able to perform this operation.

      Parameters:
      putQueryDefinitionRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putQueryDefinition

      default CompletableFuture<PutQueryDefinitionResponse> putQueryDefinition(Consumer<PutQueryDefinitionRequest.Builder> putQueryDefinitionRequest)

      Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.

      To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups.

      You must have the logs:PutQueryDefinition permission to be able to perform this operation.


      This is a convenience which creates an instance of the PutQueryDefinitionRequest.Builder avoiding the need to create one manually via PutQueryDefinitionRequest.builder()

      Parameters:
      putQueryDefinitionRequest - A Consumer that will call methods on PutQueryDefinitionRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putResourcePolicy

      default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)

      Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.

      Parameters:
      putResourcePolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putResourcePolicy

      default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)

      Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.


      This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need to create one manually via PutResourcePolicyRequest.builder()

      Parameters:
      putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putRetentionPolicy

      default CompletableFuture<PutRetentionPolicyResponse> putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)

      Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.

      CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.

      To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.

      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.

      Parameters:
      putRetentionPolicyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putRetentionPolicy

      default CompletableFuture<PutRetentionPolicyResponse> putRetentionPolicy(Consumer<PutRetentionPolicyRequest.Builder> putRetentionPolicyRequest)

      Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.

      CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.

      To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.

      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 PutRetentionPolicyRequest.Builder avoiding the need to create one manually via PutRetentionPolicyRequest.builder()

      Parameters:
      putRetentionPolicyRequest - A Consumer that will call methods on PutRetentionPolicyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putSubscriptionFilter

      default CompletableFuture<PutSubscriptionFilterResponse> putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest)

      Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

      The following destinations are supported for subscription filters:

      • An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.

      • A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and 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.

      Parameters:
      putSubscriptionFilterRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • putSubscriptionFilter

      default CompletableFuture<PutSubscriptionFilterResponse> putSubscriptionFilter(Consumer<PutSubscriptionFilterRequest.Builder> putSubscriptionFilterRequest)

      Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

      The following destinations are supported for subscription filters:

      • An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.

      • A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations.

      • An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.

      • An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

      Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName.

      To perform a PutSubscriptionFilter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.


      This is a convenience which creates an instance of the PutSubscriptionFilterRequest.Builder avoiding the need to create one manually via PutSubscriptionFilterRequest.builder()

      Parameters:
      putSubscriptionFilterRequest - A Consumer that will call methods on PutSubscriptionFilterRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startLiveTail

      default CompletableFuture<Void> startLiveTail(StartLiveTailRequest startLiveTailRequest, StartLiveTailResponseHandler asyncResponseHandler)

      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.

      For examples of using an SDK to start a Live Tail session, see Start a Live Tail session using an Amazon Web Services SDK.

      Parameters:
      startLiveTailRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startLiveTail

      default CompletableFuture<Void> startLiveTail(Consumer<StartLiveTailRequest.Builder> startLiveTailRequest, StartLiveTailResponseHandler asyncResponseHandler)

      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.

      For examples of using an SDK to start a Live Tail session, see Start a Live Tail session using an Amazon Web Services SDK.


      This is a convenience which creates an instance of the StartLiveTailRequest.Builder avoiding the need to create one manually via StartLiveTailRequest.builder()

      Parameters:
      startLiveTailRequest - A Consumer that will call methods on StartLiveTailRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startQuery

      default CompletableFuture<StartQueryResponse> startQuery(StartQueryRequest startQueryRequest)

      Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.

      For more information, see CloudWatch Logs Insights Query Syntax.

      After you run a query using StartQuery, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using the queryId that StartQuery returns.

      If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.

      Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query definition must be defined in the monitoring account.

      You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.

      Parameters:
      startQueryRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startQuery

      default CompletableFuture<StartQueryResponse> startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest)

      Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.

      For more information, see CloudWatch Logs Insights Query Syntax.

      After you run a query using StartQuery, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using the queryId that StartQuery returns.

      If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.

      Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query definition must be defined in the monitoring account.

      You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.


      This is a convenience which creates an instance of the StartQueryRequest.Builder avoiding the need to create one manually via StartQueryRequest.builder()

      Parameters:
      startQueryRequest - A Consumer that will call methods on StartQueryRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopQuery

      default CompletableFuture<StopQueryResponse> stopQuery(StopQueryRequest stopQueryRequest)

      Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.

      Parameters:
      stopQueryRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopQuery

      default CompletableFuture<StopQueryResponse> stopQuery(Consumer<StopQueryRequest.Builder> stopQueryRequest)

      Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.


      This is a convenience which creates an instance of the StopQueryRequest.Builder avoiding the need to create one manually via StopQueryRequest.builder()

      Parameters:
      stopQueryRequest - A Consumer that will call methods on StopQueryRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • tagLogGroup

      @Deprecated default CompletableFuture<TagLogGroupResponse> tagLogGroup(TagLogGroupRequest tagLogGroupRequest)
      Deprecated.
      Please use the generic tagging API TagResource

      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.

      Parameters:
      tagLogGroupRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • tagLogGroup

      @Deprecated default CompletableFuture<TagLogGroupResponse> tagLogGroup(Consumer<TagLogGroupRequest.Builder> tagLogGroupRequest)
      Deprecated.
      Please use the generic tagging API TagResource

      The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.

      Adds or updates the specified tags for the specified log group.

      To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.

      For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

      CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.


      This is a convenience which creates an instance of the TagLogGroupRequest.Builder avoiding the need to create one manually via TagLogGroupRequest.builder()

      Parameters:
      tagLogGroupRequest - A Consumer that will call methods on TagLogGroupRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

      You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

      You can associate as many as 50 tags with a CloudWatch Logs resource.

      Parameters:
      tagResourceRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

      You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

      You can associate as many as 50 tags with a CloudWatch Logs resource.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • testMetricFilter

      default CompletableFuture<TestMetricFilterResponse> testMetricFilter(TestMetricFilterRequest testMetricFilterRequest)

      Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

      Parameters:
      testMetricFilterRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • testMetricFilter

      default CompletableFuture<TestMetricFilterResponse> testMetricFilter(Consumer<TestMetricFilterRequest.Builder> testMetricFilterRequest)

      Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.


      This is a convenience which creates an instance of the TestMetricFilterRequest.Builder avoiding the need to create one manually via TestMetricFilterRequest.builder()

      Parameters:
      testMetricFilterRequest - A Consumer that will call methods on TestMetricFilterRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagLogGroup

      @Deprecated default CompletableFuture<UntagLogGroupResponse> untagLogGroup(UntagLogGroupRequest untagLogGroupRequest)
      Deprecated.
      Please use the generic tagging API UntagResource

      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.

      Parameters:
      untagLogGroupRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagLogGroup

      @Deprecated default CompletableFuture<UntagLogGroupResponse> untagLogGroup(Consumer<UntagLogGroupRequest.Builder> untagLogGroupRequest)
      Deprecated.
      Please use the generic tagging API UntagResource

      The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.

      Removes the specified tags from the specified log group.

      To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.

      CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys.


      This is a convenience which creates an instance of the UntagLogGroupRequest.Builder avoiding the need to create one manually via UntagLogGroupRequest.builder()

      Parameters:
      untagLogGroupRequest - A Consumer that will call methods on UntagLogGroupRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes one or more tags from the specified resource.

      Parameters:
      untagResourceRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes one or more tags from the specified resource.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateAnomaly

      default CompletableFuture<UpdateAnomalyResponse> updateAnomaly(UpdateAnomalyRequest updateAnomalyRequest)

      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.

      Parameters:
      updateAnomalyRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateAnomaly

      default CompletableFuture<UpdateAnomalyResponse> updateAnomaly(Consumer<UpdateAnomalyRequest.Builder> updateAnomalyRequest)

      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 UpdateAnomalyRequest.Builder avoiding the need to create one manually via UpdateAnomalyRequest.builder()

      Parameters:
      updateAnomalyRequest - A Consumer that will call methods on UpdateAnomalyRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateLogAnomalyDetector

      default CompletableFuture<UpdateLogAnomalyDetectorResponse> updateLogAnomalyDetector(UpdateLogAnomalyDetectorRequest updateLogAnomalyDetectorRequest)

      Updates an existing log anomaly detector.

      Parameters:
      updateLogAnomalyDetectorRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateLogAnomalyDetector

      default CompletableFuture<UpdateLogAnomalyDetectorResponse> updateLogAnomalyDetector(Consumer<UpdateLogAnomalyDetectorRequest.Builder> updateLogAnomalyDetectorRequest)

      Updates an existing log anomaly detector.


      This is a convenience which creates an instance of the UpdateLogAnomalyDetectorRequest.Builder avoiding the need to create one manually via UpdateLogAnomalyDetectorRequest.builder()

      Parameters:
      updateLogAnomalyDetectorRequest - A Consumer that will call methods on UpdateLogAnomalyDetectorRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • serviceClientConfiguration

      default CloudWatchLogsServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static CloudWatchLogsAsyncClient create()
      Create a CloudWatchLogsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static CloudWatchLogsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a CloudWatchLogsAsyncClient.