RedshiftDataAPIService / Client / describe_table

describe_table

RedshiftDataAPIService.Client.describe_table(**kwargs)

Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

• Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_table(
    ClusterIdentifier='string',
    ConnectedDatabase='string',
    Database='string',
    DbUser='string',
    MaxResults=123,
    NextToken='string',
    Schema='string',
    SecretArn='string',
    Table='string',
    WorkgroupName='string'
)

Parameters:

• ClusterIdentifier (string) – The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

• ConnectedDatabase (string) – A database name. The connected database is specified when you connect with your authentication credentials.

• Database (string) –

  [REQUIRED]

  The name of the database that contains the tables to be described. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

• DbUser (string) – The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

• MaxResults (integer) – The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.

• NextToken (string) – A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

• Schema (string) – The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.

• SecretArn (string) – The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

• Table (string) – The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned

• WorkgroupName (string) – The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Return type:

dict

Returns:

Response Syntax

{
    'ColumnList': [
        {
            'columnDefault': 'string',
            'isCaseSensitive': True|False,
            'isCurrency': True|False,
            'isSigned': True|False,
            'label': 'string',
            'length': 123,
            'name': 'string',
            'nullable': 123,
            'precision': 123,
            'scale': 123,
            'schemaName': 'string',
            'tableName': 'string',
            'typeName': 'string'
        },
    ],
    'NextToken': 'string',
    'TableName': 'string'
}

Response Structure

• (dict) –

  • ColumnList (list) –

    A list of columns in the table.

    • (dict) –

      The properties (metadata) of a column.

      • columnDefault (string) –

        The default value of the column.

      • isCaseSensitive (boolean) –

        A value that indicates whether the column is case-sensitive.

      • isCurrency (boolean) –

        A value that indicates whether the column contains currency values.

      • isSigned (boolean) –

        A value that indicates whether an integer column is signed.

      • label (string) –

        The label for the column.

      • length (integer) –

        The length of the column.

      • name (string) –

        The name of the column.

      • nullable (integer) –

        A value that indicates whether the column is nullable.

      • precision (integer) –

        The precision value of a decimal number column.

      • scale (integer) –

        The scale value of a decimal number column.

      • schemaName (string) –

        The name of the schema that contains the table that includes the column.

      • tableName (string) –

        The name of the table that includes the column.

      • typeName (string) –

        The database-specific data type of the column.

  • NextToken (string) –

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

  • TableName (string) –

    The table name.

Exceptions

• RedshiftDataAPIService.Client.exceptions.ValidationException

• RedshiftDataAPIService.Client.exceptions.InternalServerException

• RedshiftDataAPIService.Client.exceptions.DatabaseConnectionException