software.amazon.awssdk.services.amp

Interface AmpAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface AmpAsyncClient
extends SdkClient

Service client for accessing Amazon Prometheus Service asynchronously. This can be created using the static builder() method.

Amazon Managed Service for Prometheus

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static AmpAsyncClientBuilder	builder() Create a builder that can be used to configure and create a AmpAsyncClient.
static AmpAsyncClient	create() Create a AmpAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateWorkspaceResponse>	createWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest) Creates a new AMP workspace.
default CompletableFuture<CreateWorkspaceResponse>	createWorkspace(CreateWorkspaceRequest createWorkspaceRequest) Creates a new AMP workspace.
default CompletableFuture<DeleteWorkspaceResponse>	deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest) Deletes an AMP workspace.
default CompletableFuture<DeleteWorkspaceResponse>	deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest) Deletes an AMP workspace.
default CompletableFuture<DescribeWorkspaceResponse>	describeWorkspace(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest) Describes an existing AMP workspace.
default CompletableFuture<DescribeWorkspaceResponse>	describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest) Describes an existing AMP workspace.
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.
default CompletableFuture<UpdateWorkspaceAliasResponse>	updateWorkspaceAlias(Consumer<UpdateWorkspaceAliasRequest.Builder> updateWorkspaceAliasRequest) Updates an AMP workspace alias.
default CompletableFuture<UpdateWorkspaceAliasResponse>	updateWorkspaceAlias(UpdateWorkspaceAliasRequest updateWorkspaceAliasRequest) Updates an AMP workspace alias.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

create

static AmpAsyncClient create()

Create a AmpAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static AmpAsyncClientBuilder builder()

Create a builder that can be used to configure and create a AmpAsyncClient.

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:

AWS API Documentation

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 via CreateWorkspaceRequest.builder()

Parameters:

createWorkspaceRequest - A Consumer that will call methods on CreateWorkspaceRequest.Builder to create a request. Represents the input of a CreateWorkspace operation.

Returns:

A Java Future containing the result of the CreateWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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:

AWS API Documentation

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

AWS API Documentation

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 via DeleteWorkspaceRequest.builder()

Parameters:

deleteWorkspaceRequest - A Consumer that will call methods on DeleteWorkspaceRequest.Builder to create a request. Represents the input of a DeleteWorkspace operation.

Returns:

A Java Future containing the result of the DeleteWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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:

AWS API Documentation

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:

AWS API Documentation

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 via DescribeWorkspaceRequest.builder()

Parameters:

describeWorkspaceRequest - A Consumer that will call methods on DescribeWorkspaceRequest.Builder to create a request. Represents the input of a DescribeWorkspace operation.

Returns:

A Java Future containing the result of the DescribeWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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:

AWS API Documentation

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:

AWS API Documentation

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 via ListWorkspacesRequest.builder()

Parameters:

listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request. Represents the input of a ListWorkspaces operation.

Returns:

A Java Future containing the result of the ListWorkspaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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:

AWS API Documentation

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 new Subscription i.e., a new contract to stream data from the starting request.

The following are few ways to use the response class:

1) Using the subscribe helper method

 
 software.amazon.awssdk.services.amp.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 

2) Using a custom subscriber

 
 software.amazon.awssdk.services.amp.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amp.model.ListWorkspacesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.amp.model.ListWorkspacesResponse response) { //... };
 });
 

As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

Note: If you prefer to have control on service calls, use the listWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest) operation.

Parameters:

listWorkspacesRequest - Represents the input of a ListWorkspaces operation.

Returns:

A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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:

AWS API Documentation

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 new Subscription i.e., a new contract to stream data from the starting request.

The following are few ways to use the response class:

1) Using the subscribe helper method

 
 software.amazon.awssdk.services.amp.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 

2) Using a custom subscriber

 
 software.amazon.awssdk.services.amp.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amp.model.ListWorkspacesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.amp.model.ListWorkspacesResponse response) { //... };
 });
 

As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

Note: If you prefer to have control on service calls, use the listWorkspaces(software.amazon.awssdk.services.amp.model.ListWorkspacesRequest) operation.

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

Parameters:

listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request. Represents the input of a ListWorkspaces operation.

Returns:

A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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:

AWS API Documentation

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:

AWS API Documentation

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 via UpdateWorkspaceAliasRequest.builder()

Parameters:

updateWorkspaceAliasRequest - A Consumer that will call methods on UpdateWorkspaceAliasRequest.Builder to create a request. Represents the input of an UpdateWorkspaceAlias operation.

Returns:

A Java Future containing the result of the UpdateWorkspaceAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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:

AWS API Documentation