aws-sdk-connect 1.19.0 → 1.20.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 4938c9dd2aa7b5854b00d90d97945abb00fdb449
4
- data.tar.gz: af80fd1b855564b7c621e962feb1401391d818f8
3
+ metadata.gz: 2bf3f125c96a0247cde930d7bb1b755636d579c5
4
+ data.tar.gz: 32d214d642aa93c62104876e40be650fd2d39e05
5
5
  SHA512:
6
- metadata.gz: d087da2d95b8b4c48728e22d2b09b931527c620fefa2e2a125fd9eff3bb3ec8c8342be4bdcbaf3e551834be8162f7336e847d0ec59a2f0bcfb9611f455e4e1f8
7
- data.tar.gz: 5ebb6ec6cc6cda4142cf6c8321aea805052aaa3bf745c2c7bdd2a73c49151cd32d6e4c15edf8c9c320ae63e1ab7fa0b883f3df7fd9a6a5bcc45d3a5b4de92f85
6
+ metadata.gz: 4941b86187966d857f07fca4dde4b6700f3a873e34e1c7a0fc06301b7e42b05b5c90afc2787b03c0be6bb5aa82a5f1386276aa91c24dfbc2a6ac0fbb47d71dc6
7
+ data.tar.gz: d0912a49e9b9d585a79ab54e981b5af7d25709bb72fccae222a794080bd9df268998058186e97b2987c17e40e8ecb38cd72d3ac4c9bfb4c1a895687f957da5e9
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-connect/customizations'
42
42
  # @service
43
43
  module Aws::Connect
44
44
 
45
- GEM_VERSION = '1.19.0'
45
+ GEM_VERSION = '1.20.0'
46
46
 
47
47
  end
@@ -254,64 +254,49 @@ module Aws::Connect
254
254
 
255
255
  # @!group API Operations
256
256
 
257
- # Creates a new user account in your Amazon Connect instance.
257
+ # Creates a user account for the specified Amazon Connect instance.
258
258
  #
259
259
  # @option params [required, String] :username
260
- # The user name in Amazon Connect for the account to create. If you are
261
- # using SAML for identity management in your Amazon Connect, the value
262
- # for `Username` can include up to 64 characters from
263
- # \[a-zA-Z0-9\_-.\\@\]+.
260
+ # The user name for the account. For instances not using SAML for
261
+ # identity management, the user name can include up to 20 characters. If
262
+ # you are using SAML for identity management, the user name can include
263
+ # up to 64 characters from \[a-zA-Z0-9\_-.\\@\]+.
264
264
  #
265
265
  # @option params [String] :password
266
- # The password for the user account to create. This is required if you
267
- # are using Amazon Connect for identity management. If you are using
268
- # SAML for identity management and include this parameter, an
269
- # `InvalidRequestException` is returned.
266
+ # The password for the user account. A password is required if you are
267
+ # using Amazon Connect for identity management. Otherwise, it is an
268
+ # error to include a password.
270
269
  #
271
270
  # @option params [Types::UserIdentityInfo] :identity_info
272
- # Information about the user, including email address, first name, and
273
- # last name.
271
+ # The information about the identity of the user.
274
272
  #
275
273
  # @option params [required, Types::UserPhoneConfig] :phone_config
276
- # Specifies the phone settings for the user, including
277
- # `AfterContactWorkTimeLimit`, `AutoAccept`, `DeskPhoneNumber`, and
278
- # `PhoneType`.
274
+ # The phone settings for the user.
279
275
  #
280
276
  # @option params [String] :directory_user_id
281
- # The unique identifier for the user account in the directory service
282
- # directory used for identity management. If Amazon Connect is unable to
283
- # access the existing directory, you can use the `DirectoryUserId` to
284
- # authenticate users. If you include the parameter, it is assumed that
285
- # Amazon Connect cannot access the directory. If the parameter is not
286
- # included, the `UserIdentityInfo` is used to authenticate users from
287
- # your existing directory.
277
+ # The identifier of the user account in the directory used for identity
278
+ # management. If Amazon Connect cannot access the directory, you can
279
+ # specify this identifier to authenticate users. If you include the
280
+ # identifier, we assume that Amazon Connect cannot access the directory.
281
+ # Otherwise, the identity information is used to authenticate users from
282
+ # your directory.
288
283
  #
289
284
  # This parameter is required if you are using an existing directory for
290
285
  # identity management in Amazon Connect when Amazon Connect cannot
291
286
  # access your directory to authenticate users. If you are using SAML for
292
- # identity management and include this parameter, an
293
- # `InvalidRequestException` is returned.
287
+ # identity management and include this parameter, an error is returned.
294
288
  #
295
289
  # @option params [required, Array<String>] :security_profile_ids
296
- # The unique identifier of the security profile to assign to the user
297
- # created.
290
+ # The identifier of the security profile for the user.
298
291
  #
299
292
  # @option params [required, String] :routing_profile_id
300
- # The unique identifier for the routing profile to assign to the user
301
- # created.
293
+ # The identifier of the routing profile for the user.
302
294
  #
303
295
  # @option params [String] :hierarchy_group_id
304
- # The unique identifier for the hierarchy group to assign to the user
305
- # created.
296
+ # The identifier of the hierarchy group for the user.
306
297
  #
307
298
  # @option params [required, String] :instance_id
308
- # The identifier for your Amazon Connect instance. To find the ID of
309
- # your instance, open the AWS console and select Amazon Connect. Select
310
- # the alias of the instance in the Instance alias column. The instance
311
- # ID is displayed in the Overview section of your instance settings. For
312
- # example, the instance ID is the set of characters at the end of the
313
- # instance ARN, after instance/, such as
314
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
299
+ # The identifier of the Amazon Connect instance.
315
300
  #
316
301
  # @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
317
302
  #
@@ -355,19 +340,13 @@ module Aws::Connect
355
340
  req.send_request(options)
356
341
  end
357
342
 
358
- # Deletes a user account from Amazon Connect.
343
+ # Deletes a user account from the specified Amazon Connect instance.
359
344
  #
360
345
  # @option params [required, String] :instance_id
361
- # The identifier for your Amazon Connect instance. To find the ID of
362
- # your instance, open the AWS console and select Amazon Connect. Select
363
- # the alias of the instance in the Instance alias column. The instance
364
- # ID is displayed in the Overview section of your instance settings. For
365
- # example, the instance ID is the set of characters at the end of the
366
- # instance ARN, after instance/, such as
367
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
346
+ # The identifier of the Amazon Connect instance.
368
347
  #
369
348
  # @option params [required, String] :user_id
370
- # The unique identifier of the user to delete.
349
+ # The identifier of the user.
371
350
  #
372
351
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
373
352
  #
@@ -387,20 +366,13 @@ module Aws::Connect
387
366
  req.send_request(options)
388
367
  end
389
368
 
390
- # Returns a `User` object that contains information about the user
391
- # account specified by the `UserId`.
369
+ # Describes the specified user account.
392
370
  #
393
371
  # @option params [required, String] :user_id
394
- # Unique identifier for the user account to return.
372
+ # The identifier of the user account.
395
373
  #
396
374
  # @option params [required, String] :instance_id
397
- # The identifier for your Amazon Connect instance. To find the ID of
398
- # your instance, open the AWS console and select Amazon Connect. Select
399
- # the alias of the instance in the Instance alias column. The instance
400
- # ID is displayed in the Overview section of your instance settings. For
401
- # example, the instance ID is the set of characters at the end of the
402
- # instance ARN, after instance/, such as
403
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
375
+ # The identifier of the Amazon Connect instance.
404
376
  #
405
377
  # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
406
378
  #
@@ -440,20 +412,13 @@ module Aws::Connect
440
412
  req.send_request(options)
441
413
  end
442
414
 
443
- # Returns a `HierarchyGroup` object that includes information about a
444
- # hierarchy group in your instance.
415
+ # Describes the specified hierarchy group.
445
416
  #
446
417
  # @option params [required, String] :hierarchy_group_id
447
- # The identifier for the hierarchy group to return.
418
+ # The identifier of the hierarchy group.
448
419
  #
449
420
  # @option params [required, String] :instance_id
450
- # The identifier for your Amazon Connect instance. To find the ID of
451
- # your instance, open the AWS console and select Amazon Connect. Select
452
- # the alias of the instance in the Instance alias column. The instance
453
- # ID is displayed in the Overview section of your instance settings. For
454
- # example, the instance ID is the set of characters at the end of the
455
- # instance ARN, after instance/, such as
456
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
421
+ # The identifier of the Amazon Connect instance.
457
422
  #
458
423
  # @return [Types::DescribeUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
459
424
  #
@@ -497,17 +462,11 @@ module Aws::Connect
497
462
  req.send_request(options)
498
463
  end
499
464
 
500
- # Returns a `HiearchyGroupStructure` object, which contains data about
501
- # the levels in the agent hierarchy.
465
+ # Describes the hierarchy structure of the specified Amazon Connect
466
+ # instance.
502
467
  #
503
468
  # @option params [required, String] :instance_id
504
- # The identifier for your Amazon Connect instance. To find the ID of
505
- # your instance, open the AWS console and select Amazon Connect. Select
506
- # the alias of the instance in the Instance alias column. The instance
507
- # ID is displayed in the Overview section of your instance settings. For
508
- # example, the instance ID is the set of characters at the end of the
509
- # instance ARN, after instance/, such as
510
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
469
+ # The identifier of the Amazon Connect instance.
511
470
  #
512
471
  # @return [Types::DescribeUserHierarchyStructureResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
513
472
  #
@@ -546,15 +505,13 @@ module Aws::Connect
546
505
  req.send_request(options)
547
506
  end
548
507
 
549
- # Retrieves the contact attributes associated with a contact.
508
+ # Retrieves the contact attributes for the specified contact.
550
509
  #
551
510
  # @option params [required, String] :instance_id
552
- # The instance ID for the instance from which to retrieve contact
553
- # attributes.
511
+ # The identifier of the Amazon Connect instance.
554
512
  #
555
513
  # @option params [required, String] :initial_contact_id
556
- # The ID for the initial contact in Amazon Connect associated with the
557
- # attributes to update.
514
+ # The identifier of the initial contact.
558
515
  #
559
516
  # @return [Types::GetContactAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
560
517
  #
@@ -581,80 +538,64 @@ module Aws::Connect
581
538
  req.send_request(options)
582
539
  end
583
540
 
584
- # The `GetCurrentMetricData` operation retrieves current metric data
585
- # from your Amazon Connect instance.
541
+ # Gets the real-time metric data from the specified Amazon Connect
542
+ # instance.
586
543
  #
587
- # If you are using an IAM account, it must have permission to the
588
- # `connect:GetCurrentMetricData` action.
544
+ # For more information, see [Real-time Metrics Reports][1] in the
545
+ # *Amazon Connect Administrator Guide*.
546
+ #
547
+ #
548
+ #
549
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-reports.html
589
550
  #
590
551
  # @option params [required, String] :instance_id
591
- # The identifier for your Amazon Connect instance. To find the ID of
592
- # your instance, open the AWS console and select Amazon Connect. Select
593
- # the alias of the instance in the Instance alias column. The instance
594
- # ID is displayed in the Overview section of your instance settings. For
595
- # example, the instance ID is the set of characters at the end of the
596
- # instance ARN, after instance/, such as
597
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
552
+ # The identifier of the Amazon Connect instance.
598
553
  #
599
554
  # @option params [required, Types::Filters] :filters
600
- # A `Filters` object that contains a list of queue IDs or queue ARNs, up
601
- # to 100, or list of Channels to use to filter the metrics returned in
602
- # the response. Metric data is retrieved only for the resources
603
- # associated with the queue IDs, ARNs, or Channels included in the
604
- # filter. You can include both IDs and ARNs in the same request. To
605
- # retrieve metrics for all queues, add the queue ID or ARN for each
606
- # queue in your instance. Only VOICE is supported for Channels.
607
- #
608
- # To find the ARN for a queue, open the queue you want to use in the
609
- # Amazon Connect Queue editor. The ARN for the queue is displayed in the
610
- # address bar as part of the URL. For example, the queue ARN is the set
611
- # of characters at the end of the URL, after 'id=' such as
612
- # `arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61`.
613
- # The queue ID is also included in the URL, and is the string after
614
- # 'queue/'.
555
+ # The queues, up to 100, or channels, to use to filter the metrics
556
+ # returned. Metric data is retrieved only for the resources associated
557
+ # with the queues or channels included in the filter. You can include
558
+ # both queue IDs and queue ARNs in the same request. The only supported
559
+ # channel is `VOICE`.
615
560
  #
616
561
  # @option params [Array<String>] :groupings
617
562
  # The grouping applied to the metrics returned. For example, when
618
- # grouped by QUEUE, the metrics returned apply to each queue rather than
619
- # aggregated for all queues. If you group by CHANNEL, you should include
620
- # a Channels filter. The only supported channel is VOICE.
563
+ # grouped by `QUEUE`, the metrics returned apply to each queue rather
564
+ # than aggregated for all queues. If you group by `CHANNEL`, you should
565
+ # include a Channels filter. The only supported channel is `VOICE`.
621
566
  #
622
- # If no `Grouping` is included in the request, a summary of
623
- # `CurrentMetrics` is returned.
567
+ # If no `Grouping` is included in the request, a summary of metrics is
568
+ # returned.
624
569
  #
625
570
  # @option params [required, Array<Types::CurrentMetric>] :current_metrics
626
- # A list of `CurrentMetric` objects for the metrics to retrieve. Each
627
- # `CurrentMetric` includes a name of a metric to retrieve and the unit
628
- # to use for it. You must list each metric to retrieve data for in the
629
- # request.
630
- #
571
+ # The metrics to retrieve. Specify the name and unit for each metric.
631
572
  # The following metrics are available:
632
573
  #
633
- # AGENTS\_AVAILABLE
574
+ # AGENTS\_AFTER\_CONTACT\_WORK
634
575
  #
635
576
  # : Unit: COUNT
636
577
  #
637
- # AGENTS\_ONLINE
578
+ # AGENTS\_AVAILABLE
638
579
  #
639
580
  # : Unit: COUNT
640
581
  #
641
- # AGENTS\_ON\_CALL
582
+ # AGENTS\_ERROR
642
583
  #
643
584
  # : Unit: COUNT
644
585
  #
645
- # AGENTS\_STAFFED
586
+ # AGENTS\_NON\_PRODUCTIVE
646
587
  #
647
588
  # : Unit: COUNT
648
589
  #
649
- # AGENTS\_AFTER\_CONTACT\_WORK
590
+ # AGENTS\_ON\_CALL
650
591
  #
651
592
  # : Unit: COUNT
652
593
  #
653
- # AGENTS\_NON\_PRODUCTIVE
594
+ # AGENTS\_ONLINE
654
595
  #
655
596
  # : Unit: COUNT
656
597
  #
657
- # AGENTS\_ERROR
598
+ # AGENTS\_STAFFED
658
599
  #
659
600
  # : Unit: COUNT
660
601
  #
@@ -662,26 +603,25 @@ module Aws::Connect
662
603
  #
663
604
  # : Unit: COUNT
664
605
  #
665
- # OLDEST\_CONTACT\_AGE
666
- #
667
- # : Unit: SECONDS
668
- #
669
606
  # CONTACTS\_SCHEDULED
670
607
  #
671
608
  # : Unit: COUNT
672
609
  #
610
+ # OLDEST\_CONTACT\_AGE
611
+ #
612
+ # : Unit: SECONDS
613
+ #
673
614
  # @option params [String] :next_token
674
615
  # The token for the next set of results. Use the value returned in the
675
616
  # previous response in the next request to retrieve the next set of
676
617
  # results.
677
618
  #
678
619
  # The token expires after 5 minutes from the time it is created.
679
- # Subsequent requests that use the [NextToken]() must use the same
680
- # request parameters as the request that generated the token.
620
+ # Subsequent requests that use the token must use the same request
621
+ # parameters as the request that generated the token.
681
622
  #
682
623
  # @option params [Integer] :max_results
683
- # `MaxResults` indicates the maximum number of results to return per
684
- # page in the response, between 1 and 100.
624
+ # The maximimum number of results to return per page.
685
625
  #
686
626
  # @return [Types::GetCurrentMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
687
627
  #
@@ -733,13 +673,7 @@ module Aws::Connect
733
673
  # Retrieves a token for federation.
734
674
  #
735
675
  # @option params [required, String] :instance_id
736
- # The identifier for your Amazon Connect instance. To find the ID of
737
- # your instance, open the AWS console and select Amazon Connect. Select
738
- # the alias of the instance in the Instance alias column. The instance
739
- # ID is displayed in the Overview section of your instance settings. For
740
- # example, the instance ID is the set of characters at the end of the
741
- # instance ARN, after instance/, such as
742
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
676
+ # The identifier of the Amazon Connect instance.
743
677
  #
744
678
  # @return [Types::GetFederationTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
745
679
  #
@@ -767,20 +701,18 @@ module Aws::Connect
767
701
  req.send_request(options)
768
702
  end
769
703
 
770
- # The `GetMetricData` operation retrieves historical metrics data from
771
- # your Amazon Connect instance.
704
+ # Gets historical metric data from the specified Amazon Connect
705
+ # instance.
706
+ #
707
+ # For more information, see [Historical Metrics Reports][1] in the
708
+ # *Amazon Connect Administrator Guide*.
709
+ #
710
+ #
772
711
  #
773
- # If you are using an IAM account, it must have permission to the
774
- # `connect:GetMetricData` action.
712
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics.html
775
713
  #
776
714
  # @option params [required, String] :instance_id
777
- # The identifier for your Amazon Connect instance. To find the ID of
778
- # your instance, open the AWS console and select Amazon Connect. Select
779
- # the alias of the instance in the Instance alias column. The instance
780
- # ID is displayed in the Overview section of your instance settings. For
781
- # example, the instance ID is the set of characters at the end of the
782
- # instance ARN, after instance/, such as
783
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
715
+ # The identifier of the Amazon Connect instance.
784
716
  #
785
717
  # @option params [required, Time,DateTime,Date,Integer,String] :start_time
786
718
  # The timestamp, in UNIX Epoch time format, at which to start the
@@ -788,214 +720,189 @@ module Aws::Connect
788
720
  # time must be specified using a multiple of 5 minutes, such as 10:05,
789
721
  # 10:10, 10:15.
790
722
  #
791
- # `StartTime` cannot be earlier than 24 hours before the time of the
792
- # request. Historical metrics are available in Amazon Connect only for
793
- # 24 hours.
723
+ # The start time cannot be earlier than 24 hours before the time of the
724
+ # request. Historical metrics are available only for 24 hours.
794
725
  #
795
726
  # @option params [required, Time,DateTime,Date,Integer,String] :end_time
796
727
  # The timestamp, in UNIX Epoch time format, at which to end the
797
728
  # reporting interval for the retrieval of historical metrics data. The
798
729
  # time must be specified using an interval of 5 minutes, such as 11:00,
799
- # 11:05, 11:10, and must be later than the `StartTime` timestamp.
730
+ # 11:05, 11:10, and must be later than the start time timestamp.
800
731
  #
801
- # The time range between `StartTime` and `EndTime` must be less than 24
732
+ # The time range between the start and end time must be less than 24
802
733
  # hours.
803
734
  #
804
735
  # @option params [required, Types::Filters] :filters
805
- # A `Filters` object that contains a list of queue IDs or queue ARNs, up
806
- # to 100, or a list of Channels to use to filter the metrics returned in
807
- # the response. Metric data is retrieved only for the resources
808
- # associated with the IDs, ARNs, or Channels included in the filter. You
809
- # can use both IDs and ARNs together in a request. Only VOICE is
810
- # supported for Channel.
811
- #
812
- # To find the ARN for a queue, open the queue you want to use in the
813
- # Amazon Connect Queue editor. The ARN for the queue is displayed in the
814
- # address bar as part of the URL. For example, the queue ARN is the set
815
- # of characters at the end of the URL, after 'id=' such as
816
- # `arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61`.
817
- # The queue ID is also included in the URL, and is the string after
818
- # 'queue/'.
736
+ # The queues, up to 100, or channels, to use to filter the metrics
737
+ # returned. Metric data is retrieved only for the resources associated
738
+ # with the queues or channels included in the filter. You can include
739
+ # both queue IDs and queue ARNs in the same request. The only supported
740
+ # channel is `VOICE`.
819
741
  #
820
742
  # @option params [Array<String>] :groupings
821
743
  # The grouping applied to the metrics returned. For example, when
822
- # results are grouped by queueId, the metrics returned are grouped by
744
+ # results are grouped by queue, the metrics returned are grouped by
823
745
  # queue. The values returned apply to the metrics for each queue rather
824
746
  # than aggregated for all queues.
825
747
  #
826
- # The current version supports grouping by Queue
748
+ # The only supported grouping is `QUEUE`.
827
749
  #
828
- # If no `Grouping` is included in the request, a summary of
829
- # `HistoricalMetrics` for all queues is returned.
750
+ # If no grouping is specified, a summary of metrics for all queues is
751
+ # returned.
830
752
  #
831
753
  # @option params [required, Array<Types::HistoricalMetric>] :historical_metrics
832
- # A list of `HistoricalMetric` objects that contain the metrics to
833
- # retrieve with the request.
754
+ # The metrics to retrieve. Specify the name, unit, and statistic for
755
+ # each metric. The following historical metrics are available:
834
756
  #
835
- # A `HistoricalMetric` object contains: `HistoricalMetricName`,
836
- # `Statistic`, `Threshold`, and `Unit`.
757
+ # ABANDON\_TIME
837
758
  #
838
- # You must list each metric to retrieve data for in the request. For
839
- # each historical metric you include in the request, you must include a
840
- # `Unit` and a `Statistic`.
759
+ # : Unit: SECONDS
841
760
  #
842
- # The following historical metrics are available:
761
+ # Statistic: AVG
843
762
  #
844
- # CONTACTS\_QUEUED
763
+ # AFTER\_CONTACT\_WORK\_TIME
845
764
  #
846
- # : Unit: COUNT
765
+ # : Unit: SECONDS
847
766
  #
848
- # Statistic: SUM
767
+ # Statistic: AVG
849
768
  #
850
- # CONTACTS\_HANDLED
769
+ # API\_CONTACTS\_HANDLED
851
770
  #
852
771
  # : Unit: COUNT
853
772
  #
854
- # Statistics: SUM
773
+ # Statistic: SUM
855
774
  #
856
- # CONTACTS\_ABANDONED
775
+ # CALLBACK\_CONTACTS\_HANDLED
857
776
  #
858
777
  # : Unit: COUNT
859
778
  #
860
- # Statistics: SUM
779
+ # Statistic: SUM
861
780
  #
862
- # CONTACTS\_CONSULTED
781
+ # CONTACTS\_ABANDONED
863
782
  #
864
783
  # : Unit: COUNT
865
784
  #
866
- # Statistics: SUM
785
+ # Statistic: SUM
867
786
  #
868
787
  # CONTACTS\_AGENT\_HUNG\_UP\_FIRST
869
788
  #
870
789
  # : Unit: COUNT
871
790
  #
872
- # Statistics: SUM
791
+ # Statistic: SUM
873
792
  #
874
- # CONTACTS\_HANDLED\_INCOMING
793
+ # CONTACTS\_CONSULTED
875
794
  #
876
795
  # : Unit: COUNT
877
796
  #
878
- # Statistics: SUM
797
+ # Statistic: SUM
879
798
  #
880
- # CONTACTS\_HANDLED\_OUTBOUND
799
+ # CONTACTS\_HANDLED
881
800
  #
882
801
  # : Unit: COUNT
883
802
  #
884
- # Statistics: SUM
803
+ # Statistic: SUM
885
804
  #
886
- # CONTACTS\_HOLD\_ABANDONS
805
+ # CONTACTS\_HANDLED\_INCOMING
887
806
  #
888
807
  # : Unit: COUNT
889
808
  #
890
- # Statistics: SUM
809
+ # Statistic: SUM
891
810
  #
892
- # CONTACTS\_TRANSFERRED\_IN
811
+ # CONTACTS\_HANDLED\_OUTBOUND
893
812
  #
894
813
  # : Unit: COUNT
895
814
  #
896
- # Statistics: SUM
815
+ # Statistic: SUM
897
816
  #
898
- # CONTACTS\_TRANSFERRED\_OUT
817
+ # CONTACTS\_HOLD\_ABANDONS
899
818
  #
900
819
  # : Unit: COUNT
901
820
  #
902
- # Statistics: SUM
821
+ # Statistic: SUM
903
822
  #
904
- # CONTACTS\_TRANSFERRED\_IN\_FROM\_QUEUE
823
+ # CONTACTS\_MISSED
905
824
  #
906
825
  # : Unit: COUNT
907
826
  #
908
- # Statistics: SUM
827
+ # Statistic: SUM
909
828
  #
910
- # CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
829
+ # CONTACTS\_QUEUED
911
830
  #
912
831
  # : Unit: COUNT
913
832
  #
914
- # Statistics: SUM
833
+ # Statistic: SUM
915
834
  #
916
- # CALLBACK\_CONTACTS\_HANDLED
835
+ # CONTACTS\_TRANSFERRED\_IN
917
836
  #
918
837
  # : Unit: COUNT
919
838
  #
920
- # Statistics: SUM
839
+ # Statistic: SUM
921
840
  #
922
- # CALLBACK\_CONTACTS\_HANDLED
841
+ # CONTACTS\_TRANSFERRED\_IN\_FROM\_QUEUE
923
842
  #
924
843
  # : Unit: COUNT
925
844
  #
926
- # Statistics: SUM
845
+ # Statistic: SUM
927
846
  #
928
- # API\_CONTACTS\_HANDLED
847
+ # CONTACTS\_TRANSFERRED\_OUT
929
848
  #
930
849
  # : Unit: COUNT
931
850
  #
932
- # Statistics: SUM
851
+ # Statistic: SUM
933
852
  #
934
- # CONTACTS\_MISSED
853
+ # CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
935
854
  #
936
855
  # : Unit: COUNT
937
856
  #
938
- # Statistics: SUM
939
- #
940
- # OCCUPANCY
941
- #
942
- # : Unit: PERCENT
943
- #
944
- # Statistics: AVG
857
+ # Statistic: SUM
945
858
  #
946
859
  # HANDLE\_TIME
947
860
  #
948
861
  # : Unit: SECONDS
949
862
  #
950
- # Statistics: AVG
863
+ # Statistic: AVG
951
864
  #
952
- # AFTER\_CONTACT\_WORK\_TIME
865
+ # HOLD\_TIME
953
866
  #
954
867
  # : Unit: SECONDS
955
868
  #
956
- # Statistics: AVG
869
+ # Statistic: AVG
957
870
  #
958
- # QUEUED\_TIME
871
+ # INTERACTION\_AND\_HOLD\_TIME
959
872
  #
960
873
  # : Unit: SECONDS
961
874
  #
962
- # Statistics: MAX
963
- #
964
- # ABANDON\_TIME
965
- #
966
- # : Unit: COUNT
967
- #
968
- # Statistics: SUM
875
+ # Statistic: AVG
969
876
  #
970
- # QUEUE\_ANSWER\_TIME
877
+ # INTERACTION\_TIME
971
878
  #
972
879
  # : Unit: SECONDS
973
880
  #
974
- # Statistics: AVG
881
+ # Statistic: AVG
975
882
  #
976
- # HOLD\_TIME
883
+ # OCCUPANCY
977
884
  #
978
- # : Unit: SECONDS
885
+ # : Unit: PERCENT
979
886
  #
980
- # Statistics: AVG
887
+ # Statistic: AVG
981
888
  #
982
- # INTERACTION\_TIME
889
+ # QUEUE\_ANSWER\_TIME
983
890
  #
984
891
  # : Unit: SECONDS
985
892
  #
986
- # Statistics: AVG
893
+ # Statistic: AVG
987
894
  #
988
- # INTERACTION\_AND\_HOLD\_TIME
895
+ # QUEUED\_TIME
989
896
  #
990
897
  # : Unit: SECONDS
991
898
  #
992
- # Statistics: AVG
899
+ # Statistic: MAX
993
900
  #
994
901
  # SERVICE\_LEVEL
995
902
  #
996
903
  # : Unit: PERCENT
997
904
  #
998
- # Statistics: AVG
905
+ # Statistic: AVG
999
906
  #
1000
907
  # Threshold: Only "Less than" comparisons are supported, with the
1001
908
  # following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120,
@@ -1007,8 +914,7 @@ module Aws::Connect
1007
914
  # results.
1008
915
  #
1009
916
  # @option params [Integer] :max_results
1010
- # Indicates the maximum number of results to return per page in the
1011
- # response, between 1-100.
917
+ # The maximimum number of results to return per page.
1012
918
  #
1013
919
  # @return [Types::GetMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1014
920
  #
@@ -1065,17 +971,14 @@ module Aws::Connect
1065
971
  req.send_request(options)
1066
972
  end
1067
973
 
1068
- # Returns an array of `RoutingProfileSummary` objects that includes
1069
- # information about the routing profiles in your instance.
974
+ # Provides information about the contact flows for the specified Amazon
975
+ # Connect instance.
1070
976
  #
1071
977
  # @option params [required, String] :instance_id
1072
- # The identifier for your Amazon Connect instance. To find the ID of
1073
- # your instance, open the AWS console and select Amazon Connect. Select
1074
- # the alias of the instance in the Instance alias column. The instance
1075
- # ID is displayed in the Overview section of your instance settings. For
1076
- # example, the instance ID is the set of characters at the end of the
1077
- # instance ARN, after instance/, such as
1078
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
978
+ # The identifier of the Amazon Connect instance.
979
+ #
980
+ # @option params [Array<String>] :contact_flow_types
981
+ # The type of contact flow.
1079
982
  #
1080
983
  # @option params [String] :next_token
1081
984
  # The token for the next set of results. Use the value returned in the
@@ -1083,7 +986,200 @@ module Aws::Connect
1083
986
  # results.
1084
987
  #
1085
988
  # @option params [Integer] :max_results
1086
- # The maximum number of routing profiles to return in the response.
989
+ # The maximimum number of results to return per page.
990
+ #
991
+ # @return [Types::ListContactFlowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
992
+ #
993
+ # * {Types::ListContactFlowsResponse#contact_flow_summary_list #contact_flow_summary_list} => Array&lt;Types::ContactFlowSummary&gt;
994
+ # * {Types::ListContactFlowsResponse#next_token #next_token} => String
995
+ #
996
+ # @example Request syntax with placeholder values
997
+ #
998
+ # resp = client.list_contact_flows({
999
+ # instance_id: "InstanceId", # required
1000
+ # contact_flow_types: ["CONTACT_FLOW"], # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
1001
+ # next_token: "NextToken",
1002
+ # max_results: 1,
1003
+ # })
1004
+ #
1005
+ # @example Response structure
1006
+ #
1007
+ # resp.contact_flow_summary_list #=> Array
1008
+ # resp.contact_flow_summary_list[0].id #=> String
1009
+ # resp.contact_flow_summary_list[0].arn #=> String
1010
+ # resp.contact_flow_summary_list[0].name #=> String
1011
+ # resp.contact_flow_summary_list[0].contact_flow_type #=> String, one of "CONTACT_FLOW", "CUSTOMER_QUEUE", "CUSTOMER_HOLD", "CUSTOMER_WHISPER", "AGENT_HOLD", "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", "QUEUE_TRANSFER"
1012
+ # resp.next_token #=> String
1013
+ #
1014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlows AWS API Documentation
1015
+ #
1016
+ # @overload list_contact_flows(params = {})
1017
+ # @param [Hash] params ({})
1018
+ def list_contact_flows(params = {}, options = {})
1019
+ req = build_request(:list_contact_flows, params)
1020
+ req.send_request(options)
1021
+ end
1022
+
1023
+ # Provides information about the hours of operation for the specified
1024
+ # Amazon Connect instance.
1025
+ #
1026
+ # @option params [required, String] :instance_id
1027
+ # The identifier of the Amazon Connect instance.
1028
+ #
1029
+ # @option params [String] :next_token
1030
+ # The token for the next set of results. Use the value returned in the
1031
+ # previous response in the next request to retrieve the next set of
1032
+ # results.
1033
+ #
1034
+ # @option params [Integer] :max_results
1035
+ # The maximimum number of results to return per page.
1036
+ #
1037
+ # @return [Types::ListHoursOfOperationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1038
+ #
1039
+ # * {Types::ListHoursOfOperationsResponse#hours_of_operation_summary_list #hours_of_operation_summary_list} => Array&lt;Types::HoursOfOperationSummary&gt;
1040
+ # * {Types::ListHoursOfOperationsResponse#next_token #next_token} => String
1041
+ #
1042
+ # @example Request syntax with placeholder values
1043
+ #
1044
+ # resp = client.list_hours_of_operations({
1045
+ # instance_id: "InstanceId", # required
1046
+ # next_token: "NextToken",
1047
+ # max_results: 1,
1048
+ # })
1049
+ #
1050
+ # @example Response structure
1051
+ #
1052
+ # resp.hours_of_operation_summary_list #=> Array
1053
+ # resp.hours_of_operation_summary_list[0].id #=> String
1054
+ # resp.hours_of_operation_summary_list[0].arn #=> String
1055
+ # resp.hours_of_operation_summary_list[0].name #=> String
1056
+ # resp.next_token #=> String
1057
+ #
1058
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperations AWS API Documentation
1059
+ #
1060
+ # @overload list_hours_of_operations(params = {})
1061
+ # @param [Hash] params ({})
1062
+ def list_hours_of_operations(params = {}, options = {})
1063
+ req = build_request(:list_hours_of_operations, params)
1064
+ req.send_request(options)
1065
+ end
1066
+
1067
+ # Provides information about the phone numbers for the specified Amazon
1068
+ # Connect instance.
1069
+ #
1070
+ # @option params [required, String] :instance_id
1071
+ # The identifier of the Amazon Connect instance.
1072
+ #
1073
+ # @option params [Array<String>] :phone_number_types
1074
+ # The type of phone number.
1075
+ #
1076
+ # @option params [Array<String>] :phone_number_country_codes
1077
+ # The ISO country code.
1078
+ #
1079
+ # @option params [String] :next_token
1080
+ # The token for the next set of results. Use the value returned in the
1081
+ # previous response in the next request to retrieve the next set of
1082
+ # results.
1083
+ #
1084
+ # @option params [Integer] :max_results
1085
+ # The maximimum number of results to return per page.
1086
+ #
1087
+ # @return [Types::ListPhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1088
+ #
1089
+ # * {Types::ListPhoneNumbersResponse#phone_number_summary_list #phone_number_summary_list} => Array&lt;Types::PhoneNumberSummary&gt;
1090
+ # * {Types::ListPhoneNumbersResponse#next_token #next_token} => String
1091
+ #
1092
+ # @example Request syntax with placeholder values
1093
+ #
1094
+ # resp = client.list_phone_numbers({
1095
+ # instance_id: "InstanceId", # required
1096
+ # phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID
1097
+ # phone_number_country_codes: ["AF"], # accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
1098
+ # next_token: "NextToken",
1099
+ # max_results: 1,
1100
+ # })
1101
+ #
1102
+ # @example Response structure
1103
+ #
1104
+ # resp.phone_number_summary_list #=> Array
1105
+ # resp.phone_number_summary_list[0].id #=> String
1106
+ # resp.phone_number_summary_list[0].arn #=> String
1107
+ # resp.phone_number_summary_list[0].phone_number #=> String
1108
+ # resp.phone_number_summary_list[0].phone_number_type #=> String, one of "TOLL_FREE", "DID"
1109
+ # resp.phone_number_summary_list[0].phone_number_country_code #=> String, one of "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "TL", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "KP", "MP", "NO", "OM", "PK", "PW", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "CG", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "KR", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW"
1110
+ # resp.next_token #=> String
1111
+ #
1112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbers AWS API Documentation
1113
+ #
1114
+ # @overload list_phone_numbers(params = {})
1115
+ # @param [Hash] params ({})
1116
+ def list_phone_numbers(params = {}, options = {})
1117
+ req = build_request(:list_phone_numbers, params)
1118
+ req.send_request(options)
1119
+ end
1120
+
1121
+ # Provides information about the queues for the specified Amazon Connect
1122
+ # instance.
1123
+ #
1124
+ # @option params [required, String] :instance_id
1125
+ # The identifier of the Amazon Connect instance.
1126
+ #
1127
+ # @option params [Array<String>] :queue_types
1128
+ # The type of queue.
1129
+ #
1130
+ # @option params [String] :next_token
1131
+ # The token for the next set of results. Use the value returned in the
1132
+ # previous response in the next request to retrieve the next set of
1133
+ # results.
1134
+ #
1135
+ # @option params [Integer] :max_results
1136
+ # The maximimum number of results to return per page.
1137
+ #
1138
+ # @return [Types::ListQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1139
+ #
1140
+ # * {Types::ListQueuesResponse#queue_summary_list #queue_summary_list} => Array&lt;Types::QueueSummary&gt;
1141
+ # * {Types::ListQueuesResponse#next_token #next_token} => String
1142
+ #
1143
+ # @example Request syntax with placeholder values
1144
+ #
1145
+ # resp = client.list_queues({
1146
+ # instance_id: "InstanceId", # required
1147
+ # queue_types: ["STANDARD"], # accepts STANDARD, AGENT
1148
+ # next_token: "NextToken",
1149
+ # max_results: 1,
1150
+ # })
1151
+ #
1152
+ # @example Response structure
1153
+ #
1154
+ # resp.queue_summary_list #=> Array
1155
+ # resp.queue_summary_list[0].id #=> String
1156
+ # resp.queue_summary_list[0].arn #=> String
1157
+ # resp.queue_summary_list[0].name #=> String
1158
+ # resp.queue_summary_list[0].queue_type #=> String, one of "STANDARD", "AGENT"
1159
+ # resp.next_token #=> String
1160
+ #
1161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueues AWS API Documentation
1162
+ #
1163
+ # @overload list_queues(params = {})
1164
+ # @param [Hash] params ({})
1165
+ def list_queues(params = {}, options = {})
1166
+ req = build_request(:list_queues, params)
1167
+ req.send_request(options)
1168
+ end
1169
+
1170
+ # Provides summary information about the routing profiles for the
1171
+ # specified Amazon Connect instance.
1172
+ #
1173
+ # @option params [required, String] :instance_id
1174
+ # The identifier of the Amazon Connect instance.
1175
+ #
1176
+ # @option params [String] :next_token
1177
+ # The token for the next set of results. Use the value returned in the
1178
+ # previous response in the next request to retrieve the next set of
1179
+ # results.
1180
+ #
1181
+ # @option params [Integer] :max_results
1182
+ # The maximimum number of results to return per page.
1087
1183
  #
1088
1184
  # @return [Types::ListRoutingProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1089
1185
  #
@@ -1115,18 +1211,11 @@ module Aws::Connect
1115
1211
  req.send_request(options)
1116
1212
  end
1117
1213
 
1118
- # Returns an array of SecurityProfileSummary objects that contain
1119
- # information about the security profiles in your instance, including
1120
- # the ARN, Id, and Name of the security profile.
1214
+ # Provides summary information about the security profiles for the
1215
+ # specified Amazon Connect instance.
1121
1216
  #
1122
1217
  # @option params [required, String] :instance_id
1123
- # The identifier for your Amazon Connect instance. To find the ID of
1124
- # your instance, open the AWS console and select Amazon Connect. Select
1125
- # the alias of the instance in the Instance alias column. The instance
1126
- # ID is displayed in the Overview section of your instance settings. For
1127
- # example, the instance ID is the set of characters at the end of the
1128
- # instance ARN, after instance/, such as
1129
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1218
+ # The identifier of the Amazon Connect instance.
1130
1219
  #
1131
1220
  # @option params [String] :next_token
1132
1221
  # The token for the next set of results. Use the value returned in the
@@ -1134,7 +1223,7 @@ module Aws::Connect
1134
1223
  # results.
1135
1224
  #
1136
1225
  # @option params [Integer] :max_results
1137
- # The maximum number of security profiles to return.
1226
+ # The maximimum number of results to return per page.
1138
1227
  #
1139
1228
  # @return [Types::ListSecurityProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1140
1229
  #
@@ -1166,18 +1255,11 @@ module Aws::Connect
1166
1255
  req.send_request(options)
1167
1256
  end
1168
1257
 
1169
- # Returns a `UserHierarchyGroupSummaryList`, which is an array of
1170
- # `HierarchyGroupSummary` objects that contain information about the
1171
- # hierarchy groups in your instance.
1258
+ # Provides summary information about the hierarchy groups for the
1259
+ # specified Amazon Connect instance.
1172
1260
  #
1173
1261
  # @option params [required, String] :instance_id
1174
- # The identifier for your Amazon Connect instance. To find the ID of
1175
- # your instance, open the AWS console and select Amazon Connect. Select
1176
- # the alias of the instance in the Instance alias column. The instance
1177
- # ID is displayed in the Overview section of your instance settings. For
1178
- # example, the instance ID is the set of characters at the end of the
1179
- # instance ARN, after instance/, such as
1180
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1262
+ # The identifier of the Amazon Connect instance.
1181
1263
  #
1182
1264
  # @option params [String] :next_token
1183
1265
  # The token for the next set of results. Use the value returned in the
@@ -1185,7 +1267,7 @@ module Aws::Connect
1185
1267
  # results.
1186
1268
  #
1187
1269
  # @option params [Integer] :max_results
1188
- # The maximum number of hierarchy groups to return.
1270
+ # The maximimum number of results to return per page.
1189
1271
  #
1190
1272
  # @return [Types::ListUserHierarchyGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1191
1273
  #
@@ -1217,17 +1299,11 @@ module Aws::Connect
1217
1299
  req.send_request(options)
1218
1300
  end
1219
1301
 
1220
- # Returns a `UserSummaryList`, which is an array of `UserSummary`
1221
- # objects.
1302
+ # Provides summary information about the users for the specified Amazon
1303
+ # Connect instance.
1222
1304
  #
1223
1305
  # @option params [required, String] :instance_id
1224
- # The identifier for your Amazon Connect instance. To find the ID of
1225
- # your instance, open the AWS console and select Amazon Connect. Select
1226
- # the alias of the instance in the Instance alias column. The instance
1227
- # ID is displayed in the Overview section of your instance settings. For
1228
- # example, the instance ID is the set of characters at the end of the
1229
- # instance ARN, after instance/, such as
1230
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1306
+ # The identifier of the Amazon Connect instance.
1231
1307
  #
1232
1308
  # @option params [String] :next_token
1233
1309
  # The token for the next set of results. Use the value returned in the
@@ -1235,7 +1311,7 @@ module Aws::Connect
1235
1311
  # results.
1236
1312
  #
1237
1313
  # @option params [Integer] :max_results
1238
- # The maximum number of results to return in the response.
1314
+ # The maximimum number of results to return per page.
1239
1315
  #
1240
1316
  # @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1241
1317
  #
@@ -1267,35 +1343,19 @@ module Aws::Connect
1267
1343
  req.send_request(options)
1268
1344
  end
1269
1345
 
1270
- # The `StartOutboundVoiceContact` operation initiates a contact flow to
1271
- # place an outbound call to a customer.
1272
- #
1273
- # If you are using an IAM account, it must have permission to the
1274
- # `connect:StartOutboundVoiceContact` action.
1346
+ # Initiates a contact flow to place an outbound call to a customer.
1275
1347
  #
1276
1348
  # There is a 60 second dialing timeout for this operation. If the call
1277
- # is not connected after 60 seconds, the call fails.
1349
+ # is not connected after 60 seconds, it fails.
1278
1350
  #
1279
1351
  # @option params [required, String] :destination_phone_number
1280
- # The phone number of the customer in E.164 format.
1352
+ # The phone number of the customer, in E.164 format.
1281
1353
  #
1282
1354
  # @option params [required, String] :contact_flow_id
1283
- # The identifier for the contact flow to connect the outbound call to.
1284
- #
1285
- # To find the `ContactFlowId`, open the contact flow you want to use in
1286
- # the Amazon Connect contact flow editor. The ID for the contact flow is
1287
- # displayed in the address bar as part of the URL. For example, the
1288
- # contact flow ID is the set of characters at the end of the URL, after
1289
- # 'contact-flow/' such as `78ea8fd5-2659-4f2b-b528-699760ccfc1b`.
1355
+ # The identifier of the contact flow for the outbound call.
1290
1356
  #
1291
1357
  # @option params [required, String] :instance_id
1292
- # The identifier for your Amazon Connect instance. To find the ID of
1293
- # your instance, open the AWS console and select Amazon Connect. Select
1294
- # the alias of the instance in the Instance alias column. The instance
1295
- # ID is displayed in the Overview section of your instance settings. For
1296
- # example, the instance ID is the set of characters at the end of the
1297
- # instance ARN, after instance/, such as
1298
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1358
+ # The identifier of the Amazon Connect instance.
1299
1359
  #
1300
1360
  # @option params [String] :client_token
1301
1361
  # A unique, case-sensitive identifier that you provide to ensure the
@@ -1307,34 +1367,25 @@ module Aws::Connect
1307
1367
  # not need to pass this option.**
1308
1368
  #
1309
1369
  # @option params [String] :source_phone_number
1310
- # The phone number, in E.164 format, associated with your Amazon Connect
1311
- # instance to use for the outbound call.
1370
+ # The phone number associated with the Amazon Connect instance, in E.164
1371
+ # format. If you do not specify a source phone number, you must specify
1372
+ # a queue.
1312
1373
  #
1313
1374
  # @option params [String] :queue_id
1314
- # The queue to add the call to. If you specify a queue, the phone
1315
- # displayed for caller ID is the phone number specified in the queue. If
1316
- # you do not specify a queue, the queue used will be the queue defined
1317
- # in the contact flow.
1318
- #
1319
- # To find the `QueueId`, open the queue you want to use in the Amazon
1320
- # Connect Queue editor. The ID for the queue is displayed in the address
1321
- # bar as part of the URL. For example, the queue ID is the set of
1322
- # characters at the end of the URL, after 'queue/' such as
1323
- # `queue/aeg40574-2d01-51c3-73d6-bf8624d2168c`.
1375
+ # The queue for the call. If you specify a queue, the phone displayed
1376
+ # for caller ID is the phone number specified in the queue. If you do
1377
+ # not specify a queue, the queue defined in the contact flow is used. If
1378
+ # you do not specify a queue, you must specify a source phone number.
1324
1379
  #
1325
1380
  # @option params [Hash<String,String>] :attributes
1326
- # Specify a custom key-value pair using an attribute map. The attributes
1327
- # are standard Amazon Connect attributes, and can be accessed in contact
1381
+ # A custom key-value pair using an attribute map. The attributes are
1382
+ # standard Amazon Connect attributes, and can be accessed in contact
1328
1383
  # flows just like any other contact attributes.
1329
1384
  #
1330
1385
  # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
1331
1386
  # contact. Attribute keys can include only alphanumeric, dash, and
1332
1387
  # underscore characters.
1333
1388
  #
1334
- # For example, if you want play a greeting when the customer answers the
1335
- # call, you can pass the customer name in attributes similar to the
1336
- # following:
1337
- #
1338
1389
  # @return [Types::StartOutboundVoiceContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1339
1390
  #
1340
1391
  # * {Types::StartOutboundVoiceContactResponse#contact_id #contact_id} => String
@@ -1366,23 +1417,13 @@ module Aws::Connect
1366
1417
  req.send_request(options)
1367
1418
  end
1368
1419
 
1369
- # Ends the contact initiated by the `StartOutboundVoiceContact`
1370
- # operation.
1371
- #
1372
- # If you are using an IAM account, it must have permission to the
1373
- # `connect:StopContact` action.
1420
+ # Ends the specified contact.
1374
1421
  #
1375
1422
  # @option params [required, String] :contact_id
1376
- # The unique identifier of the contact to end.
1423
+ # The ID of the contact.
1377
1424
  #
1378
1425
  # @option params [required, String] :instance_id
1379
- # The identifier for your Amazon Connect instance. To find the ID of
1380
- # your instance, open the AWS console and select Amazon Connect. Select
1381
- # the alias of the instance in the Instance alias column. The instance
1382
- # ID is displayed in the Overview section of your instance settings. For
1383
- # example, the instance ID is the set of characters at the end of the
1384
- # instance ARN, after instance/, such as
1385
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1426
+ # The identifier of the Amazon Connect instance.
1386
1427
  #
1387
1428
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1388
1429
  #
@@ -1402,15 +1443,15 @@ module Aws::Connect
1402
1443
  req.send_request(options)
1403
1444
  end
1404
1445
 
1405
- # The `UpdateContactAttributes` operation lets you programmatically
1406
- # create new, or update existing, contact attributes associated with a
1407
- # contact. You can use the operation to add or update attributes for
1408
- # both ongoing and completed contacts. For example, you can update the
1409
- # customer's name or the reason the customer called while the call is
1410
- # active, or add notes about steps that the agent took during the call
1411
- # that are displayed to the next agent that takes the call. You can also
1412
- # use the `UpdateContactAttributes` operation to update attributes for a
1413
- # contact using data from your CRM application and save the data with
1446
+ # Creates or updates the contact attributes associated with the
1447
+ # specified contact.
1448
+ #
1449
+ # You can add or update attributes for both ongoing and completed
1450
+ # contacts. For example, you can update the customer's name or the
1451
+ # reason the customer called while the call is active, or add notes
1452
+ # about steps that the agent took during the call that are displayed to
1453
+ # the next agent that takes the call. You can also update attributes for
1454
+ # a contact using data from your CRM application and save the data with
1414
1455
  # the contact in Amazon Connect. You could also flag calls for
1415
1456
  # additional analysis, such as legal review or identifying abusive
1416
1457
  # callers.
@@ -1418,36 +1459,26 @@ module Aws::Connect
1418
1459
  # Contact attributes are available in Amazon Connect for 24 months, and
1419
1460
  # are then deleted.
1420
1461
  #
1421
- # *Important:*
1422
- #
1423
- # You cannot use the operation to update attributes for contacts that
1424
- # occurred prior to the release of the API, September 12, 2018. You can
1425
- # update attributes only for contacts that started after the release of
1426
- # the API. If you attempt to update attributes for a contact that
1427
- # occurred prior to the release of the API, a 400 error is returned.
1428
- # This applies also to queued callbacks that were initiated prior to the
1429
- # release of the API but are still active in your instance.
1462
+ # **Important:** You cannot use the operation to update attributes for
1463
+ # contacts that occurred prior to the release of the API, September 12,
1464
+ # 2018. You can update attributes only for contacts that started after
1465
+ # the release of the API. If you attempt to update attributes for a
1466
+ # contact that occurred prior to the release of the API, a 400 error is
1467
+ # returned. This applies also to queued callbacks that were initiated
1468
+ # prior to the release of the API but are still active in your instance.
1430
1469
  #
1431
1470
  # @option params [required, String] :initial_contact_id
1432
- # The unique identifier of the contact for which to update attributes.
1433
- # This is the identifier for the contact associated with the first
1434
- # interaction with the contact center.
1471
+ # The identifier of the contact. This is the identifier of the contact
1472
+ # associated with the first interaction with the contact center.
1435
1473
  #
1436
1474
  # @option params [required, String] :instance_id
1437
- # The identifier for your Amazon Connect instance. To find the ID of
1438
- # your instance, open the AWS console and select Amazon Connect. Select
1439
- # the alias of the instance in the Instance alias column. The instance
1440
- # ID is displayed in the Overview section of your instance settings. For
1441
- # example, the instance ID is the set of characters at the end of the
1442
- # instance ARN, after instance/, such as
1443
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1475
+ # The identifier of the Amazon Connect instance.
1444
1476
  #
1445
1477
  # @option params [required, Hash<String,String>] :attributes
1446
- # Specify a custom key-value pair using an attribute map. The attributes
1447
- # are standard Amazon Connect attributes, and can be accessed in contact
1448
- # flows just like any other contact attributes.
1478
+ # The Amazon Connect attributes. These attributes can be accessed in
1479
+ # contact flows just like any other contact attributes.
1449
1480
  #
1450
- # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
1481
+ # You can have up to 32,768 UTF-8 bytes across all attributes for a
1451
1482
  # contact. Attribute keys can include only alphanumeric, dash, and
1452
1483
  # underscore characters.
1453
1484
  #
@@ -1472,22 +1503,16 @@ module Aws::Connect
1472
1503
  req.send_request(options)
1473
1504
  end
1474
1505
 
1475
- # Assigns the specified hierarchy group to the user.
1506
+ # Assigns the specified hierarchy group to the specified user.
1476
1507
  #
1477
1508
  # @option params [String] :hierarchy_group_id
1478
- # The identifier for the hierarchy group to assign to the user.
1509
+ # The identifier of the hierarchy group.
1479
1510
  #
1480
1511
  # @option params [required, String] :user_id
1481
- # The identifier of the user account to assign the hierarchy group to.
1512
+ # The identifier of the user account.
1482
1513
  #
1483
1514
  # @option params [required, String] :instance_id
1484
- # The identifier for your Amazon Connect instance. To find the ID of
1485
- # your instance, open the AWS console and select Amazon Connect. Select
1486
- # the alias of the instance in the Instance alias column. The instance
1487
- # ID is displayed in the Overview section of your instance settings. For
1488
- # example, the instance ID is the set of characters at the end of the
1489
- # instance ARN, after instance/, such as
1490
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1515
+ # The identifier of the Amazon Connect instance.
1491
1516
  #
1492
1517
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1493
1518
  #
@@ -1508,24 +1533,16 @@ module Aws::Connect
1508
1533
  req.send_request(options)
1509
1534
  end
1510
1535
 
1511
- # Updates the identity information for the specified user in a
1512
- # `UserIdentityInfo` object, including email, first name, and last name.
1536
+ # Updates the identity information for the specified user.
1513
1537
  #
1514
1538
  # @option params [required, Types::UserIdentityInfo] :identity_info
1515
- # A `UserIdentityInfo` object.
1539
+ # The identity information for the user.
1516
1540
  #
1517
1541
  # @option params [required, String] :user_id
1518
- # The identifier for the user account to update identity information
1519
- # for.
1542
+ # The identifier of the user account.
1520
1543
  #
1521
1544
  # @option params [required, String] :instance_id
1522
- # The identifier for your Amazon Connect instance. To find the ID of
1523
- # your instance, open the AWS console and select Amazon Connect. Select
1524
- # the alias of the instance in the Instance alias column. The instance
1525
- # ID is displayed in the Overview section of your instance settings. For
1526
- # example, the instance ID is the set of characters at the end of the
1527
- # instance ARN, after instance/, such as
1528
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1545
+ # The identifier of the Amazon Connect instance.
1529
1546
  #
1530
1547
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1531
1548
  #
@@ -1550,25 +1567,16 @@ module Aws::Connect
1550
1567
  req.send_request(options)
1551
1568
  end
1552
1569
 
1553
- # Updates the phone configuration settings in the `UserPhoneConfig`
1554
- # object for the specified user.
1570
+ # Updates the phone configuration settings for the specified user.
1555
1571
  #
1556
1572
  # @option params [required, Types::UserPhoneConfig] :phone_config
1557
- # A `UserPhoneConfig` object that contains settings for
1558
- # `AfterContactWorkTimeLimit`, `AutoAccept`, `DeskPhoneNumber`, and
1559
- # `PhoneType` to assign to the user.
1573
+ # Information about phone configuration settings for the user.
1560
1574
  #
1561
1575
  # @option params [required, String] :user_id
1562
- # The identifier for the user account to change phone settings for.
1576
+ # The identifier of the user account.
1563
1577
  #
1564
1578
  # @option params [required, String] :instance_id
1565
- # The identifier for your Amazon Connect instance. To find the ID of
1566
- # your instance, open the AWS console and select Amazon Connect. Select
1567
- # the alias of the instance in the Instance alias column. The instance
1568
- # ID is displayed in the Overview section of your instance settings. For
1569
- # example, the instance ID is the set of characters at the end of the
1570
- # instance ARN, after instance/, such as
1571
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1579
+ # The identifier of the Amazon Connect instance.
1572
1580
  #
1573
1581
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1574
1582
  #
@@ -1594,22 +1602,16 @@ module Aws::Connect
1594
1602
  req.send_request(options)
1595
1603
  end
1596
1604
 
1597
- # Assigns the specified routing profile to a user.
1605
+ # Assigns the specified routing profile to the specified user.
1598
1606
  #
1599
1607
  # @option params [required, String] :routing_profile_id
1600
- # The identifier of the routing profile to assign to the user.
1608
+ # The identifier of the routing profile for the user.
1601
1609
  #
1602
1610
  # @option params [required, String] :user_id
1603
- # The identifier for the user account to assign the routing profile to.
1611
+ # The identifier of the user account.
1604
1612
  #
1605
1613
  # @option params [required, String] :instance_id
1606
- # The identifier for your Amazon Connect instance. To find the ID of
1607
- # your instance, open the AWS console and select Amazon Connect. Select
1608
- # the alias of the instance in the Instance alias column. The instance
1609
- # ID is displayed in the Overview section of your instance settings. For
1610
- # example, the instance ID is the set of characters at the end of the
1611
- # instance ARN, after instance/, such as
1612
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1614
+ # The identifier of the Amazon Connect instance.
1613
1615
  #
1614
1616
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1615
1617
  #
@@ -1630,22 +1632,16 @@ module Aws::Connect
1630
1632
  req.send_request(options)
1631
1633
  end
1632
1634
 
1633
- # Updates the security profiles assigned to the user.
1635
+ # Assigns the specified security profiles to the specified user.
1634
1636
  #
1635
1637
  # @option params [required, Array<String>] :security_profile_ids
1636
- # The identifiers for the security profiles to assign to the user.
1638
+ # The identifiers of the security profiles for the user.
1637
1639
  #
1638
1640
  # @option params [required, String] :user_id
1639
- # The identifier of the user account to assign the security profiles.
1641
+ # The identifier of the user account.
1640
1642
  #
1641
1643
  # @option params [required, String] :instance_id
1642
- # The identifier for your Amazon Connect instance. To find the ID of
1643
- # your instance, open the AWS console and select Amazon Connect. Select
1644
- # the alias of the instance in the Instance alias column. The instance
1645
- # ID is displayed in the Overview section of your instance settings. For
1646
- # example, the instance ID is the set of characters at the end of the
1647
- # instance ARN, after instance/, such as
1648
- # 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
1644
+ # The identifier of the Amazon Connect instance.
1649
1645
  #
1650
1646
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1651
1647
  #
@@ -1679,7 +1675,7 @@ module Aws::Connect
1679
1675
  params: params,
1680
1676
  config: config)
1681
1677
  context[:gem_name] = 'aws-sdk-connect'
1682
- context[:gem_version] = '1.19.0'
1678
+ context[:gem_version] = '1.20.0'
1683
1679
  Seahorse::Client::Request.new(handlers, context)
1684
1680
  end
1685
1681