Class UpdateWorkgroupCommandProtected

Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.

Example

Use a bare-bones client and the command you need to make an API call.

import { RedshiftServerlessClient, UpdateWorkgroupCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import
// const { RedshiftServerlessClient, UpdateWorkgroupCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import
const client = new RedshiftServerlessClient(config);
const input = { // UpdateWorkgroupRequest
  workgroupName: "STRING_VALUE", // required
  baseCapacity: Number("int"),
  enhancedVpcRouting: true || false,
  configParameters: [ // ConfigParameterList
    { // ConfigParameter
      parameterKey: "STRING_VALUE",
      parameterValue: "STRING_VALUE",
    },
  ],
  publiclyAccessible: true || false,
  subnetIds: [ // SubnetIdList
    "STRING_VALUE",
  ],
  securityGroupIds: [ // SecurityGroupIdList
    "STRING_VALUE",
  ],
  port: Number("int"),
};
const command = new UpdateWorkgroupCommand(input);
const response = await client.send(command);

Param

UpdateWorkgroupCommandInput

Returns

UpdateWorkgroupCommandOutput

See

• UpdateWorkgroupCommandInput for command's input shape.
• UpdateWorkgroupCommandOutput for command's response shape.
• config for RedshiftServerlessClient's config shape.

Throws

ConflictException (client fault)

The submitted action has conflicts.

Throws

InsufficientCapacityException (client fault)

There is an insufficient capacity to perform the action.

Throws

InternalServerException (server fault)

The request processing has failed because of an unknown error, exception or failure.

Throws

ResourceNotFoundException (client fault)

The resource could not be found.

Throws

ValidationException (client fault)

The input failed to satisfy the constraints specified by an AWS service.