GetWorkGroupCommand

Suggest an Edit

Returns information about the workgroup with the specified name.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AthenaClient, GetWorkGroupCommand } from "@aws-sdk/client-athena"; // ES Modules import
// const { AthenaClient, GetWorkGroupCommand } = require("@aws-sdk/client-athena"); // CommonJS import
const client = new AthenaClient(config);
const input = { // GetWorkGroupInput
  WorkGroup: "STRING_VALUE", // required
};
const command = new GetWorkGroupCommand(input);
const response = await client.send(command);
// { // GetWorkGroupOutput
//   WorkGroup: { // WorkGroup
//     Name: "STRING_VALUE", // required
//     State: "ENABLED" || "DISABLED",
//     Configuration: { // WorkGroupConfiguration
//       ResultConfiguration: { // ResultConfiguration
//         OutputLocation: "STRING_VALUE",
//         EncryptionConfiguration: { // EncryptionConfiguration
//           EncryptionOption: "SSE_S3" || "SSE_KMS" || "CSE_KMS", // required
//           KmsKey: "STRING_VALUE",
//         },
//         ExpectedBucketOwner: "STRING_VALUE",
//         AclConfiguration: { // AclConfiguration
//           S3AclOption: "BUCKET_OWNER_FULL_CONTROL", // required
//         },
//       },
//       EnforceWorkGroupConfiguration: true || false,
//       PublishCloudWatchMetricsEnabled: true || false,
//       BytesScannedCutoffPerQuery: Number("long"),
//       RequesterPaysEnabled: true || false,
//       EngineVersion: { // EngineVersion
//         SelectedEngineVersion: "STRING_VALUE",
//         EffectiveEngineVersion: "STRING_VALUE",
//       },
//       AdditionalConfiguration: "STRING_VALUE",
//       ExecutionRole: "STRING_VALUE",
//       CustomerContentEncryptionConfiguration: { // CustomerContentEncryptionConfiguration
//         KmsKey: "STRING_VALUE", // required
//       },
//       EnableMinimumEncryptionConfiguration: true || false,
//       IdentityCenterConfiguration: { // IdentityCenterConfiguration
//         EnableIdentityCenter: true || false,
//         IdentityCenterInstanceArn: "STRING_VALUE",
//       },
//       QueryResultsS3AccessGrantsConfiguration: { // QueryResultsS3AccessGrantsConfiguration
//         EnableS3AccessGrants: true || false, // required
//         CreateUserLevelPrefix: true || false,
//         AuthenticationType: "DIRECTORY_IDENTITY", // required
//       },
//     },
//     Description: "STRING_VALUE",
//     CreationTime: new Date("TIMESTAMP"),
//     IdentityCenterApplicationArn: "STRING_VALUE",
//   },
// };

GetWorkGroupCommand Input

See GetWorkGroupCommandInput for more details

Parameter
Type
Description
WorkGroup
Required
string | undefined

The name of the workgroup.

GetWorkGroupCommand Output

See GetWorkGroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
WorkGroup
WorkGroup | undefined

Information about the workgroup.

Throws

Name
Fault
Details
InternalServerException
server

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

InvalidRequestException
client

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

AthenaServiceException
Base exception class for all service exceptions from Athena service.