GetWorkGroup - Amazon Athena


Returns information about the workgroup with the specified name.

Request Syntax

{ "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.


The name of the workgroup.

Type: String

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

Required: Yes

Response Syntax

{ "WorkGroup": { "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" } }, "CreationTime": number, "Description": "string", "IdentityCenterApplicationArn": "string", "Name": "string", "State": "string" } }

Response Elements

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

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


Information about the workgroup.

Type: WorkGroup object


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