com.amazonaws.services.managedgrafana

Class AmazonManagedGrafanaClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.managedgrafana.AmazonManagedGrafanaClient

All Implemented Interfaces:

AmazonManagedGrafana

Direct Known Subclasses:

AmazonManagedGrafanaAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonManagedGrafanaClient
extends AmazonWebServiceClient
implements AmazonManagedGrafana

Client for accessing Amazon Managed Grafana. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.managedgrafana.AmazonManagedGrafana

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateLicenseResult	associateLicense(AssociateLicenseRequest request) Assigns a Grafana Enterprise license to a workspace.
static AmazonManagedGrafanaClientBuilder	builder()
CreateWorkspaceResult	createWorkspace(CreateWorkspaceRequest request) Creates a workspace.
CreateWorkspaceApiKeyResult	createWorkspaceApiKey(CreateWorkspaceApiKeyRequest request) Creates a Grafana API key for the workspace.
DeleteWorkspaceResult	deleteWorkspace(DeleteWorkspaceRequest request) Deletes an Amazon Managed Grafana workspace.
DeleteWorkspaceApiKeyResult	deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest request) Deletes a Grafana API key for the workspace.
DescribeWorkspaceResult	describeWorkspace(DescribeWorkspaceRequest request) Displays information about one Amazon Managed Grafana workspace.
DescribeWorkspaceAuthenticationResult	describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest request) Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
DescribeWorkspaceConfigurationResult	describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest request) Gets the current configuration string for the given workspace.
DisassociateLicenseResult	disassociateLicense(DisassociateLicenseRequest request) 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 request) Lists the users and groups who have the Grafana Admin and Editor roles in this workspace.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) The ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn.
ListWorkspacesResult	listWorkspaces(ListWorkspacesRequest request) 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.
TagResourceResult	tagResource(TagResourceRequest request) The TagResource operation associates tags with an Amazon Managed Grafana resource.
UntagResourceResult	untagResource(UntagResourceRequest request) The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource.
UpdatePermissionsResult	updatePermissions(UpdatePermissionsRequest request) Updates which users in a workspace have the Grafana Admin or Editor roles.
UpdateWorkspaceResult	updateWorkspace(UpdateWorkspaceRequest request) Modifies an existing Amazon Managed Grafana workspace.
UpdateWorkspaceAuthenticationResult	updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest request) Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.
UpdateWorkspaceConfigurationResult	updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest request) Updates the configuration string for the given workspace

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonManagedGrafanaClientBuilder builder()

associateLicense

public AssociateLicenseResult associateLicense(AssociateLicenseRequest request)

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.

Specified by:

associateLicense in interface AmazonManagedGrafana

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

public CreateWorkspaceResult createWorkspace(CreateWorkspaceRequest request)

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.

Specified by:

createWorkspace in interface AmazonManagedGrafana

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

createWorkspaceApiKey

public CreateWorkspaceApiKeyResult createWorkspaceApiKey(CreateWorkspaceApiKeyRequest request)

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.

Specified by:

createWorkspaceApiKey in interface AmazonManagedGrafana

Parameters:

createWorkspaceApiKeyRequest -

Returns:

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

deleteWorkspace

public DeleteWorkspaceResult deleteWorkspace(DeleteWorkspaceRequest request)

Deletes an Amazon Managed Grafana workspace.

Specified by:

deleteWorkspace in interface AmazonManagedGrafana

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

deleteWorkspaceApiKey

public DeleteWorkspaceApiKeyResult deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest request)

Deletes a Grafana API key for the workspace.

Specified by:

deleteWorkspaceApiKey in interface AmazonManagedGrafana

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

describeWorkspace

public DescribeWorkspaceResult describeWorkspace(DescribeWorkspaceRequest request)

Displays information about one Amazon Managed Grafana workspace.

Specified by:

describeWorkspace in interface AmazonManagedGrafana

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

public DescribeWorkspaceAuthenticationResult describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest request)

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

Specified by:

describeWorkspaceAuthentication in interface AmazonManagedGrafana

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

describeWorkspaceConfiguration

public DescribeWorkspaceConfigurationResult describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest request)

Gets the current configuration string for the given workspace.

Specified by:

describeWorkspaceConfiguration in interface AmazonManagedGrafana

Parameters:

describeWorkspaceConfigurationRequest -

Returns:

Result of the DescribeWorkspaceConfiguration 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.

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

public DisassociateLicenseResult disassociateLicense(DisassociateLicenseRequest request)

Removes the Grafana Enterprise license from a workspace.

Specified by:

disassociateLicense in interface AmazonManagedGrafana

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

public ListPermissionsResult listPermissions(ListPermissionsRequest request)

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.

Specified by:

listPermissions in interface AmazonManagedGrafana

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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.

Specified by:

listTagsForResource in interface AmazonManagedGrafana

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

listWorkspaces

public ListWorkspacesResult listWorkspaces(ListWorkspacesRequest request)

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.

Specified by:

listWorkspaces in interface AmazonManagedGrafana

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

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AmazonManagedGrafana

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

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource.

Specified by:

untagResource in interface AmazonManagedGrafana

Parameters:

untagResourceRequest -

Returns:

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

updatePermissions

public UpdatePermissionsResult updatePermissions(UpdatePermissionsRequest request)

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

Specified by:

updatePermissions in interface AmazonManagedGrafana

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

public UpdateWorkspaceResult updateWorkspace(UpdateWorkspaceRequest request)

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.

Specified by:

updateWorkspace in interface AmazonManagedGrafana

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

public UpdateWorkspaceAuthenticationResult updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest request)

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.

Specified by:

updateWorkspaceAuthentication in interface AmazonManagedGrafana

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

updateWorkspaceConfiguration

public UpdateWorkspaceConfigurationResult updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest request)

Updates the configuration string for the given workspace

Specified by:

updateWorkspaceConfiguration in interface AmazonManagedGrafana

Parameters:

updateWorkspaceConfigurationRequest -

Returns:

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonManagedGrafana

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonManagedGrafana

Overrides:

shutdown in class AmazonWebServiceClient