Skip to content

DescribeTableRequest

Source code in docs_src/capo_redshift_data/types/describe_table_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class DescribeTableRequest(TypedDict, closed=True):
    cluster_identifier: NotRequired[
        "capo_redshift_data.types.cluster_identifier_string.ClusterIdentifierString"
    ]
    """<p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>"""
    secret_arn: NotRequired["capo_redshift_data.types.secret_arn.SecretArn"]
    """<p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>"""
    db_user: NotRequired["capo_redshift_data.types.string.String"]
    """<p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>"""
    database: "capo_redshift_data.types.string.String"
    """<p>The name of the database that contains the tables to be described. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>"""
    connected_database: NotRequired["capo_redshift_data.types.string.String"]
    """<p>A database name. The connected database is specified when you connect with your authentication credentials. </p>"""
    schema: NotRequired["capo_redshift_data.types.string.String"]
    """<p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>"""
    table: NotRequired["capo_redshift_data.types.string.String"]
    """<p>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</p>"""
    next_token: NotRequired["capo_redshift_data.types.string.String"]
    """<p>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. </p>"""
    max_results: "capo_redshift_data.types.page_size.PageSize"
    """<p>The maximum number of tables to return in the response. If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>"""
    workgroup_name: NotRequired[
        "capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
    ]
    """<p>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.</p>"""

cluster_identifier instance-attribute 

cluster_identifier: NotRequired[ClusterIdentifierString]

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

connected_database instance-attribute 

connected_database: NotRequired[String]

A database name. The connected database is specified when you connect with your authentication credentials.

database instance-attribute 

database: String

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.

db_user instance-attribute 

db_user: NotRequired[String]

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

max_results instance-attribute 

max_results: PageSize

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.

next_token instance-attribute 

next_token: NotRequired[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 instance-attribute 

schema: NotRequired[String]

The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.

secret_arn instance-attribute 

secret_arn: NotRequired[SecretArn]

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

table instance-attribute 

table: NotRequired[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

workgroup_name instance-attribute 

workgroup_name: NotRequired[WorkgroupNameString]

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.