aws-sdk-connect 1.29.0 → 1.34.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 +4 -3
- data/lib/aws-sdk-connect/client.rb +849 -24
- 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 +1108 -73
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e2f591a4ef5da7d3bb41e2088e65c49b9540f8dc685a93a1502b6059a9687ac0
|
4
|
+
data.tar.gz: 2be9a1238eeb100c3e0ee4194c089efd410065b7502f668591c55c835a1826f7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5edf0889b3a43aea912e5474d0b238f71c248d384c14da316a5b37df2f0b6be842edab66dcac094cd7d1a4653f5b0c1b4393209ea8d6f5fb19d13736dbb44bec
|
7
|
+
data.tar.gz: 4e7e94e53b8065be85f349045842ac1f42c7d56904521f36e0c75e3f3de92b240f2ac3e0a04f8b545e9e8a5403fff2c55463b68fa32c3b131db1c168d07c3c99
|
data/lib/aws-sdk-connect.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -27,7 +28,7 @@ require_relative 'aws-sdk-connect/customizations'
|
|
27
28
|
# structure.
|
28
29
|
#
|
29
30
|
# connect = Aws::Connect::Client.new
|
30
|
-
# resp = connect.
|
31
|
+
# resp = connect.associate_routing_profile_queues(params)
|
31
32
|
#
|
32
33
|
# See {Client} for more information.
|
33
34
|
#
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-connect/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::Connect
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.34.0'
|
51
52
|
|
52
53
|
end
|
@@ -85,13 +85,28 @@ module Aws::Connect
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::Connect
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -312,8 +327,193 @@ module Aws::Connect
|
|
312
327
|
|
313
328
|
# @!group API Operations
|
314
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
|
+
# You can also create and update contact flows using the [Amazon Connect
|
372
|
+
# Flow language][1].
|
373
|
+
#
|
374
|
+
#
|
375
|
+
#
|
376
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
377
|
+
#
|
378
|
+
# @option params [required, String] :instance_id
|
379
|
+
# The identifier of the Amazon Connect instance.
|
380
|
+
#
|
381
|
+
# @option params [required, String] :name
|
382
|
+
# The name of the contact flow.
|
383
|
+
#
|
384
|
+
# @option params [required, String] :type
|
385
|
+
# The type of the contact flow. For descriptions of the available types,
|
386
|
+
# see [Choose a Contact Flow Type][1] in the *Amazon Connect
|
387
|
+
# Administrator Guide*.
|
388
|
+
#
|
389
|
+
#
|
390
|
+
#
|
391
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
|
392
|
+
#
|
393
|
+
# @option params [String] :description
|
394
|
+
# The description of the contact flow.
|
395
|
+
#
|
396
|
+
# @option params [required, String] :content
|
397
|
+
# The content of the contact flow.
|
398
|
+
#
|
399
|
+
# @option params [Hash<String,String>] :tags
|
400
|
+
# One or more tags.
|
401
|
+
#
|
402
|
+
# @return [Types::CreateContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
403
|
+
#
|
404
|
+
# * {Types::CreateContactFlowResponse#contact_flow_id #contact_flow_id} => String
|
405
|
+
# * {Types::CreateContactFlowResponse#contact_flow_arn #contact_flow_arn} => String
|
406
|
+
#
|
407
|
+
# @example Request syntax with placeholder values
|
408
|
+
#
|
409
|
+
# resp = client.create_contact_flow({
|
410
|
+
# instance_id: "InstanceId", # required
|
411
|
+
# name: "ContactFlowName", # required
|
412
|
+
# type: "CONTACT_FLOW", # required, accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
413
|
+
# description: "ContactFlowDescription",
|
414
|
+
# content: "ContactFlowContent", # required
|
415
|
+
# tags: {
|
416
|
+
# "TagKey" => "TagValue",
|
417
|
+
# },
|
418
|
+
# })
|
419
|
+
#
|
420
|
+
# @example Response structure
|
421
|
+
#
|
422
|
+
# resp.contact_flow_id #=> String
|
423
|
+
# resp.contact_flow_arn #=> String
|
424
|
+
#
|
425
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlow AWS API Documentation
|
426
|
+
#
|
427
|
+
# @overload create_contact_flow(params = {})
|
428
|
+
# @param [Hash] params ({})
|
429
|
+
def create_contact_flow(params = {}, options = {})
|
430
|
+
req = build_request(:create_contact_flow, params)
|
431
|
+
req.send_request(options)
|
432
|
+
end
|
433
|
+
|
434
|
+
# Creates a new routing profile.
|
435
|
+
#
|
436
|
+
# @option params [required, String] :instance_id
|
437
|
+
# The identifier of the Amazon Connect instance.
|
438
|
+
#
|
439
|
+
# @option params [required, String] :name
|
440
|
+
# The name of the routing profile. Must not be more than 127 characters.
|
441
|
+
#
|
442
|
+
# @option params [required, String] :description
|
443
|
+
# Description of the routing profile. Must not be more than 250
|
444
|
+
# characters.
|
445
|
+
#
|
446
|
+
# @option params [required, String] :default_outbound_queue_id
|
447
|
+
# The default outbound queue for the routing profile.
|
448
|
+
#
|
449
|
+
# @option params [Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
450
|
+
# The inbound queues associated with the routing profile. If no queue is
|
451
|
+
# added, the agent can only make outbound calls.
|
452
|
+
#
|
453
|
+
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
454
|
+
# The channels agents can handle in the Contact Control Panel (CCP) for
|
455
|
+
# this routing profile.
|
456
|
+
#
|
457
|
+
# @option params [Hash<String,String>] :tags
|
458
|
+
# One or more tags.
|
459
|
+
#
|
460
|
+
# @return [Types::CreateRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
461
|
+
#
|
462
|
+
# * {Types::CreateRoutingProfileResponse#routing_profile_arn #routing_profile_arn} => String
|
463
|
+
# * {Types::CreateRoutingProfileResponse#routing_profile_id #routing_profile_id} => String
|
464
|
+
#
|
465
|
+
# @example Request syntax with placeholder values
|
466
|
+
#
|
467
|
+
# resp = client.create_routing_profile({
|
468
|
+
# instance_id: "InstanceId", # required
|
469
|
+
# name: "RoutingProfileName", # required
|
470
|
+
# description: "RoutingProfileDescription", # required
|
471
|
+
# default_outbound_queue_id: "QueueId", # required
|
472
|
+
# queue_configs: [
|
473
|
+
# {
|
474
|
+
# queue_reference: { # required
|
475
|
+
# queue_id: "QueueId", # required
|
476
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
477
|
+
# },
|
478
|
+
# priority: 1, # required
|
479
|
+
# delay: 1, # required
|
480
|
+
# },
|
481
|
+
# ],
|
482
|
+
# media_concurrencies: [ # required
|
483
|
+
# {
|
484
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
485
|
+
# concurrency: 1, # required
|
486
|
+
# },
|
487
|
+
# ],
|
488
|
+
# tags: {
|
489
|
+
# "TagKey" => "TagValue",
|
490
|
+
# },
|
491
|
+
# })
|
492
|
+
#
|
493
|
+
# @example Response structure
|
494
|
+
#
|
495
|
+
# resp.routing_profile_arn #=> String
|
496
|
+
# resp.routing_profile_id #=> String
|
497
|
+
#
|
498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRoutingProfile AWS API Documentation
|
499
|
+
#
|
500
|
+
# @overload create_routing_profile(params = {})
|
501
|
+
# @param [Hash] params ({})
|
502
|
+
def create_routing_profile(params = {}, options = {})
|
503
|
+
req = build_request(:create_routing_profile, params)
|
504
|
+
req.send_request(options)
|
505
|
+
end
|
506
|
+
|
315
507
|
# Creates a user account for the specified Amazon Connect instance.
|
316
508
|
#
|
509
|
+
# For information about how to create user accounts using the Amazon
|
510
|
+
# Connect console, see [Add Users][1] in the *Amazon Connect
|
511
|
+
# Administrator Guide*.
|
512
|
+
#
|
513
|
+
#
|
514
|
+
#
|
515
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html
|
516
|
+
#
|
317
517
|
# @option params [required, String] :username
|
318
518
|
# The user name for the account. For instances not using SAML for
|
319
519
|
# identity management, the user name can include up to 20 characters. If
|
@@ -406,6 +606,14 @@ module Aws::Connect
|
|
406
606
|
|
407
607
|
# Deletes a user account from the specified Amazon Connect instance.
|
408
608
|
#
|
609
|
+
# For information about what happens to a user's data when their
|
610
|
+
# account is deleted, see [Delete Users from Your Amazon Connect
|
611
|
+
# Instance][1] in the *Amazon Connect Administrator Guide*.
|
612
|
+
#
|
613
|
+
#
|
614
|
+
#
|
615
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html
|
616
|
+
#
|
409
617
|
# @option params [required, String] :instance_id
|
410
618
|
# The identifier of the Amazon Connect instance.
|
411
619
|
#
|
@@ -430,6 +638,94 @@ module Aws::Connect
|
|
430
638
|
req.send_request(options)
|
431
639
|
end
|
432
640
|
|
641
|
+
# Describes the specified contact flow.
|
642
|
+
#
|
643
|
+
# You can also create and update contact flows using the [Amazon Connect
|
644
|
+
# Flow language][1].
|
645
|
+
#
|
646
|
+
#
|
647
|
+
#
|
648
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
649
|
+
#
|
650
|
+
# @option params [required, String] :instance_id
|
651
|
+
# The identifier of the Amazon Connect instance.
|
652
|
+
#
|
653
|
+
# @option params [required, String] :contact_flow_id
|
654
|
+
# The identifier of the contact flow.
|
655
|
+
#
|
656
|
+
# @return [Types::DescribeContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
657
|
+
#
|
658
|
+
# * {Types::DescribeContactFlowResponse#contact_flow #contact_flow} => Types::ContactFlow
|
659
|
+
#
|
660
|
+
# @example Request syntax with placeholder values
|
661
|
+
#
|
662
|
+
# resp = client.describe_contact_flow({
|
663
|
+
# instance_id: "InstanceId", # required
|
664
|
+
# contact_flow_id: "ContactFlowId", # required
|
665
|
+
# })
|
666
|
+
#
|
667
|
+
# @example Response structure
|
668
|
+
#
|
669
|
+
# resp.contact_flow.arn #=> String
|
670
|
+
# resp.contact_flow.id #=> String
|
671
|
+
# resp.contact_flow.name #=> String
|
672
|
+
# 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"
|
673
|
+
# resp.contact_flow.description #=> String
|
674
|
+
# resp.contact_flow.content #=> String
|
675
|
+
# resp.contact_flow.tags #=> Hash
|
676
|
+
# resp.contact_flow.tags["TagKey"] #=> String
|
677
|
+
#
|
678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlow AWS API Documentation
|
679
|
+
#
|
680
|
+
# @overload describe_contact_flow(params = {})
|
681
|
+
# @param [Hash] params ({})
|
682
|
+
def describe_contact_flow(params = {}, options = {})
|
683
|
+
req = build_request(:describe_contact_flow, params)
|
684
|
+
req.send_request(options)
|
685
|
+
end
|
686
|
+
|
687
|
+
# Describes the specified routing profile.
|
688
|
+
#
|
689
|
+
# @option params [required, String] :instance_id
|
690
|
+
# The identifier of the Amazon Connect instance.
|
691
|
+
#
|
692
|
+
# @option params [required, String] :routing_profile_id
|
693
|
+
# The identifier of the routing profile.
|
694
|
+
#
|
695
|
+
# @return [Types::DescribeRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
696
|
+
#
|
697
|
+
# * {Types::DescribeRoutingProfileResponse#routing_profile #routing_profile} => Types::RoutingProfile
|
698
|
+
#
|
699
|
+
# @example Request syntax with placeholder values
|
700
|
+
#
|
701
|
+
# resp = client.describe_routing_profile({
|
702
|
+
# instance_id: "InstanceId", # required
|
703
|
+
# routing_profile_id: "RoutingProfileId", # required
|
704
|
+
# })
|
705
|
+
#
|
706
|
+
# @example Response structure
|
707
|
+
#
|
708
|
+
# resp.routing_profile.instance_id #=> String
|
709
|
+
# resp.routing_profile.name #=> String
|
710
|
+
# resp.routing_profile.routing_profile_arn #=> String
|
711
|
+
# resp.routing_profile.routing_profile_id #=> String
|
712
|
+
# resp.routing_profile.description #=> String
|
713
|
+
# resp.routing_profile.media_concurrencies #=> Array
|
714
|
+
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT"
|
715
|
+
# resp.routing_profile.media_concurrencies[0].concurrency #=> Integer
|
716
|
+
# resp.routing_profile.default_outbound_queue_id #=> String
|
717
|
+
# resp.routing_profile.tags #=> Hash
|
718
|
+
# resp.routing_profile.tags["TagKey"] #=> String
|
719
|
+
#
|
720
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfile AWS API Documentation
|
721
|
+
#
|
722
|
+
# @overload describe_routing_profile(params = {})
|
723
|
+
# @param [Hash] params ({})
|
724
|
+
def describe_routing_profile(params = {}, options = {})
|
725
|
+
req = build_request(:describe_routing_profile, params)
|
726
|
+
req.send_request(options)
|
727
|
+
end
|
728
|
+
|
433
729
|
# Describes the specified user account. You can find the instance ID in
|
434
730
|
# the console (it’s the final part of the ARN). The console does not
|
435
731
|
# display the user IDs. Instead, list the users and note the IDs
|
@@ -574,6 +870,41 @@ module Aws::Connect
|
|
574
870
|
req.send_request(options)
|
575
871
|
end
|
576
872
|
|
873
|
+
# Disassociates a set of queues from a routing profile.
|
874
|
+
#
|
875
|
+
# @option params [required, String] :instance_id
|
876
|
+
# The identifier of the Amazon Connect instance.
|
877
|
+
#
|
878
|
+
# @option params [required, String] :routing_profile_id
|
879
|
+
# The identifier of the routing profile.
|
880
|
+
#
|
881
|
+
# @option params [required, Array<Types::RoutingProfileQueueReference>] :queue_references
|
882
|
+
# The queues to disassociate from this routing profile.
|
883
|
+
#
|
884
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
885
|
+
#
|
886
|
+
# @example Request syntax with placeholder values
|
887
|
+
#
|
888
|
+
# resp = client.disassociate_routing_profile_queues({
|
889
|
+
# instance_id: "InstanceId", # required
|
890
|
+
# routing_profile_id: "RoutingProfileId", # required
|
891
|
+
# queue_references: [ # required
|
892
|
+
# {
|
893
|
+
# queue_id: "QueueId", # required
|
894
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
895
|
+
# },
|
896
|
+
# ],
|
897
|
+
# })
|
898
|
+
#
|
899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateRoutingProfileQueues AWS API Documentation
|
900
|
+
#
|
901
|
+
# @overload disassociate_routing_profile_queues(params = {})
|
902
|
+
# @param [Hash] params ({})
|
903
|
+
def disassociate_routing_profile_queues(params = {}, options = {})
|
904
|
+
req = build_request(:disassociate_routing_profile_queues, params)
|
905
|
+
req.send_request(options)
|
906
|
+
end
|
907
|
+
|
577
908
|
# Retrieves the contact attributes for the specified contact.
|
578
909
|
#
|
579
910
|
# @option params [required, String] :instance_id
|
@@ -610,12 +941,12 @@ module Aws::Connect
|
|
610
941
|
# Gets the real-time metric data from the specified Amazon Connect
|
611
942
|
# instance.
|
612
943
|
#
|
613
|
-
# For
|
614
|
-
# *Amazon Connect Administrator Guide*.
|
944
|
+
# For a description of each metric, see [Real-time Metrics
|
945
|
+
# Definitions][1] in the *Amazon Connect Administrator Guide*.
|
615
946
|
#
|
616
947
|
#
|
617
948
|
#
|
618
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-
|
949
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
619
950
|
#
|
620
951
|
# @option params [required, String] :instance_id
|
621
952
|
# The identifier of the Amazon Connect instance.
|
@@ -624,79 +955,126 @@ module Aws::Connect
|
|
624
955
|
# The queues, up to 100, or channels, to use to filter the metrics
|
625
956
|
# returned. Metric data is retrieved only for the resources associated
|
626
957
|
# with the queues or channels included in the filter. You can include
|
627
|
-
# both queue IDs and queue ARNs in the same request.
|
628
|
-
#
|
958
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
959
|
+
# `CHAT` channels are supported.
|
629
960
|
#
|
630
961
|
# @option params [Array<String>] :groupings
|
631
962
|
# The grouping applied to the metrics returned. For example, when
|
632
963
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
633
964
|
# than aggregated for all queues. If you group by `CHANNEL`, you should
|
634
|
-
# include a Channels filter.
|
965
|
+
# include a Channels filter. Both `VOICE` and `CHAT` channels are
|
966
|
+
# supported.
|
635
967
|
#
|
636
968
|
# If no `Grouping` is included in the request, a summary of metrics is
|
637
969
|
# returned.
|
638
970
|
#
|
639
971
|
# @option params [required, Array<Types::CurrentMetric>] :current_metrics
|
640
972
|
# The metrics to retrieve. Specify the name and unit for each metric.
|
641
|
-
# The following metrics are available. For a description of
|
642
|
-
# see [Real-time Metrics Definitions][1] in the *Amazon Connect
|
973
|
+
# The following metrics are available. For a description of all the
|
974
|
+
# metrics, see [Real-time Metrics Definitions][1] in the *Amazon Connect
|
643
975
|
# Administrator Guide*.
|
644
976
|
#
|
645
977
|
# AGENTS\_AFTER\_CONTACT\_WORK
|
646
978
|
#
|
647
979
|
# : Unit: COUNT
|
648
980
|
#
|
981
|
+
# Name in real-time metrics report: [ACW][2]
|
982
|
+
#
|
649
983
|
# AGENTS\_AVAILABLE
|
650
984
|
#
|
651
985
|
# : Unit: COUNT
|
652
986
|
#
|
987
|
+
# Name in real-time metrics report: [Available][3]
|
988
|
+
#
|
653
989
|
# AGENTS\_ERROR
|
654
990
|
#
|
655
991
|
# : Unit: COUNT
|
656
992
|
#
|
993
|
+
# Name in real-time metrics report: [Error][4]
|
994
|
+
#
|
657
995
|
# AGENTS\_NON\_PRODUCTIVE
|
658
996
|
#
|
659
997
|
# : Unit: COUNT
|
660
998
|
#
|
999
|
+
# Name in real-time metrics report: [NPT (Non-Productive Time)][5]
|
1000
|
+
#
|
661
1001
|
# AGENTS\_ON\_CALL
|
662
1002
|
#
|
663
1003
|
# : Unit: COUNT
|
664
1004
|
#
|
1005
|
+
# Name in real-time metrics report: [On contact][6]
|
1006
|
+
#
|
665
1007
|
# AGENTS\_ON\_CONTACT
|
666
1008
|
#
|
667
1009
|
# : Unit: COUNT
|
668
1010
|
#
|
1011
|
+
# Name in real-time metrics report: [On contact][6]
|
1012
|
+
#
|
669
1013
|
# AGENTS\_ONLINE
|
670
1014
|
#
|
671
1015
|
# : Unit: COUNT
|
672
1016
|
#
|
1017
|
+
# Name in real-time metrics report: [Online][7]
|
1018
|
+
#
|
673
1019
|
# AGENTS\_STAFFED
|
674
1020
|
#
|
675
1021
|
# : Unit: COUNT
|
676
1022
|
#
|
1023
|
+
# Name in real-time metrics report: [Staffed][8]
|
1024
|
+
#
|
677
1025
|
# CONTACTS\_IN\_QUEUE
|
678
1026
|
#
|
679
1027
|
# : Unit: COUNT
|
680
1028
|
#
|
1029
|
+
# Name in real-time metrics report: [In queue][9]
|
1030
|
+
#
|
681
1031
|
# CONTACTS\_SCHEDULED
|
682
1032
|
#
|
683
1033
|
# : Unit: COUNT
|
684
1034
|
#
|
1035
|
+
# Name in real-time metrics report: [Scheduled][10]
|
1036
|
+
#
|
685
1037
|
# OLDEST\_CONTACT\_AGE
|
686
1038
|
#
|
687
1039
|
# : Unit: SECONDS
|
688
1040
|
#
|
1041
|
+
# When you use groupings, Unit says SECONDS but the Value is returned
|
1042
|
+
# in MILLISECONDS. For example, if you get a response like this:
|
1043
|
+
#
|
1044
|
+
# `\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" \},
|
1045
|
+
# "Value": 24113.0 `\\}
|
1046
|
+
#
|
1047
|
+
# The actual OLDEST\_CONTACT\_AGE is 24 seconds.
|
1048
|
+
#
|
1049
|
+
# Name in real-time metrics report: [Oldest][11]
|
1050
|
+
#
|
689
1051
|
# SLOTS\_ACTIVE
|
690
1052
|
#
|
691
1053
|
# : Unit: COUNT
|
692
1054
|
#
|
1055
|
+
# Name in real-time metrics report: [Active][12]
|
1056
|
+
#
|
693
1057
|
# SLOTS\_AVAILABLE
|
694
1058
|
#
|
695
1059
|
# : Unit: COUNT
|
696
1060
|
#
|
1061
|
+
# Name in real-time metrics report: [Availability][13]
|
1062
|
+
#
|
697
1063
|
#
|
698
1064
|
#
|
699
1065
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
1066
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time
|
1067
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time
|
1068
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time
|
1069
|
+
# [5]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time
|
1070
|
+
# [6]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time
|
1071
|
+
# [7]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time
|
1072
|
+
# [8]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time
|
1073
|
+
# [9]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time
|
1074
|
+
# [10]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time
|
1075
|
+
# [11]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time
|
1076
|
+
# [12]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time
|
1077
|
+
# [13]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time
|
700
1078
|
#
|
701
1079
|
# @option params [String] :next_token
|
702
1080
|
# The token for the next set of results. Use the value returned in the
|
@@ -793,12 +1171,12 @@ module Aws::Connect
|
|
793
1171
|
# Gets historical metric data from the specified Amazon Connect
|
794
1172
|
# instance.
|
795
1173
|
#
|
796
|
-
# For
|
797
|
-
# *Amazon Connect Administrator Guide*.
|
1174
|
+
# For a description of each historical metric, see [Historical Metrics
|
1175
|
+
# Definitions][1] in the *Amazon Connect Administrator Guide*.
|
798
1176
|
#
|
799
1177
|
#
|
800
1178
|
#
|
801
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics.html
|
1179
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
802
1180
|
#
|
803
1181
|
# @option params [required, String] :instance_id
|
804
1182
|
# The identifier of the Amazon Connect instance.
|
@@ -825,8 +1203,8 @@ module Aws::Connect
|
|
825
1203
|
# The queues, up to 100, or channels, to use to filter the metrics
|
826
1204
|
# returned. Metric data is retrieved only for the resources associated
|
827
1205
|
# with the queues or channels included in the filter. You can include
|
828
|
-
# both queue IDs and queue ARNs in the same request.
|
829
|
-
#
|
1206
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
1207
|
+
# `CHAT` channels are supported.
|
830
1208
|
#
|
831
1209
|
# @option params [Array<String>] :groupings
|
832
1210
|
# The grouping applied to the metrics returned. For example, when
|
@@ -1071,6 +1449,17 @@ module Aws::Connect
|
|
1071
1449
|
# Provides information about the contact flows for the specified Amazon
|
1072
1450
|
# Connect instance.
|
1073
1451
|
#
|
1452
|
+
# You can also create and update contact flows using the [Amazon Connect
|
1453
|
+
# Flow language][1].
|
1454
|
+
#
|
1455
|
+
# For more information about contact flows, see [Contact Flows][2] in
|
1456
|
+
# the *Amazon Connect Administrator Guide*.
|
1457
|
+
#
|
1458
|
+
#
|
1459
|
+
#
|
1460
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
1461
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html
|
1462
|
+
#
|
1074
1463
|
# @option params [required, String] :instance_id
|
1075
1464
|
# The identifier of the Amazon Connect instance.
|
1076
1465
|
#
|
@@ -1122,6 +1511,13 @@ module Aws::Connect
|
|
1122
1511
|
# Provides information about the hours of operation for the specified
|
1123
1512
|
# Amazon Connect instance.
|
1124
1513
|
#
|
1514
|
+
# For more information about hours of operation, see [Set the Hours of
|
1515
|
+
# Operation for a Queue][1] in the *Amazon Connect Administrator Guide*.
|
1516
|
+
#
|
1517
|
+
#
|
1518
|
+
#
|
1519
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html
|
1520
|
+
#
|
1125
1521
|
# @option params [required, String] :instance_id
|
1126
1522
|
# The identifier of the Amazon Connect instance.
|
1127
1523
|
#
|
@@ -1168,6 +1564,14 @@ module Aws::Connect
|
|
1168
1564
|
# Provides information about the phone numbers for the specified Amazon
|
1169
1565
|
# Connect instance.
|
1170
1566
|
#
|
1567
|
+
# For more information about phone numbers, see [Set Up Phone Numbers
|
1568
|
+
# for Your Contact Center][1] in the *Amazon Connect Administrator
|
1569
|
+
# Guide*.
|
1570
|
+
#
|
1571
|
+
#
|
1572
|
+
#
|
1573
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
|
1574
|
+
#
|
1171
1575
|
# @option params [required, String] :instance_id
|
1172
1576
|
# The identifier of the Amazon Connect instance.
|
1173
1577
|
#
|
@@ -1221,9 +1625,62 @@ module Aws::Connect
|
|
1221
1625
|
req.send_request(options)
|
1222
1626
|
end
|
1223
1627
|
|
1628
|
+
# Provides information about the prompts for the specified Amazon
|
1629
|
+
# Connect instance.
|
1630
|
+
#
|
1631
|
+
# @option params [required, String] :instance_id
|
1632
|
+
# The identifier of the Amazon Connect instance.
|
1633
|
+
#
|
1634
|
+
# @option params [String] :next_token
|
1635
|
+
# The token for the next set of results. Use the value returned in the
|
1636
|
+
# previous response in the next request to retrieve the next set of
|
1637
|
+
# results.
|
1638
|
+
#
|
1639
|
+
# @option params [Integer] :max_results
|
1640
|
+
# The maximum number of results to return per page.
|
1641
|
+
#
|
1642
|
+
# @return [Types::ListPromptsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1643
|
+
#
|
1644
|
+
# * {Types::ListPromptsResponse#prompt_summary_list #prompt_summary_list} => Array<Types::PromptSummary>
|
1645
|
+
# * {Types::ListPromptsResponse#next_token #next_token} => String
|
1646
|
+
#
|
1647
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1648
|
+
#
|
1649
|
+
# @example Request syntax with placeholder values
|
1650
|
+
#
|
1651
|
+
# resp = client.list_prompts({
|
1652
|
+
# instance_id: "InstanceId", # required
|
1653
|
+
# next_token: "NextToken",
|
1654
|
+
# max_results: 1,
|
1655
|
+
# })
|
1656
|
+
#
|
1657
|
+
# @example Response structure
|
1658
|
+
#
|
1659
|
+
# resp.prompt_summary_list #=> Array
|
1660
|
+
# resp.prompt_summary_list[0].id #=> String
|
1661
|
+
# resp.prompt_summary_list[0].arn #=> String
|
1662
|
+
# resp.prompt_summary_list[0].name #=> String
|
1663
|
+
# resp.next_token #=> String
|
1664
|
+
#
|
1665
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPrompts AWS API Documentation
|
1666
|
+
#
|
1667
|
+
# @overload list_prompts(params = {})
|
1668
|
+
# @param [Hash] params ({})
|
1669
|
+
def list_prompts(params = {}, options = {})
|
1670
|
+
req = build_request(:list_prompts, params)
|
1671
|
+
req.send_request(options)
|
1672
|
+
end
|
1673
|
+
|
1224
1674
|
# Provides information about the queues for the specified Amazon Connect
|
1225
1675
|
# instance.
|
1226
1676
|
#
|
1677
|
+
# For more information about queues, see [Queues: Standard and Agent][1]
|
1678
|
+
# in the *Amazon Connect Administrator Guide*.
|
1679
|
+
#
|
1680
|
+
#
|
1681
|
+
#
|
1682
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html
|
1683
|
+
#
|
1227
1684
|
# @option params [required, String] :instance_id
|
1228
1685
|
# The identifier of the Amazon Connect instance.
|
1229
1686
|
#
|
@@ -1272,9 +1729,70 @@ module Aws::Connect
|
|
1272
1729
|
req.send_request(options)
|
1273
1730
|
end
|
1274
1731
|
|
1732
|
+
# List the queues associated with a routing profile.
|
1733
|
+
#
|
1734
|
+
# @option params [required, String] :instance_id
|
1735
|
+
# The identifier of the Amazon Connect instance.
|
1736
|
+
#
|
1737
|
+
# @option params [required, String] :routing_profile_id
|
1738
|
+
# The identifier of the routing profile.
|
1739
|
+
#
|
1740
|
+
# @option params [String] :next_token
|
1741
|
+
# The token for the next set of results. Use the value returned in the
|
1742
|
+
# previous response in the next request to retrieve the next set of
|
1743
|
+
# results.
|
1744
|
+
#
|
1745
|
+
# @option params [Integer] :max_results
|
1746
|
+
# The maximimum number of results to return per page.
|
1747
|
+
#
|
1748
|
+
# @return [Types::ListRoutingProfileQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1749
|
+
#
|
1750
|
+
# * {Types::ListRoutingProfileQueuesResponse#next_token #next_token} => String
|
1751
|
+
# * {Types::ListRoutingProfileQueuesResponse#routing_profile_queue_config_summary_list #routing_profile_queue_config_summary_list} => Array<Types::RoutingProfileQueueConfigSummary>
|
1752
|
+
#
|
1753
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1754
|
+
#
|
1755
|
+
# @example Request syntax with placeholder values
|
1756
|
+
#
|
1757
|
+
# resp = client.list_routing_profile_queues({
|
1758
|
+
# instance_id: "InstanceId", # required
|
1759
|
+
# routing_profile_id: "RoutingProfileId", # required
|
1760
|
+
# next_token: "NextToken",
|
1761
|
+
# max_results: 1,
|
1762
|
+
# })
|
1763
|
+
#
|
1764
|
+
# @example Response structure
|
1765
|
+
#
|
1766
|
+
# resp.next_token #=> String
|
1767
|
+
# resp.routing_profile_queue_config_summary_list #=> Array
|
1768
|
+
# resp.routing_profile_queue_config_summary_list[0].queue_id #=> String
|
1769
|
+
# resp.routing_profile_queue_config_summary_list[0].queue_arn #=> String
|
1770
|
+
# resp.routing_profile_queue_config_summary_list[0].queue_name #=> String
|
1771
|
+
# resp.routing_profile_queue_config_summary_list[0].priority #=> Integer
|
1772
|
+
# resp.routing_profile_queue_config_summary_list[0].delay #=> Integer
|
1773
|
+
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT"
|
1774
|
+
#
|
1775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueues AWS API Documentation
|
1776
|
+
#
|
1777
|
+
# @overload list_routing_profile_queues(params = {})
|
1778
|
+
# @param [Hash] params ({})
|
1779
|
+
def list_routing_profile_queues(params = {}, options = {})
|
1780
|
+
req = build_request(:list_routing_profile_queues, params)
|
1781
|
+
req.send_request(options)
|
1782
|
+
end
|
1783
|
+
|
1275
1784
|
# Provides summary information about the routing profiles for the
|
1276
1785
|
# specified Amazon Connect instance.
|
1277
1786
|
#
|
1787
|
+
# For more information about routing profiles, see [Routing Profiles][1]
|
1788
|
+
# and [Create a Routing Profile][2] in the *Amazon Connect Administrator
|
1789
|
+
# Guide*.
|
1790
|
+
#
|
1791
|
+
#
|
1792
|
+
#
|
1793
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html
|
1794
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html
|
1795
|
+
#
|
1278
1796
|
# @option params [required, String] :instance_id
|
1279
1797
|
# The identifier of the Amazon Connect instance.
|
1280
1798
|
#
|
@@ -1321,6 +1839,13 @@ module Aws::Connect
|
|
1321
1839
|
# Provides summary information about the security profiles for the
|
1322
1840
|
# specified Amazon Connect instance.
|
1323
1841
|
#
|
1842
|
+
# For more information about security profiles, see [Security
|
1843
|
+
# Profiles][1] in the *Amazon Connect Administrator Guide*.
|
1844
|
+
#
|
1845
|
+
#
|
1846
|
+
#
|
1847
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
|
1848
|
+
#
|
1324
1849
|
# @option params [required, String] :instance_id
|
1325
1850
|
# The identifier of the Amazon Connect instance.
|
1326
1851
|
#
|
@@ -1366,6 +1891,13 @@ module Aws::Connect
|
|
1366
1891
|
|
1367
1892
|
# Lists the tags for the specified resource.
|
1368
1893
|
#
|
1894
|
+
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
1895
|
+
# Policy Examples][1] in the *Amazon Connect Administrator Guide*.
|
1896
|
+
#
|
1897
|
+
#
|
1898
|
+
#
|
1899
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
|
1900
|
+
#
|
1369
1901
|
# @option params [required, String] :resource_arn
|
1370
1902
|
# The Amazon Resource Name (ARN) of the resource.
|
1371
1903
|
#
|
@@ -1396,6 +1928,13 @@ module Aws::Connect
|
|
1396
1928
|
# Provides summary information about the hierarchy groups for the
|
1397
1929
|
# specified Amazon Connect instance.
|
1398
1930
|
#
|
1931
|
+
# For more information about agent hierarchies, see [Set Up Agent
|
1932
|
+
# Hierarchies][1] in the *Amazon Connect Administrator Guide*.
|
1933
|
+
#
|
1934
|
+
#
|
1935
|
+
#
|
1936
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html
|
1937
|
+
#
|
1399
1938
|
# @option params [required, String] :instance_id
|
1400
1939
|
# The identifier of the Amazon Connect instance.
|
1401
1940
|
#
|
@@ -1530,15 +2069,35 @@ module Aws::Connect
|
|
1530
2069
|
# [CreateParticipantConnection][1] with WEBSOCKET and
|
1531
2070
|
# CONNECTION\_CREDENTIALS.
|
1532
2071
|
#
|
2072
|
+
# A 429 error occurs in two situations:
|
2073
|
+
#
|
2074
|
+
# * API rate limit is exceeded. API TPS throttling returns a
|
2075
|
+
# `TooManyRequests` exception from the API Gateway.
|
2076
|
+
#
|
2077
|
+
# * The [quota for concurrent active chats][2] is exceeded. Active chat
|
2078
|
+
# throttling returns a `LimitExceededException`.
|
2079
|
+
#
|
2080
|
+
# For more information about how chat works, see [Chat][3] in the
|
2081
|
+
# *Amazon Connect Administrator Guide*.
|
2082
|
+
#
|
1533
2083
|
#
|
1534
2084
|
#
|
1535
2085
|
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
2086
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
2087
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/chat.html
|
1536
2088
|
#
|
1537
2089
|
# @option params [required, String] :instance_id
|
1538
2090
|
# The identifier of the Amazon Connect instance.
|
1539
2091
|
#
|
1540
2092
|
# @option params [required, String] :contact_flow_id
|
1541
|
-
# The identifier of the contact flow for the chat.
|
2093
|
+
# The identifier of the contact flow for initiating the chat. To see the
|
2094
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
2095
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
2096
|
+
# contact flow. On the contact flow page, under the name of the contact
|
2097
|
+
# flow, choose **Show additional flow information**. The ContactFlowId
|
2098
|
+
# is the last part of the ARN, shown here in bold:
|
2099
|
+
#
|
2100
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
1542
2101
|
#
|
1543
2102
|
# @option params [Hash<String,String>] :attributes
|
1544
2103
|
# A custom key-value pair using an attribute map. The attributes are
|
@@ -1665,11 +2224,29 @@ module Aws::Connect
|
|
1665
2224
|
# There is a 60 second dialing timeout for this operation. If the call
|
1666
2225
|
# is not connected after 60 seconds, it fails.
|
1667
2226
|
#
|
2227
|
+
# <note markdown="1"> UK numbers with a 447 prefix are not allowed by default. Before you
|
2228
|
+
# can dial these UK mobile numbers, you must submit a service quota
|
2229
|
+
# increase request. For more information, see [Amazon Connect Service
|
2230
|
+
# Quotas][1] in the *Amazon Connect Administrator Guide*.
|
2231
|
+
#
|
2232
|
+
# </note>
|
2233
|
+
#
|
2234
|
+
#
|
2235
|
+
#
|
2236
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
2237
|
+
#
|
1668
2238
|
# @option params [required, String] :destination_phone_number
|
1669
2239
|
# The phone number of the customer, in E.164 format.
|
1670
2240
|
#
|
1671
2241
|
# @option params [required, String] :contact_flow_id
|
1672
|
-
# The identifier of the contact flow for the outbound call.
|
2242
|
+
# The identifier of the contact flow for the outbound call. To see the
|
2243
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
2244
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
2245
|
+
# contact flow. On the contact flow page, under the name of the contact
|
2246
|
+
# flow, choose **Show additional flow information**. The ContactFlowId
|
2247
|
+
# is the last part of the ARN, shown here in bold:
|
2248
|
+
#
|
2249
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
1673
2250
|
#
|
1674
2251
|
# @option params [required, String] :instance_id
|
1675
2252
|
# The identifier of the Amazon Connect instance.
|
@@ -1840,7 +2417,15 @@ module Aws::Connect
|
|
1840
2417
|
|
1841
2418
|
# Adds the specified tags to the specified resource.
|
1842
2419
|
#
|
1843
|
-
# The supported resource
|
2420
|
+
# The supported resource types are users, routing profiles, and contact
|
2421
|
+
# flows.
|
2422
|
+
#
|
2423
|
+
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
2424
|
+
# Policy Examples][1] in the *Amazon Connect Administrator Guide*.
|
2425
|
+
#
|
2426
|
+
#
|
2427
|
+
#
|
2428
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
|
1844
2429
|
#
|
1845
2430
|
# @option params [required, String] :resource_arn
|
1846
2431
|
# The Amazon Resource Name (ARN) of the resource.
|
@@ -1911,6 +2496,9 @@ module Aws::Connect
|
|
1911
2496
|
# Contact attributes are available in Amazon Connect for 24 months, and
|
1912
2497
|
# are then deleted.
|
1913
2498
|
#
|
2499
|
+
# This operation is also available in the Amazon Connect Flow language.
|
2500
|
+
# See [UpdateContactAttributes][1].
|
2501
|
+
#
|
1914
2502
|
# **Important:** You cannot use the operation to update attributes for
|
1915
2503
|
# contacts that occurred prior to the release of the API, September 12,
|
1916
2504
|
# 2018. You can update attributes only for contacts that started after
|
@@ -1919,6 +2507,10 @@ module Aws::Connect
|
|
1919
2507
|
# returned. This applies also to queued callbacks that were initiated
|
1920
2508
|
# prior to the release of the API but are still active in your instance.
|
1921
2509
|
#
|
2510
|
+
#
|
2511
|
+
#
|
2512
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-actions-updatecontactattributes.html
|
2513
|
+
#
|
1922
2514
|
# @option params [required, String] :initial_contact_id
|
1923
2515
|
# The identifier of the contact. This is the identifier of the contact
|
1924
2516
|
# associated with the first interaction with the contact center.
|
@@ -1955,6 +2547,226 @@ module Aws::Connect
|
|
1955
2547
|
req.send_request(options)
|
1956
2548
|
end
|
1957
2549
|
|
2550
|
+
# Updates the specified contact flow.
|
2551
|
+
#
|
2552
|
+
# You can also create and update contact flows using the [Amazon Connect
|
2553
|
+
# Flow language][1].
|
2554
|
+
#
|
2555
|
+
#
|
2556
|
+
#
|
2557
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
2558
|
+
#
|
2559
|
+
# @option params [required, String] :instance_id
|
2560
|
+
# The identifier of the Amazon Connect instance.
|
2561
|
+
#
|
2562
|
+
# @option params [required, String] :contact_flow_id
|
2563
|
+
# The identifier of the contact flow.
|
2564
|
+
#
|
2565
|
+
# @option params [required, String] :content
|
2566
|
+
# The JSON string that represents contact flow’s content. For an
|
2567
|
+
# example, see [Example contact flow in Amazon Connect Flow language][1]
|
2568
|
+
# in the *Amazon Connect Administrator Guide*.
|
2569
|
+
#
|
2570
|
+
#
|
2571
|
+
#
|
2572
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language-example.html
|
2573
|
+
#
|
2574
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2575
|
+
#
|
2576
|
+
# @example Request syntax with placeholder values
|
2577
|
+
#
|
2578
|
+
# resp = client.update_contact_flow_content({
|
2579
|
+
# instance_id: "InstanceId", # required
|
2580
|
+
# contact_flow_id: "ContactFlowId", # required
|
2581
|
+
# content: "ContactFlowContent", # required
|
2582
|
+
# })
|
2583
|
+
#
|
2584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowContent AWS API Documentation
|
2585
|
+
#
|
2586
|
+
# @overload update_contact_flow_content(params = {})
|
2587
|
+
# @param [Hash] params ({})
|
2588
|
+
def update_contact_flow_content(params = {}, options = {})
|
2589
|
+
req = build_request(:update_contact_flow_content, params)
|
2590
|
+
req.send_request(options)
|
2591
|
+
end
|
2592
|
+
|
2593
|
+
# The name of the contact flow.
|
2594
|
+
#
|
2595
|
+
# @option params [required, String] :instance_id
|
2596
|
+
# The identifier of the Amazon Connect instance.
|
2597
|
+
#
|
2598
|
+
# @option params [required, String] :contact_flow_id
|
2599
|
+
# The identifier of the contact flow.
|
2600
|
+
#
|
2601
|
+
# @option params [String] :name
|
2602
|
+
# The name of the contact flow.
|
2603
|
+
#
|
2604
|
+
# @option params [String] :description
|
2605
|
+
# The description of the contact flow.
|
2606
|
+
#
|
2607
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2608
|
+
#
|
2609
|
+
# @example Request syntax with placeholder values
|
2610
|
+
#
|
2611
|
+
# resp = client.update_contact_flow_name({
|
2612
|
+
# instance_id: "InstanceId", # required
|
2613
|
+
# contact_flow_id: "ContactFlowId", # required
|
2614
|
+
# name: "ContactFlowName",
|
2615
|
+
# description: "ContactFlowDescription",
|
2616
|
+
# })
|
2617
|
+
#
|
2618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowName AWS API Documentation
|
2619
|
+
#
|
2620
|
+
# @overload update_contact_flow_name(params = {})
|
2621
|
+
# @param [Hash] params ({})
|
2622
|
+
def update_contact_flow_name(params = {}, options = {})
|
2623
|
+
req = build_request(:update_contact_flow_name, params)
|
2624
|
+
req.send_request(options)
|
2625
|
+
end
|
2626
|
+
|
2627
|
+
# Updates the channels that agents can handle in the Contact Control
|
2628
|
+
# Panel (CCP) for a routing profile.
|
2629
|
+
#
|
2630
|
+
# @option params [required, String] :instance_id
|
2631
|
+
# The identifier of the Amazon Connect instance.
|
2632
|
+
#
|
2633
|
+
# @option params [required, String] :routing_profile_id
|
2634
|
+
# The identifier of the routing profile.
|
2635
|
+
#
|
2636
|
+
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
2637
|
+
# The channels agents can handle in the Contact Control Panel (CCP).
|
2638
|
+
#
|
2639
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2640
|
+
#
|
2641
|
+
# @example Request syntax with placeholder values
|
2642
|
+
#
|
2643
|
+
# resp = client.update_routing_profile_concurrency({
|
2644
|
+
# instance_id: "InstanceId", # required
|
2645
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2646
|
+
# media_concurrencies: [ # required
|
2647
|
+
# {
|
2648
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2649
|
+
# concurrency: 1, # required
|
2650
|
+
# },
|
2651
|
+
# ],
|
2652
|
+
# })
|
2653
|
+
#
|
2654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileConcurrency AWS API Documentation
|
2655
|
+
#
|
2656
|
+
# @overload update_routing_profile_concurrency(params = {})
|
2657
|
+
# @param [Hash] params ({})
|
2658
|
+
def update_routing_profile_concurrency(params = {}, options = {})
|
2659
|
+
req = build_request(:update_routing_profile_concurrency, params)
|
2660
|
+
req.send_request(options)
|
2661
|
+
end
|
2662
|
+
|
2663
|
+
# Updates the default outbound queue of a routing profile.
|
2664
|
+
#
|
2665
|
+
# @option params [required, String] :instance_id
|
2666
|
+
# The identifier of the Amazon Connect instance.
|
2667
|
+
#
|
2668
|
+
# @option params [required, String] :routing_profile_id
|
2669
|
+
# The identifier of the routing profile.
|
2670
|
+
#
|
2671
|
+
# @option params [required, String] :default_outbound_queue_id
|
2672
|
+
# The identifier for the default outbound queue.
|
2673
|
+
#
|
2674
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2675
|
+
#
|
2676
|
+
# @example Request syntax with placeholder values
|
2677
|
+
#
|
2678
|
+
# resp = client.update_routing_profile_default_outbound_queue({
|
2679
|
+
# instance_id: "InstanceId", # required
|
2680
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2681
|
+
# default_outbound_queue_id: "QueueId", # required
|
2682
|
+
# })
|
2683
|
+
#
|
2684
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue AWS API Documentation
|
2685
|
+
#
|
2686
|
+
# @overload update_routing_profile_default_outbound_queue(params = {})
|
2687
|
+
# @param [Hash] params ({})
|
2688
|
+
def update_routing_profile_default_outbound_queue(params = {}, options = {})
|
2689
|
+
req = build_request(:update_routing_profile_default_outbound_queue, params)
|
2690
|
+
req.send_request(options)
|
2691
|
+
end
|
2692
|
+
|
2693
|
+
# Updates the name and description of a routing profile. The request
|
2694
|
+
# accepts the following data in JSON format. At least `Name` or
|
2695
|
+
# `Description` must be provided.
|
2696
|
+
#
|
2697
|
+
# @option params [required, String] :instance_id
|
2698
|
+
# The identifier of the Amazon Connect instance.
|
2699
|
+
#
|
2700
|
+
# @option params [required, String] :routing_profile_id
|
2701
|
+
# The identifier of the routing profile.
|
2702
|
+
#
|
2703
|
+
# @option params [String] :name
|
2704
|
+
# The name of the routing profile. Must not be more than 127 characters.
|
2705
|
+
#
|
2706
|
+
# @option params [String] :description
|
2707
|
+
# The description of the routing profile. Must not be more than 250
|
2708
|
+
# characters.
|
2709
|
+
#
|
2710
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2711
|
+
#
|
2712
|
+
# @example Request syntax with placeholder values
|
2713
|
+
#
|
2714
|
+
# resp = client.update_routing_profile_name({
|
2715
|
+
# instance_id: "InstanceId", # required
|
2716
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2717
|
+
# name: "RoutingProfileName",
|
2718
|
+
# description: "RoutingProfileDescription",
|
2719
|
+
# })
|
2720
|
+
#
|
2721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileName AWS API Documentation
|
2722
|
+
#
|
2723
|
+
# @overload update_routing_profile_name(params = {})
|
2724
|
+
# @param [Hash] params ({})
|
2725
|
+
def update_routing_profile_name(params = {}, options = {})
|
2726
|
+
req = build_request(:update_routing_profile_name, params)
|
2727
|
+
req.send_request(options)
|
2728
|
+
end
|
2729
|
+
|
2730
|
+
# Updates the properties associated with a set of queues for a routing
|
2731
|
+
# profile.
|
2732
|
+
#
|
2733
|
+
# @option params [required, String] :instance_id
|
2734
|
+
# The identifier of the Amazon Connect instance.
|
2735
|
+
#
|
2736
|
+
# @option params [required, String] :routing_profile_id
|
2737
|
+
# The identifier of the routing profile.
|
2738
|
+
#
|
2739
|
+
# @option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
2740
|
+
# The queues to be updated for this routing profile.
|
2741
|
+
#
|
2742
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2743
|
+
#
|
2744
|
+
# @example Request syntax with placeholder values
|
2745
|
+
#
|
2746
|
+
# resp = client.update_routing_profile_queues({
|
2747
|
+
# instance_id: "InstanceId", # required
|
2748
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2749
|
+
# queue_configs: [ # required
|
2750
|
+
# {
|
2751
|
+
# queue_reference: { # required
|
2752
|
+
# queue_id: "QueueId", # required
|
2753
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2754
|
+
# },
|
2755
|
+
# priority: 1, # required
|
2756
|
+
# delay: 1, # required
|
2757
|
+
# },
|
2758
|
+
# ],
|
2759
|
+
# })
|
2760
|
+
#
|
2761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileQueues AWS API Documentation
|
2762
|
+
#
|
2763
|
+
# @overload update_routing_profile_queues(params = {})
|
2764
|
+
# @param [Hash] params ({})
|
2765
|
+
def update_routing_profile_queues(params = {}, options = {})
|
2766
|
+
req = build_request(:update_routing_profile_queues, params)
|
2767
|
+
req.send_request(options)
|
2768
|
+
end
|
2769
|
+
|
1958
2770
|
# Assigns the specified hierarchy group to the specified user.
|
1959
2771
|
#
|
1960
2772
|
# @option params [String] :hierarchy_group_id
|
@@ -1987,6 +2799,19 @@ module Aws::Connect
|
|
1987
2799
|
|
1988
2800
|
# Updates the identity information for the specified user.
|
1989
2801
|
#
|
2802
|
+
# Someone with the ability to invoke `UpdateUserIndentityInfo` can
|
2803
|
+
# change the login credentials of other users by changing their email
|
2804
|
+
# address. This poses a security risk to your organization. They can
|
2805
|
+
# change the email address of a user to the attacker's email address,
|
2806
|
+
# and then reset the password through email. We strongly recommend
|
2807
|
+
# limiting who has the ability to invoke `UpdateUserIndentityInfo`. For
|
2808
|
+
# more information, see [Best Practices for Security Profiles][1] in the
|
2809
|
+
# *Amazon Connect Administrator Guide*.
|
2810
|
+
#
|
2811
|
+
#
|
2812
|
+
#
|
2813
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html
|
2814
|
+
#
|
1990
2815
|
# @option params [required, Types::UserIdentityInfo] :identity_info
|
1991
2816
|
# The identity information for the user.
|
1992
2817
|
#
|
@@ -2127,7 +2952,7 @@ module Aws::Connect
|
|
2127
2952
|
params: params,
|
2128
2953
|
config: config)
|
2129
2954
|
context[:gem_name] = 'aws-sdk-connect'
|
2130
|
-
context[:gem_version] = '1.
|
2955
|
+
context[:gem_version] = '1.34.0'
|
2131
2956
|
Seahorse::Client::Request.new(handlers, context)
|
2132
2957
|
end
|
2133
2958
|
|