class Aws::RedshiftDataAPIService::Types::DescribeTableRequest

@note When making an API call, you may pass DescribeTableRequest

data as a hash:

    {
      cluster_identifier: "Location", # required
      connected_database: "String",
      database: "String", # required
      db_user: "String",
      max_results: 1,
      next_token: "String",
      schema: "String",
      secret_arn: "SecretArn",
      table: "String",
    }

@!attribute [rw] cluster_identifier

The cluster identifier. This parameter is required when
authenticating using either Secrets Manager or temporary
credentials.
@return [String]

@!attribute [rw] connected_database

A database name. The connected database is specified when you
connect with your authentication credentials.
@return [String]

@!attribute [rw] database

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.
@return [String]

@!attribute [rw] db_user

The database user name. This parameter is required when
authenticating using temporary credentials.
@return [String]

@!attribute [rw] max_results

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.
@return [Integer]

@!attribute [rw] next_token

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.
@return [String]

@!attribute [rw] schema

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

@!attribute [rw] secret_arn

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

@!attribute [rw] table

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
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeTableRequest AWS API Documentation

Constants

SENSITIVE