1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::list_databases::_list_databases_output::ListDatabasesOutputBuilder;
pub use crate::operation::list_databases::_list_databases_input::ListDatabasesInputBuilder;
/// Fluent builder constructing a request to `ListDatabases`.
///
/// <p>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: </p>
/// <ul>
/// <li> <p>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. </p> </li>
/// <li> <p>Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required. </p> </li>
/// </ul>
/// <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListDatabasesFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::list_databases::builders::ListDatabasesInputBuilder,
}
impl ListDatabasesFluentBuilder {
/// Creates a new `ListDatabases`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// 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 customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::list_databases::ListDatabases,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::operation::list_databases::ListDatabasesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::list_databases::ListDatabasesOutput,
aws_smithy_http::result::SdkError<crate::operation::list_databases::ListDatabasesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::operation::list_databases::paginator::ListDatabasesPaginator::send) which returns a `Stream`.
pub fn into_paginator(
self,
) -> crate::operation::list_databases::paginator::ListDatabasesPaginator {
crate::operation::list_databases::paginator::ListDatabasesPaginator::new(
self.handle,
self.inner,
)
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn cluster_identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.cluster_identifier(input.into());
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_cluster_identifier(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_cluster_identifier(input);
self
}
/// <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
pub fn database(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.database(input.into());
self
}
/// <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_database(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_database(input);
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn secret_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_arn(input.into());
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn set_secret_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_arn(input);
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn db_user(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.db_user(input.into());
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials. </p>
pub fn set_db_user(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_db_user(input);
self
}
/// <p>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. </p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>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. </p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The maximum number of databases to return in the response. If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of databases to return in the response. If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>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.</p>
pub fn workgroup_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.workgroup_name(input.into());
self
}
/// <p>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.</p>
pub fn set_workgroup_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_workgroup_name(input);
self
}
}