com.amazonaws.services.prometheus

Class AmazonPrometheusClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.prometheus.AmazonPrometheusClient

All Implemented Interfaces:

AmazonPrometheus

Direct Known Subclasses:

AmazonPrometheusAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonPrometheusClient
extends AmazonWebServiceClient
implements AmazonPrometheus

Client for accessing Amazon Prometheus Service. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Managed Service for Prometheus

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.prometheus.AmazonPrometheus

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonPrometheusClientBuilder	builder()
CreateWorkspaceResult	createWorkspace(CreateWorkspaceRequest request) Creates a new AMP workspace.
DeleteWorkspaceResult	deleteWorkspace(DeleteWorkspaceRequest request) Deletes an AMP workspace.
DescribeWorkspaceResult	describeWorkspace(DescribeWorkspaceRequest request) Describes an existing AMP workspace.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListWorkspacesResult	listWorkspaces(ListWorkspacesRequest request) Lists all AMP workspaces, including workspaces being created or deleted.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateWorkspaceAliasResult	updateWorkspaceAlias(UpdateWorkspaceAliasRequest request) Updates an AMP workspace alias.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonPrometheusClientBuilder builder()

createWorkspace

public CreateWorkspaceResult createWorkspace(CreateWorkspaceRequest request)

Creates a new AMP workspace.

Specified by:

createWorkspace in interface AmazonPrometheus

Parameters:

createWorkspaceRequest - Represents the input of a CreateWorkspace operation.

Returns:

Result of the CreateWorkspace operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteWorkspace

public DeleteWorkspaceResult deleteWorkspace(DeleteWorkspaceRequest request)

Deletes an AMP workspace.

Specified by:

deleteWorkspace in interface AmazonPrometheus

Parameters:

deleteWorkspaceRequest - Represents the input of a DeleteWorkspace operation.

Returns:

Result of the DeleteWorkspace operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeWorkspace

public DescribeWorkspaceResult describeWorkspace(DescribeWorkspaceRequest request)

Describes an existing AMP workspace.

Specified by:

describeWorkspace in interface AmazonPrometheus

Parameters:

describeWorkspaceRequest - Represents the input of a DescribeWorkspace operation.

Returns:

Result of the DescribeWorkspace operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listWorkspaces

public ListWorkspacesResult listWorkspaces(ListWorkspacesRequest request)

Lists all AMP workspaces, including workspaces being created or deleted.

Specified by:

listWorkspaces in interface AmazonPrometheus

Parameters:

listWorkspacesRequest - Represents the input of a ListWorkspaces operation.

Returns:

Result of the ListWorkspaces operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateWorkspaceAlias

public UpdateWorkspaceAliasResult updateWorkspaceAlias(UpdateWorkspaceAliasRequest request)

Updates an AMP workspace alias.

Specified by:

updateWorkspaceAlias in interface AmazonPrometheus

Parameters:

updateWorkspaceAliasRequest - Represents the input of an UpdateWorkspaceAlias operation.

Returns:

Result of the UpdateWorkspaceAlias operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonPrometheus

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonPrometheus

Overrides:

shutdown in class AmazonWebServiceClient