Interface GrafanaClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface GrafanaClient extends AwsClient
Service client for accessing Amazon Managed Grafana. This can be created using the staticbuilder()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.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AssociateLicenseResponseassociateLicense(Consumer<AssociateLicenseRequest.Builder> associateLicenseRequest)Assigns a Grafana Enterprise license to a workspace.default AssociateLicenseResponseassociateLicense(AssociateLicenseRequest associateLicenseRequest)Assigns a Grafana Enterprise license to a workspace.static GrafanaClientBuilderbuilder()Create a builder that can be used to configure and create aGrafanaClient.static GrafanaClientcreate()Create aGrafanaClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateWorkspaceResponsecreateWorkspace(Consumer<CreateWorkspaceRequest.Builder> createWorkspaceRequest)Creates a workspace.default CreateWorkspaceResponsecreateWorkspace(CreateWorkspaceRequest createWorkspaceRequest)Creates a workspace.default CreateWorkspaceApiKeyResponsecreateWorkspaceApiKey(Consumer<CreateWorkspaceApiKeyRequest.Builder> createWorkspaceApiKeyRequest)Creates a Grafana API key for the workspace.default CreateWorkspaceApiKeyResponsecreateWorkspaceApiKey(CreateWorkspaceApiKeyRequest createWorkspaceApiKeyRequest)Creates a Grafana API key for the workspace.default CreateWorkspaceServiceAccountResponsecreateWorkspaceServiceAccount(Consumer<CreateWorkspaceServiceAccountRequest.Builder> createWorkspaceServiceAccountRequest)Creates a service account for the workspace.default CreateWorkspaceServiceAccountResponsecreateWorkspaceServiceAccount(CreateWorkspaceServiceAccountRequest createWorkspaceServiceAccountRequest)Creates a service account for the workspace.default CreateWorkspaceServiceAccountTokenResponsecreateWorkspaceServiceAccountToken(Consumer<CreateWorkspaceServiceAccountTokenRequest.Builder> createWorkspaceServiceAccountTokenRequest)Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account.default CreateWorkspaceServiceAccountTokenResponsecreateWorkspaceServiceAccountToken(CreateWorkspaceServiceAccountTokenRequest createWorkspaceServiceAccountTokenRequest)Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account.default DeleteWorkspaceResponsedeleteWorkspace(Consumer<DeleteWorkspaceRequest.Builder> deleteWorkspaceRequest)Deletes an Amazon Managed Grafana workspace.default DeleteWorkspaceResponsedeleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)Deletes an Amazon Managed Grafana workspace.default DeleteWorkspaceApiKeyResponsedeleteWorkspaceApiKey(Consumer<DeleteWorkspaceApiKeyRequest.Builder> deleteWorkspaceApiKeyRequest)Deletes a Grafana API key for the workspace.default DeleteWorkspaceApiKeyResponsedeleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest deleteWorkspaceApiKeyRequest)Deletes a Grafana API key for the workspace.default DeleteWorkspaceServiceAccountResponsedeleteWorkspaceServiceAccount(Consumer<DeleteWorkspaceServiceAccountRequest.Builder> deleteWorkspaceServiceAccountRequest)Deletes a workspace service account from the workspace.default DeleteWorkspaceServiceAccountResponsedeleteWorkspaceServiceAccount(DeleteWorkspaceServiceAccountRequest deleteWorkspaceServiceAccountRequest)Deletes a workspace service account from the workspace.default DeleteWorkspaceServiceAccountTokenResponsedeleteWorkspaceServiceAccountToken(Consumer<DeleteWorkspaceServiceAccountTokenRequest.Builder> deleteWorkspaceServiceAccountTokenRequest)Deletes a token for the workspace service account.default DeleteWorkspaceServiceAccountTokenResponsedeleteWorkspaceServiceAccountToken(DeleteWorkspaceServiceAccountTokenRequest deleteWorkspaceServiceAccountTokenRequest)Deletes a token for the workspace service account.default DescribeWorkspaceResponsedescribeWorkspace(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest)Displays information about one Amazon Managed Grafana workspace.default DescribeWorkspaceResponsedescribeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest)Displays information about one Amazon Managed Grafana workspace.default DescribeWorkspaceAuthenticationResponsedescribeWorkspaceAuthentication(Consumer<DescribeWorkspaceAuthenticationRequest.Builder> describeWorkspaceAuthenticationRequest)Displays information about the authentication methods used in one Amazon Managed Grafana workspace.default DescribeWorkspaceAuthenticationResponsedescribeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest)Displays information about the authentication methods used in one Amazon Managed Grafana workspace.default DescribeWorkspaceConfigurationResponsedescribeWorkspaceConfiguration(Consumer<DescribeWorkspaceConfigurationRequest.Builder> describeWorkspaceConfigurationRequest)Gets the current configuration string for the given workspace.default DescribeWorkspaceConfigurationResponsedescribeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest describeWorkspaceConfigurationRequest)Gets the current configuration string for the given workspace.default DisassociateLicenseResponsedisassociateLicense(Consumer<DisassociateLicenseRequest.Builder> disassociateLicenseRequest)Removes the Grafana Enterprise license from a workspace.default DisassociateLicenseResponsedisassociateLicense(DisassociateLicenseRequest disassociateLicenseRequest)Removes the Grafana Enterprise license from a workspace.default ListPermissionsResponselistPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)Lists the users and groups who have the GrafanaAdminandEditorroles in this workspace.default ListPermissionsResponselistPermissions(ListPermissionsRequest listPermissionsRequest)Lists the users and groups who have the GrafanaAdminandEditorroles in this workspace.default ListPermissionsIterablelistPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)This is a variant oflistPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest)operation.default ListPermissionsIterablelistPermissionsPaginator(ListPermissionsRequest listPermissionsRequest)This is a variant oflistPermissions(software.amazon.awssdk.services.grafana.model.ListPermissionsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)TheListTagsForResourceoperation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by theresourceArn.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)TheListTagsForResourceoperation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by theresourceArn.default ListVersionsResponselistVersions(Consumer<ListVersionsRequest.Builder> listVersionsRequest)Lists available versions of Grafana.default ListVersionsResponselistVersions(ListVersionsRequest listVersionsRequest)Lists available versions of Grafana.default ListVersionsIterablelistVersionsPaginator(Consumer<ListVersionsRequest.Builder> listVersionsRequest)This is a variant oflistVersions(software.amazon.awssdk.services.grafana.model.ListVersionsRequest)operation.default ListVersionsIterablelistVersionsPaginator(ListVersionsRequest listVersionsRequest)This is a variant oflistVersions(software.amazon.awssdk.services.grafana.model.ListVersionsRequest)operation.default ListWorkspacesResponselistWorkspaces(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.default ListWorkspacesResponselistWorkspaces(ListWorkspacesRequest listWorkspacesRequest)Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.default ListWorkspaceServiceAccountsResponselistWorkspaceServiceAccounts(Consumer<ListWorkspaceServiceAccountsRequest.Builder> listWorkspaceServiceAccountsRequest)Returns a list of service accounts for a workspace.default ListWorkspaceServiceAccountsResponselistWorkspaceServiceAccounts(ListWorkspaceServiceAccountsRequest listWorkspaceServiceAccountsRequest)Returns a list of service accounts for a workspace.default ListWorkspaceServiceAccountsIterablelistWorkspaceServiceAccountsPaginator(Consumer<ListWorkspaceServiceAccountsRequest.Builder> listWorkspaceServiceAccountsRequest)This is a variant oflistWorkspaceServiceAccounts(software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountsRequest)operation.default ListWorkspaceServiceAccountsIterablelistWorkspaceServiceAccountsPaginator(ListWorkspaceServiceAccountsRequest listWorkspaceServiceAccountsRequest)This is a variant oflistWorkspaceServiceAccounts(software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountsRequest)operation.default ListWorkspaceServiceAccountTokensResponselistWorkspaceServiceAccountTokens(Consumer<ListWorkspaceServiceAccountTokensRequest.Builder> listWorkspaceServiceAccountTokensRequest)Returns a list of tokens for a workspace service account.default ListWorkspaceServiceAccountTokensResponselistWorkspaceServiceAccountTokens(ListWorkspaceServiceAccountTokensRequest listWorkspaceServiceAccountTokensRequest)Returns a list of tokens for a workspace service account.default ListWorkspaceServiceAccountTokensIterablelistWorkspaceServiceAccountTokensPaginator(Consumer<ListWorkspaceServiceAccountTokensRequest.Builder> listWorkspaceServiceAccountTokensRequest)This is a variant oflistWorkspaceServiceAccountTokens(software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountTokensRequest)operation.default ListWorkspaceServiceAccountTokensIterablelistWorkspaceServiceAccountTokensPaginator(ListWorkspaceServiceAccountTokensRequest listWorkspaceServiceAccountTokensRequest)This is a variant oflistWorkspaceServiceAccountTokens(software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountTokensRequest)operation.default ListWorkspacesIterablelistWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest)This is a variant oflistWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest)operation.default ListWorkspacesIterablelistWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest)This is a variant oflistWorkspaces(software.amazon.awssdk.services.grafana.model.ListWorkspacesRequest)operation.default GrafanaServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)TheTagResourceoperation associates tags with an Amazon Managed Grafana resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)TheTagResourceoperation associates tags with an Amazon Managed Grafana resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)TheUntagResourceoperation removes the association of the tag with the Amazon Managed Grafana resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)TheUntagResourceoperation removes the association of the tag with the Amazon Managed Grafana resource.default UpdatePermissionsResponseupdatePermissions(Consumer<UpdatePermissionsRequest.Builder> updatePermissionsRequest)Updates which users in a workspace have the GrafanaAdminorEditorroles.default UpdatePermissionsResponseupdatePermissions(UpdatePermissionsRequest updatePermissionsRequest)Updates which users in a workspace have the GrafanaAdminorEditorroles.default UpdateWorkspaceResponseupdateWorkspace(Consumer<UpdateWorkspaceRequest.Builder> updateWorkspaceRequest)Modifies an existing Amazon Managed Grafana workspace.default UpdateWorkspaceResponseupdateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest)Modifies an existing Amazon Managed Grafana workspace.default UpdateWorkspaceAuthenticationResponseupdateWorkspaceAuthentication(Consumer<UpdateWorkspaceAuthenticationRequest.Builder> updateWorkspaceAuthenticationRequest)Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.default UpdateWorkspaceAuthenticationResponseupdateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest)Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.default UpdateWorkspaceConfigurationResponseupdateWorkspaceConfiguration(Consumer<UpdateWorkspaceConfigurationRequest.Builder> updateWorkspaceConfigurationRequest)Updates the configuration string for the given workspacedefault UpdateWorkspaceConfigurationResponseupdateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest updateWorkspaceConfigurationRequest)Updates the configuration string for the given workspace-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
associateLicense
default AssociateLicenseResponse associateLicense(AssociateLicenseRequest associateLicenseRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Assigns a Grafana Enterprise license to a workspace. To upgrade, you must use
ENTERPRISEfor thelicenseType, and pass in a valid Grafana Labs token for thegrafanaToken. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.- Parameters:
associateLicenseRequest-- Returns:
- Result of the AssociateLicense operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
associateLicense
default AssociateLicenseResponse associateLicense(Consumer<AssociateLicenseRequest.Builder> associateLicenseRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Assigns a Grafana Enterprise license to a workspace. To upgrade, you must use
ENTERPRISEfor thelicenseType, and pass in a valid Grafana Labs token for thegrafanaToken. 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.Builderavoiding the need to create one manually viaAssociateLicenseRequest.builder()- Parameters:
associateLicenseRequest- AConsumerthat will call methods onAssociateLicenseRequest.Builderto create a request.- Returns:
- Result of the AssociateLicense operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkspace
default 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
CreateWorkspaceto modify an existing workspace. Instead, use UpdateWorkspace.- Parameters:
createWorkspaceRequest-- Returns:
- Result of the CreateWorkspace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkspace
default 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
CreateWorkspaceto modify an existing workspace. Instead, use UpdateWorkspace.
This is a convenience which creates an instance of the
CreateWorkspaceRequest.Builderavoiding the need to create one manually viaCreateWorkspaceRequest.builder()- Parameters:
createWorkspaceRequest- AConsumerthat will call methods onCreateWorkspaceRequest.Builderto create a request.- Returns:
- Result of the CreateWorkspace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkspaceApiKey
default 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.
In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.
- Parameters:
createWorkspaceApiKeyRequest-- Returns:
- Result of the CreateWorkspaceApiKey operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkspaceApiKey
default 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.
In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.
This is a convenience which creates an instance of the
CreateWorkspaceApiKeyRequest.Builderavoiding the need to create one manually viaCreateWorkspaceApiKeyRequest.builder()- Parameters:
createWorkspaceApiKeyRequest- AConsumerthat will call methods onCreateWorkspaceApiKeyRequest.Builderto create a request.- Returns:
- Result of the CreateWorkspaceApiKey operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkspaceServiceAccount
default CreateWorkspaceServiceAccountResponse createWorkspaceServiceAccount(CreateWorkspaceServiceAccountRequest createWorkspaceServiceAccountRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, GrafanaException
Creates a service account for the workspace. A service account can be used to call Grafana HTTP APIs, and run automated workloads. After creating the service account with the correct
GrafanaRolefor your use case, useCreateWorkspaceServiceAccountTokento create a token that can be used to authenticate and authorize Grafana HTTP API calls.You can only create service accounts for workspaces that are compatible with Grafana version 9 and above.
For more information about service accounts, see Service accounts in the Amazon Managed Grafana User Guide.
For more information about the Grafana HTTP APIs, see Using Grafana HTTP APIs in the Amazon Managed Grafana User Guide.
- Parameters:
createWorkspaceServiceAccountRequest-- Returns:
- Result of the CreateWorkspaceServiceAccount operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkspaceServiceAccount
default CreateWorkspaceServiceAccountResponse createWorkspaceServiceAccount(Consumer<CreateWorkspaceServiceAccountRequest.Builder> createWorkspaceServiceAccountRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, GrafanaException
Creates a service account for the workspace. A service account can be used to call Grafana HTTP APIs, and run automated workloads. After creating the service account with the correct
GrafanaRolefor your use case, useCreateWorkspaceServiceAccountTokento create a token that can be used to authenticate and authorize Grafana HTTP API calls.You can only create service accounts for workspaces that are compatible with Grafana version 9 and above.
For more information about service accounts, see Service accounts in the Amazon Managed Grafana User Guide.
For more information about the Grafana HTTP APIs, see Using Grafana HTTP APIs in the Amazon Managed Grafana User Guide.
This is a convenience which creates an instance of the
CreateWorkspaceServiceAccountRequest.Builderavoiding the need to create one manually viaCreateWorkspaceServiceAccountRequest.builder()- Parameters:
createWorkspaceServiceAccountRequest- AConsumerthat will call methods onCreateWorkspaceServiceAccountRequest.Builderto create a request.- Returns:
- Result of the CreateWorkspaceServiceAccount operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkspaceServiceAccountToken
default CreateWorkspaceServiceAccountTokenResponse createWorkspaceServiceAccountToken(CreateWorkspaceServiceAccountTokenRequest createWorkspaceServiceAccountTokenRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, GrafanaException
Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account. The service account acts as a user for the API operations, and defines the permissions that are used by the API.
When you create the service account token, you will receive a key that is used when calling Grafana APIs. Do not lose this key, as it will not be retrievable again.
If you do lose the key, you can delete the token and recreate it to receive a new key. This will disable the initial key.
Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.
- Parameters:
createWorkspaceServiceAccountTokenRequest-- Returns:
- Result of the CreateWorkspaceServiceAccountToken operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkspaceServiceAccountToken
default CreateWorkspaceServiceAccountTokenResponse createWorkspaceServiceAccountToken(Consumer<CreateWorkspaceServiceAccountTokenRequest.Builder> createWorkspaceServiceAccountTokenRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, GrafanaException
Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account. The service account acts as a user for the API operations, and defines the permissions that are used by the API.
When you create the service account token, you will receive a key that is used when calling Grafana APIs. Do not lose this key, as it will not be retrievable again.
If you do lose the key, you can delete the token and recreate it to receive a new key. This will disable the initial key.
Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.
This is a convenience which creates an instance of the
CreateWorkspaceServiceAccountTokenRequest.Builderavoiding the need to create one manually viaCreateWorkspaceServiceAccountTokenRequest.builder()- Parameters:
createWorkspaceServiceAccountTokenRequest- AConsumerthat will call methods onCreateWorkspaceServiceAccountTokenRequest.Builderto create a request.- Returns:
- Result of the CreateWorkspaceServiceAccountToken operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkspace
default DeleteWorkspaceResponse deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Deletes an Amazon Managed Grafana workspace.
- Parameters:
deleteWorkspaceRequest-- Returns:
- Result of the DeleteWorkspace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkspace
default 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.Builderavoiding the need to create one manually viaDeleteWorkspaceRequest.builder()- Parameters:
deleteWorkspaceRequest- AConsumerthat will call methods onDeleteWorkspaceRequest.Builderto create a request.- Returns:
- Result of the DeleteWorkspace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkspaceApiKey
default DeleteWorkspaceApiKeyResponse deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest deleteWorkspaceApiKeyRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Deletes a Grafana API key for the workspace.
In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.
- Parameters:
deleteWorkspaceApiKeyRequest-- Returns:
- Result of the DeleteWorkspaceApiKey operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkspaceApiKey
default DeleteWorkspaceApiKeyResponse deleteWorkspaceApiKey(Consumer<DeleteWorkspaceApiKeyRequest.Builder> deleteWorkspaceApiKeyRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Deletes a Grafana API key for the workspace.
In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.
This is a convenience which creates an instance of the
DeleteWorkspaceApiKeyRequest.Builderavoiding the need to create one manually viaDeleteWorkspaceApiKeyRequest.builder()- Parameters:
deleteWorkspaceApiKeyRequest- AConsumerthat will call methods onDeleteWorkspaceApiKeyRequest.Builderto create a request.- Returns:
- Result of the DeleteWorkspaceApiKey operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkspaceServiceAccount
default DeleteWorkspaceServiceAccountResponse deleteWorkspaceServiceAccount(DeleteWorkspaceServiceAccountRequest deleteWorkspaceServiceAccountRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Deletes a workspace service account from the workspace.
This will delete any tokens created for the service account, as well. If the tokens are currently in use, the will fail to authenticate / authorize after they are deleted.
Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.
- Parameters:
deleteWorkspaceServiceAccountRequest-- Returns:
- Result of the DeleteWorkspaceServiceAccount operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkspaceServiceAccount
default DeleteWorkspaceServiceAccountResponse deleteWorkspaceServiceAccount(Consumer<DeleteWorkspaceServiceAccountRequest.Builder> deleteWorkspaceServiceAccountRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Deletes a workspace service account from the workspace.
This will delete any tokens created for the service account, as well. If the tokens are currently in use, the will fail to authenticate / authorize after they are deleted.
Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.
This is a convenience which creates an instance of the
DeleteWorkspaceServiceAccountRequest.Builderavoiding the need to create one manually viaDeleteWorkspaceServiceAccountRequest.builder()- Parameters:
deleteWorkspaceServiceAccountRequest- AConsumerthat will call methods onDeleteWorkspaceServiceAccountRequest.Builderto create a request.- Returns:
- Result of the DeleteWorkspaceServiceAccount operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkspaceServiceAccountToken
default DeleteWorkspaceServiceAccountTokenResponse deleteWorkspaceServiceAccountToken(DeleteWorkspaceServiceAccountTokenRequest deleteWorkspaceServiceAccountTokenRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Deletes a token for the workspace service account.
This will disable the key associated with the token. If any automation is currently using the key, it will no longer be authenticated or authorized to perform actions with the Grafana HTTP APIs.
Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.
- Parameters:
deleteWorkspaceServiceAccountTokenRequest-- Returns:
- Result of the DeleteWorkspaceServiceAccountToken operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkspaceServiceAccountToken
default DeleteWorkspaceServiceAccountTokenResponse deleteWorkspaceServiceAccountToken(Consumer<DeleteWorkspaceServiceAccountTokenRequest.Builder> deleteWorkspaceServiceAccountTokenRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Deletes a token for the workspace service account.
This will disable the key associated with the token. If any automation is currently using the key, it will no longer be authenticated or authorized to perform actions with the Grafana HTTP APIs.
Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.
This is a convenience which creates an instance of the
DeleteWorkspaceServiceAccountTokenRequest.Builderavoiding the need to create one manually viaDeleteWorkspaceServiceAccountTokenRequest.builder()- Parameters:
deleteWorkspaceServiceAccountTokenRequest- AConsumerthat will call methods onDeleteWorkspaceServiceAccountTokenRequest.Builderto create a request.- Returns:
- Result of the DeleteWorkspaceServiceAccountToken operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeWorkspace
default DescribeWorkspaceResponse describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Displays information about one Amazon Managed Grafana workspace.
- Parameters:
describeWorkspaceRequest-- Returns:
- Result of the DescribeWorkspace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeWorkspace
default 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.Builderavoiding the need to create one manually viaDescribeWorkspaceRequest.builder()- Parameters:
describeWorkspaceRequest- AConsumerthat will call methods onDescribeWorkspaceRequest.Builderto create a request.- Returns:
- Result of the DescribeWorkspace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeWorkspaceAuthentication
default DescribeWorkspaceAuthenticationResponse describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
- Parameters:
describeWorkspaceAuthenticationRequest-- Returns:
- Result of the DescribeWorkspaceAuthentication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeWorkspaceAuthentication
default DescribeWorkspaceAuthenticationResponse describeWorkspaceAuthentication(Consumer<DescribeWorkspaceAuthenticationRequest.Builder> describeWorkspaceAuthenticationRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, 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.Builderavoiding the need to create one manually viaDescribeWorkspaceAuthenticationRequest.builder()- Parameters:
describeWorkspaceAuthenticationRequest- AConsumerthat will call methods onDescribeWorkspaceAuthenticationRequest.Builderto create a request.- Returns:
- Result of the DescribeWorkspaceAuthentication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeWorkspaceConfiguration
default DescribeWorkspaceConfigurationResponse describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest describeWorkspaceConfigurationRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Gets the current configuration string for the given workspace.
- Parameters:
describeWorkspaceConfigurationRequest-- Returns:
- Result of the DescribeWorkspaceConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeWorkspaceConfiguration
default 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.Builderavoiding the need to create one manually viaDescribeWorkspaceConfigurationRequest.builder()- Parameters:
describeWorkspaceConfigurationRequest- AConsumerthat will call methods onDescribeWorkspaceConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeWorkspaceConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateLicense
default DisassociateLicenseResponse disassociateLicense(DisassociateLicenseRequest disassociateLicenseRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Removes the Grafana Enterprise license from a workspace.
- Parameters:
disassociateLicenseRequest-- Returns:
- Result of the DisassociateLicense operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateLicense
default 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.Builderavoiding the need to create one manually viaDisassociateLicenseRequest.builder()- Parameters:
disassociateLicenseRequest- AConsumerthat will call methods onDisassociateLicenseRequest.Builderto create a request.- Returns:
- Result of the DisassociateLicense operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissions
default ListPermissionsResponse listPermissions(ListPermissionsRequest listPermissionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Lists the users and groups who have the Grafana
AdminandEditorroles in this workspace. If you use this operation without specifyinguserIdorgroupId, the operation returns the roles of all users and groups. If you specify auserIdor agroupId, only the roles for that user or group are returned. If you do this, you can specify only oneuserIdor onegroupId.- Parameters:
listPermissionsRequest-- Returns:
- Result of the ListPermissions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissions
default ListPermissionsResponse listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Lists the users and groups who have the Grafana
AdminandEditorroles in this workspace. If you use this operation without specifyinguserIdorgroupId, the operation returns the roles of all users and groups. If you specify auserIdor agroupId, only the roles for that user or group are returned. If you do this, you can specify only oneuserIdor onegroupId.
This is a convenience which creates an instance of the
ListPermissionsRequest.Builderavoiding the need to create one manually viaListPermissionsRequest.builder()- Parameters:
listPermissionsRequest- AConsumerthat will call methods onListPermissionsRequest.Builderto create a request.- Returns:
- Result of the ListPermissions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionsPaginator
default ListPermissionsIterable listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
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
2) Using For loopsoftware.amazon.awssdk.services.grafana.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listPermissionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionsPaginator
default ListPermissionsIterable listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
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
2) Using For loopsoftware.amazon.awssdk.services.grafana.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListPermissionsRequest.builder()- Parameters:
listPermissionsRequest- AConsumerthat will call methods onListPermissionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
The
ListTagsForResourceoperation 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:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
The
ListTagsForResourceoperation 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listVersions
default 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.- Parameters:
listVersionsRequest-- Returns:
- Result of the ListVersions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listVersions
default 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.Builderavoiding the need to create one manually viaListVersionsRequest.builder()- Parameters:
listVersionsRequest- AConsumerthat will call methods onListVersionsRequest.Builderto create a request.- Returns:
- Result of the ListVersions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listVersionsPaginator
default ListVersionsIterable listVersionsPaginator(ListVersionsRequest listVersionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
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
2) Using For loopsoftware.amazon.awssdk.services.grafana.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listVersionsPaginator
default ListVersionsIterable listVersionsPaginator(Consumer<ListVersionsRequest.Builder> listVersionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
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
2) Using For loopsoftware.amazon.awssdk.services.grafana.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListVersionsRequest.builder()- Parameters:
listVersionsRequest- AConsumerthat will call methods onListVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspaceServiceAccountTokens
default ListWorkspaceServiceAccountTokensResponse listWorkspaceServiceAccountTokens(ListWorkspaceServiceAccountTokensRequest listWorkspaceServiceAccountTokensRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Returns a list of tokens for a workspace service account.
This does not return the key for each token. You cannot access keys after they are created. To create a new key, delete the token and recreate it.
Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.
- Parameters:
listWorkspaceServiceAccountTokensRequest-- Returns:
- Result of the ListWorkspaceServiceAccountTokens operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspaceServiceAccountTokens
default ListWorkspaceServiceAccountTokensResponse listWorkspaceServiceAccountTokens(Consumer<ListWorkspaceServiceAccountTokensRequest.Builder> listWorkspaceServiceAccountTokensRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Returns a list of tokens for a workspace service account.
This does not return the key for each token. You cannot access keys after they are created. To create a new key, delete the token and recreate it.
Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.
This is a convenience which creates an instance of the
ListWorkspaceServiceAccountTokensRequest.Builderavoiding the need to create one manually viaListWorkspaceServiceAccountTokensRequest.builder()- Parameters:
listWorkspaceServiceAccountTokensRequest- AConsumerthat will call methods onListWorkspaceServiceAccountTokensRequest.Builderto create a request.- Returns:
- Result of the ListWorkspaceServiceAccountTokens operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspaceServiceAccountTokensPaginator
default ListWorkspaceServiceAccountTokensIterable listWorkspaceServiceAccountTokensPaginator(ListWorkspaceServiceAccountTokensRequest listWorkspaceServiceAccountTokensRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
This is a variant of
listWorkspaceServiceAccountTokens(software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountTokensRequest)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
2) Using For loopsoftware.amazon.awssdk.services.grafana.paginators.ListWorkspaceServiceAccountTokensIterable responses = client.listWorkspaceServiceAccountTokensPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.grafana.paginators.ListWorkspaceServiceAccountTokensIterable responses = client .listWorkspaceServiceAccountTokensPaginator(request); for (software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountTokensResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.grafana.paginators.ListWorkspaceServiceAccountTokensIterable responses = client.listWorkspaceServiceAccountTokensPaginator(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
listWorkspaceServiceAccountTokens(software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountTokensRequest)operation.- Parameters:
listWorkspaceServiceAccountTokensRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspaceServiceAccountTokensPaginator
default ListWorkspaceServiceAccountTokensIterable listWorkspaceServiceAccountTokensPaginator(Consumer<ListWorkspaceServiceAccountTokensRequest.Builder> listWorkspaceServiceAccountTokensRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
This is a variant of
listWorkspaceServiceAccountTokens(software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountTokensRequest)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
2) Using For loopsoftware.amazon.awssdk.services.grafana.paginators.ListWorkspaceServiceAccountTokensIterable responses = client.listWorkspaceServiceAccountTokensPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.grafana.paginators.ListWorkspaceServiceAccountTokensIterable responses = client .listWorkspaceServiceAccountTokensPaginator(request); for (software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountTokensResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.grafana.paginators.ListWorkspaceServiceAccountTokensIterable responses = client.listWorkspaceServiceAccountTokensPaginator(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
listWorkspaceServiceAccountTokens(software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountTokensRequest)operation.
This is a convenience which creates an instance of the
ListWorkspaceServiceAccountTokensRequest.Builderavoiding the need to create one manually viaListWorkspaceServiceAccountTokensRequest.builder()- Parameters:
listWorkspaceServiceAccountTokensRequest- AConsumerthat will call methods onListWorkspaceServiceAccountTokensRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspaceServiceAccounts
default ListWorkspaceServiceAccountsResponse listWorkspaceServiceAccounts(ListWorkspaceServiceAccountsRequest listWorkspaceServiceAccountsRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Returns a list of service accounts for a workspace.
Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.
- Parameters:
listWorkspaceServiceAccountsRequest-- Returns:
- Result of the ListWorkspaceServiceAccounts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspaceServiceAccounts
default ListWorkspaceServiceAccountsResponse listWorkspaceServiceAccounts(Consumer<ListWorkspaceServiceAccountsRequest.Builder> listWorkspaceServiceAccountsRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Returns a list of service accounts for a workspace.
Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.
This is a convenience which creates an instance of the
ListWorkspaceServiceAccountsRequest.Builderavoiding the need to create one manually viaListWorkspaceServiceAccountsRequest.builder()- Parameters:
listWorkspaceServiceAccountsRequest- AConsumerthat will call methods onListWorkspaceServiceAccountsRequest.Builderto create a request.- Returns:
- Result of the ListWorkspaceServiceAccounts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspaceServiceAccountsPaginator
default ListWorkspaceServiceAccountsIterable listWorkspaceServiceAccountsPaginator(ListWorkspaceServiceAccountsRequest listWorkspaceServiceAccountsRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
This is a variant of
listWorkspaceServiceAccounts(software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.grafana.paginators.ListWorkspaceServiceAccountsIterable responses = client.listWorkspaceServiceAccountsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.grafana.paginators.ListWorkspaceServiceAccountsIterable responses = client .listWorkspaceServiceAccountsPaginator(request); for (software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.grafana.paginators.ListWorkspaceServiceAccountsIterable responses = client.listWorkspaceServiceAccountsPaginator(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
listWorkspaceServiceAccounts(software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountsRequest)operation.- Parameters:
listWorkspaceServiceAccountsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspaceServiceAccountsPaginator
default ListWorkspaceServiceAccountsIterable listWorkspaceServiceAccountsPaginator(Consumer<ListWorkspaceServiceAccountsRequest.Builder> listWorkspaceServiceAccountsRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
This is a variant of
listWorkspaceServiceAccounts(software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.grafana.paginators.ListWorkspaceServiceAccountsIterable responses = client.listWorkspaceServiceAccountsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.grafana.paginators.ListWorkspaceServiceAccountsIterable responses = client .listWorkspaceServiceAccountsPaginator(request); for (software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.grafana.paginators.ListWorkspaceServiceAccountsIterable responses = client.listWorkspaceServiceAccountsPaginator(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
listWorkspaceServiceAccounts(software.amazon.awssdk.services.grafana.model.ListWorkspaceServiceAccountsRequest)operation.
This is a convenience which creates an instance of the
ListWorkspaceServiceAccountsRequest.Builderavoiding the need to create one manually viaListWorkspaceServiceAccountsRequest.builder()- Parameters:
listWorkspaceServiceAccountsRequest- AConsumerthat will call methods onListWorkspaceServiceAccountsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspaces
default 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.
- Parameters:
listWorkspacesRequest-- Returns:
- Result of the ListWorkspaces operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspaces
default 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.Builderavoiding the need to create one manually viaListWorkspacesRequest.builder()- Parameters:
listWorkspacesRequest- AConsumerthat will call methods onListWorkspacesRequest.Builderto create a request.- Returns:
- Result of the ListWorkspaces operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspacesPaginator
default ListWorkspacesIterable listWorkspacesPaginator(ListWorkspacesRequest listWorkspacesRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
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
2) Using For loopsoftware.amazon.awssdk.services.grafana.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listWorkspacesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkspacesPaginator
default ListWorkspacesIterable listWorkspacesPaginator(Consumer<ListWorkspacesRequest.Builder> listWorkspacesRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
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
2) Using For loopsoftware.amazon.awssdk.services.grafana.paginators.ListWorkspacesIterable responses = client.listWorkspacesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListWorkspacesRequest.builder()- Parameters:
listWorkspacesRequest- AConsumerthat will call methods onListWorkspacesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
The
TagResourceoperation 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:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
The
TagResourceoperation 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
The
UntagResourceoperation removes the association of the tag with the Amazon Managed Grafana resource.- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
The
UntagResourceoperation removes the association of the tag with the Amazon Managed Grafana resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePermissions
default UpdatePermissionsResponse updatePermissions(UpdatePermissionsRequest updatePermissionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Updates which users in a workspace have the Grafana
AdminorEditorroles.- Parameters:
updatePermissionsRequest-- Returns:
- Result of the UpdatePermissions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePermissions
default UpdatePermissionsResponse updatePermissions(Consumer<UpdatePermissionsRequest.Builder> updatePermissionsRequest) throws ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Updates which users in a workspace have the Grafana
AdminorEditorroles.
This is a convenience which creates an instance of the
UpdatePermissionsRequest.Builderavoiding the need to create one manually viaUpdatePermissionsRequest.builder()- Parameters:
updatePermissionsRequest- AConsumerthat will call methods onUpdatePermissionsRequest.Builderto create a request.- Returns:
- Result of the UpdatePermissions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkspace
default 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
AdminandEditorGrafana roles, use UpdatePermissions.- Parameters:
updateWorkspaceRequest-- Returns:
- Result of the UpdateWorkspace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkspace
default 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
AdminandEditorGrafana roles, use UpdatePermissions.
This is a convenience which creates an instance of the
UpdateWorkspaceRequest.Builderavoiding the need to create one manually viaUpdateWorkspaceRequest.builder()- Parameters:
updateWorkspaceRequest- AConsumerthat will call methods onUpdateWorkspaceRequest.Builderto create a request.- Returns:
- Result of the UpdateWorkspace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkspaceAuthentication
default 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
AdminandEditorroles in the workspace.Changes to the authentication method for a workspace may take a few minutes to take effect.
- Parameters:
updateWorkspaceAuthenticationRequest-- Returns:
- Result of the UpdateWorkspaceAuthentication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkspaceAuthentication
default 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
AdminandEditorroles 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.Builderavoiding the need to create one manually viaUpdateWorkspaceAuthenticationRequest.builder()- Parameters:
updateWorkspaceAuthenticationRequest- AConsumerthat will call methods onUpdateWorkspaceAuthenticationRequest.Builderto create a request.- Returns:
- Result of the UpdateWorkspaceAuthentication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkspaceConfiguration
default UpdateWorkspaceConfigurationResponse updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest updateWorkspaceConfigurationRequest) throws ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, GrafanaException
Updates the configuration string for the given workspace
- Parameters:
updateWorkspaceConfigurationRequest-- Returns:
- Result of the UpdateWorkspaceConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkspaceConfiguration
default 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.Builderavoiding the need to create one manually viaUpdateWorkspaceConfigurationRequest.builder()- Parameters:
updateWorkspaceConfigurationRequest- AConsumerthat will call methods onUpdateWorkspaceConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateWorkspaceConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static GrafanaClient create()
Create aGrafanaClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static GrafanaClientBuilder builder()
Create a builder that can be used to configure and create aGrafanaClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default GrafanaServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-