JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
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 is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor container environments at scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data model and query language that you use today to monitor the performance of your containerized workloads, and also enjoy improved scalability, availability, and security without having to manage the underlying infrastructure.

    For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.

    Amazon Managed Service for Prometheus includes two APIs.

    • Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert managers.

    • Use the Prometheus-compatible API to work within your Prometheus workspace.

    • Method Detail

      • createAlertManagerDefinition

        CreateAlertManagerDefinitionResult createAlertManagerDefinition(CreateAlertManagerDefinitionRequest createAlertManagerDefinitionRequest)

        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.

        Parameters:
        createAlertManagerDefinitionRequest - Represents the input of a CreateAlertManagerDefinition operation.
        Returns:
        Result of the CreateAlertManagerDefinition operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        ConflictException - The request would cause an inconsistent state.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        ResourceNotFoundException - The request references a resources that doesn't exist.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        ServiceQuotaExceededException - Completing the request would cause a service quota to be exceeded.
        See Also:
        AWS API Documentation

      • createLoggingConfiguration

        CreateLoggingConfigurationResult createLoggingConfiguration(CreateLoggingConfigurationRequest createLoggingConfigurationRequest)

        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.

        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 Amazon Web Services service.
        ResourceNotFoundException - The request references a resources that doesn't exist.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        See Also:
        AWS API Documentation

      • createRuleGroupsNamespace

        CreateRuleGroupsNamespaceResult createRuleGroupsNamespace(CreateRuleGroupsNamespaceRequest createRuleGroupsNamespaceRequest)

        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.

        Parameters:
        createRuleGroupsNamespaceRequest - Represents the input of a CreateRuleGroupsNamespace operation.
        Returns:
        Result of the CreateRuleGroupsNamespace operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        ConflictException - The request would cause an inconsistent state.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        ResourceNotFoundException - The request references a resources that doesn't exist.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        ServiceQuotaExceededException - Completing the request would cause a service quota to be exceeded.
        See Also:
        AWS API Documentation

      • createScraper

        CreateScraperResult createScraper(CreateScraperRequest createScraperRequest)

        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.

        Parameters:
        createScraperRequest - Represents the input of a CreateScraper operation.
        Returns:
        Result of the CreateScraper operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        ConflictException - The request would cause an inconsistent state.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        ResourceNotFoundException - The request references a resources that doesn't exist.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        ServiceQuotaExceededException - Completing the request would cause a service quota to be exceeded.
        See Also:
        AWS API Documentation

      • createWorkspace

        CreateWorkspaceResult createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)

        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.

        Parameters:
        createWorkspaceRequest - Represents the input of a CreateWorkspace operation.
        Returns:
        Result of the CreateWorkspace operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        ConflictException - The request would cause an inconsistent state.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        ServiceQuotaExceededException - Completing the request would cause a service quota to be exceeded.
        See Also:
        AWS API Documentation

      • deleteWorkspace

        DeleteWorkspaceResult deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)

        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.

        Parameters:
        deleteWorkspaceRequest - Represents the input of a DeleteWorkspace operation.
        Returns:
        Result of the DeleteWorkspace operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        ConflictException - The request would cause an inconsistent state.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        ResourceNotFoundException - The request references a resources that doesn't exist.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        See Also:
        AWS API Documentation

      • describeRuleGroupsNamespace

        DescribeRuleGroupsNamespaceResult describeRuleGroupsNamespace(DescribeRuleGroupsNamespaceRequest describeRuleGroupsNamespaceRequest)

        Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.

        Parameters:
        describeRuleGroupsNamespaceRequest - Represents the input of a DescribeRuleGroupsNamespace operation.
        Returns:
        Result of the DescribeRuleGroupsNamespace operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        ResourceNotFoundException - The request references a resources that doesn't exist.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        See Also:
        AWS API Documentation

      • getDefaultScraperConfiguration

        GetDefaultScraperConfigurationResult getDefaultScraperConfiguration(GetDefaultScraperConfigurationRequest getDefaultScraperConfigurationRequest)

        The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.

        Parameters:
        getDefaultScraperConfigurationRequest - Represents the input of a GetDefaultScraperConfiguration operation.
        Returns:
        Result of the GetDefaultScraperConfiguration operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        See Also:
        AWS API Documentation

      • listScrapers

        ListScrapersResult listScrapers(ListScrapersRequest listScrapersRequest)

        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.

        Parameters:
        listScrapersRequest - Represents the input of a ListScrapers operation.
        Returns:
        Result of the ListScrapers operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        See Also:
        AWS API Documentation

      • listTagsForResource

        ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

        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.

        Parameters:
        listTagsForResourceRequest -
        Returns:
        Result of the ListTagsForResource operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        ResourceNotFoundException - The request references a resources that doesn't exist.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        See Also:
        AWS API Documentation

      • listWorkspaces

        ListWorkspacesResult listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)

        Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes 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 - The request was denied due to request throttling.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        See Also:
        AWS API Documentation

      • putAlertManagerDefinition

        PutAlertManagerDefinitionResult putAlertManagerDefinition(PutAlertManagerDefinitionRequest putAlertManagerDefinitionRequest)

        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 .

        Parameters:
        putAlertManagerDefinitionRequest - Represents the input of a PutAlertManagerDefinition operation.
        Returns:
        Result of the PutAlertManagerDefinition operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        ConflictException - The request would cause an inconsistent state.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        ResourceNotFoundException - The request references a resources that doesn't exist.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        ServiceQuotaExceededException - Completing the request would cause a service quota to be exceeded.
        See Also:
        AWS API Documentation

      • putRuleGroupsNamespace

        PutRuleGroupsNamespaceResult putRuleGroupsNamespace(PutRuleGroupsNamespaceRequest putRuleGroupsNamespaceRequest)

        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.

        Parameters:
        putRuleGroupsNamespaceRequest - Represents the input of a PutRuleGroupsNamespace operation.
        Returns:
        Result of the PutRuleGroupsNamespace operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        ConflictException - The request would cause an inconsistent state.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        ResourceNotFoundException - The request references a resources that doesn't exist.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        ServiceQuotaExceededException - Completing the request would cause a service quota to be exceeded.
        See Also:
        AWS API Documentation

      • tagResource

        TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

        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.

        Parameters:
        tagResourceRequest -
        Returns:
        Result of the TagResource operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        ResourceNotFoundException - The request references a resources that doesn't exist.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        See Also:
        AWS API Documentation

      • untagResource

        UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

        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.

        Parameters:
        untagResourceRequest -
        Returns:
        Result of the UntagResource operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
        ResourceNotFoundException - The request references a resources that doesn't exist.
        AccessDeniedException - You do not have sufficient access to perform this action.
        InternalServerException - An unexpected error occurred during the processing of the request.
        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.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /