View a markdown version of this page

UpdateSystemTableConfiguration - Amazon Athena

UpdateSystemTableConfiguration

Updates the account-level system tables configuration. If no configuration exists, use CreateSystemTableConfiguration to create one. Fields that you omit retain their current values.

Request Syntax

{ "KmsKeyArn": "string", "TableName": "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.

KmsKeyArn

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) key to use for encrypting the system table data. The encryption key is immutable while the system table exists, so a change takes effect only after the table has been deleted.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:kms:[a-z0-9\-]+:\d{12}:(key/(mrk-)?[0-9a-f\-]+|alias/[a-zA-Z0-9/_\-]+)$

Required: No

TableName

The system table configuration to update. The only accepted value is ALL.

Type: String

Valid Values: ALL

Required: Yes

Response Syntax

{ "CreatedAt": number, "KmsKeyArn": "string", "LastModifiedAt": number, "TableName": "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.

CreatedAt

The date and time the system table configuration was created.

Type: Timestamp

KmsKeyArn

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) key used for encrypting the system table data.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:kms:[a-z0-9\-]+:\d{12}:(key/(mrk-)?[0-9a-f\-]+|alias/[a-zA-Z0-9/_\-]+)$

LastModifiedAt

The date and time the system table configuration was last modified.

Type: Timestamp

TableName

The system table configuration. Always ALL.

Type: String

Valid Values: ALL

Errors

For information about the errors that are common to all actions, see Common Error Types.

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.

AthenaErrorCode

The error code returned when the query execution failed to process, or when the processing request for the named query failed.

HTTP Status Code: 400

ResourceNotFoundException

A resource, such as a workgroup, was not found.

ResourceName

The name of the Amazon resource.

HTTP Status Code: 400

TooManyRequestsException

Indicates that the request was throttled.

Reason

The reason for the query throttling, for example, when it exceeds the concurrent query limit.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: