Athena / Client / create_system_table_configuration

create_system_table_configuration

Athena.Client.create_system_table_configuration(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_system_table_configuration(
    ClientRequestToken='string',
    TableName='ALL',
    KmsKeyArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ClientRequestToken (string) –

    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.

    This field is autopopulated if not provided.

  • TableName (string) –

    [REQUIRED]

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

  • KmsKeyArn (string) – The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) key to use for encrypting the system table data.

  • Tags (list) –

    The tags to add to the system table configuration.

    • (dict) –

      A label that you assign to a resource. Athena resources include workgroups, data catalogs, and capacity reservations. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena resources by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

      • Key (string) –

        A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.

      • Value (string) –

        A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.

Return type:

dict

Returns:

Response Syntax

{
    'TableName': 'ALL',
    'KmsKeyArn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'LastModifiedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • TableName (string) –

      The system table configuration that was created. Always ALL.

    • KmsKeyArn (string) –

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

    • CreatedAt (datetime) –

      The date and time the system table configuration was created.

    • LastModifiedAt (datetime) –

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

Exceptions