Interface GrafanaAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateLicense
(Consumer<AssociateLicenseRequest.Builder> associateLicenseRequest) Assigns a Grafana Enterprise license to a workspace.associateLicense
(AssociateLicenseRequest associateLicenseRequest) Assigns a Grafana Enterprise license to a workspace.static GrafanaAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aGrafanaAsyncClient
.static GrafanaAsyncClient
create()
Create aGrafanaAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateWorkspaceResponse> createWorkspace
(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest) Creates a workspace.default CompletableFuture
<CreateWorkspaceResponse> createWorkspace
(CreateWorkspaceRequest createWorkspaceRequest) Creates a workspace.createWorkspaceApiKey
(Consumer<CreateWorkspaceApiKeyRequest.Builder> createWorkspaceApiKeyRequest) Creates a Grafana API key for the workspace.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.deleteWorkspaceApiKey
(Consumer<DeleteWorkspaceApiKeyRequest.Builder> deleteWorkspaceApiKeyRequest) Deletes a Grafana API key for the workspace.deleteWorkspaceApiKey
(DeleteWorkspaceApiKeyRequest deleteWorkspaceApiKeyRequest) Deletes a Grafana API key for the workspace.describeWorkspace
(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest) Displays information about one Amazon Managed Grafana workspace.describeWorkspace
(DescribeWorkspaceRequest describeWorkspaceRequest) Displays information about one Amazon Managed Grafana workspace.describeWorkspaceAuthentication
(Consumer<DescribeWorkspaceAuthenticationRequest.Builder> describeWorkspaceAuthenticationRequest) Displays information about the authentication methods used in one Amazon Managed Grafana workspace.describeWorkspaceAuthentication
(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest) Displays information about the authentication methods used in one Amazon Managed Grafana workspace.describeWorkspaceConfiguration
(Consumer<DescribeWorkspaceConfigurationRequest.Builder> describeWorkspaceConfigurationRequest) Gets the current configuration string for the given workspace.describeWorkspaceConfiguration
(DescribeWorkspaceConfigurationRequest describeWorkspaceConfigurationRequest) Gets the current configuration string for the given workspace.disassociateLicense
(Consumer<DisassociateLicenseRequest.Builder> disassociateLicenseRequest) Removes the Grafana Enterprise license from a workspace.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 GrafanaAdmin
andEditor
roles in this workspace.default CompletableFuture
<ListPermissionsResponse> listPermissions
(ListPermissionsRequest listPermissionsRequest) Lists the users and groups who have the GrafanaAdmin
andEditor
roles in this workspace.default ListPermissionsPublisher
listPermissionsPaginator
(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest)
operation.default ListPermissionsPublisher
listPermissionsPaginator
(ListPermissionsRequest listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) TheListTagsForResource
operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by theresourceArn
.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) TheListTagsForResource
operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by theresourceArn
.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) This is a variant oflistVersions(software.amazon.awssdk.services.grafana.model.ListVersionsRequest)
operation.default ListVersionsPublisher
listVersionsPaginator
(ListVersionsRequest listVersionsRequest) This is a variant oflistVersions(software.amazon.awssdk.services.grafana.model.ListVersionsRequest)
operation.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) This is a variant oflistWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest)
operation.default ListWorkspacesPublisher
listWorkspacesPaginator
(ListWorkspacesRequest listWorkspacesRequest) This is a variant oflistWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) TheTagResource
operation associates tags with an Amazon Managed Grafana resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) TheTagResource
operation associates tags with an Amazon Managed Grafana resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) TheUntagResource
operation removes the association of the tag with the Amazon Managed Grafana resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) TheUntagResource
operation removes the association of the tag with the Amazon Managed Grafana resource.updatePermissions
(Consumer<UpdatePermissionsRequest.Builder> updatePermissionsRequest) Updates which users in a workspace have the GrafanaAdmin
orEditor
roles.updatePermissions
(UpdatePermissionsRequest updatePermissionsRequest) Updates which users in a workspace have the GrafanaAdmin
orEditor
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.updateWorkspaceAuthentication
(Consumer<UpdateWorkspaceAuthenticationRequest.Builder> updateWorkspaceAuthenticationRequest) Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.updateWorkspaceAuthentication
(UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest) Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.updateWorkspaceConfiguration
(Consumer<UpdateWorkspaceConfigurationRequest.Builder> updateWorkspaceConfigurationRequest) Updates the configuration string for the given workspaceupdateWorkspaceConfiguration
(UpdateWorkspaceConfigurationRequest updateWorkspaceConfigurationRequest) Updates the configuration string for the given workspaceMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateLicense
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.
- Parameters:
associateLicenseRequest
-- Returns:
- A Java Future containing the result of the AssociateLicense operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateLicense
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 viaAssociateLicenseRequest.builder()
- Parameters:
associateLicenseRequest
- AConsumer
that will call methods onAssociateLicenseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateLicense operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWorkspace
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.- Parameters:
createWorkspaceRequest
-- Returns:
- A Java Future containing the result of the CreateWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWorkspace
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 viaCreateWorkspaceRequest.builder()
- Parameters:
createWorkspaceRequest
- AConsumer
that will call methods onCreateWorkspaceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWorkspaceApiKey
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.
- Parameters:
createWorkspaceApiKeyRequest
-- Returns:
- A Java Future containing the result of the CreateWorkspaceApiKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWorkspaceApiKey
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 viaCreateWorkspaceApiKeyRequest.builder()
- Parameters:
createWorkspaceApiKeyRequest
- AConsumer
that will call methods onCreateWorkspaceApiKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateWorkspaceApiKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkspace
default CompletableFuture<DeleteWorkspaceResponse> deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest) Deletes an Amazon Managed Grafana workspace.
- Parameters:
deleteWorkspaceRequest
-- Returns:
- A Java Future containing the result of the DeleteWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkspace
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 viaDeleteWorkspaceRequest.builder()
- Parameters:
deleteWorkspaceRequest
- AConsumer
that will call methods onDeleteWorkspaceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkspaceApiKey
default CompletableFuture<DeleteWorkspaceApiKeyResponse> deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest deleteWorkspaceApiKeyRequest) Deletes a Grafana API key for the workspace.
- Parameters:
deleteWorkspaceApiKeyRequest
-- Returns:
- A Java Future containing the result of the DeleteWorkspaceApiKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkspaceApiKey
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 viaDeleteWorkspaceApiKeyRequest.builder()
- Parameters:
deleteWorkspaceApiKeyRequest
- AConsumer
that will call methods onDeleteWorkspaceApiKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteWorkspaceApiKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeWorkspace
default CompletableFuture<DescribeWorkspaceResponse> describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest) Displays information about one Amazon Managed Grafana workspace.
- Parameters:
describeWorkspaceRequest
-- Returns:
- A Java Future containing the result of the DescribeWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeWorkspace
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 viaDescribeWorkspaceRequest.builder()
- Parameters:
describeWorkspaceRequest
- AConsumer
that will call methods onDescribeWorkspaceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeWorkspaceAuthentication
default CompletableFuture<DescribeWorkspaceAuthenticationResponse> describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest) Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
- Parameters:
describeWorkspaceAuthenticationRequest
-- Returns:
- A Java Future containing the result of the DescribeWorkspaceAuthentication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeWorkspaceAuthentication
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 viaDescribeWorkspaceAuthenticationRequest.builder()
- Parameters:
describeWorkspaceAuthenticationRequest
- AConsumer
that will call methods onDescribeWorkspaceAuthenticationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeWorkspaceAuthentication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeWorkspaceConfiguration
default CompletableFuture<DescribeWorkspaceConfigurationResponse> describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest describeWorkspaceConfigurationRequest) Gets the current configuration string for the given workspace.
- Parameters:
describeWorkspaceConfigurationRequest
-- Returns:
- A Java Future containing the result of the DescribeWorkspaceConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeWorkspaceConfiguration
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 viaDescribeWorkspaceConfigurationRequest.builder()
- Parameters:
describeWorkspaceConfigurationRequest
- AConsumer
that will call methods onDescribeWorkspaceConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeWorkspaceConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateLicense
default CompletableFuture<DisassociateLicenseResponse> disassociateLicense(DisassociateLicenseRequest disassociateLicenseRequest) Removes the Grafana Enterprise license from a workspace.
- Parameters:
disassociateLicenseRequest
-- Returns:
- A Java Future containing the result of the DisassociateLicense operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateLicense
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 viaDisassociateLicenseRequest.builder()
- Parameters:
disassociateLicenseRequest
- AConsumer
that will call methods onDisassociateLicenseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateLicense operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissions
default CompletableFuture<ListPermissionsResponse> listPermissions(ListPermissionsRequest listPermissionsRequest) Lists the users and groups who have the Grafana
Admin
andEditor
roles in this workspace. If you use this operation without specifyinguserId
orgroupId
, the operation returns the roles of all users and groups. If you specify auserId
or agroupId
, only the roles for that user or group are returned. If you do this, you can specify only oneuserId
or onegroupId
.- Parameters:
listPermissionsRequest
-- Returns:
- A Java Future containing the result of the ListPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissions
default CompletableFuture<ListPermissionsResponse> listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) Lists the users and groups who have the Grafana
Admin
andEditor
roles in this workspace. If you use this operation without specifyinguserId
orgroupId
, the operation returns the roles of all users and groups. If you specify auserId
or agroupId
, only the roles for that user or group are returned. If you do this, you can specify only oneuserId
or onegroupId
.
This is a convenience which creates an instance of the
ListPermissionsRequest.Builder
avoiding the need to create one manually viaListPermissionsRequest.builder()
- Parameters:
listPermissionsRequest
- AConsumer
that will call methods onListPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionsPaginator
default ListPermissionsPublisher listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.grafana.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listPermissionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionsPaginator
default ListPermissionsPublisher listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.grafana.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListPermissionsRequest.builder()
- Parameters:
listPermissionsRequest
- AConsumer
that will call methods onListPermissionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
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 theresourceArn
. Currently, the only resource that can be tagged is a workspace.- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
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 theresourceArn
. 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVersions
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.- Parameters:
listVersionsRequest
-- Returns:
- A Java Future containing the result of the ListVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVersions
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 viaListVersionsRequest.builder()
- Parameters:
listVersionsRequest
- AConsumer
that will call methods onListVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVersionsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.grafana.paginators.ListVersionsPublisher publisher = client.listVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVersionsPaginator
default ListVersionsPublisher listVersionsPaginator(Consumer<ListVersionsRequest.Builder> listVersionsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.grafana.paginators.ListVersionsPublisher publisher = client.listVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListVersionsRequest.builder()
- Parameters:
listVersionsRequest
- AConsumer
that will call methods onListVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkspaces
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.
- Parameters:
listWorkspacesRequest
-- Returns:
- A Java Future containing the result of the ListWorkspaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied because of request throttling. Retry the request.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkspaces
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 viaListWorkspacesRequest.builder()
- Parameters:
listWorkspacesRequest
- AConsumer
that will call methods onListWorkspacesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListWorkspaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied because of request throttling. Retry the request.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkspacesPaginator
default ListWorkspacesPublisher listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.grafana.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listWorkspacesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied because of request throttling. Retry the request.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkspacesPaginator
default ListWorkspacesPublisher listWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.grafana.paginators.ListWorkspacesPublisher publisher = client.listWorkspacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListWorkspacesRequest.builder()
- Parameters:
listWorkspacesRequest
- AConsumer
that will call methods onListWorkspacesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied because of request throttling. Retry the request.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) The
UntagResource
operation removes the association of the tag with the Amazon Managed Grafana resource.- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePermissions
default CompletableFuture<UpdatePermissionsResponse> updatePermissions(UpdatePermissionsRequest updatePermissionsRequest) Updates which users in a workspace have the Grafana
Admin
orEditor
roles.- Parameters:
updatePermissionsRequest
-- Returns:
- A Java Future containing the result of the UpdatePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePermissions
default CompletableFuture<UpdatePermissionsResponse> updatePermissions(Consumer<UpdatePermissionsRequest.Builder> updatePermissionsRequest) Updates which users in a workspace have the Grafana
Admin
orEditor
roles.
This is a convenience which creates an instance of the
UpdatePermissionsRequest.Builder
avoiding the need to create one manually viaUpdatePermissionsRequest.builder()
- Parameters:
updatePermissionsRequest
- AConsumer
that will call methods onUpdatePermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkspace
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
andEditor
Grafana roles, use UpdatePermissions.- Parameters:
updateWorkspaceRequest
-- Returns:
- A Java Future containing the result of the UpdateWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkspace
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
andEditor
Grafana roles, use UpdatePermissions.
This is a convenience which creates an instance of the
UpdateWorkspaceRequest.Builder
avoiding the need to create one manually viaUpdateWorkspaceRequest.builder()
- Parameters:
updateWorkspaceRequest
- AConsumer
that will call methods onUpdateWorkspaceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateWorkspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkspaceAuthentication
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
andEditor
roles in the workspace.Changes to the authentication method for a workspace may take a few minutes to take effect.
- Parameters:
updateWorkspaceAuthenticationRequest
-- Returns:
- A Java Future containing the result of the UpdateWorkspaceAuthentication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkspaceAuthentication
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
andEditor
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 viaUpdateWorkspaceAuthenticationRequest.builder()
- Parameters:
updateWorkspaceAuthenticationRequest
- AConsumer
that will call methods onUpdateWorkspaceAuthenticationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateWorkspaceAuthentication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkspaceConfiguration
default CompletableFuture<UpdateWorkspaceConfigurationResponse> updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest updateWorkspaceConfigurationRequest) Updates the configuration string for the given workspace
- Parameters:
updateWorkspaceConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateWorkspaceConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkspaceConfiguration
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 viaUpdateWorkspaceConfigurationRequest.builder()
- Parameters:
updateWorkspaceConfigurationRequest
- AConsumer
that will call methods onUpdateWorkspaceConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateWorkspaceConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The request references a resource that does not exist.
- ThrottlingException The request was denied because of request throttling. Retry the request.
- ConflictException A resource was in an inconsistent state during an update or a deletion.
- ValidationException The value of a parameter in the request caused an error.
- AccessDeniedException You do not have sufficient permissions to perform this action.
- InternalServerException Unexpected error while processing the request. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GrafanaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aGrafanaAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aGrafanaAsyncClient
.
-