@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface GrafanaAsyncClient extends AwsClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AssociateLicenseResponse> |
associateLicense(AssociateLicenseRequest associateLicenseRequest)
Assigns a Grafana Enterprise license to a workspace.
|
default CompletableFuture<AssociateLicenseResponse> |
associateLicense(Consumer<AssociateLicenseRequest.Builder> associateLicenseRequest)
Assigns a Grafana Enterprise license to a workspace.
|
static GrafanaAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
GrafanaAsyncClient. |
static GrafanaAsyncClient |
create()
Create a
GrafanaAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateWorkspaceResponse> |
createWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest)
Creates a workspace.
|
default CompletableFuture<CreateWorkspaceResponse> |
createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)
Creates a workspace.
|
default CompletableFuture<CreateWorkspaceApiKeyResponse> |
createWorkspaceApiKey(Consumer<CreateWorkspaceApiKeyRequest.Builder> createWorkspaceApiKeyRequest)
Creates a Grafana API key for the workspace.
|
default CompletableFuture<CreateWorkspaceApiKeyResponse> |
createWorkspaceApiKey(CreateWorkspaceApiKeyRequest createWorkspaceApiKeyRequest)
Creates a Grafana API key for the workspace.
|
default CompletableFuture<DeleteWorkspaceResponse> |
deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest)
Deletes an Amazon Managed Grafana workspace.
|
default CompletableFuture<DeleteWorkspaceResponse> |
deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)
Deletes an Amazon Managed Grafana workspace.
|
default CompletableFuture<DeleteWorkspaceApiKeyResponse> |
deleteWorkspaceApiKey(Consumer<DeleteWorkspaceApiKeyRequest.Builder> deleteWorkspaceApiKeyRequest)
Deletes a Grafana API key for the workspace.
|
default CompletableFuture<DeleteWorkspaceApiKeyResponse> |
deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest deleteWorkspaceApiKeyRequest)
Deletes a Grafana API key for the workspace.
|
default CompletableFuture<DescribeWorkspaceResponse> |
describeWorkspace(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest)
Displays information about one Amazon Managed Grafana workspace.
|
default CompletableFuture<DescribeWorkspaceResponse> |
describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest)
Displays information about one Amazon Managed Grafana workspace.
|
default CompletableFuture<DescribeWorkspaceAuthenticationResponse> |
describeWorkspaceAuthentication(Consumer<DescribeWorkspaceAuthenticationRequest.Builder> describeWorkspaceAuthenticationRequest)
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
|
default CompletableFuture<DescribeWorkspaceAuthenticationResponse> |
describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest)
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
|
default CompletableFuture<DescribeWorkspaceConfigurationResponse> |
describeWorkspaceConfiguration(Consumer<DescribeWorkspaceConfigurationRequest.Builder> describeWorkspaceConfigurationRequest)
Gets the current configuration string for the given workspace.
|
default CompletableFuture<DescribeWorkspaceConfigurationResponse> |
describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest describeWorkspaceConfigurationRequest)
Gets the current configuration string for the given workspace.
|
default CompletableFuture<DisassociateLicenseResponse> |
disassociateLicense(Consumer<DisassociateLicenseRequest.Builder> disassociateLicenseRequest)
Removes the Grafana Enterprise license from a workspace.
|
default CompletableFuture<DisassociateLicenseResponse> |
disassociateLicense(DisassociateLicenseRequest disassociateLicenseRequest)
Removes the Grafana Enterprise license from a workspace.
|
default CompletableFuture<ListPermissionsResponse> |
listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Lists the users and groups who have the Grafana
Admin and Editor roles in this
workspace. |
default CompletableFuture<ListPermissionsResponse> |
listPermissions(ListPermissionsRequest listPermissionsRequest)
Lists the users and groups who have the Grafana
Admin and Editor roles in this
workspace. |
default ListPermissionsPublisher |
listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Lists the users and groups who have the Grafana
Admin and Editor roles in this
workspace. |
default ListPermissionsPublisher |
listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest)
Lists the users and groups who have the Grafana
Admin and Editor roles in this
workspace. |
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
The
ListTagsForResource operation returns the tags that are associated with the Amazon Managed
Service for Grafana resource specified by the resourceArn. |
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
The
ListTagsForResource operation returns the tags that are associated with the Amazon Managed
Service for Grafana resource specified by the resourceArn. |
default CompletableFuture<ListVersionsResponse> |
listVersions(Consumer<ListVersionsRequest.Builder> listVersionsRequest)
Lists available versions of Grafana.
|
default CompletableFuture<ListVersionsResponse> |
listVersions(ListVersionsRequest listVersionsRequest)
Lists available versions of Grafana.
|
default ListVersionsPublisher |
listVersionsPaginator(Consumer<ListVersionsRequest.Builder> listVersionsRequest)
Lists available versions of Grafana.
|
default ListVersionsPublisher |
listVersionsPaginator(ListVersionsRequest listVersionsRequest)
Lists available versions of Grafana.
|
default CompletableFuture<ListWorkspacesResponse> |
listWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
|
default CompletableFuture<ListWorkspacesResponse> |
listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
|
default ListWorkspacesPublisher |
listWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
|
default ListWorkspacesPublisher |
listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest)
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
|
default GrafanaServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
The
TagResource operation associates tags with an Amazon Managed Grafana resource. |
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
The
TagResource operation associates tags with an Amazon Managed Grafana resource. |
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
The
UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource. |
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
The
UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource. |
default CompletableFuture<UpdatePermissionsResponse> |
updatePermissions(Consumer<UpdatePermissionsRequest.Builder> updatePermissionsRequest)
Updates which users in a workspace have the Grafana
Admin or Editor roles. |
default CompletableFuture<UpdatePermissionsResponse> |
updatePermissions(UpdatePermissionsRequest updatePermissionsRequest)
Updates which users in a workspace have the Grafana
Admin or Editor roles. |
default CompletableFuture<UpdateWorkspaceResponse> |
updateWorkspace(Consumer<UpdateWorkspaceRequest.Builder> updateWorkspaceRequest)
Modifies an existing Amazon Managed Grafana workspace.
|
default CompletableFuture<UpdateWorkspaceResponse> |
updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest)
Modifies an existing Amazon Managed Grafana workspace.
|
default CompletableFuture<UpdateWorkspaceAuthenticationResponse> |
updateWorkspaceAuthentication(Consumer<UpdateWorkspaceAuthenticationRequest.Builder> updateWorkspaceAuthenticationRequest)
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using
SAML.
|
default CompletableFuture<UpdateWorkspaceAuthenticationResponse> |
updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest)
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using
SAML.
|
default CompletableFuture<UpdateWorkspaceConfigurationResponse> |
updateWorkspaceConfiguration(Consumer<UpdateWorkspaceConfigurationRequest.Builder> updateWorkspaceConfigurationRequest)
Updates the configuration string for the given workspace
|
default CompletableFuture<UpdateWorkspaceConfigurationResponse> |
updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest updateWorkspaceConfigurationRequest)
Updates the configuration string for the given workspace
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<AssociateLicenseResponse> associateLicense(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 - default CompletableFuture<AssociateLicenseResponse> associateLicense(Consumer<AssociateLicenseRequest.Builder> 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.
This is a convenience which creates an instance of the AssociateLicenseRequest.Builder avoiding the need
to create one manually via AssociateLicenseRequest.builder()
associateLicenseRequest - A Consumer that will call methods on AssociateLicenseRequest.Builder to create a request.default CompletableFuture<CreateWorkspaceResponse> createWorkspace(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 - default CompletableFuture<CreateWorkspaceResponse> createWorkspace(Consumer<CreateWorkspaceRequest.Builder> 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.
This is a convenience which creates an instance of the CreateWorkspaceRequest.Builder avoiding the need
to create one manually via CreateWorkspaceRequest.builder()
createWorkspaceRequest - A Consumer that will call methods on CreateWorkspaceRequest.Builder to create a request.default CompletableFuture<CreateWorkspaceApiKeyResponse> createWorkspaceApiKey(CreateWorkspaceApiKeyRequest createWorkspaceApiKeyRequest)
Creates 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.
createWorkspaceApiKeyRequest - default CompletableFuture<CreateWorkspaceApiKeyResponse> createWorkspaceApiKey(Consumer<CreateWorkspaceApiKeyRequest.Builder> createWorkspaceApiKeyRequest)
Creates 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.
This is a convenience which creates an instance of the CreateWorkspaceApiKeyRequest.Builder avoiding the
need to create one manually via CreateWorkspaceApiKeyRequest.builder()
createWorkspaceApiKeyRequest - A Consumer that will call methods on CreateWorkspaceApiKeyRequest.Builder to create a
request.default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)
Deletes an Amazon Managed Grafana workspace.
deleteWorkspaceRequest - default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest)
Deletes an Amazon Managed Grafana workspace.
This is a convenience which creates an instance of the DeleteWorkspaceRequest.Builder avoiding the need
to create one manually via DeleteWorkspaceRequest.builder()
deleteWorkspaceRequest - A Consumer that will call methods on DeleteWorkspaceRequest.Builder to create a request.default CompletableFuture<DeleteWorkspaceApiKeyResponse> deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest deleteWorkspaceApiKeyRequest)
Deletes a Grafana API key for the workspace.
deleteWorkspaceApiKeyRequest - default CompletableFuture<DeleteWorkspaceApiKeyResponse> deleteWorkspaceApiKey(Consumer<DeleteWorkspaceApiKeyRequest.Builder> deleteWorkspaceApiKeyRequest)
Deletes a Grafana API key for the workspace.
This is a convenience which creates an instance of the DeleteWorkspaceApiKeyRequest.Builder avoiding the
need to create one manually via DeleteWorkspaceApiKeyRequest.builder()
deleteWorkspaceApiKeyRequest - A Consumer that will call methods on DeleteWorkspaceApiKeyRequest.Builder to create a
request.default CompletableFuture<DescribeWorkspaceResponse> describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest)
Displays information about one Amazon Managed Grafana workspace.
describeWorkspaceRequest - default CompletableFuture<DescribeWorkspaceResponse> describeWorkspace(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest)
Displays information about one Amazon Managed Grafana workspace.
This is a convenience which creates an instance of the DescribeWorkspaceRequest.Builder avoiding the need
to create one manually via DescribeWorkspaceRequest.builder()
describeWorkspaceRequest - A Consumer that will call methods on DescribeWorkspaceRequest.Builder to create a request.default CompletableFuture<DescribeWorkspaceAuthenticationResponse> describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest)
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
describeWorkspaceAuthenticationRequest - default CompletableFuture<DescribeWorkspaceAuthenticationResponse> describeWorkspaceAuthentication(Consumer<DescribeWorkspaceAuthenticationRequest.Builder> describeWorkspaceAuthenticationRequest)
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
This is a convenience which creates an instance of the DescribeWorkspaceAuthenticationRequest.Builder
avoiding the need to create one manually via DescribeWorkspaceAuthenticationRequest.builder()
describeWorkspaceAuthenticationRequest - A Consumer that will call methods on DescribeWorkspaceAuthenticationRequest.Builder to
create a request.default CompletableFuture<DescribeWorkspaceConfigurationResponse> describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest describeWorkspaceConfigurationRequest)
Gets the current configuration string for the given workspace.
describeWorkspaceConfigurationRequest - default CompletableFuture<DescribeWorkspaceConfigurationResponse> describeWorkspaceConfiguration(Consumer<DescribeWorkspaceConfigurationRequest.Builder> describeWorkspaceConfigurationRequest)
Gets the current configuration string for the given workspace.
This is a convenience which creates an instance of the DescribeWorkspaceConfigurationRequest.Builder
avoiding the need to create one manually via DescribeWorkspaceConfigurationRequest.builder()
describeWorkspaceConfigurationRequest - A Consumer that will call methods on DescribeWorkspaceConfigurationRequest.Builder to
create a request.default CompletableFuture<DisassociateLicenseResponse> disassociateLicense(DisassociateLicenseRequest disassociateLicenseRequest)
Removes the Grafana Enterprise license from a workspace.
disassociateLicenseRequest - default CompletableFuture<DisassociateLicenseResponse> disassociateLicense(Consumer<DisassociateLicenseRequest.Builder> disassociateLicenseRequest)
Removes the Grafana Enterprise license from a workspace.
This is a convenience which creates an instance of the DisassociateLicenseRequest.Builder avoiding the
need to create one manually via DisassociateLicenseRequest.builder()
disassociateLicenseRequest - A Consumer that will call methods on DisassociateLicenseRequest.Builder to create a
request.default CompletableFuture<ListPermissionsResponse> listPermissions(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 - default CompletableFuture<ListPermissionsResponse> listPermissions(Consumer<ListPermissionsRequest.Builder> 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.
This is a convenience which creates an instance of the ListPermissionsRequest.Builder avoiding the need
to create one manually via ListPermissionsRequest.builder()
listPermissionsRequest - A Consumer that will call methods on ListPermissionsRequest.Builder to create a request.default ListPermissionsPublisher listPermissionsPaginator(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.
This is a variant of
listPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.grafana.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.grafana.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.grafana.model.ListPermissionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.grafana.model.ListPermissionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest) operation.
listPermissionsRequest - default ListPermissionsPublisher listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> 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.
This is a variant of
listPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.grafana.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.grafana.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.grafana.model.ListPermissionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.grafana.model.ListPermissionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest) operation.
This is a convenience which creates an instance of the ListPermissionsRequest.Builder avoiding the need
to create one manually via ListPermissionsRequest.builder()
listPermissionsRequest - A Consumer that will call methods on ListPermissionsRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(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 - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> 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.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ListVersionsResponse> listVersions(ListVersionsRequest listVersionsRequest)
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.
listVersionsRequest - default CompletableFuture<ListVersionsResponse> listVersions(Consumer<ListVersionsRequest.Builder> listVersionsRequest)
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.
This is a convenience which creates an instance of the ListVersionsRequest.Builder avoiding the need to
create one manually via ListVersionsRequest.builder()
listVersionsRequest - A Consumer that will call methods on ListVersionsRequest.Builder to create a request.default ListVersionsPublisher listVersionsPaginator(ListVersionsRequest listVersionsRequest)
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.
This is a variant of listVersions(software.amazon.awssdk.services.grafana.model.ListVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.grafana.paginators.ListVersionsPublisher publisher = client.listVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.grafana.paginators.ListVersionsPublisher publisher = client.listVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.grafana.model.ListVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.grafana.model.ListVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVersions(software.amazon.awssdk.services.grafana.model.ListVersionsRequest) operation.
listVersionsRequest - default ListVersionsPublisher listVersionsPaginator(Consumer<ListVersionsRequest.Builder> listVersionsRequest)
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.
This is a variant of listVersions(software.amazon.awssdk.services.grafana.model.ListVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.grafana.paginators.ListVersionsPublisher publisher = client.listVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.grafana.paginators.ListVersionsPublisher publisher = client.listVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.grafana.model.ListVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.grafana.model.ListVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVersions(software.amazon.awssdk.services.grafana.model.ListVersionsRequest) operation.
This is a convenience which creates an instance of the ListVersionsRequest.Builder avoiding the need to
create one manually via ListVersionsRequest.builder()
listVersionsRequest - A Consumer that will call methods on ListVersionsRequest.Builder to create a request.default CompletableFuture<ListWorkspacesResponse> listWorkspaces(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 - default CompletableFuture<ListWorkspacesResponse> listWorkspaces(Consumer<ListWorkspacesRequest.Builder> 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.
This is a convenience which creates an instance of the ListWorkspacesRequest.Builder avoiding the need to
create one manually via ListWorkspacesRequest.builder()
listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request.default ListWorkspacesPublisher listWorkspacesPaginator(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.
This is a variant of listWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.grafana.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.grafana.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.grafana.model.ListWorkspacesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.grafana.model.ListWorkspacesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest) operation.
listWorkspacesRequest - default ListWorkspacesPublisher listWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> 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.
This is a variant of listWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.grafana.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.grafana.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.grafana.model.ListWorkspacesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.grafana.model.ListWorkspacesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest) operation.
This is a convenience which creates an instance of the ListWorkspacesRequest.Builder avoiding the need to
create one manually via ListWorkspacesRequest.builder()
listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(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 - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
The UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
The UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdatePermissionsResponse> updatePermissions(UpdatePermissionsRequest updatePermissionsRequest)
Updates which users in a workspace have the Grafana Admin or Editor roles.
updatePermissionsRequest - default CompletableFuture<UpdatePermissionsResponse> updatePermissions(Consumer<UpdatePermissionsRequest.Builder> updatePermissionsRequest)
Updates which users in a workspace have the Grafana Admin or Editor roles.
This is a convenience which creates an instance of the UpdatePermissionsRequest.Builder avoiding the need
to create one manually via UpdatePermissionsRequest.builder()
updatePermissionsRequest - A Consumer that will call methods on UpdatePermissionsRequest.Builder to create a request.default CompletableFuture<UpdateWorkspaceResponse> updateWorkspace(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 IAM Identity Center, use UpdateWorkspaceAuthentication.
To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions.
updateWorkspaceRequest - default CompletableFuture<UpdateWorkspaceResponse> updateWorkspace(Consumer<UpdateWorkspaceRequest.Builder> 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 IAM Identity Center, use UpdateWorkspaceAuthentication.
To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions.
This is a convenience which creates an instance of the UpdateWorkspaceRequest.Builder avoiding the need
to create one manually via UpdateWorkspaceRequest.builder()
updateWorkspaceRequest - A Consumer that will call methods on UpdateWorkspaceRequest.Builder to create a request.default CompletableFuture<UpdateWorkspaceAuthenticationResponse> updateWorkspaceAuthentication(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.
Changes to the authentication method for a workspace may take a few minutes to take effect.
updateWorkspaceAuthenticationRequest - default CompletableFuture<UpdateWorkspaceAuthenticationResponse> updateWorkspaceAuthentication(Consumer<UpdateWorkspaceAuthenticationRequest.Builder> 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.
Changes to the authentication method for a workspace may take a few minutes to take effect.
This is a convenience which creates an instance of the UpdateWorkspaceAuthenticationRequest.Builder
avoiding the need to create one manually via UpdateWorkspaceAuthenticationRequest.builder()
updateWorkspaceAuthenticationRequest - A Consumer that will call methods on UpdateWorkspaceAuthenticationRequest.Builder to
create a request.default CompletableFuture<UpdateWorkspaceConfigurationResponse> updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest updateWorkspaceConfigurationRequest)
Updates the configuration string for the given workspace
updateWorkspaceConfigurationRequest - default CompletableFuture<UpdateWorkspaceConfigurationResponse> updateWorkspaceConfiguration(Consumer<UpdateWorkspaceConfigurationRequest.Builder> updateWorkspaceConfigurationRequest)
Updates the configuration string for the given workspace
This is a convenience which creates an instance of the UpdateWorkspaceConfigurationRequest.Builder
avoiding the need to create one manually via UpdateWorkspaceConfigurationRequest.builder()
updateWorkspaceConfigurationRequest - A Consumer that will call methods on UpdateWorkspaceConfigurationRequest.Builder to create
a request.default GrafanaServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic GrafanaAsyncClient create()
GrafanaAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static GrafanaAsyncClientBuilder builder()
GrafanaAsyncClient.Copyright © 2023. All rights reserved.