Struct aws_sdk_redshiftdata::client::fluent_builders::DescribeTable

pub struct DescribeTable { /* private fields */ }

Fluent builder constructing a request to DescribeTable.

Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

• Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Implementations

impl DescribeTable

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeTable, AwsResponseRetryClassifier>, SdkError<DescribeTableError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DescribeTableOutput, SdkError<DescribeTableError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeTablePaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn cluster_identifier(self, input: impl Into<String>) -> Self

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

pub fn set_cluster_identifier(self, input: Option<String>) -> Self

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

pub fn secret_arn(self, input: impl Into<String>) -> Self

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

pub fn set_secret_arn(self, input: Option<String>) -> Self

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

pub fn db_user(self, input: impl Into<String>) -> Self

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

pub fn set_db_user(self, input: Option<String>) -> Self

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

pub fn database(self, input: impl Into<String>) -> Self

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.

pub fn set_database(self, input: Option<String>) -> Self

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.

pub fn connected_database(self, input: impl Into<String>) -> Self

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

pub fn set_connected_database(self, input: Option<String>) -> Self

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

pub fn schema(self, input: impl Into<String>) -> Self

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

pub fn set_schema(self, input: Option<String>) -> Self

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

pub fn table(self, input: impl Into<String>) -> Self

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

pub fn set_table(self, input: Option<String>) -> Self

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

pub fn next_token(self, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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.

pub fn max_results(self, input: i32) -> Self

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.

pub fn set_max_results(self, input: Option<i32>) -> Self

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.

pub fn workgroup_name(self, input: impl Into<String>) -> Self

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

pub fn set_workgroup_name(self, input: Option<String>) -> Self

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Trait Implementations

impl Clone for DescribeTable

fn clone(&self) -> DescribeTable

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeTable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.