Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . athena ]



Updates the workgroup with the specified name. The workgroup's name cannot be changed.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--work-group <value>
[--description <value>]
[--configuration-updates <value>]
[--state <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--work-group (string)

The specified workgroup that will be updated.

--description (string)

The workgroup description.

--configuration-updates (structure)

The workgroup configuration that will be updated for the given workgroup.

Shorthand Syntax:


JSON Syntax:

  "EnforceWorkGroupConfiguration": true|false,
  "ResultConfigurationUpdates": {
    "OutputLocation": "string",
    "RemoveOutputLocation": true|false,
    "EncryptionConfiguration": {
      "EncryptionOption": "SSE_S3"|"SSE_KMS"|"CSE_KMS",
      "KmsKey": "string"
    "RemoveEncryptionConfiguration": true|false
  "PublishCloudWatchMetricsEnabled": true|false,
  "BytesScannedCutoffPerQuery": long,
  "RemoveBytesScannedCutoffPerQuery": true|false,
  "RequesterPaysEnabled": true|false

--state (string)

The workgroup state that will be updated for the given workgroup.

Possible values:


--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.