AbstractAmazonManagedGrafana (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.managedgrafana.AbstractAmazonManagedGrafana

All Implemented Interfaces:

AmazonManagedGrafana

Direct Known Subclasses:

AbstractAmazonManagedGrafanaAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonManagedGrafana
extends Object
implements AmazonManagedGrafana
```
Abstract implementation of AmazonManagedGrafana. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.managedgrafana.AmazonManagedGrafana
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateLicenseResult`	`associateLicense(AssociateLicenseRequest request)` Assigns a Grafana Enterprise license to a workspace.
`CreateWorkspaceResult`	`createWorkspace(CreateWorkspaceRequest request)` Creates a workspace.
`CreateWorkspaceApiKeyResult`	`createWorkspaceApiKey(CreateWorkspaceApiKeyRequest request)` Creates a Grafana API key for the workspace.
`CreateWorkspaceServiceAccountResult`	`createWorkspaceServiceAccount(CreateWorkspaceServiceAccountRequest request)` Creates a service account for the workspace.
`CreateWorkspaceServiceAccountTokenResult`	`createWorkspaceServiceAccountToken(CreateWorkspaceServiceAccountTokenRequest request)` Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account.
`DeleteWorkspaceResult`	`deleteWorkspace(DeleteWorkspaceRequest request)` Deletes an Amazon Managed Grafana workspace.
`DeleteWorkspaceApiKeyResult`	`deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest request)` Deletes a Grafana API key for the workspace.
`DeleteWorkspaceServiceAccountResult`	`deleteWorkspaceServiceAccount(DeleteWorkspaceServiceAccountRequest request)` Deletes a workspace service account from the workspace.
`DeleteWorkspaceServiceAccountTokenResult`	`deleteWorkspaceServiceAccountToken(DeleteWorkspaceServiceAccountTokenRequest request)` Deletes a token for the workspace service account.
`DescribeWorkspaceResult`	`describeWorkspace(DescribeWorkspaceRequest request)` Displays information about one Amazon Managed Grafana workspace.
`DescribeWorkspaceAuthenticationResult`	`describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest request)` Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
`DescribeWorkspaceConfigurationResult`	`describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest request)` Gets the current configuration string for the given workspace.
`DisassociateLicenseResult`	`disassociateLicense(DisassociateLicenseRequest request)` 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 request)` Lists the users and groups who have the Grafana `Admin` and `Editor` roles in this workspace.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` The `ListTagsForResource` operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the `resourceArn`.
`ListVersionsResult`	`listVersions(ListVersionsRequest request)` Lists available versions of Grafana.
`ListWorkspacesResult`	`listWorkspaces(ListWorkspacesRequest request)` Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.
`ListWorkspaceServiceAccountsResult`	`listWorkspaceServiceAccounts(ListWorkspaceServiceAccountsRequest request)` Returns a list of service accounts for a workspace.
`ListWorkspaceServiceAccountTokensResult`	`listWorkspaceServiceAccountTokens(ListWorkspaceServiceAccountTokensRequest request)` 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 request)` The `TagResource` operation associates tags with an Amazon Managed Grafana resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` The `UntagResource` operation removes the association of the tag with the Amazon Managed Grafana resource.
`UpdatePermissionsResult`	`updatePermissions(UpdatePermissionsRequest request)` Updates which users in a workspace have the Grafana `Admin` or `Editor` roles.
`UpdateWorkspaceResult`	`updateWorkspace(UpdateWorkspaceRequest request)` Modifies an existing Amazon Managed Grafana workspace.
`UpdateWorkspaceAuthenticationResult`	`updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest request)` Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.
`UpdateWorkspaceConfigurationResult`	`updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest request)` Updates the configuration string for the given workspace

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - associateLicense
```
public AssociateLicenseResult associateLicense(AssociateLicenseRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    associateLicense in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the AssociateLicense operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createWorkspace
```
public CreateWorkspaceResult createWorkspace(CreateWorkspaceRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    createWorkspace in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the CreateWorkspace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createWorkspaceApiKey
```
public CreateWorkspaceApiKeyResult createWorkspaceApiKey(CreateWorkspaceApiKeyRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    createWorkspaceApiKey in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the CreateWorkspaceApiKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createWorkspaceServiceAccount
```
public CreateWorkspaceServiceAccountResult createWorkspaceServiceAccount(CreateWorkspaceServiceAccountRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    createWorkspaceServiceAccount in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the CreateWorkspaceServiceAccount operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createWorkspaceServiceAccountToken
```
public CreateWorkspaceServiceAccountTokenResult createWorkspaceServiceAccountToken(CreateWorkspaceServiceAccountTokenRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    createWorkspaceServiceAccountToken in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the CreateWorkspaceServiceAccountToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkspace
```
public DeleteWorkspaceResult deleteWorkspace(DeleteWorkspaceRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    Deletes an Amazon Managed Grafana workspace.
    
    Specified by:
    
    deleteWorkspace in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the DeleteWorkspace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkspaceApiKey
```
public DeleteWorkspaceApiKeyResult deleteWorkspaceApiKey(DeleteWorkspaceApiKeyRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    deleteWorkspaceApiKey in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the DeleteWorkspaceApiKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkspaceServiceAccount
```
public DeleteWorkspaceServiceAccountResult deleteWorkspaceServiceAccount(DeleteWorkspaceServiceAccountRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    deleteWorkspaceServiceAccount in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the DeleteWorkspaceServiceAccount operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkspaceServiceAccountToken
```
public DeleteWorkspaceServiceAccountTokenResult deleteWorkspaceServiceAccountToken(DeleteWorkspaceServiceAccountTokenRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    deleteWorkspaceServiceAccountToken in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the DeleteWorkspaceServiceAccountToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeWorkspace
```
public DescribeWorkspaceResult describeWorkspace(DescribeWorkspaceRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    Displays information about one Amazon Managed Grafana workspace.
    
    Specified by:
    
    describeWorkspace in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the DescribeWorkspace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeWorkspaceAuthentication
```
public DescribeWorkspaceAuthenticationResult describeWorkspaceAuthentication(DescribeWorkspaceAuthenticationRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
    
    Specified by:
    
    describeWorkspaceAuthentication in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the DescribeWorkspaceAuthentication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeWorkspaceConfiguration
```
public DescribeWorkspaceConfigurationResult describeWorkspaceConfiguration(DescribeWorkspaceConfigurationRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    Gets the current configuration string for the given workspace.
    
    Specified by:
    
    describeWorkspaceConfiguration in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the DescribeWorkspaceConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateLicense
```
public DisassociateLicenseResult disassociateLicense(DisassociateLicenseRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    Removes the Grafana Enterprise license from a workspace.
    
    Specified by:
    
    disassociateLicense in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the DisassociateLicense operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPermissions
```
public ListPermissionsResult listPermissions(ListPermissionsRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    listPermissions in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the ListPermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    listTagsForResource in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listVersions
```
public ListVersionsResult listVersions(ListVersionsRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    listVersions in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the ListVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWorkspaceServiceAccountTokens
```
public ListWorkspaceServiceAccountTokensResult listWorkspaceServiceAccountTokens(ListWorkspaceServiceAccountTokensRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    listWorkspaceServiceAccountTokens in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the ListWorkspaceServiceAccountTokens operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWorkspaceServiceAccounts
```
public ListWorkspaceServiceAccountsResult listWorkspaceServiceAccounts(ListWorkspaceServiceAccountsRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    listWorkspaceServiceAccounts in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the ListWorkspaceServiceAccounts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWorkspaces
```
public ListWorkspacesResult listWorkspaces(ListWorkspacesRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    listWorkspaces in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the ListWorkspaces operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    tagResource in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource.
    
    Specified by:
    
    untagResource in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updatePermissions
```
public UpdatePermissionsResult updatePermissions(UpdatePermissionsRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    Updates which users in a workspace have the Grafana Admin or Editor roles.
    
    Specified by:
    
    updatePermissions in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the UpdatePermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateWorkspace
```
public UpdateWorkspaceResult updateWorkspace(UpdateWorkspaceRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    updateWorkspace in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the UpdateWorkspace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateWorkspaceAuthentication
```
public UpdateWorkspaceAuthenticationResult updateWorkspaceAuthentication(UpdateWorkspaceAuthenticationRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    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.
    
    Specified by:
    
    updateWorkspaceAuthentication in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the UpdateWorkspaceAuthentication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateWorkspaceConfiguration
```
public UpdateWorkspaceConfigurationResult updateWorkspaceConfiguration(UpdateWorkspaceConfigurationRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    Updates the configuration string for the given workspace
    
    Specified by:
    
    updateWorkspaceConfiguration in interface AmazonManagedGrafana
    
    Returns:
    
    Result of the UpdateWorkspaceConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonManagedGrafana
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonManagedGrafana
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonManagedGrafana
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonManagedGrafana
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.792

Class AbstractAmazonManagedGrafana

Field Summary

Fields inherited from interface com.amazonaws.services.managedgrafana.AmazonManagedGrafana

Method Summary

Methods inherited from class java.lang.Object

Method Detail

associateLicense

createWorkspace

createWorkspaceApiKey

createWorkspaceServiceAccount

createWorkspaceServiceAccountToken

deleteWorkspace

deleteWorkspaceApiKey

deleteWorkspaceServiceAccount

deleteWorkspaceServiceAccountToken

describeWorkspace

describeWorkspaceAuthentication

describeWorkspaceConfiguration

disassociateLicense

listPermissions

listTagsForResource

listVersions

listWorkspaceServiceAccountTokens

listWorkspaceServiceAccounts

listWorkspaces

tagResource

untagResource

updatePermissions

updateWorkspace

updateWorkspaceAuthentication

updateWorkspaceConfiguration

shutdown

getCachedResponseMetadata