Interface AmpAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface AmpAsyncClient extends AwsClient
Service client for accessing Amazon Prometheus Service 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.

Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor container environments at scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data model and query language that you use today to monitor the performance of your containerized workloads, and also enjoy improved scalability, availability, and security without having to manage the underlying infrastructure.

For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.

Amazon Managed Service for Prometheus includes two APIs.

  • Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert managers.

  • Use the Prometheus-compatible API to work within your Prometheus workspace.

  • Field Details

  • Method Details

    • createAlertManagerDefinition

      default CompletableFuture<CreateAlertManagerDefinitionResponse> createAlertManagerDefinition(CreateAlertManagerDefinitionRequest createAlertManagerDefinitionRequest)

      The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition.

      Parameters:
      createAlertManagerDefinitionRequest - Represents the input of a CreateAlertManagerDefinition operation.
      Returns:
      A Java Future containing the result of the CreateAlertManagerDefinition 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createAlertManagerDefinition

      default CompletableFuture<CreateAlertManagerDefinitionResponse> createAlertManagerDefinition(Consumer<CreateAlertManagerDefinitionRequest.Builder> createAlertManagerDefinitionRequest)

      The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition.


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

      Parameters:
      createAlertManagerDefinitionRequest - A Consumer that will call methods on CreateAlertManagerDefinitionRequest.Builder to create a request. Represents the input of a CreateAlertManagerDefinition operation.
      Returns:
      A Java Future containing the result of the CreateAlertManagerDefinition 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createLoggingConfiguration

      default CompletableFuture<CreateLoggingConfigurationResponse> createLoggingConfiguration(CreateLoggingConfigurationRequest createLoggingConfigurationRequest)

      The CreateLoggingConfiguration operation creates rules and alerting logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.

      These logging configurations are only for rules and alerting logs.

      Parameters:
      createLoggingConfigurationRequest - Represents the input of a CreateLoggingConfiguration operation.
      Returns:
      A Java Future containing the result of the CreateLoggingConfiguration 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.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createLoggingConfiguration

      default CompletableFuture<CreateLoggingConfigurationResponse> createLoggingConfiguration(Consumer<CreateLoggingConfigurationRequest.Builder> createLoggingConfigurationRequest)

      The CreateLoggingConfiguration operation creates rules and alerting logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.

      These logging configurations are only for rules and alerting logs.


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

      Parameters:
      createLoggingConfigurationRequest - A Consumer that will call methods on CreateLoggingConfigurationRequest.Builder to create a request. Represents the input of a CreateLoggingConfiguration operation.
      Returns:
      A Java Future containing the result of the CreateLoggingConfiguration 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.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createQueryLoggingConfiguration

      default CompletableFuture<CreateQueryLoggingConfigurationResponse> createQueryLoggingConfiguration(CreateQueryLoggingConfigurationRequest createQueryLoggingConfigurationRequest)

      Creates a query logging configuration for the specified workspace. This operation enables logging of queries that exceed the specified QSP threshold.

      Parameters:
      createQueryLoggingConfigurationRequest -
      Returns:
      A Java Future containing the result of the CreateQueryLoggingConfiguration 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.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createQueryLoggingConfiguration

      default CompletableFuture<CreateQueryLoggingConfigurationResponse> createQueryLoggingConfiguration(Consumer<CreateQueryLoggingConfigurationRequest.Builder> createQueryLoggingConfigurationRequest)

      Creates a query logging configuration for the specified workspace. This operation enables logging of queries that exceed the specified QSP threshold.


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

      Parameters:
      createQueryLoggingConfigurationRequest - A Consumer that will call methods on CreateQueryLoggingConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateQueryLoggingConfiguration 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.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createRuleGroupsNamespace

      default CompletableFuture<CreateRuleGroupsNamespaceResponse> createRuleGroupsNamespace(CreateRuleGroupsNamespaceRequest createRuleGroupsNamespaceRequest)

      The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

      Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.

      Parameters:
      createRuleGroupsNamespaceRequest - Represents the input of a CreateRuleGroupsNamespace operation.
      Returns:
      A Java Future containing the result of the CreateRuleGroupsNamespace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createRuleGroupsNamespace

      default CompletableFuture<CreateRuleGroupsNamespaceResponse> createRuleGroupsNamespace(Consumer<CreateRuleGroupsNamespaceRequest.Builder> createRuleGroupsNamespaceRequest)

      The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

      Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.


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

      Parameters:
      createRuleGroupsNamespaceRequest - A Consumer that will call methods on CreateRuleGroupsNamespaceRequest.Builder to create a request. Represents the input of a CreateRuleGroupsNamespace operation.
      Returns:
      A Java Future containing the result of the CreateRuleGroupsNamespace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createScraper

      default CompletableFuture<CreateScraperResponse> createScraper(CreateScraperRequest createScraperRequest)

      The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.

      An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide.

      The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper.

      When creating a scraper, the service creates a Network Interface in each Availability Zone that are passed into CreateScraper through subnets. These network interfaces are used to connect to the Amazon EKS cluster within the VPC for scraping metrics.

      For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.

      Parameters:
      createScraperRequest - Represents the input of a CreateScraper operation.
      Returns:
      A Java Future containing the result of the CreateScraper 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createScraper

      default CompletableFuture<CreateScraperResponse> createScraper(Consumer<CreateScraperRequest.Builder> createScraperRequest)

      The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.

      An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide.

      The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper.

      When creating a scraper, the service creates a Network Interface in each Availability Zone that are passed into CreateScraper through subnets. These network interfaces are used to connect to the Amazon EKS cluster within the VPC for scraping metrics.

      For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.


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

      Parameters:
      createScraperRequest - A Consumer that will call methods on CreateScraperRequest.Builder to create a request. Represents the input of a CreateScraper operation.
      Returns:
      A Java Future containing the result of the CreateScraper 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createWorkspace

      default CompletableFuture<CreateWorkspaceResponse> createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)

      Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.

      Parameters:
      createWorkspaceRequest - Represents the input of a CreateWorkspace operation.
      Returns:
      A Java Future containing the result of the CreateWorkspace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createWorkspace

      default CompletableFuture<CreateWorkspaceResponse> createWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest)

      Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.


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

      Parameters:
      createWorkspaceRequest - A Consumer that will call methods on CreateWorkspaceRequest.Builder to create a request. Represents the input of a CreateWorkspace operation.
      Returns:
      A Java Future containing the result of the CreateWorkspace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteAlertManagerDefinition

      default CompletableFuture<DeleteAlertManagerDefinitionResponse> deleteAlertManagerDefinition(DeleteAlertManagerDefinitionRequest deleteAlertManagerDefinitionRequest)

      Deletes the alert manager definition from a workspace.

      Parameters:
      deleteAlertManagerDefinitionRequest - Represents the input of a DeleteAlertManagerDefinition operation.
      Returns:
      A Java Future containing the result of the DeleteAlertManagerDefinition 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteAlertManagerDefinition

      default CompletableFuture<DeleteAlertManagerDefinitionResponse> deleteAlertManagerDefinition(Consumer<DeleteAlertManagerDefinitionRequest.Builder> deleteAlertManagerDefinitionRequest)

      Deletes the alert manager definition from a workspace.


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

      Parameters:
      deleteAlertManagerDefinitionRequest - A Consumer that will call methods on DeleteAlertManagerDefinitionRequest.Builder to create a request. Represents the input of a DeleteAlertManagerDefinition operation.
      Returns:
      A Java Future containing the result of the DeleteAlertManagerDefinition 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteLoggingConfiguration

      default CompletableFuture<DeleteLoggingConfigurationResponse> deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest)

      Deletes the rules and alerting logging configuration for a workspace.

      These logging configurations are only for rules and alerting logs.

      Parameters:
      deleteLoggingConfigurationRequest - Represents the input of a DeleteLoggingConfiguration operation.
      Returns:
      A Java Future containing the result of the DeleteLoggingConfiguration 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.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteLoggingConfiguration

      default CompletableFuture<DeleteLoggingConfigurationResponse> deleteLoggingConfiguration(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest)

      Deletes the rules and alerting logging configuration for a workspace.

      These logging configurations are only for rules and alerting logs.


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

      Parameters:
      deleteLoggingConfigurationRequest - A Consumer that will call methods on DeleteLoggingConfigurationRequest.Builder to create a request. Represents the input of a DeleteLoggingConfiguration operation.
      Returns:
      A Java Future containing the result of the DeleteLoggingConfiguration 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.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteQueryLoggingConfiguration

      default CompletableFuture<DeleteQueryLoggingConfigurationResponse> deleteQueryLoggingConfiguration(DeleteQueryLoggingConfigurationRequest deleteQueryLoggingConfigurationRequest)

      Deletes the query logging configuration for the specified workspace.

      Parameters:
      deleteQueryLoggingConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteQueryLoggingConfiguration 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.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteQueryLoggingConfiguration

      default CompletableFuture<DeleteQueryLoggingConfigurationResponse> deleteQueryLoggingConfiguration(Consumer<DeleteQueryLoggingConfigurationRequest.Builder> deleteQueryLoggingConfigurationRequest)

      Deletes the query logging configuration for the specified workspace.


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

      Parameters:
      deleteQueryLoggingConfigurationRequest - A Consumer that will call methods on DeleteQueryLoggingConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteQueryLoggingConfiguration 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.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteRuleGroupsNamespace

      default CompletableFuture<DeleteRuleGroupsNamespaceResponse> deleteRuleGroupsNamespace(DeleteRuleGroupsNamespaceRequest deleteRuleGroupsNamespaceRequest)

      Deletes one rule groups namespace and its associated rule groups definition.

      Parameters:
      deleteRuleGroupsNamespaceRequest - Represents the input of a DeleteRuleGroupsNamespace operation.
      Returns:
      A Java Future containing the result of the DeleteRuleGroupsNamespace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteRuleGroupsNamespace

      default CompletableFuture<DeleteRuleGroupsNamespaceResponse> deleteRuleGroupsNamespace(Consumer<DeleteRuleGroupsNamespaceRequest.Builder> deleteRuleGroupsNamespaceRequest)

      Deletes one rule groups namespace and its associated rule groups definition.


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

      Parameters:
      deleteRuleGroupsNamespaceRequest - A Consumer that will call methods on DeleteRuleGroupsNamespaceRequest.Builder to create a request. Represents the input of a DeleteRuleGroupsNamespace operation.
      Returns:
      A Java Future containing the result of the DeleteRuleGroupsNamespace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteScraper

      default CompletableFuture<DeleteScraperResponse> deleteScraper(DeleteScraperRequest deleteScraperRequest)

      The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.

      Parameters:
      deleteScraperRequest - Represents the input of a DeleteScraper operation.
      Returns:
      A Java Future containing the result of the DeleteScraper 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteScraper

      default CompletableFuture<DeleteScraperResponse> deleteScraper(Consumer<DeleteScraperRequest.Builder> deleteScraperRequest)

      The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.


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

      Parameters:
      deleteScraperRequest - A Consumer that will call methods on DeleteScraperRequest.Builder to create a request. Represents the input of a DeleteScraper operation.
      Returns:
      A Java Future containing the result of the DeleteScraper 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteWorkspace

      default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)

      Deletes an existing workspace.

      When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.

      Parameters:
      deleteWorkspaceRequest - Represents the input of a DeleteWorkspace operation.
      Returns:
      A Java Future containing the result of the DeleteWorkspace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteWorkspace

      default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest)

      Deletes an existing workspace.

      When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.


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

      Parameters:
      deleteWorkspaceRequest - A Consumer that will call methods on DeleteWorkspaceRequest.Builder to create a request. Represents the input of a DeleteWorkspace operation.
      Returns:
      A Java Future containing the result of the DeleteWorkspace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeAlertManagerDefinition

      default CompletableFuture<DescribeAlertManagerDefinitionResponse> describeAlertManagerDefinition(DescribeAlertManagerDefinitionRequest describeAlertManagerDefinitionRequest)

      Retrieves the full information about the alert manager definition for a workspace.

      Parameters:
      describeAlertManagerDefinitionRequest - Represents the input of a DescribeAlertManagerDefinition operation.
      Returns:
      A Java Future containing the result of the DescribeAlertManagerDefinition 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeAlertManagerDefinition

      default CompletableFuture<DescribeAlertManagerDefinitionResponse> describeAlertManagerDefinition(Consumer<DescribeAlertManagerDefinitionRequest.Builder> describeAlertManagerDefinitionRequest)

      Retrieves the full information about the alert manager definition for a workspace.


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

      Parameters:
      describeAlertManagerDefinitionRequest - A Consumer that will call methods on DescribeAlertManagerDefinitionRequest.Builder to create a request. Represents the input of a DescribeAlertManagerDefinition operation.
      Returns:
      A Java Future containing the result of the DescribeAlertManagerDefinition 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeLoggingConfiguration

      default CompletableFuture<DescribeLoggingConfigurationResponse> describeLoggingConfiguration(DescribeLoggingConfigurationRequest describeLoggingConfigurationRequest)

      Returns complete information about the current rules and alerting logging configuration of the workspace.

      These logging configurations are only for rules and alerting logs.

      Parameters:
      describeLoggingConfigurationRequest - Represents the input of a DescribeLoggingConfiguration operation.
      Returns:
      A Java Future containing the result of the DescribeLoggingConfiguration 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.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeLoggingConfiguration

      default CompletableFuture<DescribeLoggingConfigurationResponse> describeLoggingConfiguration(Consumer<DescribeLoggingConfigurationRequest.Builder> describeLoggingConfigurationRequest)

      Returns complete information about the current rules and alerting logging configuration of the workspace.

      These logging configurations are only for rules and alerting logs.


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

      Parameters:
      describeLoggingConfigurationRequest - A Consumer that will call methods on DescribeLoggingConfigurationRequest.Builder to create a request. Represents the input of a DescribeLoggingConfiguration operation.
      Returns:
      A Java Future containing the result of the DescribeLoggingConfiguration 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.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeQueryLoggingConfiguration

      default CompletableFuture<DescribeQueryLoggingConfigurationResponse> describeQueryLoggingConfiguration(DescribeQueryLoggingConfigurationRequest describeQueryLoggingConfigurationRequest)

      Retrieves the details of the query logging configuration for the specified workspace.

      Parameters:
      describeQueryLoggingConfigurationRequest -
      Returns:
      A Java Future containing the result of the DescribeQueryLoggingConfiguration 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.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeQueryLoggingConfiguration

      default CompletableFuture<DescribeQueryLoggingConfigurationResponse> describeQueryLoggingConfiguration(Consumer<DescribeQueryLoggingConfigurationRequest.Builder> describeQueryLoggingConfigurationRequest)

      Retrieves the details of the query logging configuration for the specified workspace.


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

      Parameters:
      describeQueryLoggingConfigurationRequest - A Consumer that will call methods on DescribeQueryLoggingConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeQueryLoggingConfiguration 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.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeRuleGroupsNamespace

      default CompletableFuture<DescribeRuleGroupsNamespaceResponse> describeRuleGroupsNamespace(DescribeRuleGroupsNamespaceRequest describeRuleGroupsNamespaceRequest)

      Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.

      Parameters:
      describeRuleGroupsNamespaceRequest - Represents the input of a DescribeRuleGroupsNamespace operation.
      Returns:
      A Java Future containing the result of the DescribeRuleGroupsNamespace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeRuleGroupsNamespace

      default CompletableFuture<DescribeRuleGroupsNamespaceResponse> describeRuleGroupsNamespace(Consumer<DescribeRuleGroupsNamespaceRequest.Builder> describeRuleGroupsNamespaceRequest)

      Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.


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

      Parameters:
      describeRuleGroupsNamespaceRequest - A Consumer that will call methods on DescribeRuleGroupsNamespaceRequest.Builder to create a request. Represents the input of a DescribeRuleGroupsNamespace operation.
      Returns:
      A Java Future containing the result of the DescribeRuleGroupsNamespace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeScraper

      default CompletableFuture<DescribeScraperResponse> describeScraper(DescribeScraperRequest describeScraperRequest)

      The DescribeScraper operation displays information about an existing scraper.

      Parameters:
      describeScraperRequest - Represents the input of a DescribeScraper operation.
      Returns:
      A Java Future containing the result of the DescribeScraper 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeScraper

      default CompletableFuture<DescribeScraperResponse> describeScraper(Consumer<DescribeScraperRequest.Builder> describeScraperRequest)

      The DescribeScraper operation displays information about an existing scraper.


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

      Parameters:
      describeScraperRequest - A Consumer that will call methods on DescribeScraperRequest.Builder to create a request. Represents the input of a DescribeScraper operation.
      Returns:
      A Java Future containing the result of the DescribeScraper 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeWorkspace

      default CompletableFuture<DescribeWorkspaceResponse> describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest)

      Returns information about an existing workspace.

      Parameters:
      describeWorkspaceRequest - Represents the input of a DescribeWorkspace operation.
      Returns:
      A Java Future containing the result of the DescribeWorkspace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeWorkspace

      default CompletableFuture<DescribeWorkspaceResponse> describeWorkspace(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest)

      Returns information about an existing workspace.


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

      Parameters:
      describeWorkspaceRequest - A Consumer that will call methods on DescribeWorkspaceRequest.Builder to create a request. Represents the input of a DescribeWorkspace operation.
      Returns:
      A Java Future containing the result of the DescribeWorkspace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeWorkspaceConfiguration

      default CompletableFuture<DescribeWorkspaceConfigurationResponse> describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest describeWorkspaceConfigurationRequest)

      Use this operation to return information about the configuration of a workspace. The configuration details returned include workspace configuration status, label set limits, and retention period.

      Parameters:
      describeWorkspaceConfigurationRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkspaceConfiguration 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeWorkspaceConfiguration

      default CompletableFuture<DescribeWorkspaceConfigurationResponse> describeWorkspaceConfiguration(Consumer<DescribeWorkspaceConfigurationRequest.Builder> describeWorkspaceConfigurationRequest)

      Use this operation to return information about the configuration of a workspace. The configuration details returned include workspace configuration status, label set limits, and retention period.


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

      Parameters:
      describeWorkspaceConfigurationRequest - A Consumer that will call methods on DescribeWorkspaceConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkspaceConfiguration 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getDefaultScraperConfiguration

      default CompletableFuture<GetDefaultScraperConfigurationResponse> getDefaultScraperConfiguration(GetDefaultScraperConfigurationRequest getDefaultScraperConfigurationRequest)

      The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.

      Parameters:
      getDefaultScraperConfigurationRequest - Represents the input of a GetDefaultScraperConfiguration operation.
      Returns:
      A Java Future containing the result of the GetDefaultScraperConfiguration 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.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getDefaultScraperConfiguration

      default CompletableFuture<GetDefaultScraperConfigurationResponse> getDefaultScraperConfiguration(Consumer<GetDefaultScraperConfigurationRequest.Builder> getDefaultScraperConfigurationRequest)

      The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.


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

      Parameters:
      getDefaultScraperConfigurationRequest - A Consumer that will call methods on GetDefaultScraperConfigurationRequest.Builder to create a request. Represents the input of a GetDefaultScraperConfiguration operation.
      Returns:
      A Java Future containing the result of the GetDefaultScraperConfiguration 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.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listRuleGroupsNamespaces

      default CompletableFuture<ListRuleGroupsNamespacesResponse> listRuleGroupsNamespaces(ListRuleGroupsNamespacesRequest listRuleGroupsNamespacesRequest)

      Returns a list of rule groups namespaces in a workspace.

      Parameters:
      listRuleGroupsNamespacesRequest - Represents the input of a ListRuleGroupsNamespaces operation.
      Returns:
      A Java Future containing the result of the ListRuleGroupsNamespaces 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listRuleGroupsNamespaces

      default CompletableFuture<ListRuleGroupsNamespacesResponse> listRuleGroupsNamespaces(Consumer<ListRuleGroupsNamespacesRequest.Builder> listRuleGroupsNamespacesRequest)

      Returns a list of rule groups namespaces in a workspace.


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

      Parameters:
      listRuleGroupsNamespacesRequest - A Consumer that will call methods on ListRuleGroupsNamespacesRequest.Builder to create a request. Represents the input of a ListRuleGroupsNamespaces operation.
      Returns:
      A Java Future containing the result of the ListRuleGroupsNamespaces 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listRuleGroupsNamespacesPaginator

      default ListRuleGroupsNamespacesPublisher listRuleGroupsNamespacesPaginator(ListRuleGroupsNamespacesRequest listRuleGroupsNamespacesRequest)

      This is a variant of listRuleGroupsNamespaces(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesRequest) 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.amp.paginators.ListRuleGroupsNamespacesPublisher publisher = client.listRuleGroupsNamespacesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.amp.paginators.ListRuleGroupsNamespacesPublisher publisher = client.listRuleGroupsNamespacesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesResponse 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 maxResults 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 listRuleGroupsNamespaces(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesRequest) operation.

      Parameters:
      listRuleGroupsNamespacesRequest - Represents the input of a ListRuleGroupsNamespaces 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listRuleGroupsNamespacesPaginator

      default ListRuleGroupsNamespacesPublisher listRuleGroupsNamespacesPaginator(Consumer<ListRuleGroupsNamespacesRequest.Builder> listRuleGroupsNamespacesRequest)

      This is a variant of listRuleGroupsNamespaces(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesRequest) 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.amp.paginators.ListRuleGroupsNamespacesPublisher publisher = client.listRuleGroupsNamespacesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.amp.paginators.ListRuleGroupsNamespacesPublisher publisher = client.listRuleGroupsNamespacesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesResponse 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 maxResults 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 listRuleGroupsNamespaces(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesRequest) operation.


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

      Parameters:
      listRuleGroupsNamespacesRequest - A Consumer that will call methods on ListRuleGroupsNamespacesRequest.Builder to create a request. Represents the input of a ListRuleGroupsNamespaces 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listScrapers

      default CompletableFuture<ListScrapersResponse> listScrapers(ListScrapersRequest listScrapersRequest)

      The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.

      Parameters:
      listScrapersRequest - Represents the input of a ListScrapers operation.
      Returns:
      A Java Future containing the result of the ListScrapers 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listScrapers

      default CompletableFuture<ListScrapersResponse> listScrapers(Consumer<ListScrapersRequest.Builder> listScrapersRequest)

      The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.


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

      Parameters:
      listScrapersRequest - A Consumer that will call methods on ListScrapersRequest.Builder to create a request. Represents the input of a ListScrapers operation.
      Returns:
      A Java Future containing the result of the ListScrapers 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listScrapersPaginator

      default ListScrapersPublisher listScrapersPaginator(ListScrapersRequest listScrapersRequest)

      This is a variant of listScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest) 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.amp.paginators.ListScrapersPublisher publisher = client.listScrapersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.amp.paginators.ListScrapersPublisher publisher = client.listScrapersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amp.model.ListScrapersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.amp.model.ListScrapersResponse 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 maxResults 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 listScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest) operation.

      Parameters:
      listScrapersRequest - Represents the input of a ListScrapers 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listScrapersPaginator

      default ListScrapersPublisher listScrapersPaginator(Consumer<ListScrapersRequest.Builder> listScrapersRequest)

      This is a variant of listScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest) 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.amp.paginators.ListScrapersPublisher publisher = client.listScrapersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.amp.paginators.ListScrapersPublisher publisher = client.listScrapersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amp.model.ListScrapersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.amp.model.ListScrapersResponse 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 maxResults 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 listScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest) operation.


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

      Parameters:
      listScrapersRequest - A Consumer that will call methods on ListScrapersRequest.Builder to create a request. Represents the input of a ListScrapers 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException 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)

      The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are scrapers, workspaces, and rule groups namespaces.

      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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException 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)

      The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are scrapers, workspaces, and rule groups namespaces.


      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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listWorkspaces

      default CompletableFuture<ListWorkspacesResponse> listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)

      Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.

      Parameters:
      listWorkspacesRequest - Represents the input of a ListWorkspaces operation.
      Returns:
      A Java Future containing the result of the ListWorkspaces 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listWorkspaces

      default CompletableFuture<ListWorkspacesResponse> listWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)

      Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.


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

      Parameters:
      listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request. Represents the input of a ListWorkspaces operation.
      Returns:
      A Java Future containing the result of the ListWorkspaces 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listWorkspacesPaginator

      default ListWorkspacesPublisher listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest)

      This is a variant of listWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest) 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.amp.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.amp.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amp.model.ListWorkspacesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.amp.model.ListWorkspacesResponse 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 maxResults 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 listWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest) operation.

      Parameters:
      listWorkspacesRequest - Represents the input of a ListWorkspaces 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listWorkspacesPaginator

      default ListWorkspacesPublisher listWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)

      This is a variant of listWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest) 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.amp.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.amp.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amp.model.ListWorkspacesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.amp.model.ListWorkspacesResponse 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 maxResults 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 listWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest) operation.


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

      Parameters:
      listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request. Represents the input of a ListWorkspaces 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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • putAlertManagerDefinition

      default CompletableFuture<PutAlertManagerDefinitionResponse> putAlertManagerDefinition(PutAlertManagerDefinitionRequest putAlertManagerDefinitionRequest)

      Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition .

      Parameters:
      putAlertManagerDefinitionRequest - Represents the input of a PutAlertManagerDefinition operation.
      Returns:
      A Java Future containing the result of the PutAlertManagerDefinition 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • putAlertManagerDefinition

      default CompletableFuture<PutAlertManagerDefinitionResponse> putAlertManagerDefinition(Consumer<PutAlertManagerDefinitionRequest.Builder> putAlertManagerDefinitionRequest)

      Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition .


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

      Parameters:
      putAlertManagerDefinitionRequest - A Consumer that will call methods on PutAlertManagerDefinitionRequest.Builder to create a request. Represents the input of a PutAlertManagerDefinition operation.
      Returns:
      A Java Future containing the result of the PutAlertManagerDefinition 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • putRuleGroupsNamespace

      default CompletableFuture<PutRuleGroupsNamespaceResponse> putRuleGroupsNamespace(PutRuleGroupsNamespaceRequest putRuleGroupsNamespaceRequest)

      Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

      Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace.

      You can't use this operation to add tags to an existing rule groups namespace. Instead, use TagResource.

      Parameters:
      putRuleGroupsNamespaceRequest - Represents the input of a PutRuleGroupsNamespace operation.
      Returns:
      A Java Future containing the result of the PutRuleGroupsNamespace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • putRuleGroupsNamespace

      default CompletableFuture<PutRuleGroupsNamespaceResponse> putRuleGroupsNamespace(Consumer<PutRuleGroupsNamespaceRequest.Builder> putRuleGroupsNamespaceRequest)

      Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

      Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace.

      You can't use this operation to add tags to an existing rule groups namespace. Instead, use TagResource.


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

      Parameters:
      putRuleGroupsNamespaceRequest - A Consumer that will call methods on PutRuleGroupsNamespaceRequest.Builder to create a request. Represents the input of a PutRuleGroupsNamespace operation.
      Returns:
      A Java Future containing the result of the PutRuleGroupsNamespace 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException 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)

      The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.

      If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. To remove a tag, use UntagResource.

      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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException 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)

      The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.

      If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. To remove a tag, use UntagResource.


      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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException 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 the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.

      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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException 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 the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.


      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.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateLoggingConfiguration

      default CompletableFuture<UpdateLoggingConfigurationResponse> updateLoggingConfiguration(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest)

      Updates the log group ARN or the workspace ID of the current rules and alerting logging configuration.

      These logging configurations are only for rules and alerting logs.

      Parameters:
      updateLoggingConfigurationRequest - Represents the input of an UpdateLoggingConfiguration operation.
      Returns:
      A Java Future containing the result of the UpdateLoggingConfiguration 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.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateLoggingConfiguration

      default CompletableFuture<UpdateLoggingConfigurationResponse> updateLoggingConfiguration(Consumer<UpdateLoggingConfigurationRequest.Builder> updateLoggingConfigurationRequest)

      Updates the log group ARN or the workspace ID of the current rules and alerting logging configuration.

      These logging configurations are only for rules and alerting logs.


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

      Parameters:
      updateLoggingConfigurationRequest - A Consumer that will call methods on UpdateLoggingConfigurationRequest.Builder to create a request. Represents the input of an UpdateLoggingConfiguration operation.
      Returns:
      A Java Future containing the result of the UpdateLoggingConfiguration 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.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateQueryLoggingConfiguration

      default CompletableFuture<UpdateQueryLoggingConfigurationResponse> updateQueryLoggingConfiguration(UpdateQueryLoggingConfigurationRequest updateQueryLoggingConfigurationRequest)

      Updates the query logging configuration for the specified workspace.

      Parameters:
      updateQueryLoggingConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateQueryLoggingConfiguration 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.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateQueryLoggingConfiguration

      default CompletableFuture<UpdateQueryLoggingConfigurationResponse> updateQueryLoggingConfiguration(Consumer<UpdateQueryLoggingConfigurationRequest.Builder> updateQueryLoggingConfigurationRequest)

      Updates the query logging configuration for the specified workspace.


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

      Parameters:
      updateQueryLoggingConfigurationRequest - A Consumer that will call methods on UpdateQueryLoggingConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQueryLoggingConfiguration 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.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateScraper

      default CompletableFuture<UpdateScraperResponse> updateScraper(UpdateScraperRequest updateScraperRequest)

      Updates an existing scraper.

      You can't use this function to update the source from which the scraper is collecting metrics. To change the source, delete the scraper and create a new one.

      Parameters:
      updateScraperRequest -
      Returns:
      A Java Future containing the result of the UpdateScraper 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateScraper

      default CompletableFuture<UpdateScraperResponse> updateScraper(Consumer<UpdateScraperRequest.Builder> updateScraperRequest)

      Updates an existing scraper.

      You can't use this function to update the source from which the scraper is collecting metrics. To change the source, delete the scraper and create a new one.


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

      Parameters:
      updateScraperRequest - A Consumer that will call methods on UpdateScraperRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateScraper 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateWorkspaceAlias

      default CompletableFuture<UpdateWorkspaceAliasResponse> updateWorkspaceAlias(UpdateWorkspaceAliasRequest updateWorkspaceAliasRequest)

      Updates the alias of an existing workspace.

      Parameters:
      updateWorkspaceAliasRequest - Represents the input of an UpdateWorkspaceAlias operation.
      Returns:
      A Java Future containing the result of the UpdateWorkspaceAlias 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateWorkspaceAlias

      default CompletableFuture<UpdateWorkspaceAliasResponse> updateWorkspaceAlias(Consumer<UpdateWorkspaceAliasRequest.Builder> updateWorkspaceAliasRequest)

      Updates the alias of an existing workspace.


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

      Parameters:
      updateWorkspaceAliasRequest - A Consumer that will call methods on UpdateWorkspaceAliasRequest.Builder to create a request. Represents the input of an UpdateWorkspaceAlias operation.
      Returns:
      A Java Future containing the result of the UpdateWorkspaceAlias 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateWorkspaceConfiguration

      default CompletableFuture<UpdateWorkspaceConfigurationResponse> updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest updateWorkspaceConfigurationRequest)

      Use this operation to create or update the label sets, label set limits, and retention period of a workspace.

      You must specify at least one of limitsPerLabelSet or retentionPeriodInDays for the request to be valid.

      Parameters:
      updateWorkspaceConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateWorkspaceConfiguration 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateWorkspaceConfiguration

      default CompletableFuture<UpdateWorkspaceConfigurationResponse> updateWorkspaceConfiguration(Consumer<UpdateWorkspaceConfigurationRequest.Builder> updateWorkspaceConfigurationRequest)

      Use this operation to create or update the label sets, label set limits, and retention period of a workspace.

      You must specify at least one of limitsPerLabelSet or retentionPeriodInDays for the request to be valid.


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

      Parameters:
      updateWorkspaceConfigurationRequest - A Consumer that will call methods on UpdateWorkspaceConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWorkspaceConfiguration 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.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException The request would cause an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException The request references a resources that doesn't exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • waiter

      default AmpAsyncWaiter waiter()
      Create an instance of AmpAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of AmpAsyncWaiter
    • serviceClientConfiguration

      default AmpServiceClientConfiguration 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 AmpAsyncClient create()
      Create a AmpAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
    • builder

      static AmpAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a AmpAsyncClient.