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 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[derive(Debug)]
pub(crate) struct Handle {
pub(crate) conf: crate::Config,
pub(crate) runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
}
/// Client for Amazon Redshift
///
/// Client for invoking operations on Amazon Redshift. Each operation on Amazon Redshift is a method on this
/// this struct. `.send()` MUST be invoked on the generated operations to dispatch the request to the service.
/// ## Constructing a `Client`
///
/// A [`Config`] is required to construct a client. For most use cases, the [`aws-config`]
/// crate should be used to automatically resolve this config using
/// [`aws_config::load_from_env()`], since this will resolve an [`SdkConfig`] which can be shared
/// across multiple different AWS SDK clients. This config resolution process can be customized
/// by calling [`aws_config::from_env()`] instead, which returns a [`ConfigLoader`] that uses
/// the [builder pattern] to customize the default config.
///
/// In the simplest case, creating a client looks as follows:
/// ```rust,no_run
/// # async fn wrapper() {
/// let config = aws_config::load_from_env().await;
/// let client = aws_sdk_redshift::Client::new(&config);
/// # }
/// ```
///
/// Occasionally, SDKs may have additional service-specific that can be set on the [`Config`] that
/// is absent from [`SdkConfig`], or slightly different settings for a specific client may be desired.
/// The [`Config`] struct implements `From<&SdkConfig>`, so setting these specific settings can be
/// done as follows:
///
/// ```rust,no_run
/// # async fn wrapper() {
/// let sdk_config = ::aws_config::load_from_env().await;
/// let config = aws_sdk_redshift::config::Builder::from(&sdk_config)
/// # /*
/// .some_service_specific_setting("value")
/// # */
/// .build();
/// # }
/// ```
///
/// See the [`aws-config` docs] and [`Config`] for more information on customizing configuration.
///
/// _Note:_ Client construction is expensive due to connection thread pool initialization, and should
/// be done once at application start-up.
///
/// [`Config`]: crate::Config
/// [`ConfigLoader`]: https://docs.rs/aws-config/*/aws_config/struct.ConfigLoader.html
/// [`SdkConfig`]: https://docs.rs/aws-config/*/aws_config/struct.SdkConfig.html
/// [`aws-config` docs]: https://docs.rs/aws-config/*
/// [`aws-config`]: https://crates.io/crates/aws-config
/// [`aws_config::from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.from_env.html
/// [`aws_config::load_from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.load_from_env.html
/// [builder pattern]: https://rust-lang.github.io/api-guidelines/type-safety.html#builders-enable-construction-of-complex-values-c-builder
/// # Using the `Client`
///
/// A client has a function for every operation that can be performed by the service.
/// For example, the [`AcceptReservedNodeExchange`](crate::operation::accept_reserved_node_exchange) operation has
/// a [`Client::accept_reserved_node_exchange`], function which returns a builder for that operation.
/// The fluent builder ultimately has a `send()` function that returns an async future that
/// returns a result, as illustrated below:
///
/// ```rust,ignore
/// let result = client.accept_reserved_node_exchange()
/// .reserved_node_id("example")
/// .send()
/// .await;
/// ```
///
/// The underlying HTTP requests that get made by this can be modified with the `customize_operation`
/// function on the fluent builder. See the [`customize`](crate::client::customize) module for more
/// information.
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct Client {
handle: ::std::sync::Arc<Handle>,
}
impl Client {
/// Creates a new client from the service [`Config`](crate::Config).
///
/// # Panics
///
/// This method will panic if the `conf` has retry or timeouts enabled without a `sleep_impl`.
/// If you experience this panic, it can be fixed by setting the `sleep_impl`, or by disabling
/// retries and timeouts.
pub fn from_conf(conf: crate::Config) -> Self {
let retry_config = conf
.retry_config()
.cloned()
.unwrap_or_else(::aws_smithy_types::retry::RetryConfig::disabled);
let timeout_config = conf
.timeout_config()
.cloned()
.unwrap_or_else(::aws_smithy_types::timeout::TimeoutConfig::disabled);
let sleep_impl = conf.sleep_impl();
if (retry_config.has_retry() || timeout_config.has_timeouts()) && sleep_impl.is_none() {
panic!(
"An async sleep implementation is required for retries or timeouts to work. \
Set the `sleep_impl` on the Config passed into this function to fix this panic."
);
}
Self {
handle: ::std::sync::Arc::new(Handle {
conf: conf.clone(),
runtime_plugins: crate::config::base_client_runtime_plugins(conf),
}),
}
}
/// Returns the client's configuration.
pub fn config(&self) -> &crate::Config {
&self.handle.conf
}
#[doc(hidden)]
// TODO(enableNewSmithyRuntimeCleanup): Delete this function when cleaning up middleware
// This is currently kept around so the tests still compile in both modes
/// Creates a client with the given service configuration.
pub fn with_config<C, M, R>(_client: ::aws_smithy_client::Client<C, M, R>, conf: crate::Config) -> Self {
Self::from_conf(conf)
}
#[doc(hidden)]
// TODO(enableNewSmithyRuntimeCleanup): Delete this function when cleaning up middleware
// This is currently kept around so the tests still compile in both modes
/// Returns the client's configuration.
pub fn conf(&self) -> &crate::Config {
&self.handle.conf
}
}
impl Client {
/// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
///
/// # Panics
///
/// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
/// the `sleep_impl` on the Config passed into this function to fix it.
/// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
/// `http_connector` on the Config passed into this function to fix it.
pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
Self::from_conf(sdk_config.into())
}
}
mod accept_reserved_node_exchange;
mod add_partner;
mod associate_data_share_consumer;
mod authorize_cluster_security_group_ingress;
mod authorize_data_share;
mod authorize_endpoint_access;
mod authorize_snapshot_access;
mod batch_delete_cluster_snapshots;
mod batch_modify_cluster_snapshots;
mod cancel_resize;
mod copy_cluster_snapshot;
mod create_authentication_profile;
mod create_cluster;
mod create_cluster_parameter_group;
mod create_cluster_security_group;
mod create_cluster_snapshot;
mod create_cluster_subnet_group;
mod create_custom_domain_association;
mod create_endpoint_access;
mod create_event_subscription;
mod create_hsm_client_certificate;
mod create_hsm_configuration;
mod create_scheduled_action;
mod create_snapshot_copy_grant;
mod create_snapshot_schedule;
mod create_tags;
mod create_usage_limit;
/// Operation customization and supporting types.
///
/// The underlying HTTP requests made during an operation can be customized
/// by calling the `customize()` method on the builder returned from a client
/// operation call. For example, this can be used to add an additional HTTP header:
///
/// ```ignore
/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_redshift::Error> {
/// # let client: aws_sdk_redshift::Client = unimplemented!();
/// use ::http::header::{HeaderName, HeaderValue};
///
/// let result = client.accept_reserved_node_exchange()
/// .customize()
/// .await?
/// .mutate_request(|req| {
/// // Add `x-example-header` with value
/// req.headers_mut()
/// .insert(
/// HeaderName::from_static("x-example-header"),
/// HeaderValue::from_static("1"),
/// );
/// })
/// .send()
/// .await;
/// # }
/// ```
pub mod customize;
mod deauthorize_data_share;
mod delete_authentication_profile;
mod delete_cluster;
mod delete_cluster_parameter_group;
mod delete_cluster_security_group;
mod delete_cluster_snapshot;
mod delete_cluster_subnet_group;
mod delete_custom_domain_association;
mod delete_endpoint_access;
mod delete_event_subscription;
mod delete_hsm_client_certificate;
mod delete_hsm_configuration;
mod delete_partner;
mod delete_scheduled_action;
mod delete_snapshot_copy_grant;
mod delete_snapshot_schedule;
mod delete_tags;
mod delete_usage_limit;
mod describe_account_attributes;
mod describe_authentication_profiles;
mod describe_cluster_db_revisions;
mod describe_cluster_parameter_groups;
mod describe_cluster_parameters;
mod describe_cluster_security_groups;
mod describe_cluster_snapshots;
mod describe_cluster_subnet_groups;
mod describe_cluster_tracks;
mod describe_cluster_versions;
mod describe_clusters;
mod describe_custom_domain_associations;
mod describe_data_shares;
mod describe_data_shares_for_consumer;
mod describe_data_shares_for_producer;
mod describe_default_cluster_parameters;
mod describe_endpoint_access;
mod describe_endpoint_authorization;
mod describe_event_categories;
mod describe_event_subscriptions;
mod describe_events;
mod describe_hsm_client_certificates;
mod describe_hsm_configurations;
mod describe_logging_status;
mod describe_node_configuration_options;
mod describe_orderable_cluster_options;
mod describe_partners;
mod describe_reserved_node_exchange_status;
mod describe_reserved_node_offerings;
mod describe_reserved_nodes;
mod describe_resize;
mod describe_scheduled_actions;
mod describe_snapshot_copy_grants;
mod describe_snapshot_schedules;
mod describe_storage;
mod describe_table_restore_status;
mod describe_tags;
mod describe_usage_limits;
mod disable_logging;
mod disable_snapshot_copy;
mod disassociate_data_share_consumer;
mod enable_logging;
mod enable_snapshot_copy;
mod get_cluster_credentials;
mod get_cluster_credentials_with_iam;
mod get_reserved_node_exchange_configuration_options;
mod get_reserved_node_exchange_offerings;
mod modify_aqua_configuration;
mod modify_authentication_profile;
mod modify_cluster;
mod modify_cluster_db_revision;
mod modify_cluster_iam_roles;
mod modify_cluster_maintenance;
mod modify_cluster_parameter_group;
mod modify_cluster_snapshot;
mod modify_cluster_snapshot_schedule;
mod modify_cluster_subnet_group;
mod modify_custom_domain_association;
mod modify_endpoint_access;
mod modify_event_subscription;
mod modify_scheduled_action;
mod modify_snapshot_copy_retention_period;
mod modify_snapshot_schedule;
mod modify_usage_limit;
mod pause_cluster;
mod purchase_reserved_node_offering;
mod reboot_cluster;
mod reject_data_share;
mod reset_cluster_parameter_group;
mod resize_cluster;
mod restore_from_cluster_snapshot;
mod restore_table_from_cluster_snapshot;
mod resume_cluster;
mod revoke_cluster_security_group_ingress;
mod revoke_endpoint_access;
mod revoke_snapshot_access;
mod rotate_encryption_key;
mod update_partner_status;