CreateWorkGroup - Amazon Athena
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.

Request Syntax

{ "Configuration": { "AdditionalConfiguration": "string", "BytesScannedCutoffPerQuery": number, "CustomerContentEncryptionConfiguration": { "KmsKey": "string" }, "EnableMinimumEncryptionConfiguration": boolean, "EnforceWorkGroupConfiguration": boolean, "EngineVersion": { "EffectiveEngineVersion": "string", "SelectedEngineVersion": "string" }, "ExecutionRole": "string", "IdentityCenterConfiguration": { "EnableIdentityCenter": boolean, "IdentityCenterInstanceArn": "string" }, "PublishCloudWatchMetricsEnabled": boolean, "QueryResultsS3AccessGrantsConfiguration": { "AuthenticationType": "string", "CreateUserLevelPrefix": boolean, "EnableS3AccessGrants": boolean }, "RequesterPaysEnabled": boolean, "ResultConfiguration": { "AclConfiguration": { "S3AclOption": "string" }, "EncryptionConfiguration": { "EncryptionOption": "string", "KmsKey": "string" }, "ExpectedBucketOwner": "string", "OutputLocation": "string" } }, "Description": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "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.


Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration:EnforceWorkGroupConfiguration.

Type: WorkGroupConfiguration object

Required: No


The workgroup description.

Type: String

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

Required: No


The workgroup name.

Type: String

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

Required: Yes


A list of comma separated tags to add to the workgroup that is created.

Type: Array of Tag objects

Required: No

Response Elements

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


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


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

HTTP Status Code: 500


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 Amazon SDKs, see the following: