RedshiftDataAPIService / Paginator / DescribeTable

DescribeTable#

class RedshiftDataAPIService.Paginator.DescribeTable#
paginator = client.get_paginator('describe_table')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from RedshiftDataAPIService.Client.describe_table().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterIdentifier='string',
    ConnectedDatabase='string',
    Database='string',
    DbUser='string',
    Schema='string',
    SecretArn='string',
    Table='string',
    WorkgroupName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

  • 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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],
    '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.

    • TableName (string) –

      The table name.