Interface AmpAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic AmpAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aAmpAsyncClient
.static AmpAsyncClient
create()
Create aAmpAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAlertManagerDefinition
(Consumer<CreateAlertManagerDefinitionRequest.Builder> createAlertManagerDefinitionRequest) TheCreateAlertManagerDefinition
operation creates the alert manager definition in a workspace.createAlertManagerDefinition
(CreateAlertManagerDefinitionRequest createAlertManagerDefinitionRequest) TheCreateAlertManagerDefinition
operation creates the alert manager definition in a workspace.createLoggingConfiguration
(Consumer<CreateLoggingConfigurationRequest.Builder> createLoggingConfigurationRequest) TheCreateLoggingConfiguration
operation creates a logging configuration for the workspace.createLoggingConfiguration
(CreateLoggingConfigurationRequest createLoggingConfigurationRequest) TheCreateLoggingConfiguration
operation creates a logging configuration for the workspace.createRuleGroupsNamespace
(Consumer<CreateRuleGroupsNamespaceRequest.Builder> createRuleGroupsNamespaceRequest) TheCreateRuleGroupsNamespace
operation creates a rule groups namespace within a workspace.createRuleGroupsNamespace
(CreateRuleGroupsNamespaceRequest createRuleGroupsNamespaceRequest) TheCreateRuleGroupsNamespace
operation creates a rule groups namespace within a workspace.default CompletableFuture
<CreateScraperResponse> createScraper
(Consumer<CreateScraperRequest.Builder> createScraperRequest) TheCreateScraper
operation creates a scraper to collect metrics.default CompletableFuture
<CreateScraperResponse> createScraper
(CreateScraperRequest createScraperRequest) TheCreateScraper
operation 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) TheDeleteScraper
operation deletes one scraper, and stops any metrics collection that the scraper performs.default CompletableFuture
<DeleteScraperResponse> deleteScraper
(DeleteScraperRequest deleteScraperRequest) TheDeleteScraper
operation 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) TheDescribeScraper
operation displays information about an existing scraper.default CompletableFuture
<DescribeScraperResponse> describeScraper
(DescribeScraperRequest describeScraperRequest) TheDescribeScraper
operation 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) TheGetDefaultScraperConfiguration
operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.getDefaultScraperConfiguration
(GetDefaultScraperConfigurationRequest getDefaultScraperConfigurationRequest) TheGetDefaultScraperConfiguration
operation 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) TheListScrapers
operation lists all of the scrapers in your account.default CompletableFuture
<ListScrapersResponse> listScrapers
(ListScrapersRequest listScrapersRequest) TheListScrapers
operation lists all of the scrapers in your account.default ListScrapersPublisher
listScrapersPaginator
(Consumer<ListScrapersRequest.Builder> listScrapersRequest) This is a variant oflistScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest)
operation.default ListScrapersPublisher
listScrapersPaginator
(ListScrapersRequest listScrapersRequest) This is a variant oflistScrapers(software.amazon.awssdk.services.amp.model.ListScrapersRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) TheListTagsForResource
operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) TheListTagsForResource
operation 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 ListWorkspacesPublisher
listWorkspacesPaginator
(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest) This is a variant oflistWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest)
operation.default ListWorkspacesPublisher
listWorkspacesPaginator
(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 AmpServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) TheTagResource
operation associates tags with an Amazon Managed Service for Prometheus resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) TheTagResource
operation 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.updateWorkspaceAlias
(Consumer<UpdateWorkspaceAliasRequest.Builder> updateWorkspaceAliasRequest) Updates the alias of an existing workspace.updateWorkspaceAlias
(UpdateWorkspaceAliasRequest updateWorkspaceAliasRequest) Updates the alias of an existing workspace.default AmpAsyncWaiter
waiter()
Create an instance ofAmpAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods 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
CreateAlertManagerDefinition
operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, usePutAlertManagerDefinition
.- Parameters:
createAlertManagerDefinitionRequest
- Represents the input of aCreateAlertManagerDefinition
operation.- Returns:
- A Java Future containing the result of the CreateAlertManagerDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAlertManagerDefinition
default CompletableFuture<CreateAlertManagerDefinitionResponse> createAlertManagerDefinition(Consumer<CreateAlertManagerDefinitionRequest.Builder> createAlertManagerDefinitionRequest) The
CreateAlertManagerDefinition
operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, usePutAlertManagerDefinition
.
This is a convenience which creates an instance of the
CreateAlertManagerDefinitionRequest.Builder
avoiding the need to create one manually viaCreateAlertManagerDefinitionRequest.builder()
- Parameters:
createAlertManagerDefinitionRequest
- AConsumer
that will call methods onCreateAlertManagerDefinitionRequest.Builder
to create a request. Represents the input of aCreateAlertManagerDefinition
operation.- Returns:
- A Java Future containing the result of the CreateAlertManagerDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLoggingConfiguration
default CompletableFuture<CreateLoggingConfigurationResponse> createLoggingConfiguration(CreateLoggingConfigurationRequest createLoggingConfigurationRequest) The
CreateLoggingConfiguration
operation creates 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 aCreateLoggingConfiguration
operation.- Returns:
- A Java Future containing the result of the CreateLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLoggingConfiguration
default CompletableFuture<CreateLoggingConfigurationResponse> createLoggingConfiguration(Consumer<CreateLoggingConfigurationRequest.Builder> createLoggingConfigurationRequest) The
CreateLoggingConfiguration
operation creates 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.Builder
avoiding the need to create one manually viaCreateLoggingConfigurationRequest.builder()
- Parameters:
createLoggingConfigurationRequest
- AConsumer
that will call methods onCreateLoggingConfigurationRequest.Builder
to create a request. Represents the input of aCreateLoggingConfiguration
operation.- Returns:
- A Java Future containing the result of the CreateLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRuleGroupsNamespace
default CompletableFuture<CreateRuleGroupsNamespaceResponse> createRuleGroupsNamespace(CreateRuleGroupsNamespaceRequest createRuleGroupsNamespaceRequest) The
CreateRuleGroupsNamespace
operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use
PutRuleGroupsNamespace
.- Parameters:
createRuleGroupsNamespaceRequest
- Represents the input of aCreateRuleGroupsNamespace
operation.- Returns:
- A Java Future containing the result of the CreateRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRuleGroupsNamespace
default CompletableFuture<CreateRuleGroupsNamespaceResponse> createRuleGroupsNamespace(Consumer<CreateRuleGroupsNamespaceRequest.Builder> createRuleGroupsNamespaceRequest) The
CreateRuleGroupsNamespace
operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use
PutRuleGroupsNamespace
.
This is a convenience which creates an instance of the
CreateRuleGroupsNamespaceRequest.Builder
avoiding the need to create one manually viaCreateRuleGroupsNamespaceRequest.builder()
- Parameters:
createRuleGroupsNamespaceRequest
- AConsumer
that will call methods onCreateRuleGroupsNamespaceRequest.Builder
to create a request. Represents the input of aCreateRuleGroupsNamespace
operation.- Returns:
- A Java Future containing the result of the CreateRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createScraper
default CompletableFuture<CreateScraperResponse> createScraper(CreateScraperRequest createScraperRequest) The
CreateScraper
operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the scraper to control what metrics are collected, and what transformations are applied prior to sending them to your workspace.If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see Using roles for scraping metrics from EKS in the Amazon Managed Service for Prometheus User Guide.
You cannot update a scraper. If you want to change the configuration of the scraper, create a new scraper and delete the old one.
The
scrapeConfiguration
parameter contains the base64-encoded version of the YAML configuration file.For more information about collectors, including what metrics are collected, and how to configure the scraper, see Amazon Web Services managed collectors in the Amazon Managed Service for Prometheus User Guide.
- Parameters:
createScraperRequest
- Represents the input of aCreateScraper
operation.- Returns:
- A Java Future containing the result of the CreateScraper operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createScraper
default CompletableFuture<CreateScraperResponse> createScraper(Consumer<CreateScraperRequest.Builder> createScraperRequest) The
CreateScraper
operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the scraper to control what metrics are collected, and what transformations are applied prior to sending them to your workspace.If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see Using roles for scraping metrics from EKS in the Amazon Managed Service for Prometheus User Guide.
You cannot update a scraper. If you want to change the configuration of the scraper, create a new scraper and delete the old one.
The
scrapeConfiguration
parameter contains the base64-encoded version of the YAML configuration file.For more information about collectors, including what metrics are collected, and how to configure the scraper, see Amazon Web Services managed collectors in the Amazon Managed Service for Prometheus User Guide.
This is a convenience which creates an instance of the
CreateScraperRequest.Builder
avoiding the need to create one manually viaCreateScraperRequest.builder()
- Parameters:
createScraperRequest
- AConsumer
that will call methods onCreateScraperRequest.Builder
to create a request. Represents the input of aCreateScraper
operation.- Returns:
- A Java Future containing the result of the CreateScraper operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aCreateWorkspace
operation.- Returns:
- A Java Future containing the result of the CreateWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWorkspace
default CompletableFuture<CreateWorkspaceResponse> createWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest) Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.
This is a convenience which creates an instance of the
CreateWorkspaceRequest.Builder
avoiding the need to create one manually viaCreateWorkspaceRequest.builder()
- Parameters:
createWorkspaceRequest
- AConsumer
that will call methods onCreateWorkspaceRequest.Builder
to create a request. Represents the input of aCreateWorkspace
operation.- Returns:
- A Java Future containing the result of the CreateWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aDeleteAlertManagerDefinition
operation.- Returns:
- A Java Future containing the result of the DeleteAlertManagerDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAlertManagerDefinition
default CompletableFuture<DeleteAlertManagerDefinitionResponse> deleteAlertManagerDefinition(Consumer<DeleteAlertManagerDefinitionRequest.Builder> deleteAlertManagerDefinitionRequest) Deletes the alert manager definition from a workspace.
This is a convenience which creates an instance of the
DeleteAlertManagerDefinitionRequest.Builder
avoiding the need to create one manually viaDeleteAlertManagerDefinitionRequest.builder()
- Parameters:
deleteAlertManagerDefinitionRequest
- AConsumer
that will call methods onDeleteAlertManagerDefinitionRequest.Builder
to create a request. Represents the input of aDeleteAlertManagerDefinition
operation.- Returns:
- A Java Future containing the result of the DeleteAlertManagerDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aDeleteLoggingConfiguration
operation.- Returns:
- A Java Future containing the result of the DeleteLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.Builder
avoiding the need to create one manually viaDeleteLoggingConfigurationRequest.builder()
- Parameters:
deleteLoggingConfigurationRequest
- AConsumer
that will call methods onDeleteLoggingConfigurationRequest.Builder
to create a request. Represents the input of aDeleteLoggingConfiguration
operation.- Returns:
- A Java Future containing the result of the DeleteLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aDeleteRuleGroupsNamespace
operation.- Returns:
- A Java Future containing the result of the DeleteRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRuleGroupsNamespace
default CompletableFuture<DeleteRuleGroupsNamespaceResponse> deleteRuleGroupsNamespace(Consumer<DeleteRuleGroupsNamespaceRequest.Builder> deleteRuleGroupsNamespaceRequest) Deletes one rule groups namespace and its associated rule groups definition.
This is a convenience which creates an instance of the
DeleteRuleGroupsNamespaceRequest.Builder
avoiding the need to create one manually viaDeleteRuleGroupsNamespaceRequest.builder()
- Parameters:
deleteRuleGroupsNamespaceRequest
- AConsumer
that will call methods onDeleteRuleGroupsNamespaceRequest.Builder
to create a request. Represents the input of aDeleteRuleGroupsNamespace
operation.- Returns:
- A Java Future containing the result of the DeleteRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteScraper
default CompletableFuture<DeleteScraperResponse> deleteScraper(DeleteScraperRequest deleteScraperRequest) The
DeleteScraper
operation deletes one scraper, and stops any metrics collection that the scraper performs.- Parameters:
deleteScraperRequest
- Represents the input of aDeleteScraper
operation.- Returns:
- A Java Future containing the result of the DeleteScraper operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteScraper
default CompletableFuture<DeleteScraperResponse> deleteScraper(Consumer<DeleteScraperRequest.Builder> deleteScraperRequest) The
DeleteScraper
operation deletes one scraper, and stops any metrics collection that the scraper performs.
This is a convenience which creates an instance of the
DeleteScraperRequest.Builder
avoiding the need to create one manually viaDeleteScraperRequest.builder()
- Parameters:
deleteScraperRequest
- AConsumer
that will call methods onDeleteScraperRequest.Builder
to create a request. Represents the input of aDeleteScraper
operation.- Returns:
- A Java Future containing the result of the DeleteScraper operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aDeleteWorkspace
operation.- Returns:
- A Java Future containing the result of the DeleteWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkspace
default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest) Deletes an existing workspace.
When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.
This is a convenience which creates an instance of the
DeleteWorkspaceRequest.Builder
avoiding the need to create one manually viaDeleteWorkspaceRequest.builder()
- Parameters:
deleteWorkspaceRequest
- AConsumer
that will call methods onDeleteWorkspaceRequest.Builder
to create a request. Represents the input of aDeleteWorkspace
operation.- Returns:
- A Java Future containing the result of the DeleteWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aDescribeAlertManagerDefinition
operation.- Returns:
- A Java Future containing the result of the DescribeAlertManagerDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAlertManagerDefinition
default CompletableFuture<DescribeAlertManagerDefinitionResponse> describeAlertManagerDefinition(Consumer<DescribeAlertManagerDefinitionRequest.Builder> describeAlertManagerDefinitionRequest) Retrieves the full information about the alert manager definition for a workspace.
This is a convenience which creates an instance of the
DescribeAlertManagerDefinitionRequest.Builder
avoiding the need to create one manually viaDescribeAlertManagerDefinitionRequest.builder()
- Parameters:
describeAlertManagerDefinitionRequest
- AConsumer
that will call methods onDescribeAlertManagerDefinitionRequest.Builder
to create a request. Represents the input of aDescribeAlertManagerDefinition
operation.- Returns:
- A Java Future containing the result of the DescribeAlertManagerDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aDescribeLoggingConfiguration
operation.- Returns:
- A Java Future containing the result of the DescribeLoggingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.Builder
avoiding the need to create one manually viaDescribeLoggingConfigurationRequest.builder()
- Parameters:
describeLoggingConfigurationRequest
- AConsumer
that will call methods onDescribeLoggingConfigurationRequest.Builder
to create a request. Represents the input of aDescribeLoggingConfiguration
operation.- Returns:
- A Java Future containing the result of the DescribeLoggingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aDescribeRuleGroupsNamespace
operation.- Returns:
- A Java Future containing the result of the DescribeRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRuleGroupsNamespace
default CompletableFuture<DescribeRuleGroupsNamespaceResponse> describeRuleGroupsNamespace(Consumer<DescribeRuleGroupsNamespaceRequest.Builder> describeRuleGroupsNamespaceRequest) Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use
ListRuleGroupsNamespaces
.
This is a convenience which creates an instance of the
DescribeRuleGroupsNamespaceRequest.Builder
avoiding the need to create one manually viaDescribeRuleGroupsNamespaceRequest.builder()
- Parameters:
describeRuleGroupsNamespaceRequest
- AConsumer
that will call methods onDescribeRuleGroupsNamespaceRequest.Builder
to create a request. Represents the input of aDescribeRuleGroupsNamespace
operation.- Returns:
- A Java Future containing the result of the DescribeRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeScraper
default CompletableFuture<DescribeScraperResponse> describeScraper(DescribeScraperRequest describeScraperRequest) The
DescribeScraper
operation displays information about an existing scraper.- Parameters:
describeScraperRequest
- Represents the input of aDescribeScraper
operation.- Returns:
- A Java Future containing the result of the DescribeScraper operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeScraper
default CompletableFuture<DescribeScraperResponse> describeScraper(Consumer<DescribeScraperRequest.Builder> describeScraperRequest) The
DescribeScraper
operation displays information about an existing scraper.
This is a convenience which creates an instance of the
DescribeScraperRequest.Builder
avoiding the need to create one manually viaDescribeScraperRequest.builder()
- Parameters:
describeScraperRequest
- AConsumer
that will call methods onDescribeScraperRequest.Builder
to create a request. Represents the input of aDescribeScraper
operation.- Returns:
- A Java Future containing the result of the DescribeScraper operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aDescribeWorkspace
operation.- Returns:
- A Java Future containing the result of the DescribeWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeWorkspace
default CompletableFuture<DescribeWorkspaceResponse> describeWorkspace(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest) Returns information about an existing workspace.
This is a convenience which creates an instance of the
DescribeWorkspaceRequest.Builder
avoiding the need to create one manually viaDescribeWorkspaceRequest.builder()
- Parameters:
describeWorkspaceRequest
- AConsumer
that will call methods onDescribeWorkspaceRequest.Builder
to create a request. Represents the input of aDescribeWorkspace
operation.- Returns:
- A Java Future containing the result of the DescribeWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDefaultScraperConfiguration
default CompletableFuture<GetDefaultScraperConfigurationResponse> getDefaultScraperConfiguration(GetDefaultScraperConfigurationRequest getDefaultScraperConfigurationRequest) The
GetDefaultScraperConfiguration
operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.- Parameters:
getDefaultScraperConfigurationRequest
- Represents the input of aGetDefaultScraperConfiguration
operation.- Returns:
- A Java Future containing the result of the GetDefaultScraperConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDefaultScraperConfiguration
default CompletableFuture<GetDefaultScraperConfigurationResponse> getDefaultScraperConfiguration(Consumer<GetDefaultScraperConfigurationRequest.Builder> getDefaultScraperConfigurationRequest) The
GetDefaultScraperConfiguration
operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
This is a convenience which creates an instance of the
GetDefaultScraperConfigurationRequest.Builder
avoiding the need to create one manually viaGetDefaultScraperConfigurationRequest.builder()
- Parameters:
getDefaultScraperConfigurationRequest
- AConsumer
that will call methods onGetDefaultScraperConfigurationRequest.Builder
to create a request. Represents the input of aGetDefaultScraperConfiguration
operation.- Returns:
- A Java Future containing the result of the GetDefaultScraperConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aListRuleGroupsNamespaces
operation.- Returns:
- A Java Future containing the result of the ListRuleGroupsNamespaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleGroupsNamespaces
default CompletableFuture<ListRuleGroupsNamespacesResponse> listRuleGroupsNamespaces(Consumer<ListRuleGroupsNamespacesRequest.Builder> listRuleGroupsNamespacesRequest) Returns a list of rule groups namespaces in a workspace.
This is a convenience which creates an instance of the
ListRuleGroupsNamespacesRequest.Builder
avoiding the need to create one manually viaListRuleGroupsNamespacesRequest.builder()
- Parameters:
listRuleGroupsNamespacesRequest
- AConsumer
that will call methods onListRuleGroupsNamespacesRequest.Builder
to create a request. Represents the input of aListRuleGroupsNamespaces
operation.- Returns:
- A Java Future containing the result of the ListRuleGroupsNamespaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amp.paginators.ListRuleGroupsNamespacesPublisher publisher = client.listRuleGroupsNamespacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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 aListRuleGroupsNamespaces
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amp.paginators.ListRuleGroupsNamespacesPublisher publisher = client.listRuleGroupsNamespacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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.Builder
avoiding the need to create one manually viaListRuleGroupsNamespacesRequest.builder()
- Parameters:
listRuleGroupsNamespacesRequest
- AConsumer
that will call methods onListRuleGroupsNamespacesRequest.Builder
to create a request. Represents the input of aListRuleGroupsNamespaces
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listScrapers
default CompletableFuture<ListScrapersResponse> listScrapers(ListScrapersRequest listScrapersRequest) The
ListScrapers
operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.- Parameters:
listScrapersRequest
- Represents the input of aListScrapers
operation.- Returns:
- A Java Future containing the result of the ListScrapers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listScrapers
default CompletableFuture<ListScrapersResponse> listScrapers(Consumer<ListScrapersRequest.Builder> listScrapersRequest) The
ListScrapers
operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.
This is a convenience which creates an instance of the
ListScrapersRequest.Builder
avoiding the need to create one manually viaListScrapersRequest.builder()
- Parameters:
listScrapersRequest
- AConsumer
that will call methods onListScrapersRequest.Builder
to create a request. Represents the input of aListScrapers
operation.- Returns:
- A Java Future containing the result of the ListScrapers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amp.paginators.ListScrapersPublisher publisher = client.listScrapersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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 aListScrapers
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amp.paginators.ListScrapersPublisher publisher = client.listScrapersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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.Builder
avoiding the need to create one manually viaListScrapersRequest.builder()
- Parameters:
listScrapersRequest
- AConsumer
that will call methods onListScrapersRequest.Builder
to create a request. Represents the input of aListScrapers
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) The
ListTagsForResource
operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are 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.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) The
ListTagsForResource
operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are workspaces and rule groups namespaces.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aListWorkspaces
operation.- Returns:
- A Java Future containing the result of the ListWorkspaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkspaces
default CompletableFuture<ListWorkspacesResponse> listWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest) Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.
This is a convenience which creates an instance of the
ListWorkspacesRequest.Builder
avoiding the need to create one manually viaListWorkspacesRequest.builder()
- Parameters:
listWorkspacesRequest
- AConsumer
that will call methods onListWorkspacesRequest.Builder
to create a request. Represents the input of aListWorkspaces
operation.- Returns:
- A Java Future containing the result of the ListWorkspaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amp.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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 aListWorkspaces
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amp.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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.Builder
avoiding the need to create one manually viaListWorkspacesRequest.builder()
- Parameters:
listWorkspacesRequest
- AConsumer
that will call methods onListWorkspacesRequest.Builder
to create a request. Represents the input of aListWorkspaces
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aPutAlertManagerDefinition
operation.- Returns:
- A Java Future containing the result of the PutAlertManagerDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAlertManagerDefinition
default CompletableFuture<PutAlertManagerDefinitionResponse> putAlertManagerDefinition(Consumer<PutAlertManagerDefinitionRequest.Builder> putAlertManagerDefinitionRequest) Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use
CreateAlertManagerDefinition
.
This is a convenience which creates an instance of the
PutAlertManagerDefinitionRequest.Builder
avoiding the need to create one manually viaPutAlertManagerDefinitionRequest.builder()
- Parameters:
putAlertManagerDefinitionRequest
- AConsumer
that will call methods onPutAlertManagerDefinitionRequest.Builder
to create a request. Represents the input of aPutAlertManagerDefinition
operation.- Returns:
- A Java Future containing the result of the PutAlertManagerDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 aPutRuleGroupsNamespace
operation.- Returns:
- A Java Future containing the result of the PutRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRuleGroupsNamespace
default CompletableFuture<PutRuleGroupsNamespaceResponse> putRuleGroupsNamespace(Consumer<PutRuleGroupsNamespaceRequest.Builder> putRuleGroupsNamespaceRequest) Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.
Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use
CreateRuleGroupsNamespace
.You can't use this operation to add tags to an existing rule groups namespace. Instead, use
TagResource
.
This is a convenience which creates an instance of the
PutRuleGroupsNamespaceRequest.Builder
avoiding the need to create one manually viaPutRuleGroupsNamespaceRequest.builder()
- Parameters:
putRuleGroupsNamespaceRequest
- AConsumer
that will call methods onPutRuleGroupsNamespaceRequest.Builder
to create a request. Represents the input of aPutRuleGroupsNamespace
operation.- Returns:
- A Java Future containing the result of the PutRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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
TagResource
operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.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.
- 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.- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) The
TagResource
operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 workspaces and rule groups namespaces.
- 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.- 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 workspaces and rule groups namespaces.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 anUpdateLoggingConfiguration
operation.- Returns:
- A Java Future containing the result of the UpdateLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.Builder
avoiding the need to create one manually viaUpdateLoggingConfigurationRequest.builder()
- Parameters:
updateLoggingConfigurationRequest
- AConsumer
that will call methods onUpdateLoggingConfigurationRequest.Builder
to create a request. Represents the input of anUpdateLoggingConfiguration
operation.- Returns:
- A Java Future containing the result of the UpdateLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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:
-
updateWorkspaceAlias
default CompletableFuture<UpdateWorkspaceAliasResponse> updateWorkspaceAlias(UpdateWorkspaceAliasRequest updateWorkspaceAliasRequest) Updates the alias of an existing workspace.
- Parameters:
updateWorkspaceAliasRequest
- Represents the input of anUpdateWorkspaceAlias
operation.- Returns:
- A Java Future containing the result of the UpdateWorkspaceAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request would cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The request references a resources that doesn't exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException An unexpected error occurred during the processing of the request.
- ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmpException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkspaceAlias
default CompletableFuture<UpdateWorkspaceAliasResponse> updateWorkspaceAlias(Consumer<UpdateWorkspaceAliasRequest.Builder> updateWorkspaceAliasRequest) Updates the alias of an existing workspace.
This is a convenience which creates an instance of the
UpdateWorkspaceAliasRequest.Builder
avoiding the need to create one manually viaUpdateWorkspaceAliasRequest.builder()
- Parameters:
updateWorkspaceAliasRequest
- AConsumer
that will call methods onUpdateWorkspaceAliasRequest.Builder
to create a request. Represents the input of anUpdateWorkspaceAlias
operation.- Returns:
- A Java Future containing the result of the UpdateWorkspaceAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 ofAmpAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
AmpAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aAmpAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAmpAsyncClient
.
-