aws-sdk-connect 1.31.0 → 1.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-connect.rb +2 -2
- data/lib/aws-sdk-connect/client.rb +787 -16
- data/lib/aws-sdk-connect/client_api.rb +414 -0
- data/lib/aws-sdk-connect/errors.rb +32 -0
- data/lib/aws-sdk-connect/types.rb +1095 -73
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e062dfbd3106a56eda16ffa2ec9780e9153e126aa9bb8174ab7e8193afc41ed2
|
4
|
+
data.tar.gz: d58f148d07215bd5776cb987e0240a5b1ff24647ea2c2378411364c991141ce5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 164a7a83ce3fa576638cb5a93cd02bcfe3236d5e07b8d4b2e0bdb6a66e719d9b676d1da9a4561bbb49a44b8d3f6fbe6f133d68932ab74265f6b53b28396436f8
|
7
|
+
data.tar.gz: 2ee4e3e77a428792fc415dc61d4d8991d2635beb6a6a1df4a5074b5a1673759b814624247178bb7713a0aeb42cf2d480a0022d94d24a9fe5bbddd722fb60dab5
|
data/lib/aws-sdk-connect.rb
CHANGED
@@ -28,7 +28,7 @@ require_relative 'aws-sdk-connect/customizations'
|
|
28
28
|
# structure.
|
29
29
|
#
|
30
30
|
# connect = Aws::Connect::Client.new
|
31
|
-
# resp = connect.
|
31
|
+
# resp = connect.associate_routing_profile_queues(params)
|
32
32
|
#
|
33
33
|
# See {Client} for more information.
|
34
34
|
#
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-connect/customizations'
|
|
48
48
|
# @!group service
|
49
49
|
module Aws::Connect
|
50
50
|
|
51
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.32.0'
|
52
52
|
|
53
53
|
end
|
@@ -327,8 +327,186 @@ module Aws::Connect
|
|
327
327
|
|
328
328
|
# @!group API Operations
|
329
329
|
|
330
|
+
# Associates a set of queues with a routing profile.
|
331
|
+
#
|
332
|
+
# @option params [required, String] :instance_id
|
333
|
+
# The identifier of the Amazon Connect instance.
|
334
|
+
#
|
335
|
+
# @option params [required, String] :routing_profile_id
|
336
|
+
# The identifier of the routing profile.
|
337
|
+
#
|
338
|
+
# @option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
339
|
+
# The queues to associate with this routing profile.
|
340
|
+
#
|
341
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
342
|
+
#
|
343
|
+
# @example Request syntax with placeholder values
|
344
|
+
#
|
345
|
+
# resp = client.associate_routing_profile_queues({
|
346
|
+
# instance_id: "InstanceId", # required
|
347
|
+
# routing_profile_id: "RoutingProfileId", # required
|
348
|
+
# queue_configs: [ # required
|
349
|
+
# {
|
350
|
+
# queue_reference: { # required
|
351
|
+
# queue_id: "QueueId", # required
|
352
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
353
|
+
# },
|
354
|
+
# priority: 1, # required
|
355
|
+
# delay: 1, # required
|
356
|
+
# },
|
357
|
+
# ],
|
358
|
+
# })
|
359
|
+
#
|
360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateRoutingProfileQueues AWS API Documentation
|
361
|
+
#
|
362
|
+
# @overload associate_routing_profile_queues(params = {})
|
363
|
+
# @param [Hash] params ({})
|
364
|
+
def associate_routing_profile_queues(params = {}, options = {})
|
365
|
+
req = build_request(:associate_routing_profile_queues, params)
|
366
|
+
req.send_request(options)
|
367
|
+
end
|
368
|
+
|
369
|
+
# Creates a contact flow for the specified Amazon Connect instance.
|
370
|
+
#
|
371
|
+
# @option params [required, String] :instance_id
|
372
|
+
# The identifier of the Amazon Connect instance.
|
373
|
+
#
|
374
|
+
# @option params [required, String] :name
|
375
|
+
# The name of the contact flow.
|
376
|
+
#
|
377
|
+
# @option params [required, String] :type
|
378
|
+
# The type of the contact flow. For descriptions of the available types,
|
379
|
+
# see [Choose a Contact Flow Type][1] in the *Amazon Connect
|
380
|
+
# Administrator Guide*.
|
381
|
+
#
|
382
|
+
#
|
383
|
+
#
|
384
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
|
385
|
+
#
|
386
|
+
# @option params [String] :description
|
387
|
+
# The description of the contact flow.
|
388
|
+
#
|
389
|
+
# @option params [required, String] :content
|
390
|
+
# The content of the contact flow.
|
391
|
+
#
|
392
|
+
# @option params [Hash<String,String>] :tags
|
393
|
+
# One or more tags.
|
394
|
+
#
|
395
|
+
# @return [Types::CreateContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
396
|
+
#
|
397
|
+
# * {Types::CreateContactFlowResponse#contact_flow_id #contact_flow_id} => String
|
398
|
+
# * {Types::CreateContactFlowResponse#contact_flow_arn #contact_flow_arn} => String
|
399
|
+
#
|
400
|
+
# @example Request syntax with placeholder values
|
401
|
+
#
|
402
|
+
# resp = client.create_contact_flow({
|
403
|
+
# instance_id: "InstanceId", # required
|
404
|
+
# name: "ContactFlowName", # required
|
405
|
+
# type: "CONTACT_FLOW", # required, accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
406
|
+
# description: "ContactFlowDescription",
|
407
|
+
# content: "ContactFlowContent", # required
|
408
|
+
# tags: {
|
409
|
+
# "TagKey" => "TagValue",
|
410
|
+
# },
|
411
|
+
# })
|
412
|
+
#
|
413
|
+
# @example Response structure
|
414
|
+
#
|
415
|
+
# resp.contact_flow_id #=> String
|
416
|
+
# resp.contact_flow_arn #=> String
|
417
|
+
#
|
418
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlow AWS API Documentation
|
419
|
+
#
|
420
|
+
# @overload create_contact_flow(params = {})
|
421
|
+
# @param [Hash] params ({})
|
422
|
+
def create_contact_flow(params = {}, options = {})
|
423
|
+
req = build_request(:create_contact_flow, params)
|
424
|
+
req.send_request(options)
|
425
|
+
end
|
426
|
+
|
427
|
+
# Creates a new routing profile.
|
428
|
+
#
|
429
|
+
# @option params [required, String] :instance_id
|
430
|
+
# The identifier of the Amazon Connect instance.
|
431
|
+
#
|
432
|
+
# @option params [required, String] :name
|
433
|
+
# The name of the routing profile. Must not be more than 127 characters.
|
434
|
+
#
|
435
|
+
# @option params [required, String] :description
|
436
|
+
# Description of the routing profile. Must not be more than 250
|
437
|
+
# characters.
|
438
|
+
#
|
439
|
+
# @option params [required, String] :default_outbound_queue_id
|
440
|
+
# The default outbound queue for the routing profile.
|
441
|
+
#
|
442
|
+
# @option params [Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
443
|
+
# The inbound queues associated with the routing profile. If no queue is
|
444
|
+
# added, the agent can only make outbound calls.
|
445
|
+
#
|
446
|
+
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
447
|
+
# The channels agents can handle in the Contact Control Panel (CCP) for
|
448
|
+
# this routing profile.
|
449
|
+
#
|
450
|
+
# @option params [Hash<String,String>] :tags
|
451
|
+
# One or more tags.
|
452
|
+
#
|
453
|
+
# @return [Types::CreateRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
454
|
+
#
|
455
|
+
# * {Types::CreateRoutingProfileResponse#routing_profile_arn #routing_profile_arn} => String
|
456
|
+
# * {Types::CreateRoutingProfileResponse#routing_profile_id #routing_profile_id} => String
|
457
|
+
#
|
458
|
+
# @example Request syntax with placeholder values
|
459
|
+
#
|
460
|
+
# resp = client.create_routing_profile({
|
461
|
+
# instance_id: "InstanceId", # required
|
462
|
+
# name: "RoutingProfileName", # required
|
463
|
+
# description: "RoutingProfileDescription", # required
|
464
|
+
# default_outbound_queue_id: "QueueId", # required
|
465
|
+
# queue_configs: [
|
466
|
+
# {
|
467
|
+
# queue_reference: { # required
|
468
|
+
# queue_id: "QueueId", # required
|
469
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
470
|
+
# },
|
471
|
+
# priority: 1, # required
|
472
|
+
# delay: 1, # required
|
473
|
+
# },
|
474
|
+
# ],
|
475
|
+
# media_concurrencies: [ # required
|
476
|
+
# {
|
477
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
478
|
+
# concurrency: 1, # required
|
479
|
+
# },
|
480
|
+
# ],
|
481
|
+
# tags: {
|
482
|
+
# "TagKey" => "TagValue",
|
483
|
+
# },
|
484
|
+
# })
|
485
|
+
#
|
486
|
+
# @example Response structure
|
487
|
+
#
|
488
|
+
# resp.routing_profile_arn #=> String
|
489
|
+
# resp.routing_profile_id #=> String
|
490
|
+
#
|
491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRoutingProfile AWS API Documentation
|
492
|
+
#
|
493
|
+
# @overload create_routing_profile(params = {})
|
494
|
+
# @param [Hash] params ({})
|
495
|
+
def create_routing_profile(params = {}, options = {})
|
496
|
+
req = build_request(:create_routing_profile, params)
|
497
|
+
req.send_request(options)
|
498
|
+
end
|
499
|
+
|
330
500
|
# Creates a user account for the specified Amazon Connect instance.
|
331
501
|
#
|
502
|
+
# For information about how to create user accounts using the Amazon
|
503
|
+
# Connect console, see [Add Users][1] in the *Amazon Connect
|
504
|
+
# Administrator Guide*.
|
505
|
+
#
|
506
|
+
#
|
507
|
+
#
|
508
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html
|
509
|
+
#
|
332
510
|
# @option params [required, String] :username
|
333
511
|
# The user name for the account. For instances not using SAML for
|
334
512
|
# identity management, the user name can include up to 20 characters. If
|
@@ -421,6 +599,14 @@ module Aws::Connect
|
|
421
599
|
|
422
600
|
# Deletes a user account from the specified Amazon Connect instance.
|
423
601
|
#
|
602
|
+
# For information about what happens to a user's data when their
|
603
|
+
# account is deleted, see [Delete Users from Your Amazon Connect
|
604
|
+
# Instance][1] in the *Amazon Connect Administrator Guide*.
|
605
|
+
#
|
606
|
+
#
|
607
|
+
#
|
608
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html
|
609
|
+
#
|
424
610
|
# @option params [required, String] :instance_id
|
425
611
|
# The identifier of the Amazon Connect instance.
|
426
612
|
#
|
@@ -445,6 +631,87 @@ module Aws::Connect
|
|
445
631
|
req.send_request(options)
|
446
632
|
end
|
447
633
|
|
634
|
+
# Describes the specified contact flow.
|
635
|
+
#
|
636
|
+
# @option params [required, String] :instance_id
|
637
|
+
# The identifier of the Amazon Connect instance.
|
638
|
+
#
|
639
|
+
# @option params [required, String] :contact_flow_id
|
640
|
+
# The identifier of the contact flow.
|
641
|
+
#
|
642
|
+
# @return [Types::DescribeContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
643
|
+
#
|
644
|
+
# * {Types::DescribeContactFlowResponse#contact_flow #contact_flow} => Types::ContactFlow
|
645
|
+
#
|
646
|
+
# @example Request syntax with placeholder values
|
647
|
+
#
|
648
|
+
# resp = client.describe_contact_flow({
|
649
|
+
# instance_id: "InstanceId", # required
|
650
|
+
# contact_flow_id: "ContactFlowId", # required
|
651
|
+
# })
|
652
|
+
#
|
653
|
+
# @example Response structure
|
654
|
+
#
|
655
|
+
# resp.contact_flow.arn #=> String
|
656
|
+
# resp.contact_flow.id #=> String
|
657
|
+
# resp.contact_flow.name #=> String
|
658
|
+
# resp.contact_flow.type #=> String, one of "CONTACT_FLOW", "CUSTOMER_QUEUE", "CUSTOMER_HOLD", "CUSTOMER_WHISPER", "AGENT_HOLD", "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", "QUEUE_TRANSFER"
|
659
|
+
# resp.contact_flow.description #=> String
|
660
|
+
# resp.contact_flow.content #=> String
|
661
|
+
# resp.contact_flow.tags #=> Hash
|
662
|
+
# resp.contact_flow.tags["TagKey"] #=> String
|
663
|
+
#
|
664
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlow AWS API Documentation
|
665
|
+
#
|
666
|
+
# @overload describe_contact_flow(params = {})
|
667
|
+
# @param [Hash] params ({})
|
668
|
+
def describe_contact_flow(params = {}, options = {})
|
669
|
+
req = build_request(:describe_contact_flow, params)
|
670
|
+
req.send_request(options)
|
671
|
+
end
|
672
|
+
|
673
|
+
# Describes the specified routing profile.
|
674
|
+
#
|
675
|
+
# @option params [required, String] :instance_id
|
676
|
+
# The identifier of the Amazon Connect instance.
|
677
|
+
#
|
678
|
+
# @option params [required, String] :routing_profile_id
|
679
|
+
# The identifier of the routing profile.
|
680
|
+
#
|
681
|
+
# @return [Types::DescribeRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
682
|
+
#
|
683
|
+
# * {Types::DescribeRoutingProfileResponse#routing_profile #routing_profile} => Types::RoutingProfile
|
684
|
+
#
|
685
|
+
# @example Request syntax with placeholder values
|
686
|
+
#
|
687
|
+
# resp = client.describe_routing_profile({
|
688
|
+
# instance_id: "InstanceId", # required
|
689
|
+
# routing_profile_id: "RoutingProfileId", # required
|
690
|
+
# })
|
691
|
+
#
|
692
|
+
# @example Response structure
|
693
|
+
#
|
694
|
+
# resp.routing_profile.instance_id #=> String
|
695
|
+
# resp.routing_profile.name #=> String
|
696
|
+
# resp.routing_profile.routing_profile_arn #=> String
|
697
|
+
# resp.routing_profile.routing_profile_id #=> String
|
698
|
+
# resp.routing_profile.description #=> String
|
699
|
+
# resp.routing_profile.media_concurrencies #=> Array
|
700
|
+
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT"
|
701
|
+
# resp.routing_profile.media_concurrencies[0].concurrency #=> Integer
|
702
|
+
# resp.routing_profile.default_outbound_queue_id #=> String
|
703
|
+
# resp.routing_profile.tags #=> Hash
|
704
|
+
# resp.routing_profile.tags["TagKey"] #=> String
|
705
|
+
#
|
706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfile AWS API Documentation
|
707
|
+
#
|
708
|
+
# @overload describe_routing_profile(params = {})
|
709
|
+
# @param [Hash] params ({})
|
710
|
+
def describe_routing_profile(params = {}, options = {})
|
711
|
+
req = build_request(:describe_routing_profile, params)
|
712
|
+
req.send_request(options)
|
713
|
+
end
|
714
|
+
|
448
715
|
# Describes the specified user account. You can find the instance ID in
|
449
716
|
# the console (it’s the final part of the ARN). The console does not
|
450
717
|
# display the user IDs. Instead, list the users and note the IDs
|
@@ -589,6 +856,41 @@ module Aws::Connect
|
|
589
856
|
req.send_request(options)
|
590
857
|
end
|
591
858
|
|
859
|
+
# Disassociates a set of queues from a routing profile.
|
860
|
+
#
|
861
|
+
# @option params [required, String] :instance_id
|
862
|
+
# The identifier of the Amazon Connect instance.
|
863
|
+
#
|
864
|
+
# @option params [required, String] :routing_profile_id
|
865
|
+
# The identifier of the routing profile.
|
866
|
+
#
|
867
|
+
# @option params [required, Array<Types::RoutingProfileQueueReference>] :queue_references
|
868
|
+
# The queues to disassociate from this routing profile.
|
869
|
+
#
|
870
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
871
|
+
#
|
872
|
+
# @example Request syntax with placeholder values
|
873
|
+
#
|
874
|
+
# resp = client.disassociate_routing_profile_queues({
|
875
|
+
# instance_id: "InstanceId", # required
|
876
|
+
# routing_profile_id: "RoutingProfileId", # required
|
877
|
+
# queue_references: [ # required
|
878
|
+
# {
|
879
|
+
# queue_id: "QueueId", # required
|
880
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
881
|
+
# },
|
882
|
+
# ],
|
883
|
+
# })
|
884
|
+
#
|
885
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateRoutingProfileQueues AWS API Documentation
|
886
|
+
#
|
887
|
+
# @overload disassociate_routing_profile_queues(params = {})
|
888
|
+
# @param [Hash] params ({})
|
889
|
+
def disassociate_routing_profile_queues(params = {}, options = {})
|
890
|
+
req = build_request(:disassociate_routing_profile_queues, params)
|
891
|
+
req.send_request(options)
|
892
|
+
end
|
893
|
+
|
592
894
|
# Retrieves the contact attributes for the specified contact.
|
593
895
|
#
|
594
896
|
# @option params [required, String] :instance_id
|
@@ -625,12 +927,12 @@ module Aws::Connect
|
|
625
927
|
# Gets the real-time metric data from the specified Amazon Connect
|
626
928
|
# instance.
|
627
929
|
#
|
628
|
-
# For
|
629
|
-
# *Amazon Connect Administrator Guide*.
|
930
|
+
# For a description of each metric, see [Real-time Metrics
|
931
|
+
# Definitions][1] in the *Amazon Connect Administrator Guide*.
|
630
932
|
#
|
631
933
|
#
|
632
934
|
#
|
633
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-
|
935
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
634
936
|
#
|
635
937
|
# @option params [required, String] :instance_id
|
636
938
|
# The identifier of the Amazon Connect instance.
|
@@ -639,79 +941,126 @@ module Aws::Connect
|
|
639
941
|
# The queues, up to 100, or channels, to use to filter the metrics
|
640
942
|
# returned. Metric data is retrieved only for the resources associated
|
641
943
|
# with the queues or channels included in the filter. You can include
|
642
|
-
# both queue IDs and queue ARNs in the same request.
|
643
|
-
#
|
944
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
945
|
+
# `CHAT` channels are supported.
|
644
946
|
#
|
645
947
|
# @option params [Array<String>] :groupings
|
646
948
|
# The grouping applied to the metrics returned. For example, when
|
647
949
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
648
950
|
# than aggregated for all queues. If you group by `CHANNEL`, you should
|
649
|
-
# include a Channels filter.
|
951
|
+
# include a Channels filter. Both `VOICE` and `CHAT` channels are
|
952
|
+
# supported.
|
650
953
|
#
|
651
954
|
# If no `Grouping` is included in the request, a summary of metrics is
|
652
955
|
# returned.
|
653
956
|
#
|
654
957
|
# @option params [required, Array<Types::CurrentMetric>] :current_metrics
|
655
958
|
# The metrics to retrieve. Specify the name and unit for each metric.
|
656
|
-
# The following metrics are available. For a description of
|
657
|
-
# see [Real-time Metrics Definitions][1] in the *Amazon Connect
|
959
|
+
# The following metrics are available. For a description of all the
|
960
|
+
# metrics, see [Real-time Metrics Definitions][1] in the *Amazon Connect
|
658
961
|
# Administrator Guide*.
|
659
962
|
#
|
660
963
|
# AGENTS\_AFTER\_CONTACT\_WORK
|
661
964
|
#
|
662
965
|
# : Unit: COUNT
|
663
966
|
#
|
967
|
+
# Name in real-time metrics report: [ACW][2]
|
968
|
+
#
|
664
969
|
# AGENTS\_AVAILABLE
|
665
970
|
#
|
666
971
|
# : Unit: COUNT
|
667
972
|
#
|
973
|
+
# Name in real-time metrics report: [Available][3]
|
974
|
+
#
|
668
975
|
# AGENTS\_ERROR
|
669
976
|
#
|
670
977
|
# : Unit: COUNT
|
671
978
|
#
|
979
|
+
# Name in real-time metrics report: [Error][4]
|
980
|
+
#
|
672
981
|
# AGENTS\_NON\_PRODUCTIVE
|
673
982
|
#
|
674
983
|
# : Unit: COUNT
|
675
984
|
#
|
985
|
+
# Name in real-time metrics report: [NPT (Non-Productive Time)][5]
|
986
|
+
#
|
676
987
|
# AGENTS\_ON\_CALL
|
677
988
|
#
|
678
989
|
# : Unit: COUNT
|
679
990
|
#
|
991
|
+
# Name in real-time metrics report: [On contact][6]
|
992
|
+
#
|
680
993
|
# AGENTS\_ON\_CONTACT
|
681
994
|
#
|
682
995
|
# : Unit: COUNT
|
683
996
|
#
|
997
|
+
# Name in real-time metrics report: [On contact][6]
|
998
|
+
#
|
684
999
|
# AGENTS\_ONLINE
|
685
1000
|
#
|
686
1001
|
# : Unit: COUNT
|
687
1002
|
#
|
1003
|
+
# Name in real-time metrics report: [Online][7]
|
1004
|
+
#
|
688
1005
|
# AGENTS\_STAFFED
|
689
1006
|
#
|
690
1007
|
# : Unit: COUNT
|
691
1008
|
#
|
1009
|
+
# Name in real-time metrics report: [Staffed][8]
|
1010
|
+
#
|
692
1011
|
# CONTACTS\_IN\_QUEUE
|
693
1012
|
#
|
694
1013
|
# : Unit: COUNT
|
695
1014
|
#
|
1015
|
+
# Name in real-time metrics report: [In queue][9]
|
1016
|
+
#
|
696
1017
|
# CONTACTS\_SCHEDULED
|
697
1018
|
#
|
698
1019
|
# : Unit: COUNT
|
699
1020
|
#
|
1021
|
+
# Name in real-time metrics report: [Scheduled][10]
|
1022
|
+
#
|
700
1023
|
# OLDEST\_CONTACT\_AGE
|
701
1024
|
#
|
702
1025
|
# : Unit: SECONDS
|
703
1026
|
#
|
1027
|
+
# When you use groupings, Unit says SECONDS but the Value is returned
|
1028
|
+
# in MILLISECONDS. For example, if you get a response like this:
|
1029
|
+
#
|
1030
|
+
# `\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" \},
|
1031
|
+
# "Value": 24113.0 `\\}
|
1032
|
+
#
|
1033
|
+
# The actual OLDEST\_CONTACT\_AGE is 24 seconds.
|
1034
|
+
#
|
1035
|
+
# Name in real-time metrics report: [Oldest][11]
|
1036
|
+
#
|
704
1037
|
# SLOTS\_ACTIVE
|
705
1038
|
#
|
706
1039
|
# : Unit: COUNT
|
707
1040
|
#
|
1041
|
+
# Name in real-time metrics report: [Active][12]
|
1042
|
+
#
|
708
1043
|
# SLOTS\_AVAILABLE
|
709
1044
|
#
|
710
1045
|
# : Unit: COUNT
|
711
1046
|
#
|
1047
|
+
# Name in real-time metrics report: [Availability][13]
|
1048
|
+
#
|
712
1049
|
#
|
713
1050
|
#
|
714
1051
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
1052
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time
|
1053
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time
|
1054
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time
|
1055
|
+
# [5]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time
|
1056
|
+
# [6]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time
|
1057
|
+
# [7]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time
|
1058
|
+
# [8]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time
|
1059
|
+
# [9]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time
|
1060
|
+
# [10]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time
|
1061
|
+
# [11]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time
|
1062
|
+
# [12]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time
|
1063
|
+
# [13]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time
|
715
1064
|
#
|
716
1065
|
# @option params [String] :next_token
|
717
1066
|
# The token for the next set of results. Use the value returned in the
|
@@ -808,12 +1157,12 @@ module Aws::Connect
|
|
808
1157
|
# Gets historical metric data from the specified Amazon Connect
|
809
1158
|
# instance.
|
810
1159
|
#
|
811
|
-
# For
|
812
|
-
# *Amazon Connect Administrator Guide*.
|
1160
|
+
# For a description of each historical metric, see [Historical Metrics
|
1161
|
+
# Definitions][1] in the *Amazon Connect Administrator Guide*.
|
813
1162
|
#
|
814
1163
|
#
|
815
1164
|
#
|
816
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics.html
|
1165
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
817
1166
|
#
|
818
1167
|
# @option params [required, String] :instance_id
|
819
1168
|
# The identifier of the Amazon Connect instance.
|
@@ -840,8 +1189,8 @@ module Aws::Connect
|
|
840
1189
|
# The queues, up to 100, or channels, to use to filter the metrics
|
841
1190
|
# returned. Metric data is retrieved only for the resources associated
|
842
1191
|
# with the queues or channels included in the filter. You can include
|
843
|
-
# both queue IDs and queue ARNs in the same request.
|
844
|
-
#
|
1192
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
1193
|
+
# `CHAT` channels are supported.
|
845
1194
|
#
|
846
1195
|
# @option params [Array<String>] :groupings
|
847
1196
|
# The grouping applied to the metrics returned. For example, when
|
@@ -1086,6 +1435,13 @@ module Aws::Connect
|
|
1086
1435
|
# Provides information about the contact flows for the specified Amazon
|
1087
1436
|
# Connect instance.
|
1088
1437
|
#
|
1438
|
+
# For more information about contact flows, see [Contact Flows][1] in
|
1439
|
+
# the *Amazon Connect Administrator Guide*.
|
1440
|
+
#
|
1441
|
+
#
|
1442
|
+
#
|
1443
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html
|
1444
|
+
#
|
1089
1445
|
# @option params [required, String] :instance_id
|
1090
1446
|
# The identifier of the Amazon Connect instance.
|
1091
1447
|
#
|
@@ -1137,6 +1493,13 @@ module Aws::Connect
|
|
1137
1493
|
# Provides information about the hours of operation for the specified
|
1138
1494
|
# Amazon Connect instance.
|
1139
1495
|
#
|
1496
|
+
# For more information about hours of operation, see [Set the Hours of
|
1497
|
+
# Operation for a Queue][1] in the *Amazon Connect Administrator Guide*.
|
1498
|
+
#
|
1499
|
+
#
|
1500
|
+
#
|
1501
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html
|
1502
|
+
#
|
1140
1503
|
# @option params [required, String] :instance_id
|
1141
1504
|
# The identifier of the Amazon Connect instance.
|
1142
1505
|
#
|
@@ -1183,6 +1546,14 @@ module Aws::Connect
|
|
1183
1546
|
# Provides information about the phone numbers for the specified Amazon
|
1184
1547
|
# Connect instance.
|
1185
1548
|
#
|
1549
|
+
# For more information about phone numbers, see [Set Up Phone Numbers
|
1550
|
+
# for Your Contact Center][1] in the *Amazon Connect Administrator
|
1551
|
+
# Guide*.
|
1552
|
+
#
|
1553
|
+
#
|
1554
|
+
#
|
1555
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
|
1556
|
+
#
|
1186
1557
|
# @option params [required, String] :instance_id
|
1187
1558
|
# The identifier of the Amazon Connect instance.
|
1188
1559
|
#
|
@@ -1236,9 +1607,62 @@ module Aws::Connect
|
|
1236
1607
|
req.send_request(options)
|
1237
1608
|
end
|
1238
1609
|
|
1610
|
+
# Provides information about the prompts for the specified Amazon
|
1611
|
+
# Connect instance.
|
1612
|
+
#
|
1613
|
+
# @option params [required, String] :instance_id
|
1614
|
+
# The identifier of the Amazon Connect instance.
|
1615
|
+
#
|
1616
|
+
# @option params [String] :next_token
|
1617
|
+
# The token for the next set of results. Use the value returned in the
|
1618
|
+
# previous response in the next request to retrieve the next set of
|
1619
|
+
# results.
|
1620
|
+
#
|
1621
|
+
# @option params [Integer] :max_results
|
1622
|
+
# The maximum number of results to return per page.
|
1623
|
+
#
|
1624
|
+
# @return [Types::ListPromptsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1625
|
+
#
|
1626
|
+
# * {Types::ListPromptsResponse#prompt_summary_list #prompt_summary_list} => Array<Types::PromptSummary>
|
1627
|
+
# * {Types::ListPromptsResponse#next_token #next_token} => String
|
1628
|
+
#
|
1629
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1630
|
+
#
|
1631
|
+
# @example Request syntax with placeholder values
|
1632
|
+
#
|
1633
|
+
# resp = client.list_prompts({
|
1634
|
+
# instance_id: "InstanceId", # required
|
1635
|
+
# next_token: "NextToken",
|
1636
|
+
# max_results: 1,
|
1637
|
+
# })
|
1638
|
+
#
|
1639
|
+
# @example Response structure
|
1640
|
+
#
|
1641
|
+
# resp.prompt_summary_list #=> Array
|
1642
|
+
# resp.prompt_summary_list[0].id #=> String
|
1643
|
+
# resp.prompt_summary_list[0].arn #=> String
|
1644
|
+
# resp.prompt_summary_list[0].name #=> String
|
1645
|
+
# resp.next_token #=> String
|
1646
|
+
#
|
1647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPrompts AWS API Documentation
|
1648
|
+
#
|
1649
|
+
# @overload list_prompts(params = {})
|
1650
|
+
# @param [Hash] params ({})
|
1651
|
+
def list_prompts(params = {}, options = {})
|
1652
|
+
req = build_request(:list_prompts, params)
|
1653
|
+
req.send_request(options)
|
1654
|
+
end
|
1655
|
+
|
1239
1656
|
# Provides information about the queues for the specified Amazon Connect
|
1240
1657
|
# instance.
|
1241
1658
|
#
|
1659
|
+
# For more information about queues, see [Queues: Standard and Agent][1]
|
1660
|
+
# in the *Amazon Connect Administrator Guide*.
|
1661
|
+
#
|
1662
|
+
#
|
1663
|
+
#
|
1664
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html
|
1665
|
+
#
|
1242
1666
|
# @option params [required, String] :instance_id
|
1243
1667
|
# The identifier of the Amazon Connect instance.
|
1244
1668
|
#
|
@@ -1287,9 +1711,70 @@ module Aws::Connect
|
|
1287
1711
|
req.send_request(options)
|
1288
1712
|
end
|
1289
1713
|
|
1714
|
+
# List the queues associated with a routing profile.
|
1715
|
+
#
|
1716
|
+
# @option params [required, String] :instance_id
|
1717
|
+
# The identifier of the Amazon Connect instance.
|
1718
|
+
#
|
1719
|
+
# @option params [required, String] :routing_profile_id
|
1720
|
+
# The identifier of the routing profile.
|
1721
|
+
#
|
1722
|
+
# @option params [String] :next_token
|
1723
|
+
# The token for the next set of results. Use the value returned in the
|
1724
|
+
# previous response in the next request to retrieve the next set of
|
1725
|
+
# results.
|
1726
|
+
#
|
1727
|
+
# @option params [Integer] :max_results
|
1728
|
+
# The maximimum number of results to return per page.
|
1729
|
+
#
|
1730
|
+
# @return [Types::ListRoutingProfileQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1731
|
+
#
|
1732
|
+
# * {Types::ListRoutingProfileQueuesResponse#next_token #next_token} => String
|
1733
|
+
# * {Types::ListRoutingProfileQueuesResponse#routing_profile_queue_config_summary_list #routing_profile_queue_config_summary_list} => Array<Types::RoutingProfileQueueConfigSummary>
|
1734
|
+
#
|
1735
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1736
|
+
#
|
1737
|
+
# @example Request syntax with placeholder values
|
1738
|
+
#
|
1739
|
+
# resp = client.list_routing_profile_queues({
|
1740
|
+
# instance_id: "InstanceId", # required
|
1741
|
+
# routing_profile_id: "RoutingProfileId", # required
|
1742
|
+
# next_token: "NextToken",
|
1743
|
+
# max_results: 1,
|
1744
|
+
# })
|
1745
|
+
#
|
1746
|
+
# @example Response structure
|
1747
|
+
#
|
1748
|
+
# resp.next_token #=> String
|
1749
|
+
# resp.routing_profile_queue_config_summary_list #=> Array
|
1750
|
+
# resp.routing_profile_queue_config_summary_list[0].queue_id #=> String
|
1751
|
+
# resp.routing_profile_queue_config_summary_list[0].queue_arn #=> String
|
1752
|
+
# resp.routing_profile_queue_config_summary_list[0].queue_name #=> String
|
1753
|
+
# resp.routing_profile_queue_config_summary_list[0].priority #=> Integer
|
1754
|
+
# resp.routing_profile_queue_config_summary_list[0].delay #=> Integer
|
1755
|
+
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT"
|
1756
|
+
#
|
1757
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueues AWS API Documentation
|
1758
|
+
#
|
1759
|
+
# @overload list_routing_profile_queues(params = {})
|
1760
|
+
# @param [Hash] params ({})
|
1761
|
+
def list_routing_profile_queues(params = {}, options = {})
|
1762
|
+
req = build_request(:list_routing_profile_queues, params)
|
1763
|
+
req.send_request(options)
|
1764
|
+
end
|
1765
|
+
|
1290
1766
|
# Provides summary information about the routing profiles for the
|
1291
1767
|
# specified Amazon Connect instance.
|
1292
1768
|
#
|
1769
|
+
# For more information about routing profiles, see [Routing Profiles][1]
|
1770
|
+
# and [Create a Routing Profile][2] in the *Amazon Connect Administrator
|
1771
|
+
# Guide*.
|
1772
|
+
#
|
1773
|
+
#
|
1774
|
+
#
|
1775
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html
|
1776
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html
|
1777
|
+
#
|
1293
1778
|
# @option params [required, String] :instance_id
|
1294
1779
|
# The identifier of the Amazon Connect instance.
|
1295
1780
|
#
|
@@ -1336,6 +1821,13 @@ module Aws::Connect
|
|
1336
1821
|
# Provides summary information about the security profiles for the
|
1337
1822
|
# specified Amazon Connect instance.
|
1338
1823
|
#
|
1824
|
+
# For more information about security profiles, see [Security
|
1825
|
+
# Profiles][1] in the *Amazon Connect Administrator Guide*.
|
1826
|
+
#
|
1827
|
+
#
|
1828
|
+
#
|
1829
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
|
1830
|
+
#
|
1339
1831
|
# @option params [required, String] :instance_id
|
1340
1832
|
# The identifier of the Amazon Connect instance.
|
1341
1833
|
#
|
@@ -1381,6 +1873,13 @@ module Aws::Connect
|
|
1381
1873
|
|
1382
1874
|
# Lists the tags for the specified resource.
|
1383
1875
|
#
|
1876
|
+
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
1877
|
+
# Policy Examples][1] in the *Amazon Connect Administrator Guide*.
|
1878
|
+
#
|
1879
|
+
#
|
1880
|
+
#
|
1881
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
|
1882
|
+
#
|
1384
1883
|
# @option params [required, String] :resource_arn
|
1385
1884
|
# The Amazon Resource Name (ARN) of the resource.
|
1386
1885
|
#
|
@@ -1411,6 +1910,13 @@ module Aws::Connect
|
|
1411
1910
|
# Provides summary information about the hierarchy groups for the
|
1412
1911
|
# specified Amazon Connect instance.
|
1413
1912
|
#
|
1913
|
+
# For more information about agent hierarchies, see [Set Up Agent
|
1914
|
+
# Hierarchies][1] in the *Amazon Connect Administrator Guide*.
|
1915
|
+
#
|
1916
|
+
#
|
1917
|
+
#
|
1918
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html
|
1919
|
+
#
|
1414
1920
|
# @option params [required, String] :instance_id
|
1415
1921
|
# The identifier of the Amazon Connect instance.
|
1416
1922
|
#
|
@@ -1545,15 +2051,35 @@ module Aws::Connect
|
|
1545
2051
|
# [CreateParticipantConnection][1] with WEBSOCKET and
|
1546
2052
|
# CONNECTION\_CREDENTIALS.
|
1547
2053
|
#
|
2054
|
+
# A 429 error occurs in two situations:
|
2055
|
+
#
|
2056
|
+
# * API rate limit is exceeded. API TPS throttling returns a
|
2057
|
+
# `TooManyRequests` exception from the API Gateway.
|
2058
|
+
#
|
2059
|
+
# * The [quota for concurrent active chats][2] is exceeded. Active chat
|
2060
|
+
# throttling returns a `LimitExceededException`.
|
2061
|
+
#
|
2062
|
+
# For more information about how chat works, see [Chat][3] in the
|
2063
|
+
# *Amazon Connect Administrator Guide*.
|
2064
|
+
#
|
1548
2065
|
#
|
1549
2066
|
#
|
1550
2067
|
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
2068
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
2069
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/chat.html
|
1551
2070
|
#
|
1552
2071
|
# @option params [required, String] :instance_id
|
1553
2072
|
# The identifier of the Amazon Connect instance.
|
1554
2073
|
#
|
1555
2074
|
# @option params [required, String] :contact_flow_id
|
1556
|
-
# The identifier of the contact flow for the chat.
|
2075
|
+
# The identifier of the contact flow for initiating the chat. To see the
|
2076
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
2077
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
2078
|
+
# contact flow. On the contact flow page, under the name of the contact
|
2079
|
+
# flow, choose **Show additional flow information**. The ContactFlowId
|
2080
|
+
# is the last part of the ARN, shown here in bold:
|
2081
|
+
#
|
2082
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
1557
2083
|
#
|
1558
2084
|
# @option params [Hash<String,String>] :attributes
|
1559
2085
|
# A custom key-value pair using an attribute map. The attributes are
|
@@ -1680,11 +2206,29 @@ module Aws::Connect
|
|
1680
2206
|
# There is a 60 second dialing timeout for this operation. If the call
|
1681
2207
|
# is not connected after 60 seconds, it fails.
|
1682
2208
|
#
|
2209
|
+
# <note markdown="1"> UK numbers with a 447 prefix are not allowed by default. Before you
|
2210
|
+
# can dial these UK mobile numbers, you must submit a service quota
|
2211
|
+
# increase request. For more information, see [Amazon Connect Service
|
2212
|
+
# Quotas][1] in the *Amazon Connect Administrator Guide*.
|
2213
|
+
#
|
2214
|
+
# </note>
|
2215
|
+
#
|
2216
|
+
#
|
2217
|
+
#
|
2218
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
2219
|
+
#
|
1683
2220
|
# @option params [required, String] :destination_phone_number
|
1684
2221
|
# The phone number of the customer, in E.164 format.
|
1685
2222
|
#
|
1686
2223
|
# @option params [required, String] :contact_flow_id
|
1687
|
-
# The identifier of the contact flow for the outbound call.
|
2224
|
+
# The identifier of the contact flow for the outbound call. To see the
|
2225
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
2226
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
2227
|
+
# contact flow. On the contact flow page, under the name of the contact
|
2228
|
+
# flow, choose **Show additional flow information**. The ContactFlowId
|
2229
|
+
# is the last part of the ARN, shown here in bold:
|
2230
|
+
#
|
2231
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
1688
2232
|
#
|
1689
2233
|
# @option params [required, String] :instance_id
|
1690
2234
|
# The identifier of the Amazon Connect instance.
|
@@ -1857,6 +2401,13 @@ module Aws::Connect
|
|
1857
2401
|
#
|
1858
2402
|
# The supported resource type is users.
|
1859
2403
|
#
|
2404
|
+
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
2405
|
+
# Policy Examples][1] in the *Amazon Connect Administrator Guide*.
|
2406
|
+
#
|
2407
|
+
#
|
2408
|
+
#
|
2409
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
|
2410
|
+
#
|
1860
2411
|
# @option params [required, String] :resource_arn
|
1861
2412
|
# The Amazon Resource Name (ARN) of the resource.
|
1862
2413
|
#
|
@@ -1970,6 +2521,213 @@ module Aws::Connect
|
|
1970
2521
|
req.send_request(options)
|
1971
2522
|
end
|
1972
2523
|
|
2524
|
+
# Updates the specified contact flow.
|
2525
|
+
#
|
2526
|
+
# @option params [required, String] :instance_id
|
2527
|
+
# The identifier of the Amazon Connect instance.
|
2528
|
+
#
|
2529
|
+
# @option params [required, String] :contact_flow_id
|
2530
|
+
# The identifier of the contact flow.
|
2531
|
+
#
|
2532
|
+
# @option params [required, String] :content
|
2533
|
+
# The content of the contact flow.
|
2534
|
+
#
|
2535
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2536
|
+
#
|
2537
|
+
# @example Request syntax with placeholder values
|
2538
|
+
#
|
2539
|
+
# resp = client.update_contact_flow_content({
|
2540
|
+
# instance_id: "InstanceId", # required
|
2541
|
+
# contact_flow_id: "ContactFlowId", # required
|
2542
|
+
# content: "ContactFlowContent", # required
|
2543
|
+
# })
|
2544
|
+
#
|
2545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowContent AWS API Documentation
|
2546
|
+
#
|
2547
|
+
# @overload update_contact_flow_content(params = {})
|
2548
|
+
# @param [Hash] params ({})
|
2549
|
+
def update_contact_flow_content(params = {}, options = {})
|
2550
|
+
req = build_request(:update_contact_flow_content, params)
|
2551
|
+
req.send_request(options)
|
2552
|
+
end
|
2553
|
+
|
2554
|
+
# The name of the contact flow.
|
2555
|
+
#
|
2556
|
+
# @option params [required, String] :instance_id
|
2557
|
+
# The identifier of the Amazon Connect instance.
|
2558
|
+
#
|
2559
|
+
# @option params [required, String] :contact_flow_id
|
2560
|
+
# The identifier of the contact flow.
|
2561
|
+
#
|
2562
|
+
# @option params [String] :name
|
2563
|
+
# The name of the contact flow.
|
2564
|
+
#
|
2565
|
+
# @option params [String] :description
|
2566
|
+
# The description of the contact flow.
|
2567
|
+
#
|
2568
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2569
|
+
#
|
2570
|
+
# @example Request syntax with placeholder values
|
2571
|
+
#
|
2572
|
+
# resp = client.update_contact_flow_name({
|
2573
|
+
# instance_id: "InstanceId", # required
|
2574
|
+
# contact_flow_id: "ContactFlowId", # required
|
2575
|
+
# name: "ContactFlowName",
|
2576
|
+
# description: "ContactFlowDescription",
|
2577
|
+
# })
|
2578
|
+
#
|
2579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowName AWS API Documentation
|
2580
|
+
#
|
2581
|
+
# @overload update_contact_flow_name(params = {})
|
2582
|
+
# @param [Hash] params ({})
|
2583
|
+
def update_contact_flow_name(params = {}, options = {})
|
2584
|
+
req = build_request(:update_contact_flow_name, params)
|
2585
|
+
req.send_request(options)
|
2586
|
+
end
|
2587
|
+
|
2588
|
+
# Updates the channels that agents can handle in the Contact Control
|
2589
|
+
# Panel (CCP) for a routing profile.
|
2590
|
+
#
|
2591
|
+
# @option params [required, String] :instance_id
|
2592
|
+
# The identifier of the Amazon Connect instance.
|
2593
|
+
#
|
2594
|
+
# @option params [required, String] :routing_profile_id
|
2595
|
+
# The identifier of the routing profile.
|
2596
|
+
#
|
2597
|
+
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
2598
|
+
# The channels agents can handle in the Contact Control Panel (CCP).
|
2599
|
+
#
|
2600
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2601
|
+
#
|
2602
|
+
# @example Request syntax with placeholder values
|
2603
|
+
#
|
2604
|
+
# resp = client.update_routing_profile_concurrency({
|
2605
|
+
# instance_id: "InstanceId", # required
|
2606
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2607
|
+
# media_concurrencies: [ # required
|
2608
|
+
# {
|
2609
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2610
|
+
# concurrency: 1, # required
|
2611
|
+
# },
|
2612
|
+
# ],
|
2613
|
+
# })
|
2614
|
+
#
|
2615
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileConcurrency AWS API Documentation
|
2616
|
+
#
|
2617
|
+
# @overload update_routing_profile_concurrency(params = {})
|
2618
|
+
# @param [Hash] params ({})
|
2619
|
+
def update_routing_profile_concurrency(params = {}, options = {})
|
2620
|
+
req = build_request(:update_routing_profile_concurrency, params)
|
2621
|
+
req.send_request(options)
|
2622
|
+
end
|
2623
|
+
|
2624
|
+
# Updates the default outbound queue of a routing profile.
|
2625
|
+
#
|
2626
|
+
# @option params [required, String] :instance_id
|
2627
|
+
# The identifier of the Amazon Connect instance.
|
2628
|
+
#
|
2629
|
+
# @option params [required, String] :routing_profile_id
|
2630
|
+
# The identifier of the routing profile.
|
2631
|
+
#
|
2632
|
+
# @option params [required, String] :default_outbound_queue_id
|
2633
|
+
# The identifier for the default outbound queue.
|
2634
|
+
#
|
2635
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2636
|
+
#
|
2637
|
+
# @example Request syntax with placeholder values
|
2638
|
+
#
|
2639
|
+
# resp = client.update_routing_profile_default_outbound_queue({
|
2640
|
+
# instance_id: "InstanceId", # required
|
2641
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2642
|
+
# default_outbound_queue_id: "QueueId", # required
|
2643
|
+
# })
|
2644
|
+
#
|
2645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue AWS API Documentation
|
2646
|
+
#
|
2647
|
+
# @overload update_routing_profile_default_outbound_queue(params = {})
|
2648
|
+
# @param [Hash] params ({})
|
2649
|
+
def update_routing_profile_default_outbound_queue(params = {}, options = {})
|
2650
|
+
req = build_request(:update_routing_profile_default_outbound_queue, params)
|
2651
|
+
req.send_request(options)
|
2652
|
+
end
|
2653
|
+
|
2654
|
+
# Updates the name and description of a routing profile. The request
|
2655
|
+
# accepts the following data in JSON format. At least `Name` or
|
2656
|
+
# `Description` must be provided.
|
2657
|
+
#
|
2658
|
+
# @option params [required, String] :instance_id
|
2659
|
+
# The identifier of the Amazon Connect instance.
|
2660
|
+
#
|
2661
|
+
# @option params [required, String] :routing_profile_id
|
2662
|
+
# The identifier of the routing profile.
|
2663
|
+
#
|
2664
|
+
# @option params [String] :name
|
2665
|
+
# The name of the routing profile. Must not be more than 127 characters.
|
2666
|
+
#
|
2667
|
+
# @option params [String] :description
|
2668
|
+
# The description of the routing profile. Must not be more than 250
|
2669
|
+
# characters.
|
2670
|
+
#
|
2671
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2672
|
+
#
|
2673
|
+
# @example Request syntax with placeholder values
|
2674
|
+
#
|
2675
|
+
# resp = client.update_routing_profile_name({
|
2676
|
+
# instance_id: "InstanceId", # required
|
2677
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2678
|
+
# name: "RoutingProfileName",
|
2679
|
+
# description: "RoutingProfileDescription",
|
2680
|
+
# })
|
2681
|
+
#
|
2682
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileName AWS API Documentation
|
2683
|
+
#
|
2684
|
+
# @overload update_routing_profile_name(params = {})
|
2685
|
+
# @param [Hash] params ({})
|
2686
|
+
def update_routing_profile_name(params = {}, options = {})
|
2687
|
+
req = build_request(:update_routing_profile_name, params)
|
2688
|
+
req.send_request(options)
|
2689
|
+
end
|
2690
|
+
|
2691
|
+
# Updates the properties associated with a set of queues for a routing
|
2692
|
+
# profile.
|
2693
|
+
#
|
2694
|
+
# @option params [required, String] :instance_id
|
2695
|
+
# The identifier of the Amazon Connect instance.
|
2696
|
+
#
|
2697
|
+
# @option params [required, String] :routing_profile_id
|
2698
|
+
# The identifier of the routing profile.
|
2699
|
+
#
|
2700
|
+
# @option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
2701
|
+
# The queues to be updated for this routing profile.
|
2702
|
+
#
|
2703
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2704
|
+
#
|
2705
|
+
# @example Request syntax with placeholder values
|
2706
|
+
#
|
2707
|
+
# resp = client.update_routing_profile_queues({
|
2708
|
+
# instance_id: "InstanceId", # required
|
2709
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2710
|
+
# queue_configs: [ # required
|
2711
|
+
# {
|
2712
|
+
# queue_reference: { # required
|
2713
|
+
# queue_id: "QueueId", # required
|
2714
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2715
|
+
# },
|
2716
|
+
# priority: 1, # required
|
2717
|
+
# delay: 1, # required
|
2718
|
+
# },
|
2719
|
+
# ],
|
2720
|
+
# })
|
2721
|
+
#
|
2722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileQueues AWS API Documentation
|
2723
|
+
#
|
2724
|
+
# @overload update_routing_profile_queues(params = {})
|
2725
|
+
# @param [Hash] params ({})
|
2726
|
+
def update_routing_profile_queues(params = {}, options = {})
|
2727
|
+
req = build_request(:update_routing_profile_queues, params)
|
2728
|
+
req.send_request(options)
|
2729
|
+
end
|
2730
|
+
|
1973
2731
|
# Assigns the specified hierarchy group to the specified user.
|
1974
2732
|
#
|
1975
2733
|
# @option params [String] :hierarchy_group_id
|
@@ -2002,6 +2760,19 @@ module Aws::Connect
|
|
2002
2760
|
|
2003
2761
|
# Updates the identity information for the specified user.
|
2004
2762
|
#
|
2763
|
+
# Someone with the ability to invoke `UpdateUserIndentityInfo` can
|
2764
|
+
# change the login credentials of other users by changing their email
|
2765
|
+
# address. This poses a security risk to your organization. They can
|
2766
|
+
# change the email address of a user to the attacker's email address,
|
2767
|
+
# and then reset the password through email. We strongly recommend
|
2768
|
+
# limiting who has the ability to invoke `UpdateUserIndentityInfo`. For
|
2769
|
+
# more information, see [Best Practices for Security Profiles][1] in the
|
2770
|
+
# *Amazon Connect Administrator Guide*.
|
2771
|
+
#
|
2772
|
+
#
|
2773
|
+
#
|
2774
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html
|
2775
|
+
#
|
2005
2776
|
# @option params [required, Types::UserIdentityInfo] :identity_info
|
2006
2777
|
# The identity information for the user.
|
2007
2778
|
#
|
@@ -2142,7 +2913,7 @@ module Aws::Connect
|
|
2142
2913
|
params: params,
|
2143
2914
|
config: config)
|
2144
2915
|
context[:gem_name] = 'aws-sdk-connect'
|
2145
|
-
context[:gem_version] = '1.
|
2916
|
+
context[:gem_version] = '1.32.0'
|
2146
2917
|
Seahorse::Client::Request.new(handlers, context)
|
2147
2918
|
end
|
2148
2919
|
|