aws_sdk_connect/operation/get_metric_data/builders.rs
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 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_metric_data::_get_metric_data_output::GetMetricDataOutputBuilder;
pub use crate::operation::get_metric_data::_get_metric_data_input::GetMetricDataInputBuilder;
impl crate::operation::get_metric_data::builders::GetMetricDataInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::get_metric_data::GetMetricDataOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_metric_data::GetMetricDataError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.get_metric_data();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `GetMetricData`.
///
/// <p>Gets historical metric data from the specified Amazon Connect instance.</p>
/// <p>For a description of each historical metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p><note>
/// <p>We recommend using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html">GetMetricDataV2</a> API. It provides more flexibility, features, and the ability to query longer time ranges than <code>GetMetricData</code>. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.</p>
/// </note>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetMetricDataFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::get_metric_data::builders::GetMetricDataInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::get_metric_data::GetMetricDataOutput,
crate::operation::get_metric_data::GetMetricDataError,
> for GetMetricDataFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::get_metric_data::GetMetricDataOutput,
crate::operation::get_metric_data::GetMetricDataError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl GetMetricDataFluentBuilder {
/// Creates a new `GetMetricDataFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the GetMetricData as a reference.
pub fn as_input(&self) -> &crate::operation::get_metric_data::builders::GetMetricDataInputBuilder {
&self.inner
}
/// 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::get_metric_data::GetMetricDataOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_metric_data::GetMetricDataError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::get_metric_data::GetMetricData::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::get_metric_data::GetMetricData::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::get_metric_data::GetMetricDataOutput,
crate::operation::get_metric_data::GetMetricDataError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::operation::get_metric_data::paginator::GetMetricDataPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
pub fn into_paginator(self) -> crate::operation::get_metric_data::paginator::GetMetricDataPaginator {
crate::operation::get_metric_data::paginator::GetMetricDataPaginator::new(self.handle, self.inner)
}
/// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.instance_id(input.into());
self
}
/// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_instance_id(input);
self
}
/// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_instance_id()
}
/// <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.</p>
/// <p>The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.</p>
pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.start_time(input);
self
}
/// <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.</p>
/// <p>The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.</p>
pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_start_time(input);
self
}
/// <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.</p>
/// <p>The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.</p>
pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_start_time()
}
/// <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.</p>
/// <p>The time range between the start and end time must be less than 24 hours.</p>
pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.end_time(input);
self
}
/// <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.</p>
/// <p>The time range between the start and end time must be less than 24 hours.</p>
pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_end_time(input);
self
}
/// <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.</p>
/// <p>The time range between the start and end time must be less than 24 hours.</p>
pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_end_time()
}
/// <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
/// <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p><note>
/// <p>To filter by <code>Queues</code>, enter the queue ID/ARN, not the name of the queue.</p>
/// </note>
pub fn filters(mut self, input: crate::types::Filters) -> Self {
self.inner = self.inner.filters(input);
self
}
/// <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
/// <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p><note>
/// <p>To filter by <code>Queues</code>, enter the queue ID/ARN, not the name of the queue.</p>
/// </note>
pub fn set_filters(mut self, input: ::std::option::Option<crate::types::Filters>) -> Self {
self.inner = self.inner.set_filters(input);
self
}
/// <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
/// <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p><note>
/// <p>To filter by <code>Queues</code>, enter the queue ID/ARN, not the name of the queue.</p>
/// </note>
pub fn get_filters(&self) -> &::std::option::Option<crate::types::Filters> {
self.inner.get_filters()
}
///
/// Appends an item to `Groupings`.
///
/// To override the contents of this collection use [`set_groupings`](Self::set_groupings).
///
/// <p>The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.</p>
/// <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
/// <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p>
pub fn groupings(mut self, input: crate::types::Grouping) -> Self {
self.inner = self.inner.groupings(input);
self
}
/// <p>The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.</p>
/// <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
/// <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p>
pub fn set_groupings(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Grouping>>) -> Self {
self.inner = self.inner.set_groupings(input);
self
}
/// <p>The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.</p>
/// <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
/// <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</p>
pub fn get_groupings(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Grouping>> {
self.inner.get_groupings()
}
///
/// Appends an item to `HistoricalMetrics`.
///
/// To override the contents of this collection use [`set_historical_metrics`](Self::set_historical_metrics).
///
/// <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p><note>
/// <p>This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).</p>
/// </note>
/// <dl>
/// <dt>
/// ABANDON_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// AFTER_CONTACT_WORK_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// API_CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CALLBACK_CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_ABANDONED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_AGENT_HUNG_UP_FIRST
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_CONSULTED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED_INCOMING
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED_OUTBOUND
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_HOLD_ABANDONS
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_MISSED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_QUEUED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_IN
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_IN_FROM_QUEUE
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_OUT
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// HANDLE_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// HOLD_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// INTERACTION_AND_HOLD_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// INTERACTION_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// OCCUPANCY
/// </dt>
/// <dd>
/// <p>Unit: PERCENT</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// QUEUE_ANSWER_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// QUEUED_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: MAX</p>
/// </dd>
/// <dt>
/// SERVICE_LEVEL
/// </dt>
/// <dd>
/// <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
/// <p>Unit: PERCENT</p>
/// <p>Statistic: AVG</p>
/// <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for "Less than").</p>
/// </dd>
/// </dl>
pub fn historical_metrics(mut self, input: crate::types::HistoricalMetric) -> Self {
self.inner = self.inner.historical_metrics(input);
self
}
/// <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p><note>
/// <p>This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).</p>
/// </note>
/// <dl>
/// <dt>
/// ABANDON_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// AFTER_CONTACT_WORK_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// API_CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CALLBACK_CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_ABANDONED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_AGENT_HUNG_UP_FIRST
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_CONSULTED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED_INCOMING
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED_OUTBOUND
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_HOLD_ABANDONS
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_MISSED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_QUEUED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_IN
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_IN_FROM_QUEUE
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_OUT
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// HANDLE_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// HOLD_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// INTERACTION_AND_HOLD_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// INTERACTION_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// OCCUPANCY
/// </dt>
/// <dd>
/// <p>Unit: PERCENT</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// QUEUE_ANSWER_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// QUEUED_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: MAX</p>
/// </dd>
/// <dt>
/// SERVICE_LEVEL
/// </dt>
/// <dd>
/// <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
/// <p>Unit: PERCENT</p>
/// <p>Statistic: AVG</p>
/// <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for "Less than").</p>
/// </dd>
/// </dl>
pub fn set_historical_metrics(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::HistoricalMetric>>) -> Self {
self.inner = self.inner.set_historical_metrics(input);
self
}
/// <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p><note>
/// <p>This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).</p>
/// </note>
/// <dl>
/// <dt>
/// ABANDON_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// AFTER_CONTACT_WORK_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// API_CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CALLBACK_CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_ABANDONED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_AGENT_HUNG_UP_FIRST
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_CONSULTED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED_INCOMING
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_HANDLED_OUTBOUND
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_HOLD_ABANDONS
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_MISSED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_QUEUED
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_IN
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_IN_FROM_QUEUE
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_OUT
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
/// </dt>
/// <dd>
/// <p>Unit: COUNT</p>
/// <p>Statistic: SUM</p>
/// </dd>
/// <dt>
/// HANDLE_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// HOLD_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// INTERACTION_AND_HOLD_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// INTERACTION_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// OCCUPANCY
/// </dt>
/// <dd>
/// <p>Unit: PERCENT</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// QUEUE_ANSWER_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: AVG</p>
/// </dd>
/// <dt>
/// QUEUED_TIME
/// </dt>
/// <dd>
/// <p>Unit: SECONDS</p>
/// <p>Statistic: MAX</p>
/// </dd>
/// <dt>
/// SERVICE_LEVEL
/// </dt>
/// <dd>
/// <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
/// <p>Unit: PERCENT</p>
/// <p>Statistic: AVG</p>
/// <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for "Less than").</p>
/// </dd>
/// </dl>
pub fn get_historical_metrics(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::HistoricalMetric>> {
self.inner.get_historical_metrics()
}
/// <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</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 token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_next_token()
}
/// <p>The maximum number of results to return per page.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of results to return per page.</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 maximum number of results to return per page.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
self.inner.get_max_results()
}
}