Interface AmpAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Managed Service for Prometheus
-
Field Summary
FieldsModifier 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) Create an alert manager definition.createAlertManagerDefinition
(CreateAlertManagerDefinitionRequest createAlertManagerDefinitionRequest) Create an alert manager definition.createLoggingConfiguration
(Consumer<CreateLoggingConfigurationRequest.Builder> createLoggingConfigurationRequest) Create logging configuration.createLoggingConfiguration
(CreateLoggingConfigurationRequest createLoggingConfigurationRequest) Create logging configuration.createRuleGroupsNamespace
(Consumer<CreateRuleGroupsNamespaceRequest.Builder> createRuleGroupsNamespaceRequest) Create a rule group namespace.createRuleGroupsNamespace
(CreateRuleGroupsNamespaceRequest createRuleGroupsNamespaceRequest) Create a rule group namespace.default CompletableFuture
<CreateWorkspaceResponse> createWorkspace
(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest) Creates a new AMP workspace.default CompletableFuture
<CreateWorkspaceResponse> createWorkspace
(CreateWorkspaceRequest createWorkspaceRequest) Creates a new AMP workspace.deleteAlertManagerDefinition
(Consumer<DeleteAlertManagerDefinitionRequest.Builder> deleteAlertManagerDefinitionRequest) Deletes an alert manager definition.deleteAlertManagerDefinition
(DeleteAlertManagerDefinitionRequest deleteAlertManagerDefinitionRequest) Deletes an alert manager definition.deleteLoggingConfiguration
(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest) Delete logging configuration.deleteLoggingConfiguration
(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest) Delete logging configuration.deleteRuleGroupsNamespace
(Consumer<DeleteRuleGroupsNamespaceRequest.Builder> deleteRuleGroupsNamespaceRequest) Delete a rule groups namespace.deleteRuleGroupsNamespace
(DeleteRuleGroupsNamespaceRequest deleteRuleGroupsNamespaceRequest) Delete a rule groups namespace.default CompletableFuture
<DeleteWorkspaceResponse> deleteWorkspace
(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest) Deletes an AMP workspace.default CompletableFuture
<DeleteWorkspaceResponse> deleteWorkspace
(DeleteWorkspaceRequest deleteWorkspaceRequest) Deletes an AMP workspace.describeAlertManagerDefinition
(Consumer<DescribeAlertManagerDefinitionRequest.Builder> describeAlertManagerDefinitionRequest) Describes an alert manager definition.describeAlertManagerDefinition
(DescribeAlertManagerDefinitionRequest describeAlertManagerDefinitionRequest) Describes an alert manager definition.describeLoggingConfiguration
(Consumer<DescribeLoggingConfigurationRequest.Builder> describeLoggingConfigurationRequest) Describes logging configuration.describeLoggingConfiguration
(DescribeLoggingConfigurationRequest describeLoggingConfigurationRequest) Describes logging configuration.describeRuleGroupsNamespace
(Consumer<DescribeRuleGroupsNamespaceRequest.Builder> describeRuleGroupsNamespaceRequest) Describe a rule groups namespace.describeRuleGroupsNamespace
(DescribeRuleGroupsNamespaceRequest describeRuleGroupsNamespaceRequest) Describe a rule groups namespace.describeWorkspace
(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest) Describes an existing AMP workspace.describeWorkspace
(DescribeWorkspaceRequest describeWorkspaceRequest) Describes an existing AMP workspace.listRuleGroupsNamespaces
(Consumer<ListRuleGroupsNamespacesRequest.Builder> listRuleGroupsNamespacesRequest) Lists rule groups namespaces.listRuleGroupsNamespaces
(ListRuleGroupsNamespacesRequest listRuleGroupsNamespacesRequest) Lists rule groups namespaces.listRuleGroupsNamespacesPaginator
(Consumer<ListRuleGroupsNamespacesRequest.Builder> listRuleGroupsNamespacesRequest) Lists rule groups namespaces.listRuleGroupsNamespacesPaginator
(ListRuleGroupsNamespacesRequest listRuleGroupsNamespacesRequest) Lists rule groups namespaces.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags you have assigned to the resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags you have assigned to the resource.default CompletableFuture
<ListWorkspacesResponse> listWorkspaces
(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest) Lists all AMP workspaces, including workspaces being created or deleted.default CompletableFuture
<ListWorkspacesResponse> listWorkspaces
(ListWorkspacesRequest listWorkspacesRequest) Lists all AMP workspaces, including workspaces being created or deleted.default ListWorkspacesPublisher
listWorkspacesPaginator
(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest) Lists all AMP workspaces, including workspaces being created or deleted.default ListWorkspacesPublisher
listWorkspacesPaginator
(ListWorkspacesRequest listWorkspacesRequest) Lists all AMP workspaces, including workspaces being created or deleted.putAlertManagerDefinition
(Consumer<PutAlertManagerDefinitionRequest.Builder> putAlertManagerDefinitionRequest) Update an alert manager definition.putAlertManagerDefinition
(PutAlertManagerDefinitionRequest putAlertManagerDefinitionRequest) Update an alert manager definition.putRuleGroupsNamespace
(Consumer<PutRuleGroupsNamespaceRequest.Builder> putRuleGroupsNamespaceRequest) Update a rule groups namespace.putRuleGroupsNamespace
(PutRuleGroupsNamespaceRequest putRuleGroupsNamespaceRequest) Update a rule groups namespace.default AmpServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates tags for the specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Creates tags for the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes tags from the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Deletes tags from the specified resource.updateLoggingConfiguration
(Consumer<UpdateLoggingConfigurationRequest.Builder> updateLoggingConfigurationRequest) Update logging configuration.updateLoggingConfiguration
(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest) Update logging configuration.updateWorkspaceAlias
(Consumer<UpdateWorkspaceAliasRequest.Builder> updateWorkspaceAliasRequest) Updates an AMP workspace alias.updateWorkspaceAlias
(UpdateWorkspaceAliasRequest updateWorkspaceAliasRequest) Updates an AMP workspace alias.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) Create an alert manager definition.
- Parameters:
createAlertManagerDefinitionRequest
- Represents the input of a CreateAlertManagerDefinition operation.- Returns:
- A Java Future containing the result of the CreateAlertManagerDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- ServiceQuotaExceededException 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) Create an alert manager definition.
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 a CreateAlertManagerDefinition operation.- Returns:
- A Java Future containing the result of the CreateAlertManagerDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- ServiceQuotaExceededException 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) Create logging configuration.
- Parameters:
createLoggingConfigurationRequest
- Represents the input of a CreateLoggingConfiguration operation.- Returns:
- A Java Future containing the result of the CreateLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Create logging configuration.
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 a CreateLoggingConfiguration operation.- Returns:
- A Java Future containing the result of the CreateLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Create a rule group namespace.
- Parameters:
createRuleGroupsNamespaceRequest
- Represents the input of a CreateRuleGroupsNamespace operation.- Returns:
- A Java Future containing the result of the CreateRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- ServiceQuotaExceededException 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) Create a rule group namespace.
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 a CreateRuleGroupsNamespace operation.- Returns:
- A Java Future containing the result of the CreateRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- ServiceQuotaExceededException 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 new AMP workspace.
- Parameters:
createWorkspaceRequest
- Represents the input of a CreateWorkspace operation.- Returns:
- A Java Future containing the result of the CreateWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- ServiceQuotaExceededException 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 new AMP workspace.
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 a CreateWorkspace operation.- Returns:
- A Java Future containing the result of the CreateWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- ServiceQuotaExceededException 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 an alert manager definition.
- Parameters:
deleteAlertManagerDefinitionRequest
- Represents the input of a DeleteAlertManagerDefinition operation.- Returns:
- A Java Future containing the result of the DeleteAlertManagerDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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 an alert manager definition.
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 a DeleteAlertManagerDefinition operation.- Returns:
- A Java Future containing the result of the DeleteAlertManagerDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Delete logging configuration.
- Parameters:
deleteLoggingConfigurationRequest
- Represents the input of a DeleteLoggingConfiguration operation.- Returns:
- A Java Future containing the result of the DeleteLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Delete logging configuration.
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 a DeleteLoggingConfiguration operation.- Returns:
- A Java Future containing the result of the DeleteLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Delete a rule groups namespace.
- Parameters:
deleteRuleGroupsNamespaceRequest
- Represents the input of a DeleteRuleGroupsNamespace operation.- Returns:
- A Java Future containing the result of the DeleteRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Delete a rule groups namespace.
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 a DeleteRuleGroupsNamespace operation.- Returns:
- A Java Future containing the result of the DeleteRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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 AMP workspace.
- Parameters:
deleteWorkspaceRequest
- Represents the input of a DeleteWorkspace operation.- Returns:
- A Java Future containing the result of the DeleteWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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 AMP workspace.
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 a DeleteWorkspace operation.- Returns:
- A Java Future containing the result of the DeleteWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Describes an alert manager definition.
- Parameters:
describeAlertManagerDefinitionRequest
- Represents the input of a DescribeAlertManagerDefinition operation.- Returns:
- A Java Future containing the result of the DescribeAlertManagerDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Describes an alert manager definition.
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 a DescribeAlertManagerDefinition operation.- Returns:
- A Java Future containing the result of the DescribeAlertManagerDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Describes logging configuration.
- Parameters:
describeLoggingConfigurationRequest
- Represents the input of a DescribeLoggingConfiguration operation.- Returns:
- A Java Future containing the result of the DescribeLoggingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Describes logging configuration.
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 a DescribeLoggingConfiguration operation.- Returns:
- A Java Future containing the result of the DescribeLoggingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Describe a rule groups namespace.
- Parameters:
describeRuleGroupsNamespaceRequest
- Represents the input of a DescribeRuleGroupsNamespace operation.- Returns:
- A Java Future containing the result of the DescribeRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Describe a rule groups namespace.
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 a DescribeRuleGroupsNamespace operation.- Returns:
- A Java Future containing the result of the DescribeRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Describes an existing AMP workspace.
- Parameters:
describeWorkspaceRequest
- Represents the input of a DescribeWorkspace operation.- Returns:
- A Java Future containing the result of the DescribeWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Describes an existing AMP 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 a DescribeWorkspace operation.- Returns:
- A Java Future containing the result of the DescribeWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Lists rule groups namespaces.
- Parameters:
listRuleGroupsNamespacesRequest
- Represents the input of a ListRuleGroupsNamespaces operation.- Returns:
- A Java Future containing the result of the ListRuleGroupsNamespaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Lists rule groups namespaces.
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 a ListRuleGroupsNamespaces operation.- Returns:
- A Java Future containing the result of the ListRuleGroupsNamespaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Lists rule groups namespaces.
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 a ListRuleGroupsNamespaces operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Lists rule groups namespaces.
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 a ListRuleGroupsNamespaces operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Lists the tags you have assigned to the resource.
- 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 Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Lists the tags you have assigned to the resource.
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 Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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 AMP workspaces, including workspaces being created or deleted.
- Parameters:
listWorkspacesRequest
- Represents the input of a ListWorkspaces operation.- Returns:
- A Java Future containing the result of the ListWorkspaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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 AMP workspaces, including 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 a ListWorkspaces operation.- Returns:
- A Java Future containing the result of the ListWorkspaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Lists all AMP workspaces, including workspaces being created or deleted.
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 a ListWorkspaces operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Lists all AMP workspaces, including workspaces being created or deleted.
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 a ListWorkspaces operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Update an alert manager definition.
- Parameters:
putAlertManagerDefinitionRequest
- Represents the input of a PutAlertManagerDefinition operation.- Returns:
- A Java Future containing the result of the PutAlertManagerDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- ServiceQuotaExceededException 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) Update an alert manager definition.
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 a PutAlertManagerDefinition operation.- Returns:
- A Java Future containing the result of the PutAlertManagerDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- ServiceQuotaExceededException 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) Update a rule groups namespace.
- Parameters:
putRuleGroupsNamespaceRequest
- Represents the input of a PutRuleGroupsNamespace operation.- Returns:
- A Java Future containing the result of the PutRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- ServiceQuotaExceededException 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) Update a rule groups namespace.
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 a PutRuleGroupsNamespace operation.- Returns:
- A Java Future containing the result of the PutRuleGroupsNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- ServiceQuotaExceededException 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
Creates tags for the specified resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Creates tags for the specified resource.
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 Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Deletes tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Deletes tags from the specified resource.
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 Request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Update logging configuration.
- Parameters:
updateLoggingConfigurationRequest
- Represents the input of an UpdateLoggingConfiguration operation.- Returns:
- A Java Future containing the result of the UpdateLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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) Update 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 an UpdateLoggingConfiguration operation.- Returns:
- A Java Future containing the result of the UpdateLoggingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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 an AMP workspace alias.
- Parameters:
updateWorkspaceAliasRequest
- Represents the input of an UpdateWorkspaceAlias operation.- Returns:
- A Java Future containing the result of the UpdateWorkspaceAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- ServiceQuotaExceededException 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 an AMP workspace alias.
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 an UpdateWorkspaceAlias operation.- Returns:
- A Java Future containing the result of the UpdateWorkspaceAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException Request references a resource which does not exist.
- AccessDeniedException User does not have sufficient access to perform this action.
- InternalServerException Unexpected error during processing of request.
- ServiceQuotaExceededException 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
.
-