aws-sdk-connect 1.5.0 → 1.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-connect.rb +1 -1
- data/lib/aws-sdk-connect/client.rb +464 -11
- data/lib/aws-sdk-connect/client_api.rb +158 -0
- data/lib/aws-sdk-connect/types.rb +732 -6
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '0103609859e4c052c359b4b14fc6fb1220382943'
|
4
|
+
data.tar.gz: cbd6b7ae09fb5b089c6edecfba0eea76aa33eb47
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b514b458d865b0dc24dbd39c00e792dad64444d9760579de0c2e35da500efa3a8cd0f4c63180300d08f6e75d61c0bf7d17adae1f54a42aa85be7fedfc24b8868
|
7
|
+
data.tar.gz: 332536318dac962cdea0591550d69fbf2810b19625daf84df474db33295775a9a09be46ecb16740d514862b3b3aaa8a2f6cccb96ec59377178d2b09401f7b06d
|
data/lib/aws-sdk-connect.rb
CHANGED
@@ -179,7 +179,7 @@ module Aws::Connect
|
|
179
179
|
# Creates a new user account in your Amazon Connect instance.
|
180
180
|
#
|
181
181
|
# @option params [required, String] :username
|
182
|
-
# The user name in Amazon Connect for the
|
182
|
+
# The user name in Amazon Connect for the account to create.
|
183
183
|
#
|
184
184
|
# @option params [String] :password
|
185
185
|
# The password for the user account to create. This is required if you
|
@@ -464,6 +464,154 @@ module Aws::Connect
|
|
464
464
|
req.send_request(options)
|
465
465
|
end
|
466
466
|
|
467
|
+
# The `GetCurrentMetricData` operation retrieves current metric data
|
468
|
+
# from your Amazon Connect instance.
|
469
|
+
#
|
470
|
+
# If you are using an IAM account, it must have permission to the
|
471
|
+
# `connect:GetCurrentMetricData` action.
|
472
|
+
#
|
473
|
+
# @option params [required, String] :instance_id
|
474
|
+
# The identifier for your Amazon Connect instance. To find the ID of
|
475
|
+
# your instance, open the AWS console and select Amazon Connect. Select
|
476
|
+
# the alias of the instance in the Instance alias column. The instance
|
477
|
+
# ID is displayed in the Overview section of your instance settings. For
|
478
|
+
# example, the instance ID is the set of characters at the end of the
|
479
|
+
# instance ARN, after instance/, such as
|
480
|
+
# 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
|
481
|
+
#
|
482
|
+
# @option params [required, Types::Filters] :filters
|
483
|
+
# A `Filters` object that contains a list of queue IDs or queue ARNs, up
|
484
|
+
# to 100, or list of Channels to use to filter the metrics returned in
|
485
|
+
# the response. Metric data is retrieved only for the resources
|
486
|
+
# associated with the queue IDs, ARNs, or Channels included in the
|
487
|
+
# filter. You can include both IDs and ARNs in the same request. To
|
488
|
+
# retrieve metrics for all queues, add the queue ID or ARN for each
|
489
|
+
# queue in your instance. Only VOICE is supported for Channels.
|
490
|
+
#
|
491
|
+
# To find the ARN for a queue, open the queue you want to use in the
|
492
|
+
# Amazon Connect Queue editor. The ARN for the queue is displayed in the
|
493
|
+
# address bar as part of the URL. For example, the queue ARN is the set
|
494
|
+
# of characters at the end of the URL, after 'id=' such as
|
495
|
+
# `arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61`.
|
496
|
+
# The queue ID is also included in the URL, and is the string after
|
497
|
+
# 'queue/'.
|
498
|
+
#
|
499
|
+
# @option params [Array<String>] :groupings
|
500
|
+
# The grouping applied to the metrics returned. For example, when
|
501
|
+
# grouped by QUEUE, the metrics returned apply to each queue rather than
|
502
|
+
# aggregated for all queues. If you group by CHANNEL, you should include
|
503
|
+
# a Channels filter. The only supported channel is VOICE.
|
504
|
+
#
|
505
|
+
# If no `Grouping` is included in the request, a summary of
|
506
|
+
# `CurrentMetrics` is returned.
|
507
|
+
#
|
508
|
+
# @option params [required, Array<Types::CurrentMetric>] :current_metrics
|
509
|
+
# A list of `CurrentMetric` objects for the metrics to retrieve. Each
|
510
|
+
# `CurrentMetric` includes a name of a metric to retrieve and the unit
|
511
|
+
# to use for it.
|
512
|
+
#
|
513
|
+
# The following metrics are available:
|
514
|
+
#
|
515
|
+
# AGENTS\_AVAILABLE
|
516
|
+
#
|
517
|
+
# : Unit: COUNT
|
518
|
+
#
|
519
|
+
# AGENTS\_ONLINE
|
520
|
+
#
|
521
|
+
# : Unit: COUNT
|
522
|
+
#
|
523
|
+
# AGENTS\_ON\_CALL
|
524
|
+
#
|
525
|
+
# : Unit: COUNT
|
526
|
+
#
|
527
|
+
# AGENTS\_STAFFED
|
528
|
+
#
|
529
|
+
# : Unit: COUNT
|
530
|
+
#
|
531
|
+
# AGENTS\_AFTER\_CONTACT\_WORK
|
532
|
+
#
|
533
|
+
# : Unit: COUNT
|
534
|
+
#
|
535
|
+
# AGENTS\_NON\_PRODUCTIVE
|
536
|
+
#
|
537
|
+
# : Unit: COUNT
|
538
|
+
#
|
539
|
+
# AGENTS\_ERROR
|
540
|
+
#
|
541
|
+
# : Unit: COUNT
|
542
|
+
#
|
543
|
+
# CONTACTS\_IN\_QUEUE
|
544
|
+
#
|
545
|
+
# : Unit: COUNT
|
546
|
+
#
|
547
|
+
# OLDEST\_CONTACT\_AGE
|
548
|
+
#
|
549
|
+
# : Unit: SECONDS
|
550
|
+
#
|
551
|
+
# CONTACTS\_SCHEDULED
|
552
|
+
#
|
553
|
+
# : Unit: COUNT
|
554
|
+
#
|
555
|
+
# @option params [String] :next_token
|
556
|
+
# The token for the next set of results. Use the value returned in the
|
557
|
+
# previous response in the next request to retrieve the next set of
|
558
|
+
# results.
|
559
|
+
#
|
560
|
+
# The token expires after 5 minutes from the time it is created.
|
561
|
+
# Subsequent requests that use the [NextToken]() must use the same
|
562
|
+
# request parameters as the request that generated the token.
|
563
|
+
#
|
564
|
+
# @option params [Integer] :max_results
|
565
|
+
# `MaxResults` indicates the maximum number of results to return per
|
566
|
+
# page in the response, between 1 and 100.
|
567
|
+
#
|
568
|
+
# @return [Types::GetCurrentMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
569
|
+
#
|
570
|
+
# * {Types::GetCurrentMetricDataResponse#next_token #next_token} => String
|
571
|
+
# * {Types::GetCurrentMetricDataResponse#metric_results #metric_results} => Array<Types::CurrentMetricResult>
|
572
|
+
# * {Types::GetCurrentMetricDataResponse#data_snapshot_time #data_snapshot_time} => Time
|
573
|
+
#
|
574
|
+
# @example Request syntax with placeholder values
|
575
|
+
#
|
576
|
+
# resp = client.get_current_metric_data({
|
577
|
+
# instance_id: "InstanceId", # required
|
578
|
+
# filters: { # required
|
579
|
+
# queues: ["QueueId"],
|
580
|
+
# channels: ["VOICE"], # accepts VOICE
|
581
|
+
# },
|
582
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
583
|
+
# current_metrics: [ # required
|
584
|
+
# {
|
585
|
+
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED
|
586
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
587
|
+
# },
|
588
|
+
# ],
|
589
|
+
# next_token: "NextToken",
|
590
|
+
# max_results: 1,
|
591
|
+
# })
|
592
|
+
#
|
593
|
+
# @example Response structure
|
594
|
+
#
|
595
|
+
# resp.next_token #=> String
|
596
|
+
# resp.metric_results #=> Array
|
597
|
+
# resp.metric_results[0].dimensions.queue.id #=> String
|
598
|
+
# resp.metric_results[0].dimensions.queue.arn #=> String
|
599
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE"
|
600
|
+
# resp.metric_results[0].collections #=> Array
|
601
|
+
# resp.metric_results[0].collections[0].metric.name #=> String, one of "AGENTS_ONLINE", "AGENTS_AVAILABLE", "AGENTS_ON_CALL", "AGENTS_NON_PRODUCTIVE", "AGENTS_AFTER_CONTACT_WORK", "AGENTS_ERROR", "AGENTS_STAFFED", "CONTACTS_IN_QUEUE", "OLDEST_CONTACT_AGE", "CONTACTS_SCHEDULED"
|
602
|
+
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
603
|
+
# resp.metric_results[0].collections[0].value #=> Float
|
604
|
+
# resp.data_snapshot_time #=> Time
|
605
|
+
#
|
606
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricData AWS API Documentation
|
607
|
+
#
|
608
|
+
# @overload get_current_metric_data(params = {})
|
609
|
+
# @param [Hash] params ({})
|
610
|
+
def get_current_metric_data(params = {}, options = {})
|
611
|
+
req = build_request(:get_current_metric_data, params)
|
612
|
+
req.send_request(options)
|
613
|
+
end
|
614
|
+
|
467
615
|
# Retrieves a token for federation.
|
468
616
|
#
|
469
617
|
# @option params [required, String] :instance_id
|
@@ -501,6 +649,303 @@ module Aws::Connect
|
|
501
649
|
req.send_request(options)
|
502
650
|
end
|
503
651
|
|
652
|
+
# The `GetMetricData` operation retrieves historical metrics data from
|
653
|
+
# your Amazon Connect instance.
|
654
|
+
#
|
655
|
+
# If you are using an IAM account, it must have permission to the
|
656
|
+
# `connect:GetMetricData` action.
|
657
|
+
#
|
658
|
+
# @option params [required, String] :instance_id
|
659
|
+
# The identifier for your Amazon Connect instance. To find the ID of
|
660
|
+
# your instance, open the AWS console and select Amazon Connect. Select
|
661
|
+
# the alias of the instance in the Instance alias column. The instance
|
662
|
+
# ID is displayed in the Overview section of your instance settings. For
|
663
|
+
# example, the instance ID is the set of characters at the end of the
|
664
|
+
# instance ARN, after instance/, such as
|
665
|
+
# 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
|
666
|
+
#
|
667
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
668
|
+
# The timestamp, in UNIX Epoch time format, at which to start the
|
669
|
+
# reporting interval for the retrieval of historical metrics data. The
|
670
|
+
# time must be specified using a multiple of 5 minutes, such as 10:05,
|
671
|
+
# 10:10, 10:15.
|
672
|
+
#
|
673
|
+
# `StartTime` cannot be earlier than 24 hours before the time of the
|
674
|
+
# request. Historical metrics are available in Amazon Connect only for
|
675
|
+
# 24 hours.
|
676
|
+
#
|
677
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
678
|
+
# The timestamp, in UNIX Epoch time format, at which to end the
|
679
|
+
# reporting interval for the retrieval of historical metrics data. The
|
680
|
+
# time must be specified using an interval of 5 minutes, such as 11:00,
|
681
|
+
# 11:05, 11:10, and must be later than the `StartTime` timestamp.
|
682
|
+
#
|
683
|
+
# The time range between `StartTime` and `EndTime` must be less than 24
|
684
|
+
# hours.
|
685
|
+
#
|
686
|
+
# @option params [required, Types::Filters] :filters
|
687
|
+
# A `Filters` object that contains a list of queue IDs or queue ARNs, up
|
688
|
+
# to 100, or a list of Channels to use to filter the metrics returned in
|
689
|
+
# the response. Metric data is retrieved only for the resources
|
690
|
+
# associated with the IDs, ARNs, or Channels included in the filter. You
|
691
|
+
# can use both IDs and ARNs together in a request. Only VOICE is
|
692
|
+
# supported for Channel.
|
693
|
+
#
|
694
|
+
# To find the ARN for a queue, open the queue you want to use in the
|
695
|
+
# Amazon Connect Queue editor. The ARN for the queue is displayed in the
|
696
|
+
# address bar as part of the URL. For example, the queue ARN is the set
|
697
|
+
# of characters at the end of the URL, after 'id=' such as
|
698
|
+
# `arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61`.
|
699
|
+
# The queue ID is also included in the URL, and is the string after
|
700
|
+
# 'queue/'.
|
701
|
+
#
|
702
|
+
# @option params [Array<String>] :groupings
|
703
|
+
# The grouping applied to the metrics returned. For example, when
|
704
|
+
# results are grouped by queueId, the metrics returned are grouped by
|
705
|
+
# queue. The values returned apply to the metrics for each queue rather
|
706
|
+
# than aggregated for all queues.
|
707
|
+
#
|
708
|
+
# The current version supports grouping by Queue
|
709
|
+
#
|
710
|
+
# If no `Grouping` is included in the request, a summary of
|
711
|
+
# `HistoricalMetrics` for all queues is returned.
|
712
|
+
#
|
713
|
+
# @option params [required, Array<Types::HistoricalMetric>] :historical_metrics
|
714
|
+
# A list of `HistoricalMetric` objects that contain the metrics to
|
715
|
+
# retrieve with the request.
|
716
|
+
#
|
717
|
+
# A `HistoricalMetric` object contains: `HistoricalMetricName`,
|
718
|
+
# `Statistic`, `Threshold`, and `Unit`.
|
719
|
+
#
|
720
|
+
# For each historical metric you include in the request, you must
|
721
|
+
# include a `Unit` and a `Statistic`.
|
722
|
+
#
|
723
|
+
# The following historical metrics are available:
|
724
|
+
#
|
725
|
+
# CONTACTS\_QUEUED
|
726
|
+
#
|
727
|
+
# : Unit: COUNT
|
728
|
+
#
|
729
|
+
# Statistic: SUM
|
730
|
+
#
|
731
|
+
# CONTACTS\_HANDLED
|
732
|
+
#
|
733
|
+
# : Unit: COUNT
|
734
|
+
#
|
735
|
+
# Statistics: SUM
|
736
|
+
#
|
737
|
+
# CONTACTS\_ABANDONED
|
738
|
+
#
|
739
|
+
# : Unit: COUNT
|
740
|
+
#
|
741
|
+
# Statistics: SUM
|
742
|
+
#
|
743
|
+
# CONTACTS\_CONSULTED
|
744
|
+
#
|
745
|
+
# : Unit: COUNT
|
746
|
+
#
|
747
|
+
# Statistics: SUM
|
748
|
+
#
|
749
|
+
# CONTACTS\_AGENT\_HUNG\_UP\_FIRST
|
750
|
+
#
|
751
|
+
# : Unit: COUNT
|
752
|
+
#
|
753
|
+
# Statistics: SUM
|
754
|
+
#
|
755
|
+
# CONTACTS\_HANDLED\_INCOMING
|
756
|
+
#
|
757
|
+
# : Unit: COUNT
|
758
|
+
#
|
759
|
+
# Statistics: SUM
|
760
|
+
#
|
761
|
+
# CONTACTS\_HANDLED\_OUTBOUND
|
762
|
+
#
|
763
|
+
# : Unit: COUNT
|
764
|
+
#
|
765
|
+
# Statistics: SUM
|
766
|
+
#
|
767
|
+
# CONTACTS\_HOLD\_ABANDONS
|
768
|
+
#
|
769
|
+
# : Unit: COUNT
|
770
|
+
#
|
771
|
+
# Statistics: SUM
|
772
|
+
#
|
773
|
+
# CONTACTS\_TRANSFERRED\_IN
|
774
|
+
#
|
775
|
+
# : Unit: COUNT
|
776
|
+
#
|
777
|
+
# Statistics: SUM
|
778
|
+
#
|
779
|
+
# CONTACTS\_TRANSFERRED\_OUT
|
780
|
+
#
|
781
|
+
# : Unit: COUNT
|
782
|
+
#
|
783
|
+
# Statistics: SUM
|
784
|
+
#
|
785
|
+
# CONTACTS\_TRANSFERRED\_IN\_FROM\_QUEUE
|
786
|
+
#
|
787
|
+
# : Unit: COUNT
|
788
|
+
#
|
789
|
+
# Statistics: SUM
|
790
|
+
#
|
791
|
+
# CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
|
792
|
+
#
|
793
|
+
# : Unit: COUNT
|
794
|
+
#
|
795
|
+
# Statistics: SUM
|
796
|
+
#
|
797
|
+
# CALLBACK\_CONTACTS\_HANDLED
|
798
|
+
#
|
799
|
+
# : Unit: COUNT
|
800
|
+
#
|
801
|
+
# Statistics: SUM
|
802
|
+
#
|
803
|
+
# CALLBACK\_CONTACTS\_HANDLED
|
804
|
+
#
|
805
|
+
# : Unit: COUNT
|
806
|
+
#
|
807
|
+
# Statistics: SUM
|
808
|
+
#
|
809
|
+
# API\_CONTACTS\_HANDLED
|
810
|
+
#
|
811
|
+
# : Unit: COUNT
|
812
|
+
#
|
813
|
+
# Statistics: SUM
|
814
|
+
#
|
815
|
+
# CONTACTS\_MISSED
|
816
|
+
#
|
817
|
+
# : Unit: COUNT
|
818
|
+
#
|
819
|
+
# Statistics: SUM
|
820
|
+
#
|
821
|
+
# OCCUPANCY
|
822
|
+
#
|
823
|
+
# : Unit: PERCENT
|
824
|
+
#
|
825
|
+
# Statistics: AVG
|
826
|
+
#
|
827
|
+
# HANDLE\_TIME
|
828
|
+
#
|
829
|
+
# : Unit: SECONDS
|
830
|
+
#
|
831
|
+
# Statistics: AVG
|
832
|
+
#
|
833
|
+
# AFTER\_CONTACT\_WORK\_TIME
|
834
|
+
#
|
835
|
+
# : Unit: SECONDS
|
836
|
+
#
|
837
|
+
# Statistics: AVG
|
838
|
+
#
|
839
|
+
# QUEUED\_TIME
|
840
|
+
#
|
841
|
+
# : Unit: SECONDS
|
842
|
+
#
|
843
|
+
# Statistics: MAX
|
844
|
+
#
|
845
|
+
# ABANDON\_TIME
|
846
|
+
#
|
847
|
+
# : Unit: COUNT
|
848
|
+
#
|
849
|
+
# Statistics: SUM
|
850
|
+
#
|
851
|
+
# QUEUE\_ANSWER\_TIME
|
852
|
+
#
|
853
|
+
# : Unit: SECONDS
|
854
|
+
#
|
855
|
+
# Statistics: AVG
|
856
|
+
#
|
857
|
+
# HOLD\_TIME
|
858
|
+
#
|
859
|
+
# : Unit: SECONDS
|
860
|
+
#
|
861
|
+
# Statistics: AVG
|
862
|
+
#
|
863
|
+
# INTERACTION\_TIME
|
864
|
+
#
|
865
|
+
# : Unit: SECONDS
|
866
|
+
#
|
867
|
+
# Statistics: AVG
|
868
|
+
#
|
869
|
+
# INTERACTION\_AND\_HOLD\_TIME
|
870
|
+
#
|
871
|
+
# : Unit: SECONDS
|
872
|
+
#
|
873
|
+
# Statistics: AVG
|
874
|
+
#
|
875
|
+
# SERVICE\_LEVEL
|
876
|
+
#
|
877
|
+
# : Unit: PERCENT
|
878
|
+
#
|
879
|
+
# Statistics: AVG
|
880
|
+
#
|
881
|
+
# Threshold: Only "Less than" comparisons are supported, with the
|
882
|
+
# following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120,
|
883
|
+
# 180, 240, 300, 600
|
884
|
+
#
|
885
|
+
# @option params [String] :next_token
|
886
|
+
# The token for the next set of results. Use the value returned in the
|
887
|
+
# previous response in the next request to retrieve the next set of
|
888
|
+
# results.
|
889
|
+
#
|
890
|
+
# @option params [Integer] :max_results
|
891
|
+
# Indicates the maximum number of results to return per page in the
|
892
|
+
# response, between 1-100.
|
893
|
+
#
|
894
|
+
# @return [Types::GetMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
895
|
+
#
|
896
|
+
# * {Types::GetMetricDataResponse#next_token #next_token} => String
|
897
|
+
# * {Types::GetMetricDataResponse#metric_results #metric_results} => Array<Types::HistoricalMetricResult>
|
898
|
+
#
|
899
|
+
# @example Request syntax with placeholder values
|
900
|
+
#
|
901
|
+
# resp = client.get_metric_data({
|
902
|
+
# instance_id: "InstanceId", # required
|
903
|
+
# start_time: Time.now, # required
|
904
|
+
# end_time: Time.now, # required
|
905
|
+
# filters: { # required
|
906
|
+
# queues: ["QueueId"],
|
907
|
+
# channels: ["VOICE"], # accepts VOICE
|
908
|
+
# },
|
909
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
910
|
+
# historical_metrics: [ # required
|
911
|
+
# {
|
912
|
+
# name: "CONTACTS_QUEUED", # accepts CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL
|
913
|
+
# threshold: {
|
914
|
+
# comparison: "LT", # accepts LT
|
915
|
+
# threshold_value: 1.0,
|
916
|
+
# },
|
917
|
+
# statistic: "SUM", # accepts SUM, MAX, AVG
|
918
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
919
|
+
# },
|
920
|
+
# ],
|
921
|
+
# next_token: "NextToken",
|
922
|
+
# max_results: 1,
|
923
|
+
# })
|
924
|
+
#
|
925
|
+
# @example Response structure
|
926
|
+
#
|
927
|
+
# resp.next_token #=> String
|
928
|
+
# resp.metric_results #=> Array
|
929
|
+
# resp.metric_results[0].dimensions.queue.id #=> String
|
930
|
+
# resp.metric_results[0].dimensions.queue.arn #=> String
|
931
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE"
|
932
|
+
# resp.metric_results[0].collections #=> Array
|
933
|
+
# resp.metric_results[0].collections[0].metric.name #=> String, one of "CONTACTS_QUEUED", "CONTACTS_HANDLED", "CONTACTS_ABANDONED", "CONTACTS_CONSULTED", "CONTACTS_AGENT_HUNG_UP_FIRST", "CONTACTS_HANDLED_INCOMING", "CONTACTS_HANDLED_OUTBOUND", "CONTACTS_HOLD_ABANDONS", "CONTACTS_TRANSFERRED_IN", "CONTACTS_TRANSFERRED_OUT", "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", "CONTACTS_MISSED", "CALLBACK_CONTACTS_HANDLED", "API_CONTACTS_HANDLED", "OCCUPANCY", "HANDLE_TIME", "AFTER_CONTACT_WORK_TIME", "QUEUED_TIME", "ABANDON_TIME", "QUEUE_ANSWER_TIME", "HOLD_TIME", "INTERACTION_TIME", "INTERACTION_AND_HOLD_TIME", "SERVICE_LEVEL"
|
934
|
+
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
935
|
+
# resp.metric_results[0].collections[0].metric.threshold.threshold_value #=> Float
|
936
|
+
# resp.metric_results[0].collections[0].metric.statistic #=> String, one of "SUM", "MAX", "AVG"
|
937
|
+
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
938
|
+
# resp.metric_results[0].collections[0].value #=> Float
|
939
|
+
#
|
940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData AWS API Documentation
|
941
|
+
#
|
942
|
+
# @overload get_metric_data(params = {})
|
943
|
+
# @param [Hash] params ({})
|
944
|
+
def get_metric_data(params = {}, options = {})
|
945
|
+
req = build_request(:get_metric_data, params)
|
946
|
+
req.send_request(options)
|
947
|
+
end
|
948
|
+
|
504
949
|
# Returns an array of `RoutingProfileSummary` objects that includes
|
505
950
|
# information about the routing profiles in your instance.
|
506
951
|
#
|
@@ -706,9 +1151,6 @@ module Aws::Connect
|
|
706
1151
|
# The `StartOutboundVoiceContact` operation initiates a contact flow to
|
707
1152
|
# place an outbound call to a customer.
|
708
1153
|
#
|
709
|
-
# There is a throttling limit placed on usage of the API that includes a
|
710
|
-
# RateLimit of 2 per second, and a BurstLimit of 5 per second.
|
711
|
-
#
|
712
1154
|
# If you are using an IAM account, it must have permission to the
|
713
1155
|
# `connect:StartOutboundVoiceContact` action.
|
714
1156
|
#
|
@@ -839,7 +1281,7 @@ module Aws::Connect
|
|
839
1281
|
end
|
840
1282
|
|
841
1283
|
# The `UpdateContactAttributes` operation lets you programmatically
|
842
|
-
# create new or update existing contact attributes associated with a
|
1284
|
+
# create new, or update existing, contact attributes associated with a
|
843
1285
|
# contact. You can use the operation to add or update attributes for
|
844
1286
|
# both ongoing and completed contacts. For example, you can update the
|
845
1287
|
# customer's name or the reason the customer called while the call is
|
@@ -848,11 +1290,22 @@ module Aws::Connect
|
|
848
1290
|
# use the `UpdateContactAttributes` operation to update attributes for a
|
849
1291
|
# contact using data from your CRM application and save the data with
|
850
1292
|
# the contact in Amazon Connect. You could also flag calls for
|
851
|
-
# additional analysis, or
|
1293
|
+
# additional analysis, such as legal review or identifying abusive
|
1294
|
+
# callers.
|
852
1295
|
#
|
853
1296
|
# Contact attributes are available in Amazon Connect for 24 months, and
|
854
1297
|
# are then deleted.
|
855
1298
|
#
|
1299
|
+
# *Important:*
|
1300
|
+
#
|
1301
|
+
# You cannot use the operation to update attributes for contacts that
|
1302
|
+
# occurred prior to the release of the API, September 12, 2018. You can
|
1303
|
+
# update attributes only for contacts that started after the release of
|
1304
|
+
# the API. If you attempt to update attributes for a contact that
|
1305
|
+
# occurred prior to the release of the API, a 400 error is returned.
|
1306
|
+
# This applies also to queued callbacks that were initiated prior to the
|
1307
|
+
# release of the API but are still active in your instance.
|
1308
|
+
#
|
856
1309
|
# @option params [required, String] :initial_contact_id
|
857
1310
|
# The unique identifier of the contact for which to update attributes.
|
858
1311
|
# This is the identifier for the contact associated with the first
|
@@ -860,9 +1313,9 @@ module Aws::Connect
|
|
860
1313
|
#
|
861
1314
|
# @option params [required, String] :instance_id
|
862
1315
|
# The identifier for your Amazon Connect instance. To find the ID of
|
863
|
-
# your
|
864
|
-
#
|
865
|
-
# displayed in the Overview section of your instance settings. For
|
1316
|
+
# your instance, open the AWS console and select Amazon Connect. Select
|
1317
|
+
# the alias of the instance in the Instance alias column. The instance
|
1318
|
+
# ID is displayed in the Overview section of your instance settings. For
|
866
1319
|
# example, the instance ID is the set of characters at the end of the
|
867
1320
|
# instance ARN, after instance/, such as
|
868
1321
|
# 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
|
@@ -1049,7 +1502,7 @@ module Aws::Connect
|
|
1049
1502
|
req.send_request(options)
|
1050
1503
|
end
|
1051
1504
|
|
1052
|
-
#
|
1505
|
+
# Updates the security profiles assigned to the user.
|
1053
1506
|
#
|
1054
1507
|
# @option params [required, Array<String>] :security_profile_ids
|
1055
1508
|
# The identifiers for the security profiles to assign to the user.
|
@@ -1098,7 +1551,7 @@ module Aws::Connect
|
|
1098
1551
|
params: params,
|
1099
1552
|
config: config)
|
1100
1553
|
context[:gem_name] = 'aws-sdk-connect'
|
1101
|
-
context[:gem_version] = '1.
|
1554
|
+
context[:gem_version] = '1.6.0'
|
1102
1555
|
Seahorse::Client::Request.new(handlers, context)
|
1103
1556
|
end
|
1104
1557
|
|