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

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonPrometheusClientBuilder	builder()
CreateAlertManagerDefinitionResult	createAlertManagerDefinition(CreateAlertManagerDefinitionRequest request) Create an alert manager definition.
CreateRuleGroupsNamespaceResult	createRuleGroupsNamespace(CreateRuleGroupsNamespaceRequest request) Create a rule group namespace.
CreateWorkspaceResult	createWorkspace(CreateWorkspaceRequest request) Creates a new AMP workspace.
DeleteAlertManagerDefinitionResult	deleteAlertManagerDefinition(DeleteAlertManagerDefinitionRequest request) Deletes an alert manager definition.
DeleteRuleGroupsNamespaceResult	deleteRuleGroupsNamespace(DeleteRuleGroupsNamespaceRequest request) Delete a rule groups namespace.
DeleteWorkspaceResult	deleteWorkspace(DeleteWorkspaceRequest request) Deletes an AMP workspace.
DescribeAlertManagerDefinitionResult	describeAlertManagerDefinition(DescribeAlertManagerDefinitionRequest request) Describes an alert manager definition.
DescribeRuleGroupsNamespaceResult	describeRuleGroupsNamespace(DescribeRuleGroupsNamespaceRequest request) Describe a rule groups namespace.
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.
ListRuleGroupsNamespacesResult	listRuleGroupsNamespaces(ListRuleGroupsNamespacesRequest request) Lists rule groups namespaces.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags you have assigned to the resource.
ListWorkspacesResult	listWorkspaces(ListWorkspacesRequest request) Lists all AMP workspaces, including workspaces being created or deleted.
PutAlertManagerDefinitionResult	putAlertManagerDefinition(PutAlertManagerDefinitionRequest request) Update an alert manager definition.
PutRuleGroupsNamespaceResult	putRuleGroupsNamespace(PutRuleGroupsNamespaceRequest request) Update a rule groups namespace.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Creates tags for the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Deletes tags from the specified resource.
UpdateWorkspaceAliasResult	updateWorkspaceAlias(UpdateWorkspaceAliasRequest request) Updates an AMP workspace alias.
AmazonPrometheusWaiters	waiters()

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonPrometheusClientBuilder builder()

createAlertManagerDefinition

public CreateAlertManagerDefinitionResult createAlertManagerDefinition(CreateAlertManagerDefinitionRequest request)

Create an alert manager definition.

Specified by:

createAlertManagerDefinition in interface AmazonPrometheus

Parameters:

createAlertManagerDefinitionRequest - Represents the input of a CreateAlertManagerDefinition operation.

Returns:

Result of the CreateAlertManagerDefinition 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

createRuleGroupsNamespace

public CreateRuleGroupsNamespaceResult createRuleGroupsNamespace(CreateRuleGroupsNamespaceRequest request)

Create a rule group namespace.

Specified by:

createRuleGroupsNamespace in interface AmazonPrometheus

Parameters:

createRuleGroupsNamespaceRequest - Represents the input of a CreateRuleGroupsNamespace operation.

Returns:

Result of the CreateRuleGroupsNamespace 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

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

deleteAlertManagerDefinition

public DeleteAlertManagerDefinitionResult deleteAlertManagerDefinition(DeleteAlertManagerDefinitionRequest request)

Deletes an alert manager definition.

Specified by:

deleteAlertManagerDefinition in interface AmazonPrometheus

Parameters:

deleteAlertManagerDefinitionRequest - Represents the input of a DeleteAlertManagerDefinition operation.

Returns:

Result of the DeleteAlertManagerDefinition 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.

See Also:

AWS API Documentation

deleteRuleGroupsNamespace

public DeleteRuleGroupsNamespaceResult deleteRuleGroupsNamespace(DeleteRuleGroupsNamespaceRequest request)

Delete a rule groups namespace.

Specified by:

deleteRuleGroupsNamespace in interface AmazonPrometheus

Parameters:

deleteRuleGroupsNamespaceRequest - Represents the input of a DeleteRuleGroupsNamespace operation.

Returns:

Result of the DeleteRuleGroupsNamespace 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.

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.

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.

See Also:

AWS API Documentation

describeAlertManagerDefinition

public DescribeAlertManagerDefinitionResult describeAlertManagerDefinition(DescribeAlertManagerDefinitionRequest request)

Describes an alert manager definition.

Specified by:

describeAlertManagerDefinition in interface AmazonPrometheus

Parameters:

describeAlertManagerDefinitionRequest - Represents the input of a DescribeAlertManagerDefinition operation.

Returns:

Result of the DescribeAlertManagerDefinition 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

describeRuleGroupsNamespace

public DescribeRuleGroupsNamespaceResult describeRuleGroupsNamespace(DescribeRuleGroupsNamespaceRequest request)

Describe a rule groups namespace.

Specified by:

describeRuleGroupsNamespace in interface AmazonPrometheus

Parameters:

describeRuleGroupsNamespaceRequest - Represents the input of a DescribeRuleGroupsNamespace operation.

Returns:

Result of the DescribeRuleGroupsNamespace 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

listRuleGroupsNamespaces

public ListRuleGroupsNamespacesResult listRuleGroupsNamespaces(ListRuleGroupsNamespacesRequest request)

Lists rule groups namespaces.

Specified by:

listRuleGroupsNamespaces in interface AmazonPrometheus

Parameters:

listRuleGroupsNamespacesRequest - Represents the input of a ListRuleGroupsNamespaces operation.

Returns:

Result of the ListRuleGroupsNamespaces 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

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags you have assigned to the resource.

Specified by:

listTagsForResource in interface AmazonPrometheus

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource 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

putAlertManagerDefinition

public PutAlertManagerDefinitionResult putAlertManagerDefinition(PutAlertManagerDefinitionRequest request)

Update an alert manager definition.

Specified by:

putAlertManagerDefinition in interface AmazonPrometheus

Parameters:

putAlertManagerDefinitionRequest - Represents the input of a PutAlertManagerDefinition operation.

Returns:

Result of the PutAlertManagerDefinition 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

putRuleGroupsNamespace

public PutRuleGroupsNamespaceResult putRuleGroupsNamespace(PutRuleGroupsNamespaceRequest request)

Update a rule groups namespace.

Specified by:

putRuleGroupsNamespace in interface AmazonPrometheus

Parameters:

putRuleGroupsNamespaceRequest - Represents the input of a PutRuleGroupsNamespace operation.

Returns:

Result of the PutRuleGroupsNamespace 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

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Creates tags for the specified resource.

Specified by:

tagResource in interface AmazonPrometheus

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource 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

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Deletes tags from the specified resource.

Specified by:

untagResource in interface AmazonPrometheus

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource 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

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.

waiters

public AmazonPrometheusWaiters waiters()

Specified by:

waiters in interface AmazonPrometheus

shutdown

public void shutdown()

Description copied from interface: AmazonPrometheus

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.

Specified by:

shutdown in interface AmazonPrometheus

Overrides:

shutdown in class AmazonWebServiceClient