Interface AmpAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
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 Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic AmpAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aAmpAsyncClient.static AmpAsyncClientcreate()Create aAmpAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createAlertManagerDefinition(Consumer<CreateAlertManagerDefinitionRequest.Builder> createAlertManagerDefinitionRequest) TheCreateAlertManagerDefinitionoperation creates the alert manager definition in a workspace.createAlertManagerDefinition(CreateAlertManagerDefinitionRequest createAlertManagerDefinitionRequest) TheCreateAlertManagerDefinitionoperation creates the alert manager definition in a workspace.createLoggingConfiguration(Consumer<CreateLoggingConfigurationRequest.Builder> createLoggingConfigurationRequest) TheCreateLoggingConfigurationoperation creates a logging configuration for the workspace.createLoggingConfiguration(CreateLoggingConfigurationRequest createLoggingConfigurationRequest) TheCreateLoggingConfigurationoperation creates a logging configuration for the workspace.createRuleGroupsNamespace(Consumer<CreateRuleGroupsNamespaceRequest.Builder> createRuleGroupsNamespaceRequest) TheCreateRuleGroupsNamespaceoperation creates a rule groups namespace within a workspace.createRuleGroupsNamespace(CreateRuleGroupsNamespaceRequest createRuleGroupsNamespaceRequest) TheCreateRuleGroupsNamespaceoperation creates a rule groups namespace within a workspace.default CompletableFuture<CreateScraperResponse> createScraper(Consumer<CreateScraperRequest.Builder> createScraperRequest) TheCreateScraperoperation creates a scraper to collect metrics.default CompletableFuture<CreateScraperResponse> createScraper(CreateScraperRequest createScraperRequest) TheCreateScraperoperation creates a scraper to collect metrics.default CompletableFuture<CreateWorkspaceResponse> createWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest) Creates a Prometheus workspace.default CompletableFuture<CreateWorkspaceResponse> createWorkspace(CreateWorkspaceRequest createWorkspaceRequest) Creates a Prometheus workspace.deleteAlertManagerDefinition(Consumer<DeleteAlertManagerDefinitionRequest.Builder> deleteAlertManagerDefinitionRequest) Deletes the alert manager definition from a workspace.deleteAlertManagerDefinition(DeleteAlertManagerDefinitionRequest deleteAlertManagerDefinitionRequest) Deletes the alert manager definition from a workspace.deleteLoggingConfiguration(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest) Deletes the logging configuration for a workspace.deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest) Deletes the logging configuration for a workspace.deleteRuleGroupsNamespace(Consumer<DeleteRuleGroupsNamespaceRequest.Builder> deleteRuleGroupsNamespaceRequest) Deletes one rule groups namespace and its associated rule groups definition.deleteRuleGroupsNamespace(DeleteRuleGroupsNamespaceRequest deleteRuleGroupsNamespaceRequest) Deletes one rule groups namespace and its associated rule groups definition.default CompletableFuture<DeleteScraperResponse> deleteScraper(Consumer<DeleteScraperRequest.Builder> deleteScraperRequest) TheDeleteScraperoperation deletes one scraper, and stops any metrics collection that the scraper performs.default CompletableFuture<DeleteScraperResponse> deleteScraper(DeleteScraperRequest deleteScraperRequest) TheDeleteScraperoperation deletes one scraper, and stops any metrics collection that the scraper performs.default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest) Deletes an existing workspace.default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest) Deletes an existing workspace.describeAlertManagerDefinition(Consumer<DescribeAlertManagerDefinitionRequest.Builder> describeAlertManagerDefinitionRequest) Retrieves the full information about the alert manager definition for a workspace.describeAlertManagerDefinition(DescribeAlertManagerDefinitionRequest describeAlertManagerDefinitionRequest) Retrieves the full information about the alert manager definition for a workspace.describeLoggingConfiguration(Consumer<DescribeLoggingConfigurationRequest.Builder> describeLoggingConfigurationRequest) Returns complete information about the current logging configuration of the workspace.describeLoggingConfiguration(DescribeLoggingConfigurationRequest describeLoggingConfigurationRequest) Returns complete information about the current logging configuration of the workspace.describeRuleGroupsNamespace(Consumer<DescribeRuleGroupsNamespaceRequest.Builder> describeRuleGroupsNamespaceRequest) Returns complete information about one rule groups namespace.describeRuleGroupsNamespace(DescribeRuleGroupsNamespaceRequest describeRuleGroupsNamespaceRequest) Returns complete information about one rule groups namespace.default CompletableFuture<DescribeScraperResponse> describeScraper(Consumer<DescribeScraperRequest.Builder> describeScraperRequest) TheDescribeScraperoperation displays information about an existing scraper.default CompletableFuture<DescribeScraperResponse> describeScraper(DescribeScraperRequest describeScraperRequest) TheDescribeScraperoperation displays information about an existing scraper.describeWorkspace(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest) Returns information about an existing workspace.describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest) Returns information about an existing workspace.getDefaultScraperConfiguration(Consumer<GetDefaultScraperConfigurationRequest.Builder> getDefaultScraperConfigurationRequest) TheGetDefaultScraperConfigurationoperation returns the default scraper configuration used when Amazon EKS creates a scraper for you.getDefaultScraperConfiguration(GetDefaultScraperConfigurationRequest getDefaultScraperConfigurationRequest) TheGetDefaultScraperConfigurationoperation returns the default scraper configuration used when Amazon EKS creates a scraper for you.listRuleGroupsNamespaces(Consumer<ListRuleGroupsNamespacesRequest.Builder> listRuleGroupsNamespacesRequest) Returns a list of rule groups namespaces in a workspace.listRuleGroupsNamespaces(ListRuleGroupsNamespacesRequest listRuleGroupsNamespacesRequest) Returns a list of rule groups namespaces in a workspace.listRuleGroupsNamespacesPaginator(Consumer<ListRuleGroupsNamespacesRequest.Builder> listRuleGroupsNamespacesRequest) This is a variant oflistRuleGroupsNamespaces(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesRequest)operation.listRuleGroupsNamespacesPaginator(ListRuleGroupsNamespacesRequest listRuleGroupsNamespacesRequest) This is a variant oflistRuleGroupsNamespaces(software.amazon.awssdk.services.amp.model.ListRuleGroupsNamespacesRequest)operation.default CompletableFuture<ListScrapersResponse> listScrapers(Consumer<ListScrapersRequest.Builder> listScrapersRequest) TheListScrapersoperation lists all of the scrapers in your account.default CompletableFuture<ListScrapersResponse> listScrapers(ListScrapersRequest listScrapersRequest) TheListScrapersoperation lists all of the scrapers in your account.default ListScrapersPublisherlistScrapersPaginator(Consumer<ListScrapersRequest.Builder> listScrapersRequest) This is a variant oflistScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest)operation.default ListScrapersPublisherlistScrapersPaginator(ListScrapersRequest listScrapersRequest) This is a variant oflistScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) TheListTagsForResourceoperation returns the tags that are associated with an Amazon Managed Service for Prometheus resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) TheListTagsForResourceoperation returns the tags that are associated with an Amazon Managed Service for Prometheus resource.default CompletableFuture<ListWorkspacesResponse> listWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest) Lists all of the Amazon Managed Service for Prometheus workspaces in your account.default CompletableFuture<ListWorkspacesResponse> listWorkspaces(ListWorkspacesRequest listWorkspacesRequest) Lists all of the Amazon Managed Service for Prometheus workspaces in your account.default ListWorkspacesPublisherlistWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest) This is a variant oflistWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest)operation.default ListWorkspacesPublisherlistWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest) This is a variant oflistWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest)operation.putAlertManagerDefinition(Consumer<PutAlertManagerDefinitionRequest.Builder> putAlertManagerDefinitionRequest) Updates an existing alert manager definition in a workspace.putAlertManagerDefinition(PutAlertManagerDefinitionRequest putAlertManagerDefinitionRequest) Updates an existing alert manager definition in a workspace.putRuleGroupsNamespace(Consumer<PutRuleGroupsNamespaceRequest.Builder> putRuleGroupsNamespaceRequest) Updates an existing rule groups namespace within a workspace.putRuleGroupsNamespace(PutRuleGroupsNamespaceRequest putRuleGroupsNamespaceRequest) Updates an existing rule groups namespace within a workspace.default AmpServiceClientConfigurationThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) TheTagResourceoperation associates tags with an Amazon Managed Service for Prometheus resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) TheTagResourceoperation associates tags with an Amazon Managed Service for Prometheus resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from an Amazon Managed Service for Prometheus resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from an Amazon Managed Service for Prometheus resource.updateLoggingConfiguration(Consumer<UpdateLoggingConfigurationRequest.Builder> updateLoggingConfigurationRequest) Updates the log group ARN or the workspace ID of the current logging configuration.updateLoggingConfiguration(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest) Updates the log group ARN or the workspace ID of the current logging configuration.default CompletableFuture<UpdateScraperResponse> updateScraper(Consumer<UpdateScraperRequest.Builder> updateScraperRequest) Updates an existing scraper.default CompletableFuture<UpdateScraperResponse> updateScraper(UpdateScraperRequest updateScraperRequest) Updates an existing scraper.updateWorkspaceAlias(Consumer<UpdateWorkspaceAliasRequest.Builder> updateWorkspaceAliasRequest) Updates the alias of an existing workspace.updateWorkspaceAlias(UpdateWorkspaceAliasRequest updateWorkspaceAliasRequest) Updates the alias of an existing workspace.default AmpAsyncWaiterwaiter()Create an instance ofAmpAsyncWaiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
createAlertManagerDefinition
default CompletableFuture<CreateAlertManagerDefinitionResponse> createAlertManagerDefinition(CreateAlertManagerDefinitionRequest createAlertManagerDefinitionRequest) The
CreateAlertManagerDefinitionoperation 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, usePutAlertManagerDefinition.- Parameters:
createAlertManagerDefinitionRequest- Represents the input of aCreateAlertManagerDefinitionoperation.- 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 invokeThrowable.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
CreateAlertManagerDefinitionoperation 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, usePutAlertManagerDefinition.
This is a convenience which creates an instance of the
CreateAlertManagerDefinitionRequest.Builderavoiding the need to create one manually viaCreateAlertManagerDefinitionRequest.builder()- Parameters:
createAlertManagerDefinitionRequest- AConsumerthat will call methods onCreateAlertManagerDefinitionRequest.Builderto create a request. Represents the input of aCreateAlertManagerDefinitionoperation.- 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 invokeThrowable.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
CreateLoggingConfigurationoperation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.- Parameters:
createLoggingConfigurationRequest- Represents the input of aCreateLoggingConfigurationoperation.- 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 invokeThrowable.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
CreateLoggingConfigurationoperation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.
This is a convenience which creates an instance of the
CreateLoggingConfigurationRequest.Builderavoiding the need to create one manually viaCreateLoggingConfigurationRequest.builder()- Parameters:
createLoggingConfigurationRequest- AConsumerthat will call methods onCreateLoggingConfigurationRequest.Builderto create a request. Represents the input of aCreateLoggingConfigurationoperation.- 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 invokeThrowable.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
CreateRuleGroupsNamespaceoperation 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 aCreateRuleGroupsNamespaceoperation.- 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 invokeThrowable.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
CreateRuleGroupsNamespaceoperation 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.Builderavoiding the need to create one manually viaCreateRuleGroupsNamespaceRequest.builder()- Parameters:
createRuleGroupsNamespaceRequest- AConsumerthat will call methods onCreateRuleGroupsNamespaceRequest.Builderto create a request. Represents the input of aCreateRuleGroupsNamespaceoperation.- 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 invokeThrowable.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
CreateScraperoperation 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
scrapeConfigurationparameter contains the base-64 encoded YAML configuration for the scraper.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 aCreateScraperoperation.- 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 invokeThrowable.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
CreateScraperoperation 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
scrapeConfigurationparameter contains the base-64 encoded YAML configuration for the scraper.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.Builderavoiding the need to create one manually viaCreateScraperRequest.builder()- Parameters:
createScraperRequest- AConsumerthat will call methods onCreateScraperRequest.Builderto create a request. Represents the input of aCreateScraperoperation.- 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 invokeThrowable.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 aCreateWorkspaceoperation.- 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 invokeThrowable.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.Builderavoiding the need to create one manually viaCreateWorkspaceRequest.builder()- Parameters:
createWorkspaceRequest- AConsumerthat will call methods onCreateWorkspaceRequest.Builderto create a request. Represents the input of aCreateWorkspaceoperation.- 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 invokeThrowable.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 aDeleteAlertManagerDefinitionoperation.- 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 invokeThrowable.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.Builderavoiding the need to create one manually viaDeleteAlertManagerDefinitionRequest.builder()- Parameters:
deleteAlertManagerDefinitionRequest- AConsumerthat will call methods onDeleteAlertManagerDefinitionRequest.Builderto create a request. Represents the input of aDeleteAlertManagerDefinitionoperation.- 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 invokeThrowable.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 logging configuration for a workspace.
- Parameters:
deleteLoggingConfigurationRequest- Represents the input of aDeleteLoggingConfigurationoperation.- 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 invokeThrowable.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 logging configuration for a workspace.
This is a convenience which creates an instance of the
DeleteLoggingConfigurationRequest.Builderavoiding the need to create one manually viaDeleteLoggingConfigurationRequest.builder()- Parameters:
deleteLoggingConfigurationRequest- AConsumerthat will call methods onDeleteLoggingConfigurationRequest.Builderto create a request. Represents the input of aDeleteLoggingConfigurationoperation.- 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 invokeThrowable.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 aDeleteRuleGroupsNamespaceoperation.- 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 invokeThrowable.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.Builderavoiding the need to create one manually viaDeleteRuleGroupsNamespaceRequest.builder()- Parameters:
deleteRuleGroupsNamespaceRequest- AConsumerthat will call methods onDeleteRuleGroupsNamespaceRequest.Builderto create a request. Represents the input of aDeleteRuleGroupsNamespaceoperation.- 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 invokeThrowable.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
DeleteScraperoperation deletes one scraper, and stops any metrics collection that the scraper performs.- Parameters:
deleteScraperRequest- Represents the input of aDeleteScraperoperation.- 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 invokeThrowable.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
DeleteScraperoperation deletes one scraper, and stops any metrics collection that the scraper performs.
This is a convenience which creates an instance of the
DeleteScraperRequest.Builderavoiding the need to create one manually viaDeleteScraperRequest.builder()- Parameters:
deleteScraperRequest- AConsumerthat will call methods onDeleteScraperRequest.Builderto create a request. Represents the input of aDeleteScraperoperation.- 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 invokeThrowable.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 aDeleteWorkspaceoperation.- 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 invokeThrowable.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.Builderavoiding the need to create one manually viaDeleteWorkspaceRequest.builder()- Parameters:
deleteWorkspaceRequest- AConsumerthat will call methods onDeleteWorkspaceRequest.Builderto create a request. Represents the input of aDeleteWorkspaceoperation.- 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 invokeThrowable.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 aDescribeAlertManagerDefinitionoperation.- 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 invokeThrowable.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.Builderavoiding the need to create one manually viaDescribeAlertManagerDefinitionRequest.builder()- Parameters:
describeAlertManagerDefinitionRequest- AConsumerthat will call methods onDescribeAlertManagerDefinitionRequest.Builderto create a request. Represents the input of aDescribeAlertManagerDefinitionoperation.- 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 invokeThrowable.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 logging configuration of the workspace.
- Parameters:
describeLoggingConfigurationRequest- Represents the input of aDescribeLoggingConfigurationoperation.- 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 invokeThrowable.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 logging configuration of the workspace.
This is a convenience which creates an instance of the
DescribeLoggingConfigurationRequest.Builderavoiding the need to create one manually viaDescribeLoggingConfigurationRequest.builder()- Parameters:
describeLoggingConfigurationRequest- AConsumerthat will call methods onDescribeLoggingConfigurationRequest.Builderto create a request. Represents the input of aDescribeLoggingConfigurationoperation.- 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 invokeThrowable.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 aDescribeRuleGroupsNamespaceoperation.- 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 invokeThrowable.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.Builderavoiding the need to create one manually viaDescribeRuleGroupsNamespaceRequest.builder()- Parameters:
describeRuleGroupsNamespaceRequest- AConsumerthat will call methods onDescribeRuleGroupsNamespaceRequest.Builderto create a request. Represents the input of aDescribeRuleGroupsNamespaceoperation.- 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 invokeThrowable.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
DescribeScraperoperation displays information about an existing scraper.- Parameters:
describeScraperRequest- Represents the input of aDescribeScraperoperation.- 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 invokeThrowable.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
DescribeScraperoperation displays information about an existing scraper.
This is a convenience which creates an instance of the
DescribeScraperRequest.Builderavoiding the need to create one manually viaDescribeScraperRequest.builder()- Parameters:
describeScraperRequest- AConsumerthat will call methods onDescribeScraperRequest.Builderto create a request. Represents the input of aDescribeScraperoperation.- 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 invokeThrowable.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 aDescribeWorkspaceoperation.- 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 invokeThrowable.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.Builderavoiding the need to create one manually viaDescribeWorkspaceRequest.builder()- Parameters:
describeWorkspaceRequest- AConsumerthat will call methods onDescribeWorkspaceRequest.Builderto create a request. Represents the input of aDescribeWorkspaceoperation.- 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 invokeThrowable.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
GetDefaultScraperConfigurationoperation returns the default scraper configuration used when Amazon EKS creates a scraper for you.- Parameters:
getDefaultScraperConfigurationRequest- Represents the input of aGetDefaultScraperConfigurationoperation.- 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 invokeThrowable.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
GetDefaultScraperConfigurationoperation 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.Builderavoiding the need to create one manually viaGetDefaultScraperConfigurationRequest.builder()- Parameters:
getDefaultScraperConfigurationRequest- AConsumerthat will call methods onGetDefaultScraperConfigurationRequest.Builderto create a request. Represents the input of aGetDefaultScraperConfigurationoperation.- 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 invokeThrowable.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 aListRuleGroupsNamespacesoperation.- 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 invokeThrowable.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.Builderavoiding the need to create one manually viaListRuleGroupsNamespacesRequest.builder()- Parameters:
listRuleGroupsNamespacesRequest- AConsumerthat will call methods onListRuleGroupsNamespacesRequest.Builderto create a request. Represents the input of aListRuleGroupsNamespacesoperation.- 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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.amp.paginators.ListRuleGroupsNamespacesPublisher publisher = client.listRuleGroupsNamespacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 aListRuleGroupsNamespacesoperation.- 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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.amp.paginators.ListRuleGroupsNamespacesPublisher publisher = client.listRuleGroupsNamespacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListRuleGroupsNamespacesRequest.builder()- Parameters:
listRuleGroupsNamespacesRequest- AConsumerthat will call methods onListRuleGroupsNamespacesRequest.Builderto create a request. Represents the input of aListRuleGroupsNamespacesoperation.- 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 invokeThrowable.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
ListScrapersoperation 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 aListScrapersoperation.- 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 invokeThrowable.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
ListScrapersoperation 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.Builderavoiding the need to create one manually viaListScrapersRequest.builder()- Parameters:
listScrapersRequest- AConsumerthat will call methods onListScrapersRequest.Builderto create a request. Represents the input of aListScrapersoperation.- 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 invokeThrowable.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
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.amp.paginators.ListScrapersPublisher publisher = client.listScrapersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 aListScrapersoperation.- 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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.amp.paginators.ListScrapersPublisher publisher = client.listScrapersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListScrapersRequest.builder()- Parameters:
listScrapersRequest- AConsumerthat will call methods onListScrapersRequest.Builderto create a request. Represents the input of aListScrapersoperation.- 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 invokeThrowable.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
ListTagsForResourceoperation 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 invokeThrowable.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
ListTagsForResourceoperation 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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 invokeThrowable.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 aListWorkspacesoperation.- 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 invokeThrowable.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.Builderavoiding the need to create one manually viaListWorkspacesRequest.builder()- Parameters:
listWorkspacesRequest- AConsumerthat will call methods onListWorkspacesRequest.Builderto create a request. Represents the input of aListWorkspacesoperation.- 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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.amp.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 aListWorkspacesoperation.- 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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.amp.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListWorkspacesRequest.builder()- Parameters:
listWorkspacesRequest- AConsumerthat will call methods onListWorkspacesRequest.Builderto create a request. Represents the input of aListWorkspacesoperation.- 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 invokeThrowable.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 aPutAlertManagerDefinitionoperation.- 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 invokeThrowable.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.Builderavoiding the need to create one manually viaPutAlertManagerDefinitionRequest.builder()- Parameters:
putAlertManagerDefinitionRequest- AConsumerthat will call methods onPutAlertManagerDefinitionRequest.Builderto create a request. Represents the input of aPutAlertManagerDefinitionoperation.- 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 invokeThrowable.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 aPutRuleGroupsNamespaceoperation.- 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 invokeThrowable.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.Builderavoiding the need to create one manually viaPutRuleGroupsNamespaceRequest.builder()- Parameters:
putRuleGroupsNamespaceRequest- AConsumerthat will call methods onPutRuleGroupsNamespaceRequest.Builderto create a request. Represents the input of aPutRuleGroupsNamespaceoperation.- 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 invokeThrowable.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
The
TagResourceoperation 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 invokeThrowable.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
TagResourceoperation 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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 invokeThrowable.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 logging configuration.
- Parameters:
updateLoggingConfigurationRequest- Represents the input of anUpdateLoggingConfigurationoperation.- 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 invokeThrowable.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 logging configuration.
This is a convenience which creates an instance of the
UpdateLoggingConfigurationRequest.Builderavoiding the need to create one manually viaUpdateLoggingConfigurationRequest.builder()- Parameters:
updateLoggingConfigurationRequest- AConsumerthat will call methods onUpdateLoggingConfigurationRequest.Builderto create a request. Represents the input of anUpdateLoggingConfigurationoperation.- 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaUpdateScraperRequest.builder()- Parameters:
updateScraperRequest- AConsumerthat will call methods onUpdateScraperRequest.Builderto 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 invokeThrowable.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 anUpdateWorkspaceAliasoperation.- 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 invokeThrowable.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.Builderavoiding the need to create one manually viaUpdateWorkspaceAliasRequest.builder()- Parameters:
updateWorkspaceAliasRequest- AConsumerthat will call methods onUpdateWorkspaceAliasRequest.Builderto create a request. Represents the input of anUpdateWorkspaceAliasoperation.- 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 invokeThrowable.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
Create an instance ofAmpAsyncWaiterusing 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
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aAmpAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aAmpAsyncClient.
-