@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonManagedGrafanaAsyncClient extends AmazonManagedGrafanaClient implements AmazonManagedGrafanaAsync
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXassociateLicense, builder, createWorkspace, createWorkspaceApiKey, deleteWorkspace, deleteWorkspaceApiKey, describeWorkspace, describeWorkspaceAuthentication, describeWorkspaceConfiguration, disassociateLicense, getCachedResponseMetadata, listPermissions, listTagsForResource, listVersions, listWorkspaces, tagResource, untagResource, updatePermissions, updateWorkspace, updateWorkspaceAuthentication, updateWorkspaceConfigurationaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitassociateLicense, createWorkspace, createWorkspaceApiKey, deleteWorkspace, deleteWorkspaceApiKey, describeWorkspace, describeWorkspaceAuthentication, describeWorkspaceConfiguration, disassociateLicense, getCachedResponseMetadata, listPermissions, listTagsForResource, listVersions, listWorkspaces, tagResource, untagResource, updatePermissions, updateWorkspace, updateWorkspaceAuthentication, updateWorkspaceConfigurationpublic static AmazonManagedGrafanaAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AssociateLicenseResult> associateLicenseAsync(AssociateLicenseRequest request)
AmazonManagedGrafanaAsyncAssigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.
associateLicenseAsync in interface AmazonManagedGrafanaAsyncpublic Future<AssociateLicenseResult> associateLicenseAsync(AssociateLicenseRequest request, AsyncHandler<AssociateLicenseRequest,AssociateLicenseResult> asyncHandler)
AmazonManagedGrafanaAsyncAssigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.
associateLicenseAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<CreateWorkspaceResult> createWorkspaceAsync(CreateWorkspaceRequest request)
AmazonManagedGrafanaAsyncCreates 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.
createWorkspaceAsync in interface AmazonManagedGrafanaAsyncpublic Future<CreateWorkspaceResult> createWorkspaceAsync(CreateWorkspaceRequest request, AsyncHandler<CreateWorkspaceRequest,CreateWorkspaceResult> asyncHandler)
AmazonManagedGrafanaAsyncCreates 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.
createWorkspaceAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<CreateWorkspaceApiKeyResult> createWorkspaceApiKeyAsync(CreateWorkspaceApiKeyRequest request)
AmazonManagedGrafanaAsyncCreates 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.
createWorkspaceApiKeyAsync in interface AmazonManagedGrafanaAsyncpublic Future<CreateWorkspaceApiKeyResult> createWorkspaceApiKeyAsync(CreateWorkspaceApiKeyRequest request, AsyncHandler<CreateWorkspaceApiKeyRequest,CreateWorkspaceApiKeyResult> asyncHandler)
AmazonManagedGrafanaAsyncCreates 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.
createWorkspaceApiKeyAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<DeleteWorkspaceResult> deleteWorkspaceAsync(DeleteWorkspaceRequest request)
AmazonManagedGrafanaAsyncDeletes an Amazon Managed Grafana workspace.
deleteWorkspaceAsync in interface AmazonManagedGrafanaAsyncpublic Future<DeleteWorkspaceResult> deleteWorkspaceAsync(DeleteWorkspaceRequest request, AsyncHandler<DeleteWorkspaceRequest,DeleteWorkspaceResult> asyncHandler)
AmazonManagedGrafanaAsyncDeletes an Amazon Managed Grafana workspace.
deleteWorkspaceAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<DeleteWorkspaceApiKeyResult> deleteWorkspaceApiKeyAsync(DeleteWorkspaceApiKeyRequest request)
AmazonManagedGrafanaAsyncDeletes a Grafana API key for the workspace.
deleteWorkspaceApiKeyAsync in interface AmazonManagedGrafanaAsyncpublic Future<DeleteWorkspaceApiKeyResult> deleteWorkspaceApiKeyAsync(DeleteWorkspaceApiKeyRequest request, AsyncHandler<DeleteWorkspaceApiKeyRequest,DeleteWorkspaceApiKeyResult> asyncHandler)
AmazonManagedGrafanaAsyncDeletes a Grafana API key for the workspace.
deleteWorkspaceApiKeyAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<DescribeWorkspaceResult> describeWorkspaceAsync(DescribeWorkspaceRequest request)
AmazonManagedGrafanaAsyncDisplays information about one Amazon Managed Grafana workspace.
describeWorkspaceAsync in interface AmazonManagedGrafanaAsyncpublic Future<DescribeWorkspaceResult> describeWorkspaceAsync(DescribeWorkspaceRequest request, AsyncHandler<DescribeWorkspaceRequest,DescribeWorkspaceResult> asyncHandler)
AmazonManagedGrafanaAsyncDisplays information about one Amazon Managed Grafana workspace.
describeWorkspaceAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<DescribeWorkspaceAuthenticationResult> describeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest request)
AmazonManagedGrafanaAsyncDisplays information about the authentication methods used in one Amazon Managed Grafana workspace.
describeWorkspaceAuthenticationAsync in interface AmazonManagedGrafanaAsyncpublic Future<DescribeWorkspaceAuthenticationResult> describeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest request, AsyncHandler<DescribeWorkspaceAuthenticationRequest,DescribeWorkspaceAuthenticationResult> asyncHandler)
AmazonManagedGrafanaAsyncDisplays information about the authentication methods used in one Amazon Managed Grafana workspace.
describeWorkspaceAuthenticationAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<DescribeWorkspaceConfigurationResult> describeWorkspaceConfigurationAsync(DescribeWorkspaceConfigurationRequest request)
AmazonManagedGrafanaAsyncGets the current configuration string for the given workspace.
describeWorkspaceConfigurationAsync in interface AmazonManagedGrafanaAsyncpublic Future<DescribeWorkspaceConfigurationResult> describeWorkspaceConfigurationAsync(DescribeWorkspaceConfigurationRequest request, AsyncHandler<DescribeWorkspaceConfigurationRequest,DescribeWorkspaceConfigurationResult> asyncHandler)
AmazonManagedGrafanaAsyncGets the current configuration string for the given workspace.
describeWorkspaceConfigurationAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<DisassociateLicenseResult> disassociateLicenseAsync(DisassociateLicenseRequest request)
AmazonManagedGrafanaAsyncRemoves the Grafana Enterprise license from a workspace.
disassociateLicenseAsync in interface AmazonManagedGrafanaAsyncpublic Future<DisassociateLicenseResult> disassociateLicenseAsync(DisassociateLicenseRequest request, AsyncHandler<DisassociateLicenseRequest,DisassociateLicenseResult> asyncHandler)
AmazonManagedGrafanaAsyncRemoves the Grafana Enterprise license from a workspace.
disassociateLicenseAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<ListPermissionsResult> listPermissionsAsync(ListPermissionsRequest request)
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.
listPermissionsAsync in interface AmazonManagedGrafanaAsyncpublic Future<ListPermissionsResult> listPermissionsAsync(ListPermissionsRequest request, AsyncHandler<ListPermissionsRequest,ListPermissionsResult> asyncHandler)
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.
listPermissionsAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonManagedGrafanaAsync
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.
listTagsForResourceAsync in interface AmazonManagedGrafanaAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonManagedGrafanaAsync
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.
listTagsForResourceAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<ListVersionsResult> listVersionsAsync(ListVersionsRequest request)
AmazonManagedGrafanaAsync
Lists available versions of Grafana. These are available when calling CreateWorkspace. Optionally,
include a workspace to list the versions to which it can be upgraded.
listVersionsAsync in interface AmazonManagedGrafanaAsyncpublic Future<ListVersionsResult> listVersionsAsync(ListVersionsRequest request, AsyncHandler<ListVersionsRequest,ListVersionsResult> asyncHandler)
AmazonManagedGrafanaAsync
Lists available versions of Grafana. These are available when calling CreateWorkspace. Optionally,
include a workspace to list the versions to which it can be upgraded.
listVersionsAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<ListWorkspacesResult> listWorkspacesAsync(ListWorkspacesRequest request)
AmazonManagedGrafanaAsyncReturns 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.
listWorkspacesAsync in interface AmazonManagedGrafanaAsyncpublic Future<ListWorkspacesResult> listWorkspacesAsync(ListWorkspacesRequest request, AsyncHandler<ListWorkspacesRequest,ListWorkspacesResult> asyncHandler)
AmazonManagedGrafanaAsyncReturns 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.
listWorkspacesAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonManagedGrafanaAsync
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.
tagResourceAsync in interface AmazonManagedGrafanaAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonManagedGrafanaAsync
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.
tagResourceAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonManagedGrafanaAsync
The UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource.
untagResourceAsync in interface AmazonManagedGrafanaAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonManagedGrafanaAsync
The UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource.
untagResourceAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<UpdatePermissionsResult> updatePermissionsAsync(UpdatePermissionsRequest request)
AmazonManagedGrafanaAsync
Updates which users in a workspace have the Grafana Admin or Editor roles.
updatePermissionsAsync in interface AmazonManagedGrafanaAsyncpublic Future<UpdatePermissionsResult> updatePermissionsAsync(UpdatePermissionsRequest request, AsyncHandler<UpdatePermissionsRequest,UpdatePermissionsResult> asyncHandler)
AmazonManagedGrafanaAsync
Updates which users in a workspace have the Grafana Admin or Editor roles.
updatePermissionsAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<UpdateWorkspaceResult> updateWorkspaceAsync(UpdateWorkspaceRequest request)
AmazonManagedGrafanaAsyncModifies 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.
updateWorkspaceAsync in interface AmazonManagedGrafanaAsyncpublic Future<UpdateWorkspaceResult> updateWorkspaceAsync(UpdateWorkspaceRequest request, AsyncHandler<UpdateWorkspaceRequest,UpdateWorkspaceResult> asyncHandler)
AmazonManagedGrafanaAsyncModifies 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.
updateWorkspaceAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<UpdateWorkspaceAuthenticationResult> updateWorkspaceAuthenticationAsync(UpdateWorkspaceAuthenticationRequest request)
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.
Changes to the authentication method for a workspace may take a few minutes to take effect.
updateWorkspaceAuthenticationAsync in interface AmazonManagedGrafanaAsyncpublic Future<UpdateWorkspaceAuthenticationResult> updateWorkspaceAuthenticationAsync(UpdateWorkspaceAuthenticationRequest request, AsyncHandler<UpdateWorkspaceAuthenticationRequest,UpdateWorkspaceAuthenticationResult> asyncHandler)
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.
Changes to the authentication method for a workspace may take a few minutes to take effect.
updateWorkspaceAuthenticationAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public Future<UpdateWorkspaceConfigurationResult> updateWorkspaceConfigurationAsync(UpdateWorkspaceConfigurationRequest request)
AmazonManagedGrafanaAsyncUpdates the configuration string for the given workspace
updateWorkspaceConfigurationAsync in interface AmazonManagedGrafanaAsyncpublic Future<UpdateWorkspaceConfigurationResult> updateWorkspaceConfigurationAsync(UpdateWorkspaceConfigurationRequest request, AsyncHandler<UpdateWorkspaceConfigurationRequest,UpdateWorkspaceConfigurationResult> asyncHandler)
AmazonManagedGrafanaAsyncUpdates the configuration string for the given workspace
updateWorkspaceConfigurationAsync in interface AmazonManagedGrafanaAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonManagedGrafanashutdown in class AmazonManagedGrafanaClient