com.amazonaws.services.managedgrafana

Class AbstractAmazonManagedGrafana

java.lang.Object

com.amazonaws.services.managedgrafana.AbstractAmazonManagedGrafana

All Implemented Interfaces:

AmazonManagedGrafana

Direct Known Subclasses:

AbstractAmazonManagedGrafanaAsync

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

Abstract implementation of AmazonManagedGrafana. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

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.
CreateWorkspaceResult	createWorkspace(CreateWorkspaceRequest request) Creates a workspace.
DeleteWorkspaceResult	deleteWorkspace(DeleteWorkspaceRequest request) Deletes an Amazon Managed Grafana 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.
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.
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.
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.

Methods inherited from class java.lang.Object

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

Method Detail

associateLicense

public AssociateLicenseResult associateLicense(AssociateLicenseRequest request)

Description copied from interface: AmazonManagedGrafana

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

Returns:

Result of the AssociateLicense operation returned by the service.

See Also:

AWS API Documentation

createWorkspace

public CreateWorkspaceResult createWorkspace(CreateWorkspaceRequest request)

Description copied from interface: AmazonManagedGrafana

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

Returns:

Result of the CreateWorkspace operation returned by the service.

See Also:

AWS API Documentation

deleteWorkspace

public DeleteWorkspaceResult deleteWorkspace(DeleteWorkspaceRequest request)

Description copied from interface: AmazonManagedGrafana

Deletes an Amazon Managed Grafana workspace.

Specified by:

deleteWorkspace in interface AmazonManagedGrafana

Returns:

Result of the DeleteWorkspace operation returned by the service.

See Also:

AWS API Documentation

describeWorkspace

public DescribeWorkspaceResult describeWorkspace(DescribeWorkspaceRequest request)

Description copied from interface: AmazonManagedGrafana

Displays information about one Amazon Managed Grafana workspace.

Specified by:

describeWorkspace in interface AmazonManagedGrafana

Returns:

Result of the DescribeWorkspace operation returned by the service.

See Also:

AWS API Documentation

describeWorkspaceAuthentication

public DescribeWorkspaceAuthenticationResult describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest request)

Description copied from interface: AmazonManagedGrafana

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

Specified by:

describeWorkspaceAuthentication in interface AmazonManagedGrafana

Returns:

Result of the DescribeWorkspaceAuthentication operation returned by the service.

See Also:

AWS API Documentation

disassociateLicense

public DisassociateLicenseResult disassociateLicense(DisassociateLicenseRequest request)

Description copied from interface: AmazonManagedGrafana

Removes the Grafana Enterprise license from a workspace.

Specified by:

disassociateLicense in interface AmazonManagedGrafana

Returns:

Result of the DisassociateLicense operation returned by the service.

See Also:

AWS API Documentation

listPermissions

public ListPermissionsResult listPermissions(ListPermissionsRequest request)

Description copied from interface: AmazonManagedGrafana

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

Returns:

Result of the ListPermissions operation returned by the service.

See Also:

AWS API Documentation

listWorkspaces

public ListWorkspacesResult listWorkspaces(ListWorkspacesRequest request)

Description copied from interface: AmazonManagedGrafana

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

Returns:

Result of the ListWorkspaces operation returned by the service.

See Also:

AWS API Documentation

updatePermissions

public UpdatePermissionsResult updatePermissions(UpdatePermissionsRequest request)

Description copied from interface: AmazonManagedGrafana

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

Specified by:

updatePermissions in interface AmazonManagedGrafana

Returns:

Result of the UpdatePermissions operation returned by the service.

See Also:

AWS API Documentation

updateWorkspace

public UpdateWorkspaceResult updateWorkspace(UpdateWorkspaceRequest request)

Description copied from interface: AmazonManagedGrafana

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.

Specified by:

updateWorkspace in interface AmazonManagedGrafana

Returns:

Result of the UpdateWorkspace operation returned by the service.

See Also:

AWS API Documentation

updateWorkspaceAuthentication

public UpdateWorkspaceAuthenticationResult updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest request)

Description copied from interface: AmazonManagedGrafana

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

Returns:

Result of the UpdateWorkspaceAuthentication operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonManagedGrafana

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.

Specified by:

shutdown in interface AmazonManagedGrafana

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonManagedGrafana

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.

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.