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 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
// 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 AWS IoT
///
/// Client for invoking operations on AWS IoT. Each operation on AWS IoT 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_iot::Client::new(&config);
/// # }
/// ```
///
/// Occasionally, SDKs may have additional service-specific values 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_iot::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 [`AcceptCertificateTransfer`](crate::operation::accept_certificate_transfer) operation has
/// a [`Client::accept_certificate_transfer`], 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_certificate_transfer()
/// .certificate_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 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 accept_certificate_transfer;
mod add_thing_to_billing_group;
mod add_thing_to_thing_group;
mod associate_targets_with_job;
mod attach_policy;
mod attach_principal_policy;
mod attach_security_profile;
mod attach_thing_principal;
mod cancel_audit_mitigation_actions_task;
mod cancel_audit_task;
mod cancel_certificate_transfer;
mod cancel_detect_mitigation_actions_task;
mod cancel_job;
mod cancel_job_execution;
mod clear_default_authorizer;
mod confirm_topic_rule_destination;
mod create_audit_suppression;
mod create_authorizer;
mod create_billing_group;
mod create_certificate_from_csr;
mod create_certificate_provider;
mod create_custom_metric;
mod create_dimension;
mod create_domain_configuration;
mod create_dynamic_thing_group;
mod create_fleet_metric;
mod create_job;
mod create_job_template;
mod create_keys_and_certificate;
mod create_mitigation_action;
mod create_ota_update;
mod create_package;
mod create_package_version;
mod create_policy;
mod create_policy_version;
mod create_provisioning_claim;
mod create_provisioning_template;
mod create_provisioning_template_version;
mod create_role_alias;
mod create_scheduled_audit;
mod create_security_profile;
mod create_stream;
mod create_thing;
mod create_thing_group;
mod create_thing_type;
mod create_topic_rule;
mod create_topic_rule_destination;
/// 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_iot::Error> {
/// # let client: aws_sdk_iot::Client = unimplemented!();
/// use ::http::header::{HeaderName, HeaderValue};
///
/// let result = client.accept_certificate_transfer()
/// .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_account_audit_configuration;
mod delete_audit_suppression;
mod delete_authorizer;
mod delete_billing_group;
mod delete_ca_certificate;
mod delete_certificate;
mod delete_certificate_provider;
mod delete_custom_metric;
mod delete_dimension;
mod delete_domain_configuration;
mod delete_dynamic_thing_group;
mod delete_fleet_metric;
mod delete_job;
mod delete_job_execution;
mod delete_job_template;
mod delete_mitigation_action;
mod delete_ota_update;
mod delete_package;
mod delete_package_version;
mod delete_policy;
mod delete_policy_version;
mod delete_provisioning_template;
mod delete_provisioning_template_version;
mod delete_registration_code;
mod delete_role_alias;
mod delete_scheduled_audit;
mod delete_security_profile;
mod delete_stream;
mod delete_thing;
mod delete_thing_group;
mod delete_thing_type;
mod delete_topic_rule;
mod delete_topic_rule_destination;
mod delete_v2_logging_level;
mod deprecate_thing_type;
mod describe_account_audit_configuration;
mod describe_audit_finding;
mod describe_audit_mitigation_actions_task;
mod describe_audit_suppression;
mod describe_audit_task;
mod describe_authorizer;
mod describe_billing_group;
mod describe_ca_certificate;
mod describe_certificate;
mod describe_certificate_provider;
mod describe_custom_metric;
mod describe_default_authorizer;
mod describe_detect_mitigation_actions_task;
mod describe_dimension;
mod describe_domain_configuration;
mod describe_endpoint;
mod describe_event_configurations;
mod describe_fleet_metric;
mod describe_index;
mod describe_job;
mod describe_job_execution;
mod describe_job_template;
mod describe_managed_job_template;
mod describe_mitigation_action;
mod describe_provisioning_template;
mod describe_provisioning_template_version;
mod describe_role_alias;
mod describe_scheduled_audit;
mod describe_security_profile;
mod describe_stream;
mod describe_thing;
mod describe_thing_group;
mod describe_thing_registration_task;
mod describe_thing_type;
mod detach_policy;
mod detach_principal_policy;
mod detach_security_profile;
mod detach_thing_principal;
mod disable_topic_rule;
mod enable_topic_rule;
mod get_behavior_model_training_summaries;
mod get_buckets_aggregation;
mod get_cardinality;
mod get_effective_policies;
mod get_indexing_configuration;
mod get_job_document;
mod get_logging_options;
mod get_ota_update;
mod get_package;
mod get_package_configuration;
mod get_package_version;
mod get_percentiles;
mod get_policy;
mod get_policy_version;
mod get_registration_code;
mod get_statistics;
mod get_topic_rule;
mod get_topic_rule_destination;
mod get_v2_logging_options;
mod list_active_violations;
mod list_attached_policies;
mod list_audit_findings;
mod list_audit_mitigation_actions_executions;
mod list_audit_mitigation_actions_tasks;
mod list_audit_suppressions;
mod list_audit_tasks;
mod list_authorizers;
mod list_billing_groups;
mod list_ca_certificates;
mod list_certificate_providers;
mod list_certificates;
mod list_certificates_by_ca;
mod list_custom_metrics;
mod list_detect_mitigation_actions_executions;
mod list_detect_mitigation_actions_tasks;
mod list_dimensions;
mod list_domain_configurations;
mod list_fleet_metrics;
mod list_indices;
mod list_job_executions_for_job;
mod list_job_executions_for_thing;
mod list_job_templates;
mod list_jobs;
mod list_managed_job_templates;
mod list_metric_values;
mod list_mitigation_actions;
mod list_ota_updates;
mod list_outgoing_certificates;
mod list_package_versions;
mod list_packages;
mod list_policies;
mod list_policy_principals;
mod list_policy_versions;
mod list_principal_policies;
mod list_principal_things;
mod list_provisioning_template_versions;
mod list_provisioning_templates;
mod list_related_resources_for_audit_finding;
mod list_role_aliases;
mod list_scheduled_audits;
mod list_security_profiles;
mod list_security_profiles_for_target;
mod list_streams;
mod list_tags_for_resource;
mod list_targets_for_policy;
mod list_targets_for_security_profile;
mod list_thing_groups;
mod list_thing_groups_for_thing;
mod list_thing_principals;
mod list_thing_registration_task_reports;
mod list_thing_registration_tasks;
mod list_thing_types;
mod list_things;
mod list_things_in_billing_group;
mod list_things_in_thing_group;
mod list_topic_rule_destinations;
mod list_topic_rules;
mod list_v2_logging_levels;
mod list_violation_events;
mod put_verification_state_on_violation;
mod register_ca_certificate;
mod register_certificate;
mod register_certificate_without_ca;
mod register_thing;
mod reject_certificate_transfer;
mod remove_thing_from_billing_group;
mod remove_thing_from_thing_group;
mod replace_topic_rule;
mod search_index;
mod set_default_authorizer;
mod set_default_policy_version;
mod set_logging_options;
mod set_v2_logging_level;
mod set_v2_logging_options;
mod start_audit_mitigation_actions_task;
mod start_detect_mitigation_actions_task;
mod start_on_demand_audit_task;
mod start_thing_registration_task;
mod stop_thing_registration_task;
mod tag_resource;
mod test_authorization;
mod test_invoke_authorizer;
mod transfer_certificate;
mod untag_resource;
mod update_account_audit_configuration;
mod update_audit_suppression;
mod update_authorizer;
mod update_billing_group;
mod update_ca_certificate;
mod update_certificate;
mod update_certificate_provider;
mod update_custom_metric;
mod update_dimension;
mod update_domain_configuration;
mod update_dynamic_thing_group;
mod update_event_configurations;
mod update_fleet_metric;
mod update_indexing_configuration;
mod update_job;
mod update_mitigation_action;
mod update_package;
mod update_package_configuration;
mod update_package_version;
mod update_provisioning_template;
mod update_role_alias;
mod update_scheduled_audit;
mod update_security_profile;
mod update_stream;
mod update_thing;
mod update_thing_group;
mod update_thing_groups_for_thing;
mod update_topic_rule_destination;
mod validate_security_profile_behaviors;