CreateWorkGroup
Creates a workgroup with the specified name.
Request Syntax
{
"Configuration": {
"BytesScannedCutoffPerQuery": number
,
"EnforceWorkGroupConfiguration": boolean
,
"EngineVersion": {
"EffectiveEngineVersion": "string
",
"SelectedEngineVersion": "string
"
},
"PublishCloudWatchMetricsEnabled": boolean
,
"RequesterPaysEnabled": boolean
,
"ResultConfiguration": {
"EncryptionConfiguration": {
"EncryptionOption": "string
",
"KmsKey": "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.
- Configuration
-
The configuration for the workgroup, which includes the location in Amazon S3 where query 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
- Description
-
The workgroup description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- Name
-
The workgroup name.
Type: String
Pattern:
[a-zA-Z0-9._-]{1,128}
Required: Yes
- Tags
-
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.
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: