com.amazonaws.services.managedgrafana

Class AmazonManagedGrafanaAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.managedgrafana.AmazonManagedGrafanaClient

com.amazonaws.services.managedgrafana.AmazonManagedGrafanaAsyncClient

All Implemented Interfaces:

AmazonManagedGrafana, AmazonManagedGrafanaAsync

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

Client 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.

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
Future<AssociateLicenseResult>	associateLicenseAsync(AssociateLicenseRequest request) Assigns a Grafana Enterprise license to a workspace.
Future<AssociateLicenseResult>	associateLicenseAsync(AssociateLicenseRequest request, AsyncHandler<AssociateLicenseRequest,AssociateLicenseResult> asyncHandler) Assigns a Grafana Enterprise license to a workspace.
static AmazonManagedGrafanaAsyncClientBuilder	asyncBuilder()
Future<CreateWorkspaceResult>	createWorkspaceAsync(CreateWorkspaceRequest request) Creates a workspace.
Future<CreateWorkspaceResult>	createWorkspaceAsync(CreateWorkspaceRequest request, AsyncHandler<CreateWorkspaceRequest,CreateWorkspaceResult> asyncHandler) Creates a workspace.
Future<DeleteWorkspaceResult>	deleteWorkspaceAsync(DeleteWorkspaceRequest request) Deletes an Amazon Managed Grafana workspace.
Future<DeleteWorkspaceResult>	deleteWorkspaceAsync(DeleteWorkspaceRequest request, AsyncHandler<DeleteWorkspaceRequest,DeleteWorkspaceResult> asyncHandler) Deletes an Amazon Managed Grafana workspace.
Future<DescribeWorkspaceResult>	describeWorkspaceAsync(DescribeWorkspaceRequest request) Displays information about one Amazon Managed Grafana workspace.
Future<DescribeWorkspaceResult>	describeWorkspaceAsync(DescribeWorkspaceRequest request, AsyncHandler<DescribeWorkspaceRequest,DescribeWorkspaceResult> asyncHandler) Displays information about one Amazon Managed Grafana workspace.
Future<DescribeWorkspaceAuthenticationResult>	describeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest request) Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
Future<DescribeWorkspaceAuthenticationResult>	describeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest request, AsyncHandler<DescribeWorkspaceAuthenticationRequest,DescribeWorkspaceAuthenticationResult> asyncHandler) Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
Future<DisassociateLicenseResult>	disassociateLicenseAsync(DisassociateLicenseRequest request) Removes the Grafana Enterprise license from a workspace.
Future<DisassociateLicenseResult>	disassociateLicenseAsync(DisassociateLicenseRequest request, AsyncHandler<DisassociateLicenseRequest,DisassociateLicenseResult> asyncHandler) Removes the Grafana Enterprise license from a workspace.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListPermissionsResult>	listPermissionsAsync(ListPermissionsRequest request) Lists the users and groups who have the Grafana Admin and Editor roles in this workspace.
Future<ListPermissionsResult>	listPermissionsAsync(ListPermissionsRequest request, AsyncHandler<ListPermissionsRequest,ListPermissionsResult> asyncHandler) Lists the users and groups who have the Grafana Admin and Editor roles in this workspace.
Future<ListWorkspacesResult>	listWorkspacesAsync(ListWorkspacesRequest request) Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
Future<ListWorkspacesResult>	listWorkspacesAsync(ListWorkspacesRequest request, AsyncHandler<ListWorkspacesRequest,ListWorkspacesResult> asyncHandler) Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<UpdatePermissionsResult>	updatePermissionsAsync(UpdatePermissionsRequest request) Updates which users in a workspace have the Grafana Admin or Editor roles.
Future<UpdatePermissionsResult>	updatePermissionsAsync(UpdatePermissionsRequest request, AsyncHandler<UpdatePermissionsRequest,UpdatePermissionsResult> asyncHandler) Updates which users in a workspace have the Grafana Admin or Editor roles.
Future<UpdateWorkspaceResult>	updateWorkspaceAsync(UpdateWorkspaceRequest request) Modifies an existing Amazon Managed Grafana workspace.
Future<UpdateWorkspaceResult>	updateWorkspaceAsync(UpdateWorkspaceRequest request, AsyncHandler<UpdateWorkspaceRequest,UpdateWorkspaceResult> asyncHandler) Modifies an existing Amazon Managed Grafana workspace.
Future<UpdateWorkspaceAuthenticationResult>	updateWorkspaceAuthenticationAsync(UpdateWorkspaceAuthenticationRequest request) Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.
Future<UpdateWorkspaceAuthenticationResult>	updateWorkspaceAuthenticationAsync(UpdateWorkspaceAuthenticationRequest request, AsyncHandler<UpdateWorkspaceAuthenticationRequest,UpdateWorkspaceAuthenticationResult> asyncHandler) Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.

Methods inherited from class com.amazonaws.services.managedgrafana.AmazonManagedGrafanaClient

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

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

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

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

Method Detail

asyncBuilder

public static AmazonManagedGrafanaAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

associateLicenseAsync

public Future<AssociateLicenseResult> associateLicenseAsync(AssociateLicenseRequest request)

Description copied from interface: AmazonManagedGrafanaAsync

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:

associateLicenseAsync in interface AmazonManagedGrafanaAsync

Returns:

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

See Also:

AWS API Documentation

associateLicenseAsync

public Future<AssociateLicenseResult> associateLicenseAsync(AssociateLicenseRequest request,
                                                            AsyncHandler<AssociateLicenseRequest,AssociateLicenseResult> asyncHandler)

Description copied from interface: AmazonManagedGrafanaAsync

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:

associateLicenseAsync in interface AmazonManagedGrafanaAsync

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

public Future<CreateWorkspaceResult> createWorkspaceAsync(CreateWorkspaceRequest request)

Description copied from interface: AmazonManagedGrafanaAsync

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:

createWorkspaceAsync in interface AmazonManagedGrafanaAsync

Returns:

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

See Also:

AWS API Documentation

createWorkspaceAsync

public Future<CreateWorkspaceResult> createWorkspaceAsync(CreateWorkspaceRequest request,
                                                          AsyncHandler<CreateWorkspaceRequest,CreateWorkspaceResult> asyncHandler)

Description copied from interface: AmazonManagedGrafanaAsync

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:

createWorkspaceAsync in interface AmazonManagedGrafanaAsync

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

public Future<DeleteWorkspaceResult> deleteWorkspaceAsync(DeleteWorkspaceRequest request)

Description copied from interface: AmazonManagedGrafanaAsync

Deletes an Amazon Managed Grafana workspace.

Specified by:

deleteWorkspaceAsync in interface AmazonManagedGrafanaAsync

Returns:

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

See Also:

AWS API Documentation

deleteWorkspaceAsync

public Future<DeleteWorkspaceResult> deleteWorkspaceAsync(DeleteWorkspaceRequest request,
                                                          AsyncHandler<DeleteWorkspaceRequest,DeleteWorkspaceResult> asyncHandler)

Description copied from interface: AmazonManagedGrafanaAsync

Deletes an Amazon Managed Grafana workspace.

Specified by:

deleteWorkspaceAsync in interface AmazonManagedGrafanaAsync

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

public Future<DescribeWorkspaceResult> describeWorkspaceAsync(DescribeWorkspaceRequest request)

Description copied from interface: AmazonManagedGrafanaAsync

Displays information about one Amazon Managed Grafana workspace.

Specified by:

describeWorkspaceAsync in interface AmazonManagedGrafanaAsync

Returns:

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

See Also:

AWS API Documentation

describeWorkspaceAsync

public Future<DescribeWorkspaceResult> describeWorkspaceAsync(DescribeWorkspaceRequest request,
                                                              AsyncHandler<DescribeWorkspaceRequest,DescribeWorkspaceResult> asyncHandler)

Description copied from interface: AmazonManagedGrafanaAsync

Displays information about one Amazon Managed Grafana workspace.

Specified by:

describeWorkspaceAsync in interface AmazonManagedGrafanaAsync

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

public Future<DescribeWorkspaceAuthenticationResult> describeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest request)

Description copied from interface: AmazonManagedGrafanaAsync

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

Specified by:

describeWorkspaceAuthenticationAsync in interface AmazonManagedGrafanaAsync

Returns:

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

See Also:

AWS API Documentation

describeWorkspaceAuthenticationAsync

public Future<DescribeWorkspaceAuthenticationResult> describeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest request,
                                                                                          AsyncHandler<DescribeWorkspaceAuthenticationRequest,DescribeWorkspaceAuthenticationResult> asyncHandler)

Description copied from interface: AmazonManagedGrafanaAsync

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

Specified by:

describeWorkspaceAuthenticationAsync in interface AmazonManagedGrafanaAsync

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

public Future<DisassociateLicenseResult> disassociateLicenseAsync(DisassociateLicenseRequest request)

Description copied from interface: AmazonManagedGrafanaAsync

Removes the Grafana Enterprise license from a workspace.

Specified by:

disassociateLicenseAsync in interface AmazonManagedGrafanaAsync

Returns:

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

See Also:

AWS API Documentation

disassociateLicenseAsync

public Future<DisassociateLicenseResult> disassociateLicenseAsync(DisassociateLicenseRequest request,
                                                                  AsyncHandler<DisassociateLicenseRequest,DisassociateLicenseResult> asyncHandler)

Description copied from interface: AmazonManagedGrafanaAsync

Removes the Grafana Enterprise license from a workspace.

Specified by:

disassociateLicenseAsync in interface AmazonManagedGrafanaAsync

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

public Future<ListPermissionsResult> listPermissionsAsync(ListPermissionsRequest request)

Description copied from interface: AmazonManagedGrafanaAsync

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:

listPermissionsAsync in interface AmazonManagedGrafanaAsync

Returns:

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

See Also:

AWS API Documentation

listPermissionsAsync

public Future<ListPermissionsResult> listPermissionsAsync(ListPermissionsRequest request,
                                                          AsyncHandler<ListPermissionsRequest,ListPermissionsResult> asyncHandler)

Description copied from interface: AmazonManagedGrafanaAsync

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:

listPermissionsAsync in interface AmazonManagedGrafanaAsync

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

public Future<ListWorkspacesResult> listWorkspacesAsync(ListWorkspacesRequest request)

Description copied from interface: AmazonManagedGrafanaAsync

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:

listWorkspacesAsync in interface AmazonManagedGrafanaAsync

Returns:

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

See Also:

AWS API Documentation

listWorkspacesAsync

public Future<ListWorkspacesResult> listWorkspacesAsync(ListWorkspacesRequest request,
                                                        AsyncHandler<ListWorkspacesRequest,ListWorkspacesResult> asyncHandler)

Description copied from interface: AmazonManagedGrafanaAsync

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:

listWorkspacesAsync in interface AmazonManagedGrafanaAsync

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

public Future<UpdatePermissionsResult> updatePermissionsAsync(UpdatePermissionsRequest request)

Description copied from interface: AmazonManagedGrafanaAsync

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

Specified by:

updatePermissionsAsync in interface AmazonManagedGrafanaAsync

Returns:

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

See Also:

AWS API Documentation

updatePermissionsAsync

public Future<UpdatePermissionsResult> updatePermissionsAsync(UpdatePermissionsRequest request,
                                                              AsyncHandler<UpdatePermissionsRequest,UpdatePermissionsResult> asyncHandler)

Description copied from interface: AmazonManagedGrafanaAsync

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

Specified by:

updatePermissionsAsync in interface AmazonManagedGrafanaAsync

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

public Future<UpdateWorkspaceResult> updateWorkspaceAsync(UpdateWorkspaceRequest request)

Description copied from interface: AmazonManagedGrafanaAsync

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:

updateWorkspaceAsync in interface AmazonManagedGrafanaAsync

Returns:

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

See Also:

AWS API Documentation

updateWorkspaceAsync

public Future<UpdateWorkspaceResult> updateWorkspaceAsync(UpdateWorkspaceRequest request,
                                                          AsyncHandler<UpdateWorkspaceRequest,UpdateWorkspaceResult> asyncHandler)

Description copied from interface: AmazonManagedGrafanaAsync

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:

updateWorkspaceAsync in interface AmazonManagedGrafanaAsync

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

public Future<UpdateWorkspaceAuthenticationResult> updateWorkspaceAuthenticationAsync(UpdateWorkspaceAuthenticationRequest request)

Description copied from interface: AmazonManagedGrafanaAsync

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:

updateWorkspaceAuthenticationAsync in interface AmazonManagedGrafanaAsync

Returns:

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

See Also:

AWS API Documentation

updateWorkspaceAuthenticationAsync

public Future<UpdateWorkspaceAuthenticationResult> updateWorkspaceAuthenticationAsync(UpdateWorkspaceAuthenticationRequest request,
                                                                                      AsyncHandler<UpdateWorkspaceAuthenticationRequest,UpdateWorkspaceAuthenticationResult> asyncHandler)

Description copied from interface: AmazonManagedGrafanaAsync

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:

updateWorkspaceAuthenticationAsync in interface AmazonManagedGrafanaAsync

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

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonManagedGrafana

Overrides:

shutdown in class AmazonManagedGrafanaClient