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

Inherits:

Struct

• Object
• Struct
• Aws::RedshiftDataAPIService::Types::DescribeTableRequest

Includes:

Structure

Defined in:

lib/aws-sdk-redshiftdataapiservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cluster_identifier ⇒ String

  The cluster identifier.

• #connected_database ⇒ String

  A database name.

• #database ⇒ String

  The name of the database that contains the tables to be described.

• #db_user ⇒ String

  The database user name.

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

• #schema ⇒ String

  The schema that contains the table.

• #secret_arn ⇒ String

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

• #table ⇒ String

  The table name.

• #workgroup_name ⇒ String

  The serverless workgroup name or Amazon Resource Name (ARN).

Instance Attribute Details

#cluster_identifier ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 496

class DescribeTableRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema,
  :secret_arn,
  :table,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#connected_database ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 496

class DescribeTableRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema,
  :secret_arn,
  :table,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 496

class DescribeTableRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema,
  :secret_arn,
  :table,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#db_user ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 496

class DescribeTableRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema,
  :secret_arn,
  :table,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 496

class DescribeTableRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema,
  :secret_arn,
  :table,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 496

class DescribeTableRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema,
  :secret_arn,
  :table,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#schema ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 496

class DescribeTableRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema,
  :secret_arn,
  :table,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 496

class DescribeTableRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema,
  :secret_arn,
  :table,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 496

class DescribeTableRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema,
  :secret_arn,
  :table,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-redshiftdataapiservice/types.rb', line 496

class DescribeTableRequest < Struct.new(
  :cluster_identifier,
  :connected_database,
  :database,
  :db_user,
  :max_results,
  :next_token,
  :schema,
  :secret_arn,
  :table,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end