AbstractAmazonPrometheus (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.prometheus.AbstractAmazonPrometheus

All Implemented Interfaces:

AmazonPrometheus

Direct Known Subclasses:

AbstractAmazonPrometheusAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonPrometheus
extends Object
implements AmazonPrometheus
```
Abstract implementation of AmazonPrometheus. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.prometheus.AmazonPrometheus
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateAlertManagerDefinitionResult`	`createAlertManagerDefinition(CreateAlertManagerDefinitionRequest request)` The `CreateAlertManagerDefinition` operation creates the alert manager definition in a workspace.
`CreateLoggingConfigurationResult`	`createLoggingConfiguration(CreateLoggingConfigurationRequest request)` The `CreateLoggingConfiguration` operation creates a logging configuration for the workspace.
`CreateRuleGroupsNamespaceResult`	`createRuleGroupsNamespace(CreateRuleGroupsNamespaceRequest request)` The `CreateRuleGroupsNamespace` operation creates a rule groups namespace within a workspace.
`CreateScraperResult`	`createScraper(CreateScraperRequest request)` The `CreateScraper` operation creates a scraper to collect metrics.
`CreateWorkspaceResult`	`createWorkspace(CreateWorkspaceRequest request)` Creates a Prometheus workspace.
`DeleteAlertManagerDefinitionResult`	`deleteAlertManagerDefinition(DeleteAlertManagerDefinitionRequest request)` Deletes the alert manager definition from a workspace.
`DeleteLoggingConfigurationResult`	`deleteLoggingConfiguration(DeleteLoggingConfigurationRequest request)` Deletes the logging configuration for a workspace.
`DeleteRuleGroupsNamespaceResult`	`deleteRuleGroupsNamespace(DeleteRuleGroupsNamespaceRequest request)` Deletes one rule groups namespace and its associated rule groups definition.
`DeleteScraperResult`	`deleteScraper(DeleteScraperRequest request)` The `DeleteScraper` operation deletes one scraper, and stops any metrics collection that the scraper performs.
`DeleteWorkspaceResult`	`deleteWorkspace(DeleteWorkspaceRequest request)` Deletes an existing workspace.
`DescribeAlertManagerDefinitionResult`	`describeAlertManagerDefinition(DescribeAlertManagerDefinitionRequest request)` Retrieves the full information about the alert manager definition for a workspace.
`DescribeLoggingConfigurationResult`	`describeLoggingConfiguration(DescribeLoggingConfigurationRequest request)` Returns complete information about the current logging configuration of the workspace.
`DescribeRuleGroupsNamespaceResult`	`describeRuleGroupsNamespace(DescribeRuleGroupsNamespaceRequest request)` Returns complete information about one rule groups namespace.
`DescribeScraperResult`	`describeScraper(DescribeScraperRequest request)` The `DescribeScraper` operation displays information about an existing scraper.
`DescribeWorkspaceResult`	`describeWorkspace(DescribeWorkspaceRequest request)` Returns information about an existing 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.
`GetDefaultScraperConfigurationResult`	`getDefaultScraperConfiguration(GetDefaultScraperConfigurationRequest request)` The `GetDefaultScraperConfiguration` operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
`ListRuleGroupsNamespacesResult`	`listRuleGroupsNamespaces(ListRuleGroupsNamespacesRequest request)` Returns a list of rule groups namespaces in a workspace.
`ListScrapersResult`	`listScrapers(ListScrapersRequest request)` The `ListScrapers` operation lists all of the scrapers in your account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` The `ListTagsForResource` operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource.
`ListWorkspacesResult`	`listWorkspaces(ListWorkspacesRequest request)` Lists all of the Amazon Managed Service for Prometheus workspaces in your account.
`PutAlertManagerDefinitionResult`	`putAlertManagerDefinition(PutAlertManagerDefinitionRequest request)` Updates an existing alert manager definition in a workspace.
`PutRuleGroupsNamespaceResult`	`putRuleGroupsNamespace(PutRuleGroupsNamespaceRequest request)` Updates an existing rule groups namespace within a workspace.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` The `TagResource` operation associates tags with an Amazon Managed Service for Prometheus resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the specified tags from an Amazon Managed Service for Prometheus resource.
`UpdateLoggingConfigurationResult`	`updateLoggingConfiguration(UpdateLoggingConfigurationRequest request)` Updates the log group ARN or the workspace ID of the current logging configuration.
`UpdateWorkspaceAliasResult`	`updateWorkspaceAlias(UpdateWorkspaceAliasRequest request)` Updates the alias of an existing workspace.
`AmazonPrometheusWaiters`	`waiters()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createAlertManagerDefinition
```
public CreateAlertManagerDefinitionResult createAlertManagerDefinition(CreateAlertManagerDefinitionRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition.
    
    Specified by:
    
    createAlertManagerDefinition in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a CreateAlertManagerDefinition operation.
    
    Returns:
    
    Result of the CreateAlertManagerDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLoggingConfiguration
```
public CreateLoggingConfigurationResult createLoggingConfiguration(CreateLoggingConfigurationRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    The CreateLoggingConfiguration operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.
    
    Specified by:
    
    createLoggingConfiguration in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a CreateLoggingConfiguration operation.
    
    Returns:
    
    Result of the CreateLoggingConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createRuleGroupsNamespace
```
public CreateRuleGroupsNamespaceResult createRuleGroupsNamespace(CreateRuleGroupsNamespaceRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.
    
    Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.
    
    Specified by:
    
    createRuleGroupsNamespace in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a CreateRuleGroupsNamespace operation.
    
    Returns:
    
    Result of the CreateRuleGroupsNamespace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createScraper
```
public CreateScraperResult createScraper(CreateScraperRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the scraper to control what metrics are collected, and what transformations are applied prior to sending them to your workspace.
    
    If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see Using roles for scraping metrics from EKS in the Amazon Managed Service for Prometheus User Guide.
    
    You cannot update a scraper. If you want to change the configuration of the scraper, create a new scraper and delete the old one.
    
    The scrapeConfiguration parameter contains the base64-encoded version of the YAML configuration file.
    
    For more information about collectors, including what metrics are collected, and how to configure the scraper, see Amazon Web Services managed collectors in the Amazon Managed Service for Prometheus User Guide.
    
    Specified by:
    
    createScraper in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a CreateScraper operation.
    
    Returns:
    
    Result of the CreateScraper operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createWorkspace
```
public CreateWorkspaceResult createWorkspace(CreateWorkspaceRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.
    
    Specified by:
    
    createWorkspace in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a CreateWorkspace operation.
    
    Returns:
    
    Result of the CreateWorkspace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAlertManagerDefinition
```
public DeleteAlertManagerDefinitionResult deleteAlertManagerDefinition(DeleteAlertManagerDefinitionRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Deletes the alert manager definition from a workspace.
    
    Specified by:
    
    deleteAlertManagerDefinition in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a DeleteAlertManagerDefinition operation.
    
    Returns:
    
    Result of the DeleteAlertManagerDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteLoggingConfiguration
```
public DeleteLoggingConfigurationResult deleteLoggingConfiguration(DeleteLoggingConfigurationRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Deletes the logging configuration for a workspace.
    
    Specified by:
    
    deleteLoggingConfiguration in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a DeleteLoggingConfiguration operation.
    
    Returns:
    
    Result of the DeleteLoggingConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRuleGroupsNamespace
```
public DeleteRuleGroupsNamespaceResult deleteRuleGroupsNamespace(DeleteRuleGroupsNamespaceRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Deletes one rule groups namespace and its associated rule groups definition.
    
    Specified by:
    
    deleteRuleGroupsNamespace in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a DeleteRuleGroupsNamespace operation.
    
    Returns:
    
    Result of the DeleteRuleGroupsNamespace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteScraper
```
public DeleteScraperResult deleteScraper(DeleteScraperRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.
    
    Specified by:
    
    deleteScraper in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a DeleteScraper operation.
    
    Returns:
    
    Result of the DeleteScraper operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkspace
```
public DeleteWorkspaceResult deleteWorkspace(DeleteWorkspaceRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Deletes an existing workspace.
    
    When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.
    
    Specified by:
    
    deleteWorkspace in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a DeleteWorkspace operation.
    
    Returns:
    
    Result of the DeleteWorkspace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAlertManagerDefinition
```
public DescribeAlertManagerDefinitionResult describeAlertManagerDefinition(DescribeAlertManagerDefinitionRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Retrieves the full information about the alert manager definition for a workspace.
    
    Specified by:
    
    describeAlertManagerDefinition in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a DescribeAlertManagerDefinition operation.
    
    Returns:
    
    Result of the DescribeAlertManagerDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLoggingConfiguration
```
public DescribeLoggingConfigurationResult describeLoggingConfiguration(DescribeLoggingConfigurationRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Returns complete information about the current logging configuration of the workspace.
    
    Specified by:
    
    describeLoggingConfiguration in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a DescribeLoggingConfiguration operation.
    
    Returns:
    
    Result of the DescribeLoggingConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeRuleGroupsNamespace
```
public DescribeRuleGroupsNamespaceResult describeRuleGroupsNamespace(DescribeRuleGroupsNamespaceRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.
    
    Specified by:
    
    describeRuleGroupsNamespace in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a DescribeRuleGroupsNamespace operation.
    
    Returns:
    
    Result of the DescribeRuleGroupsNamespace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeScraper
```
public DescribeScraperResult describeScraper(DescribeScraperRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    The DescribeScraper operation displays information about an existing scraper.
    
    Specified by:
    
    describeScraper in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a DescribeScraper operation.
    
    Returns:
    
    Result of the DescribeScraper operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeWorkspace
```
public DescribeWorkspaceResult describeWorkspace(DescribeWorkspaceRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Returns information about an existing workspace.
    
    Specified by:
    
    describeWorkspace in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a DescribeWorkspace operation.
    
    Returns:
    
    Result of the DescribeWorkspace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDefaultScraperConfiguration
```
public GetDefaultScraperConfigurationResult getDefaultScraperConfiguration(GetDefaultScraperConfigurationRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
    
    Specified by:
    
    getDefaultScraperConfiguration in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a GetDefaultScraperConfiguration operation.
    
    Returns:
    
    Result of the GetDefaultScraperConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRuleGroupsNamespaces
```
public ListRuleGroupsNamespacesResult listRuleGroupsNamespaces(ListRuleGroupsNamespacesRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Returns a list of rule groups namespaces in a workspace.
    
    Specified by:
    
    listRuleGroupsNamespaces in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a ListRuleGroupsNamespaces operation.
    
    Returns:
    
    Result of the ListRuleGroupsNamespaces operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listScrapers
```
public ListScrapersResult listScrapers(ListScrapersRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.
    
    Specified by:
    
    listScrapers in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a ListScrapers operation.
    
    Returns:
    
    Result of the ListScrapers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are workspaces and rule groups namespaces.
    
    Specified by:
    
    listTagsForResource in interface AmazonPrometheus
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWorkspaces
```
public ListWorkspacesResult listWorkspaces(ListWorkspacesRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.
    
    Specified by:
    
    listWorkspaces in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a ListWorkspaces operation.
    
    Returns:
    
    Result of the ListWorkspaces operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putAlertManagerDefinition
```
public PutAlertManagerDefinitionResult putAlertManagerDefinition(PutAlertManagerDefinitionRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition .
    
    Specified by:
    
    putAlertManagerDefinition in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a PutAlertManagerDefinition operation.
    
    Returns:
    
    Result of the PutAlertManagerDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putRuleGroupsNamespace
```
public PutRuleGroupsNamespaceResult putRuleGroupsNamespace(PutRuleGroupsNamespaceRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.
    
    Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace.
    
    You can't use this operation to add tags to an existing rule groups namespace. Instead, use TagResource.
    
    Specified by:
    
    putRuleGroupsNamespace in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of a PutRuleGroupsNamespace operation.
    
    Returns:
    
    Result of the PutRuleGroupsNamespace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.
    
    If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
    
    Specified by:
    
    tagResource in interface AmazonPrometheus
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.
    
    Specified by:
    
    untagResource in interface AmazonPrometheus
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateLoggingConfiguration
```
public UpdateLoggingConfigurationResult updateLoggingConfiguration(UpdateLoggingConfigurationRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Updates the log group ARN or the workspace ID of the current logging configuration.
    
    Specified by:
    
    updateLoggingConfiguration in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of an UpdateLoggingConfiguration operation.
    
    Returns:
    
    Result of the UpdateLoggingConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateWorkspaceAlias
```
public UpdateWorkspaceAliasResult updateWorkspaceAlias(UpdateWorkspaceAliasRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    Updates the alias of an existing workspace.
    
    Specified by:
    
    updateWorkspaceAlias in interface AmazonPrometheus
    
    Parameters:
    
    request - Represents the input of an UpdateWorkspaceAlias operation.
    
    Returns:
    
    Result of the UpdateWorkspaceAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonPrometheus
    
    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.
    
    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

AWS SDK for Java 1.x API Reference - 1.12.780

Class AbstractAmazonPrometheus

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createAlertManagerDefinition

createLoggingConfiguration

createRuleGroupsNamespace

createScraper

createWorkspace

deleteAlertManagerDefinition

deleteLoggingConfiguration

deleteRuleGroupsNamespace

deleteScraper

deleteWorkspace

describeAlertManagerDefinition

describeLoggingConfiguration

describeRuleGroupsNamespace

describeScraper

describeWorkspace

getDefaultScraperConfiguration

listRuleGroupsNamespaces

listScrapers

listTagsForResource

listWorkspaces

putAlertManagerDefinition

putRuleGroupsNamespace

tagResource

untagResource

updateLoggingConfiguration

updateWorkspaceAlias

shutdown

getCachedResponseMetadata

waiters