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 (p. 141).
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateWorkGroup
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": {
"ExpectedBucketOwner": "string", "OutputLocation": "string"
} },
"Description": "string", "Name": "string",
"Tags": [
For information about the parameters that are common to all actions, see Common Parameters (p. 139).
The request accepts the following data in JSON format.
Configuration (p. 16)
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
Response Elements
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
A list of comma separated tags to add to the workgroup that is created.
Type: Array of Tag (p. 128) 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 (p. 141).
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
See Also
• AWS SDK for Ruby V3
DeleteDataCatalog
DeleteDataCatalog
Deletes a data catalog.
Request Syntax
{ "Name": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 139).
The request accepts the following data in JSON format.
Name (p. 19)
The name of the data catalog to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: Yes
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 (p. 141).
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:
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteNamedQuery
DeleteNamedQuery
Deletes the named query if you have access to the workgroup in which the query was saved.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
Request Syntax
{ "NamedQueryId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 139).
The request accepts the following data in JSON format.
NamedQueryId (p. 21)
The unique ID of the query to delete.
Type: String Required: Yes
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 (p. 141).
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:
• AWS Command Line Interface
See Also
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeletePreparedStatement
DeletePreparedStatement
Deletes the prepared statement with the specified name from the specified workgroup.
Request Syntax
{ "StatementName": "string", "WorkGroup": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 139).
The request accepts the following data in JSON format.
StatementName (p. 23)
The name of the prepared statement to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [a-zA-Z_][a-zA-Z0-9_@:]{1,256}
Required: Yes WorkGroup (p. 23)
The workgroup to which the statement to be deleted belongs.
Type: String
Pattern: [a-zA-Z0-9._-]{1,128}
Required: Yes
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 (p. 141).
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.
See Also
HTTP Status Code: 400 ResourceNotFoundException
A resource, such as a workgroup, was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteWorkGroup
DeleteWorkGroup
Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
Request Syntax
{
"RecursiveDeleteOption": boolean, "WorkGroup": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 139).
The request accepts the following data in JSON format.
RecursiveDeleteOption (p. 25)
The option to delete the workgroup and its contents even if the workgroup contains any named queries or query executions.
Type: Boolean Required: No WorkGroup (p. 25)
The unique name of the workgroup to delete.
Type: String
Pattern: [a-zA-Z0-9._-]{1,128}
Required: Yes
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 (p. 141).
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetDatabase
GetDatabase
Returns a database object for the specified database and data catalog.
Request Syntax
{ "CatalogName": "string", "DatabaseName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 139).
The request accepts the following data in JSON format.
CatalogName (p. 27)
The name of the data catalog that contains the database to return.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: Yes DatabaseName (p. 27)
The name of the database to return.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes