aws-sdk-connect 1.33.0 → 1.38.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-connect.rb +2 -2
- data/lib/aws-sdk-connect/client.rb +2024 -227
- data/lib/aws-sdk-connect/client_api.rb +1193 -0
- data/lib/aws-sdk-connect/errors.rb +58 -0
- data/lib/aws-sdk-connect/types.rb +3477 -846
- 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: 89ac949afefecb2294f8a044c5ac179bb69531ca4b48bad3c318e95ba90d5936
|
4
|
+
data.tar.gz: f41d2e274130339328cb27118134fb1fced1c43141a60033e0b8524bd383baae
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1f1c89f999c36844615c122834a9b769bfb8140cd903ad40f6b523df6b2027ec84978010510a9d6a408f7047890c73f6c2ec34ccaa35a1d07fdca950b148fd6d
|
7
|
+
data.tar.gz: d479f4fa0641ed397f352caccf1a818da72fb5c966b578016aa35e29fd31c49bc8c6622fc221da3ef4ada18cdd5db9e586cebed339091213a8eb63a825591a76
|
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_approved_origin(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.38.0'
|
52
52
|
|
53
53
|
end
|
@@ -327,6 +327,171 @@ module Aws::Connect
|
|
327
327
|
|
328
328
|
# @!group API Operations
|
329
329
|
|
330
|
+
# This API is in preview release for Amazon Connect and is subject to
|
331
|
+
# change.
|
332
|
+
#
|
333
|
+
# Associates an approved origin to an Amazon Connect instance.
|
334
|
+
#
|
335
|
+
# @option params [required, String] :instance_id
|
336
|
+
# The identifier of the Amazon Connect instance.
|
337
|
+
#
|
338
|
+
# @option params [required, String] :origin
|
339
|
+
# The domain to add to your allow list.
|
340
|
+
#
|
341
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
342
|
+
#
|
343
|
+
# @example Request syntax with placeholder values
|
344
|
+
#
|
345
|
+
# resp = client.associate_approved_origin({
|
346
|
+
# instance_id: "InstanceId", # required
|
347
|
+
# origin: "Origin", # required
|
348
|
+
# })
|
349
|
+
#
|
350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateApprovedOrigin AWS API Documentation
|
351
|
+
#
|
352
|
+
# @overload associate_approved_origin(params = {})
|
353
|
+
# @param [Hash] params ({})
|
354
|
+
def associate_approved_origin(params = {}, options = {})
|
355
|
+
req = build_request(:associate_approved_origin, params)
|
356
|
+
req.send_request(options)
|
357
|
+
end
|
358
|
+
|
359
|
+
# This API is in preview release for Amazon Connect and is subject to
|
360
|
+
# change.
|
361
|
+
#
|
362
|
+
# Associates a storage resource type for the first time. You can only
|
363
|
+
# associate one type of storage configuration in a single call. This
|
364
|
+
# means, for example, that you can't define an instance with multiple
|
365
|
+
# S3 buckets for storing chat transcripts.
|
366
|
+
#
|
367
|
+
# This API does not create a resource that doesn't exist. It only
|
368
|
+
# associates it to the instance. Ensure that the resource being
|
369
|
+
# specified in the storage configuration, like an Amazon S3 bucket,
|
370
|
+
# exists when being used for association.
|
371
|
+
#
|
372
|
+
# @option params [required, String] :instance_id
|
373
|
+
# The identifier of the Amazon Connect instance.
|
374
|
+
#
|
375
|
+
# @option params [required, String] :resource_type
|
376
|
+
# A valid resource type.
|
377
|
+
#
|
378
|
+
# @option params [required, Types::InstanceStorageConfig] :storage_config
|
379
|
+
# A valid storage type.
|
380
|
+
#
|
381
|
+
# @return [Types::AssociateInstanceStorageConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
382
|
+
#
|
383
|
+
# * {Types::AssociateInstanceStorageConfigResponse#association_id #association_id} => String
|
384
|
+
#
|
385
|
+
# @example Request syntax with placeholder values
|
386
|
+
#
|
387
|
+
# resp = client.associate_instance_storage_config({
|
388
|
+
# instance_id: "InstanceId", # required
|
389
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
390
|
+
# storage_config: { # required
|
391
|
+
# association_id: "AssociationId",
|
392
|
+
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
393
|
+
# s3_config: {
|
394
|
+
# bucket_name: "BucketName", # required
|
395
|
+
# bucket_prefix: "Prefix", # required
|
396
|
+
# encryption_config: {
|
397
|
+
# encryption_type: "KMS", # required, accepts KMS
|
398
|
+
# key_id: "KeyId", # required
|
399
|
+
# },
|
400
|
+
# },
|
401
|
+
# kinesis_video_stream_config: {
|
402
|
+
# prefix: "Prefix", # required
|
403
|
+
# retention_period_hours: 1, # required
|
404
|
+
# encryption_config: { # required
|
405
|
+
# encryption_type: "KMS", # required, accepts KMS
|
406
|
+
# key_id: "KeyId", # required
|
407
|
+
# },
|
408
|
+
# },
|
409
|
+
# kinesis_stream_config: {
|
410
|
+
# stream_arn: "ARN", # required
|
411
|
+
# },
|
412
|
+
# kinesis_firehose_config: {
|
413
|
+
# firehose_arn: "ARN", # required
|
414
|
+
# },
|
415
|
+
# },
|
416
|
+
# })
|
417
|
+
#
|
418
|
+
# @example Response structure
|
419
|
+
#
|
420
|
+
# resp.association_id #=> String
|
421
|
+
#
|
422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateInstanceStorageConfig AWS API Documentation
|
423
|
+
#
|
424
|
+
# @overload associate_instance_storage_config(params = {})
|
425
|
+
# @param [Hash] params ({})
|
426
|
+
def associate_instance_storage_config(params = {}, options = {})
|
427
|
+
req = build_request(:associate_instance_storage_config, params)
|
428
|
+
req.send_request(options)
|
429
|
+
end
|
430
|
+
|
431
|
+
# This API is in preview release for Amazon Connect and is subject to
|
432
|
+
# change.
|
433
|
+
#
|
434
|
+
# Allows the specified Amazon Connect instance to access the specified
|
435
|
+
# Lambda function.
|
436
|
+
#
|
437
|
+
# @option params [required, String] :instance_id
|
438
|
+
# The identifier of the Amazon Connect instance.
|
439
|
+
#
|
440
|
+
# @option params [required, String] :function_arn
|
441
|
+
# The Amazon Resource Name (ARN) for the Lambda function being
|
442
|
+
# associated. Maximum number of characters allowed is 140.
|
443
|
+
#
|
444
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
445
|
+
#
|
446
|
+
# @example Request syntax with placeholder values
|
447
|
+
#
|
448
|
+
# resp = client.associate_lambda_function({
|
449
|
+
# instance_id: "InstanceId", # required
|
450
|
+
# function_arn: "FunctionArn", # required
|
451
|
+
# })
|
452
|
+
#
|
453
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateLambdaFunction AWS API Documentation
|
454
|
+
#
|
455
|
+
# @overload associate_lambda_function(params = {})
|
456
|
+
# @param [Hash] params ({})
|
457
|
+
def associate_lambda_function(params = {}, options = {})
|
458
|
+
req = build_request(:associate_lambda_function, params)
|
459
|
+
req.send_request(options)
|
460
|
+
end
|
461
|
+
|
462
|
+
# This API is in preview release for Amazon Connect and is subject to
|
463
|
+
# change.
|
464
|
+
#
|
465
|
+
# Allows the specified Amazon Connect instance to access the specified
|
466
|
+
# Amazon Lex bot.
|
467
|
+
#
|
468
|
+
# @option params [required, String] :instance_id
|
469
|
+
# The identifier of the Amazon Connect instance.
|
470
|
+
#
|
471
|
+
# @option params [required, Types::LexBot] :lex_bot
|
472
|
+
# The Amazon Lex box to associate with the instance.
|
473
|
+
#
|
474
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
475
|
+
#
|
476
|
+
# @example Request syntax with placeholder values
|
477
|
+
#
|
478
|
+
# resp = client.associate_lex_bot({
|
479
|
+
# instance_id: "InstanceId", # required
|
480
|
+
# lex_bot: { # required
|
481
|
+
# name: "BotName",
|
482
|
+
# lex_region: "LexRegion",
|
483
|
+
# },
|
484
|
+
# })
|
485
|
+
#
|
486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateLexBot AWS API Documentation
|
487
|
+
#
|
488
|
+
# @overload associate_lex_bot(params = {})
|
489
|
+
# @param [Hash] params ({})
|
490
|
+
def associate_lex_bot(params = {}, options = {})
|
491
|
+
req = build_request(:associate_lex_bot, params)
|
492
|
+
req.send_request(options)
|
493
|
+
end
|
494
|
+
|
330
495
|
# Associates a set of queues with a routing profile.
|
331
496
|
#
|
332
497
|
# @option params [required, String] :instance_id
|
@@ -349,7 +514,7 @@ module Aws::Connect
|
|
349
514
|
# {
|
350
515
|
# queue_reference: { # required
|
351
516
|
# queue_id: "QueueId", # required
|
352
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
517
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
353
518
|
# },
|
354
519
|
# priority: 1, # required
|
355
520
|
# delay: 1, # required
|
@@ -366,6 +531,41 @@ module Aws::Connect
|
|
366
531
|
req.send_request(options)
|
367
532
|
end
|
368
533
|
|
534
|
+
# This API is in preview release for Amazon Connect and is subject to
|
535
|
+
# change.
|
536
|
+
#
|
537
|
+
# Associates a security key to the instance.
|
538
|
+
#
|
539
|
+
# @option params [required, String] :instance_id
|
540
|
+
# The identifier of the Amazon Connect instance.
|
541
|
+
#
|
542
|
+
# @option params [required, String] :key
|
543
|
+
# A valid security key in PEM format.
|
544
|
+
#
|
545
|
+
# @return [Types::AssociateSecurityKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
546
|
+
#
|
547
|
+
# * {Types::AssociateSecurityKeyResponse#association_id #association_id} => String
|
548
|
+
#
|
549
|
+
# @example Request syntax with placeholder values
|
550
|
+
#
|
551
|
+
# resp = client.associate_security_key({
|
552
|
+
# instance_id: "InstanceId", # required
|
553
|
+
# key: "PEM", # required
|
554
|
+
# })
|
555
|
+
#
|
556
|
+
# @example Response structure
|
557
|
+
#
|
558
|
+
# resp.association_id #=> String
|
559
|
+
#
|
560
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateSecurityKey AWS API Documentation
|
561
|
+
#
|
562
|
+
# @overload associate_security_key(params = {})
|
563
|
+
# @param [Hash] params ({})
|
564
|
+
def associate_security_key(params = {}, options = {})
|
565
|
+
req = build_request(:associate_security_key, params)
|
566
|
+
req.send_request(options)
|
567
|
+
end
|
568
|
+
|
369
569
|
# Creates a contact flow for the specified Amazon Connect instance.
|
370
570
|
#
|
371
571
|
# You can also create and update contact flows using the [Amazon Connect
|
@@ -431,6 +631,179 @@ module Aws::Connect
|
|
431
631
|
req.send_request(options)
|
432
632
|
end
|
433
633
|
|
634
|
+
# This API is in preview release for Amazon Connect and is subject to
|
635
|
+
# change.
|
636
|
+
#
|
637
|
+
# Initiates an Amazon Connect instance with all the supported channels
|
638
|
+
# enabled. It does not attach any storage (such as Amazon S3, or
|
639
|
+
# Kinesis) or allow for any configurations on features such as Contact
|
640
|
+
# Lens for Amazon Connect.
|
641
|
+
#
|
642
|
+
# @option params [String] :client_token
|
643
|
+
# The idempotency token.
|
644
|
+
#
|
645
|
+
# @option params [required, String] :identity_management_type
|
646
|
+
# The type of identity management for your Amazon Connect users.
|
647
|
+
#
|
648
|
+
# @option params [String] :instance_alias
|
649
|
+
# The name for your instance.
|
650
|
+
#
|
651
|
+
# @option params [String] :directory_id
|
652
|
+
# The identifier for the directory.
|
653
|
+
#
|
654
|
+
# @option params [required, Boolean] :inbound_calls_enabled
|
655
|
+
# Whether your contact center handles incoming contacts.
|
656
|
+
#
|
657
|
+
# @option params [required, Boolean] :outbound_calls_enabled
|
658
|
+
# Whether your contact center allows outbound calls.
|
659
|
+
#
|
660
|
+
# @return [Types::CreateInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
661
|
+
#
|
662
|
+
# * {Types::CreateInstanceResponse#id #id} => String
|
663
|
+
# * {Types::CreateInstanceResponse#arn #arn} => String
|
664
|
+
#
|
665
|
+
# @example Request syntax with placeholder values
|
666
|
+
#
|
667
|
+
# resp = client.create_instance({
|
668
|
+
# client_token: "ClientToken",
|
669
|
+
# identity_management_type: "SAML", # required, accepts SAML, CONNECT_MANAGED, EXISTING_DIRECTORY
|
670
|
+
# instance_alias: "DirectoryAlias",
|
671
|
+
# directory_id: "DirectoryId",
|
672
|
+
# inbound_calls_enabled: false, # required
|
673
|
+
# outbound_calls_enabled: false, # required
|
674
|
+
# })
|
675
|
+
#
|
676
|
+
# @example Response structure
|
677
|
+
#
|
678
|
+
# resp.id #=> String
|
679
|
+
# resp.arn #=> String
|
680
|
+
#
|
681
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateInstance AWS API Documentation
|
682
|
+
#
|
683
|
+
# @overload create_instance(params = {})
|
684
|
+
# @param [Hash] params ({})
|
685
|
+
def create_instance(params = {}, options = {})
|
686
|
+
req = build_request(:create_instance, params)
|
687
|
+
req.send_request(options)
|
688
|
+
end
|
689
|
+
|
690
|
+
# This API is in preview release for Amazon Connect and is subject to
|
691
|
+
# change.
|
692
|
+
#
|
693
|
+
# Create an AppIntegration association with an Amazon Connect instance.
|
694
|
+
#
|
695
|
+
# @option params [required, String] :instance_id
|
696
|
+
# The identifier of the Amazon Connect instance.
|
697
|
+
#
|
698
|
+
# @option params [required, String] :integration_type
|
699
|
+
# The type of information to be ingested.
|
700
|
+
#
|
701
|
+
# @option params [required, String] :integration_arn
|
702
|
+
# The Amazon Resource Name (ARN) of the integration.
|
703
|
+
#
|
704
|
+
# @option params [required, String] :source_application_url
|
705
|
+
# The URL for the external application.
|
706
|
+
#
|
707
|
+
# @option params [required, String] :source_application_name
|
708
|
+
# The name of the external application.
|
709
|
+
#
|
710
|
+
# @option params [required, String] :source_type
|
711
|
+
# The type of the data source.
|
712
|
+
#
|
713
|
+
# @return [Types::CreateIntegrationAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
714
|
+
#
|
715
|
+
# * {Types::CreateIntegrationAssociationResponse#integration_association_id #integration_association_id} => String
|
716
|
+
# * {Types::CreateIntegrationAssociationResponse#integration_association_arn #integration_association_arn} => String
|
717
|
+
#
|
718
|
+
# @example Request syntax with placeholder values
|
719
|
+
#
|
720
|
+
# resp = client.create_integration_association({
|
721
|
+
# instance_id: "InstanceId", # required
|
722
|
+
# integration_type: "EVENT", # required, accepts EVENT
|
723
|
+
# integration_arn: "ARN", # required
|
724
|
+
# source_application_url: "URI", # required
|
725
|
+
# source_application_name: "SourceApplicationName", # required
|
726
|
+
# source_type: "SALESFORCE", # required, accepts SALESFORCE, ZENDESK
|
727
|
+
# })
|
728
|
+
#
|
729
|
+
# @example Response structure
|
730
|
+
#
|
731
|
+
# resp.integration_association_id #=> String
|
732
|
+
# resp.integration_association_arn #=> String
|
733
|
+
#
|
734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateIntegrationAssociation AWS API Documentation
|
735
|
+
#
|
736
|
+
# @overload create_integration_association(params = {})
|
737
|
+
# @param [Hash] params ({})
|
738
|
+
def create_integration_association(params = {}, options = {})
|
739
|
+
req = build_request(:create_integration_association, params)
|
740
|
+
req.send_request(options)
|
741
|
+
end
|
742
|
+
|
743
|
+
# This API is in preview release for Amazon Connect and is subject to
|
744
|
+
# change.
|
745
|
+
#
|
746
|
+
# Creates a quick connect for the specified Amazon Connect instance.
|
747
|
+
#
|
748
|
+
# @option params [required, String] :instance_id
|
749
|
+
# The identifier of the Amazon Connect instance.
|
750
|
+
#
|
751
|
+
# @option params [required, String] :name
|
752
|
+
# The name of the quick connect.
|
753
|
+
#
|
754
|
+
# @option params [String] :description
|
755
|
+
# The description of the quick connect.
|
756
|
+
#
|
757
|
+
# @option params [required, Types::QuickConnectConfig] :quick_connect_config
|
758
|
+
# Configuration settings for the quick connect.
|
759
|
+
#
|
760
|
+
# @option params [Hash<String,String>] :tags
|
761
|
+
# One or more tags.
|
762
|
+
#
|
763
|
+
# @return [Types::CreateQuickConnectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
764
|
+
#
|
765
|
+
# * {Types::CreateQuickConnectResponse#quick_connect_arn #quick_connect_arn} => String
|
766
|
+
# * {Types::CreateQuickConnectResponse#quick_connect_id #quick_connect_id} => String
|
767
|
+
#
|
768
|
+
# @example Request syntax with placeholder values
|
769
|
+
#
|
770
|
+
# resp = client.create_quick_connect({
|
771
|
+
# instance_id: "InstanceId", # required
|
772
|
+
# name: "QuickConnectName", # required
|
773
|
+
# description: "QuickConnectDescription",
|
774
|
+
# quick_connect_config: { # required
|
775
|
+
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
776
|
+
# user_config: {
|
777
|
+
# user_id: "UserId", # required
|
778
|
+
# contact_flow_id: "ContactFlowId", # required
|
779
|
+
# },
|
780
|
+
# queue_config: {
|
781
|
+
# queue_id: "QueueId", # required
|
782
|
+
# contact_flow_id: "ContactFlowId", # required
|
783
|
+
# },
|
784
|
+
# phone_config: {
|
785
|
+
# phone_number: "PhoneNumber", # required
|
786
|
+
# },
|
787
|
+
# },
|
788
|
+
# tags: {
|
789
|
+
# "TagKey" => "TagValue",
|
790
|
+
# },
|
791
|
+
# })
|
792
|
+
#
|
793
|
+
# @example Response structure
|
794
|
+
#
|
795
|
+
# resp.quick_connect_arn #=> String
|
796
|
+
# resp.quick_connect_id #=> String
|
797
|
+
#
|
798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQuickConnect AWS API Documentation
|
799
|
+
#
|
800
|
+
# @overload create_quick_connect(params = {})
|
801
|
+
# @param [Hash] params ({})
|
802
|
+
def create_quick_connect(params = {}, options = {})
|
803
|
+
req = build_request(:create_quick_connect, params)
|
804
|
+
req.send_request(options)
|
805
|
+
end
|
806
|
+
|
434
807
|
# Creates a new routing profile.
|
435
808
|
#
|
436
809
|
# @option params [required, String] :instance_id
|
@@ -473,7 +846,7 @@ module Aws::Connect
|
|
473
846
|
# {
|
474
847
|
# queue_reference: { # required
|
475
848
|
# queue_id: "QueueId", # required
|
476
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
849
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
477
850
|
# },
|
478
851
|
# priority: 1, # required
|
479
852
|
# delay: 1, # required
|
@@ -481,7 +854,7 @@ module Aws::Connect
|
|
481
854
|
# ],
|
482
855
|
# media_concurrencies: [ # required
|
483
856
|
# {
|
484
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
857
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
485
858
|
# concurrency: 1, # required
|
486
859
|
# },
|
487
860
|
# ],
|
@@ -504,6 +877,49 @@ module Aws::Connect
|
|
504
877
|
req.send_request(options)
|
505
878
|
end
|
506
879
|
|
880
|
+
# This API is in preview release for Amazon Connect and is subject to
|
881
|
+
# change.
|
882
|
+
#
|
883
|
+
# Creates a use case for an AppIntegration association.
|
884
|
+
#
|
885
|
+
# @option params [required, String] :instance_id
|
886
|
+
# The identifier of the Amazon Connect instance.
|
887
|
+
#
|
888
|
+
# @option params [required, String] :integration_association_id
|
889
|
+
# The identifier for the AppIntegration association.
|
890
|
+
#
|
891
|
+
# @option params [required, String] :use_case_type
|
892
|
+
# The type of use case to associate to the AppIntegration association.
|
893
|
+
# Each AppIntegration association can have only one of each use case
|
894
|
+
# type.
|
895
|
+
#
|
896
|
+
# @return [Types::CreateUseCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
897
|
+
#
|
898
|
+
# * {Types::CreateUseCaseResponse#use_case_id #use_case_id} => String
|
899
|
+
# * {Types::CreateUseCaseResponse#use_case_arn #use_case_arn} => String
|
900
|
+
#
|
901
|
+
# @example Request syntax with placeholder values
|
902
|
+
#
|
903
|
+
# resp = client.create_use_case({
|
904
|
+
# instance_id: "InstanceId", # required
|
905
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
906
|
+
# use_case_type: "RULES_EVALUATION", # required, accepts RULES_EVALUATION
|
907
|
+
# })
|
908
|
+
#
|
909
|
+
# @example Response structure
|
910
|
+
#
|
911
|
+
# resp.use_case_id #=> String
|
912
|
+
# resp.use_case_arn #=> String
|
913
|
+
#
|
914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUseCase AWS API Documentation
|
915
|
+
#
|
916
|
+
# @overload create_use_case(params = {})
|
917
|
+
# @param [Hash] params ({})
|
918
|
+
def create_use_case(params = {}, options = {})
|
919
|
+
req = build_request(:create_use_case, params)
|
920
|
+
req.send_request(options)
|
921
|
+
end
|
922
|
+
|
507
923
|
# Creates a user account for the specified Amazon Connect instance.
|
508
924
|
#
|
509
925
|
# For information about how to create user accounts using the Amazon
|
@@ -604,73 +1020,257 @@ module Aws::Connect
|
|
604
1020
|
req.send_request(options)
|
605
1021
|
end
|
606
1022
|
|
607
|
-
#
|
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
|
-
#
|
1023
|
+
# Creates a new user hierarchy group.
|
613
1024
|
#
|
1025
|
+
# @option params [required, String] :name
|
1026
|
+
# The name of the user hierarchy group. Must not be more than 100
|
1027
|
+
# characters.
|
614
1028
|
#
|
615
|
-
# [
|
1029
|
+
# @option params [String] :parent_group_id
|
1030
|
+
# The identifier for the parent hierarchy group. The user hierarchy is
|
1031
|
+
# created at level one if the parent group ID is null.
|
616
1032
|
#
|
617
1033
|
# @option params [required, String] :instance_id
|
618
1034
|
# The identifier of the Amazon Connect instance.
|
619
1035
|
#
|
620
|
-
# @
|
621
|
-
# The identifier of the user.
|
1036
|
+
# @return [Types::CreateUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
622
1037
|
#
|
623
|
-
#
|
1038
|
+
# * {Types::CreateUserHierarchyGroupResponse#hierarchy_group_id #hierarchy_group_id} => String
|
1039
|
+
# * {Types::CreateUserHierarchyGroupResponse#hierarchy_group_arn #hierarchy_group_arn} => String
|
624
1040
|
#
|
625
1041
|
# @example Request syntax with placeholder values
|
626
1042
|
#
|
627
|
-
# resp = client.
|
1043
|
+
# resp = client.create_user_hierarchy_group({
|
1044
|
+
# name: "HierarchyGroupName", # required
|
1045
|
+
# parent_group_id: "HierarchyGroupId",
|
628
1046
|
# instance_id: "InstanceId", # required
|
629
|
-
# user_id: "UserId", # required
|
630
1047
|
# })
|
631
1048
|
#
|
632
|
-
# @
|
1049
|
+
# @example Response structure
|
633
1050
|
#
|
634
|
-
#
|
1051
|
+
# resp.hierarchy_group_id #=> String
|
1052
|
+
# resp.hierarchy_group_arn #=> String
|
1053
|
+
#
|
1054
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserHierarchyGroup AWS API Documentation
|
1055
|
+
#
|
1056
|
+
# @overload create_user_hierarchy_group(params = {})
|
635
1057
|
# @param [Hash] params ({})
|
636
|
-
def
|
637
|
-
req = build_request(:
|
1058
|
+
def create_user_hierarchy_group(params = {}, options = {})
|
1059
|
+
req = build_request(:create_user_hierarchy_group, params)
|
638
1060
|
req.send_request(options)
|
639
1061
|
end
|
640
1062
|
|
641
|
-
#
|
642
|
-
#
|
643
|
-
# You can also create and update contact flows using the [Amazon Connect
|
644
|
-
# Flow language][1].
|
645
|
-
#
|
646
|
-
#
|
1063
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1064
|
+
# change.
|
647
1065
|
#
|
648
|
-
#
|
1066
|
+
# Deletes the Amazon Connect instance.
|
649
1067
|
#
|
650
1068
|
# @option params [required, String] :instance_id
|
651
1069
|
# The identifier of the Amazon Connect instance.
|
652
1070
|
#
|
653
|
-
# @
|
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
|
1071
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
659
1072
|
#
|
660
1073
|
# @example Request syntax with placeholder values
|
661
1074
|
#
|
662
|
-
# resp = client.
|
1075
|
+
# resp = client.delete_instance({
|
663
1076
|
# instance_id: "InstanceId", # required
|
664
|
-
# contact_flow_id: "ContactFlowId", # required
|
665
1077
|
# })
|
666
1078
|
#
|
667
|
-
# @
|
1079
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteInstance AWS API Documentation
|
668
1080
|
#
|
669
|
-
#
|
670
|
-
#
|
671
|
-
|
672
|
-
|
673
|
-
|
1081
|
+
# @overload delete_instance(params = {})
|
1082
|
+
# @param [Hash] params ({})
|
1083
|
+
def delete_instance(params = {}, options = {})
|
1084
|
+
req = build_request(:delete_instance, params)
|
1085
|
+
req.send_request(options)
|
1086
|
+
end
|
1087
|
+
|
1088
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1089
|
+
# change.
|
1090
|
+
#
|
1091
|
+
# Deletes an AppIntegration association from an Amazon Connect instance.
|
1092
|
+
# The association must not have any use cases associated with it.
|
1093
|
+
#
|
1094
|
+
# @option params [required, String] :instance_id
|
1095
|
+
# The identifier of the Amazon Connect instance.
|
1096
|
+
#
|
1097
|
+
# @option params [required, String] :integration_association_id
|
1098
|
+
# The identifier for the AppIntegration association.
|
1099
|
+
#
|
1100
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1101
|
+
#
|
1102
|
+
# @example Request syntax with placeholder values
|
1103
|
+
#
|
1104
|
+
# resp = client.delete_integration_association({
|
1105
|
+
# instance_id: "InstanceId", # required
|
1106
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1107
|
+
# })
|
1108
|
+
#
|
1109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteIntegrationAssociation AWS API Documentation
|
1110
|
+
#
|
1111
|
+
# @overload delete_integration_association(params = {})
|
1112
|
+
# @param [Hash] params ({})
|
1113
|
+
def delete_integration_association(params = {}, options = {})
|
1114
|
+
req = build_request(:delete_integration_association, params)
|
1115
|
+
req.send_request(options)
|
1116
|
+
end
|
1117
|
+
|
1118
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1119
|
+
# change.
|
1120
|
+
#
|
1121
|
+
# Deletes a quick connect.
|
1122
|
+
#
|
1123
|
+
# @option params [required, String] :instance_id
|
1124
|
+
# The identifier of the Amazon Connect instance.
|
1125
|
+
#
|
1126
|
+
# @option params [required, String] :quick_connect_id
|
1127
|
+
# The identifier for the quick connect.
|
1128
|
+
#
|
1129
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1130
|
+
#
|
1131
|
+
# @example Request syntax with placeholder values
|
1132
|
+
#
|
1133
|
+
# resp = client.delete_quick_connect({
|
1134
|
+
# instance_id: "InstanceId", # required
|
1135
|
+
# quick_connect_id: "QuickConnectId", # required
|
1136
|
+
# })
|
1137
|
+
#
|
1138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteQuickConnect AWS API Documentation
|
1139
|
+
#
|
1140
|
+
# @overload delete_quick_connect(params = {})
|
1141
|
+
# @param [Hash] params ({})
|
1142
|
+
def delete_quick_connect(params = {}, options = {})
|
1143
|
+
req = build_request(:delete_quick_connect, params)
|
1144
|
+
req.send_request(options)
|
1145
|
+
end
|
1146
|
+
|
1147
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1148
|
+
# change.
|
1149
|
+
#
|
1150
|
+
# Deletes a use case from an AppIntegration association.
|
1151
|
+
#
|
1152
|
+
# @option params [required, String] :instance_id
|
1153
|
+
# The identifier of the Amazon Connect instance.
|
1154
|
+
#
|
1155
|
+
# @option params [required, String] :integration_association_id
|
1156
|
+
# The identifier for the AppIntegration association.
|
1157
|
+
#
|
1158
|
+
# @option params [required, String] :use_case_id
|
1159
|
+
# The identifier for the use case.
|
1160
|
+
#
|
1161
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1162
|
+
#
|
1163
|
+
# @example Request syntax with placeholder values
|
1164
|
+
#
|
1165
|
+
# resp = client.delete_use_case({
|
1166
|
+
# instance_id: "InstanceId", # required
|
1167
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1168
|
+
# use_case_id: "UseCaseId", # required
|
1169
|
+
# })
|
1170
|
+
#
|
1171
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUseCase AWS API Documentation
|
1172
|
+
#
|
1173
|
+
# @overload delete_use_case(params = {})
|
1174
|
+
# @param [Hash] params ({})
|
1175
|
+
def delete_use_case(params = {}, options = {})
|
1176
|
+
req = build_request(:delete_use_case, params)
|
1177
|
+
req.send_request(options)
|
1178
|
+
end
|
1179
|
+
|
1180
|
+
# Deletes a user account from the specified Amazon Connect instance.
|
1181
|
+
#
|
1182
|
+
# For information about what happens to a user's data when their
|
1183
|
+
# account is deleted, see [Delete Users from Your Amazon Connect
|
1184
|
+
# Instance][1] in the *Amazon Connect Administrator Guide*.
|
1185
|
+
#
|
1186
|
+
#
|
1187
|
+
#
|
1188
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html
|
1189
|
+
#
|
1190
|
+
# @option params [required, String] :instance_id
|
1191
|
+
# The identifier of the Amazon Connect instance.
|
1192
|
+
#
|
1193
|
+
# @option params [required, String] :user_id
|
1194
|
+
# The identifier of the user.
|
1195
|
+
#
|
1196
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1197
|
+
#
|
1198
|
+
# @example Request syntax with placeholder values
|
1199
|
+
#
|
1200
|
+
# resp = client.delete_user({
|
1201
|
+
# instance_id: "InstanceId", # required
|
1202
|
+
# user_id: "UserId", # required
|
1203
|
+
# })
|
1204
|
+
#
|
1205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser AWS API Documentation
|
1206
|
+
#
|
1207
|
+
# @overload delete_user(params = {})
|
1208
|
+
# @param [Hash] params ({})
|
1209
|
+
def delete_user(params = {}, options = {})
|
1210
|
+
req = build_request(:delete_user, params)
|
1211
|
+
req.send_request(options)
|
1212
|
+
end
|
1213
|
+
|
1214
|
+
# Deletes an existing user hierarchy group. It must not be associated
|
1215
|
+
# with any agents or have any active child groups.
|
1216
|
+
#
|
1217
|
+
# @option params [required, String] :hierarchy_group_id
|
1218
|
+
# The identifier of the hierarchy group.
|
1219
|
+
#
|
1220
|
+
# @option params [required, String] :instance_id
|
1221
|
+
# The identifier of the Amazon Connect instance.
|
1222
|
+
#
|
1223
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1224
|
+
#
|
1225
|
+
# @example Request syntax with placeholder values
|
1226
|
+
#
|
1227
|
+
# resp = client.delete_user_hierarchy_group({
|
1228
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
1229
|
+
# instance_id: "InstanceId", # required
|
1230
|
+
# })
|
1231
|
+
#
|
1232
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUserHierarchyGroup AWS API Documentation
|
1233
|
+
#
|
1234
|
+
# @overload delete_user_hierarchy_group(params = {})
|
1235
|
+
# @param [Hash] params ({})
|
1236
|
+
def delete_user_hierarchy_group(params = {}, options = {})
|
1237
|
+
req = build_request(:delete_user_hierarchy_group, params)
|
1238
|
+
req.send_request(options)
|
1239
|
+
end
|
1240
|
+
|
1241
|
+
# Describes the specified contact flow.
|
1242
|
+
#
|
1243
|
+
# You can also create and update contact flows using the [Amazon Connect
|
1244
|
+
# Flow language][1].
|
1245
|
+
#
|
1246
|
+
#
|
1247
|
+
#
|
1248
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
1249
|
+
#
|
1250
|
+
# @option params [required, String] :instance_id
|
1251
|
+
# The identifier of the Amazon Connect instance.
|
1252
|
+
#
|
1253
|
+
# @option params [required, String] :contact_flow_id
|
1254
|
+
# The identifier of the contact flow.
|
1255
|
+
#
|
1256
|
+
# @return [Types::DescribeContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1257
|
+
#
|
1258
|
+
# * {Types::DescribeContactFlowResponse#contact_flow #contact_flow} => Types::ContactFlow
|
1259
|
+
#
|
1260
|
+
# @example Request syntax with placeholder values
|
1261
|
+
#
|
1262
|
+
# resp = client.describe_contact_flow({
|
1263
|
+
# instance_id: "InstanceId", # required
|
1264
|
+
# contact_flow_id: "ContactFlowId", # required
|
1265
|
+
# })
|
1266
|
+
#
|
1267
|
+
# @example Response structure
|
1268
|
+
#
|
1269
|
+
# resp.contact_flow.arn #=> String
|
1270
|
+
# resp.contact_flow.id #=> String
|
1271
|
+
# resp.contact_flow.name #=> String
|
1272
|
+
# 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"
|
1273
|
+
# resp.contact_flow.description #=> String
|
674
1274
|
# resp.contact_flow.content #=> String
|
675
1275
|
# resp.contact_flow.tags #=> Hash
|
676
1276
|
# resp.contact_flow.tags["TagKey"] #=> String
|
@@ -684,6 +1284,187 @@ module Aws::Connect
|
|
684
1284
|
req.send_request(options)
|
685
1285
|
end
|
686
1286
|
|
1287
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1288
|
+
# change.
|
1289
|
+
#
|
1290
|
+
# Returns the current state of the specified instance identifier. It
|
1291
|
+
# tracks the instance while it is being created and returns an error
|
1292
|
+
# status if applicable.
|
1293
|
+
#
|
1294
|
+
# If an instance is not created successfully, the instance status reason
|
1295
|
+
# field returns details relevant to the reason. The instance in a failed
|
1296
|
+
# state is returned only for 24 hours after the CreateInstance API was
|
1297
|
+
# invoked.
|
1298
|
+
#
|
1299
|
+
# @option params [required, String] :instance_id
|
1300
|
+
# The identifier of the Amazon Connect instance.
|
1301
|
+
#
|
1302
|
+
# @return [Types::DescribeInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1303
|
+
#
|
1304
|
+
# * {Types::DescribeInstanceResponse#instance #instance} => Types::Instance
|
1305
|
+
#
|
1306
|
+
# @example Request syntax with placeholder values
|
1307
|
+
#
|
1308
|
+
# resp = client.describe_instance({
|
1309
|
+
# instance_id: "InstanceId", # required
|
1310
|
+
# })
|
1311
|
+
#
|
1312
|
+
# @example Response structure
|
1313
|
+
#
|
1314
|
+
# resp.instance.id #=> String
|
1315
|
+
# resp.instance.arn #=> String
|
1316
|
+
# resp.instance.identity_management_type #=> String, one of "SAML", "CONNECT_MANAGED", "EXISTING_DIRECTORY"
|
1317
|
+
# resp.instance.instance_alias #=> String
|
1318
|
+
# resp.instance.created_time #=> Time
|
1319
|
+
# resp.instance.service_role #=> String
|
1320
|
+
# resp.instance.instance_status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED"
|
1321
|
+
# resp.instance.status_reason.message #=> String
|
1322
|
+
# resp.instance.inbound_calls_enabled #=> Boolean
|
1323
|
+
# resp.instance.outbound_calls_enabled #=> Boolean
|
1324
|
+
#
|
1325
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstance AWS API Documentation
|
1326
|
+
#
|
1327
|
+
# @overload describe_instance(params = {})
|
1328
|
+
# @param [Hash] params ({})
|
1329
|
+
def describe_instance(params = {}, options = {})
|
1330
|
+
req = build_request(:describe_instance, params)
|
1331
|
+
req.send_request(options)
|
1332
|
+
end
|
1333
|
+
|
1334
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1335
|
+
# change.
|
1336
|
+
#
|
1337
|
+
# Describes the specified instance attribute.
|
1338
|
+
#
|
1339
|
+
# @option params [required, String] :instance_id
|
1340
|
+
# The identifier of the Amazon Connect instance.
|
1341
|
+
#
|
1342
|
+
# @option params [required, String] :attribute_type
|
1343
|
+
# The type of attribute.
|
1344
|
+
#
|
1345
|
+
# @return [Types::DescribeInstanceAttributeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1346
|
+
#
|
1347
|
+
# * {Types::DescribeInstanceAttributeResponse#attribute #attribute} => Types::Attribute
|
1348
|
+
#
|
1349
|
+
# @example Request syntax with placeholder values
|
1350
|
+
#
|
1351
|
+
# resp = client.describe_instance_attribute({
|
1352
|
+
# instance_id: "InstanceId", # required
|
1353
|
+
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA
|
1354
|
+
# })
|
1355
|
+
#
|
1356
|
+
# @example Response structure
|
1357
|
+
#
|
1358
|
+
# resp.attribute.attribute_type #=> String, one of "INBOUND_CALLS", "OUTBOUND_CALLS", "CONTACTFLOW_LOGS", "CONTACT_LENS", "AUTO_RESOLVE_BEST_VOICES", "USE_CUSTOM_TTS_VOICES", "EARLY_MEDIA"
|
1359
|
+
# resp.attribute.value #=> String
|
1360
|
+
#
|
1361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceAttribute AWS API Documentation
|
1362
|
+
#
|
1363
|
+
# @overload describe_instance_attribute(params = {})
|
1364
|
+
# @param [Hash] params ({})
|
1365
|
+
def describe_instance_attribute(params = {}, options = {})
|
1366
|
+
req = build_request(:describe_instance_attribute, params)
|
1367
|
+
req.send_request(options)
|
1368
|
+
end
|
1369
|
+
|
1370
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1371
|
+
# change.
|
1372
|
+
#
|
1373
|
+
# Retrieves the current storage configurations for the specified
|
1374
|
+
# resource type, association ID, and instance ID.
|
1375
|
+
#
|
1376
|
+
# @option params [required, String] :instance_id
|
1377
|
+
# The identifier of the Amazon Connect instance.
|
1378
|
+
#
|
1379
|
+
# @option params [required, String] :association_id
|
1380
|
+
# The existing association identifier that uniquely identifies the
|
1381
|
+
# resource type and storage config for the given instance ID.
|
1382
|
+
#
|
1383
|
+
# @option params [required, String] :resource_type
|
1384
|
+
# A valid resource type.
|
1385
|
+
#
|
1386
|
+
# @return [Types::DescribeInstanceStorageConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1387
|
+
#
|
1388
|
+
# * {Types::DescribeInstanceStorageConfigResponse#storage_config #storage_config} => Types::InstanceStorageConfig
|
1389
|
+
#
|
1390
|
+
# @example Request syntax with placeholder values
|
1391
|
+
#
|
1392
|
+
# resp = client.describe_instance_storage_config({
|
1393
|
+
# instance_id: "InstanceId", # required
|
1394
|
+
# association_id: "AssociationId", # required
|
1395
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
1396
|
+
# })
|
1397
|
+
#
|
1398
|
+
# @example Response structure
|
1399
|
+
#
|
1400
|
+
# resp.storage_config.association_id #=> String
|
1401
|
+
# resp.storage_config.storage_type #=> String, one of "S3", "KINESIS_VIDEO_STREAM", "KINESIS_STREAM", "KINESIS_FIREHOSE"
|
1402
|
+
# resp.storage_config.s3_config.bucket_name #=> String
|
1403
|
+
# resp.storage_config.s3_config.bucket_prefix #=> String
|
1404
|
+
# resp.storage_config.s3_config.encryption_config.encryption_type #=> String, one of "KMS"
|
1405
|
+
# resp.storage_config.s3_config.encryption_config.key_id #=> String
|
1406
|
+
# resp.storage_config.kinesis_video_stream_config.prefix #=> String
|
1407
|
+
# resp.storage_config.kinesis_video_stream_config.retention_period_hours #=> Integer
|
1408
|
+
# resp.storage_config.kinesis_video_stream_config.encryption_config.encryption_type #=> String, one of "KMS"
|
1409
|
+
# resp.storage_config.kinesis_video_stream_config.encryption_config.key_id #=> String
|
1410
|
+
# resp.storage_config.kinesis_stream_config.stream_arn #=> String
|
1411
|
+
# resp.storage_config.kinesis_firehose_config.firehose_arn #=> String
|
1412
|
+
#
|
1413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceStorageConfig AWS API Documentation
|
1414
|
+
#
|
1415
|
+
# @overload describe_instance_storage_config(params = {})
|
1416
|
+
# @param [Hash] params ({})
|
1417
|
+
def describe_instance_storage_config(params = {}, options = {})
|
1418
|
+
req = build_request(:describe_instance_storage_config, params)
|
1419
|
+
req.send_request(options)
|
1420
|
+
end
|
1421
|
+
|
1422
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1423
|
+
# change.
|
1424
|
+
#
|
1425
|
+
# Describes the quick connect.
|
1426
|
+
#
|
1427
|
+
# @option params [required, String] :instance_id
|
1428
|
+
# The identifier of the Amazon Connect instance.
|
1429
|
+
#
|
1430
|
+
# @option params [required, String] :quick_connect_id
|
1431
|
+
# The identifier for the quick connect.
|
1432
|
+
#
|
1433
|
+
# @return [Types::DescribeQuickConnectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1434
|
+
#
|
1435
|
+
# * {Types::DescribeQuickConnectResponse#quick_connect #quick_connect} => Types::QuickConnect
|
1436
|
+
#
|
1437
|
+
# @example Request syntax with placeholder values
|
1438
|
+
#
|
1439
|
+
# resp = client.describe_quick_connect({
|
1440
|
+
# instance_id: "InstanceId", # required
|
1441
|
+
# quick_connect_id: "QuickConnectId", # required
|
1442
|
+
# })
|
1443
|
+
#
|
1444
|
+
# @example Response structure
|
1445
|
+
#
|
1446
|
+
# resp.quick_connect.quick_connect_arn #=> String
|
1447
|
+
# resp.quick_connect.quick_connect_id #=> String
|
1448
|
+
# resp.quick_connect.name #=> String
|
1449
|
+
# resp.quick_connect.description #=> String
|
1450
|
+
# resp.quick_connect.quick_connect_config.quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
|
1451
|
+
# resp.quick_connect.quick_connect_config.user_config.user_id #=> String
|
1452
|
+
# resp.quick_connect.quick_connect_config.user_config.contact_flow_id #=> String
|
1453
|
+
# resp.quick_connect.quick_connect_config.queue_config.queue_id #=> String
|
1454
|
+
# resp.quick_connect.quick_connect_config.queue_config.contact_flow_id #=> String
|
1455
|
+
# resp.quick_connect.quick_connect_config.phone_config.phone_number #=> String
|
1456
|
+
# resp.quick_connect.tags #=> Hash
|
1457
|
+
# resp.quick_connect.tags["TagKey"] #=> String
|
1458
|
+
#
|
1459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeQuickConnect AWS API Documentation
|
1460
|
+
#
|
1461
|
+
# @overload describe_quick_connect(params = {})
|
1462
|
+
# @param [Hash] params ({})
|
1463
|
+
def describe_quick_connect(params = {}, options = {})
|
1464
|
+
req = build_request(:describe_quick_connect, params)
|
1465
|
+
req.send_request(options)
|
1466
|
+
end
|
1467
|
+
|
687
1468
|
# Describes the specified routing profile.
|
688
1469
|
#
|
689
1470
|
# @option params [required, String] :instance_id
|
@@ -711,7 +1492,7 @@ module Aws::Connect
|
|
711
1492
|
# resp.routing_profile.routing_profile_id #=> String
|
712
1493
|
# resp.routing_profile.description #=> String
|
713
1494
|
# resp.routing_profile.media_concurrencies #=> Array
|
714
|
-
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT"
|
1495
|
+
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
715
1496
|
# resp.routing_profile.media_concurrencies[0].concurrency #=> Integer
|
716
1497
|
# resp.routing_profile.default_outbound_queue_id #=> String
|
717
1498
|
# resp.routing_profile.tags #=> Hash
|
@@ -870,63 +1651,222 @@ module Aws::Connect
|
|
870
1651
|
req.send_request(options)
|
871
1652
|
end
|
872
1653
|
|
873
|
-
#
|
1654
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1655
|
+
# change.
|
1656
|
+
#
|
1657
|
+
# Revokes access to integrated applications from Amazon Connect.
|
874
1658
|
#
|
875
1659
|
# @option params [required, String] :instance_id
|
876
1660
|
# The identifier of the Amazon Connect instance.
|
877
1661
|
#
|
878
|
-
# @option params [required, String] :
|
879
|
-
# The
|
880
|
-
#
|
881
|
-
# @option params [required, Array<Types::RoutingProfileQueueReference>] :queue_references
|
882
|
-
# The queues to disassociate from this routing profile.
|
1662
|
+
# @option params [required, String] :origin
|
1663
|
+
# The domain URL of the integrated application.
|
883
1664
|
#
|
884
1665
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
885
1666
|
#
|
886
1667
|
# @example Request syntax with placeholder values
|
887
1668
|
#
|
888
|
-
# resp = client.
|
1669
|
+
# resp = client.disassociate_approved_origin({
|
889
1670
|
# instance_id: "InstanceId", # required
|
890
|
-
#
|
891
|
-
# queue_references: [ # required
|
892
|
-
# {
|
893
|
-
# queue_id: "QueueId", # required
|
894
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
895
|
-
# },
|
896
|
-
# ],
|
1671
|
+
# origin: "Origin", # required
|
897
1672
|
# })
|
898
1673
|
#
|
899
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
1674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateApprovedOrigin AWS API Documentation
|
900
1675
|
#
|
901
|
-
# @overload
|
1676
|
+
# @overload disassociate_approved_origin(params = {})
|
902
1677
|
# @param [Hash] params ({})
|
903
|
-
def
|
904
|
-
req = build_request(:
|
1678
|
+
def disassociate_approved_origin(params = {}, options = {})
|
1679
|
+
req = build_request(:disassociate_approved_origin, params)
|
905
1680
|
req.send_request(options)
|
906
1681
|
end
|
907
1682
|
|
908
|
-
#
|
1683
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1684
|
+
# change.
|
1685
|
+
#
|
1686
|
+
# Removes the storage type configurations for the specified resource
|
1687
|
+
# type and association ID.
|
909
1688
|
#
|
910
1689
|
# @option params [required, String] :instance_id
|
911
1690
|
# The identifier of the Amazon Connect instance.
|
912
1691
|
#
|
913
|
-
# @option params [required, String] :
|
914
|
-
# The identifier
|
1692
|
+
# @option params [required, String] :association_id
|
1693
|
+
# The existing association identifier that uniquely identifies the
|
1694
|
+
# resource type and storage config for the given instance ID.
|
915
1695
|
#
|
916
|
-
# @
|
1696
|
+
# @option params [required, String] :resource_type
|
1697
|
+
# A valid resource type.
|
917
1698
|
#
|
918
|
-
#
|
1699
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
919
1700
|
#
|
920
1701
|
# @example Request syntax with placeholder values
|
921
1702
|
#
|
922
|
-
# resp = client.
|
1703
|
+
# resp = client.disassociate_instance_storage_config({
|
923
1704
|
# instance_id: "InstanceId", # required
|
924
|
-
#
|
1705
|
+
# association_id: "AssociationId", # required
|
1706
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
925
1707
|
# })
|
926
1708
|
#
|
927
|
-
# @
|
1709
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateInstanceStorageConfig AWS API Documentation
|
928
1710
|
#
|
929
|
-
#
|
1711
|
+
# @overload disassociate_instance_storage_config(params = {})
|
1712
|
+
# @param [Hash] params ({})
|
1713
|
+
def disassociate_instance_storage_config(params = {}, options = {})
|
1714
|
+
req = build_request(:disassociate_instance_storage_config, params)
|
1715
|
+
req.send_request(options)
|
1716
|
+
end
|
1717
|
+
|
1718
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1719
|
+
# change.
|
1720
|
+
#
|
1721
|
+
# Remove the Lambda function from the drop-down options available in the
|
1722
|
+
# relevant contact flow blocks.
|
1723
|
+
#
|
1724
|
+
# @option params [required, String] :instance_id
|
1725
|
+
# The identifier of the Amazon Connect instance..
|
1726
|
+
#
|
1727
|
+
# @option params [required, String] :function_arn
|
1728
|
+
# The Amazon Resource Name (ARN) of the Lambda function being
|
1729
|
+
# disassociated.
|
1730
|
+
#
|
1731
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1732
|
+
#
|
1733
|
+
# @example Request syntax with placeholder values
|
1734
|
+
#
|
1735
|
+
# resp = client.disassociate_lambda_function({
|
1736
|
+
# instance_id: "InstanceId", # required
|
1737
|
+
# function_arn: "FunctionArn", # required
|
1738
|
+
# })
|
1739
|
+
#
|
1740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateLambdaFunction AWS API Documentation
|
1741
|
+
#
|
1742
|
+
# @overload disassociate_lambda_function(params = {})
|
1743
|
+
# @param [Hash] params ({})
|
1744
|
+
def disassociate_lambda_function(params = {}, options = {})
|
1745
|
+
req = build_request(:disassociate_lambda_function, params)
|
1746
|
+
req.send_request(options)
|
1747
|
+
end
|
1748
|
+
|
1749
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1750
|
+
# change.
|
1751
|
+
#
|
1752
|
+
# Revokes authorization from the specified instance to access the
|
1753
|
+
# specified Amazon Lex bot.
|
1754
|
+
#
|
1755
|
+
# @option params [required, String] :instance_id
|
1756
|
+
# The identifier of the Amazon Connect instance.
|
1757
|
+
#
|
1758
|
+
# @option params [required, String] :bot_name
|
1759
|
+
# The name of the Amazon Lex bot. Maximum character limit of 50.
|
1760
|
+
#
|
1761
|
+
# @option params [required, String] :lex_region
|
1762
|
+
# The Region in which the Amazon Lex bot has been created.
|
1763
|
+
#
|
1764
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1765
|
+
#
|
1766
|
+
# @example Request syntax with placeholder values
|
1767
|
+
#
|
1768
|
+
# resp = client.disassociate_lex_bot({
|
1769
|
+
# instance_id: "InstanceId", # required
|
1770
|
+
# bot_name: "BotName", # required
|
1771
|
+
# lex_region: "LexRegion", # required
|
1772
|
+
# })
|
1773
|
+
#
|
1774
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateLexBot AWS API Documentation
|
1775
|
+
#
|
1776
|
+
# @overload disassociate_lex_bot(params = {})
|
1777
|
+
# @param [Hash] params ({})
|
1778
|
+
def disassociate_lex_bot(params = {}, options = {})
|
1779
|
+
req = build_request(:disassociate_lex_bot, params)
|
1780
|
+
req.send_request(options)
|
1781
|
+
end
|
1782
|
+
|
1783
|
+
# Disassociates a set of queues from a routing profile.
|
1784
|
+
#
|
1785
|
+
# @option params [required, String] :instance_id
|
1786
|
+
# The identifier of the Amazon Connect instance.
|
1787
|
+
#
|
1788
|
+
# @option params [required, String] :routing_profile_id
|
1789
|
+
# The identifier of the routing profile.
|
1790
|
+
#
|
1791
|
+
# @option params [required, Array<Types::RoutingProfileQueueReference>] :queue_references
|
1792
|
+
# The queues to disassociate from this routing profile.
|
1793
|
+
#
|
1794
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1795
|
+
#
|
1796
|
+
# @example Request syntax with placeholder values
|
1797
|
+
#
|
1798
|
+
# resp = client.disassociate_routing_profile_queues({
|
1799
|
+
# instance_id: "InstanceId", # required
|
1800
|
+
# routing_profile_id: "RoutingProfileId", # required
|
1801
|
+
# queue_references: [ # required
|
1802
|
+
# {
|
1803
|
+
# queue_id: "QueueId", # required
|
1804
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
1805
|
+
# },
|
1806
|
+
# ],
|
1807
|
+
# })
|
1808
|
+
#
|
1809
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateRoutingProfileQueues AWS API Documentation
|
1810
|
+
#
|
1811
|
+
# @overload disassociate_routing_profile_queues(params = {})
|
1812
|
+
# @param [Hash] params ({})
|
1813
|
+
def disassociate_routing_profile_queues(params = {}, options = {})
|
1814
|
+
req = build_request(:disassociate_routing_profile_queues, params)
|
1815
|
+
req.send_request(options)
|
1816
|
+
end
|
1817
|
+
|
1818
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1819
|
+
# change.
|
1820
|
+
#
|
1821
|
+
# Deletes the specified security key.
|
1822
|
+
#
|
1823
|
+
# @option params [required, String] :instance_id
|
1824
|
+
# The identifier of the Amazon Connect instance.
|
1825
|
+
#
|
1826
|
+
# @option params [required, String] :association_id
|
1827
|
+
# The existing association identifier that uniquely identifies the
|
1828
|
+
# resource type and storage config for the given instance ID.
|
1829
|
+
#
|
1830
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1831
|
+
#
|
1832
|
+
# @example Request syntax with placeholder values
|
1833
|
+
#
|
1834
|
+
# resp = client.disassociate_security_key({
|
1835
|
+
# instance_id: "InstanceId", # required
|
1836
|
+
# association_id: "AssociationId", # required
|
1837
|
+
# })
|
1838
|
+
#
|
1839
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateSecurityKey AWS API Documentation
|
1840
|
+
#
|
1841
|
+
# @overload disassociate_security_key(params = {})
|
1842
|
+
# @param [Hash] params ({})
|
1843
|
+
def disassociate_security_key(params = {}, options = {})
|
1844
|
+
req = build_request(:disassociate_security_key, params)
|
1845
|
+
req.send_request(options)
|
1846
|
+
end
|
1847
|
+
|
1848
|
+
# Retrieves the contact attributes for the specified contact.
|
1849
|
+
#
|
1850
|
+
# @option params [required, String] :instance_id
|
1851
|
+
# The identifier of the Amazon Connect instance.
|
1852
|
+
#
|
1853
|
+
# @option params [required, String] :initial_contact_id
|
1854
|
+
# The identifier of the initial contact.
|
1855
|
+
#
|
1856
|
+
# @return [Types::GetContactAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1857
|
+
#
|
1858
|
+
# * {Types::GetContactAttributesResponse#attributes #attributes} => Hash<String,String>
|
1859
|
+
#
|
1860
|
+
# @example Request syntax with placeholder values
|
1861
|
+
#
|
1862
|
+
# resp = client.get_contact_attributes({
|
1863
|
+
# instance_id: "InstanceId", # required
|
1864
|
+
# initial_contact_id: "ContactId", # required
|
1865
|
+
# })
|
1866
|
+
#
|
1867
|
+
# @example Response structure
|
1868
|
+
#
|
1869
|
+
# resp.attributes #=> Hash
|
930
1870
|
# resp.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
931
1871
|
#
|
932
1872
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactAttributes AWS API Documentation
|
@@ -955,14 +1895,14 @@ module Aws::Connect
|
|
955
1895
|
# The queues, up to 100, or channels, to use to filter the metrics
|
956
1896
|
# returned. Metric data is retrieved only for the resources associated
|
957
1897
|
# with the queues or channels included in the filter. You can include
|
958
|
-
# both queue IDs and queue ARNs in the same request.
|
959
|
-
#
|
1898
|
+
# both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
|
1899
|
+
# TASK channels are supported.
|
960
1900
|
#
|
961
1901
|
# @option params [Array<String>] :groupings
|
962
1902
|
# The grouping applied to the metrics returned. For example, when
|
963
1903
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
964
1904
|
# than aggregated for all queues. If you group by `CHANNEL`, you should
|
965
|
-
# include a Channels filter.
|
1905
|
+
# include a Channels filter. VOICE, CHAT, and TASK channels are
|
966
1906
|
# supported.
|
967
1907
|
#
|
968
1908
|
# If no `Grouping` is included in the request, a summary of metrics is
|
@@ -1102,7 +2042,7 @@ module Aws::Connect
|
|
1102
2042
|
# instance_id: "InstanceId", # required
|
1103
2043
|
# filters: { # required
|
1104
2044
|
# queues: ["QueueId"],
|
1105
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
2045
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
1106
2046
|
# },
|
1107
2047
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
1108
2048
|
# current_metrics: [ # required
|
@@ -1121,7 +2061,7 @@ module Aws::Connect
|
|
1121
2061
|
# resp.metric_results #=> Array
|
1122
2062
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
1123
2063
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
1124
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
2064
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
1125
2065
|
# resp.metric_results[0].collections #=> Array
|
1126
2066
|
# resp.metric_results[0].collections[0].metric.name #=> String, one of "AGENTS_ONLINE", "AGENTS_AVAILABLE", "AGENTS_ON_CALL", "AGENTS_NON_PRODUCTIVE", "AGENTS_AFTER_CONTACT_WORK", "AGENTS_ERROR", "AGENTS_STAFFED", "CONTACTS_IN_QUEUE", "OLDEST_CONTACT_AGE", "CONTACTS_SCHEDULED", "AGENTS_ON_CONTACT", "SLOTS_ACTIVE", "SLOTS_AVAILABLE"
|
1127
2067
|
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
@@ -1203,8 +2143,8 @@ module Aws::Connect
|
|
1203
2143
|
# The queues, up to 100, or channels, to use to filter the metrics
|
1204
2144
|
# returned. Metric data is retrieved only for the resources associated
|
1205
2145
|
# with the queues or channels included in the filter. You can include
|
1206
|
-
# both queue IDs and queue ARNs in the same request.
|
1207
|
-
#
|
2146
|
+
# both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
|
2147
|
+
# TASK channels are supported.
|
1208
2148
|
#
|
1209
2149
|
# @option params [Array<String>] :groupings
|
1210
2150
|
# The grouping applied to the metrics returned. For example, when
|
@@ -1305,81 +2245,480 @@ module Aws::Connect
|
|
1305
2245
|
#
|
1306
2246
|
# : Unit: COUNT
|
1307
2247
|
#
|
1308
|
-
# Statistic: SUM
|
2248
|
+
# Statistic: SUM
|
2249
|
+
#
|
2250
|
+
# CONTACTS\_TRANSFERRED\_IN\_FROM\_QUEUE
|
2251
|
+
#
|
2252
|
+
# : Unit: COUNT
|
2253
|
+
#
|
2254
|
+
# Statistic: SUM
|
2255
|
+
#
|
2256
|
+
# CONTACTS\_TRANSFERRED\_OUT
|
2257
|
+
#
|
2258
|
+
# : Unit: COUNT
|
2259
|
+
#
|
2260
|
+
# Statistic: SUM
|
2261
|
+
#
|
2262
|
+
# CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
|
2263
|
+
#
|
2264
|
+
# : Unit: COUNT
|
2265
|
+
#
|
2266
|
+
# Statistic: SUM
|
2267
|
+
#
|
2268
|
+
# HANDLE\_TIME
|
2269
|
+
#
|
2270
|
+
# : Unit: SECONDS
|
2271
|
+
#
|
2272
|
+
# Statistic: AVG
|
2273
|
+
#
|
2274
|
+
# HOLD\_TIME
|
2275
|
+
#
|
2276
|
+
# : Unit: SECONDS
|
2277
|
+
#
|
2278
|
+
# Statistic: AVG
|
2279
|
+
#
|
2280
|
+
# INTERACTION\_AND\_HOLD\_TIME
|
2281
|
+
#
|
2282
|
+
# : Unit: SECONDS
|
2283
|
+
#
|
2284
|
+
# Statistic: AVG
|
2285
|
+
#
|
2286
|
+
# INTERACTION\_TIME
|
2287
|
+
#
|
2288
|
+
# : Unit: SECONDS
|
2289
|
+
#
|
2290
|
+
# Statistic: AVG
|
2291
|
+
#
|
2292
|
+
# OCCUPANCY
|
2293
|
+
#
|
2294
|
+
# : Unit: PERCENT
|
2295
|
+
#
|
2296
|
+
# Statistic: AVG
|
2297
|
+
#
|
2298
|
+
# QUEUE\_ANSWER\_TIME
|
2299
|
+
#
|
2300
|
+
# : Unit: SECONDS
|
2301
|
+
#
|
2302
|
+
# Statistic: AVG
|
2303
|
+
#
|
2304
|
+
# QUEUED\_TIME
|
2305
|
+
#
|
2306
|
+
# : Unit: SECONDS
|
2307
|
+
#
|
2308
|
+
# Statistic: MAX
|
2309
|
+
#
|
2310
|
+
# SERVICE\_LEVEL
|
2311
|
+
#
|
2312
|
+
# : Unit: PERCENT
|
2313
|
+
#
|
2314
|
+
# Statistic: AVG
|
2315
|
+
#
|
2316
|
+
# Threshold: Only "Less than" comparisons are supported, with the
|
2317
|
+
# following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120,
|
2318
|
+
# 180, 240, 300, 600
|
2319
|
+
#
|
2320
|
+
#
|
2321
|
+
#
|
2322
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
2323
|
+
#
|
2324
|
+
# @option params [String] :next_token
|
2325
|
+
# The token for the next set of results. Use the value returned in the
|
2326
|
+
# previous response in the next request to retrieve the next set of
|
2327
|
+
# results.
|
2328
|
+
#
|
2329
|
+
# @option params [Integer] :max_results
|
2330
|
+
# The maximimum number of results to return per page.
|
2331
|
+
#
|
2332
|
+
# @return [Types::GetMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2333
|
+
#
|
2334
|
+
# * {Types::GetMetricDataResponse#next_token #next_token} => String
|
2335
|
+
# * {Types::GetMetricDataResponse#metric_results #metric_results} => Array<Types::HistoricalMetricResult>
|
2336
|
+
#
|
2337
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2338
|
+
#
|
2339
|
+
# @example Request syntax with placeholder values
|
2340
|
+
#
|
2341
|
+
# resp = client.get_metric_data({
|
2342
|
+
# instance_id: "InstanceId", # required
|
2343
|
+
# start_time: Time.now, # required
|
2344
|
+
# end_time: Time.now, # required
|
2345
|
+
# filters: { # required
|
2346
|
+
# queues: ["QueueId"],
|
2347
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
2348
|
+
# },
|
2349
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
2350
|
+
# historical_metrics: [ # required
|
2351
|
+
# {
|
2352
|
+
# name: "CONTACTS_QUEUED", # accepts CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL
|
2353
|
+
# threshold: {
|
2354
|
+
# comparison: "LT", # accepts LT
|
2355
|
+
# threshold_value: 1.0,
|
2356
|
+
# },
|
2357
|
+
# statistic: "SUM", # accepts SUM, MAX, AVG
|
2358
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
2359
|
+
# },
|
2360
|
+
# ],
|
2361
|
+
# next_token: "NextToken",
|
2362
|
+
# max_results: 1,
|
2363
|
+
# })
|
2364
|
+
#
|
2365
|
+
# @example Response structure
|
2366
|
+
#
|
2367
|
+
# resp.next_token #=> String
|
2368
|
+
# resp.metric_results #=> Array
|
2369
|
+
# resp.metric_results[0].dimensions.queue.id #=> String
|
2370
|
+
# resp.metric_results[0].dimensions.queue.arn #=> String
|
2371
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
2372
|
+
# resp.metric_results[0].collections #=> Array
|
2373
|
+
# resp.metric_results[0].collections[0].metric.name #=> String, one of "CONTACTS_QUEUED", "CONTACTS_HANDLED", "CONTACTS_ABANDONED", "CONTACTS_CONSULTED", "CONTACTS_AGENT_HUNG_UP_FIRST", "CONTACTS_HANDLED_INCOMING", "CONTACTS_HANDLED_OUTBOUND", "CONTACTS_HOLD_ABANDONS", "CONTACTS_TRANSFERRED_IN", "CONTACTS_TRANSFERRED_OUT", "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", "CONTACTS_MISSED", "CALLBACK_CONTACTS_HANDLED", "API_CONTACTS_HANDLED", "OCCUPANCY", "HANDLE_TIME", "AFTER_CONTACT_WORK_TIME", "QUEUED_TIME", "ABANDON_TIME", "QUEUE_ANSWER_TIME", "HOLD_TIME", "INTERACTION_TIME", "INTERACTION_AND_HOLD_TIME", "SERVICE_LEVEL"
|
2374
|
+
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
2375
|
+
# resp.metric_results[0].collections[0].metric.threshold.threshold_value #=> Float
|
2376
|
+
# resp.metric_results[0].collections[0].metric.statistic #=> String, one of "SUM", "MAX", "AVG"
|
2377
|
+
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
2378
|
+
# resp.metric_results[0].collections[0].value #=> Float
|
2379
|
+
#
|
2380
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData AWS API Documentation
|
2381
|
+
#
|
2382
|
+
# @overload get_metric_data(params = {})
|
2383
|
+
# @param [Hash] params ({})
|
2384
|
+
def get_metric_data(params = {}, options = {})
|
2385
|
+
req = build_request(:get_metric_data, params)
|
2386
|
+
req.send_request(options)
|
2387
|
+
end
|
2388
|
+
|
2389
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2390
|
+
# change.
|
2391
|
+
#
|
2392
|
+
# Returns a paginated list of all approved origins associated with the
|
2393
|
+
# instance.
|
2394
|
+
#
|
2395
|
+
# @option params [required, String] :instance_id
|
2396
|
+
# The identifier of the Amazon Connect instance.
|
2397
|
+
#
|
2398
|
+
# @option params [String] :next_token
|
2399
|
+
# The token for the next set of results. Use the value returned in the
|
2400
|
+
# previous response in the next request to retrieve the next set of
|
2401
|
+
# results.
|
2402
|
+
#
|
2403
|
+
# @option params [Integer] :max_results
|
2404
|
+
# The maximimum number of results to return per page.
|
2405
|
+
#
|
2406
|
+
# @return [Types::ListApprovedOriginsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2407
|
+
#
|
2408
|
+
# * {Types::ListApprovedOriginsResponse#origins #origins} => Array<String>
|
2409
|
+
# * {Types::ListApprovedOriginsResponse#next_token #next_token} => String
|
2410
|
+
#
|
2411
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2412
|
+
#
|
2413
|
+
# @example Request syntax with placeholder values
|
2414
|
+
#
|
2415
|
+
# resp = client.list_approved_origins({
|
2416
|
+
# instance_id: "InstanceId", # required
|
2417
|
+
# next_token: "NextToken",
|
2418
|
+
# max_results: 1,
|
2419
|
+
# })
|
2420
|
+
#
|
2421
|
+
# @example Response structure
|
2422
|
+
#
|
2423
|
+
# resp.origins #=> Array
|
2424
|
+
# resp.origins[0] #=> String
|
2425
|
+
# resp.next_token #=> String
|
2426
|
+
#
|
2427
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListApprovedOrigins AWS API Documentation
|
2428
|
+
#
|
2429
|
+
# @overload list_approved_origins(params = {})
|
2430
|
+
# @param [Hash] params ({})
|
2431
|
+
def list_approved_origins(params = {}, options = {})
|
2432
|
+
req = build_request(:list_approved_origins, params)
|
2433
|
+
req.send_request(options)
|
2434
|
+
end
|
2435
|
+
|
2436
|
+
# Provides information about the contact flows for the specified Amazon
|
2437
|
+
# Connect instance.
|
2438
|
+
#
|
2439
|
+
# You can also create and update contact flows using the [Amazon Connect
|
2440
|
+
# Flow language][1].
|
2441
|
+
#
|
2442
|
+
# For more information about contact flows, see [Contact Flows][2] in
|
2443
|
+
# the *Amazon Connect Administrator Guide*.
|
2444
|
+
#
|
2445
|
+
#
|
2446
|
+
#
|
2447
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
2448
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html
|
2449
|
+
#
|
2450
|
+
# @option params [required, String] :instance_id
|
2451
|
+
# The identifier of the Amazon Connect instance.
|
2452
|
+
#
|
2453
|
+
# @option params [Array<String>] :contact_flow_types
|
2454
|
+
# The type of contact flow.
|
2455
|
+
#
|
2456
|
+
# @option params [String] :next_token
|
2457
|
+
# The token for the next set of results. Use the value returned in the
|
2458
|
+
# previous response in the next request to retrieve the next set of
|
2459
|
+
# results.
|
2460
|
+
#
|
2461
|
+
# @option params [Integer] :max_results
|
2462
|
+
# The maximimum number of results to return per page.
|
2463
|
+
#
|
2464
|
+
# @return [Types::ListContactFlowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2465
|
+
#
|
2466
|
+
# * {Types::ListContactFlowsResponse#contact_flow_summary_list #contact_flow_summary_list} => Array<Types::ContactFlowSummary>
|
2467
|
+
# * {Types::ListContactFlowsResponse#next_token #next_token} => String
|
2468
|
+
#
|
2469
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2470
|
+
#
|
2471
|
+
# @example Request syntax with placeholder values
|
2472
|
+
#
|
2473
|
+
# resp = client.list_contact_flows({
|
2474
|
+
# instance_id: "InstanceId", # required
|
2475
|
+
# contact_flow_types: ["CONTACT_FLOW"], # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
2476
|
+
# next_token: "NextToken",
|
2477
|
+
# max_results: 1,
|
2478
|
+
# })
|
2479
|
+
#
|
2480
|
+
# @example Response structure
|
2481
|
+
#
|
2482
|
+
# resp.contact_flow_summary_list #=> Array
|
2483
|
+
# resp.contact_flow_summary_list[0].id #=> String
|
2484
|
+
# resp.contact_flow_summary_list[0].arn #=> String
|
2485
|
+
# resp.contact_flow_summary_list[0].name #=> String
|
2486
|
+
# resp.contact_flow_summary_list[0].contact_flow_type #=> String, one of "CONTACT_FLOW", "CUSTOMER_QUEUE", "CUSTOMER_HOLD", "CUSTOMER_WHISPER", "AGENT_HOLD", "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", "QUEUE_TRANSFER"
|
2487
|
+
# resp.next_token #=> String
|
2488
|
+
#
|
2489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlows AWS API Documentation
|
2490
|
+
#
|
2491
|
+
# @overload list_contact_flows(params = {})
|
2492
|
+
# @param [Hash] params ({})
|
2493
|
+
def list_contact_flows(params = {}, options = {})
|
2494
|
+
req = build_request(:list_contact_flows, params)
|
2495
|
+
req.send_request(options)
|
2496
|
+
end
|
2497
|
+
|
2498
|
+
# Provides information about the hours of operation for the specified
|
2499
|
+
# Amazon Connect instance.
|
2500
|
+
#
|
2501
|
+
# For more information about hours of operation, see [Set the Hours of
|
2502
|
+
# Operation for a Queue][1] in the *Amazon Connect Administrator Guide*.
|
2503
|
+
#
|
2504
|
+
#
|
2505
|
+
#
|
2506
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html
|
2507
|
+
#
|
2508
|
+
# @option params [required, String] :instance_id
|
2509
|
+
# The identifier of the Amazon Connect instance.
|
2510
|
+
#
|
2511
|
+
# @option params [String] :next_token
|
2512
|
+
# The token for the next set of results. Use the value returned in the
|
2513
|
+
# previous response in the next request to retrieve the next set of
|
2514
|
+
# results.
|
2515
|
+
#
|
2516
|
+
# @option params [Integer] :max_results
|
2517
|
+
# The maximimum number of results to return per page.
|
2518
|
+
#
|
2519
|
+
# @return [Types::ListHoursOfOperationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2520
|
+
#
|
2521
|
+
# * {Types::ListHoursOfOperationsResponse#hours_of_operation_summary_list #hours_of_operation_summary_list} => Array<Types::HoursOfOperationSummary>
|
2522
|
+
# * {Types::ListHoursOfOperationsResponse#next_token #next_token} => String
|
2523
|
+
#
|
2524
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2525
|
+
#
|
2526
|
+
# @example Request syntax with placeholder values
|
2527
|
+
#
|
2528
|
+
# resp = client.list_hours_of_operations({
|
2529
|
+
# instance_id: "InstanceId", # required
|
2530
|
+
# next_token: "NextToken",
|
2531
|
+
# max_results: 1,
|
2532
|
+
# })
|
2533
|
+
#
|
2534
|
+
# @example Response structure
|
2535
|
+
#
|
2536
|
+
# resp.hours_of_operation_summary_list #=> Array
|
2537
|
+
# resp.hours_of_operation_summary_list[0].id #=> String
|
2538
|
+
# resp.hours_of_operation_summary_list[0].arn #=> String
|
2539
|
+
# resp.hours_of_operation_summary_list[0].name #=> String
|
2540
|
+
# resp.next_token #=> String
|
2541
|
+
#
|
2542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperations AWS API Documentation
|
2543
|
+
#
|
2544
|
+
# @overload list_hours_of_operations(params = {})
|
2545
|
+
# @param [Hash] params ({})
|
2546
|
+
def list_hours_of_operations(params = {}, options = {})
|
2547
|
+
req = build_request(:list_hours_of_operations, params)
|
2548
|
+
req.send_request(options)
|
2549
|
+
end
|
2550
|
+
|
2551
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2552
|
+
# change.
|
2553
|
+
#
|
2554
|
+
# Returns a paginated list of all attribute types for the given
|
2555
|
+
# instance.
|
2556
|
+
#
|
2557
|
+
# @option params [required, String] :instance_id
|
2558
|
+
# The identifier of the Amazon Connect instance.
|
2559
|
+
#
|
2560
|
+
# @option params [String] :next_token
|
2561
|
+
# The token for the next set of results. Use the value returned in the
|
2562
|
+
# previous response in the next request to retrieve the next set of
|
2563
|
+
# results.
|
2564
|
+
#
|
2565
|
+
# @option params [Integer] :max_results
|
2566
|
+
# The maximimum number of results to return per page.
|
1309
2567
|
#
|
1310
|
-
#
|
2568
|
+
# @return [Types::ListInstanceAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1311
2569
|
#
|
1312
|
-
#
|
2570
|
+
# * {Types::ListInstanceAttributesResponse#attributes #attributes} => Array<Types::Attribute>
|
2571
|
+
# * {Types::ListInstanceAttributesResponse#next_token #next_token} => String
|
1313
2572
|
#
|
1314
|
-
#
|
2573
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1315
2574
|
#
|
1316
|
-
#
|
2575
|
+
# @example Request syntax with placeholder values
|
1317
2576
|
#
|
1318
|
-
#
|
2577
|
+
# resp = client.list_instance_attributes({
|
2578
|
+
# instance_id: "InstanceId", # required
|
2579
|
+
# next_token: "NextToken",
|
2580
|
+
# max_results: 1,
|
2581
|
+
# })
|
1319
2582
|
#
|
1320
|
-
#
|
2583
|
+
# @example Response structure
|
1321
2584
|
#
|
1322
|
-
#
|
2585
|
+
# resp.attributes #=> Array
|
2586
|
+
# resp.attributes[0].attribute_type #=> String, one of "INBOUND_CALLS", "OUTBOUND_CALLS", "CONTACTFLOW_LOGS", "CONTACT_LENS", "AUTO_RESOLVE_BEST_VOICES", "USE_CUSTOM_TTS_VOICES", "EARLY_MEDIA"
|
2587
|
+
# resp.attributes[0].value #=> String
|
2588
|
+
# resp.next_token #=> String
|
1323
2589
|
#
|
1324
|
-
#
|
2590
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceAttributes AWS API Documentation
|
1325
2591
|
#
|
1326
|
-
#
|
2592
|
+
# @overload list_instance_attributes(params = {})
|
2593
|
+
# @param [Hash] params ({})
|
2594
|
+
def list_instance_attributes(params = {}, options = {})
|
2595
|
+
req = build_request(:list_instance_attributes, params)
|
2596
|
+
req.send_request(options)
|
2597
|
+
end
|
2598
|
+
|
2599
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2600
|
+
# change.
|
1327
2601
|
#
|
1328
|
-
#
|
2602
|
+
# Returns a paginated list of storage configs for the identified
|
2603
|
+
# instance and resource type.
|
1329
2604
|
#
|
1330
|
-
#
|
2605
|
+
# @option params [required, String] :instance_id
|
2606
|
+
# The identifier of the Amazon Connect instance.
|
1331
2607
|
#
|
1332
|
-
#
|
2608
|
+
# @option params [required, String] :resource_type
|
2609
|
+
# A valid resource type.
|
1333
2610
|
#
|
1334
|
-
#
|
2611
|
+
# @option params [String] :next_token
|
2612
|
+
# The token for the next set of results. Use the value returned in the
|
2613
|
+
# previous response in the next request to retrieve the next set of
|
2614
|
+
# results.
|
1335
2615
|
#
|
1336
|
-
#
|
2616
|
+
# @option params [Integer] :max_results
|
2617
|
+
# The maximimum number of results to return per page.
|
1337
2618
|
#
|
1338
|
-
#
|
2619
|
+
# @return [Types::ListInstanceStorageConfigsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1339
2620
|
#
|
1340
|
-
#
|
2621
|
+
# * {Types::ListInstanceStorageConfigsResponse#storage_configs #storage_configs} => Array<Types::InstanceStorageConfig>
|
2622
|
+
# * {Types::ListInstanceStorageConfigsResponse#next_token #next_token} => String
|
1341
2623
|
#
|
1342
|
-
#
|
2624
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1343
2625
|
#
|
1344
|
-
#
|
2626
|
+
# @example Request syntax with placeholder values
|
1345
2627
|
#
|
1346
|
-
#
|
2628
|
+
# resp = client.list_instance_storage_configs({
|
2629
|
+
# instance_id: "InstanceId", # required
|
2630
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
2631
|
+
# next_token: "NextToken",
|
2632
|
+
# max_results: 1,
|
2633
|
+
# })
|
1347
2634
|
#
|
1348
|
-
#
|
2635
|
+
# @example Response structure
|
1349
2636
|
#
|
1350
|
-
#
|
2637
|
+
# resp.storage_configs #=> Array
|
2638
|
+
# resp.storage_configs[0].association_id #=> String
|
2639
|
+
# resp.storage_configs[0].storage_type #=> String, one of "S3", "KINESIS_VIDEO_STREAM", "KINESIS_STREAM", "KINESIS_FIREHOSE"
|
2640
|
+
# resp.storage_configs[0].s3_config.bucket_name #=> String
|
2641
|
+
# resp.storage_configs[0].s3_config.bucket_prefix #=> String
|
2642
|
+
# resp.storage_configs[0].s3_config.encryption_config.encryption_type #=> String, one of "KMS"
|
2643
|
+
# resp.storage_configs[0].s3_config.encryption_config.key_id #=> String
|
2644
|
+
# resp.storage_configs[0].kinesis_video_stream_config.prefix #=> String
|
2645
|
+
# resp.storage_configs[0].kinesis_video_stream_config.retention_period_hours #=> Integer
|
2646
|
+
# resp.storage_configs[0].kinesis_video_stream_config.encryption_config.encryption_type #=> String, one of "KMS"
|
2647
|
+
# resp.storage_configs[0].kinesis_video_stream_config.encryption_config.key_id #=> String
|
2648
|
+
# resp.storage_configs[0].kinesis_stream_config.stream_arn #=> String
|
2649
|
+
# resp.storage_configs[0].kinesis_firehose_config.firehose_arn #=> String
|
2650
|
+
# resp.next_token #=> String
|
1351
2651
|
#
|
1352
|
-
#
|
2652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceStorageConfigs AWS API Documentation
|
1353
2653
|
#
|
1354
|
-
#
|
2654
|
+
# @overload list_instance_storage_configs(params = {})
|
2655
|
+
# @param [Hash] params ({})
|
2656
|
+
def list_instance_storage_configs(params = {}, options = {})
|
2657
|
+
req = build_request(:list_instance_storage_configs, params)
|
2658
|
+
req.send_request(options)
|
2659
|
+
end
|
2660
|
+
|
2661
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2662
|
+
# change.
|
1355
2663
|
#
|
1356
|
-
#
|
2664
|
+
# Return a list of instances which are in active state,
|
2665
|
+
# creation-in-progress state, and failed state. Instances that aren't
|
2666
|
+
# successfully created (they are in a failed state) are returned only
|
2667
|
+
# for 24 hours after the CreateInstance API was invoked.
|
1357
2668
|
#
|
1358
|
-
#
|
2669
|
+
# @option params [String] :next_token
|
2670
|
+
# The token for the next set of results. Use the value returned in the
|
2671
|
+
# previous response in the next request to retrieve the next set of
|
2672
|
+
# results.
|
1359
2673
|
#
|
1360
|
-
#
|
2674
|
+
# @option params [Integer] :max_results
|
2675
|
+
# The maximimum number of results to return per page.
|
1361
2676
|
#
|
1362
|
-
#
|
2677
|
+
# @return [Types::ListInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1363
2678
|
#
|
1364
|
-
#
|
2679
|
+
# * {Types::ListInstancesResponse#instance_summary_list #instance_summary_list} => Array<Types::InstanceSummary>
|
2680
|
+
# * {Types::ListInstancesResponse#next_token #next_token} => String
|
1365
2681
|
#
|
1366
|
-
#
|
2682
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1367
2683
|
#
|
1368
|
-
#
|
2684
|
+
# @example Request syntax with placeholder values
|
1369
2685
|
#
|
1370
|
-
#
|
2686
|
+
# resp = client.list_instances({
|
2687
|
+
# next_token: "NextToken",
|
2688
|
+
# max_results: 1,
|
2689
|
+
# })
|
1371
2690
|
#
|
1372
|
-
#
|
2691
|
+
# @example Response structure
|
1373
2692
|
#
|
1374
|
-
#
|
2693
|
+
# resp.instance_summary_list #=> Array
|
2694
|
+
# resp.instance_summary_list[0].id #=> String
|
2695
|
+
# resp.instance_summary_list[0].arn #=> String
|
2696
|
+
# resp.instance_summary_list[0].identity_management_type #=> String, one of "SAML", "CONNECT_MANAGED", "EXISTING_DIRECTORY"
|
2697
|
+
# resp.instance_summary_list[0].instance_alias #=> String
|
2698
|
+
# resp.instance_summary_list[0].created_time #=> Time
|
2699
|
+
# resp.instance_summary_list[0].service_role #=> String
|
2700
|
+
# resp.instance_summary_list[0].instance_status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED"
|
2701
|
+
# resp.instance_summary_list[0].inbound_calls_enabled #=> Boolean
|
2702
|
+
# resp.instance_summary_list[0].outbound_calls_enabled #=> Boolean
|
2703
|
+
# resp.next_token #=> String
|
1375
2704
|
#
|
1376
|
-
#
|
1377
|
-
# following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120,
|
1378
|
-
# 180, 240, 300, 600
|
2705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstances AWS API Documentation
|
1379
2706
|
#
|
2707
|
+
# @overload list_instances(params = {})
|
2708
|
+
# @param [Hash] params ({})
|
2709
|
+
def list_instances(params = {}, options = {})
|
2710
|
+
req = build_request(:list_instances, params)
|
2711
|
+
req.send_request(options)
|
2712
|
+
end
|
2713
|
+
|
2714
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2715
|
+
# change.
|
1380
2716
|
#
|
2717
|
+
# Provides summary information about the AppIntegration associations for
|
2718
|
+
# the specified Amazon Connect instance.
|
1381
2719
|
#
|
1382
|
-
#
|
2720
|
+
# @option params [required, String] :instance_id
|
2721
|
+
# The identifier of the Amazon Connect instance.
|
1383
2722
|
#
|
1384
2723
|
# @option params [String] :next_token
|
1385
2724
|
# The token for the next set of results. Use the value returned in the
|
@@ -1389,83 +2728,52 @@ module Aws::Connect
|
|
1389
2728
|
# @option params [Integer] :max_results
|
1390
2729
|
# The maximimum number of results to return per page.
|
1391
2730
|
#
|
1392
|
-
# @return [Types::
|
2731
|
+
# @return [Types::ListIntegrationAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1393
2732
|
#
|
1394
|
-
# * {Types::
|
1395
|
-
# * {Types::
|
2733
|
+
# * {Types::ListIntegrationAssociationsResponse#integration_association_summary_list #integration_association_summary_list} => Array<Types::IntegrationAssociationSummary>
|
2734
|
+
# * {Types::ListIntegrationAssociationsResponse#next_token #next_token} => String
|
1396
2735
|
#
|
1397
2736
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1398
2737
|
#
|
1399
2738
|
# @example Request syntax with placeholder values
|
1400
2739
|
#
|
1401
|
-
# resp = client.
|
2740
|
+
# resp = client.list_integration_associations({
|
1402
2741
|
# instance_id: "InstanceId", # required
|
1403
|
-
# start_time: Time.now, # required
|
1404
|
-
# end_time: Time.now, # required
|
1405
|
-
# filters: { # required
|
1406
|
-
# queues: ["QueueId"],
|
1407
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
1408
|
-
# },
|
1409
|
-
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
1410
|
-
# historical_metrics: [ # required
|
1411
|
-
# {
|
1412
|
-
# name: "CONTACTS_QUEUED", # accepts CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL
|
1413
|
-
# threshold: {
|
1414
|
-
# comparison: "LT", # accepts LT
|
1415
|
-
# threshold_value: 1.0,
|
1416
|
-
# },
|
1417
|
-
# statistic: "SUM", # accepts SUM, MAX, AVG
|
1418
|
-
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
1419
|
-
# },
|
1420
|
-
# ],
|
1421
2742
|
# next_token: "NextToken",
|
1422
2743
|
# max_results: 1,
|
1423
2744
|
# })
|
1424
2745
|
#
|
1425
2746
|
# @example Response structure
|
1426
2747
|
#
|
2748
|
+
# resp.integration_association_summary_list #=> Array
|
2749
|
+
# resp.integration_association_summary_list[0].integration_association_id #=> String
|
2750
|
+
# resp.integration_association_summary_list[0].integration_association_arn #=> String
|
2751
|
+
# resp.integration_association_summary_list[0].instance_id #=> String
|
2752
|
+
# resp.integration_association_summary_list[0].integration_type #=> String, one of "EVENT"
|
2753
|
+
# resp.integration_association_summary_list[0].integration_arn #=> String
|
2754
|
+
# resp.integration_association_summary_list[0].source_application_url #=> String
|
2755
|
+
# resp.integration_association_summary_list[0].source_application_name #=> String
|
2756
|
+
# resp.integration_association_summary_list[0].source_type #=> String, one of "SALESFORCE", "ZENDESK"
|
1427
2757
|
# resp.next_token #=> String
|
1428
|
-
# resp.metric_results #=> Array
|
1429
|
-
# resp.metric_results[0].dimensions.queue.id #=> String
|
1430
|
-
# resp.metric_results[0].dimensions.queue.arn #=> String
|
1431
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
1432
|
-
# resp.metric_results[0].collections #=> Array
|
1433
|
-
# resp.metric_results[0].collections[0].metric.name #=> String, one of "CONTACTS_QUEUED", "CONTACTS_HANDLED", "CONTACTS_ABANDONED", "CONTACTS_CONSULTED", "CONTACTS_AGENT_HUNG_UP_FIRST", "CONTACTS_HANDLED_INCOMING", "CONTACTS_HANDLED_OUTBOUND", "CONTACTS_HOLD_ABANDONS", "CONTACTS_TRANSFERRED_IN", "CONTACTS_TRANSFERRED_OUT", "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", "CONTACTS_MISSED", "CALLBACK_CONTACTS_HANDLED", "API_CONTACTS_HANDLED", "OCCUPANCY", "HANDLE_TIME", "AFTER_CONTACT_WORK_TIME", "QUEUED_TIME", "ABANDON_TIME", "QUEUE_ANSWER_TIME", "HOLD_TIME", "INTERACTION_TIME", "INTERACTION_AND_HOLD_TIME", "SERVICE_LEVEL"
|
1434
|
-
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
1435
|
-
# resp.metric_results[0].collections[0].metric.threshold.threshold_value #=> Float
|
1436
|
-
# resp.metric_results[0].collections[0].metric.statistic #=> String, one of "SUM", "MAX", "AVG"
|
1437
|
-
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
1438
|
-
# resp.metric_results[0].collections[0].value #=> Float
|
1439
2758
|
#
|
1440
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListIntegrationAssociations AWS API Documentation
|
1441
2760
|
#
|
1442
|
-
# @overload
|
2761
|
+
# @overload list_integration_associations(params = {})
|
1443
2762
|
# @param [Hash] params ({})
|
1444
|
-
def
|
1445
|
-
req = build_request(:
|
2763
|
+
def list_integration_associations(params = {}, options = {})
|
2764
|
+
req = build_request(:list_integration_associations, params)
|
1446
2765
|
req.send_request(options)
|
1447
2766
|
end
|
1448
2767
|
|
1449
|
-
#
|
1450
|
-
#
|
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
|
-
#
|
2768
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2769
|
+
# change.
|
1458
2770
|
#
|
1459
|
-
#
|
1460
|
-
#
|
1461
|
-
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html
|
2771
|
+
# Returns a paginated list of all the Lambda functions that show up in
|
2772
|
+
# the drop-down options in the relevant contact flow blocks.
|
1462
2773
|
#
|
1463
2774
|
# @option params [required, String] :instance_id
|
1464
2775
|
# The identifier of the Amazon Connect instance.
|
1465
2776
|
#
|
1466
|
-
# @option params [Array<String>] :contact_flow_types
|
1467
|
-
# The type of contact flow.
|
1468
|
-
#
|
1469
2777
|
# @option params [String] :next_token
|
1470
2778
|
# The token for the next set of results. Use the value returned in the
|
1471
2779
|
# previous response in the next request to retrieve the next set of
|
@@ -1474,49 +2782,41 @@ module Aws::Connect
|
|
1474
2782
|
# @option params [Integer] :max_results
|
1475
2783
|
# The maximimum number of results to return per page.
|
1476
2784
|
#
|
1477
|
-
# @return [Types::
|
2785
|
+
# @return [Types::ListLambdaFunctionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1478
2786
|
#
|
1479
|
-
# * {Types::
|
1480
|
-
# * {Types::
|
2787
|
+
# * {Types::ListLambdaFunctionsResponse#lambda_functions #lambda_functions} => Array<String>
|
2788
|
+
# * {Types::ListLambdaFunctionsResponse#next_token #next_token} => String
|
1481
2789
|
#
|
1482
2790
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1483
2791
|
#
|
1484
2792
|
# @example Request syntax with placeholder values
|
1485
2793
|
#
|
1486
|
-
# resp = client.
|
2794
|
+
# resp = client.list_lambda_functions({
|
1487
2795
|
# instance_id: "InstanceId", # required
|
1488
|
-
# contact_flow_types: ["CONTACT_FLOW"], # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
1489
2796
|
# next_token: "NextToken",
|
1490
2797
|
# max_results: 1,
|
1491
2798
|
# })
|
1492
2799
|
#
|
1493
2800
|
# @example Response structure
|
1494
2801
|
#
|
1495
|
-
# resp.
|
1496
|
-
# resp.
|
1497
|
-
# resp.contact_flow_summary_list[0].arn #=> String
|
1498
|
-
# resp.contact_flow_summary_list[0].name #=> String
|
1499
|
-
# resp.contact_flow_summary_list[0].contact_flow_type #=> String, one of "CONTACT_FLOW", "CUSTOMER_QUEUE", "CUSTOMER_HOLD", "CUSTOMER_WHISPER", "AGENT_HOLD", "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", "QUEUE_TRANSFER"
|
2802
|
+
# resp.lambda_functions #=> Array
|
2803
|
+
# resp.lambda_functions[0] #=> String
|
1500
2804
|
# resp.next_token #=> String
|
1501
2805
|
#
|
1502
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLambdaFunctions AWS API Documentation
|
1503
2807
|
#
|
1504
|
-
# @overload
|
2808
|
+
# @overload list_lambda_functions(params = {})
|
1505
2809
|
# @param [Hash] params ({})
|
1506
|
-
def
|
1507
|
-
req = build_request(:
|
2810
|
+
def list_lambda_functions(params = {}, options = {})
|
2811
|
+
req = build_request(:list_lambda_functions, params)
|
1508
2812
|
req.send_request(options)
|
1509
2813
|
end
|
1510
2814
|
|
1511
|
-
#
|
1512
|
-
#
|
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
|
-
#
|
2815
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2816
|
+
# change.
|
1517
2817
|
#
|
1518
|
-
#
|
1519
|
-
#
|
2818
|
+
# Returns a paginated list of all the Amazon Lex bots currently
|
2819
|
+
# associated with the instance.
|
1520
2820
|
#
|
1521
2821
|
# @option params [required, String] :instance_id
|
1522
2822
|
# The identifier of the Amazon Connect instance.
|
@@ -1529,16 +2829,16 @@ module Aws::Connect
|
|
1529
2829
|
# @option params [Integer] :max_results
|
1530
2830
|
# The maximimum number of results to return per page.
|
1531
2831
|
#
|
1532
|
-
# @return [Types::
|
2832
|
+
# @return [Types::ListLexBotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1533
2833
|
#
|
1534
|
-
# * {Types::
|
1535
|
-
# * {Types::
|
2834
|
+
# * {Types::ListLexBotsResponse#lex_bots #lex_bots} => Array<Types::LexBot>
|
2835
|
+
# * {Types::ListLexBotsResponse#next_token #next_token} => String
|
1536
2836
|
#
|
1537
2837
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1538
2838
|
#
|
1539
2839
|
# @example Request syntax with placeholder values
|
1540
2840
|
#
|
1541
|
-
# resp = client.
|
2841
|
+
# resp = client.list_lex_bots({
|
1542
2842
|
# instance_id: "InstanceId", # required
|
1543
2843
|
# next_token: "NextToken",
|
1544
2844
|
# max_results: 1,
|
@@ -1546,18 +2846,17 @@ module Aws::Connect
|
|
1546
2846
|
#
|
1547
2847
|
# @example Response structure
|
1548
2848
|
#
|
1549
|
-
# resp.
|
1550
|
-
# resp.
|
1551
|
-
# resp.
|
1552
|
-
# resp.hours_of_operation_summary_list[0].name #=> String
|
2849
|
+
# resp.lex_bots #=> Array
|
2850
|
+
# resp.lex_bots[0].name #=> String
|
2851
|
+
# resp.lex_bots[0].lex_region #=> String
|
1553
2852
|
# resp.next_token #=> String
|
1554
2853
|
#
|
1555
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2854
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLexBots AWS API Documentation
|
1556
2855
|
#
|
1557
|
-
# @overload
|
2856
|
+
# @overload list_lex_bots(params = {})
|
1558
2857
|
# @param [Hash] params ({})
|
1559
|
-
def
|
1560
|
-
req = build_request(:
|
2858
|
+
def list_lex_bots(params = {}, options = {})
|
2859
|
+
req = build_request(:list_lex_bots, params)
|
1561
2860
|
req.send_request(options)
|
1562
2861
|
end
|
1563
2862
|
|
@@ -1729,6 +3028,63 @@ module Aws::Connect
|
|
1729
3028
|
req.send_request(options)
|
1730
3029
|
end
|
1731
3030
|
|
3031
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3032
|
+
# change.
|
3033
|
+
#
|
3034
|
+
# Provides information about the quick connects for the specified Amazon
|
3035
|
+
# Connect instance.
|
3036
|
+
#
|
3037
|
+
# @option params [required, String] :instance_id
|
3038
|
+
# The identifier of the Amazon Connect instance.
|
3039
|
+
#
|
3040
|
+
# @option params [String] :next_token
|
3041
|
+
# The token for the next set of results. Use the value returned in the
|
3042
|
+
# previous response in the next request to retrieve the next set of
|
3043
|
+
# results.
|
3044
|
+
#
|
3045
|
+
# @option params [Integer] :max_results
|
3046
|
+
# The maximimum number of results to return per page.
|
3047
|
+
#
|
3048
|
+
# @option params [Array<String>] :quick_connect_types
|
3049
|
+
# The type of quick connect. In the Amazon Connect console, when you
|
3050
|
+
# create a quick connect, you are prompted to assign one of the
|
3051
|
+
# following types: Agent (USER), External (PHONE\_NUMBER), or Queue
|
3052
|
+
# (QUEUE).
|
3053
|
+
#
|
3054
|
+
# @return [Types::ListQuickConnectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3055
|
+
#
|
3056
|
+
# * {Types::ListQuickConnectsResponse#quick_connect_summary_list #quick_connect_summary_list} => Array<Types::QuickConnectSummary>
|
3057
|
+
# * {Types::ListQuickConnectsResponse#next_token #next_token} => String
|
3058
|
+
#
|
3059
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3060
|
+
#
|
3061
|
+
# @example Request syntax with placeholder values
|
3062
|
+
#
|
3063
|
+
# resp = client.list_quick_connects({
|
3064
|
+
# instance_id: "InstanceId", # required
|
3065
|
+
# next_token: "NextToken",
|
3066
|
+
# max_results: 1,
|
3067
|
+
# quick_connect_types: ["USER"], # accepts USER, QUEUE, PHONE_NUMBER
|
3068
|
+
# })
|
3069
|
+
#
|
3070
|
+
# @example Response structure
|
3071
|
+
#
|
3072
|
+
# resp.quick_connect_summary_list #=> Array
|
3073
|
+
# resp.quick_connect_summary_list[0].id #=> String
|
3074
|
+
# resp.quick_connect_summary_list[0].arn #=> String
|
3075
|
+
# resp.quick_connect_summary_list[0].name #=> String
|
3076
|
+
# resp.quick_connect_summary_list[0].quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
|
3077
|
+
# resp.next_token #=> String
|
3078
|
+
#
|
3079
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQuickConnects AWS API Documentation
|
3080
|
+
#
|
3081
|
+
# @overload list_quick_connects(params = {})
|
3082
|
+
# @param [Hash] params ({})
|
3083
|
+
def list_quick_connects(params = {}, options = {})
|
3084
|
+
req = build_request(:list_quick_connects, params)
|
3085
|
+
req.send_request(options)
|
3086
|
+
end
|
3087
|
+
|
1732
3088
|
# List the queues associated with a routing profile.
|
1733
3089
|
#
|
1734
3090
|
# @option params [required, String] :instance_id
|
@@ -1770,7 +3126,7 @@ module Aws::Connect
|
|
1770
3126
|
# resp.routing_profile_queue_config_summary_list[0].queue_name #=> String
|
1771
3127
|
# resp.routing_profile_queue_config_summary_list[0].priority #=> Integer
|
1772
3128
|
# 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"
|
3129
|
+
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
1774
3130
|
#
|
1775
3131
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueues AWS API Documentation
|
1776
3132
|
#
|
@@ -1790,8 +3146,57 @@ module Aws::Connect
|
|
1790
3146
|
#
|
1791
3147
|
#
|
1792
3148
|
#
|
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
|
3149
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html
|
3150
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html
|
3151
|
+
#
|
3152
|
+
# @option params [required, String] :instance_id
|
3153
|
+
# The identifier of the Amazon Connect instance.
|
3154
|
+
#
|
3155
|
+
# @option params [String] :next_token
|
3156
|
+
# The token for the next set of results. Use the value returned in the
|
3157
|
+
# previous response in the next request to retrieve the next set of
|
3158
|
+
# results.
|
3159
|
+
#
|
3160
|
+
# @option params [Integer] :max_results
|
3161
|
+
# The maximimum number of results to return per page.
|
3162
|
+
#
|
3163
|
+
# @return [Types::ListRoutingProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3164
|
+
#
|
3165
|
+
# * {Types::ListRoutingProfilesResponse#routing_profile_summary_list #routing_profile_summary_list} => Array<Types::RoutingProfileSummary>
|
3166
|
+
# * {Types::ListRoutingProfilesResponse#next_token #next_token} => String
|
3167
|
+
#
|
3168
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3169
|
+
#
|
3170
|
+
# @example Request syntax with placeholder values
|
3171
|
+
#
|
3172
|
+
# resp = client.list_routing_profiles({
|
3173
|
+
# instance_id: "InstanceId", # required
|
3174
|
+
# next_token: "NextToken",
|
3175
|
+
# max_results: 1,
|
3176
|
+
# })
|
3177
|
+
#
|
3178
|
+
# @example Response structure
|
3179
|
+
#
|
3180
|
+
# resp.routing_profile_summary_list #=> Array
|
3181
|
+
# resp.routing_profile_summary_list[0].id #=> String
|
3182
|
+
# resp.routing_profile_summary_list[0].arn #=> String
|
3183
|
+
# resp.routing_profile_summary_list[0].name #=> String
|
3184
|
+
# resp.next_token #=> String
|
3185
|
+
#
|
3186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfiles AWS API Documentation
|
3187
|
+
#
|
3188
|
+
# @overload list_routing_profiles(params = {})
|
3189
|
+
# @param [Hash] params ({})
|
3190
|
+
def list_routing_profiles(params = {}, options = {})
|
3191
|
+
req = build_request(:list_routing_profiles, params)
|
3192
|
+
req.send_request(options)
|
3193
|
+
end
|
3194
|
+
|
3195
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3196
|
+
# change.
|
3197
|
+
#
|
3198
|
+
# Returns a paginated list of all security keys associated with the
|
3199
|
+
# instance.
|
1795
3200
|
#
|
1796
3201
|
# @option params [required, String] :instance_id
|
1797
3202
|
# The identifier of the Amazon Connect instance.
|
@@ -1804,16 +3209,16 @@ module Aws::Connect
|
|
1804
3209
|
# @option params [Integer] :max_results
|
1805
3210
|
# The maximimum number of results to return per page.
|
1806
3211
|
#
|
1807
|
-
# @return [Types::
|
3212
|
+
# @return [Types::ListSecurityKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1808
3213
|
#
|
1809
|
-
# * {Types::
|
1810
|
-
# * {Types::
|
3214
|
+
# * {Types::ListSecurityKeysResponse#security_keys #security_keys} => Array<Types::SecurityKey>
|
3215
|
+
# * {Types::ListSecurityKeysResponse#next_token #next_token} => String
|
1811
3216
|
#
|
1812
3217
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1813
3218
|
#
|
1814
3219
|
# @example Request syntax with placeholder values
|
1815
3220
|
#
|
1816
|
-
# resp = client.
|
3221
|
+
# resp = client.list_security_keys({
|
1817
3222
|
# instance_id: "InstanceId", # required
|
1818
3223
|
# next_token: "NextToken",
|
1819
3224
|
# max_results: 1,
|
@@ -1821,18 +3226,18 @@ module Aws::Connect
|
|
1821
3226
|
#
|
1822
3227
|
# @example Response structure
|
1823
3228
|
#
|
1824
|
-
# resp.
|
1825
|
-
# resp.
|
1826
|
-
# resp.
|
1827
|
-
# resp.
|
3229
|
+
# resp.security_keys #=> Array
|
3230
|
+
# resp.security_keys[0].association_id #=> String
|
3231
|
+
# resp.security_keys[0].key #=> String
|
3232
|
+
# resp.security_keys[0].creation_time #=> Time
|
1828
3233
|
# resp.next_token #=> String
|
1829
3234
|
#
|
1830
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
3235
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityKeys AWS API Documentation
|
1831
3236
|
#
|
1832
|
-
# @overload
|
3237
|
+
# @overload list_security_keys(params = {})
|
1833
3238
|
# @param [Hash] params ({})
|
1834
|
-
def
|
1835
|
-
req = build_request(:
|
3239
|
+
def list_security_keys(params = {}, options = {})
|
3240
|
+
req = build_request(:list_security_keys, params)
|
1836
3241
|
req.send_request(options)
|
1837
3242
|
end
|
1838
3243
|
|
@@ -1925,6 +3330,58 @@ module Aws::Connect
|
|
1925
3330
|
req.send_request(options)
|
1926
3331
|
end
|
1927
3332
|
|
3333
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3334
|
+
# change.
|
3335
|
+
#
|
3336
|
+
# List the use cases.
|
3337
|
+
#
|
3338
|
+
# @option params [required, String] :instance_id
|
3339
|
+
# The identifier of the Amazon Connect instance.
|
3340
|
+
#
|
3341
|
+
# @option params [required, String] :integration_association_id
|
3342
|
+
# The identifier for the integration association.
|
3343
|
+
#
|
3344
|
+
# @option params [String] :next_token
|
3345
|
+
# The token for the next set of results. Use the value returned in the
|
3346
|
+
# previous response in the next request to retrieve the next set of
|
3347
|
+
# results.
|
3348
|
+
#
|
3349
|
+
# @option params [Integer] :max_results
|
3350
|
+
# The maximimum number of results to return per page.
|
3351
|
+
#
|
3352
|
+
# @return [Types::ListUseCasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3353
|
+
#
|
3354
|
+
# * {Types::ListUseCasesResponse#use_case_summary_list #use_case_summary_list} => Array<Types::UseCase>
|
3355
|
+
# * {Types::ListUseCasesResponse#next_token #next_token} => String
|
3356
|
+
#
|
3357
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3358
|
+
#
|
3359
|
+
# @example Request syntax with placeholder values
|
3360
|
+
#
|
3361
|
+
# resp = client.list_use_cases({
|
3362
|
+
# instance_id: "InstanceId", # required
|
3363
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
3364
|
+
# next_token: "NextToken",
|
3365
|
+
# max_results: 1,
|
3366
|
+
# })
|
3367
|
+
#
|
3368
|
+
# @example Response structure
|
3369
|
+
#
|
3370
|
+
# resp.use_case_summary_list #=> Array
|
3371
|
+
# resp.use_case_summary_list[0].use_case_id #=> String
|
3372
|
+
# resp.use_case_summary_list[0].use_case_arn #=> String
|
3373
|
+
# resp.use_case_summary_list[0].use_case_type #=> String, one of "RULES_EVALUATION"
|
3374
|
+
# resp.next_token #=> String
|
3375
|
+
#
|
3376
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCases AWS API Documentation
|
3377
|
+
#
|
3378
|
+
# @overload list_use_cases(params = {})
|
3379
|
+
# @param [Hash] params ({})
|
3380
|
+
def list_use_cases(params = {}, options = {})
|
3381
|
+
req = build_request(:list_use_cases, params)
|
3382
|
+
req.send_request(options)
|
3383
|
+
end
|
3384
|
+
|
1928
3385
|
# Provides summary information about the hierarchy groups for the
|
1929
3386
|
# specified Amazon Connect instance.
|
1930
3387
|
#
|
@@ -2311,6 +3768,89 @@ module Aws::Connect
|
|
2311
3768
|
req.send_request(options)
|
2312
3769
|
end
|
2313
3770
|
|
3771
|
+
# Initiates a contact flow to start a new task.
|
3772
|
+
#
|
3773
|
+
# @option params [required, String] :instance_id
|
3774
|
+
# The identifier of the Amazon Connect instance.
|
3775
|
+
#
|
3776
|
+
# @option params [String] :previous_contact_id
|
3777
|
+
# The identifier of the previous chat, voice, or task contact.
|
3778
|
+
#
|
3779
|
+
# @option params [required, String] :contact_flow_id
|
3780
|
+
# The identifier of the contact flow for initiating the tasks. To see
|
3781
|
+
# the ContactFlowId in the Amazon Connect console user interface, on the
|
3782
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
3783
|
+
# contact flow. On the contact flow page, under the name of the contact
|
3784
|
+
# flow, choose **Show additional flow information**. The ContactFlowId
|
3785
|
+
# is the last part of the ARN, shown here in bold:
|
3786
|
+
#
|
3787
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
3788
|
+
#
|
3789
|
+
# @option params [Hash<String,String>] :attributes
|
3790
|
+
# A custom key-value pair using an attribute map. The attributes are
|
3791
|
+
# standard Amazon Connect attributes, and can be accessed in contact
|
3792
|
+
# flows just like any other contact attributes.
|
3793
|
+
#
|
3794
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
3795
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
3796
|
+
# underscore characters.
|
3797
|
+
#
|
3798
|
+
# @option params [required, String] :name
|
3799
|
+
# The name of a task that is shown to an agent in the Contact Control
|
3800
|
+
# Panel (CCP).
|
3801
|
+
#
|
3802
|
+
# @option params [Hash<String,Types::Reference>] :references
|
3803
|
+
# A formatted URL that is shown to an agent in the Contact Control Panel
|
3804
|
+
# (CCP).
|
3805
|
+
#
|
3806
|
+
# @option params [String] :description
|
3807
|
+
# A description of the task that is shown to an agent in the Contact
|
3808
|
+
# Control Panel (CCP).
|
3809
|
+
#
|
3810
|
+
# @option params [String] :client_token
|
3811
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
3812
|
+
# idempotency of the request.
|
3813
|
+
#
|
3814
|
+
# **A suitable default value is auto-generated.** You should normally
|
3815
|
+
# not need to pass this option.**
|
3816
|
+
#
|
3817
|
+
# @return [Types::StartTaskContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3818
|
+
#
|
3819
|
+
# * {Types::StartTaskContactResponse#contact_id #contact_id} => String
|
3820
|
+
#
|
3821
|
+
# @example Request syntax with placeholder values
|
3822
|
+
#
|
3823
|
+
# resp = client.start_task_contact({
|
3824
|
+
# instance_id: "InstanceId", # required
|
3825
|
+
# previous_contact_id: "ContactId",
|
3826
|
+
# contact_flow_id: "ContactFlowId", # required
|
3827
|
+
# attributes: {
|
3828
|
+
# "AttributeName" => "AttributeValue",
|
3829
|
+
# },
|
3830
|
+
# name: "Name", # required
|
3831
|
+
# references: {
|
3832
|
+
# "ReferenceKey" => {
|
3833
|
+
# value: "ReferenceValue", # required
|
3834
|
+
# type: "URL", # required, accepts URL
|
3835
|
+
# },
|
3836
|
+
# },
|
3837
|
+
# description: "Description",
|
3838
|
+
# client_token: "ClientToken",
|
3839
|
+
# })
|
3840
|
+
#
|
3841
|
+
# @example Response structure
|
3842
|
+
#
|
3843
|
+
# resp.contact_id #=> String
|
3844
|
+
#
|
3845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContact AWS API Documentation
|
3846
|
+
#
|
3847
|
+
# @overload start_task_contact(params = {})
|
3848
|
+
# @param [Hash] params ({})
|
3849
|
+
def start_task_contact(params = {}, options = {})
|
3850
|
+
req = build_request(:start_task_contact, params)
|
3851
|
+
req.send_request(options)
|
3852
|
+
end
|
3853
|
+
|
2314
3854
|
# Ends the specified contact.
|
2315
3855
|
#
|
2316
3856
|
# @option params [required, String] :contact_id
|
@@ -2417,8 +3957,8 @@ module Aws::Connect
|
|
2417
3957
|
|
2418
3958
|
# Adds the specified tags to the specified resource.
|
2419
3959
|
#
|
2420
|
-
# The supported resource types are users, routing profiles,
|
2421
|
-
# flows.
|
3960
|
+
# The supported resource types are users, routing profiles, quick
|
3961
|
+
# connects, and contact flows.
|
2422
3962
|
#
|
2423
3963
|
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
2424
3964
|
# Policy Examples][1] in the *Amazon Connect Administrator Guide*.
|
@@ -2496,9 +4036,6 @@ module Aws::Connect
|
|
2496
4036
|
# Contact attributes are available in Amazon Connect for 24 months, and
|
2497
4037
|
# are then deleted.
|
2498
4038
|
#
|
2499
|
-
# This operation is also available in the Amazon Connect Flow language.
|
2500
|
-
# See [UpdateContactAttributes][1].
|
2501
|
-
#
|
2502
4039
|
# **Important:** You cannot use the operation to update attributes for
|
2503
4040
|
# contacts that occurred prior to the release of the API, September 12,
|
2504
4041
|
# 2018. You can update attributes only for contacts that started after
|
@@ -2507,10 +4044,6 @@ module Aws::Connect
|
|
2507
4044
|
# returned. This applies also to queued callbacks that were initiated
|
2508
4045
|
# prior to the release of the API but are still active in your instance.
|
2509
4046
|
#
|
2510
|
-
#
|
2511
|
-
#
|
2512
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-actions-updatecontactattributes.html
|
2513
|
-
#
|
2514
4047
|
# @option params [required, String] :initial_contact_id
|
2515
4048
|
# The identifier of the contact. This is the identifier of the contact
|
2516
4049
|
# associated with the first interaction with the contact center.
|
@@ -2592,6 +4125,13 @@ module Aws::Connect
|
|
2592
4125
|
|
2593
4126
|
# The name of the contact flow.
|
2594
4127
|
#
|
4128
|
+
# You can also create and update contact flows using the [Amazon Connect
|
4129
|
+
# Flow language][1].
|
4130
|
+
#
|
4131
|
+
#
|
4132
|
+
#
|
4133
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
4134
|
+
#
|
2595
4135
|
# @option params [required, String] :instance_id
|
2596
4136
|
# The identifier of the Amazon Connect instance.
|
2597
4137
|
#
|
@@ -2624,6 +4164,188 @@ module Aws::Connect
|
|
2624
4164
|
req.send_request(options)
|
2625
4165
|
end
|
2626
4166
|
|
4167
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4168
|
+
# change.
|
4169
|
+
#
|
4170
|
+
# Updates the value for the specified attribute type.
|
4171
|
+
#
|
4172
|
+
# @option params [required, String] :instance_id
|
4173
|
+
# The identifier of the Amazon Connect instance.
|
4174
|
+
#
|
4175
|
+
# @option params [required, String] :attribute_type
|
4176
|
+
# The type of attribute.
|
4177
|
+
#
|
4178
|
+
# @option params [required, String] :value
|
4179
|
+
# The value for the attribute. Maximum character limit is 100.
|
4180
|
+
#
|
4181
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4182
|
+
#
|
4183
|
+
# @example Request syntax with placeholder values
|
4184
|
+
#
|
4185
|
+
# resp = client.update_instance_attribute({
|
4186
|
+
# instance_id: "InstanceId", # required
|
4187
|
+
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA
|
4188
|
+
# value: "InstanceAttributeValue", # required
|
4189
|
+
# })
|
4190
|
+
#
|
4191
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateInstanceAttribute AWS API Documentation
|
4192
|
+
#
|
4193
|
+
# @overload update_instance_attribute(params = {})
|
4194
|
+
# @param [Hash] params ({})
|
4195
|
+
def update_instance_attribute(params = {}, options = {})
|
4196
|
+
req = build_request(:update_instance_attribute, params)
|
4197
|
+
req.send_request(options)
|
4198
|
+
end
|
4199
|
+
|
4200
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4201
|
+
# change.
|
4202
|
+
#
|
4203
|
+
# Updates an existing configuration for a resource type. This API is
|
4204
|
+
# idempotent.
|
4205
|
+
#
|
4206
|
+
# @option params [required, String] :instance_id
|
4207
|
+
# The identifier of the Amazon Connect instance.
|
4208
|
+
#
|
4209
|
+
# @option params [required, String] :association_id
|
4210
|
+
# The existing association identifier that uniquely identifies the
|
4211
|
+
# resource type and storage config for the given instance ID.
|
4212
|
+
#
|
4213
|
+
# @option params [required, String] :resource_type
|
4214
|
+
# A valid resource type.
|
4215
|
+
#
|
4216
|
+
# @option params [required, Types::InstanceStorageConfig] :storage_config
|
4217
|
+
# The storage configuration for the instance.
|
4218
|
+
#
|
4219
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4220
|
+
#
|
4221
|
+
# @example Request syntax with placeholder values
|
4222
|
+
#
|
4223
|
+
# resp = client.update_instance_storage_config({
|
4224
|
+
# instance_id: "InstanceId", # required
|
4225
|
+
# association_id: "AssociationId", # required
|
4226
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
4227
|
+
# storage_config: { # required
|
4228
|
+
# association_id: "AssociationId",
|
4229
|
+
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
4230
|
+
# s3_config: {
|
4231
|
+
# bucket_name: "BucketName", # required
|
4232
|
+
# bucket_prefix: "Prefix", # required
|
4233
|
+
# encryption_config: {
|
4234
|
+
# encryption_type: "KMS", # required, accepts KMS
|
4235
|
+
# key_id: "KeyId", # required
|
4236
|
+
# },
|
4237
|
+
# },
|
4238
|
+
# kinesis_video_stream_config: {
|
4239
|
+
# prefix: "Prefix", # required
|
4240
|
+
# retention_period_hours: 1, # required
|
4241
|
+
# encryption_config: { # required
|
4242
|
+
# encryption_type: "KMS", # required, accepts KMS
|
4243
|
+
# key_id: "KeyId", # required
|
4244
|
+
# },
|
4245
|
+
# },
|
4246
|
+
# kinesis_stream_config: {
|
4247
|
+
# stream_arn: "ARN", # required
|
4248
|
+
# },
|
4249
|
+
# kinesis_firehose_config: {
|
4250
|
+
# firehose_arn: "ARN", # required
|
4251
|
+
# },
|
4252
|
+
# },
|
4253
|
+
# })
|
4254
|
+
#
|
4255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateInstanceStorageConfig AWS API Documentation
|
4256
|
+
#
|
4257
|
+
# @overload update_instance_storage_config(params = {})
|
4258
|
+
# @param [Hash] params ({})
|
4259
|
+
def update_instance_storage_config(params = {}, options = {})
|
4260
|
+
req = build_request(:update_instance_storage_config, params)
|
4261
|
+
req.send_request(options)
|
4262
|
+
end
|
4263
|
+
|
4264
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4265
|
+
# change.
|
4266
|
+
#
|
4267
|
+
# Updates the configuration settings for the specified quick connect.
|
4268
|
+
#
|
4269
|
+
# @option params [required, String] :instance_id
|
4270
|
+
# The identifier of the Amazon Connect instance.
|
4271
|
+
#
|
4272
|
+
# @option params [required, String] :quick_connect_id
|
4273
|
+
# The identifier for the quick connect.
|
4274
|
+
#
|
4275
|
+
# @option params [required, Types::QuickConnectConfig] :quick_connect_config
|
4276
|
+
# Information about the configuration settings for the quick connect.
|
4277
|
+
#
|
4278
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4279
|
+
#
|
4280
|
+
# @example Request syntax with placeholder values
|
4281
|
+
#
|
4282
|
+
# resp = client.update_quick_connect_config({
|
4283
|
+
# instance_id: "InstanceId", # required
|
4284
|
+
# quick_connect_id: "QuickConnectId", # required
|
4285
|
+
# quick_connect_config: { # required
|
4286
|
+
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
4287
|
+
# user_config: {
|
4288
|
+
# user_id: "UserId", # required
|
4289
|
+
# contact_flow_id: "ContactFlowId", # required
|
4290
|
+
# },
|
4291
|
+
# queue_config: {
|
4292
|
+
# queue_id: "QueueId", # required
|
4293
|
+
# contact_flow_id: "ContactFlowId", # required
|
4294
|
+
# },
|
4295
|
+
# phone_config: {
|
4296
|
+
# phone_number: "PhoneNumber", # required
|
4297
|
+
# },
|
4298
|
+
# },
|
4299
|
+
# })
|
4300
|
+
#
|
4301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQuickConnectConfig AWS API Documentation
|
4302
|
+
#
|
4303
|
+
# @overload update_quick_connect_config(params = {})
|
4304
|
+
# @param [Hash] params ({})
|
4305
|
+
def update_quick_connect_config(params = {}, options = {})
|
4306
|
+
req = build_request(:update_quick_connect_config, params)
|
4307
|
+
req.send_request(options)
|
4308
|
+
end
|
4309
|
+
|
4310
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4311
|
+
# change.
|
4312
|
+
#
|
4313
|
+
# Updates the name and description of a quick connect. The request
|
4314
|
+
# accepts the following data in JSON format. At least Name or
|
4315
|
+
# Description must be provided.
|
4316
|
+
#
|
4317
|
+
# @option params [required, String] :instance_id
|
4318
|
+
# The identifier of the Amazon Connect instance.
|
4319
|
+
#
|
4320
|
+
# @option params [required, String] :quick_connect_id
|
4321
|
+
# The identifier for the quick connect.
|
4322
|
+
#
|
4323
|
+
# @option params [String] :name
|
4324
|
+
# The name of the quick connect.
|
4325
|
+
#
|
4326
|
+
# @option params [String] :description
|
4327
|
+
# The description of the quick connect.
|
4328
|
+
#
|
4329
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4330
|
+
#
|
4331
|
+
# @example Request syntax with placeholder values
|
4332
|
+
#
|
4333
|
+
# resp = client.update_quick_connect_name({
|
4334
|
+
# instance_id: "InstanceId", # required
|
4335
|
+
# quick_connect_id: "QuickConnectId", # required
|
4336
|
+
# name: "QuickConnectName",
|
4337
|
+
# description: "QuickConnectDescription",
|
4338
|
+
# })
|
4339
|
+
#
|
4340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQuickConnectName AWS API Documentation
|
4341
|
+
#
|
4342
|
+
# @overload update_quick_connect_name(params = {})
|
4343
|
+
# @param [Hash] params ({})
|
4344
|
+
def update_quick_connect_name(params = {}, options = {})
|
4345
|
+
req = build_request(:update_quick_connect_name, params)
|
4346
|
+
req.send_request(options)
|
4347
|
+
end
|
4348
|
+
|
2627
4349
|
# Updates the channels that agents can handle in the Contact Control
|
2628
4350
|
# Panel (CCP) for a routing profile.
|
2629
4351
|
#
|
@@ -2645,7 +4367,7 @@ module Aws::Connect
|
|
2645
4367
|
# routing_profile_id: "RoutingProfileId", # required
|
2646
4368
|
# media_concurrencies: [ # required
|
2647
4369
|
# {
|
2648
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
4370
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
2649
4371
|
# concurrency: 1, # required
|
2650
4372
|
# },
|
2651
4373
|
# ],
|
@@ -2737,7 +4459,9 @@ module Aws::Connect
|
|
2737
4459
|
# The identifier of the routing profile.
|
2738
4460
|
#
|
2739
4461
|
# @option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
2740
|
-
# The queues to be updated for this routing profile.
|
4462
|
+
# The queues to be updated for this routing profile. Queues must first
|
4463
|
+
# be associated to the routing profile. You can do this using
|
4464
|
+
# AssociateRoutingProfileQueues.
|
2741
4465
|
#
|
2742
4466
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2743
4467
|
#
|
@@ -2750,7 +4474,7 @@ module Aws::Connect
|
|
2750
4474
|
# {
|
2751
4475
|
# queue_reference: { # required
|
2752
4476
|
# queue_id: "QueueId", # required
|
2753
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
4477
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
2754
4478
|
# },
|
2755
4479
|
# priority: 1, # required
|
2756
4480
|
# delay: 1, # required
|
@@ -2797,6 +4521,79 @@ module Aws::Connect
|
|
2797
4521
|
req.send_request(options)
|
2798
4522
|
end
|
2799
4523
|
|
4524
|
+
# Updates the name of the user hierarchy group.
|
4525
|
+
#
|
4526
|
+
# @option params [required, String] :name
|
4527
|
+
# The name of the hierarchy group. Must not be more than 100 characters.
|
4528
|
+
#
|
4529
|
+
# @option params [required, String] :hierarchy_group_id
|
4530
|
+
# The identifier of the hierarchy group.
|
4531
|
+
#
|
4532
|
+
# @option params [required, String] :instance_id
|
4533
|
+
# The identifier of the Amazon Connect instance.
|
4534
|
+
#
|
4535
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4536
|
+
#
|
4537
|
+
# @example Request syntax with placeholder values
|
4538
|
+
#
|
4539
|
+
# resp = client.update_user_hierarchy_group_name({
|
4540
|
+
# name: "HierarchyGroupName", # required
|
4541
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
4542
|
+
# instance_id: "InstanceId", # required
|
4543
|
+
# })
|
4544
|
+
#
|
4545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyGroupName AWS API Documentation
|
4546
|
+
#
|
4547
|
+
# @overload update_user_hierarchy_group_name(params = {})
|
4548
|
+
# @param [Hash] params ({})
|
4549
|
+
def update_user_hierarchy_group_name(params = {}, options = {})
|
4550
|
+
req = build_request(:update_user_hierarchy_group_name, params)
|
4551
|
+
req.send_request(options)
|
4552
|
+
end
|
4553
|
+
|
4554
|
+
# Updates the user hierarchy structure: add, remove, and rename user
|
4555
|
+
# hierarchy levels.
|
4556
|
+
#
|
4557
|
+
# @option params [required, Types::HierarchyStructureUpdate] :hierarchy_structure
|
4558
|
+
# The hierarchy levels to update.
|
4559
|
+
#
|
4560
|
+
# @option params [required, String] :instance_id
|
4561
|
+
# The identifier of the Amazon Connect instance.
|
4562
|
+
#
|
4563
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4564
|
+
#
|
4565
|
+
# @example Request syntax with placeholder values
|
4566
|
+
#
|
4567
|
+
# resp = client.update_user_hierarchy_structure({
|
4568
|
+
# hierarchy_structure: { # required
|
4569
|
+
# level_one: {
|
4570
|
+
# name: "HierarchyLevelName", # required
|
4571
|
+
# },
|
4572
|
+
# level_two: {
|
4573
|
+
# name: "HierarchyLevelName", # required
|
4574
|
+
# },
|
4575
|
+
# level_three: {
|
4576
|
+
# name: "HierarchyLevelName", # required
|
4577
|
+
# },
|
4578
|
+
# level_four: {
|
4579
|
+
# name: "HierarchyLevelName", # required
|
4580
|
+
# },
|
4581
|
+
# level_five: {
|
4582
|
+
# name: "HierarchyLevelName", # required
|
4583
|
+
# },
|
4584
|
+
# },
|
4585
|
+
# instance_id: "InstanceId", # required
|
4586
|
+
# })
|
4587
|
+
#
|
4588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyStructure AWS API Documentation
|
4589
|
+
#
|
4590
|
+
# @overload update_user_hierarchy_structure(params = {})
|
4591
|
+
# @param [Hash] params ({})
|
4592
|
+
def update_user_hierarchy_structure(params = {}, options = {})
|
4593
|
+
req = build_request(:update_user_hierarchy_structure, params)
|
4594
|
+
req.send_request(options)
|
4595
|
+
end
|
4596
|
+
|
2800
4597
|
# Updates the identity information for the specified user.
|
2801
4598
|
#
|
2802
4599
|
# Someone with the ability to invoke `UpdateUserIndentityInfo` can
|
@@ -2952,7 +4749,7 @@ module Aws::Connect
|
|
2952
4749
|
params: params,
|
2953
4750
|
config: config)
|
2954
4751
|
context[:gem_name] = 'aws-sdk-connect'
|
2955
|
-
context[:gem_version] = '1.
|
4752
|
+
context[:gem_version] = '1.38.0'
|
2956
4753
|
Seahorse::Client::Request.new(handlers, context)
|
2957
4754
|
end
|
2958
4755
|
|