Amazon Athena
Amazon Athena Documentation (API Version 2017-05-18)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

UpdateWorkGroup

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

Request Syntax

{ "ConfigurationUpdates": { "BytesScannedCutoffPerQuery": number, "EnforceWorkGroupConfiguration": boolean, "PublishCloudWatchMetricsEnabled": boolean, "RemoveBytesScannedCutoffPerQuery": boolean, "RequesterPaysEnabled": boolean, "ResultConfigurationUpdates": { "EncryptionConfiguration": { "EncryptionOption": "string", "KmsKey": "string" }, "OutputLocation": "string", "RemoveEncryptionConfiguration": boolean, "RemoveOutputLocation": boolean } }, "Description": "string", "State": "string", "WorkGroup": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConfigurationUpdates

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

Type: WorkGroupConfigurationUpdates object

Required: No

Description

The workgroup description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

State

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

Type: String

Valid Values: ENABLED | DISABLED

Required: No

WorkGroup

The specified workgroup that will be updated.

Type: String

Pattern: [a-zA-z0-9._-]{1,128}

Required: Yes

Response Elements

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

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

Indicates a platform issue, which may be due to a transient condition or outage.

HTTP Status Code: 500

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: