@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface GrafanaClient extends AwsClient
builder() method.
Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.
With Amazon Managed Grafana, you create logically isolated Grafana servers called workspaces. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociateLicenseResponse |
associateLicense(AssociateLicenseRequest associateLicenseRequest)
Assigns a Grafana Enterprise license to a workspace.
|
default AssociateLicenseResponse |
associateLicense(Consumer<AssociateLicenseRequest.Builder> associateLicenseRequest)
Assigns a Grafana Enterprise license to a workspace.
|
static GrafanaClientBuilder |
builder()
Create a builder that can be used to configure and create a
GrafanaClient. |
static GrafanaClient |
create()
Create a
GrafanaClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateWorkspaceResponse |
createWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest)
Creates a workspace.
|
default CreateWorkspaceResponse |
createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)
Creates a workspace.
|
default CreateWorkspaceApiKeyResponse |
createWorkspaceApiKey(Consumer<CreateWorkspaceApiKeyRequest.Builder> createWorkspaceApiKeyRequest)
Creates a Grafana API key for the workspace.
|
default CreateWorkspaceApiKeyResponse |
createWorkspaceApiKey(CreateWorkspaceApiKeyRequest createWorkspaceApiKeyRequest)
Creates a Grafana API key for the workspace.
|
default DeleteWorkspaceResponse |
deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest)
Deletes an Amazon Managed Grafana workspace.
|
default DeleteWorkspaceResponse |
deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)
Deletes an Amazon Managed Grafana workspace.
|
default DeleteWorkspaceApiKeyResponse |
deleteWorkspaceApiKey(Consumer<DeleteWorkspaceApiKeyRequest.Builder> deleteWorkspaceApiKeyRequest)
Deletes a Grafana API key for the workspace.
|
default DeleteWorkspaceApiKeyResponse |
deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest deleteWorkspaceApiKeyRequest)
Deletes a Grafana API key for the workspace.
|
default DescribeWorkspaceResponse |
describeWorkspace(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest)
Displays information about one Amazon Managed Grafana workspace.
|
default DescribeWorkspaceResponse |
describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest)
Displays information about one Amazon Managed Grafana workspace.
|
default DescribeWorkspaceAuthenticationResponse |
describeWorkspaceAuthentication(Consumer<DescribeWorkspaceAuthenticationRequest.Builder> describeWorkspaceAuthenticationRequest)
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
|
default DescribeWorkspaceAuthenticationResponse |
describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest)
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
|
default DescribeWorkspaceConfigurationResponse |
describeWorkspaceConfiguration(Consumer<DescribeWorkspaceConfigurationRequest.Builder> describeWorkspaceConfigurationRequest)
Gets the current configuration string for the given workspace.
|
default DescribeWorkspaceConfigurationResponse |
describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest describeWorkspaceConfigurationRequest)
Gets the current configuration string for the given workspace.
|
default DisassociateLicenseResponse |
disassociateLicense(Consumer<DisassociateLicenseRequest.Builder> disassociateLicenseRequest)
Removes the Grafana Enterprise license from a workspace.
|
default DisassociateLicenseResponse |
disassociateLicense(DisassociateLicenseRequest disassociateLicenseRequest)
Removes the Grafana Enterprise license from a workspace.
|
default ListPermissionsResponse |
listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Lists the users and groups who have the Grafana
Admin and Editor roles in this
workspace. |
default ListPermissionsResponse |
listPermissions(ListPermissionsRequest listPermissionsRequest)
Lists the users and groups who have the Grafana
Admin and Editor roles in this
workspace. |
default ListPermissionsIterable |
listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Lists the users and groups who have the Grafana
Admin and Editor roles in this
workspace. |
default ListPermissionsIterable |
listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest)
Lists the users and groups who have the Grafana
Admin and Editor roles in this
workspace. |
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
The
ListTagsForResource operation returns the tags that are associated with the Amazon Managed
Service for Grafana resource specified by the resourceArn. |
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
The
ListTagsForResource operation returns the tags that are associated with the Amazon Managed
Service for Grafana resource specified by the resourceArn. |
default ListVersionsResponse |
listVersions(Consumer<ListVersionsRequest.Builder> listVersionsRequest)
Lists available versions of Grafana.
|
default ListVersionsResponse |
listVersions(ListVersionsRequest listVersionsRequest)
Lists available versions of Grafana.
|
default ListVersionsIterable |
listVersionsPaginator(Consumer<ListVersionsRequest.Builder> listVersionsRequest)
Lists available versions of Grafana.
|
default ListVersionsIterable |
listVersionsPaginator(ListVersionsRequest listVersionsRequest)
Lists available versions of Grafana.
|
default ListWorkspacesResponse |
listWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
|
default ListWorkspacesResponse |
listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
|
default ListWorkspacesIterable |
listWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
|
default ListWorkspacesIterable |
listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest)
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
|
default GrafanaServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
The
TagResource operation associates tags with an Amazon Managed Grafana resource. |
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
The
TagResource operation associates tags with an Amazon Managed Grafana resource. |
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
The
UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource. |
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
The
UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource. |
default UpdatePermissionsResponse |
updatePermissions(Consumer<UpdatePermissionsRequest.Builder> updatePermissionsRequest)
Updates which users in a workspace have the Grafana
Admin or Editor roles. |
default UpdatePermissionsResponse |
updatePermissions(UpdatePermissionsRequest updatePermissionsRequest)
Updates which users in a workspace have the Grafana
Admin or Editor roles. |
default UpdateWorkspaceResponse |
updateWorkspace(Consumer<UpdateWorkspaceRequest.Builder> updateWorkspaceRequest)
Modifies an existing Amazon Managed Grafana workspace.
|
default UpdateWorkspaceResponse |
updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest)
Modifies an existing Amazon Managed Grafana workspace.
|
default UpdateWorkspaceAuthenticationResponse |
updateWorkspaceAuthentication(Consumer<UpdateWorkspaceAuthenticationRequest.Builder> updateWorkspaceAuthenticationRequest)
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using
SAML.
|
default UpdateWorkspaceAuthenticationResponse |
updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest)
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using
SAML.
|
default UpdateWorkspaceConfigurationResponse |
updateWorkspaceConfiguration(Consumer<UpdateWorkspaceConfigurationRequest.Builder> updateWorkspaceConfigurationRequest)
Updates the configuration string for the given workspace
|
default UpdateWorkspaceConfigurationResponse |
updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest updateWorkspaceConfigurationRequest)
Updates the configuration string for the given workspace
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default AssociateLicenseResponse associateLicense(AssociateLicenseRequest associateLicenseRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.
associateLicenseRequest - 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.AwsServiceExceptiondefault AssociateLicenseResponse associateLicense(Consumer<AssociateLicenseRequest.Builder> associateLicenseRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.
This is a convenience which creates an instance of the AssociateLicenseRequest.Builder avoiding the need
to create one manually via AssociateLicenseRequest.builder()
associateLicenseRequest - A Consumer that will call methods on AssociateLicenseRequest.Builder to create a request.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.AwsServiceExceptiondefault CreateWorkspaceResponse createWorkspace(CreateWorkspaceRequest createWorkspaceRequest) throws ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, GrafanaException
Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.
Don't use CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace.
createWorkspaceRequest - 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.AwsServiceExceptiondefault CreateWorkspaceResponse createWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest) throws ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, GrafanaException
Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.
Don't use CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace.
This is a convenience which creates an instance of the CreateWorkspaceRequest.Builder avoiding the need
to create one manually via CreateWorkspaceRequest.builder()
createWorkspaceRequest - A Consumer that will call methods on CreateWorkspaceRequest.Builder to create a request.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.AwsServiceExceptiondefault CreateWorkspaceApiKeyResponse createWorkspaceApiKey(CreateWorkspaceApiKeyRequest createWorkspaceApiKeyRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, GrafanaException
Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https ://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example requests.
createWorkspaceApiKeyRequest - 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.AwsServiceExceptiondefault CreateWorkspaceApiKeyResponse createWorkspaceApiKey(Consumer<CreateWorkspaceApiKeyRequest.Builder> createWorkspaceApiKeyRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, GrafanaException
Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https ://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example requests.
This is a convenience which creates an instance of the CreateWorkspaceApiKeyRequest.Builder avoiding the
need to create one manually via CreateWorkspaceApiKeyRequest.builder()
createWorkspaceApiKeyRequest - A Consumer that will call methods on CreateWorkspaceApiKeyRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteWorkspaceResponse deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Deletes an Amazon Managed Grafana workspace.
deleteWorkspaceRequest - 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.AwsServiceExceptiondefault DeleteWorkspaceResponse deleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Deletes an Amazon Managed Grafana workspace.
This is a convenience which creates an instance of the DeleteWorkspaceRequest.Builder avoiding the need
to create one manually via DeleteWorkspaceRequest.builder()
deleteWorkspaceRequest - A Consumer that will call methods on DeleteWorkspaceRequest.Builder to create a request.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.AwsServiceExceptiondefault DeleteWorkspaceApiKeyResponse deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest deleteWorkspaceApiKeyRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Deletes a Grafana API key for the workspace.
deleteWorkspaceApiKeyRequest - 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.AwsServiceExceptiondefault DeleteWorkspaceApiKeyResponse deleteWorkspaceApiKey(Consumer<DeleteWorkspaceApiKeyRequest.Builder> deleteWorkspaceApiKeyRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Deletes a Grafana API key for the workspace.
This is a convenience which creates an instance of the DeleteWorkspaceApiKeyRequest.Builder avoiding the
need to create one manually via DeleteWorkspaceApiKeyRequest.builder()
deleteWorkspaceApiKeyRequest - A Consumer that will call methods on DeleteWorkspaceApiKeyRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeWorkspaceResponse describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Displays information about one Amazon Managed Grafana workspace.
describeWorkspaceRequest - 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.AwsServiceExceptiondefault DescribeWorkspaceResponse describeWorkspace(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Displays information about one Amazon Managed Grafana workspace.
This is a convenience which creates an instance of the DescribeWorkspaceRequest.Builder avoiding the need
to create one manually via DescribeWorkspaceRequest.builder()
describeWorkspaceRequest - A Consumer that will call methods on DescribeWorkspaceRequest.Builder to create a request.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.AwsServiceExceptiondefault DescribeWorkspaceAuthenticationResponse describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
describeWorkspaceAuthenticationRequest - 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.AwsServiceExceptiondefault DescribeWorkspaceAuthenticationResponse describeWorkspaceAuthentication(Consumer<DescribeWorkspaceAuthenticationRequest.Builder> describeWorkspaceAuthenticationRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
This is a convenience which creates an instance of the DescribeWorkspaceAuthenticationRequest.Builder
avoiding the need to create one manually via DescribeWorkspaceAuthenticationRequest.builder()
describeWorkspaceAuthenticationRequest - A Consumer that will call methods on DescribeWorkspaceAuthenticationRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeWorkspaceConfigurationResponse describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest describeWorkspaceConfigurationRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Gets the current configuration string for the given workspace.
describeWorkspaceConfigurationRequest - 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.AwsServiceExceptiondefault DescribeWorkspaceConfigurationResponse describeWorkspaceConfiguration(Consumer<DescribeWorkspaceConfigurationRequest.Builder> describeWorkspaceConfigurationRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Gets the current configuration string for the given workspace.
This is a convenience which creates an instance of the DescribeWorkspaceConfigurationRequest.Builder
avoiding the need to create one manually via DescribeWorkspaceConfigurationRequest.builder()
describeWorkspaceConfigurationRequest - A Consumer that will call methods on DescribeWorkspaceConfigurationRequest.Builder to
create a request.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.AwsServiceExceptiondefault DisassociateLicenseResponse disassociateLicense(DisassociateLicenseRequest disassociateLicenseRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Removes the Grafana Enterprise license from a workspace.
disassociateLicenseRequest - 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.AwsServiceExceptiondefault DisassociateLicenseResponse disassociateLicense(Consumer<DisassociateLicenseRequest.Builder> disassociateLicenseRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Removes the Grafana Enterprise license from a workspace.
This is a convenience which creates an instance of the DisassociateLicenseRequest.Builder avoiding the
need to create one manually via DisassociateLicenseRequest.builder()
disassociateLicenseRequest - A Consumer that will call methods on DisassociateLicenseRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListPermissionsResponse listPermissions(ListPermissionsRequest listPermissionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Lists the users and groups who have the Grafana Admin and Editor roles in this
workspace. If you use this operation without specifying userId or groupId, the
operation returns the roles of all users and groups. If you specify a userId or a
groupId, only the roles for that user or group are returned. If you do this, you can specify only
one userId or one groupId.
listPermissionsRequest - 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.AwsServiceExceptiondefault ListPermissionsResponse listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Lists the users and groups who have the Grafana Admin and Editor roles in this
workspace. If you use this operation without specifying userId or groupId, the
operation returns the roles of all users and groups. If you specify a userId or a
groupId, only the roles for that user or group are returned. If you do this, you can specify only
one userId or one groupId.
This is a convenience which creates an instance of the ListPermissionsRequest.Builder avoiding the need
to create one manually via ListPermissionsRequest.builder()
listPermissionsRequest - A Consumer that will call methods on ListPermissionsRequest.Builder to create a request.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.AwsServiceExceptiondefault ListPermissionsIterable listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Lists the users and groups who have the Grafana Admin and Editor roles in this
workspace. If you use this operation without specifying userId or groupId, the
operation returns the roles of all users and groups. If you specify a userId or a
groupId, only the roles for that user or group are returned. If you do this, you can specify only
one userId or one groupId.
This is a variant of
listPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.grafana.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.grafana.paginators.ListPermissionsIterable responses = client
.listPermissionsPaginator(request);
for (software.amazon.awssdk.services.grafana.model.ListPermissionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.grafana.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest) operation.
listPermissionsRequest - 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.AwsServiceExceptiondefault ListPermissionsIterable listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Lists the users and groups who have the Grafana Admin and Editor roles in this
workspace. If you use this operation without specifying userId or groupId, the
operation returns the roles of all users and groups. If you specify a userId or a
groupId, only the roles for that user or group are returned. If you do this, you can specify only
one userId or one groupId.
This is a variant of
listPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.grafana.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.grafana.paginators.ListPermissionsIterable responses = client
.listPermissionsPaginator(request);
for (software.amazon.awssdk.services.grafana.model.ListPermissionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.grafana.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest) operation.
This is a convenience which creates an instance of the ListPermissionsRequest.Builder avoiding the need
to create one manually via ListPermissionsRequest.builder()
listPermissionsRequest - A Consumer that will call methods on ListPermissionsRequest.Builder to create a request.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
The ListTagsForResource operation returns the tags that are associated with the Amazon Managed
Service for Grafana resource specified by the resourceArn. Currently, the only resource that can be
tagged is a workspace.
listTagsForResourceRequest - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
The ListTagsForResource operation returns the tags that are associated with the Amazon Managed
Service for Grafana resource specified by the resourceArn. Currently, the only resource that can be
tagged is a workspace.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListVersionsResponse listVersions(ListVersionsRequest listVersionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Lists available versions of Grafana. These are available when calling CreateWorkspace. Optionally,
include a workspace to list the versions to which it can be upgraded.
listVersionsRequest - 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.AwsServiceExceptiondefault ListVersionsResponse listVersions(Consumer<ListVersionsRequest.Builder> listVersionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Lists available versions of Grafana. These are available when calling CreateWorkspace. Optionally,
include a workspace to list the versions to which it can be upgraded.
This is a convenience which creates an instance of the ListVersionsRequest.Builder avoiding the need to
create one manually via ListVersionsRequest.builder()
listVersionsRequest - A Consumer that will call methods on ListVersionsRequest.Builder to create a request.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.AwsServiceExceptiondefault ListVersionsIterable listVersionsPaginator(ListVersionsRequest listVersionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Lists available versions of Grafana. These are available when calling CreateWorkspace. Optionally,
include a workspace to list the versions to which it can be upgraded.
This is a variant of listVersions(software.amazon.awssdk.services.grafana.model.ListVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.grafana.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.grafana.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request);
for (software.amazon.awssdk.services.grafana.model.ListVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.grafana.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVersions(software.amazon.awssdk.services.grafana.model.ListVersionsRequest) operation.
listVersionsRequest - 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.AwsServiceExceptiondefault ListVersionsIterable listVersionsPaginator(Consumer<ListVersionsRequest.Builder> listVersionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Lists available versions of Grafana. These are available when calling CreateWorkspace. Optionally,
include a workspace to list the versions to which it can be upgraded.
This is a variant of listVersions(software.amazon.awssdk.services.grafana.model.ListVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.grafana.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.grafana.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request);
for (software.amazon.awssdk.services.grafana.model.ListVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.grafana.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVersions(software.amazon.awssdk.services.grafana.model.ListVersionsRequest) operation.
This is a convenience which creates an instance of the ListVersionsRequest.Builder avoiding the need to
create one manually via ListVersionsRequest.builder()
listVersionsRequest - A Consumer that will call methods on ListVersionsRequest.Builder to create a request.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.AwsServiceExceptiondefault ListWorkspacesResponse listWorkspaces(ListWorkspacesRequest listWorkspacesRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use DescribeWorkspace.
listWorkspacesRequest - 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.AwsServiceExceptiondefault ListWorkspacesResponse listWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use DescribeWorkspace.
This is a convenience which creates an instance of the ListWorkspacesRequest.Builder avoiding the need to
create one manually via ListWorkspacesRequest.builder()
listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request.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.AwsServiceExceptiondefault ListWorkspacesIterable listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use DescribeWorkspace.
This is a variant of listWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.grafana.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.grafana.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request);
for (software.amazon.awssdk.services.grafana.model.ListWorkspacesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.grafana.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest) operation.
listWorkspacesRequest - 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.AwsServiceExceptiondefault ListWorkspacesIterable listWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use DescribeWorkspace.
This is a variant of listWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.grafana.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.grafana.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request);
for (software.amazon.awssdk.services.grafana.model.ListWorkspacesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.grafana.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest) operation.
This is a convenience which creates an instance of the ListWorkspacesRequest.Builder avoiding the need to
create one manually via ListWorkspacesRequest.builder()
listWorkspacesRequest - A Consumer that will call methods on ListWorkspacesRequest.Builder to create a request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
The TagResource operation associates tags with an Amazon Managed Grafana resource. Currently, the
only resource that can be tagged is workspaces.
If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
tagResourceRequest - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
The TagResource operation associates tags with an Amazon Managed Grafana resource. Currently, the
only resource that can be tagged is workspaces.
If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
The UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource.
untagResourceRequest - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
The UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UpdatePermissionsResponse updatePermissions(UpdatePermissionsRequest updatePermissionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Updates which users in a workspace have the Grafana Admin or Editor roles.
updatePermissionsRequest - 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.AwsServiceExceptiondefault UpdatePermissionsResponse updatePermissions(Consumer<UpdatePermissionsRequest.Builder> updatePermissionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Updates which users in a workspace have the Grafana Admin or Editor roles.
This is a convenience which creates an instance of the UpdatePermissionsRequest.Builder avoiding the need
to create one manually via UpdatePermissionsRequest.builder()
updatePermissionsRequest - A Consumer that will call methods on UpdatePermissionsRequest.Builder to create a request.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.AwsServiceExceptiondefault UpdateWorkspaceResponse updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.
To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center, use UpdateWorkspaceAuthentication.
To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions.
updateWorkspaceRequest - 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.AwsServiceExceptiondefault UpdateWorkspaceResponse updateWorkspace(Consumer<UpdateWorkspaceRequest.Builder> updateWorkspaceRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.
To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center, use UpdateWorkspaceAuthentication.
To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions.
This is a convenience which creates an instance of the UpdateWorkspaceRequest.Builder avoiding the need
to create one manually via UpdateWorkspaceRequest.builder()
updateWorkspaceRequest - A Consumer that will call methods on UpdateWorkspaceRequest.Builder to create a request.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.AwsServiceExceptiondefault UpdateWorkspaceAuthenticationResponse updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using
SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the
assertion attribute are to have the Admin and Editor roles in the workspace.
Changes to the authentication method for a workspace may take a few minutes to take effect.
updateWorkspaceAuthenticationRequest - 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.AwsServiceExceptiondefault UpdateWorkspaceAuthenticationResponse updateWorkspaceAuthentication(Consumer<UpdateWorkspaceAuthenticationRequest.Builder> updateWorkspaceAuthenticationRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using
SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the
assertion attribute are to have the Admin and Editor roles in the workspace.
Changes to the authentication method for a workspace may take a few minutes to take effect.
This is a convenience which creates an instance of the UpdateWorkspaceAuthenticationRequest.Builder
avoiding the need to create one manually via UpdateWorkspaceAuthenticationRequest.builder()
updateWorkspaceAuthenticationRequest - A Consumer that will call methods on UpdateWorkspaceAuthenticationRequest.Builder to
create a request.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.AwsServiceExceptiondefault UpdateWorkspaceConfigurationResponse updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest updateWorkspaceConfigurationRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Updates the configuration string for the given workspace
updateWorkspaceConfigurationRequest - 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.AwsServiceExceptiondefault UpdateWorkspaceConfigurationResponse updateWorkspaceConfiguration(Consumer<UpdateWorkspaceConfigurationRequest.Builder> updateWorkspaceConfigurationRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Updates the configuration string for the given workspace
This is a convenience which creates an instance of the UpdateWorkspaceConfigurationRequest.Builder
avoiding the need to create one manually via UpdateWorkspaceConfigurationRequest.builder()
updateWorkspaceConfigurationRequest - A Consumer that will call methods on UpdateWorkspaceConfigurationRequest.Builder to create
a request.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.AwsServiceExceptionstatic GrafanaClient create()
GrafanaClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static GrafanaClientBuilder builder()
GrafanaClient.static ServiceMetadata serviceMetadata()
default GrafanaServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.