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 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[derive(Debug)]
pub(crate) struct Handle {
pub(crate) conf: crate::Config,
#[allow(dead_code)] // unused when a service does not provide any operations
pub(crate) runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
}
/// Client for Amazon Simple Systems Manager (SSM)
///
/// Client for invoking operations on Amazon Simple Systems Manager (SSM). Each operation on Amazon Simple Systems Manager (SSM) 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_ssm::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_ssm::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 [`AddTagsToResource`](crate::operation::add_tags_to_resource) operation has
/// a [`Client::add_tags_to_resource`], 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.add_tags_to_resource()
/// .resource_type("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 in the following cases:
///
/// - Retries or timeouts are enabled without a `sleep_impl` configured.
/// - Identity caching is enabled without a `sleep_impl` and `time_source` configured.
/// - No `behavior_version` is provided.
///
/// The panic message for each of these will have instructions on how to resolve them.
#[track_caller]
pub fn from_conf(conf: crate::Config) -> Self {
let handle = Handle {
conf: conf.clone(),
runtime_plugins: crate::config::base_client_runtime_plugins(conf),
};
if let Err(err) = Self::validate_config(&handle) {
panic!("Invalid client configuration: {err}");
}
Self {
handle: ::std::sync::Arc::new(handle),
}
}
/// Returns the client's configuration.
pub fn config(&self) -> &crate::Config {
&self.handle.conf
}
fn validate_config(handle: &Handle) -> Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
handle
.runtime_plugins
.apply_client_configuration(&mut cfg)?
.validate_base_client_config(&cfg)?;
Ok(())
}
}
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.
/// - This method will panic if no `BehaviorVersion` is provided. If you experience this panic, set `behavior_version` on the Config or enable the `behavior-version-latest` Cargo feature.
#[track_caller]
pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
Self::from_conf(sdk_config.into())
}
}
mod add_tags_to_resource;
mod associate_ops_item_related_item;
mod cancel_command;
mod cancel_maintenance_window_execution;
mod create_activation;
mod create_association;
mod create_association_batch;
mod create_document;
mod create_maintenance_window;
mod create_ops_item;
mod create_ops_metadata;
mod create_patch_baseline;
mod create_resource_data_sync;
/// 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_ssm::Error> {
/// # let client: aws_sdk_ssm::Client = unimplemented!();
/// use ::http::header::{HeaderName, HeaderValue};
///
/// let result = client.add_tags_to_resource()
/// .customize()
/// .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 delete_activation;
mod delete_association;
mod delete_document;
mod delete_inventory;
mod delete_maintenance_window;
mod delete_ops_item;
mod delete_ops_metadata;
mod delete_parameter;
mod delete_parameters;
mod delete_patch_baseline;
mod delete_resource_data_sync;
mod delete_resource_policy;
mod deregister_managed_instance;
mod deregister_patch_baseline_for_patch_group;
mod deregister_target_from_maintenance_window;
mod deregister_task_from_maintenance_window;
mod describe_activations;
mod describe_association;
mod describe_association_execution_targets;
mod describe_association_executions;
mod describe_automation_executions;
mod describe_automation_step_executions;
mod describe_available_patches;
mod describe_document;
mod describe_document_permission;
mod describe_effective_instance_associations;
mod describe_effective_patches_for_patch_baseline;
mod describe_instance_associations_status;
mod describe_instance_information;
mod describe_instance_patch_states;
mod describe_instance_patch_states_for_patch_group;
mod describe_instance_patches;
mod describe_inventory_deletions;
mod describe_maintenance_window_execution_task_invocations;
mod describe_maintenance_window_execution_tasks;
mod describe_maintenance_window_executions;
mod describe_maintenance_window_schedule;
mod describe_maintenance_window_targets;
mod describe_maintenance_window_tasks;
mod describe_maintenance_windows;
mod describe_maintenance_windows_for_target;
mod describe_ops_items;
mod describe_parameters;
mod describe_patch_baselines;
mod describe_patch_group_state;
mod describe_patch_groups;
mod describe_patch_properties;
mod describe_sessions;
mod disassociate_ops_item_related_item;
mod get_automation_execution;
mod get_calendar_state;
mod get_command_invocation;
mod get_connection_status;
mod get_default_patch_baseline;
mod get_deployable_patch_snapshot_for_instance;
mod get_document;
mod get_inventory;
mod get_inventory_schema;
mod get_maintenance_window;
mod get_maintenance_window_execution;
mod get_maintenance_window_execution_task;
mod get_maintenance_window_execution_task_invocation;
mod get_maintenance_window_task;
mod get_ops_item;
mod get_ops_metadata;
mod get_ops_summary;
mod get_parameter;
mod get_parameter_history;
mod get_parameters;
mod get_parameters_by_path;
mod get_patch_baseline;
mod get_patch_baseline_for_patch_group;
mod get_resource_policies;
mod get_service_setting;
mod label_parameter_version;
mod list_association_versions;
mod list_associations;
mod list_command_invocations;
mod list_commands;
mod list_compliance_items;
mod list_compliance_summaries;
mod list_document_metadata_history;
mod list_document_versions;
mod list_documents;
mod list_inventory_entries;
mod list_ops_item_events;
mod list_ops_item_related_items;
mod list_ops_metadata;
mod list_resource_compliance_summaries;
mod list_resource_data_sync;
mod list_tags_for_resource;
mod modify_document_permission;
mod put_compliance_items;
mod put_inventory;
mod put_parameter;
mod put_resource_policy;
mod register_default_patch_baseline;
mod register_patch_baseline_for_patch_group;
mod register_target_with_maintenance_window;
mod register_task_with_maintenance_window;
mod remove_tags_from_resource;
mod reset_service_setting;
mod resume_session;
mod send_automation_signal;
mod send_command;
mod start_associations_once;
mod start_automation_execution;
mod start_change_request_execution;
mod start_session;
mod stop_automation_execution;
mod terminate_session;
mod unlabel_parameter_version;
mod update_association;
mod update_association_status;
mod update_document;
mod update_document_default_version;
mod update_document_metadata;
mod update_maintenance_window;
mod update_maintenance_window_target;
mod update_maintenance_window_task;
mod update_managed_instance_role;
mod update_ops_item;
mod update_ops_metadata;
mod update_patch_baseline;
mod update_resource_data_sync;
mod update_service_setting;