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.

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
AssociateLicenseResult	associateLicense(AssociateLicenseRequest associateLicenseRequest) Assigns a Grafana Enterprise license to a workspace.
CreateWorkspaceResult	createWorkspace(CreateWorkspaceRequest createWorkspaceRequest) Creates a workspace.
DeleteWorkspaceResult	deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest) Deletes an Amazon Managed Grafana workspace.
DescribeWorkspaceResult	describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest) Displays information about one Amazon Managed Grafana workspace.
DescribeWorkspaceAuthenticationResult	describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest) Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
DisassociateLicenseResult	disassociateLicense(DisassociateLicenseRequest disassociateLicenseRequest) Removes the Grafana Enterprise license from a 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.
ListPermissionsResult	listPermissions(ListPermissionsRequest listPermissionsRequest) Lists the users and groups who have the Grafana Admin and Editor roles in this workspace.
ListWorkspacesResult	listWorkspaces(ListWorkspacesRequest listWorkspacesRequest) Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdatePermissionsResult	updatePermissions(UpdatePermissionsRequest updatePermissionsRequest) Updates which users in a workspace have the Grafana Admin or Editor roles.
UpdateWorkspaceResult	updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest) Modifies an existing Amazon Managed Grafana workspace.
UpdateWorkspaceAuthenticationResult	updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest) Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.

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

associateLicense

AssociateLicenseResult associateLicense(AssociateLicenseRequest associateLicenseRequest)

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.

Parameters:

associateLicenseRequest -

Returns:

Result of the AssociateLicense 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

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

deleteWorkspace

DeleteWorkspaceResult deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)

Deletes an Amazon Managed Grafana workspace.

Parameters:

deleteWorkspaceRequest -

Returns:

Result of the DeleteWorkspace 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

describeWorkspace

DescribeWorkspaceResult describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest)

Displays information about one Amazon Managed Grafana workspace.

Parameters:

describeWorkspaceRequest -

Returns:

Result of the DescribeWorkspace 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

describeWorkspaceAuthentication

DescribeWorkspaceAuthenticationResult describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest)

Displays information about the authentication methods used in one Amazon Managed Grafana workspace.

Parameters:

describeWorkspaceAuthenticationRequest -

Returns:

Result of the DescribeWorkspaceAuthentication 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

disassociateLicense

DisassociateLicenseResult disassociateLicense(DisassociateLicenseRequest disassociateLicenseRequest)

Removes the Grafana Enterprise license from a workspace.

Parameters:

disassociateLicenseRequest -

Returns:

Result of the DisassociateLicense 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

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

listWorkspaces

ListWorkspacesResult listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)

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.

Parameters:

listWorkspacesRequest -

Returns:

Result of the ListWorkspaces operation returned by the service.

Throws:

ThrottlingException - The request was denied because of request throttling. Retry the request.

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

updatePermissions

UpdatePermissionsResult updatePermissions(UpdatePermissionsRequest updatePermissionsRequest)

Updates which users in a workspace have the Grafana Admin or Editor roles.

Parameters:

updatePermissionsRequest -

Returns:

Result of the UpdatePermissions 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 Amazon Web Services SSO, 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.

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.