import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GrafanaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GrafanaClient"; import type { UpdateWorkspaceRequest, UpdateWorkspaceResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateWorkspaceCommand}. */ export interface UpdateWorkspaceCommandInput extends UpdateWorkspaceRequest { } /** * @public * * The output of {@link UpdateWorkspaceCommand}. */ export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, __MetadataBearer { } declare const UpdateWorkspaceCommand_base: { new (input: UpdateWorkspaceCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: UpdateWorkspaceCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { GrafanaClient, UpdateWorkspaceCommand } from "@aws-sdk/client-grafana"; // ES Modules import * // const { GrafanaClient, UpdateWorkspaceCommand } = require("@aws-sdk/client-grafana"); // CommonJS import * // import type { GrafanaClientConfig } from "@aws-sdk/client-grafana"; * const config = {}; // type is GrafanaClientConfig * const client = new GrafanaClient(config); * const input = { // UpdateWorkspaceRequest * accountAccessType: "STRING_VALUE", * organizationRoleName: "STRING_VALUE", * permissionType: "STRING_VALUE", * stackSetName: "STRING_VALUE", * workspaceDataSources: [ // DataSourceTypesList * "STRING_VALUE", * ], * workspaceDescription: "STRING_VALUE", * workspaceId: "STRING_VALUE", // required * workspaceName: "STRING_VALUE", * workspaceNotificationDestinations: [ // NotificationDestinationsList * "STRING_VALUE", * ], * workspaceOrganizationalUnits: [ // OrganizationalUnitList * "STRING_VALUE", * ], * workspaceRoleArn: "STRING_VALUE", * vpcConfiguration: { // VpcConfiguration * securityGroupIds: [ // SecurityGroupIds // required * "STRING_VALUE", * ], * subnetIds: [ // SubnetIds // required * "STRING_VALUE", * ], * }, * removeVpcConfiguration: true || false, * networkAccessControl: { // NetworkAccessConfiguration * prefixListIds: [ // PrefixListIds // required * "STRING_VALUE", * ], * vpceIds: [ // VpceIds // required * "STRING_VALUE", * ], * }, * removeNetworkAccessConfiguration: true || false, * }; * const command = new UpdateWorkspaceCommand(input); * const response = await client.send(command); * // { // UpdateWorkspaceResponse * // workspace: { // WorkspaceDescription * // accountAccessType: "STRING_VALUE", * // created: new Date("TIMESTAMP"), // required * // dataSources: [ // DataSourceTypesList // required * // "STRING_VALUE", * // ], * // description: "STRING_VALUE", * // endpoint: "STRING_VALUE", // required * // grafanaVersion: "STRING_VALUE", // required * // id: "STRING_VALUE", // required * // modified: new Date("TIMESTAMP"), // required * // name: "STRING_VALUE", * // organizationRoleName: "STRING_VALUE", * // notificationDestinations: [ // NotificationDestinationsList * // "STRING_VALUE", * // ], * // organizationalUnits: [ // OrganizationalUnitList * // "STRING_VALUE", * // ], * // permissionType: "STRING_VALUE", * // stackSetName: "STRING_VALUE", * // status: "STRING_VALUE", // required * // workspaceRoleArn: "STRING_VALUE", * // licenseType: "STRING_VALUE", * // freeTrialConsumed: true || false, * // licenseExpiration: new Date("TIMESTAMP"), * // freeTrialExpiration: new Date("TIMESTAMP"), * // authentication: { // AuthenticationSummary * // providers: [ // AuthenticationProviders // required * // "STRING_VALUE", * // ], * // samlConfigurationStatus: "STRING_VALUE", * // }, * // tags: { // TagMap * // "": "STRING_VALUE", * // }, * // vpcConfiguration: { // VpcConfiguration * // securityGroupIds: [ // SecurityGroupIds // required * // "STRING_VALUE", * // ], * // subnetIds: [ // SubnetIds // required * // "STRING_VALUE", * // ], * // }, * // networkAccessControl: { // NetworkAccessConfiguration * // prefixListIds: [ // PrefixListIds // required * // "STRING_VALUE", * // ], * // vpceIds: [ // VpceIds // required * // "STRING_VALUE", * // ], * // }, * // grafanaToken: "STRING_VALUE", * // kmsKeyId: "STRING_VALUE", * // }, * // }; * * ``` * * @param UpdateWorkspaceCommandInput - {@link UpdateWorkspaceCommandInput} * @returns {@link UpdateWorkspaceCommandOutput} * @see {@link UpdateWorkspaceCommandInput} for command's `input` shape. * @see {@link UpdateWorkspaceCommandOutput} for command's `response` shape. * @see {@link GrafanaClientResolvedConfig | config} for GrafanaClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You do not have sufficient permissions to perform this action.

* * @throws {@link ConflictException} (client fault) *

A resource was in an inconsistent state during an update or a deletion.

* * @throws {@link InternalServerException} (server fault) *

Unexpected error while processing the request. Retry the request.

* * @throws {@link ResourceNotFoundException} (client fault) *

The request references a resource that does not exist.

* * @throws {@link ThrottlingException} (client fault) *

The request was denied because of request throttling. Retry the request.

* * @throws {@link ValidationException} (client fault) *

The value of a parameter in the request caused an error.

* * @throws {@link GrafanaServiceException} *

Base exception class for all service exceptions from Grafana service.

* * * @public */ export declare class UpdateWorkspaceCommand extends UpdateWorkspaceCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateWorkspaceRequest; output: UpdateWorkspaceResponse; }; sdk: { input: UpdateWorkspaceCommandInput; output: UpdateWorkspaceCommandOutput; }; }; }