Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateSystemTableConfiguration

Enables system tables for the current account. System tables are enabled or disabled for the entire account: creating this configuration enables them. If a configuration already exists, use UpdateSystemTableConfiguration to update it.

Request Syntax


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

ClientRequestToken

A unique case-sensitive string used to ensure the request to create the system table configuration is idempotent (executes only once). If another CreateSystemTableConfiguration request is received with the same client token but different parameters, the request fails with an InvalidRequestException.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 128.

Required: No

KmsKeyArn

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) key to use 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/_\-]+)$

Required: No

TableName

The system table configuration to create. The only accepted value is ALL, the reserved keyword that enables all system tables for the account.

Type: String

Valid Values: ALL

Required: Yes

Tags

The tags to add to the system table configuration.

Type: Array of Tag objects

Required: No

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 that was created. 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

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