com.amazonaws.services.prometheus

Interface AmazonPrometheus

All Known Subinterfaces:

AmazonPrometheusAsync

All Known Implementing Classes:

AbstractAmazonPrometheus, AbstractAmazonPrometheusAsync, AmazonPrometheusAsyncClient, AmazonPrometheusClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonPrometheus

Interface for accessing Amazon Prometheus Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonPrometheus instead.

Amazon Managed Service for Prometheus

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateWorkspaceResult	createWorkspace(CreateWorkspaceRequest createWorkspaceRequest) Creates a new AMP workspace.
DeleteWorkspaceResult	deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest) Deletes an AMP workspace.
DescribeWorkspaceResult	describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest) 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 listWorkspacesRequest) 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 updateWorkspaceAliasRequest) Updates an AMP workspace alias.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createWorkspace

CreateWorkspaceResult createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)

Creates a new AMP workspace.

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

DeleteWorkspaceResult deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)

Deletes an AMP workspace.

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

DescribeWorkspaceResult describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest)

Describes an existing AMP workspace.

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

ListWorkspacesResult listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)

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

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

UpdateWorkspaceAliasResult updateWorkspaceAlias(UpdateWorkspaceAliasRequest updateWorkspaceAliasRequest)

Updates an AMP workspace alias.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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