# UpdateWorkgroup
<a name="API_UpdateWorkgroup"></a>

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.

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA turned on, the following capabilities are blocked: 
+ Creating a public access workgroup
+ Modifying a private workgroup to public
+ Adding a subnet with VPC BPA turned on to the workgroup when the workgroup is public

For more information about VPC BPA, see [Block public access to VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html) in the *Amazon VPC User Guide*.

## Request Syntax
<a name="API_UpdateWorkgroup_RequestSyntax"></a>

```
{
   "baseCapacity": number,
   "configParameters": [ 
      { 
         "parameterKey": "string",
         "parameterValue": "string"
      }
   ],
   "enhancedVpcRouting": boolean,
   "extraComputeForAutomaticOptimization": boolean,
   "ipAddressType": "string",
   "maxCapacity": number,
   "port": number,
   "pricePerformanceTarget": { 
      "level": number,
      "status": "string"
   },
   "publiclyAccessible": boolean,
   "securityGroupIds": [ "string" ],
   "subnetIds": [ "string" ],
   "trackName": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_UpdateWorkgroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [baseCapacity](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-baseCapacity"></a>
The new base data warehouse capacity in Redshift Processing Units (RPUs).  
Type: Integer  
Required: No

 ** [configParameters](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-configParameters"></a>
An array of parameters to set for advanced control over a database. The options are `auto_mv`, `datestyle`, `enable_case_sensitive_identifier`, `enable_user_activity_logging`, `query_group`, `search_path`, `require_ssl`, `use_fips_ssl`, and either `wlm_json_configuration` or query monitoring metrics that let you define performance boundaries. You can either specify individual query monitoring metrics (such as `max_scan_row_count`, `max_query_execution_time`) or use `wlm_json_configuration` to define query queues with rules, but not both. If you're using `wlm_json_configuration`, the maximum size of `parameterValue` is 8000 characters. For more information about query monitoring rules and available metrics, see [ Query monitoring metrics for Amazon Redshift Serverless](https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless).  
Type: Array of [ConfigParameter](API_ConfigParameter.md) objects  
Required: No

 ** [enhancedVpcRouting](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-enhancedVpcRouting"></a>
The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.  
Type: Boolean  
Required: No

 ** [extraComputeForAutomaticOptimization](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-extraComputeForAutomaticOptimization"></a>
If `true`, allocates additional compute resources for running automatic optimization operations.  
Default: false  
Type: Boolean  
Required: No

 ** [ipAddressType](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-ipAddressType"></a>
The IP address type that the workgroup supports. Possible values are `ipv4` and `dualstack`.  
Type: String  
Pattern: `(ipv4|dualstack)`   
Required: No

 ** [maxCapacity](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-maxCapacity"></a>
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.  
Type: Integer  
Required: No

 ** [port](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-port"></a>
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.  
Type: Integer  
Required: No

 ** [pricePerformanceTarget](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-pricePerformanceTarget"></a>
An object that represents the price performance target settings for the workgroup.  
Type: [PerformanceTarget](API_PerformanceTarget.md) object  
Required: No

 ** [publiclyAccessible](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-publiclyAccessible"></a>
A value that specifies whether the workgroup can be accessible from a public network.  
Type: Boolean  
Required: No

 ** [securityGroupIds](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-securityGroupIds"></a>
An array of security group IDs to associate with the workgroup.  
Type: Array of strings  
Required: No

 ** [subnetIds](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-subnetIds"></a>
An array of VPC subnet IDs to associate with the workgroup.  
Type: Array of strings  
Required: No

 ** [trackName](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-trackName"></a>
An optional parameter for the name of the track for the workgroup. If you don't provide a track name, the workgroup is assigned to the `current` track.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_]+`   
Required: No

 ** [workgroupName](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-workgroupName"></a>
The name of the workgroup to update. You can't update the name of a workgroup once it is created.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_UpdateWorkgroup_ResponseSyntax"></a>

```
{
   "workgroup": { 
      "baseCapacity": number,
      "configParameters": [ 
         { 
            "parameterKey": "string",
            "parameterValue": "string"
         }
      ],
      "creationDate": "string",
      "crossAccountVpcs": [ "string" ],
      "customDomainCertificateArn": "string",
      "customDomainCertificateExpiryTime": "string",
      "customDomainName": "string",
      "endpoint": { 
         "address": "string",
         "port": number,
         "vpcEndpoints": [ 
            { 
               "networkInterfaces": [ 
                  { 
                     "availabilityZone": "string",
                     "ipv6Address": "string",
                     "networkInterfaceId": "string",
                     "privateIpAddress": "string",
                     "subnetId": "string"
                  }
               ],
               "vpcEndpointId": "string",
               "vpcId": "string"
            }
         ]
      },
      "enhancedVpcRouting": boolean,
      "extraComputeForAutomaticOptimization": boolean,
      "ipAddressType": "string",
      "maxCapacity": number,
      "namespaceName": "string",
      "patchVersion": "string",
      "pendingTrackName": "string",
      "port": number,
      "pricePerformanceTarget": { 
         "level": number,
         "status": "string"
      },
      "publiclyAccessible": boolean,
      "securityGroupIds": [ "string" ],
      "status": "string",
      "subnetIds": [ "string" ],
      "trackName": "string",
      "workgroupArn": "string",
      "workgroupId": "string",
      "workgroupName": "string",
      "workgroupVersion": "string"
   }
}
```

## Response Elements
<a name="API_UpdateWorkgroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [workgroup](#API_UpdateWorkgroup_ResponseSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-response-workgroup"></a>
The updated workgroup object.  
Type: [Workgroup](API_Workgroup.md) object

## Errors
<a name="API_UpdateWorkgroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InsufficientCapacityException **   
There is an insufficient capacity to perform the action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** Ipv6CidrBlockNotFoundException **   
There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateWorkgroup_Examples"></a>

### Example
<a name="API_UpdateWorkgroup_Example_1"></a>

This example illustrates one usage of UpdateWorkgroup.

#### Sample Request
<a name="API_UpdateWorkgroup_Example_1_Request"></a>

```
aws redshift-serverless update-workgroup
--workgroup-name test-wg
--track-name trailing
```

#### Sample Response
<a name="API_UpdateWorkgroup_Example_1_Response"></a>

```
{
  "workgroup": {
    "workgroupId": "875083e4-50b5-4ad7-bd8b-b01beb74d912",
    "workgroupArn": "arn:aws:redshift-serverless:us-east-1:012345678901:workgroup/875083e4-50b5-4ad7-bd8b-b01beb74d912",
    "workgroupName": "test-wg",
    "namespaceName": "test-namespace",
    "baseCapacity": 32,
    "enhancedVpcRouting": false,
    ...
    "ipAddressType": "ipv4",
    "trackName": "current"
    "pendingTrackName": "trailing"
  }
}
```

## See Also
<a name="API_UpdateWorkgroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/UpdateWorkgroup)