@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonManagedGrafanaAsync extends AmazonManagedGrafana
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.
ENDPOINT_PREFIX
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<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
The
ListTagsForResource operation returns the tags that are associated with the Amazon Managed
Service for Grafana resource specified by the resourceArn . |
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
The
ListTagsForResource operation returns the tags that are associated with the Amazon Managed
Service for Grafana resource specified by the resourceArn . |
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<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
The
TagResource operation associates tags with an Amazon Managed Grafana resource. |
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
The
TagResource operation associates tags with an Amazon Managed Grafana resource. |
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
The
UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource. |
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
The
UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource. |
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.
|
associateLicense, createWorkspace, deleteWorkspace, describeWorkspace, describeWorkspaceAuthentication, disassociateLicense, getCachedResponseMetadata, listPermissions, listTagsForResource, listWorkspaces, shutdown, tagResource, untagResource, updatePermissions, updateWorkspace, updateWorkspaceAuthentication
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.
associateLicenseRequest
- 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.
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.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.
createWorkspaceRequest
- 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.
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.Future<DeleteWorkspaceResult> deleteWorkspaceAsync(DeleteWorkspaceRequest deleteWorkspaceRequest)
Deletes an Amazon Managed Grafana workspace.
deleteWorkspaceRequest
- Future<DeleteWorkspaceResult> deleteWorkspaceAsync(DeleteWorkspaceRequest deleteWorkspaceRequest, AsyncHandler<DeleteWorkspaceRequest,DeleteWorkspaceResult> asyncHandler)
Deletes an Amazon Managed Grafana workspace.
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.Future<DescribeWorkspaceResult> describeWorkspaceAsync(DescribeWorkspaceRequest describeWorkspaceRequest)
Displays information about one Amazon Managed Grafana workspace.
describeWorkspaceRequest
- Future<DescribeWorkspaceResult> describeWorkspaceAsync(DescribeWorkspaceRequest describeWorkspaceRequest, AsyncHandler<DescribeWorkspaceRequest,DescribeWorkspaceResult> asyncHandler)
Displays information about one Amazon Managed Grafana workspace.
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.Future<DescribeWorkspaceAuthenticationResult> describeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest)
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
describeWorkspaceAuthenticationRequest
- Future<DescribeWorkspaceAuthenticationResult> describeWorkspaceAuthenticationAsync(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest, AsyncHandler<DescribeWorkspaceAuthenticationRequest,DescribeWorkspaceAuthenticationResult> asyncHandler)
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
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.Future<DisassociateLicenseResult> disassociateLicenseAsync(DisassociateLicenseRequest disassociateLicenseRequest)
Removes the Grafana Enterprise license from a workspace.
disassociateLicenseRequest
- Future<DisassociateLicenseResult> disassociateLicenseAsync(DisassociateLicenseRequest disassociateLicenseRequest, AsyncHandler<DisassociateLicenseRequest,DisassociateLicenseResult> asyncHandler)
Removes the Grafana Enterprise license from a workspace.
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.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
.
listPermissionsRequest
- 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
.
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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
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.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
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.
listTagsForResourceRequest
- 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.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.
listWorkspacesRequest
- 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.
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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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.
tagResourceRequest
- 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
The UntagResource
operation removes the association of the tag with the Amazon Managed Grafana
resource.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
The UntagResource
operation removes the association of the tag with the Amazon Managed Grafana
resource.
untagResourceRequest
- 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.Future<UpdatePermissionsResult> updatePermissionsAsync(UpdatePermissionsRequest updatePermissionsRequest)
Updates which users in a workspace have the Grafana Admin
or Editor
roles.
updatePermissionsRequest
- Future<UpdatePermissionsResult> updatePermissionsAsync(UpdatePermissionsRequest updatePermissionsRequest, AsyncHandler<UpdatePermissionsRequest,UpdatePermissionsResult> asyncHandler)
Updates which users in a workspace have the Grafana Admin
or Editor
roles.
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.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.
updateWorkspaceRequest
- 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.
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.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.
updateWorkspaceAuthenticationRequest
- 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.
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.