Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetWorkGroup

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.

WorkGroup

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.

WorkGroup

Information about the workgroup.

Type: WorkGroup object

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