@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonManagedGrafana
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonManagedGrafana
instead.
Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.
With Amazon Managed Grafana, you create logically isolated Grafana servers called workspaces. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AssociateLicenseResult |
associateLicense(AssociateLicenseRequest associateLicenseRequest)
Assigns a Grafana Enterprise license to a workspace.
|
CreateWorkspaceResult |
createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)
Creates a workspace.
|
CreateWorkspaceApiKeyResult |
createWorkspaceApiKey(CreateWorkspaceApiKeyRequest createWorkspaceApiKeyRequest)
Creates a Grafana API key for the workspace.
|
CreateWorkspaceServiceAccountResult |
createWorkspaceServiceAccount(CreateWorkspaceServiceAccountRequest createWorkspaceServiceAccountRequest)
Creates a service account for the workspace.
|
CreateWorkspaceServiceAccountTokenResult |
createWorkspaceServiceAccountToken(CreateWorkspaceServiceAccountTokenRequest createWorkspaceServiceAccountTokenRequest)
Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account.
|
DeleteWorkspaceResult |
deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)
Deletes an Amazon Managed Grafana workspace.
|
DeleteWorkspaceApiKeyResult |
deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest deleteWorkspaceApiKeyRequest)
Deletes a Grafana API key for the workspace.
|
DeleteWorkspaceServiceAccountResult |
deleteWorkspaceServiceAccount(DeleteWorkspaceServiceAccountRequest deleteWorkspaceServiceAccountRequest)
Deletes a workspace service account from the workspace.
|
DeleteWorkspaceServiceAccountTokenResult |
deleteWorkspaceServiceAccountToken(DeleteWorkspaceServiceAccountTokenRequest deleteWorkspaceServiceAccountTokenRequest)
Deletes a token for the workspace service account.
|
DescribeWorkspaceResult |
describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest)
Displays information about one Amazon Managed Grafana workspace.
|
DescribeWorkspaceAuthenticationResult |
describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest)
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
|
DescribeWorkspaceConfigurationResult |
describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest describeWorkspaceConfigurationRequest)
Gets the current configuration string for the given workspace.
|
DisassociateLicenseResult |
disassociateLicense(DisassociateLicenseRequest disassociateLicenseRequest)
Removes the Grafana Enterprise license from a workspace.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListPermissionsResult |
listPermissions(ListPermissionsRequest listPermissionsRequest)
Lists the users and groups who have the Grafana
Admin and Editor roles in this
workspace. |
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
The
ListTagsForResource operation returns the tags that are associated with the Amazon Managed
Service for Grafana resource specified by the resourceArn . |
ListVersionsResult |
listVersions(ListVersionsRequest listVersionsRequest)
Lists available versions of Grafana.
|
ListWorkspacesResult |
listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
|
ListWorkspaceServiceAccountsResult |
listWorkspaceServiceAccounts(ListWorkspaceServiceAccountsRequest listWorkspaceServiceAccountsRequest)
Returns a list of service accounts for a workspace.
|
ListWorkspaceServiceAccountTokensResult |
listWorkspaceServiceAccountTokens(ListWorkspaceServiceAccountTokensRequest listWorkspaceServiceAccountTokensRequest)
Returns a list of tokens for a workspace service account.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
The
TagResource operation associates tags with an Amazon Managed Grafana resource. |
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
The
UntagResource operation removes the association of the tag with the Amazon Managed Grafana
resource. |
UpdatePermissionsResult |
updatePermissions(UpdatePermissionsRequest updatePermissionsRequest)
Updates which users in a workspace have the Grafana
Admin or Editor roles. |
UpdateWorkspaceResult |
updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest)
Modifies an existing Amazon Managed Grafana workspace.
|
UpdateWorkspaceAuthenticationResult |
updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest)
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using
SAML.
|
UpdateWorkspaceConfigurationResult |
updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest updateWorkspaceConfigurationRequest)
Updates the configuration string for the given workspace
|
static final String ENDPOINT_PREFIX
AssociateLicenseResult associateLicense(AssociateLicenseRequest associateLicenseRequest)
Assigns a Grafana Enterprise license to a workspace. To upgrade, you must use ENTERPRISE
for the
licenseType
, and pass in a valid Grafana Labs token for the grafanaToken
. Upgrading to
Grafana Enterprise incurs additional fees. For more information, see Upgrade a
workspace to Grafana Enterprise.
associateLicenseRequest
- ResourceNotFoundException
- The request references a resource that does not exist.ThrottlingException
- The request was denied because of request throttling. Retry the request.ValidationException
- The value of a parameter in the request caused an error.AccessDeniedException
- You do not have sufficient permissions to perform this action.InternalServerException
- Unexpected error while processing the request. Retry the request.CreateWorkspaceResult createWorkspace(CreateWorkspaceRequest createWorkspaceRequest)
Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.
Don't use CreateWorkspace
to modify an existing workspace. Instead, use UpdateWorkspace.
createWorkspaceRequest
- 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.CreateWorkspaceApiKeyResult createWorkspaceApiKey(CreateWorkspaceApiKeyRequest createWorkspaceApiKeyRequest)
Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https ://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example requests.
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.
createWorkspaceApiKeyRequest
- ResourceNotFoundException
- The request references a resource that does not exist.ThrottlingException
- The request was denied because of request throttling. Retry the request.ConflictException
- A resource was in an inconsistent state during an update or a deletion.ValidationException
- The value of a parameter in the request caused an error.AccessDeniedException
- You do not have sufficient permissions to perform this action.InternalServerException
- Unexpected error while processing the request. Retry the request.ServiceQuotaExceededException
- The request would cause a service quota to be exceeded.CreateWorkspaceServiceAccountResult createWorkspaceServiceAccount(CreateWorkspaceServiceAccountRequest createWorkspaceServiceAccountRequest)
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 GrafanaRole
for your use
case, use CreateWorkspaceServiceAccountToken
to 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.
createWorkspaceServiceAccountRequest
- 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.CreateWorkspaceServiceAccountTokenResult createWorkspaceServiceAccountToken(CreateWorkspaceServiceAccountTokenRequest createWorkspaceServiceAccountTokenRequest)
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.
createWorkspaceServiceAccountTokenRequest
- 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.DeleteWorkspaceResult deleteWorkspace(DeleteWorkspaceRequest deleteWorkspaceRequest)
Deletes an Amazon Managed Grafana workspace.
deleteWorkspaceRequest
- ResourceNotFoundException
- The request references a resource that does not exist.ThrottlingException
- The request was denied because of request throttling. Retry the request.ConflictException
- A resource was in an inconsistent state during an update or a deletion.ValidationException
- The value of a parameter in the request caused an error.AccessDeniedException
- You do not have sufficient permissions to perform this action.InternalServerException
- Unexpected error while processing the request. Retry the request.DeleteWorkspaceApiKeyResult deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest deleteWorkspaceApiKeyRequest)
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.
deleteWorkspaceApiKeyRequest
- ResourceNotFoundException
- The request references a resource that does not exist.ThrottlingException
- The request was denied because of request throttling. Retry the request.ConflictException
- A resource was in an inconsistent state during an update or a deletion.ValidationException
- The value of a parameter in the request caused an error.AccessDeniedException
- You do not have sufficient permissions to perform this action.InternalServerException
- Unexpected error while processing the request. Retry the request.DeleteWorkspaceServiceAccountResult deleteWorkspaceServiceAccount(DeleteWorkspaceServiceAccountRequest deleteWorkspaceServiceAccountRequest)
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.
deleteWorkspaceServiceAccountRequest
- 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.DeleteWorkspaceServiceAccountTokenResult deleteWorkspaceServiceAccountToken(DeleteWorkspaceServiceAccountTokenRequest deleteWorkspaceServiceAccountTokenRequest)
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.
deleteWorkspaceServiceAccountTokenRequest
- 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.DescribeWorkspaceResult describeWorkspace(DescribeWorkspaceRequest describeWorkspaceRequest)
Displays information about one Amazon Managed Grafana workspace.
describeWorkspaceRequest
- ResourceNotFoundException
- The request references a resource that does not exist.ThrottlingException
- The request was denied because of request throttling. Retry the request.ValidationException
- The value of a parameter in the request caused an error.AccessDeniedException
- You do not have sufficient permissions to perform this action.InternalServerException
- Unexpected error while processing the request. Retry the request.DescribeWorkspaceAuthenticationResult describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest describeWorkspaceAuthenticationRequest)
Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
describeWorkspaceAuthenticationRequest
- ResourceNotFoundException
- The request references a resource that does not exist.ThrottlingException
- The request was denied because of request throttling. Retry the request.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.DescribeWorkspaceConfigurationResult describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest describeWorkspaceConfigurationRequest)
Gets the current configuration string for the given workspace.
describeWorkspaceConfigurationRequest
- ResourceNotFoundException
- The request references a resource that does not exist.ThrottlingException
- The request was denied because of request throttling. Retry the request.AccessDeniedException
- You do not have sufficient permissions to perform this action.InternalServerException
- Unexpected error while processing the request. Retry the request.DisassociateLicenseResult disassociateLicense(DisassociateLicenseRequest disassociateLicenseRequest)
Removes the Grafana Enterprise license from a workspace.
disassociateLicenseRequest
- ResourceNotFoundException
- The request references a resource that does not exist.ThrottlingException
- The request was denied because of request throttling. Retry the request.ValidationException
- The value of a parameter in the request caused an error.AccessDeniedException
- You do not have sufficient permissions to perform this action.InternalServerException
- Unexpected error while processing the request. Retry the request.ListPermissionsResult listPermissions(ListPermissionsRequest listPermissionsRequest)
Lists the users and groups who have the Grafana Admin
and Editor
roles in this
workspace. If you use this operation without specifying userId
or groupId
, the
operation returns the roles of all users and groups. If you specify a userId
or a
groupId
, only the roles for that user or group are returned. If you do this, you can specify only
one userId
or one groupId
.
listPermissionsRequest
- 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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
The ListTagsForResource
operation returns the tags that are associated with the Amazon Managed
Service for Grafana resource specified by the resourceArn
. Currently, the only resource that can be
tagged is a workspace.
listTagsForResourceRequest
- 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.ListVersionsResult listVersions(ListVersionsRequest listVersionsRequest)
Lists available versions of Grafana. These are available when calling CreateWorkspace
. Optionally,
include a workspace to list the versions to which it can be upgraded.
listVersionsRequest
- 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.ListWorkspaceServiceAccountTokensResult listWorkspaceServiceAccountTokens(ListWorkspaceServiceAccountTokensRequest listWorkspaceServiceAccountTokensRequest)
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.
listWorkspaceServiceAccountTokensRequest
- 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.ListWorkspaceServiceAccountsResult listWorkspaceServiceAccounts(ListWorkspaceServiceAccountsRequest listWorkspaceServiceAccountsRequest)
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.
listWorkspaceServiceAccountsRequest
- 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.ListWorkspacesResult listWorkspaces(ListWorkspacesRequest listWorkspacesRequest)
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use DescribeWorkspace.
listWorkspacesRequest
- 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
The TagResource
operation associates tags with an Amazon Managed Grafana resource. Currently, the
only resource that can be tagged is workspaces.
If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
tagResourceRequest
- 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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
The UntagResource
operation removes the association of the tag with the Amazon Managed Grafana
resource.
untagResourceRequest
- ResourceNotFoundException
- The request references a resource that does not exist.ThrottlingException
- The request was denied because of request throttling. Retry the request.ValidationException
- The value of a parameter in the request caused an error.AccessDeniedException
- You do not have sufficient permissions to perform this action.InternalServerException
- Unexpected error while processing the request. Retry the request.UpdatePermissionsResult updatePermissions(UpdatePermissionsRequest updatePermissionsRequest)
Updates which users in a workspace have the Grafana Admin
or Editor
roles.
updatePermissionsRequest
- ResourceNotFoundException
- The request references a resource that does not exist.ThrottlingException
- The request was denied because of request throttling. Retry the request.ValidationException
- The value of a parameter in the request caused an error.AccessDeniedException
- You do not have sufficient permissions to perform this action.InternalServerException
- Unexpected error while processing the request. Retry the request.UpdateWorkspaceResult updateWorkspace(UpdateWorkspaceRequest updateWorkspaceRequest)
Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.
To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center, use UpdateWorkspaceAuthentication.
To modify which users in the workspace have the Admin
and Editor
Grafana roles, use UpdatePermissions.
updateWorkspaceRequest
- 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.UpdateWorkspaceAuthenticationResult updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest updateWorkspaceAuthenticationRequest)
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using
SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the
assertion attribute are to have the Admin
and Editor
roles in the workspace.
Changes to the authentication method for a workspace may take a few minutes to take effect.
updateWorkspaceAuthenticationRequest
- 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.UpdateWorkspaceConfigurationResult updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest updateWorkspaceConfigurationRequest)
Updates the configuration string for the given workspace
updateWorkspaceConfigurationRequest
- ResourceNotFoundException
- The request references a resource that does not exist.ThrottlingException
- The request was denied because of request throttling. Retry the request.ConflictException
- A resource was in an inconsistent state during an update or a deletion.ValidationException
- The value of a parameter in the request caused an error.AccessDeniedException
- You do not have sufficient permissions to perform this action.InternalServerException
- Unexpected error while processing the request. Retry the request.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.