You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RedshiftDataAPIService::Types::DescribeTableRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeTableRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifier ⇒ String

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Returns:

  • (String) —

    The cluster identifier.

#database ⇒ String

The name of the database. This parameter is required when authenticating using temporary credentials.

Returns:

  • (String) —

    The name of the database.

#db_user ⇒ String

The database user name. This parameter is required when authenticating using temporary credentials.

Returns:

  • (String) —

    The database user name.

#max_results ⇒ 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.

Returns:

  • (Integer) —

    The maximum number of tables to return in the response.

#next_token ⇒ 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.

Returns:

  • (String) —

    A value that indicates the starting point for the next set of response records in a subsequent request.

#schema ⇒ String

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

Returns:

  • (String) —

    The schema that contains the table.

#secret_arn ⇒ String

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

Returns:

  • (String) —

    The name or ARN of the secret that enables access to the database.

#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

Returns:

  • (String) —

    The table name.