/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.managedgrafana; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.managedgrafana.model.*; /** * Interface for accessing Amazon Managed Grafana. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.managedgrafana.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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonManagedGrafana { /** * 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 RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "grafana"; /** ** Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For * more information, see Upgrade a * workspace to Grafana Enterprise. *
* * @param associateLicenseRequest * @return Result of the AssociateLicense operation returned by the service. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InternalServerException * Unexpected error while processing the request. Retry the request. * @sample AmazonManagedGrafana.AssociateLicense * @see AWS API * Documentation */ AssociateLicenseResult associateLicense(AssociateLicenseRequest associateLicenseRequest); /** ** 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.
*
* Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the * workspace's HTTP API. See https * ://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example * requests. *
* * @param createWorkspaceApiKeyRequest * @return Result of the CreateWorkspaceApiKey operation returned by the service. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InternalServerException * Unexpected error while processing the request. Retry the request. * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. * @sample AmazonManagedGrafana.CreateWorkspaceApiKey * @see AWS * API Documentation */ CreateWorkspaceApiKeyResult createWorkspaceApiKey(CreateWorkspaceApiKeyRequest createWorkspaceApiKeyRequest); /** ** Deletes an Amazon Managed Grafana workspace. *
* * @param deleteWorkspaceRequest * @return Result of the DeleteWorkspace operation returned by the service. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InternalServerException * Unexpected error while processing the request. Retry the request. * @sample AmazonManagedGrafana.DeleteWorkspace * @see AWS API * Documentation */ DeleteWorkspaceResult deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest); /** ** Deletes a Grafana API key for the workspace. *
* * @param deleteWorkspaceApiKeyRequest * @return Result of the DeleteWorkspaceApiKey operation returned by the service. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InternalServerException * Unexpected error while processing the request. Retry the request. * @sample AmazonManagedGrafana.DeleteWorkspaceApiKey * @see AWS * API Documentation */ DeleteWorkspaceApiKeyResult deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest deleteWorkspaceApiKeyRequest); /** ** Displays information about one Amazon Managed Grafana workspace. *
* * @param describeWorkspaceRequest * @return Result of the DescribeWorkspace operation returned by the service. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InternalServerException * Unexpected error while processing the request. Retry the request. * @sample AmazonManagedGrafana.DescribeWorkspace * @see AWS API * Documentation */ DescribeWorkspaceResult describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest); /** ** Displays information about the authentication methods used in one Amazon Managed Grafana workspace. *
* * @param describeWorkspaceAuthenticationRequest * @return Result of the DescribeWorkspaceAuthentication operation returned by the service. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InternalServerException * Unexpected error while processing the request. Retry the request. * @sample AmazonManagedGrafana.DescribeWorkspaceAuthentication * @see AWS API Documentation */ DescribeWorkspaceAuthenticationResult describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest); /** ** Gets the current configuration string for the given workspace. *
* * @param describeWorkspaceConfigurationRequest * @return Result of the DescribeWorkspaceConfiguration operation returned by the service. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InternalServerException * Unexpected error while processing the request. Retry the request. * @sample AmazonManagedGrafana.DescribeWorkspaceConfiguration * @see AWS API Documentation */ DescribeWorkspaceConfigurationResult describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest describeWorkspaceConfigurationRequest); /** ** Removes the Grafana Enterprise license from a workspace. *
* * @param disassociateLicenseRequest * @return Result of the DisassociateLicense operation returned by the service. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InternalServerException * Unexpected error while processing the request. Retry the request. * @sample AmazonManagedGrafana.DisassociateLicense * @see AWS * API Documentation */ DisassociateLicenseResult disassociateLicense(DisassociateLicenseRequest disassociateLicenseRequest); /** *
* 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
.
*
* 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.
*
* 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.
*
* Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. * For more complete information about one workspace, use DescribeWorkspace. *
* * @param listWorkspacesRequest * @return Result of the ListWorkspaces operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InternalServerException * Unexpected error while processing the request. Retry the request. * @sample AmazonManagedGrafana.ListWorkspaces * @see AWS API * Documentation */ ListWorkspacesResult listWorkspaces(ListWorkspacesRequest listWorkspacesRequest); /** *
* 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. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InternalServerException * Unexpected error while processing the request. Retry the request. * @sample AmazonManagedGrafana.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *
* The UntagResource
operation removes the association of the tag with the Amazon Managed Grafana
* resource.
*
* Updates which users in a workspace have the Grafana Admin
or Editor
roles.
*
* 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.
*
* 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. *
** Updates the configuration string for the given workspace *
* * @param updateWorkspaceConfigurationRequest * @return Result of the UpdateWorkspaceConfiguration operation returned by the service. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @throws InternalServerException * Unexpected error while processing the request. Retry the request. * @sample AmazonManagedGrafana.UpdateWorkspaceConfiguration * @see AWS API Documentation */ UpdateWorkspaceConfigurationResult updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest updateWorkspaceConfigurationRequest); /** * 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. */ void shutdown(); /** * 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }