DescribeTableRequest

public struct DescribeTableRequest : AWSShape
extension RedshiftDataAPIService.DescribeTableRequest: AWSPaginateStringToken

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let clusterIdentifier: String

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

    Declaration

    Swift

    public let database: String?

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

    Declaration

    Swift

    public let dbUser: String?

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

    Declaration

    Swift

    public let maxResults: Int?

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

    Declaration

    Swift

    public let nextToken: String?

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

    Declaration

    Swift

    public let schema: String?

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

    Declaration

    Swift

    public let secretArn: 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

    Declaration

    Swift

    public let table: String?

  • Undocumented

    Declaration

    Swift

    public init(clusterIdentifier: String, database: String? = nil, dbUser: String? = nil, maxResults: Int? = nil, nextToken: String? = nil, schema: String? = nil, secretArn: String? = nil, table: String? = nil)

Paginators