com.amazonaws.services.managedgrafana

Interface AmazonManagedGrafanaAsync

All Superinterfaces:

AmazonManagedGrafana

All Known Implementing Classes:

AbstractAmazonManagedGrafanaAsync, AmazonManagedGrafanaAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonManagedGrafanaAsync
extends AmazonManagedGrafana

Interface for accessing Amazon Managed Grafana asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonManagedGrafanaAsync 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 inherited from interface com.amazonaws.services.managedgrafana.AmazonManagedGrafana

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<AssociateLicenseResult>	associateLicenseAsync(AssociateLicenseRequest associateLicenseRequest) Assigns a Grafana Enterprise license to a workspace.
Future<AssociateLicenseResult>	associateLicenseAsync(AssociateLicenseRequest associateLicenseRequest, AsyncHandler<AssociateLicenseRequest,AssociateLicenseResult> asyncHandler) Assigns a Grafana Enterprise license to a workspace.
Future<CreateWorkspaceResult>	createWorkspaceAsync(CreateWorkspaceRequest createWorkspaceRequest) Creates a workspace.
Future<CreateWorkspaceResult>	createWorkspaceAsync(CreateWorkspaceRequest createWorkspaceRequest, AsyncHandler<CreateWorkspaceRequest,CreateWorkspaceResult> asyncHandler) Creates a workspace.
Future<DeleteWorkspaceResult>	deleteWorkspaceAsync(DeleteWorkspaceRequest deleteWorkspaceRequest) Deletes an Amazon Managed Grafana workspace.
Future<DeleteWorkspaceResult>	deleteWorkspaceAsync(DeleteWorkspaceRequest deleteWorkspaceRequest, AsyncHandler<DeleteWorkspaceRequest,DeleteWorkspaceResult> asyncHandler) Deletes an Amazon Managed Grafana workspace.
Future<DescribeWorkspaceResult>	describeWorkspaceAsync(DescribeWorkspaceRequest describeWorkspaceRequest) Displays information about one Amazon Managed Grafana workspace.
Future<DescribeWorkspaceResult>	describeWorkspaceAsync(DescribeWorkspaceRequest describeWorkspaceRequest, AsyncHandler<DescribeWorkspaceRequest,DescribeWorkspaceResult> asyncHandler) Displays information about one Amazon Managed Grafana workspace.
Future<DescribeWorkspaceAuthenticationResult>	describeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest) Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
Future<DescribeWorkspaceAuthenticationResult>	describeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest, AsyncHandler<DescribeWorkspaceAuthenticationRequest,DescribeWorkspaceAuthenticationResult> asyncHandler) Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
Future<DisassociateLicenseResult>	disassociateLicenseAsync(DisassociateLicenseRequest disassociateLicenseRequest) Removes the Grafana Enterprise license from a workspace.
Future<DisassociateLicenseResult>	disassociateLicenseAsync(DisassociateLicenseRequest disassociateLicenseRequest, AsyncHandler<DisassociateLicenseRequest,DisassociateLicenseResult> asyncHandler) Removes the Grafana Enterprise license from a workspace.
Future<ListPermissionsResult>	listPermissionsAsync(ListPermissionsRequest listPermissionsRequest) Lists the users and groups who have the Grafana Admin and Editor roles in this workspace.
Future<ListPermissionsResult>	listPermissionsAsync(ListPermissionsRequest listPermissionsRequest, AsyncHandler<ListPermissionsRequest,ListPermissionsResult> asyncHandler) Lists the users and groups who have the Grafana Admin and Editor roles in this workspace.
Future<ListWorkspacesResult>	listWorkspacesAsync(ListWorkspacesRequest listWorkspacesRequest) Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
Future<ListWorkspacesResult>	listWorkspacesAsync(ListWorkspacesRequest listWorkspacesRequest, AsyncHandler<ListWorkspacesRequest,ListWorkspacesResult> asyncHandler) Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
Future<UpdatePermissionsResult>	updatePermissionsAsync(UpdatePermissionsRequest updatePermissionsRequest) Updates which users in a workspace have the Grafana Admin or Editor roles.
Future<UpdatePermissionsResult>	updatePermissionsAsync(UpdatePermissionsRequest updatePermissionsRequest, AsyncHandler<UpdatePermissionsRequest,UpdatePermissionsResult> asyncHandler) Updates which users in a workspace have the Grafana Admin or Editor roles.
Future<UpdateWorkspaceResult>	updateWorkspaceAsync(UpdateWorkspaceRequest updateWorkspaceRequest) Modifies an existing Amazon Managed Grafana workspace.
Future<UpdateWorkspaceResult>	updateWorkspaceAsync(UpdateWorkspaceRequest updateWorkspaceRequest, AsyncHandler<UpdateWorkspaceRequest,UpdateWorkspaceResult> asyncHandler) Modifies an existing Amazon Managed Grafana workspace.
Future<UpdateWorkspaceAuthenticationResult>	updateWorkspaceAuthenticationAsync(UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest) Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.
Future<UpdateWorkspaceAuthenticationResult>	updateWorkspaceAuthenticationAsync(UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest, AsyncHandler<UpdateWorkspaceAuthenticationRequest,UpdateWorkspaceAuthenticationResult> asyncHandler) Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.

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

associateLicense, createWorkspace, deleteWorkspace, describeWorkspace, describeWorkspaceAuthentication, disassociateLicense, getCachedResponseMetadata, listPermissions, listWorkspaces, shutdown, updatePermissions, updateWorkspace, updateWorkspaceAuthentication

Method Detail

associateLicenseAsync

Future<AssociateLicenseResult> associateLicenseAsync(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:

A Java Future containing the result of the AssociateLicense operation returned by the service.

See Also:

AWS API Documentation

associateLicenseAsync

Future<AssociateLicenseResult> associateLicenseAsync(AssociateLicenseRequest associateLicenseRequest,
                                                     AsyncHandler<AssociateLicenseRequest,AssociateLicenseResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AssociateLicense operation returned by the service.

See Also:

AWS API Documentation

createWorkspaceAsync

Future<CreateWorkspaceResult> createWorkspaceAsync(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:

A Java Future containing the result of the CreateWorkspace operation returned by the service.

See Also:

AWS API Documentation

createWorkspaceAsync

Future<CreateWorkspaceResult> createWorkspaceAsync(CreateWorkspaceRequest createWorkspaceRequest,
                                                   AsyncHandler<CreateWorkspaceRequest,CreateWorkspaceResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateWorkspace operation returned by the service.

See Also:

AWS API Documentation

deleteWorkspaceAsync

Future<DeleteWorkspaceResult> deleteWorkspaceAsync(DeleteWorkspaceRequest deleteWorkspaceRequest)

Deletes an Amazon Managed Grafana workspace.

Parameters:

deleteWorkspaceRequest -

Returns:

A Java Future containing the result of the DeleteWorkspace operation returned by the service.

See Also:

AWS API Documentation

deleteWorkspaceAsync

Future<DeleteWorkspaceResult> deleteWorkspaceAsync(DeleteWorkspaceRequest deleteWorkspaceRequest,
                                                   AsyncHandler<DeleteWorkspaceRequest,DeleteWorkspaceResult> asyncHandler)

Deletes an Amazon Managed Grafana workspace.

Parameters:

deleteWorkspaceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteWorkspace operation returned by the service.

See Also:

AWS API Documentation

describeWorkspaceAsync

Future<DescribeWorkspaceResult> describeWorkspaceAsync(DescribeWorkspaceRequest describeWorkspaceRequest)

Displays information about one Amazon Managed Grafana workspace.

Parameters:

describeWorkspaceRequest -

Returns:

A Java Future containing the result of the DescribeWorkspace operation returned by the service.

See Also:

AWS API Documentation

describeWorkspaceAsync

Future<DescribeWorkspaceResult> describeWorkspaceAsync(DescribeWorkspaceRequest describeWorkspaceRequest,
                                                       AsyncHandler<DescribeWorkspaceRequest,DescribeWorkspaceResult> asyncHandler)

Displays information about one Amazon Managed Grafana workspace.

Parameters:

describeWorkspaceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeWorkspace operation returned by the service.

See Also:

AWS API Documentation

describeWorkspaceAuthenticationAsync

Future<DescribeWorkspaceAuthenticationResult> describeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest)

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

Parameters:

describeWorkspaceAuthenticationRequest -

Returns:

A Java Future containing the result of the DescribeWorkspaceAuthentication operation returned by the service.

See Also:

AWS API Documentation

describeWorkspaceAuthenticationAsync

Future<DescribeWorkspaceAuthenticationResult> describeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest,
                                                                                   AsyncHandler<DescribeWorkspaceAuthenticationRequest,DescribeWorkspaceAuthenticationResult> asyncHandler)

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

Parameters:

describeWorkspaceAuthenticationRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeWorkspaceAuthentication operation returned by the service.

See Also:

AWS API Documentation

disassociateLicenseAsync

Future<DisassociateLicenseResult> disassociateLicenseAsync(DisassociateLicenseRequest disassociateLicenseRequest)

Removes the Grafana Enterprise license from a workspace.

Parameters:

disassociateLicenseRequest -

Returns:

A Java Future containing the result of the DisassociateLicense operation returned by the service.

See Also:

AWS API Documentation

disassociateLicenseAsync

Future<DisassociateLicenseResult> disassociateLicenseAsync(DisassociateLicenseRequest disassociateLicenseRequest,
                                                           AsyncHandler<DisassociateLicenseRequest,DisassociateLicenseResult> asyncHandler)

Removes the Grafana Enterprise license from a workspace.

Parameters:

disassociateLicenseRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DisassociateLicense operation returned by the service.

See Also:

AWS API Documentation

listPermissionsAsync

Future<ListPermissionsResult> listPermissionsAsync(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:

A Java Future containing the result of the ListPermissions operation returned by the service.

See Also:

AWS API Documentation

listPermissionsAsync

Future<ListPermissionsResult> listPermissionsAsync(ListPermissionsRequest listPermissionsRequest,
                                                   AsyncHandler<ListPermissionsRequest,ListPermissionsResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListPermissions operation returned by the service.

See Also:

AWS API Documentation

listWorkspacesAsync

Future<ListWorkspacesResult> listWorkspacesAsync(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:

A Java Future containing the result of the ListWorkspaces operation returned by the service.

See Also:

AWS API Documentation

listWorkspacesAsync

Future<ListWorkspacesResult> listWorkspacesAsync(ListWorkspacesRequest listWorkspacesRequest,
                                                 AsyncHandler<ListWorkspacesRequest,ListWorkspacesResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListWorkspaces operation returned by the service.

See Also:

AWS API Documentation

updatePermissionsAsync

Future<UpdatePermissionsResult> updatePermissionsAsync(UpdatePermissionsRequest updatePermissionsRequest)

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

Parameters:

updatePermissionsRequest -

Returns:

A Java Future containing the result of the UpdatePermissions operation returned by the service.

See Also:

AWS API Documentation

updatePermissionsAsync

Future<UpdatePermissionsResult> updatePermissionsAsync(UpdatePermissionsRequest updatePermissionsRequest,
                                                       AsyncHandler<UpdatePermissionsRequest,UpdatePermissionsResult> asyncHandler)

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

Parameters:

updatePermissionsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdatePermissions operation returned by the service.

See Also:

AWS API Documentation

updateWorkspaceAsync

Future<UpdateWorkspaceResult> updateWorkspaceAsync(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:

A Java Future containing the result of the UpdateWorkspace operation returned by the service.

See Also:

AWS API Documentation

updateWorkspaceAsync

Future<UpdateWorkspaceResult> updateWorkspaceAsync(UpdateWorkspaceRequest updateWorkspaceRequest,
                                                   AsyncHandler<UpdateWorkspaceRequest,UpdateWorkspaceResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateWorkspace operation returned by the service.

See Also:

AWS API Documentation

updateWorkspaceAuthenticationAsync

Future<UpdateWorkspaceAuthenticationResult> updateWorkspaceAuthenticationAsync(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:

A Java Future containing the result of the UpdateWorkspaceAuthentication operation returned by the service.

See Also:

AWS API Documentation

updateWorkspaceAuthenticationAsync

Future<UpdateWorkspaceAuthenticationResult> updateWorkspaceAuthenticationAsync(UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest,
                                                                               AsyncHandler<UpdateWorkspaceAuthenticationRequest,UpdateWorkspaceAuthenticationResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateWorkspaceAuthentication operation returned by the service.

See Also:

AWS API Documentation