- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeWorkspaceConfigurationCommand
Gets the current configuration string for the given workspace.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { GrafanaClient, DescribeWorkspaceConfigurationCommand } from "@aws-sdk/client-grafana"; // ES Modules import
// const { GrafanaClient, DescribeWorkspaceConfigurationCommand } = require("@aws-sdk/client-grafana"); // CommonJS import
const client = new GrafanaClient(config);
const input = { // DescribeWorkspaceConfigurationRequest
workspaceId: "STRING_VALUE", // required
};
const command = new DescribeWorkspaceConfigurationCommand(input);
const response = await client.send(command);
// { // DescribeWorkspaceConfigurationResponse
// configuration: "STRING_VALUE", // required
// grafanaVersion: "STRING_VALUE",
// };
DescribeWorkspaceConfigurationCommand Input
See DescribeWorkspaceConfigurationCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
workspaceIdRequired | string | undefined | The ID of the workspace to get configuration information for. |
DescribeWorkspaceConfigurationCommand Output
See DescribeWorkspaceConfigurationCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
configurationRequired | AutomaticJsonStringConversion | string | undefined | The configuration string for the workspace that you requested. For more information about the format and configuration options available, see Working in your Grafana workspace . |
grafanaVersion | string | undefined | The supported Grafana version for the workspace. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You do not have sufficient permissions to perform this action. |
| InternalServerException | server | Unexpected error while processing the request. Retry the request. |
| ResourceNotFoundException | client | The request references a resource that does not exist. |
| ThrottlingException | client | The request was denied because of request throttling. Retry the request. |
| GrafanaServiceException | Base exception class for all service exceptions from Grafana service. |