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
// 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 Connect Service
///
/// Client for invoking operations on Amazon Connect Service. Each operation on Amazon Connect Service 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_connect::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_connect::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 [`ActivateEvaluationForm`](crate::operation::activate_evaluation_form) operation has
/// a [`Client::activate_evaluation_form`], 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.activate_evaluation_form()
/// .instance_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 activate_evaluation_form;
mod associate_analytics_data_set;
mod associate_approved_origin;
mod associate_bot;
mod associate_default_vocabulary;
mod associate_flow;
mod associate_instance_storage_config;
mod associate_lambda_function;
mod associate_lex_bot;
mod associate_phone_number_contact_flow;
mod associate_queue_quick_connects;
mod associate_routing_profile_queues;
mod associate_security_key;
mod associate_traffic_distribution_group_user;
mod associate_user_proficiencies;
mod batch_associate_analytics_data_set;
mod batch_disassociate_analytics_data_set;
mod batch_get_flow_association;
mod batch_put_contact;
mod claim_phone_number;
mod create_agent_status;
mod create_contact_flow;
mod create_contact_flow_module;
mod create_evaluation_form;
mod create_hours_of_operation;
mod create_instance;
mod create_integration_association;
mod create_participant;
mod create_persistent_contact_association;
mod create_predefined_attribute;
mod create_prompt;
mod create_queue;
mod create_quick_connect;
mod create_routing_profile;
mod create_rule;
mod create_security_profile;
mod create_task_template;
mod create_traffic_distribution_group;
mod create_use_case;
mod create_user;
mod create_user_hierarchy_group;
mod create_view;
mod create_view_version;
mod create_vocabulary;
/// 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_connect::Error> {
/// # let client: aws_sdk_connect::Client = unimplemented!();
/// use ::http::header::{HeaderName, HeaderValue};
///
/// let result = client.activate_evaluation_form()
/// .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 deactivate_evaluation_form;
mod delete_contact_evaluation;
mod delete_contact_flow;
mod delete_contact_flow_module;
mod delete_evaluation_form;
mod delete_hours_of_operation;
mod delete_instance;
mod delete_integration_association;
mod delete_predefined_attribute;
mod delete_prompt;
mod delete_queue;
mod delete_quick_connect;
mod delete_routing_profile;
mod delete_rule;
mod delete_security_profile;
mod delete_task_template;
mod delete_traffic_distribution_group;
mod delete_use_case;
mod delete_user;
mod delete_user_hierarchy_group;
mod delete_view;
mod delete_view_version;
mod delete_vocabulary;
mod describe_agent_status;
mod describe_contact;
mod describe_contact_evaluation;
mod describe_contact_flow;
mod describe_contact_flow_module;
mod describe_evaluation_form;
mod describe_hours_of_operation;
mod describe_instance;
mod describe_instance_attribute;
mod describe_instance_storage_config;
mod describe_phone_number;
mod describe_predefined_attribute;
mod describe_prompt;
mod describe_queue;
mod describe_quick_connect;
mod describe_routing_profile;
mod describe_rule;
mod describe_security_profile;
mod describe_traffic_distribution_group;
mod describe_user;
mod describe_user_hierarchy_group;
mod describe_user_hierarchy_structure;
mod describe_view;
mod describe_vocabulary;
mod disassociate_analytics_data_set;
mod disassociate_approved_origin;
mod disassociate_bot;
mod disassociate_flow;
mod disassociate_instance_storage_config;
mod disassociate_lambda_function;
mod disassociate_lex_bot;
mod disassociate_phone_number_contact_flow;
mod disassociate_queue_quick_connects;
mod disassociate_routing_profile_queues;
mod disassociate_security_key;
mod disassociate_traffic_distribution_group_user;
mod disassociate_user_proficiencies;
mod dismiss_user_contact;
mod get_contact_attributes;
mod get_current_metric_data;
mod get_current_user_data;
mod get_federation_token;
mod get_flow_association;
mod get_metric_data;
mod get_metric_data_v2;
mod get_prompt_file;
mod get_task_template;
mod get_traffic_distribution;
mod import_phone_number;
mod list_agent_statuses;
mod list_analytics_data_associations;
mod list_approved_origins;
mod list_bots;
mod list_contact_evaluations;
mod list_contact_flow_modules;
mod list_contact_flows;
mod list_contact_references;
mod list_default_vocabularies;
mod list_evaluation_form_versions;
mod list_evaluation_forms;
mod list_flow_associations;
mod list_hours_of_operations;
mod list_instance_attributes;
mod list_instance_storage_configs;
mod list_instances;
mod list_integration_associations;
mod list_lambda_functions;
mod list_lex_bots;
mod list_phone_numbers;
mod list_phone_numbers_v2;
mod list_predefined_attributes;
mod list_prompts;
mod list_queue_quick_connects;
mod list_queues;
mod list_quick_connects;
mod list_realtime_contact_analysis_segments_v2;
mod list_routing_profile_queues;
mod list_routing_profiles;
mod list_rules;
mod list_security_keys;
mod list_security_profile_applications;
mod list_security_profile_permissions;
mod list_security_profiles;
mod list_tags_for_resource;
mod list_task_templates;
mod list_traffic_distribution_group_users;
mod list_traffic_distribution_groups;
mod list_use_cases;
mod list_user_hierarchy_groups;
mod list_user_proficiencies;
mod list_users;
mod list_view_versions;
mod list_views;
mod monitor_contact;
mod pause_contact;
mod put_user_status;
mod release_phone_number;
mod replicate_instance;
mod resume_contact;
mod resume_contact_recording;
mod search_available_phone_numbers;
mod search_contacts;
mod search_hours_of_operations;
mod search_predefined_attributes;
mod search_prompts;
mod search_queues;
mod search_quick_connects;
mod search_resource_tags;
mod search_routing_profiles;
mod search_security_profiles;
mod search_users;
mod search_vocabularies;
mod send_chat_integration_event;
mod start_chat_contact;
mod start_contact_evaluation;
mod start_contact_recording;
mod start_contact_streaming;
mod start_outbound_voice_contact;
mod start_task_contact;
mod start_web_rtc_contact;
mod stop_contact;
mod stop_contact_recording;
mod stop_contact_streaming;
mod submit_contact_evaluation;
mod suspend_contact_recording;
mod tag_contact;
mod tag_resource;
mod transfer_contact;
mod untag_contact;
mod untag_resource;
mod update_agent_status;
mod update_contact;
mod update_contact_attributes;
mod update_contact_evaluation;
mod update_contact_flow_content;
mod update_contact_flow_metadata;
mod update_contact_flow_module_content;
mod update_contact_flow_module_metadata;
mod update_contact_flow_name;
mod update_contact_routing_data;
mod update_contact_schedule;
mod update_evaluation_form;
mod update_hours_of_operation;
mod update_instance_attribute;
mod update_instance_storage_config;
mod update_participant_role_config;
mod update_phone_number;
mod update_phone_number_metadata;
mod update_predefined_attribute;
mod update_prompt;
mod update_queue_hours_of_operation;
mod update_queue_max_contacts;
mod update_queue_name;
mod update_queue_outbound_caller_config;
mod update_queue_status;
mod update_quick_connect_config;
mod update_quick_connect_name;
mod update_routing_profile_agent_availability_timer;
mod update_routing_profile_concurrency;
mod update_routing_profile_default_outbound_queue;
mod update_routing_profile_name;
mod update_routing_profile_queues;
mod update_rule;
mod update_security_profile;
mod update_task_template;
mod update_traffic_distribution;
mod update_user_hierarchy;
mod update_user_hierarchy_group_name;
mod update_user_hierarchy_structure;
mod update_user_identity_info;
mod update_user_phone_config;
mod update_user_proficiencies;
mod update_user_routing_profile;
mod update_user_security_profiles;
mod update_view_content;
mod update_view_metadata;