Struct aws_sdk_redshiftdata::client::fluent_builders::ListDatabases

source · [−]

pub struct ListDatabases<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Expand description

Fluent builder constructing a request to ListDatabases.

List the databases in a cluster. A token is returned to page through the database 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 endpoint, 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 endpoint, specify the database name.

Implementations

source

impl<C, M, R> ListDatabases<C, M, R> where
 C: SmithyConnector,
 M: SmithyMiddleware<C>,
 R: NewRequestPolicy,

source

pub async fn send(
self
) -> Result<ListDatabasesOutput, SdkError<ListDatabasesError>> where
R::Policy: SmithyRetryPolicy<ListDatabasesInputOperationOutputAlias, ListDatabasesOutput, ListDatabasesError, ListDatabasesInputOperationRetryAlias>,

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.

source

pub fn into_paginator(self) -> ListDatabasesPaginator<C, M, R>

Create a paginator for this request

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

source

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.

source

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.

source

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

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

source

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

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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

The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.

source

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

The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.