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
CreateAlertManagerDefinitionResult	createAlertManagerDefinition(CreateAlertManagerDefinitionRequest createAlertManagerDefinitionRequest) Create an alert manager definition.
CreateLoggingConfigurationResult	createLoggingConfiguration(CreateLoggingConfigurationRequest createLoggingConfigurationRequest) Create logging configuration.
CreateRuleGroupsNamespaceResult	createRuleGroupsNamespace(CreateRuleGroupsNamespaceRequest createRuleGroupsNamespaceRequest) Create a rule group namespace.
CreateWorkspaceResult	createWorkspace(CreateWorkspaceRequest createWorkspaceRequest) Creates a new AMP workspace.
DeleteAlertManagerDefinitionResult	deleteAlertManagerDefinition(DeleteAlertManagerDefinitionRequest deleteAlertManagerDefinitionRequest) Deletes an alert manager definition.
DeleteLoggingConfigurationResult	deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest) Delete logging configuration.
DeleteRuleGroupsNamespaceResult	deleteRuleGroupsNamespace(DeleteRuleGroupsNamespaceRequest deleteRuleGroupsNamespaceRequest) Delete a rule groups namespace.
DeleteWorkspaceResult	deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest) Deletes an AMP workspace.
DescribeAlertManagerDefinitionResult	describeAlertManagerDefinition(DescribeAlertManagerDefinitionRequest describeAlertManagerDefinitionRequest) Describes an alert manager definition.
DescribeLoggingConfigurationResult	describeLoggingConfiguration(DescribeLoggingConfigurationRequest describeLoggingConfigurationRequest) Describes logging configuration.
DescribeRuleGroupsNamespaceResult	describeRuleGroupsNamespace(DescribeRuleGroupsNamespaceRequest describeRuleGroupsNamespaceRequest) Describe a rule groups namespace.
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.
ListRuleGroupsNamespacesResult	listRuleGroupsNamespaces(ListRuleGroupsNamespacesRequest listRuleGroupsNamespacesRequest) Lists rule groups namespaces.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags you have assigned to the resource.
ListWorkspacesResult	listWorkspaces(ListWorkspacesRequest listWorkspacesRequest) Lists all AMP workspaces, including workspaces being created or deleted.
PutAlertManagerDefinitionResult	putAlertManagerDefinition(PutAlertManagerDefinitionRequest putAlertManagerDefinitionRequest) Update an alert manager definition.
PutRuleGroupsNamespaceResult	putRuleGroupsNamespace(PutRuleGroupsNamespaceRequest putRuleGroupsNamespaceRequest) Update a rule groups namespace.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Creates tags for the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Deletes tags from the specified resource.
UpdateLoggingConfigurationResult	updateLoggingConfiguration(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest) Update logging configuration.
UpdateWorkspaceAliasResult	updateWorkspaceAlias(UpdateWorkspaceAliasRequest updateWorkspaceAliasRequest) Updates an AMP workspace alias.
AmazonPrometheusWaiters	waiters()

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

createAlertManagerDefinition

CreateAlertManagerDefinitionResult createAlertManagerDefinition(CreateAlertManagerDefinitionRequest createAlertManagerDefinitionRequest)

Create an alert manager definition.

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

createLoggingConfiguration

CreateLoggingConfigurationResult createLoggingConfiguration(CreateLoggingConfigurationRequest createLoggingConfigurationRequest)

Create logging configuration.

Parameters:

createLoggingConfigurationRequest - Represents the input of a CreateLoggingConfiguration operation.

Returns:

Result of the CreateLoggingConfiguration operation returned by the service.

Throws:

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

createRuleGroupsNamespace

CreateRuleGroupsNamespaceResult createRuleGroupsNamespace(CreateRuleGroupsNamespaceRequest createRuleGroupsNamespaceRequest)

Create a rule group namespace.

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

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

deleteAlertManagerDefinition

DeleteAlertManagerDefinitionResult deleteAlertManagerDefinition(DeleteAlertManagerDefinitionRequest deleteAlertManagerDefinitionRequest)

Deletes an alert manager definition.

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

deleteLoggingConfiguration

DeleteLoggingConfigurationResult deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest)

Delete logging configuration.

Parameters:

deleteLoggingConfigurationRequest - Represents the input of a DeleteLoggingConfiguration operation.

Returns:

Result of the DeleteLoggingConfiguration operation returned by the service.

Throws:

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

DeleteRuleGroupsNamespaceResult deleteRuleGroupsNamespace(DeleteRuleGroupsNamespaceRequest deleteRuleGroupsNamespaceRequest)

Delete a rule groups namespace.

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

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.

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

DescribeAlertManagerDefinitionResult describeAlertManagerDefinition(DescribeAlertManagerDefinitionRequest describeAlertManagerDefinitionRequest)

Describes an alert manager definition.

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

describeLoggingConfiguration

DescribeLoggingConfigurationResult describeLoggingConfiguration(DescribeLoggingConfigurationRequest describeLoggingConfigurationRequest)

Describes logging configuration.

Parameters:

describeLoggingConfigurationRequest - Represents the input of a DescribeLoggingConfiguration operation.

Returns:

Result of the DescribeLoggingConfiguration operation returned by the service.

Throws:

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

DescribeRuleGroupsNamespaceResult describeRuleGroupsNamespace(DescribeRuleGroupsNamespaceRequest describeRuleGroupsNamespaceRequest)

Describe a rule groups namespace.

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

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

listRuleGroupsNamespaces

ListRuleGroupsNamespacesResult listRuleGroupsNamespaces(ListRuleGroupsNamespacesRequest listRuleGroupsNamespacesRequest)

Lists rule groups namespaces.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags you have assigned to the resource.

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

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

putAlertManagerDefinition

PutAlertManagerDefinitionResult putAlertManagerDefinition(PutAlertManagerDefinitionRequest putAlertManagerDefinitionRequest)

Update an alert manager definition.

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

PutRuleGroupsNamespaceResult putRuleGroupsNamespace(PutRuleGroupsNamespaceRequest putRuleGroupsNamespaceRequest)

Update a rule groups namespace.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Creates tags for the specified resource.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Deletes tags from the specified resource.

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

updateLoggingConfiguration

UpdateLoggingConfigurationResult updateLoggingConfiguration(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest)

Update logging configuration.

Parameters:

updateLoggingConfigurationRequest - Represents the input of an UpdateLoggingConfiguration operation.

Returns:

Result of the UpdateLoggingConfiguration operation returned by the service.

Throws:

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

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.

waiters

AmazonPrometheusWaiters waiters()