JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

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.managedgrafana

Interface AmazonManagedGrafana

  • All Known Subinterfaces:
    AmazonManagedGrafanaAsync
    All Known Implementing Classes:
    AbstractAmazonManagedGrafana, AbstractAmazonManagedGrafanaAsync, AmazonManagedGrafanaAsyncClient, AmazonManagedGrafanaClient 

    @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonManagedGrafana
    Interface for accessing Amazon Managed Grafana.

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

    Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.

    With Amazon Managed Grafana, you create logically isolated Grafana servers called workspaces. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers.

    • Method Detail

      • createWorkspace

        CreateWorkspaceResult createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)

        Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.

        Don't use CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace.

        Parameters:
        createWorkspaceRequest -
        Returns:
        Result of the CreateWorkspace operation returned by the service.
        Throws:
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ConflictException - A resource was in an inconsistent state during an update or a deletion.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry the request.
        ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
        See Also:
        AWS API Documentation

      • createWorkspaceServiceAccount

        CreateWorkspaceServiceAccountResult createWorkspaceServiceAccount(CreateWorkspaceServiceAccountRequest createWorkspaceServiceAccountRequest)

        Creates a service account for the workspace. A service account can be used to call Grafana HTTP APIs, and run automated workloads. After creating the service account with the correct GrafanaRole for your use case, use CreateWorkspaceServiceAccountToken to create a token that can be used to authenticate and authorize Grafana HTTP API calls.

        You can only create service accounts for workspaces that are compatible with Grafana version 9 and above.

        For more information about service accounts, see Service accounts in the Amazon Managed Grafana User Guide.

        For more information about the Grafana HTTP APIs, see Using Grafana HTTP APIs in the Amazon Managed Grafana User Guide.

        Parameters:
        createWorkspaceServiceAccountRequest -
        Returns:
        Result of the CreateWorkspaceServiceAccount operation returned by the service.
        Throws:
        ResourceNotFoundException - The request references a resource that does not exist.
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ConflictException - A resource was in an inconsistent state during an update or a deletion.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry the request.
        ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
        See Also:
        AWS API Documentation

      • createWorkspaceServiceAccountToken

        CreateWorkspaceServiceAccountTokenResult createWorkspaceServiceAccountToken(CreateWorkspaceServiceAccountTokenRequest createWorkspaceServiceAccountTokenRequest)

        Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account. The service account acts as a user for the API operations, and defines the permissions that are used by the API.

        When you create the service account token, you will receive a key that is used when calling Grafana APIs. Do not lose this key, as it will not be retrievable again.

        If you do lose the key, you can delete the token and recreate it to receive a new key. This will disable the initial key.

        Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

        Parameters:
        createWorkspaceServiceAccountTokenRequest -
        Returns:
        Result of the CreateWorkspaceServiceAccountToken operation returned by the service.
        Throws:
        ResourceNotFoundException - The request references a resource that does not exist.
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ConflictException - A resource was in an inconsistent state during an update or a deletion.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry the request.
        ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
        See Also:
        AWS API Documentation

      • deleteWorkspaceApiKey

        DeleteWorkspaceApiKeyResult deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest deleteWorkspaceApiKeyRequest)

        Deletes a Grafana API key for the workspace.

        In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.

        Parameters:
        deleteWorkspaceApiKeyRequest -
        Returns:
        Result of the DeleteWorkspaceApiKey operation returned by the service.
        Throws:
        ResourceNotFoundException - The request references a resource that does not exist.
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ConflictException - A resource was in an inconsistent state during an update or a deletion.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry the request.
        See Also:
        AWS API Documentation

      • deleteWorkspaceServiceAccount

        DeleteWorkspaceServiceAccountResult deleteWorkspaceServiceAccount(DeleteWorkspaceServiceAccountRequest deleteWorkspaceServiceAccountRequest)

        Deletes a workspace service account from the workspace.

        This will delete any tokens created for the service account, as well. If the tokens are currently in use, the will fail to authenticate / authorize after they are deleted.

        Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

        Parameters:
        deleteWorkspaceServiceAccountRequest -
        Returns:
        Result of the DeleteWorkspaceServiceAccount operation returned by the service.
        Throws:
        ResourceNotFoundException - The request references a resource that does not exist.
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ConflictException - A resource was in an inconsistent state during an update or a deletion.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry the request.
        See Also:
        AWS API Documentation

      • deleteWorkspaceServiceAccountToken

        DeleteWorkspaceServiceAccountTokenResult deleteWorkspaceServiceAccountToken(DeleteWorkspaceServiceAccountTokenRequest deleteWorkspaceServiceAccountTokenRequest)

        Deletes a token for the workspace service account.

        This will disable the key associated with the token. If any automation is currently using the key, it will no longer be authenticated or authorized to perform actions with the Grafana HTTP APIs.

        Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

        Parameters:
        deleteWorkspaceServiceAccountTokenRequest -
        Returns:
        Result of the DeleteWorkspaceServiceAccountToken operation returned by the service.
        Throws:
        ResourceNotFoundException - The request references a resource that does not exist.
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ConflictException - A resource was in an inconsistent state during an update or a deletion.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry the request.
        See Also:
        AWS API Documentation

      • listPermissions

        ListPermissionsResult listPermissions(ListPermissionsRequest listPermissionsRequest)

        Lists the users and groups who have the Grafana Admin and Editor roles in this workspace. If you use this operation without specifying userId or groupId, the operation returns the roles of all users and groups. If you specify a userId or a groupId, only the roles for that user or group are returned. If you do this, you can specify only one userId or one groupId.

        Parameters:
        listPermissionsRequest -
        Returns:
        Result of the ListPermissions operation returned by the service.
        Throws:
        ResourceNotFoundException - The request references a resource that does not exist.
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry the request.
        See Also:
        AWS API Documentation

      • listTagsForResource

        ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

        The ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn. Currently, the only resource that can be tagged is a workspace.

        Parameters:
        listTagsForResourceRequest -
        Returns:
        Result of the ListTagsForResource operation returned by the service.
        Throws:
        ResourceNotFoundException - The request references a resource that does not exist.
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry the request.
        See Also:
        AWS API Documentation

      • listVersions

        ListVersionsResult listVersions(ListVersionsRequest listVersionsRequest)

        Lists available versions of Grafana. These are available when calling CreateWorkspace. Optionally, include a workspace to list the versions to which it can be upgraded.

        Parameters:
        listVersionsRequest -
        Returns:
        Result of the ListVersions operation returned by the service.
        Throws:
        ResourceNotFoundException - The request references a resource that does not exist.
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry the request.
        See Also:
        AWS API Documentation

      • listWorkspaceServiceAccountTokens

        ListWorkspaceServiceAccountTokensResult listWorkspaceServiceAccountTokens(ListWorkspaceServiceAccountTokensRequest listWorkspaceServiceAccountTokensRequest)

        Returns a list of tokens for a workspace service account.

        This does not return the key for each token. You cannot access keys after they are created. To create a new key, delete the token and recreate it.

        Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

        Parameters:
        listWorkspaceServiceAccountTokensRequest -
        Returns:
        Result of the ListWorkspaceServiceAccountTokens operation returned by the service.
        Throws:
        ResourceNotFoundException - The request references a resource that does not exist.
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ConflictException - A resource was in an inconsistent state during an update or a deletion.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry the request.
        See Also:
        AWS API Documentation

      • tagResource

        TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

        The TagResource operation associates tags with an Amazon Managed Grafana resource. Currently, the only resource that can be tagged is workspaces.

        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:
        ResourceNotFoundException - The request references a resource that does not exist.
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry the request.
        See Also:
        AWS API Documentation

      • updateWorkspace

        UpdateWorkspaceResult updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest)

        Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.

        To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center, use UpdateWorkspaceAuthentication.

        To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions.

        Parameters:
        updateWorkspaceRequest -
        Returns:
        Result of the UpdateWorkspace operation returned by the service.
        Throws:
        ResourceNotFoundException - The request references a resource that does not exist.
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ConflictException - A resource was in an inconsistent state during an update or a deletion.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry the request.
        See Also:
        AWS API Documentation

      • updateWorkspaceAuthentication

        UpdateWorkspaceAuthenticationResult updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest)

        Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.

        Changes to the authentication method for a workspace may take a few minutes to take effect.

        Parameters:
        updateWorkspaceAuthenticationRequest -
        Returns:
        Result of the UpdateWorkspaceAuthentication operation returned by the service.
        Throws:
        ResourceNotFoundException - The request references a resource that does not exist.
        ThrottlingException - The request was denied because of request throttling. Retry the request.
        ConflictException - A resource was in an inconsistent state during an update or a deletion.
        ValidationException - The value of a parameter in the request caused an error.
        AccessDeniedException - You do not have sufficient permissions to perform this action.
        InternalServerException - Unexpected error while processing the request. Retry 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 によって変換されたページ (->オリジナル) /