aws-sdk-connect 1.34.0 → 1.39.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-connect.rb +2 -2
- data/lib/aws-sdk-connect/client.rb +2603 -348
- data/lib/aws-sdk-connect/client_api.rb +1499 -9
- data/lib/aws-sdk-connect/errors.rb +58 -0
- data/lib/aws-sdk-connect/types.rb +5052 -1799
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ca76bb2bcb3d132d1dcf550221bdd17c45516d7d85e86ff48cd5e99fd88a45ad
|
4
|
+
data.tar.gz: 7368af9e52149a9c8c80de6526bf1e8b276c88e05424d103c5c7ede968a1c8bb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9f31913187d2b7c88adce8bcf00ea7d8b782e8e2a1b6c78e8ed1054b5cc388b4adc302b4eed987ad69e3e0ffda7e16e9f2cb8043a85e3b70f2a525b3d1ae9f32
|
7
|
+
data.tar.gz: cc4d57464c430fdfc90775238b592763df58b1280a0276b004a5844c76199bbecad4b99be9aa3249873cfe8db11dbba9fa6f5f471151883a8e9b0f06ee705570
|
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.39.0'
|
52
52
|
|
53
53
|
end
|
@@ -327,6 +327,204 @@ 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 S3 bucket, exists when
|
370
|
+
# 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
|
+
|
495
|
+
# This API is in preview release for Amazon Connect and is subject to
|
496
|
+
# change.
|
497
|
+
#
|
498
|
+
# Associates a set of quick connects with a queue.
|
499
|
+
#
|
500
|
+
# @option params [required, String] :instance_id
|
501
|
+
# The identifier of the Amazon Connect instance.
|
502
|
+
#
|
503
|
+
# @option params [required, String] :queue_id
|
504
|
+
# The identifier for the queue.
|
505
|
+
#
|
506
|
+
# @option params [required, Array<String>] :quick_connect_ids
|
507
|
+
# The quick connects to associate with this queue.
|
508
|
+
#
|
509
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
510
|
+
#
|
511
|
+
# @example Request syntax with placeholder values
|
512
|
+
#
|
513
|
+
# resp = client.associate_queue_quick_connects({
|
514
|
+
# instance_id: "InstanceId", # required
|
515
|
+
# queue_id: "QueueId", # required
|
516
|
+
# quick_connect_ids: ["QuickConnectId"], # required
|
517
|
+
# })
|
518
|
+
#
|
519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateQueueQuickConnects AWS API Documentation
|
520
|
+
#
|
521
|
+
# @overload associate_queue_quick_connects(params = {})
|
522
|
+
# @param [Hash] params ({})
|
523
|
+
def associate_queue_quick_connects(params = {}, options = {})
|
524
|
+
req = build_request(:associate_queue_quick_connects, params)
|
525
|
+
req.send_request(options)
|
526
|
+
end
|
527
|
+
|
330
528
|
# Associates a set of queues with a routing profile.
|
331
529
|
#
|
332
530
|
# @option params [required, String] :instance_id
|
@@ -349,7 +547,7 @@ module Aws::Connect
|
|
349
547
|
# {
|
350
548
|
# queue_reference: { # required
|
351
549
|
# queue_id: "QueueId", # required
|
352
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
550
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
353
551
|
# },
|
354
552
|
# priority: 1, # required
|
355
553
|
# delay: 1, # required
|
@@ -366,6 +564,41 @@ module Aws::Connect
|
|
366
564
|
req.send_request(options)
|
367
565
|
end
|
368
566
|
|
567
|
+
# This API is in preview release for Amazon Connect and is subject to
|
568
|
+
# change.
|
569
|
+
#
|
570
|
+
# Associates a security key to the instance.
|
571
|
+
#
|
572
|
+
# @option params [required, String] :instance_id
|
573
|
+
# The identifier of the Amazon Connect instance.
|
574
|
+
#
|
575
|
+
# @option params [required, String] :key
|
576
|
+
# A valid security key in PEM format.
|
577
|
+
#
|
578
|
+
# @return [Types::AssociateSecurityKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
579
|
+
#
|
580
|
+
# * {Types::AssociateSecurityKeyResponse#association_id #association_id} => String
|
581
|
+
#
|
582
|
+
# @example Request syntax with placeholder values
|
583
|
+
#
|
584
|
+
# resp = client.associate_security_key({
|
585
|
+
# instance_id: "InstanceId", # required
|
586
|
+
# key: "PEM", # required
|
587
|
+
# })
|
588
|
+
#
|
589
|
+
# @example Response structure
|
590
|
+
#
|
591
|
+
# resp.association_id #=> String
|
592
|
+
#
|
593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateSecurityKey AWS API Documentation
|
594
|
+
#
|
595
|
+
# @overload associate_security_key(params = {})
|
596
|
+
# @param [Hash] params ({})
|
597
|
+
def associate_security_key(params = {}, options = {})
|
598
|
+
req = build_request(:associate_security_key, params)
|
599
|
+
req.send_request(options)
|
600
|
+
end
|
601
|
+
|
369
602
|
# Creates a contact flow for the specified Amazon Connect instance.
|
370
603
|
#
|
371
604
|
# You can also create and update contact flows using the [Amazon Connect
|
@@ -431,6 +664,247 @@ module Aws::Connect
|
|
431
664
|
req.send_request(options)
|
432
665
|
end
|
433
666
|
|
667
|
+
# This API is in preview release for Amazon Connect and is subject to
|
668
|
+
# change.
|
669
|
+
#
|
670
|
+
# Initiates an Amazon Connect instance with all the supported channels
|
671
|
+
# enabled. It does not attach any storage, such as Amazon Simple Storage
|
672
|
+
# Service (Amazon S3) or Amazon Kinesis. It also does not allow for any
|
673
|
+
# configurations on features, such as Contact Lens for Amazon Connect.
|
674
|
+
#
|
675
|
+
# @option params [String] :client_token
|
676
|
+
# The idempotency token.
|
677
|
+
#
|
678
|
+
# @option params [required, String] :identity_management_type
|
679
|
+
# The type of identity management for your Amazon Connect users.
|
680
|
+
#
|
681
|
+
# @option params [String] :instance_alias
|
682
|
+
# The name for your instance.
|
683
|
+
#
|
684
|
+
# @option params [String] :directory_id
|
685
|
+
# The identifier for the directory.
|
686
|
+
#
|
687
|
+
# @option params [required, Boolean] :inbound_calls_enabled
|
688
|
+
# Your contact center handles incoming contacts.
|
689
|
+
#
|
690
|
+
# @option params [required, Boolean] :outbound_calls_enabled
|
691
|
+
# Your contact center allows outbound calls.
|
692
|
+
#
|
693
|
+
# @return [Types::CreateInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
694
|
+
#
|
695
|
+
# * {Types::CreateInstanceResponse#id #id} => String
|
696
|
+
# * {Types::CreateInstanceResponse#arn #arn} => String
|
697
|
+
#
|
698
|
+
# @example Request syntax with placeholder values
|
699
|
+
#
|
700
|
+
# resp = client.create_instance({
|
701
|
+
# client_token: "ClientToken",
|
702
|
+
# identity_management_type: "SAML", # required, accepts SAML, CONNECT_MANAGED, EXISTING_DIRECTORY
|
703
|
+
# instance_alias: "DirectoryAlias",
|
704
|
+
# directory_id: "DirectoryId",
|
705
|
+
# inbound_calls_enabled: false, # required
|
706
|
+
# outbound_calls_enabled: false, # required
|
707
|
+
# })
|
708
|
+
#
|
709
|
+
# @example Response structure
|
710
|
+
#
|
711
|
+
# resp.id #=> String
|
712
|
+
# resp.arn #=> String
|
713
|
+
#
|
714
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateInstance AWS API Documentation
|
715
|
+
#
|
716
|
+
# @overload create_instance(params = {})
|
717
|
+
# @param [Hash] params ({})
|
718
|
+
def create_instance(params = {}, options = {})
|
719
|
+
req = build_request(:create_instance, params)
|
720
|
+
req.send_request(options)
|
721
|
+
end
|
722
|
+
|
723
|
+
# This API is in preview release for Amazon Connect and is subject to
|
724
|
+
# change.
|
725
|
+
#
|
726
|
+
# Create an AppIntegration association with an Amazon Connect instance.
|
727
|
+
#
|
728
|
+
# @option params [required, String] :instance_id
|
729
|
+
# The identifier of the Amazon Connect instance.
|
730
|
+
#
|
731
|
+
# @option params [required, String] :integration_type
|
732
|
+
# The type of information to be ingested.
|
733
|
+
#
|
734
|
+
# @option params [required, String] :integration_arn
|
735
|
+
# The Amazon Resource Name (ARN) of the integration.
|
736
|
+
#
|
737
|
+
# @option params [required, String] :source_application_url
|
738
|
+
# The URL for the external application.
|
739
|
+
#
|
740
|
+
# @option params [required, String] :source_application_name
|
741
|
+
# The name of the external application.
|
742
|
+
#
|
743
|
+
# @option params [required, String] :source_type
|
744
|
+
# The type of the data source.
|
745
|
+
#
|
746
|
+
# @return [Types::CreateIntegrationAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
747
|
+
#
|
748
|
+
# * {Types::CreateIntegrationAssociationResponse#integration_association_id #integration_association_id} => String
|
749
|
+
# * {Types::CreateIntegrationAssociationResponse#integration_association_arn #integration_association_arn} => String
|
750
|
+
#
|
751
|
+
# @example Request syntax with placeholder values
|
752
|
+
#
|
753
|
+
# resp = client.create_integration_association({
|
754
|
+
# instance_id: "InstanceId", # required
|
755
|
+
# integration_type: "EVENT", # required, accepts EVENT
|
756
|
+
# integration_arn: "ARN", # required
|
757
|
+
# source_application_url: "URI", # required
|
758
|
+
# source_application_name: "SourceApplicationName", # required
|
759
|
+
# source_type: "SALESFORCE", # required, accepts SALESFORCE, ZENDESK
|
760
|
+
# })
|
761
|
+
#
|
762
|
+
# @example Response structure
|
763
|
+
#
|
764
|
+
# resp.integration_association_id #=> String
|
765
|
+
# resp.integration_association_arn #=> String
|
766
|
+
#
|
767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateIntegrationAssociation AWS API Documentation
|
768
|
+
#
|
769
|
+
# @overload create_integration_association(params = {})
|
770
|
+
# @param [Hash] params ({})
|
771
|
+
def create_integration_association(params = {}, options = {})
|
772
|
+
req = build_request(:create_integration_association, params)
|
773
|
+
req.send_request(options)
|
774
|
+
end
|
775
|
+
|
776
|
+
# This API is in preview release for Amazon Connect and is subject to
|
777
|
+
# change.
|
778
|
+
#
|
779
|
+
# Creates a new queue for the specified Amazon Connect instance.
|
780
|
+
#
|
781
|
+
# @option params [required, String] :instance_id
|
782
|
+
# The identifier of the Amazon Connect instance.
|
783
|
+
#
|
784
|
+
# @option params [required, String] :name
|
785
|
+
# The name of the queue.
|
786
|
+
#
|
787
|
+
# @option params [String] :description
|
788
|
+
# The description of the queue.
|
789
|
+
#
|
790
|
+
# @option params [Types::OutboundCallerConfig] :outbound_caller_config
|
791
|
+
# The outbound caller ID name, number, and outbound whisper flow.
|
792
|
+
#
|
793
|
+
# @option params [required, String] :hours_of_operation_id
|
794
|
+
# The identifier for the hours of operation.
|
795
|
+
#
|
796
|
+
# @option params [Integer] :max_contacts
|
797
|
+
# The maximum number of contacts that can be in the queue before it is
|
798
|
+
# considered full.
|
799
|
+
#
|
800
|
+
# @option params [Array<String>] :quick_connect_ids
|
801
|
+
# The quick connects available to agents who are working the queue.
|
802
|
+
#
|
803
|
+
# @option params [Hash<String,String>] :tags
|
804
|
+
# One or more tags.
|
805
|
+
#
|
806
|
+
# @return [Types::CreateQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
807
|
+
#
|
808
|
+
# * {Types::CreateQueueResponse#queue_arn #queue_arn} => String
|
809
|
+
# * {Types::CreateQueueResponse#queue_id #queue_id} => String
|
810
|
+
#
|
811
|
+
# @example Request syntax with placeholder values
|
812
|
+
#
|
813
|
+
# resp = client.create_queue({
|
814
|
+
# instance_id: "InstanceId", # required
|
815
|
+
# name: "CommonNameLength127", # required
|
816
|
+
# description: "QueueDescription",
|
817
|
+
# outbound_caller_config: {
|
818
|
+
# outbound_caller_id_name: "OutboundCallerIdName",
|
819
|
+
# outbound_caller_id_number_id: "PhoneNumberId",
|
820
|
+
# outbound_flow_id: "ContactFlowId",
|
821
|
+
# },
|
822
|
+
# hours_of_operation_id: "HoursOfOperationId", # required
|
823
|
+
# max_contacts: 1,
|
824
|
+
# quick_connect_ids: ["QuickConnectId"],
|
825
|
+
# tags: {
|
826
|
+
# "TagKey" => "TagValue",
|
827
|
+
# },
|
828
|
+
# })
|
829
|
+
#
|
830
|
+
# @example Response structure
|
831
|
+
#
|
832
|
+
# resp.queue_arn #=> String
|
833
|
+
# resp.queue_id #=> String
|
834
|
+
#
|
835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQueue AWS API Documentation
|
836
|
+
#
|
837
|
+
# @overload create_queue(params = {})
|
838
|
+
# @param [Hash] params ({})
|
839
|
+
def create_queue(params = {}, options = {})
|
840
|
+
req = build_request(:create_queue, params)
|
841
|
+
req.send_request(options)
|
842
|
+
end
|
843
|
+
|
844
|
+
# This API is in preview release for Amazon Connect and is subject to
|
845
|
+
# change.
|
846
|
+
#
|
847
|
+
# Creates a quick connect for the specified Amazon Connect instance.
|
848
|
+
#
|
849
|
+
# @option params [required, String] :instance_id
|
850
|
+
# The identifier of the Amazon Connect instance.
|
851
|
+
#
|
852
|
+
# @option params [required, String] :name
|
853
|
+
# The name of the quick connect.
|
854
|
+
#
|
855
|
+
# @option params [String] :description
|
856
|
+
# The description of the quick connect.
|
857
|
+
#
|
858
|
+
# @option params [required, Types::QuickConnectConfig] :quick_connect_config
|
859
|
+
# Configuration settings for the quick connect.
|
860
|
+
#
|
861
|
+
# @option params [Hash<String,String>] :tags
|
862
|
+
# One or more tags.
|
863
|
+
#
|
864
|
+
# @return [Types::CreateQuickConnectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
865
|
+
#
|
866
|
+
# * {Types::CreateQuickConnectResponse#quick_connect_arn #quick_connect_arn} => String
|
867
|
+
# * {Types::CreateQuickConnectResponse#quick_connect_id #quick_connect_id} => String
|
868
|
+
#
|
869
|
+
# @example Request syntax with placeholder values
|
870
|
+
#
|
871
|
+
# resp = client.create_quick_connect({
|
872
|
+
# instance_id: "InstanceId", # required
|
873
|
+
# name: "QuickConnectName", # required
|
874
|
+
# description: "QuickConnectDescription",
|
875
|
+
# quick_connect_config: { # required
|
876
|
+
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
877
|
+
# user_config: {
|
878
|
+
# user_id: "UserId", # required
|
879
|
+
# contact_flow_id: "ContactFlowId", # required
|
880
|
+
# },
|
881
|
+
# queue_config: {
|
882
|
+
# queue_id: "QueueId", # required
|
883
|
+
# contact_flow_id: "ContactFlowId", # required
|
884
|
+
# },
|
885
|
+
# phone_config: {
|
886
|
+
# phone_number: "PhoneNumber", # required
|
887
|
+
# },
|
888
|
+
# },
|
889
|
+
# tags: {
|
890
|
+
# "TagKey" => "TagValue",
|
891
|
+
# },
|
892
|
+
# })
|
893
|
+
#
|
894
|
+
# @example Response structure
|
895
|
+
#
|
896
|
+
# resp.quick_connect_arn #=> String
|
897
|
+
# resp.quick_connect_id #=> String
|
898
|
+
#
|
899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQuickConnect AWS API Documentation
|
900
|
+
#
|
901
|
+
# @overload create_quick_connect(params = {})
|
902
|
+
# @param [Hash] params ({})
|
903
|
+
def create_quick_connect(params = {}, options = {})
|
904
|
+
req = build_request(:create_quick_connect, params)
|
905
|
+
req.send_request(options)
|
906
|
+
end
|
907
|
+
|
434
908
|
# Creates a new routing profile.
|
435
909
|
#
|
436
910
|
# @option params [required, String] :instance_id
|
@@ -448,11 +922,11 @@ module Aws::Connect
|
|
448
922
|
#
|
449
923
|
# @option params [Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
450
924
|
# The inbound queues associated with the routing profile. If no queue is
|
451
|
-
# added, the agent can only
|
925
|
+
# added, the agent can make only outbound calls.
|
452
926
|
#
|
453
927
|
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
454
|
-
# The channels agents can handle in the Contact Control Panel (CCP)
|
455
|
-
# this routing profile.
|
928
|
+
# The channels that agents can handle in the Contact Control Panel (CCP)
|
929
|
+
# for this routing profile.
|
456
930
|
#
|
457
931
|
# @option params [Hash<String,String>] :tags
|
458
932
|
# One or more tags.
|
@@ -473,7 +947,7 @@ module Aws::Connect
|
|
473
947
|
# {
|
474
948
|
# queue_reference: { # required
|
475
949
|
# queue_id: "QueueId", # required
|
476
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
950
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
477
951
|
# },
|
478
952
|
# priority: 1, # required
|
479
953
|
# delay: 1, # required
|
@@ -481,7 +955,7 @@ module Aws::Connect
|
|
481
955
|
# ],
|
482
956
|
# media_concurrencies: [ # required
|
483
957
|
# {
|
484
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
958
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
485
959
|
# concurrency: 1, # required
|
486
960
|
# },
|
487
961
|
# ],
|
@@ -504,20 +978,63 @@ module Aws::Connect
|
|
504
978
|
req.send_request(options)
|
505
979
|
end
|
506
980
|
|
507
|
-
#
|
981
|
+
# This API is in preview release for Amazon Connect and is subject to
|
982
|
+
# change.
|
508
983
|
#
|
509
|
-
#
|
510
|
-
# Connect console, see [Add Users][1] in the *Amazon Connect
|
511
|
-
# Administrator Guide*.
|
984
|
+
# Creates a use case for an AppIntegration association.
|
512
985
|
#
|
986
|
+
# @option params [required, String] :instance_id
|
987
|
+
# The identifier of the Amazon Connect instance.
|
513
988
|
#
|
989
|
+
# @option params [required, String] :integration_association_id
|
990
|
+
# The identifier for the AppIntegration association.
|
514
991
|
#
|
515
|
-
# [
|
992
|
+
# @option params [required, String] :use_case_type
|
993
|
+
# The type of use case to associate to the AppIntegration association.
|
994
|
+
# Each AppIntegration association can have only one of each use case
|
995
|
+
# type.
|
516
996
|
#
|
517
|
-
# @
|
518
|
-
#
|
519
|
-
#
|
520
|
-
#
|
997
|
+
# @return [Types::CreateUseCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
998
|
+
#
|
999
|
+
# * {Types::CreateUseCaseResponse#use_case_id #use_case_id} => String
|
1000
|
+
# * {Types::CreateUseCaseResponse#use_case_arn #use_case_arn} => String
|
1001
|
+
#
|
1002
|
+
# @example Request syntax with placeholder values
|
1003
|
+
#
|
1004
|
+
# resp = client.create_use_case({
|
1005
|
+
# instance_id: "InstanceId", # required
|
1006
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1007
|
+
# use_case_type: "RULES_EVALUATION", # required, accepts RULES_EVALUATION
|
1008
|
+
# })
|
1009
|
+
#
|
1010
|
+
# @example Response structure
|
1011
|
+
#
|
1012
|
+
# resp.use_case_id #=> String
|
1013
|
+
# resp.use_case_arn #=> String
|
1014
|
+
#
|
1015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUseCase AWS API Documentation
|
1016
|
+
#
|
1017
|
+
# @overload create_use_case(params = {})
|
1018
|
+
# @param [Hash] params ({})
|
1019
|
+
def create_use_case(params = {}, options = {})
|
1020
|
+
req = build_request(:create_use_case, params)
|
1021
|
+
req.send_request(options)
|
1022
|
+
end
|
1023
|
+
|
1024
|
+
# Creates a user account for the specified Amazon Connect instance.
|
1025
|
+
#
|
1026
|
+
# For information about how to create user accounts using the Amazon
|
1027
|
+
# Connect console, see [Add Users][1] in the *Amazon Connect
|
1028
|
+
# Administrator Guide*.
|
1029
|
+
#
|
1030
|
+
#
|
1031
|
+
#
|
1032
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html
|
1033
|
+
#
|
1034
|
+
# @option params [required, String] :username
|
1035
|
+
# The user name for the account. For instances not using SAML for
|
1036
|
+
# identity management, the user name can include up to 20 characters. If
|
1037
|
+
# you are using SAML for identity management, the user name can include
|
521
1038
|
# up to 64 characters from \[a-zA-Z0-9\_-.\\@\]+.
|
522
1039
|
#
|
523
1040
|
# @option params [String] :password
|
@@ -604,6 +1121,163 @@ module Aws::Connect
|
|
604
1121
|
req.send_request(options)
|
605
1122
|
end
|
606
1123
|
|
1124
|
+
# Creates a new user hierarchy group.
|
1125
|
+
#
|
1126
|
+
# @option params [required, String] :name
|
1127
|
+
# The name of the user hierarchy group. Must not be more than 100
|
1128
|
+
# characters.
|
1129
|
+
#
|
1130
|
+
# @option params [String] :parent_group_id
|
1131
|
+
# The identifier for the parent hierarchy group. The user hierarchy is
|
1132
|
+
# created at level one if the parent group ID is null.
|
1133
|
+
#
|
1134
|
+
# @option params [required, String] :instance_id
|
1135
|
+
# The identifier of the Amazon Connect instance.
|
1136
|
+
#
|
1137
|
+
# @return [Types::CreateUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1138
|
+
#
|
1139
|
+
# * {Types::CreateUserHierarchyGroupResponse#hierarchy_group_id #hierarchy_group_id} => String
|
1140
|
+
# * {Types::CreateUserHierarchyGroupResponse#hierarchy_group_arn #hierarchy_group_arn} => String
|
1141
|
+
#
|
1142
|
+
# @example Request syntax with placeholder values
|
1143
|
+
#
|
1144
|
+
# resp = client.create_user_hierarchy_group({
|
1145
|
+
# name: "HierarchyGroupName", # required
|
1146
|
+
# parent_group_id: "HierarchyGroupId",
|
1147
|
+
# instance_id: "InstanceId", # required
|
1148
|
+
# })
|
1149
|
+
#
|
1150
|
+
# @example Response structure
|
1151
|
+
#
|
1152
|
+
# resp.hierarchy_group_id #=> String
|
1153
|
+
# resp.hierarchy_group_arn #=> String
|
1154
|
+
#
|
1155
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserHierarchyGroup AWS API Documentation
|
1156
|
+
#
|
1157
|
+
# @overload create_user_hierarchy_group(params = {})
|
1158
|
+
# @param [Hash] params ({})
|
1159
|
+
def create_user_hierarchy_group(params = {}, options = {})
|
1160
|
+
req = build_request(:create_user_hierarchy_group, params)
|
1161
|
+
req.send_request(options)
|
1162
|
+
end
|
1163
|
+
|
1164
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1165
|
+
# change.
|
1166
|
+
#
|
1167
|
+
# Deletes the Amazon Connect instance.
|
1168
|
+
#
|
1169
|
+
# @option params [required, String] :instance_id
|
1170
|
+
# The identifier of the Amazon Connect instance.
|
1171
|
+
#
|
1172
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1173
|
+
#
|
1174
|
+
# @example Request syntax with placeholder values
|
1175
|
+
#
|
1176
|
+
# resp = client.delete_instance({
|
1177
|
+
# instance_id: "InstanceId", # required
|
1178
|
+
# })
|
1179
|
+
#
|
1180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteInstance AWS API Documentation
|
1181
|
+
#
|
1182
|
+
# @overload delete_instance(params = {})
|
1183
|
+
# @param [Hash] params ({})
|
1184
|
+
def delete_instance(params = {}, options = {})
|
1185
|
+
req = build_request(:delete_instance, params)
|
1186
|
+
req.send_request(options)
|
1187
|
+
end
|
1188
|
+
|
1189
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1190
|
+
# change.
|
1191
|
+
#
|
1192
|
+
# Deletes an AppIntegration association from an Amazon Connect instance.
|
1193
|
+
# The association must not have any use cases associated with it.
|
1194
|
+
#
|
1195
|
+
# @option params [required, String] :instance_id
|
1196
|
+
# The identifier of the Amazon Connect instance.
|
1197
|
+
#
|
1198
|
+
# @option params [required, String] :integration_association_id
|
1199
|
+
# The identifier for the AppIntegration association.
|
1200
|
+
#
|
1201
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1202
|
+
#
|
1203
|
+
# @example Request syntax with placeholder values
|
1204
|
+
#
|
1205
|
+
# resp = client.delete_integration_association({
|
1206
|
+
# instance_id: "InstanceId", # required
|
1207
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1208
|
+
# })
|
1209
|
+
#
|
1210
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteIntegrationAssociation AWS API Documentation
|
1211
|
+
#
|
1212
|
+
# @overload delete_integration_association(params = {})
|
1213
|
+
# @param [Hash] params ({})
|
1214
|
+
def delete_integration_association(params = {}, options = {})
|
1215
|
+
req = build_request(:delete_integration_association, params)
|
1216
|
+
req.send_request(options)
|
1217
|
+
end
|
1218
|
+
|
1219
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1220
|
+
# change.
|
1221
|
+
#
|
1222
|
+
# Deletes a quick connect.
|
1223
|
+
#
|
1224
|
+
# @option params [required, String] :instance_id
|
1225
|
+
# The identifier of the Amazon Connect instance.
|
1226
|
+
#
|
1227
|
+
# @option params [required, String] :quick_connect_id
|
1228
|
+
# The identifier for the quick connect.
|
1229
|
+
#
|
1230
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1231
|
+
#
|
1232
|
+
# @example Request syntax with placeholder values
|
1233
|
+
#
|
1234
|
+
# resp = client.delete_quick_connect({
|
1235
|
+
# instance_id: "InstanceId", # required
|
1236
|
+
# quick_connect_id: "QuickConnectId", # required
|
1237
|
+
# })
|
1238
|
+
#
|
1239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteQuickConnect AWS API Documentation
|
1240
|
+
#
|
1241
|
+
# @overload delete_quick_connect(params = {})
|
1242
|
+
# @param [Hash] params ({})
|
1243
|
+
def delete_quick_connect(params = {}, options = {})
|
1244
|
+
req = build_request(:delete_quick_connect, params)
|
1245
|
+
req.send_request(options)
|
1246
|
+
end
|
1247
|
+
|
1248
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1249
|
+
# change.
|
1250
|
+
#
|
1251
|
+
# Deletes a use case from an AppIntegration association.
|
1252
|
+
#
|
1253
|
+
# @option params [required, String] :instance_id
|
1254
|
+
# The identifier of the Amazon Connect instance.
|
1255
|
+
#
|
1256
|
+
# @option params [required, String] :integration_association_id
|
1257
|
+
# The identifier for the AppIntegration association.
|
1258
|
+
#
|
1259
|
+
# @option params [required, String] :use_case_id
|
1260
|
+
# The identifier for the use case.
|
1261
|
+
#
|
1262
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1263
|
+
#
|
1264
|
+
# @example Request syntax with placeholder values
|
1265
|
+
#
|
1266
|
+
# resp = client.delete_use_case({
|
1267
|
+
# instance_id: "InstanceId", # required
|
1268
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1269
|
+
# use_case_id: "UseCaseId", # required
|
1270
|
+
# })
|
1271
|
+
#
|
1272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUseCase AWS API Documentation
|
1273
|
+
#
|
1274
|
+
# @overload delete_use_case(params = {})
|
1275
|
+
# @param [Hash] params ({})
|
1276
|
+
def delete_use_case(params = {}, options = {})
|
1277
|
+
req = build_request(:delete_use_case, params)
|
1278
|
+
req.send_request(options)
|
1279
|
+
end
|
1280
|
+
|
607
1281
|
# Deletes a user account from the specified Amazon Connect instance.
|
608
1282
|
#
|
609
1283
|
# For information about what happens to a user's data when their
|
@@ -638,6 +1312,33 @@ module Aws::Connect
|
|
638
1312
|
req.send_request(options)
|
639
1313
|
end
|
640
1314
|
|
1315
|
+
# Deletes an existing user hierarchy group. It must not be associated
|
1316
|
+
# with any agents or have any active child groups.
|
1317
|
+
#
|
1318
|
+
# @option params [required, String] :hierarchy_group_id
|
1319
|
+
# The identifier of the hierarchy group.
|
1320
|
+
#
|
1321
|
+
# @option params [required, String] :instance_id
|
1322
|
+
# The identifier of the Amazon Connect instance.
|
1323
|
+
#
|
1324
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1325
|
+
#
|
1326
|
+
# @example Request syntax with placeholder values
|
1327
|
+
#
|
1328
|
+
# resp = client.delete_user_hierarchy_group({
|
1329
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
1330
|
+
# instance_id: "InstanceId", # required
|
1331
|
+
# })
|
1332
|
+
#
|
1333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUserHierarchyGroup AWS API Documentation
|
1334
|
+
#
|
1335
|
+
# @overload delete_user_hierarchy_group(params = {})
|
1336
|
+
# @param [Hash] params ({})
|
1337
|
+
def delete_user_hierarchy_group(params = {}, options = {})
|
1338
|
+
req = build_request(:delete_user_hierarchy_group, params)
|
1339
|
+
req.send_request(options)
|
1340
|
+
end
|
1341
|
+
|
641
1342
|
# Describes the specified contact flow.
|
642
1343
|
#
|
643
1344
|
# You can also create and update contact flows using the [Amazon Connect
|
@@ -684,189 +1385,625 @@ module Aws::Connect
|
|
684
1385
|
req.send_request(options)
|
685
1386
|
end
|
686
1387
|
|
687
|
-
#
|
1388
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1389
|
+
# change.
|
1390
|
+
#
|
1391
|
+
# Describes the hours of operation.
|
688
1392
|
#
|
689
1393
|
# @option params [required, String] :instance_id
|
690
1394
|
# The identifier of the Amazon Connect instance.
|
691
1395
|
#
|
692
|
-
# @option params [required, String] :
|
693
|
-
# The identifier
|
1396
|
+
# @option params [required, String] :hours_of_operation_id
|
1397
|
+
# The identifier for the hours of operation.
|
694
1398
|
#
|
695
|
-
# @return [Types::
|
1399
|
+
# @return [Types::DescribeHoursOfOperationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
696
1400
|
#
|
697
|
-
# * {Types::
|
1401
|
+
# * {Types::DescribeHoursOfOperationResponse#hours_of_operation #hours_of_operation} => Types::HoursOfOperation
|
698
1402
|
#
|
699
1403
|
# @example Request syntax with placeholder values
|
700
1404
|
#
|
701
|
-
# resp = client.
|
1405
|
+
# resp = client.describe_hours_of_operation({
|
702
1406
|
# instance_id: "InstanceId", # required
|
703
|
-
#
|
1407
|
+
# hours_of_operation_id: "HoursOfOperationId", # required
|
704
1408
|
# })
|
705
1409
|
#
|
706
1410
|
# @example Response structure
|
707
1411
|
#
|
708
|
-
# resp.
|
709
|
-
# resp.
|
710
|
-
# resp.
|
711
|
-
# resp.
|
712
|
-
# resp.
|
713
|
-
# resp.
|
714
|
-
# resp.
|
715
|
-
# resp.
|
716
|
-
# resp.
|
717
|
-
# resp.
|
718
|
-
# resp.
|
719
|
-
#
|
720
|
-
#
|
721
|
-
#
|
722
|
-
# @
|
1412
|
+
# resp.hours_of_operation.hours_of_operation_id #=> String
|
1413
|
+
# resp.hours_of_operation.hours_of_operation_arn #=> String
|
1414
|
+
# resp.hours_of_operation.name #=> String
|
1415
|
+
# resp.hours_of_operation.description #=> String
|
1416
|
+
# resp.hours_of_operation.time_zone #=> String
|
1417
|
+
# resp.hours_of_operation.config #=> Array
|
1418
|
+
# resp.hours_of_operation.config[0].day #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
|
1419
|
+
# resp.hours_of_operation.config[0].start_time.hours #=> Integer
|
1420
|
+
# resp.hours_of_operation.config[0].start_time.minutes #=> Integer
|
1421
|
+
# resp.hours_of_operation.config[0].end_time.hours #=> Integer
|
1422
|
+
# resp.hours_of_operation.config[0].end_time.minutes #=> Integer
|
1423
|
+
# resp.hours_of_operation.tags #=> Hash
|
1424
|
+
# resp.hours_of_operation.tags["TagKey"] #=> String
|
1425
|
+
#
|
1426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeHoursOfOperation AWS API Documentation
|
1427
|
+
#
|
1428
|
+
# @overload describe_hours_of_operation(params = {})
|
723
1429
|
# @param [Hash] params ({})
|
724
|
-
def
|
725
|
-
req = build_request(:
|
1430
|
+
def describe_hours_of_operation(params = {}, options = {})
|
1431
|
+
req = build_request(:describe_hours_of_operation, params)
|
726
1432
|
req.send_request(options)
|
727
1433
|
end
|
728
1434
|
|
729
|
-
#
|
730
|
-
#
|
731
|
-
# display the user IDs. Instead, list the users and note the IDs
|
732
|
-
# provided in the output.
|
1435
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1436
|
+
# change.
|
733
1437
|
#
|
734
|
-
#
|
735
|
-
#
|
1438
|
+
# Returns the current state of the specified instance identifier. It
|
1439
|
+
# tracks the instance while it is being created and returns an error
|
1440
|
+
# status, if applicable.
|
1441
|
+
#
|
1442
|
+
# If an instance is not created successfully, the instance status reason
|
1443
|
+
# field returns details relevant to the reason. The instance in a failed
|
1444
|
+
# state is returned only for 24 hours after the CreateInstance API was
|
1445
|
+
# invoked.
|
736
1446
|
#
|
737
1447
|
# @option params [required, String] :instance_id
|
738
1448
|
# The identifier of the Amazon Connect instance.
|
739
1449
|
#
|
740
|
-
# @return [Types::
|
1450
|
+
# @return [Types::DescribeInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
741
1451
|
#
|
742
|
-
# * {Types::
|
1452
|
+
# * {Types::DescribeInstanceResponse#instance #instance} => Types::Instance
|
743
1453
|
#
|
744
1454
|
# @example Request syntax with placeholder values
|
745
1455
|
#
|
746
|
-
# resp = client.
|
747
|
-
# user_id: "UserId", # required
|
1456
|
+
# resp = client.describe_instance({
|
748
1457
|
# instance_id: "InstanceId", # required
|
749
1458
|
# })
|
750
1459
|
#
|
751
1460
|
# @example Response structure
|
752
1461
|
#
|
753
|
-
# resp.
|
754
|
-
# resp.
|
755
|
-
# resp.
|
756
|
-
# resp.
|
757
|
-
# resp.
|
758
|
-
# resp.
|
759
|
-
# resp.
|
760
|
-
# resp.
|
761
|
-
# resp.
|
762
|
-
# resp.
|
763
|
-
# resp.user.directory_user_id #=> String
|
764
|
-
# resp.user.security_profile_ids #=> Array
|
765
|
-
# resp.user.security_profile_ids[0] #=> String
|
766
|
-
# resp.user.routing_profile_id #=> String
|
767
|
-
# resp.user.hierarchy_group_id #=> String
|
768
|
-
# resp.user.tags #=> Hash
|
769
|
-
# resp.user.tags["TagKey"] #=> String
|
1462
|
+
# resp.instance.id #=> String
|
1463
|
+
# resp.instance.arn #=> String
|
1464
|
+
# resp.instance.identity_management_type #=> String, one of "SAML", "CONNECT_MANAGED", "EXISTING_DIRECTORY"
|
1465
|
+
# resp.instance.instance_alias #=> String
|
1466
|
+
# resp.instance.created_time #=> Time
|
1467
|
+
# resp.instance.service_role #=> String
|
1468
|
+
# resp.instance.instance_status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED"
|
1469
|
+
# resp.instance.status_reason.message #=> String
|
1470
|
+
# resp.instance.inbound_calls_enabled #=> Boolean
|
1471
|
+
# resp.instance.outbound_calls_enabled #=> Boolean
|
770
1472
|
#
|
771
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
1473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstance AWS API Documentation
|
772
1474
|
#
|
773
|
-
# @overload
|
1475
|
+
# @overload describe_instance(params = {})
|
774
1476
|
# @param [Hash] params ({})
|
775
|
-
def
|
776
|
-
req = build_request(:
|
1477
|
+
def describe_instance(params = {}, options = {})
|
1478
|
+
req = build_request(:describe_instance, params)
|
777
1479
|
req.send_request(options)
|
778
1480
|
end
|
779
1481
|
|
780
|
-
#
|
1482
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1483
|
+
# change.
|
781
1484
|
#
|
782
|
-
#
|
783
|
-
# The identifier of the hierarchy group.
|
1485
|
+
# Describes the specified instance attribute.
|
784
1486
|
#
|
785
1487
|
# @option params [required, String] :instance_id
|
786
1488
|
# The identifier of the Amazon Connect instance.
|
787
1489
|
#
|
788
|
-
# @
|
1490
|
+
# @option params [required, String] :attribute_type
|
1491
|
+
# The type of attribute.
|
789
1492
|
#
|
790
|
-
#
|
1493
|
+
# @return [Types::DescribeInstanceAttributeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1494
|
+
#
|
1495
|
+
# * {Types::DescribeInstanceAttributeResponse#attribute #attribute} => Types::Attribute
|
791
1496
|
#
|
792
1497
|
# @example Request syntax with placeholder values
|
793
1498
|
#
|
794
|
-
# resp = client.
|
795
|
-
# hierarchy_group_id: "HierarchyGroupId", # required
|
1499
|
+
# resp = client.describe_instance_attribute({
|
796
1500
|
# instance_id: "InstanceId", # required
|
1501
|
+
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA
|
797
1502
|
# })
|
798
1503
|
#
|
799
1504
|
# @example Response structure
|
800
1505
|
#
|
801
|
-
# resp.
|
802
|
-
# resp.
|
803
|
-
# resp.hierarchy_group.name #=> String
|
804
|
-
# resp.hierarchy_group.level_id #=> String
|
805
|
-
# resp.hierarchy_group.hierarchy_path.level_one.id #=> String
|
806
|
-
# resp.hierarchy_group.hierarchy_path.level_one.arn #=> String
|
807
|
-
# resp.hierarchy_group.hierarchy_path.level_one.name #=> String
|
808
|
-
# resp.hierarchy_group.hierarchy_path.level_two.id #=> String
|
809
|
-
# resp.hierarchy_group.hierarchy_path.level_two.arn #=> String
|
810
|
-
# resp.hierarchy_group.hierarchy_path.level_two.name #=> String
|
811
|
-
# resp.hierarchy_group.hierarchy_path.level_three.id #=> String
|
812
|
-
# resp.hierarchy_group.hierarchy_path.level_three.arn #=> String
|
813
|
-
# resp.hierarchy_group.hierarchy_path.level_three.name #=> String
|
814
|
-
# resp.hierarchy_group.hierarchy_path.level_four.id #=> String
|
815
|
-
# resp.hierarchy_group.hierarchy_path.level_four.arn #=> String
|
816
|
-
# resp.hierarchy_group.hierarchy_path.level_four.name #=> String
|
817
|
-
# resp.hierarchy_group.hierarchy_path.level_five.id #=> String
|
818
|
-
# resp.hierarchy_group.hierarchy_path.level_five.arn #=> String
|
819
|
-
# resp.hierarchy_group.hierarchy_path.level_five.name #=> String
|
1506
|
+
# 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"
|
1507
|
+
# resp.attribute.value #=> String
|
820
1508
|
#
|
821
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
1509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceAttribute AWS API Documentation
|
822
1510
|
#
|
823
|
-
# @overload
|
1511
|
+
# @overload describe_instance_attribute(params = {})
|
824
1512
|
# @param [Hash] params ({})
|
825
|
-
def
|
826
|
-
req = build_request(:
|
1513
|
+
def describe_instance_attribute(params = {}, options = {})
|
1514
|
+
req = build_request(:describe_instance_attribute, params)
|
827
1515
|
req.send_request(options)
|
828
1516
|
end
|
829
1517
|
|
830
|
-
#
|
831
|
-
#
|
1518
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1519
|
+
# change.
|
1520
|
+
#
|
1521
|
+
# Retrieves the current storage configurations for the specified
|
1522
|
+
# resource type, association ID, and instance ID.
|
832
1523
|
#
|
833
1524
|
# @option params [required, String] :instance_id
|
834
1525
|
# The identifier of the Amazon Connect instance.
|
835
1526
|
#
|
836
|
-
# @
|
1527
|
+
# @option params [required, String] :association_id
|
1528
|
+
# The existing association identifier that uniquely identifies the
|
1529
|
+
# resource type and storage config for the given instance ID.
|
837
1530
|
#
|
838
|
-
#
|
1531
|
+
# @option params [required, String] :resource_type
|
1532
|
+
# A valid resource type.
|
1533
|
+
#
|
1534
|
+
# @return [Types::DescribeInstanceStorageConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1535
|
+
#
|
1536
|
+
# * {Types::DescribeInstanceStorageConfigResponse#storage_config #storage_config} => Types::InstanceStorageConfig
|
839
1537
|
#
|
840
1538
|
# @example Request syntax with placeholder values
|
841
1539
|
#
|
842
|
-
# resp = client.
|
1540
|
+
# resp = client.describe_instance_storage_config({
|
843
1541
|
# instance_id: "InstanceId", # required
|
1542
|
+
# association_id: "AssociationId", # required
|
1543
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
844
1544
|
# })
|
845
1545
|
#
|
846
1546
|
# @example Response structure
|
847
1547
|
#
|
848
|
-
# resp.
|
849
|
-
# resp.
|
850
|
-
# resp.
|
851
|
-
# resp.
|
852
|
-
# resp.
|
853
|
-
# resp.
|
854
|
-
# resp.
|
855
|
-
# resp.
|
856
|
-
# resp.
|
857
|
-
# resp.
|
858
|
-
# resp.
|
859
|
-
# resp.
|
860
|
-
#
|
861
|
-
#
|
862
|
-
#
|
863
|
-
#
|
864
|
-
# @
|
1548
|
+
# resp.storage_config.association_id #=> String
|
1549
|
+
# resp.storage_config.storage_type #=> String, one of "S3", "KINESIS_VIDEO_STREAM", "KINESIS_STREAM", "KINESIS_FIREHOSE"
|
1550
|
+
# resp.storage_config.s3_config.bucket_name #=> String
|
1551
|
+
# resp.storage_config.s3_config.bucket_prefix #=> String
|
1552
|
+
# resp.storage_config.s3_config.encryption_config.encryption_type #=> String, one of "KMS"
|
1553
|
+
# resp.storage_config.s3_config.encryption_config.key_id #=> String
|
1554
|
+
# resp.storage_config.kinesis_video_stream_config.prefix #=> String
|
1555
|
+
# resp.storage_config.kinesis_video_stream_config.retention_period_hours #=> Integer
|
1556
|
+
# resp.storage_config.kinesis_video_stream_config.encryption_config.encryption_type #=> String, one of "KMS"
|
1557
|
+
# resp.storage_config.kinesis_video_stream_config.encryption_config.key_id #=> String
|
1558
|
+
# resp.storage_config.kinesis_stream_config.stream_arn #=> String
|
1559
|
+
# resp.storage_config.kinesis_firehose_config.firehose_arn #=> String
|
1560
|
+
#
|
1561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceStorageConfig AWS API Documentation
|
1562
|
+
#
|
1563
|
+
# @overload describe_instance_storage_config(params = {})
|
1564
|
+
# @param [Hash] params ({})
|
1565
|
+
def describe_instance_storage_config(params = {}, options = {})
|
1566
|
+
req = build_request(:describe_instance_storage_config, params)
|
1567
|
+
req.send_request(options)
|
1568
|
+
end
|
1569
|
+
|
1570
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1571
|
+
# change.
|
1572
|
+
#
|
1573
|
+
# Describes the specified queue.
|
1574
|
+
#
|
1575
|
+
# @option params [required, String] :instance_id
|
1576
|
+
# The identifier of the Amazon Connect instance.
|
1577
|
+
#
|
1578
|
+
# @option params [required, String] :queue_id
|
1579
|
+
# The identifier for the queue.
|
1580
|
+
#
|
1581
|
+
# @return [Types::DescribeQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1582
|
+
#
|
1583
|
+
# * {Types::DescribeQueueResponse#queue #queue} => Types::Queue
|
1584
|
+
#
|
1585
|
+
# @example Request syntax with placeholder values
|
1586
|
+
#
|
1587
|
+
# resp = client.describe_queue({
|
1588
|
+
# instance_id: "InstanceId", # required
|
1589
|
+
# queue_id: "QueueId", # required
|
1590
|
+
# })
|
1591
|
+
#
|
1592
|
+
# @example Response structure
|
1593
|
+
#
|
1594
|
+
# resp.queue.name #=> String
|
1595
|
+
# resp.queue.queue_arn #=> String
|
1596
|
+
# resp.queue.queue_id #=> String
|
1597
|
+
# resp.queue.description #=> String
|
1598
|
+
# resp.queue.outbound_caller_config.outbound_caller_id_name #=> String
|
1599
|
+
# resp.queue.outbound_caller_config.outbound_caller_id_number_id #=> String
|
1600
|
+
# resp.queue.outbound_caller_config.outbound_flow_id #=> String
|
1601
|
+
# resp.queue.hours_of_operation_id #=> String
|
1602
|
+
# resp.queue.max_contacts #=> Integer
|
1603
|
+
# resp.queue.status #=> String, one of "ENABLED", "DISABLED"
|
1604
|
+
# resp.queue.tags #=> Hash
|
1605
|
+
# resp.queue.tags["TagKey"] #=> String
|
1606
|
+
#
|
1607
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeQueue AWS API Documentation
|
1608
|
+
#
|
1609
|
+
# @overload describe_queue(params = {})
|
1610
|
+
# @param [Hash] params ({})
|
1611
|
+
def describe_queue(params = {}, options = {})
|
1612
|
+
req = build_request(:describe_queue, params)
|
1613
|
+
req.send_request(options)
|
1614
|
+
end
|
1615
|
+
|
1616
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1617
|
+
# change.
|
1618
|
+
#
|
1619
|
+
# Describes the quick connect.
|
1620
|
+
#
|
1621
|
+
# @option params [required, String] :instance_id
|
1622
|
+
# The identifier of the Amazon Connect instance.
|
1623
|
+
#
|
1624
|
+
# @option params [required, String] :quick_connect_id
|
1625
|
+
# The identifier for the quick connect.
|
1626
|
+
#
|
1627
|
+
# @return [Types::DescribeQuickConnectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1628
|
+
#
|
1629
|
+
# * {Types::DescribeQuickConnectResponse#quick_connect #quick_connect} => Types::QuickConnect
|
1630
|
+
#
|
1631
|
+
# @example Request syntax with placeholder values
|
1632
|
+
#
|
1633
|
+
# resp = client.describe_quick_connect({
|
1634
|
+
# instance_id: "InstanceId", # required
|
1635
|
+
# quick_connect_id: "QuickConnectId", # required
|
1636
|
+
# })
|
1637
|
+
#
|
1638
|
+
# @example Response structure
|
1639
|
+
#
|
1640
|
+
# resp.quick_connect.quick_connect_arn #=> String
|
1641
|
+
# resp.quick_connect.quick_connect_id #=> String
|
1642
|
+
# resp.quick_connect.name #=> String
|
1643
|
+
# resp.quick_connect.description #=> String
|
1644
|
+
# resp.quick_connect.quick_connect_config.quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
|
1645
|
+
# resp.quick_connect.quick_connect_config.user_config.user_id #=> String
|
1646
|
+
# resp.quick_connect.quick_connect_config.user_config.contact_flow_id #=> String
|
1647
|
+
# resp.quick_connect.quick_connect_config.queue_config.queue_id #=> String
|
1648
|
+
# resp.quick_connect.quick_connect_config.queue_config.contact_flow_id #=> String
|
1649
|
+
# resp.quick_connect.quick_connect_config.phone_config.phone_number #=> String
|
1650
|
+
# resp.quick_connect.tags #=> Hash
|
1651
|
+
# resp.quick_connect.tags["TagKey"] #=> String
|
1652
|
+
#
|
1653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeQuickConnect AWS API Documentation
|
1654
|
+
#
|
1655
|
+
# @overload describe_quick_connect(params = {})
|
1656
|
+
# @param [Hash] params ({})
|
1657
|
+
def describe_quick_connect(params = {}, options = {})
|
1658
|
+
req = build_request(:describe_quick_connect, params)
|
1659
|
+
req.send_request(options)
|
1660
|
+
end
|
1661
|
+
|
1662
|
+
# Describes the specified routing profile.
|
1663
|
+
#
|
1664
|
+
# @option params [required, String] :instance_id
|
1665
|
+
# The identifier of the Amazon Connect instance.
|
1666
|
+
#
|
1667
|
+
# @option params [required, String] :routing_profile_id
|
1668
|
+
# The identifier of the routing profile.
|
1669
|
+
#
|
1670
|
+
# @return [Types::DescribeRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1671
|
+
#
|
1672
|
+
# * {Types::DescribeRoutingProfileResponse#routing_profile #routing_profile} => Types::RoutingProfile
|
1673
|
+
#
|
1674
|
+
# @example Request syntax with placeholder values
|
1675
|
+
#
|
1676
|
+
# resp = client.describe_routing_profile({
|
1677
|
+
# instance_id: "InstanceId", # required
|
1678
|
+
# routing_profile_id: "RoutingProfileId", # required
|
1679
|
+
# })
|
1680
|
+
#
|
1681
|
+
# @example Response structure
|
1682
|
+
#
|
1683
|
+
# resp.routing_profile.instance_id #=> String
|
1684
|
+
# resp.routing_profile.name #=> String
|
1685
|
+
# resp.routing_profile.routing_profile_arn #=> String
|
1686
|
+
# resp.routing_profile.routing_profile_id #=> String
|
1687
|
+
# resp.routing_profile.description #=> String
|
1688
|
+
# resp.routing_profile.media_concurrencies #=> Array
|
1689
|
+
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
1690
|
+
# resp.routing_profile.media_concurrencies[0].concurrency #=> Integer
|
1691
|
+
# resp.routing_profile.default_outbound_queue_id #=> String
|
1692
|
+
# resp.routing_profile.tags #=> Hash
|
1693
|
+
# resp.routing_profile.tags["TagKey"] #=> String
|
1694
|
+
#
|
1695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfile AWS API Documentation
|
1696
|
+
#
|
1697
|
+
# @overload describe_routing_profile(params = {})
|
1698
|
+
# @param [Hash] params ({})
|
1699
|
+
def describe_routing_profile(params = {}, options = {})
|
1700
|
+
req = build_request(:describe_routing_profile, params)
|
1701
|
+
req.send_request(options)
|
1702
|
+
end
|
1703
|
+
|
1704
|
+
# Describes the specified user account. You can find the instance ID in
|
1705
|
+
# the console (it’s the final part of the ARN). The console does not
|
1706
|
+
# display the user IDs. Instead, list the users and note the IDs
|
1707
|
+
# provided in the output.
|
1708
|
+
#
|
1709
|
+
# @option params [required, String] :user_id
|
1710
|
+
# The identifier of the user account.
|
1711
|
+
#
|
1712
|
+
# @option params [required, String] :instance_id
|
1713
|
+
# The identifier of the Amazon Connect instance.
|
1714
|
+
#
|
1715
|
+
# @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1716
|
+
#
|
1717
|
+
# * {Types::DescribeUserResponse#user #user} => Types::User
|
1718
|
+
#
|
1719
|
+
# @example Request syntax with placeholder values
|
1720
|
+
#
|
1721
|
+
# resp = client.describe_user({
|
1722
|
+
# user_id: "UserId", # required
|
1723
|
+
# instance_id: "InstanceId", # required
|
1724
|
+
# })
|
1725
|
+
#
|
1726
|
+
# @example Response structure
|
1727
|
+
#
|
1728
|
+
# resp.user.id #=> String
|
1729
|
+
# resp.user.arn #=> String
|
1730
|
+
# resp.user.username #=> String
|
1731
|
+
# resp.user.identity_info.first_name #=> String
|
1732
|
+
# resp.user.identity_info.last_name #=> String
|
1733
|
+
# resp.user.identity_info.email #=> String
|
1734
|
+
# resp.user.phone_config.phone_type #=> String, one of "SOFT_PHONE", "DESK_PHONE"
|
1735
|
+
# resp.user.phone_config.auto_accept #=> Boolean
|
1736
|
+
# resp.user.phone_config.after_contact_work_time_limit #=> Integer
|
1737
|
+
# resp.user.phone_config.desk_phone_number #=> String
|
1738
|
+
# resp.user.directory_user_id #=> String
|
1739
|
+
# resp.user.security_profile_ids #=> Array
|
1740
|
+
# resp.user.security_profile_ids[0] #=> String
|
1741
|
+
# resp.user.routing_profile_id #=> String
|
1742
|
+
# resp.user.hierarchy_group_id #=> String
|
1743
|
+
# resp.user.tags #=> Hash
|
1744
|
+
# resp.user.tags["TagKey"] #=> String
|
1745
|
+
#
|
1746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUser AWS API Documentation
|
1747
|
+
#
|
1748
|
+
# @overload describe_user(params = {})
|
1749
|
+
# @param [Hash] params ({})
|
1750
|
+
def describe_user(params = {}, options = {})
|
1751
|
+
req = build_request(:describe_user, params)
|
1752
|
+
req.send_request(options)
|
1753
|
+
end
|
1754
|
+
|
1755
|
+
# Describes the specified hierarchy group.
|
1756
|
+
#
|
1757
|
+
# @option params [required, String] :hierarchy_group_id
|
1758
|
+
# The identifier of the hierarchy group.
|
1759
|
+
#
|
1760
|
+
# @option params [required, String] :instance_id
|
1761
|
+
# The identifier of the Amazon Connect instance.
|
1762
|
+
#
|
1763
|
+
# @return [Types::DescribeUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1764
|
+
#
|
1765
|
+
# * {Types::DescribeUserHierarchyGroupResponse#hierarchy_group #hierarchy_group} => Types::HierarchyGroup
|
1766
|
+
#
|
1767
|
+
# @example Request syntax with placeholder values
|
1768
|
+
#
|
1769
|
+
# resp = client.describe_user_hierarchy_group({
|
1770
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
1771
|
+
# instance_id: "InstanceId", # required
|
1772
|
+
# })
|
1773
|
+
#
|
1774
|
+
# @example Response structure
|
1775
|
+
#
|
1776
|
+
# resp.hierarchy_group.id #=> String
|
1777
|
+
# resp.hierarchy_group.arn #=> String
|
1778
|
+
# resp.hierarchy_group.name #=> String
|
1779
|
+
# resp.hierarchy_group.level_id #=> String
|
1780
|
+
# resp.hierarchy_group.hierarchy_path.level_one.id #=> String
|
1781
|
+
# resp.hierarchy_group.hierarchy_path.level_one.arn #=> String
|
1782
|
+
# resp.hierarchy_group.hierarchy_path.level_one.name #=> String
|
1783
|
+
# resp.hierarchy_group.hierarchy_path.level_two.id #=> String
|
1784
|
+
# resp.hierarchy_group.hierarchy_path.level_two.arn #=> String
|
1785
|
+
# resp.hierarchy_group.hierarchy_path.level_two.name #=> String
|
1786
|
+
# resp.hierarchy_group.hierarchy_path.level_three.id #=> String
|
1787
|
+
# resp.hierarchy_group.hierarchy_path.level_three.arn #=> String
|
1788
|
+
# resp.hierarchy_group.hierarchy_path.level_three.name #=> String
|
1789
|
+
# resp.hierarchy_group.hierarchy_path.level_four.id #=> String
|
1790
|
+
# resp.hierarchy_group.hierarchy_path.level_four.arn #=> String
|
1791
|
+
# resp.hierarchy_group.hierarchy_path.level_four.name #=> String
|
1792
|
+
# resp.hierarchy_group.hierarchy_path.level_five.id #=> String
|
1793
|
+
# resp.hierarchy_group.hierarchy_path.level_five.arn #=> String
|
1794
|
+
# resp.hierarchy_group.hierarchy_path.level_five.name #=> String
|
1795
|
+
#
|
1796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroup AWS API Documentation
|
1797
|
+
#
|
1798
|
+
# @overload describe_user_hierarchy_group(params = {})
|
1799
|
+
# @param [Hash] params ({})
|
1800
|
+
def describe_user_hierarchy_group(params = {}, options = {})
|
1801
|
+
req = build_request(:describe_user_hierarchy_group, params)
|
1802
|
+
req.send_request(options)
|
1803
|
+
end
|
1804
|
+
|
1805
|
+
# Describes the hierarchy structure of the specified Amazon Connect
|
1806
|
+
# instance.
|
1807
|
+
#
|
1808
|
+
# @option params [required, String] :instance_id
|
1809
|
+
# The identifier of the Amazon Connect instance.
|
1810
|
+
#
|
1811
|
+
# @return [Types::DescribeUserHierarchyStructureResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1812
|
+
#
|
1813
|
+
# * {Types::DescribeUserHierarchyStructureResponse#hierarchy_structure #hierarchy_structure} => Types::HierarchyStructure
|
1814
|
+
#
|
1815
|
+
# @example Request syntax with placeholder values
|
1816
|
+
#
|
1817
|
+
# resp = client.describe_user_hierarchy_structure({
|
1818
|
+
# instance_id: "InstanceId", # required
|
1819
|
+
# })
|
1820
|
+
#
|
1821
|
+
# @example Response structure
|
1822
|
+
#
|
1823
|
+
# resp.hierarchy_structure.level_one.id #=> String
|
1824
|
+
# resp.hierarchy_structure.level_one.arn #=> String
|
1825
|
+
# resp.hierarchy_structure.level_one.name #=> String
|
1826
|
+
# resp.hierarchy_structure.level_two.id #=> String
|
1827
|
+
# resp.hierarchy_structure.level_two.arn #=> String
|
1828
|
+
# resp.hierarchy_structure.level_two.name #=> String
|
1829
|
+
# resp.hierarchy_structure.level_three.id #=> String
|
1830
|
+
# resp.hierarchy_structure.level_three.arn #=> String
|
1831
|
+
# resp.hierarchy_structure.level_three.name #=> String
|
1832
|
+
# resp.hierarchy_structure.level_four.id #=> String
|
1833
|
+
# resp.hierarchy_structure.level_four.arn #=> String
|
1834
|
+
# resp.hierarchy_structure.level_four.name #=> String
|
1835
|
+
# resp.hierarchy_structure.level_five.id #=> String
|
1836
|
+
# resp.hierarchy_structure.level_five.arn #=> String
|
1837
|
+
# resp.hierarchy_structure.level_five.name #=> String
|
1838
|
+
#
|
1839
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructure AWS API Documentation
|
1840
|
+
#
|
1841
|
+
# @overload describe_user_hierarchy_structure(params = {})
|
1842
|
+
# @param [Hash] params ({})
|
1843
|
+
def describe_user_hierarchy_structure(params = {}, options = {})
|
1844
|
+
req = build_request(:describe_user_hierarchy_structure, params)
|
1845
|
+
req.send_request(options)
|
1846
|
+
end
|
1847
|
+
|
1848
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1849
|
+
# change.
|
1850
|
+
#
|
1851
|
+
# Revokes access to integrated applications from Amazon Connect.
|
1852
|
+
#
|
1853
|
+
# @option params [required, String] :instance_id
|
1854
|
+
# The identifier of the Amazon Connect instance.
|
1855
|
+
#
|
1856
|
+
# @option params [required, String] :origin
|
1857
|
+
# The domain URL of the integrated application.
|
1858
|
+
#
|
1859
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1860
|
+
#
|
1861
|
+
# @example Request syntax with placeholder values
|
1862
|
+
#
|
1863
|
+
# resp = client.disassociate_approved_origin({
|
1864
|
+
# instance_id: "InstanceId", # required
|
1865
|
+
# origin: "Origin", # required
|
1866
|
+
# })
|
1867
|
+
#
|
1868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateApprovedOrigin AWS API Documentation
|
1869
|
+
#
|
1870
|
+
# @overload disassociate_approved_origin(params = {})
|
1871
|
+
# @param [Hash] params ({})
|
1872
|
+
def disassociate_approved_origin(params = {}, options = {})
|
1873
|
+
req = build_request(:disassociate_approved_origin, params)
|
1874
|
+
req.send_request(options)
|
1875
|
+
end
|
1876
|
+
|
1877
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1878
|
+
# change.
|
1879
|
+
#
|
1880
|
+
# Removes the storage type configurations for the specified resource
|
1881
|
+
# type and association ID.
|
1882
|
+
#
|
1883
|
+
# @option params [required, String] :instance_id
|
1884
|
+
# The identifier of the Amazon Connect instance.
|
1885
|
+
#
|
1886
|
+
# @option params [required, String] :association_id
|
1887
|
+
# The existing association identifier that uniquely identifies the
|
1888
|
+
# resource type and storage config for the given instance ID.
|
1889
|
+
#
|
1890
|
+
# @option params [required, String] :resource_type
|
1891
|
+
# A valid resource type.
|
1892
|
+
#
|
1893
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1894
|
+
#
|
1895
|
+
# @example Request syntax with placeholder values
|
1896
|
+
#
|
1897
|
+
# resp = client.disassociate_instance_storage_config({
|
1898
|
+
# instance_id: "InstanceId", # required
|
1899
|
+
# association_id: "AssociationId", # required
|
1900
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
1901
|
+
# })
|
1902
|
+
#
|
1903
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateInstanceStorageConfig AWS API Documentation
|
1904
|
+
#
|
1905
|
+
# @overload disassociate_instance_storage_config(params = {})
|
1906
|
+
# @param [Hash] params ({})
|
1907
|
+
def disassociate_instance_storage_config(params = {}, options = {})
|
1908
|
+
req = build_request(:disassociate_instance_storage_config, params)
|
1909
|
+
req.send_request(options)
|
1910
|
+
end
|
1911
|
+
|
1912
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1913
|
+
# change.
|
1914
|
+
#
|
1915
|
+
# Remove the Lambda function from the dropdown options available in the
|
1916
|
+
# relevant contact flow blocks.
|
1917
|
+
#
|
1918
|
+
# @option params [required, String] :instance_id
|
1919
|
+
# The identifier of the Amazon Connect instance..
|
1920
|
+
#
|
1921
|
+
# @option params [required, String] :function_arn
|
1922
|
+
# The Amazon Resource Name (ARN) of the Lambda function being
|
1923
|
+
# disassociated.
|
1924
|
+
#
|
1925
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1926
|
+
#
|
1927
|
+
# @example Request syntax with placeholder values
|
1928
|
+
#
|
1929
|
+
# resp = client.disassociate_lambda_function({
|
1930
|
+
# instance_id: "InstanceId", # required
|
1931
|
+
# function_arn: "FunctionArn", # required
|
1932
|
+
# })
|
1933
|
+
#
|
1934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateLambdaFunction AWS API Documentation
|
1935
|
+
#
|
1936
|
+
# @overload disassociate_lambda_function(params = {})
|
1937
|
+
# @param [Hash] params ({})
|
1938
|
+
def disassociate_lambda_function(params = {}, options = {})
|
1939
|
+
req = build_request(:disassociate_lambda_function, params)
|
1940
|
+
req.send_request(options)
|
1941
|
+
end
|
1942
|
+
|
1943
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1944
|
+
# change.
|
1945
|
+
#
|
1946
|
+
# Revokes authorization from the specified instance to access the
|
1947
|
+
# specified Amazon Lex bot.
|
1948
|
+
#
|
1949
|
+
# @option params [required, String] :instance_id
|
1950
|
+
# The identifier of the Amazon Connect instance.
|
1951
|
+
#
|
1952
|
+
# @option params [required, String] :bot_name
|
1953
|
+
# The name of the Amazon Lex bot. Maximum character limit of 50.
|
1954
|
+
#
|
1955
|
+
# @option params [required, String] :lex_region
|
1956
|
+
# The Region in which the Amazon Lex bot has been created.
|
1957
|
+
#
|
1958
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1959
|
+
#
|
1960
|
+
# @example Request syntax with placeholder values
|
1961
|
+
#
|
1962
|
+
# resp = client.disassociate_lex_bot({
|
1963
|
+
# instance_id: "InstanceId", # required
|
1964
|
+
# bot_name: "BotName", # required
|
1965
|
+
# lex_region: "LexRegion", # required
|
1966
|
+
# })
|
1967
|
+
#
|
1968
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateLexBot AWS API Documentation
|
1969
|
+
#
|
1970
|
+
# @overload disassociate_lex_bot(params = {})
|
1971
|
+
# @param [Hash] params ({})
|
1972
|
+
def disassociate_lex_bot(params = {}, options = {})
|
1973
|
+
req = build_request(:disassociate_lex_bot, params)
|
1974
|
+
req.send_request(options)
|
1975
|
+
end
|
1976
|
+
|
1977
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1978
|
+
# change.
|
865
1979
|
#
|
866
|
-
#
|
1980
|
+
# Disassociates a set of quick connects from a queue.
|
1981
|
+
#
|
1982
|
+
# @option params [required, String] :instance_id
|
1983
|
+
# The identifier of the Amazon Connect instance.
|
1984
|
+
#
|
1985
|
+
# @option params [required, String] :queue_id
|
1986
|
+
# The identifier for the queue.
|
1987
|
+
#
|
1988
|
+
# @option params [required, Array<String>] :quick_connect_ids
|
1989
|
+
# The quick connects to disassociate from the queue.
|
1990
|
+
#
|
1991
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1992
|
+
#
|
1993
|
+
# @example Request syntax with placeholder values
|
1994
|
+
#
|
1995
|
+
# resp = client.disassociate_queue_quick_connects({
|
1996
|
+
# instance_id: "InstanceId", # required
|
1997
|
+
# queue_id: "QueueId", # required
|
1998
|
+
# quick_connect_ids: ["QuickConnectId"], # required
|
1999
|
+
# })
|
2000
|
+
#
|
2001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateQueueQuickConnects AWS API Documentation
|
2002
|
+
#
|
2003
|
+
# @overload disassociate_queue_quick_connects(params = {})
|
867
2004
|
# @param [Hash] params ({})
|
868
|
-
def
|
869
|
-
req = build_request(:
|
2005
|
+
def disassociate_queue_quick_connects(params = {}, options = {})
|
2006
|
+
req = build_request(:disassociate_queue_quick_connects, params)
|
870
2007
|
req.send_request(options)
|
871
2008
|
end
|
872
2009
|
|
@@ -891,7 +2028,7 @@ module Aws::Connect
|
|
891
2028
|
# queue_references: [ # required
|
892
2029
|
# {
|
893
2030
|
# queue_id: "QueueId", # required
|
894
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
2031
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
895
2032
|
# },
|
896
2033
|
# ],
|
897
2034
|
# })
|
@@ -905,6 +2042,36 @@ module Aws::Connect
|
|
905
2042
|
req.send_request(options)
|
906
2043
|
end
|
907
2044
|
|
2045
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2046
|
+
# change.
|
2047
|
+
#
|
2048
|
+
# Deletes the specified security key.
|
2049
|
+
#
|
2050
|
+
# @option params [required, String] :instance_id
|
2051
|
+
# The identifier of the Amazon Connect instance.
|
2052
|
+
#
|
2053
|
+
# @option params [required, String] :association_id
|
2054
|
+
# The existing association identifier that uniquely identifies the
|
2055
|
+
# resource type and storage config for the given instance ID.
|
2056
|
+
#
|
2057
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2058
|
+
#
|
2059
|
+
# @example Request syntax with placeholder values
|
2060
|
+
#
|
2061
|
+
# resp = client.disassociate_security_key({
|
2062
|
+
# instance_id: "InstanceId", # required
|
2063
|
+
# association_id: "AssociationId", # required
|
2064
|
+
# })
|
2065
|
+
#
|
2066
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateSecurityKey AWS API Documentation
|
2067
|
+
#
|
2068
|
+
# @overload disassociate_security_key(params = {})
|
2069
|
+
# @param [Hash] params ({})
|
2070
|
+
def disassociate_security_key(params = {}, options = {})
|
2071
|
+
req = build_request(:disassociate_security_key, params)
|
2072
|
+
req.send_request(options)
|
2073
|
+
end
|
2074
|
+
|
908
2075
|
# Retrieves the contact attributes for the specified contact.
|
909
2076
|
#
|
910
2077
|
# @option params [required, String] :instance_id
|
@@ -955,14 +2122,14 @@ module Aws::Connect
|
|
955
2122
|
# The queues, up to 100, or channels, to use to filter the metrics
|
956
2123
|
# returned. Metric data is retrieved only for the resources associated
|
957
2124
|
# with the queues or channels included in the filter. You can include
|
958
|
-
# both queue IDs and queue ARNs in the same request.
|
959
|
-
#
|
2125
|
+
# both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
|
2126
|
+
# TASK channels are supported.
|
960
2127
|
#
|
961
2128
|
# @option params [Array<String>] :groupings
|
962
2129
|
# The grouping applied to the metrics returned. For example, when
|
963
2130
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
964
2131
|
# than aggregated for all queues. If you group by `CHANNEL`, you should
|
965
|
-
# include a Channels filter.
|
2132
|
+
# include a Channels filter. VOICE, CHAT, and TASK channels are
|
966
2133
|
# supported.
|
967
2134
|
#
|
968
2135
|
# If no `Grouping` is included in the request, a summary of metrics is
|
@@ -1086,7 +2253,7 @@ module Aws::Connect
|
|
1086
2253
|
# parameters as the request that generated the token.
|
1087
2254
|
#
|
1088
2255
|
# @option params [Integer] :max_results
|
1089
|
-
# The
|
2256
|
+
# The maximum number of results to return per page.
|
1090
2257
|
#
|
1091
2258
|
# @return [Types::GetCurrentMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1092
2259
|
#
|
@@ -1102,7 +2269,7 @@ module Aws::Connect
|
|
1102
2269
|
# instance_id: "InstanceId", # required
|
1103
2270
|
# filters: { # required
|
1104
2271
|
# queues: ["QueueId"],
|
1105
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
2272
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
1106
2273
|
# },
|
1107
2274
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
1108
2275
|
# current_metrics: [ # required
|
@@ -1121,7 +2288,7 @@ module Aws::Connect
|
|
1121
2288
|
# resp.metric_results #=> Array
|
1122
2289
|
# resp.metric_results[0].dimensions.queue.id #=> String
|
1123
2290
|
# resp.metric_results[0].dimensions.queue.arn #=> String
|
1124
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
2291
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
1125
2292
|
# resp.metric_results[0].collections #=> Array
|
1126
2293
|
# 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
2294
|
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
@@ -1203,8 +2370,8 @@ module Aws::Connect
|
|
1203
2370
|
# The queues, up to 100, or channels, to use to filter the metrics
|
1204
2371
|
# returned. Metric data is retrieved only for the resources associated
|
1205
2372
|
# with the queues or channels included in the filter. You can include
|
1206
|
-
# both queue IDs and queue ARNs in the same request.
|
1207
|
-
#
|
2373
|
+
# both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
|
2374
|
+
# TASK channels are supported.
|
1208
2375
|
#
|
1209
2376
|
# @option params [Array<String>] :groupings
|
1210
2377
|
# The grouping applied to the metrics returned. For example, when
|
@@ -1249,137 +2416,482 @@ module Aws::Connect
|
|
1249
2416
|
#
|
1250
2417
|
# CONTACTS\_ABANDONED
|
1251
2418
|
#
|
1252
|
-
# : Unit: COUNT
|
2419
|
+
# : Unit: COUNT
|
2420
|
+
#
|
2421
|
+
# Statistic: SUM
|
2422
|
+
#
|
2423
|
+
# CONTACTS\_AGENT\_HUNG\_UP\_FIRST
|
2424
|
+
#
|
2425
|
+
# : Unit: COUNT
|
2426
|
+
#
|
2427
|
+
# Statistic: SUM
|
2428
|
+
#
|
2429
|
+
# CONTACTS\_CONSULTED
|
2430
|
+
#
|
2431
|
+
# : Unit: COUNT
|
2432
|
+
#
|
2433
|
+
# Statistic: SUM
|
2434
|
+
#
|
2435
|
+
# CONTACTS\_HANDLED
|
2436
|
+
#
|
2437
|
+
# : Unit: COUNT
|
2438
|
+
#
|
2439
|
+
# Statistic: SUM
|
2440
|
+
#
|
2441
|
+
# CONTACTS\_HANDLED\_INCOMING
|
2442
|
+
#
|
2443
|
+
# : Unit: COUNT
|
2444
|
+
#
|
2445
|
+
# Statistic: SUM
|
2446
|
+
#
|
2447
|
+
# CONTACTS\_HANDLED\_OUTBOUND
|
2448
|
+
#
|
2449
|
+
# : Unit: COUNT
|
2450
|
+
#
|
2451
|
+
# Statistic: SUM
|
2452
|
+
#
|
2453
|
+
# CONTACTS\_HOLD\_ABANDONS
|
2454
|
+
#
|
2455
|
+
# : Unit: COUNT
|
2456
|
+
#
|
2457
|
+
# Statistic: SUM
|
2458
|
+
#
|
2459
|
+
# CONTACTS\_MISSED
|
2460
|
+
#
|
2461
|
+
# : Unit: COUNT
|
2462
|
+
#
|
2463
|
+
# Statistic: SUM
|
2464
|
+
#
|
2465
|
+
# CONTACTS\_QUEUED
|
2466
|
+
#
|
2467
|
+
# : Unit: COUNT
|
2468
|
+
#
|
2469
|
+
# Statistic: SUM
|
2470
|
+
#
|
2471
|
+
# CONTACTS\_TRANSFERRED\_IN
|
2472
|
+
#
|
2473
|
+
# : Unit: COUNT
|
2474
|
+
#
|
2475
|
+
# Statistic: SUM
|
2476
|
+
#
|
2477
|
+
# CONTACTS\_TRANSFERRED\_IN\_FROM\_QUEUE
|
2478
|
+
#
|
2479
|
+
# : Unit: COUNT
|
2480
|
+
#
|
2481
|
+
# Statistic: SUM
|
2482
|
+
#
|
2483
|
+
# CONTACTS\_TRANSFERRED\_OUT
|
2484
|
+
#
|
2485
|
+
# : Unit: COUNT
|
2486
|
+
#
|
2487
|
+
# Statistic: SUM
|
2488
|
+
#
|
2489
|
+
# CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
|
2490
|
+
#
|
2491
|
+
# : Unit: COUNT
|
2492
|
+
#
|
2493
|
+
# Statistic: SUM
|
2494
|
+
#
|
2495
|
+
# HANDLE\_TIME
|
2496
|
+
#
|
2497
|
+
# : Unit: SECONDS
|
2498
|
+
#
|
2499
|
+
# Statistic: AVG
|
2500
|
+
#
|
2501
|
+
# HOLD\_TIME
|
2502
|
+
#
|
2503
|
+
# : Unit: SECONDS
|
2504
|
+
#
|
2505
|
+
# Statistic: AVG
|
2506
|
+
#
|
2507
|
+
# INTERACTION\_AND\_HOLD\_TIME
|
2508
|
+
#
|
2509
|
+
# : Unit: SECONDS
|
2510
|
+
#
|
2511
|
+
# Statistic: AVG
|
2512
|
+
#
|
2513
|
+
# INTERACTION\_TIME
|
2514
|
+
#
|
2515
|
+
# : Unit: SECONDS
|
2516
|
+
#
|
2517
|
+
# Statistic: AVG
|
2518
|
+
#
|
2519
|
+
# OCCUPANCY
|
2520
|
+
#
|
2521
|
+
# : Unit: PERCENT
|
2522
|
+
#
|
2523
|
+
# Statistic: AVG
|
2524
|
+
#
|
2525
|
+
# QUEUE\_ANSWER\_TIME
|
2526
|
+
#
|
2527
|
+
# : Unit: SECONDS
|
2528
|
+
#
|
2529
|
+
# Statistic: AVG
|
2530
|
+
#
|
2531
|
+
# QUEUED\_TIME
|
2532
|
+
#
|
2533
|
+
# : Unit: SECONDS
|
2534
|
+
#
|
2535
|
+
# Statistic: MAX
|
2536
|
+
#
|
2537
|
+
# SERVICE\_LEVEL
|
2538
|
+
#
|
2539
|
+
# : Unit: PERCENT
|
2540
|
+
#
|
2541
|
+
# Statistic: AVG
|
2542
|
+
#
|
2543
|
+
# Threshold: Only "Less than" comparisons are supported, with the
|
2544
|
+
# following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120,
|
2545
|
+
# 180, 240, 300, 600
|
2546
|
+
#
|
2547
|
+
#
|
2548
|
+
#
|
2549
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
2550
|
+
#
|
2551
|
+
# @option params [String] :next_token
|
2552
|
+
# The token for the next set of results. Use the value returned in the
|
2553
|
+
# previous response in the next request to retrieve the next set of
|
2554
|
+
# results.
|
2555
|
+
#
|
2556
|
+
# @option params [Integer] :max_results
|
2557
|
+
# The maximum number of results to return per page.
|
2558
|
+
#
|
2559
|
+
# @return [Types::GetMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2560
|
+
#
|
2561
|
+
# * {Types::GetMetricDataResponse#next_token #next_token} => String
|
2562
|
+
# * {Types::GetMetricDataResponse#metric_results #metric_results} => Array<Types::HistoricalMetricResult>
|
2563
|
+
#
|
2564
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2565
|
+
#
|
2566
|
+
# @example Request syntax with placeholder values
|
2567
|
+
#
|
2568
|
+
# resp = client.get_metric_data({
|
2569
|
+
# instance_id: "InstanceId", # required
|
2570
|
+
# start_time: Time.now, # required
|
2571
|
+
# end_time: Time.now, # required
|
2572
|
+
# filters: { # required
|
2573
|
+
# queues: ["QueueId"],
|
2574
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
2575
|
+
# },
|
2576
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
2577
|
+
# historical_metrics: [ # required
|
2578
|
+
# {
|
2579
|
+
# 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
|
2580
|
+
# threshold: {
|
2581
|
+
# comparison: "LT", # accepts LT
|
2582
|
+
# threshold_value: 1.0,
|
2583
|
+
# },
|
2584
|
+
# statistic: "SUM", # accepts SUM, MAX, AVG
|
2585
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
2586
|
+
# },
|
2587
|
+
# ],
|
2588
|
+
# next_token: "NextToken",
|
2589
|
+
# max_results: 1,
|
2590
|
+
# })
|
2591
|
+
#
|
2592
|
+
# @example Response structure
|
2593
|
+
#
|
2594
|
+
# resp.next_token #=> String
|
2595
|
+
# resp.metric_results #=> Array
|
2596
|
+
# resp.metric_results[0].dimensions.queue.id #=> String
|
2597
|
+
# resp.metric_results[0].dimensions.queue.arn #=> String
|
2598
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
2599
|
+
# resp.metric_results[0].collections #=> Array
|
2600
|
+
# 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"
|
2601
|
+
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
2602
|
+
# resp.metric_results[0].collections[0].metric.threshold.threshold_value #=> Float
|
2603
|
+
# resp.metric_results[0].collections[0].metric.statistic #=> String, one of "SUM", "MAX", "AVG"
|
2604
|
+
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
2605
|
+
# resp.metric_results[0].collections[0].value #=> Float
|
2606
|
+
#
|
2607
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData AWS API Documentation
|
2608
|
+
#
|
2609
|
+
# @overload get_metric_data(params = {})
|
2610
|
+
# @param [Hash] params ({})
|
2611
|
+
def get_metric_data(params = {}, options = {})
|
2612
|
+
req = build_request(:get_metric_data, params)
|
2613
|
+
req.send_request(options)
|
2614
|
+
end
|
2615
|
+
|
2616
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2617
|
+
# change.
|
2618
|
+
#
|
2619
|
+
# Returns a paginated list of all approved origins associated with the
|
2620
|
+
# instance.
|
2621
|
+
#
|
2622
|
+
# @option params [required, String] :instance_id
|
2623
|
+
# The identifier of the Amazon Connect instance.
|
2624
|
+
#
|
2625
|
+
# @option params [String] :next_token
|
2626
|
+
# The token for the next set of results. Use the value returned in the
|
2627
|
+
# previous response in the next request to retrieve the next set of
|
2628
|
+
# results.
|
2629
|
+
#
|
2630
|
+
# @option params [Integer] :max_results
|
2631
|
+
# The maximum number of results to return per page.
|
2632
|
+
#
|
2633
|
+
# @return [Types::ListApprovedOriginsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2634
|
+
#
|
2635
|
+
# * {Types::ListApprovedOriginsResponse#origins #origins} => Array<String>
|
2636
|
+
# * {Types::ListApprovedOriginsResponse#next_token #next_token} => String
|
2637
|
+
#
|
2638
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2639
|
+
#
|
2640
|
+
# @example Request syntax with placeholder values
|
2641
|
+
#
|
2642
|
+
# resp = client.list_approved_origins({
|
2643
|
+
# instance_id: "InstanceId", # required
|
2644
|
+
# next_token: "NextToken",
|
2645
|
+
# max_results: 1,
|
2646
|
+
# })
|
2647
|
+
#
|
2648
|
+
# @example Response structure
|
1253
2649
|
#
|
1254
|
-
#
|
2650
|
+
# resp.origins #=> Array
|
2651
|
+
# resp.origins[0] #=> String
|
2652
|
+
# resp.next_token #=> String
|
1255
2653
|
#
|
1256
|
-
#
|
2654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListApprovedOrigins AWS API Documentation
|
1257
2655
|
#
|
1258
|
-
#
|
2656
|
+
# @overload list_approved_origins(params = {})
|
2657
|
+
# @param [Hash] params ({})
|
2658
|
+
def list_approved_origins(params = {}, options = {})
|
2659
|
+
req = build_request(:list_approved_origins, params)
|
2660
|
+
req.send_request(options)
|
2661
|
+
end
|
2662
|
+
|
2663
|
+
# Provides information about the contact flows for the specified Amazon
|
2664
|
+
# Connect instance.
|
1259
2665
|
#
|
1260
|
-
#
|
2666
|
+
# You can also create and update contact flows using the [Amazon Connect
|
2667
|
+
# Flow language][1].
|
1261
2668
|
#
|
1262
|
-
#
|
2669
|
+
# For more information about contact flows, see [Contact Flows][2] in
|
2670
|
+
# the *Amazon Connect Administrator Guide*.
|
1263
2671
|
#
|
1264
|
-
# : Unit: COUNT
|
1265
2672
|
#
|
1266
|
-
# Statistic: SUM
|
1267
2673
|
#
|
1268
|
-
#
|
2674
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
2675
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html
|
1269
2676
|
#
|
1270
|
-
#
|
2677
|
+
# @option params [required, String] :instance_id
|
2678
|
+
# The identifier of the Amazon Connect instance.
|
1271
2679
|
#
|
1272
|
-
#
|
2680
|
+
# @option params [Array<String>] :contact_flow_types
|
2681
|
+
# The type of contact flow.
|
1273
2682
|
#
|
1274
|
-
#
|
2683
|
+
# @option params [String] :next_token
|
2684
|
+
# The token for the next set of results. Use the value returned in the
|
2685
|
+
# previous response in the next request to retrieve the next set of
|
2686
|
+
# results.
|
1275
2687
|
#
|
1276
|
-
#
|
2688
|
+
# @option params [Integer] :max_results
|
2689
|
+
# The maximum number of results to return per page.
|
1277
2690
|
#
|
1278
|
-
#
|
2691
|
+
# @return [Types::ListContactFlowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1279
2692
|
#
|
1280
|
-
#
|
2693
|
+
# * {Types::ListContactFlowsResponse#contact_flow_summary_list #contact_flow_summary_list} => Array<Types::ContactFlowSummary>
|
2694
|
+
# * {Types::ListContactFlowsResponse#next_token #next_token} => String
|
1281
2695
|
#
|
1282
|
-
#
|
2696
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1283
2697
|
#
|
1284
|
-
#
|
2698
|
+
# @example Request syntax with placeholder values
|
1285
2699
|
#
|
1286
|
-
#
|
2700
|
+
# resp = client.list_contact_flows({
|
2701
|
+
# instance_id: "InstanceId", # required
|
2702
|
+
# contact_flow_types: ["CONTACT_FLOW"], # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
2703
|
+
# next_token: "NextToken",
|
2704
|
+
# max_results: 1,
|
2705
|
+
# })
|
1287
2706
|
#
|
1288
|
-
#
|
2707
|
+
# @example Response structure
|
1289
2708
|
#
|
1290
|
-
#
|
2709
|
+
# resp.contact_flow_summary_list #=> Array
|
2710
|
+
# resp.contact_flow_summary_list[0].id #=> String
|
2711
|
+
# resp.contact_flow_summary_list[0].arn #=> String
|
2712
|
+
# resp.contact_flow_summary_list[0].name #=> String
|
2713
|
+
# 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"
|
2714
|
+
# resp.next_token #=> String
|
1291
2715
|
#
|
1292
|
-
#
|
2716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlows AWS API Documentation
|
1293
2717
|
#
|
1294
|
-
#
|
2718
|
+
# @overload list_contact_flows(params = {})
|
2719
|
+
# @param [Hash] params ({})
|
2720
|
+
def list_contact_flows(params = {}, options = {})
|
2721
|
+
req = build_request(:list_contact_flows, params)
|
2722
|
+
req.send_request(options)
|
2723
|
+
end
|
2724
|
+
|
2725
|
+
# Provides information about the hours of operation for the specified
|
2726
|
+
# Amazon Connect instance.
|
1295
2727
|
#
|
1296
|
-
#
|
2728
|
+
# For more information about hours of operation, see [Set the Hours of
|
2729
|
+
# Operation for a Queue][1] in the *Amazon Connect Administrator Guide*.
|
1297
2730
|
#
|
1298
|
-
# CONTACTS\_QUEUED
|
1299
2731
|
#
|
1300
|
-
# : Unit: COUNT
|
1301
2732
|
#
|
1302
|
-
#
|
2733
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html
|
1303
2734
|
#
|
1304
|
-
#
|
2735
|
+
# @option params [required, String] :instance_id
|
2736
|
+
# The identifier of the Amazon Connect instance.
|
1305
2737
|
#
|
1306
|
-
#
|
2738
|
+
# @option params [String] :next_token
|
2739
|
+
# The token for the next set of results. Use the value returned in the
|
2740
|
+
# previous response in the next request to retrieve the next set of
|
2741
|
+
# results.
|
1307
2742
|
#
|
1308
|
-
#
|
2743
|
+
# @option params [Integer] :max_results
|
2744
|
+
# The maximum number of results to return per page.
|
1309
2745
|
#
|
1310
|
-
#
|
2746
|
+
# @return [Types::ListHoursOfOperationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1311
2747
|
#
|
1312
|
-
#
|
2748
|
+
# * {Types::ListHoursOfOperationsResponse#hours_of_operation_summary_list #hours_of_operation_summary_list} => Array<Types::HoursOfOperationSummary>
|
2749
|
+
# * {Types::ListHoursOfOperationsResponse#next_token #next_token} => String
|
1313
2750
|
#
|
1314
|
-
#
|
2751
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1315
2752
|
#
|
1316
|
-
#
|
2753
|
+
# @example Request syntax with placeholder values
|
1317
2754
|
#
|
1318
|
-
#
|
2755
|
+
# resp = client.list_hours_of_operations({
|
2756
|
+
# instance_id: "InstanceId", # required
|
2757
|
+
# next_token: "NextToken",
|
2758
|
+
# max_results: 1,
|
2759
|
+
# })
|
1319
2760
|
#
|
1320
|
-
#
|
2761
|
+
# @example Response structure
|
1321
2762
|
#
|
1322
|
-
#
|
2763
|
+
# resp.hours_of_operation_summary_list #=> Array
|
2764
|
+
# resp.hours_of_operation_summary_list[0].id #=> String
|
2765
|
+
# resp.hours_of_operation_summary_list[0].arn #=> String
|
2766
|
+
# resp.hours_of_operation_summary_list[0].name #=> String
|
2767
|
+
# resp.next_token #=> String
|
1323
2768
|
#
|
1324
|
-
#
|
2769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperations AWS API Documentation
|
1325
2770
|
#
|
1326
|
-
#
|
2771
|
+
# @overload list_hours_of_operations(params = {})
|
2772
|
+
# @param [Hash] params ({})
|
2773
|
+
def list_hours_of_operations(params = {}, options = {})
|
2774
|
+
req = build_request(:list_hours_of_operations, params)
|
2775
|
+
req.send_request(options)
|
2776
|
+
end
|
2777
|
+
|
2778
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2779
|
+
# change.
|
1327
2780
|
#
|
1328
|
-
#
|
2781
|
+
# Returns a paginated list of all attribute types for the given
|
2782
|
+
# instance.
|
1329
2783
|
#
|
1330
|
-
#
|
2784
|
+
# @option params [required, String] :instance_id
|
2785
|
+
# The identifier of the Amazon Connect instance.
|
1331
2786
|
#
|
1332
|
-
#
|
2787
|
+
# @option params [String] :next_token
|
2788
|
+
# The token for the next set of results. Use the value returned in the
|
2789
|
+
# previous response in the next request to retrieve the next set of
|
2790
|
+
# results.
|
1333
2791
|
#
|
1334
|
-
#
|
2792
|
+
# @option params [Integer] :max_results
|
2793
|
+
# The maximum number of results to return per page.
|
1335
2794
|
#
|
1336
|
-
#
|
2795
|
+
# @return [Types::ListInstanceAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1337
2796
|
#
|
1338
|
-
#
|
2797
|
+
# * {Types::ListInstanceAttributesResponse#attributes #attributes} => Array<Types::Attribute>
|
2798
|
+
# * {Types::ListInstanceAttributesResponse#next_token #next_token} => String
|
1339
2799
|
#
|
1340
|
-
#
|
2800
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1341
2801
|
#
|
1342
|
-
#
|
2802
|
+
# @example Request syntax with placeholder values
|
1343
2803
|
#
|
1344
|
-
#
|
2804
|
+
# resp = client.list_instance_attributes({
|
2805
|
+
# instance_id: "InstanceId", # required
|
2806
|
+
# next_token: "NextToken",
|
2807
|
+
# max_results: 1,
|
2808
|
+
# })
|
1345
2809
|
#
|
1346
|
-
#
|
2810
|
+
# @example Response structure
|
1347
2811
|
#
|
1348
|
-
#
|
2812
|
+
# resp.attributes #=> Array
|
2813
|
+
# 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"
|
2814
|
+
# resp.attributes[0].value #=> String
|
2815
|
+
# resp.next_token #=> String
|
1349
2816
|
#
|
1350
|
-
#
|
2817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceAttributes AWS API Documentation
|
1351
2818
|
#
|
1352
|
-
#
|
2819
|
+
# @overload list_instance_attributes(params = {})
|
2820
|
+
# @param [Hash] params ({})
|
2821
|
+
def list_instance_attributes(params = {}, options = {})
|
2822
|
+
req = build_request(:list_instance_attributes, params)
|
2823
|
+
req.send_request(options)
|
2824
|
+
end
|
2825
|
+
|
2826
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2827
|
+
# change.
|
1353
2828
|
#
|
1354
|
-
#
|
2829
|
+
# Returns a paginated list of storage configs for the identified
|
2830
|
+
# instance and resource type.
|
1355
2831
|
#
|
1356
|
-
#
|
2832
|
+
# @option params [required, String] :instance_id
|
2833
|
+
# The identifier of the Amazon Connect instance.
|
1357
2834
|
#
|
1358
|
-
#
|
2835
|
+
# @option params [required, String] :resource_type
|
2836
|
+
# A valid resource type.
|
1359
2837
|
#
|
1360
|
-
#
|
2838
|
+
# @option params [String] :next_token
|
2839
|
+
# The token for the next set of results. Use the value returned in the
|
2840
|
+
# previous response in the next request to retrieve the next set of
|
2841
|
+
# results.
|
1361
2842
|
#
|
1362
|
-
#
|
2843
|
+
# @option params [Integer] :max_results
|
2844
|
+
# The maximum number of results to return per page.
|
1363
2845
|
#
|
1364
|
-
#
|
2846
|
+
# @return [Types::ListInstanceStorageConfigsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1365
2847
|
#
|
1366
|
-
#
|
2848
|
+
# * {Types::ListInstanceStorageConfigsResponse#storage_configs #storage_configs} => Array<Types::InstanceStorageConfig>
|
2849
|
+
# * {Types::ListInstanceStorageConfigsResponse#next_token #next_token} => String
|
1367
2850
|
#
|
1368
|
-
#
|
2851
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1369
2852
|
#
|
1370
|
-
#
|
2853
|
+
# @example Request syntax with placeholder values
|
1371
2854
|
#
|
1372
|
-
#
|
2855
|
+
# resp = client.list_instance_storage_configs({
|
2856
|
+
# instance_id: "InstanceId", # required
|
2857
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
2858
|
+
# next_token: "NextToken",
|
2859
|
+
# max_results: 1,
|
2860
|
+
# })
|
1373
2861
|
#
|
1374
|
-
#
|
2862
|
+
# @example Response structure
|
1375
2863
|
#
|
1376
|
-
#
|
1377
|
-
#
|
1378
|
-
#
|
2864
|
+
# resp.storage_configs #=> Array
|
2865
|
+
# resp.storage_configs[0].association_id #=> String
|
2866
|
+
# resp.storage_configs[0].storage_type #=> String, one of "S3", "KINESIS_VIDEO_STREAM", "KINESIS_STREAM", "KINESIS_FIREHOSE"
|
2867
|
+
# resp.storage_configs[0].s3_config.bucket_name #=> String
|
2868
|
+
# resp.storage_configs[0].s3_config.bucket_prefix #=> String
|
2869
|
+
# resp.storage_configs[0].s3_config.encryption_config.encryption_type #=> String, one of "KMS"
|
2870
|
+
# resp.storage_configs[0].s3_config.encryption_config.key_id #=> String
|
2871
|
+
# resp.storage_configs[0].kinesis_video_stream_config.prefix #=> String
|
2872
|
+
# resp.storage_configs[0].kinesis_video_stream_config.retention_period_hours #=> Integer
|
2873
|
+
# resp.storage_configs[0].kinesis_video_stream_config.encryption_config.encryption_type #=> String, one of "KMS"
|
2874
|
+
# resp.storage_configs[0].kinesis_video_stream_config.encryption_config.key_id #=> String
|
2875
|
+
# resp.storage_configs[0].kinesis_stream_config.stream_arn #=> String
|
2876
|
+
# resp.storage_configs[0].kinesis_firehose_config.firehose_arn #=> String
|
2877
|
+
# resp.next_token #=> String
|
1379
2878
|
#
|
2879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceStorageConfigs AWS API Documentation
|
1380
2880
|
#
|
2881
|
+
# @overload list_instance_storage_configs(params = {})
|
2882
|
+
# @param [Hash] params ({})
|
2883
|
+
def list_instance_storage_configs(params = {}, options = {})
|
2884
|
+
req = build_request(:list_instance_storage_configs, params)
|
2885
|
+
req.send_request(options)
|
2886
|
+
end
|
2887
|
+
|
2888
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2889
|
+
# change.
|
1381
2890
|
#
|
1382
|
-
#
|
2891
|
+
# Return a list of instances which are in active state,
|
2892
|
+
# creation-in-progress state, and failed state. Instances that aren't
|
2893
|
+
# successfully created (they are in a failed state) are returned only
|
2894
|
+
# for 24 hours after the CreateInstance API was invoked.
|
1383
2895
|
#
|
1384
2896
|
# @option params [String] :next_token
|
1385
2897
|
# The token for the next set of results. Use the value returned in the
|
@@ -1387,136 +2899,151 @@ module Aws::Connect
|
|
1387
2899
|
# results.
|
1388
2900
|
#
|
1389
2901
|
# @option params [Integer] :max_results
|
1390
|
-
# The
|
2902
|
+
# The maximum number of results to return per page.
|
1391
2903
|
#
|
1392
|
-
# @return [Types::
|
2904
|
+
# @return [Types::ListInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1393
2905
|
#
|
1394
|
-
# * {Types::
|
1395
|
-
# * {Types::
|
2906
|
+
# * {Types::ListInstancesResponse#instance_summary_list #instance_summary_list} => Array<Types::InstanceSummary>
|
2907
|
+
# * {Types::ListInstancesResponse#next_token #next_token} => String
|
1396
2908
|
#
|
1397
2909
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1398
2910
|
#
|
1399
2911
|
# @example Request syntax with placeholder values
|
1400
2912
|
#
|
1401
|
-
# resp = client.
|
1402
|
-
# 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
|
-
# ],
|
2913
|
+
# resp = client.list_instances({
|
1421
2914
|
# next_token: "NextToken",
|
1422
2915
|
# max_results: 1,
|
1423
2916
|
# })
|
1424
2917
|
#
|
1425
2918
|
# @example Response structure
|
1426
2919
|
#
|
2920
|
+
# resp.instance_summary_list #=> Array
|
2921
|
+
# resp.instance_summary_list[0].id #=> String
|
2922
|
+
# resp.instance_summary_list[0].arn #=> String
|
2923
|
+
# resp.instance_summary_list[0].identity_management_type #=> String, one of "SAML", "CONNECT_MANAGED", "EXISTING_DIRECTORY"
|
2924
|
+
# resp.instance_summary_list[0].instance_alias #=> String
|
2925
|
+
# resp.instance_summary_list[0].created_time #=> Time
|
2926
|
+
# resp.instance_summary_list[0].service_role #=> String
|
2927
|
+
# resp.instance_summary_list[0].instance_status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED"
|
2928
|
+
# resp.instance_summary_list[0].inbound_calls_enabled #=> Boolean
|
2929
|
+
# resp.instance_summary_list[0].outbound_calls_enabled #=> Boolean
|
1427
2930
|
# 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
2931
|
#
|
1440
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstances AWS API Documentation
|
1441
2933
|
#
|
1442
|
-
# @overload
|
2934
|
+
# @overload list_instances(params = {})
|
1443
2935
|
# @param [Hash] params ({})
|
1444
|
-
def
|
1445
|
-
req = build_request(:
|
2936
|
+
def list_instances(params = {}, options = {})
|
2937
|
+
req = build_request(:list_instances, params)
|
1446
2938
|
req.send_request(options)
|
1447
2939
|
end
|
1448
2940
|
|
1449
|
-
#
|
1450
|
-
#
|
2941
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2942
|
+
# change.
|
2943
|
+
#
|
2944
|
+
# Provides summary information about the AppIntegration associations for
|
2945
|
+
# the specified Amazon Connect instance.
|
2946
|
+
#
|
2947
|
+
# @option params [required, String] :instance_id
|
2948
|
+
# The identifier of the Amazon Connect instance.
|
2949
|
+
#
|
2950
|
+
# @option params [String] :next_token
|
2951
|
+
# The token for the next set of results. Use the value returned in the
|
2952
|
+
# previous response in the next request to retrieve the next set of
|
2953
|
+
# results.
|
2954
|
+
#
|
2955
|
+
# @option params [Integer] :max_results
|
2956
|
+
# The maximum number of results to return per page.
|
2957
|
+
#
|
2958
|
+
# @return [Types::ListIntegrationAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2959
|
+
#
|
2960
|
+
# * {Types::ListIntegrationAssociationsResponse#integration_association_summary_list #integration_association_summary_list} => Array<Types::IntegrationAssociationSummary>
|
2961
|
+
# * {Types::ListIntegrationAssociationsResponse#next_token #next_token} => String
|
2962
|
+
#
|
2963
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2964
|
+
#
|
2965
|
+
# @example Request syntax with placeholder values
|
2966
|
+
#
|
2967
|
+
# resp = client.list_integration_associations({
|
2968
|
+
# instance_id: "InstanceId", # required
|
2969
|
+
# next_token: "NextToken",
|
2970
|
+
# max_results: 1,
|
2971
|
+
# })
|
1451
2972
|
#
|
1452
|
-
#
|
1453
|
-
# Flow language][1].
|
2973
|
+
# @example Response structure
|
1454
2974
|
#
|
1455
|
-
#
|
1456
|
-
#
|
2975
|
+
# resp.integration_association_summary_list #=> Array
|
2976
|
+
# resp.integration_association_summary_list[0].integration_association_id #=> String
|
2977
|
+
# resp.integration_association_summary_list[0].integration_association_arn #=> String
|
2978
|
+
# resp.integration_association_summary_list[0].instance_id #=> String
|
2979
|
+
# resp.integration_association_summary_list[0].integration_type #=> String, one of "EVENT"
|
2980
|
+
# resp.integration_association_summary_list[0].integration_arn #=> String
|
2981
|
+
# resp.integration_association_summary_list[0].source_application_url #=> String
|
2982
|
+
# resp.integration_association_summary_list[0].source_application_name #=> String
|
2983
|
+
# resp.integration_association_summary_list[0].source_type #=> String, one of "SALESFORCE", "ZENDESK"
|
2984
|
+
# resp.next_token #=> String
|
1457
2985
|
#
|
2986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListIntegrationAssociations AWS API Documentation
|
1458
2987
|
#
|
2988
|
+
# @overload list_integration_associations(params = {})
|
2989
|
+
# @param [Hash] params ({})
|
2990
|
+
def list_integration_associations(params = {}, options = {})
|
2991
|
+
req = build_request(:list_integration_associations, params)
|
2992
|
+
req.send_request(options)
|
2993
|
+
end
|
2994
|
+
|
2995
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2996
|
+
# change.
|
1459
2997
|
#
|
1460
|
-
#
|
1461
|
-
#
|
2998
|
+
# Returns a paginated list of all Lambda functions that display in the
|
2999
|
+
# dropdown options in the relevant contact flow blocks.
|
1462
3000
|
#
|
1463
3001
|
# @option params [required, String] :instance_id
|
1464
3002
|
# The identifier of the Amazon Connect instance.
|
1465
3003
|
#
|
1466
|
-
# @option params [Array<String>] :contact_flow_types
|
1467
|
-
# The type of contact flow.
|
1468
|
-
#
|
1469
3004
|
# @option params [String] :next_token
|
1470
3005
|
# The token for the next set of results. Use the value returned in the
|
1471
3006
|
# previous response in the next request to retrieve the next set of
|
1472
3007
|
# results.
|
1473
3008
|
#
|
1474
3009
|
# @option params [Integer] :max_results
|
1475
|
-
# The
|
3010
|
+
# The maximum number of results to return per page.
|
1476
3011
|
#
|
1477
|
-
# @return [Types::
|
3012
|
+
# @return [Types::ListLambdaFunctionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1478
3013
|
#
|
1479
|
-
# * {Types::
|
1480
|
-
# * {Types::
|
3014
|
+
# * {Types::ListLambdaFunctionsResponse#lambda_functions #lambda_functions} => Array<String>
|
3015
|
+
# * {Types::ListLambdaFunctionsResponse#next_token #next_token} => String
|
1481
3016
|
#
|
1482
3017
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1483
3018
|
#
|
1484
3019
|
# @example Request syntax with placeholder values
|
1485
3020
|
#
|
1486
|
-
# resp = client.
|
3021
|
+
# resp = client.list_lambda_functions({
|
1487
3022
|
# 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
3023
|
# next_token: "NextToken",
|
1490
3024
|
# max_results: 1,
|
1491
3025
|
# })
|
1492
3026
|
#
|
1493
3027
|
# @example Response structure
|
1494
3028
|
#
|
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"
|
3029
|
+
# resp.lambda_functions #=> Array
|
3030
|
+
# resp.lambda_functions[0] #=> String
|
1500
3031
|
# resp.next_token #=> String
|
1501
3032
|
#
|
1502
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
3033
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLambdaFunctions AWS API Documentation
|
1503
3034
|
#
|
1504
|
-
# @overload
|
3035
|
+
# @overload list_lambda_functions(params = {})
|
1505
3036
|
# @param [Hash] params ({})
|
1506
|
-
def
|
1507
|
-
req = build_request(:
|
3037
|
+
def list_lambda_functions(params = {}, options = {})
|
3038
|
+
req = build_request(:list_lambda_functions, params)
|
1508
3039
|
req.send_request(options)
|
1509
3040
|
end
|
1510
3041
|
|
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
|
-
#
|
3042
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3043
|
+
# change.
|
1517
3044
|
#
|
1518
|
-
#
|
1519
|
-
#
|
3045
|
+
# Returns a paginated list of all the Amazon Lex bots currently
|
3046
|
+
# associated with the instance.
|
1520
3047
|
#
|
1521
3048
|
# @option params [required, String] :instance_id
|
1522
3049
|
# The identifier of the Amazon Connect instance.
|
@@ -1527,18 +3054,18 @@ module Aws::Connect
|
|
1527
3054
|
# results.
|
1528
3055
|
#
|
1529
3056
|
# @option params [Integer] :max_results
|
1530
|
-
# The
|
3057
|
+
# The maximum number of results to return per page.
|
1531
3058
|
#
|
1532
|
-
# @return [Types::
|
3059
|
+
# @return [Types::ListLexBotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1533
3060
|
#
|
1534
|
-
# * {Types::
|
1535
|
-
# * {Types::
|
3061
|
+
# * {Types::ListLexBotsResponse#lex_bots #lex_bots} => Array<Types::LexBot>
|
3062
|
+
# * {Types::ListLexBotsResponse#next_token #next_token} => String
|
1536
3063
|
#
|
1537
3064
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1538
3065
|
#
|
1539
3066
|
# @example Request syntax with placeholder values
|
1540
3067
|
#
|
1541
|
-
# resp = client.
|
3068
|
+
# resp = client.list_lex_bots({
|
1542
3069
|
# instance_id: "InstanceId", # required
|
1543
3070
|
# next_token: "NextToken",
|
1544
3071
|
# max_results: 1,
|
@@ -1546,18 +3073,17 @@ module Aws::Connect
|
|
1546
3073
|
#
|
1547
3074
|
# @example Response structure
|
1548
3075
|
#
|
1549
|
-
# resp.
|
1550
|
-
# resp.
|
1551
|
-
# resp.
|
1552
|
-
# resp.hours_of_operation_summary_list[0].name #=> String
|
3076
|
+
# resp.lex_bots #=> Array
|
3077
|
+
# resp.lex_bots[0].name #=> String
|
3078
|
+
# resp.lex_bots[0].lex_region #=> String
|
1553
3079
|
# resp.next_token #=> String
|
1554
3080
|
#
|
1555
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
3081
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLexBots AWS API Documentation
|
1556
3082
|
#
|
1557
|
-
# @overload
|
3083
|
+
# @overload list_lex_bots(params = {})
|
1558
3084
|
# @param [Hash] params ({})
|
1559
|
-
def
|
1560
|
-
req = build_request(:
|
3085
|
+
def list_lex_bots(params = {}, options = {})
|
3086
|
+
req = build_request(:list_lex_bots, params)
|
1561
3087
|
req.send_request(options)
|
1562
3088
|
end
|
1563
3089
|
|
@@ -1587,7 +3113,7 @@ module Aws::Connect
|
|
1587
3113
|
# results.
|
1588
3114
|
#
|
1589
3115
|
# @option params [Integer] :max_results
|
1590
|
-
# The
|
3116
|
+
# The maximum number of results to return per page.
|
1591
3117
|
#
|
1592
3118
|
# @return [Types::ListPhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1593
3119
|
#
|
@@ -1671,6 +3197,59 @@ module Aws::Connect
|
|
1671
3197
|
req.send_request(options)
|
1672
3198
|
end
|
1673
3199
|
|
3200
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3201
|
+
# change.
|
3202
|
+
#
|
3203
|
+
# Lists the quick connects associated with a queue.
|
3204
|
+
#
|
3205
|
+
# @option params [required, String] :instance_id
|
3206
|
+
# The identifier of the Amazon Connect instance.
|
3207
|
+
#
|
3208
|
+
# @option params [required, String] :queue_id
|
3209
|
+
# The identifier for the queue.
|
3210
|
+
#
|
3211
|
+
# @option params [String] :next_token
|
3212
|
+
# The token for the next set of results. Use the value returned in the
|
3213
|
+
# previous response in the next request to retrieve the next set of
|
3214
|
+
# results.
|
3215
|
+
#
|
3216
|
+
# @option params [Integer] :max_results
|
3217
|
+
# The maximum number of results to return per page.
|
3218
|
+
#
|
3219
|
+
# @return [Types::ListQueueQuickConnectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3220
|
+
#
|
3221
|
+
# * {Types::ListQueueQuickConnectsResponse#next_token #next_token} => String
|
3222
|
+
# * {Types::ListQueueQuickConnectsResponse#quick_connect_summary_list #quick_connect_summary_list} => Array<Types::QuickConnectSummary>
|
3223
|
+
#
|
3224
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3225
|
+
#
|
3226
|
+
# @example Request syntax with placeholder values
|
3227
|
+
#
|
3228
|
+
# resp = client.list_queue_quick_connects({
|
3229
|
+
# instance_id: "InstanceId", # required
|
3230
|
+
# queue_id: "QueueId", # required
|
3231
|
+
# next_token: "NextToken",
|
3232
|
+
# max_results: 1,
|
3233
|
+
# })
|
3234
|
+
#
|
3235
|
+
# @example Response structure
|
3236
|
+
#
|
3237
|
+
# resp.next_token #=> String
|
3238
|
+
# resp.quick_connect_summary_list #=> Array
|
3239
|
+
# resp.quick_connect_summary_list[0].id #=> String
|
3240
|
+
# resp.quick_connect_summary_list[0].arn #=> String
|
3241
|
+
# resp.quick_connect_summary_list[0].name #=> String
|
3242
|
+
# resp.quick_connect_summary_list[0].quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
|
3243
|
+
#
|
3244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueueQuickConnects AWS API Documentation
|
3245
|
+
#
|
3246
|
+
# @overload list_queue_quick_connects(params = {})
|
3247
|
+
# @param [Hash] params ({})
|
3248
|
+
def list_queue_quick_connects(params = {}, options = {})
|
3249
|
+
req = build_request(:list_queue_quick_connects, params)
|
3250
|
+
req.send_request(options)
|
3251
|
+
end
|
3252
|
+
|
1674
3253
|
# Provides information about the queues for the specified Amazon Connect
|
1675
3254
|
# instance.
|
1676
3255
|
#
|
@@ -1693,7 +3272,7 @@ module Aws::Connect
|
|
1693
3272
|
# results.
|
1694
3273
|
#
|
1695
3274
|
# @option params [Integer] :max_results
|
1696
|
-
# The
|
3275
|
+
# The maximum number of results to return per page.
|
1697
3276
|
#
|
1698
3277
|
# @return [Types::ListQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1699
3278
|
#
|
@@ -1729,7 +3308,64 @@ module Aws::Connect
|
|
1729
3308
|
req.send_request(options)
|
1730
3309
|
end
|
1731
3310
|
|
1732
|
-
#
|
3311
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3312
|
+
# change.
|
3313
|
+
#
|
3314
|
+
# Provides information about the quick connects for the specified Amazon
|
3315
|
+
# Connect instance.
|
3316
|
+
#
|
3317
|
+
# @option params [required, String] :instance_id
|
3318
|
+
# The identifier of the Amazon Connect instance.
|
3319
|
+
#
|
3320
|
+
# @option params [String] :next_token
|
3321
|
+
# The token for the next set of results. Use the value returned in the
|
3322
|
+
# previous response in the next request to retrieve the next set of
|
3323
|
+
# results.
|
3324
|
+
#
|
3325
|
+
# @option params [Integer] :max_results
|
3326
|
+
# The maximum number of results to return per page.
|
3327
|
+
#
|
3328
|
+
# @option params [Array<String>] :quick_connect_types
|
3329
|
+
# The type of quick connect. In the Amazon Connect console, when you
|
3330
|
+
# create a quick connect, you are prompted to assign one of the
|
3331
|
+
# following types: Agent (USER), External (PHONE\_NUMBER), or Queue
|
3332
|
+
# (QUEUE).
|
3333
|
+
#
|
3334
|
+
# @return [Types::ListQuickConnectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3335
|
+
#
|
3336
|
+
# * {Types::ListQuickConnectsResponse#quick_connect_summary_list #quick_connect_summary_list} => Array<Types::QuickConnectSummary>
|
3337
|
+
# * {Types::ListQuickConnectsResponse#next_token #next_token} => String
|
3338
|
+
#
|
3339
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3340
|
+
#
|
3341
|
+
# @example Request syntax with placeholder values
|
3342
|
+
#
|
3343
|
+
# resp = client.list_quick_connects({
|
3344
|
+
# instance_id: "InstanceId", # required
|
3345
|
+
# next_token: "NextToken",
|
3346
|
+
# max_results: 1,
|
3347
|
+
# quick_connect_types: ["USER"], # accepts USER, QUEUE, PHONE_NUMBER
|
3348
|
+
# })
|
3349
|
+
#
|
3350
|
+
# @example Response structure
|
3351
|
+
#
|
3352
|
+
# resp.quick_connect_summary_list #=> Array
|
3353
|
+
# resp.quick_connect_summary_list[0].id #=> String
|
3354
|
+
# resp.quick_connect_summary_list[0].arn #=> String
|
3355
|
+
# resp.quick_connect_summary_list[0].name #=> String
|
3356
|
+
# resp.quick_connect_summary_list[0].quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
|
3357
|
+
# resp.next_token #=> String
|
3358
|
+
#
|
3359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQuickConnects AWS API Documentation
|
3360
|
+
#
|
3361
|
+
# @overload list_quick_connects(params = {})
|
3362
|
+
# @param [Hash] params ({})
|
3363
|
+
def list_quick_connects(params = {}, options = {})
|
3364
|
+
req = build_request(:list_quick_connects, params)
|
3365
|
+
req.send_request(options)
|
3366
|
+
end
|
3367
|
+
|
3368
|
+
# Lists the queues associated with a routing profile.
|
1733
3369
|
#
|
1734
3370
|
# @option params [required, String] :instance_id
|
1735
3371
|
# The identifier of the Amazon Connect instance.
|
@@ -1743,7 +3379,7 @@ module Aws::Connect
|
|
1743
3379
|
# results.
|
1744
3380
|
#
|
1745
3381
|
# @option params [Integer] :max_results
|
1746
|
-
# The
|
3382
|
+
# The maximum number of results to return per page.
|
1747
3383
|
#
|
1748
3384
|
# @return [Types::ListRoutingProfileQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1749
3385
|
#
|
@@ -1770,7 +3406,7 @@ module Aws::Connect
|
|
1770
3406
|
# resp.routing_profile_queue_config_summary_list[0].queue_name #=> String
|
1771
3407
|
# resp.routing_profile_queue_config_summary_list[0].priority #=> Integer
|
1772
3408
|
# 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"
|
3409
|
+
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
1774
3410
|
#
|
1775
3411
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueues AWS API Documentation
|
1776
3412
|
#
|
@@ -1802,7 +3438,7 @@ module Aws::Connect
|
|
1802
3438
|
# results.
|
1803
3439
|
#
|
1804
3440
|
# @option params [Integer] :max_results
|
1805
|
-
# The
|
3441
|
+
# The maximum number of results to return per page.
|
1806
3442
|
#
|
1807
3443
|
# @return [Types::ListRoutingProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1808
3444
|
#
|
@@ -1836,6 +3472,55 @@ module Aws::Connect
|
|
1836
3472
|
req.send_request(options)
|
1837
3473
|
end
|
1838
3474
|
|
3475
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3476
|
+
# change.
|
3477
|
+
#
|
3478
|
+
# Returns a paginated list of all security keys associated with the
|
3479
|
+
# instance.
|
3480
|
+
#
|
3481
|
+
# @option params [required, String] :instance_id
|
3482
|
+
# The identifier of the Amazon Connect instance.
|
3483
|
+
#
|
3484
|
+
# @option params [String] :next_token
|
3485
|
+
# The token for the next set of results. Use the value returned in the
|
3486
|
+
# previous response in the next request to retrieve the next set of
|
3487
|
+
# results.
|
3488
|
+
#
|
3489
|
+
# @option params [Integer] :max_results
|
3490
|
+
# The maximum number of results to return per page.
|
3491
|
+
#
|
3492
|
+
# @return [Types::ListSecurityKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3493
|
+
#
|
3494
|
+
# * {Types::ListSecurityKeysResponse#security_keys #security_keys} => Array<Types::SecurityKey>
|
3495
|
+
# * {Types::ListSecurityKeysResponse#next_token #next_token} => String
|
3496
|
+
#
|
3497
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3498
|
+
#
|
3499
|
+
# @example Request syntax with placeholder values
|
3500
|
+
#
|
3501
|
+
# resp = client.list_security_keys({
|
3502
|
+
# instance_id: "InstanceId", # required
|
3503
|
+
# next_token: "NextToken",
|
3504
|
+
# max_results: 1,
|
3505
|
+
# })
|
3506
|
+
#
|
3507
|
+
# @example Response structure
|
3508
|
+
#
|
3509
|
+
# resp.security_keys #=> Array
|
3510
|
+
# resp.security_keys[0].association_id #=> String
|
3511
|
+
# resp.security_keys[0].key #=> String
|
3512
|
+
# resp.security_keys[0].creation_time #=> Time
|
3513
|
+
# resp.next_token #=> String
|
3514
|
+
#
|
3515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityKeys AWS API Documentation
|
3516
|
+
#
|
3517
|
+
# @overload list_security_keys(params = {})
|
3518
|
+
# @param [Hash] params ({})
|
3519
|
+
def list_security_keys(params = {}, options = {})
|
3520
|
+
req = build_request(:list_security_keys, params)
|
3521
|
+
req.send_request(options)
|
3522
|
+
end
|
3523
|
+
|
1839
3524
|
# Provides summary information about the security profiles for the
|
1840
3525
|
# specified Amazon Connect instance.
|
1841
3526
|
#
|
@@ -1855,7 +3540,7 @@ module Aws::Connect
|
|
1855
3540
|
# results.
|
1856
3541
|
#
|
1857
3542
|
# @option params [Integer] :max_results
|
1858
|
-
# The
|
3543
|
+
# The maximum number of results to return per page.
|
1859
3544
|
#
|
1860
3545
|
# @return [Types::ListSecurityProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1861
3546
|
#
|
@@ -1925,6 +3610,58 @@ module Aws::Connect
|
|
1925
3610
|
req.send_request(options)
|
1926
3611
|
end
|
1927
3612
|
|
3613
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3614
|
+
# change.
|
3615
|
+
#
|
3616
|
+
# Lists the use cases.
|
3617
|
+
#
|
3618
|
+
# @option params [required, String] :instance_id
|
3619
|
+
# The identifier of the Amazon Connect instance.
|
3620
|
+
#
|
3621
|
+
# @option params [required, String] :integration_association_id
|
3622
|
+
# The identifier for the integration association.
|
3623
|
+
#
|
3624
|
+
# @option params [String] :next_token
|
3625
|
+
# The token for the next set of results. Use the value returned in the
|
3626
|
+
# previous response in the next request to retrieve the next set of
|
3627
|
+
# results.
|
3628
|
+
#
|
3629
|
+
# @option params [Integer] :max_results
|
3630
|
+
# The maximum number of results to return per page.
|
3631
|
+
#
|
3632
|
+
# @return [Types::ListUseCasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3633
|
+
#
|
3634
|
+
# * {Types::ListUseCasesResponse#use_case_summary_list #use_case_summary_list} => Array<Types::UseCase>
|
3635
|
+
# * {Types::ListUseCasesResponse#next_token #next_token} => String
|
3636
|
+
#
|
3637
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3638
|
+
#
|
3639
|
+
# @example Request syntax with placeholder values
|
3640
|
+
#
|
3641
|
+
# resp = client.list_use_cases({
|
3642
|
+
# instance_id: "InstanceId", # required
|
3643
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
3644
|
+
# next_token: "NextToken",
|
3645
|
+
# max_results: 1,
|
3646
|
+
# })
|
3647
|
+
#
|
3648
|
+
# @example Response structure
|
3649
|
+
#
|
3650
|
+
# resp.use_case_summary_list #=> Array
|
3651
|
+
# resp.use_case_summary_list[0].use_case_id #=> String
|
3652
|
+
# resp.use_case_summary_list[0].use_case_arn #=> String
|
3653
|
+
# resp.use_case_summary_list[0].use_case_type #=> String, one of "RULES_EVALUATION"
|
3654
|
+
# resp.next_token #=> String
|
3655
|
+
#
|
3656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCases AWS API Documentation
|
3657
|
+
#
|
3658
|
+
# @overload list_use_cases(params = {})
|
3659
|
+
# @param [Hash] params ({})
|
3660
|
+
def list_use_cases(params = {}, options = {})
|
3661
|
+
req = build_request(:list_use_cases, params)
|
3662
|
+
req.send_request(options)
|
3663
|
+
end
|
3664
|
+
|
1928
3665
|
# Provides summary information about the hierarchy groups for the
|
1929
3666
|
# specified Amazon Connect instance.
|
1930
3667
|
#
|
@@ -1944,7 +3681,7 @@ module Aws::Connect
|
|
1944
3681
|
# results.
|
1945
3682
|
#
|
1946
3683
|
# @option params [Integer] :max_results
|
1947
|
-
# The
|
3684
|
+
# The maximum number of results to return per page.
|
1948
3685
|
#
|
1949
3686
|
# @return [Types::ListUserHierarchyGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1950
3687
|
#
|
@@ -1990,7 +3727,7 @@ module Aws::Connect
|
|
1990
3727
|
# results.
|
1991
3728
|
#
|
1992
3729
|
# @option params [Integer] :max_results
|
1993
|
-
# The
|
3730
|
+
# The maximum number of results to return per page.
|
1994
3731
|
#
|
1995
3732
|
# @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1996
3733
|
#
|
@@ -2063,7 +3800,7 @@ module Aws::Connect
|
|
2063
3800
|
# from the [CreateParticipantConnection][1] API in the Amazon Connect
|
2064
3801
|
# Participant Service.
|
2065
3802
|
#
|
2066
|
-
# When a new chat contact is successfully created, clients
|
3803
|
+
# When a new chat contact is successfully created, clients must
|
2067
3804
|
# subscribe to the participant’s connection for the created chat within
|
2068
3805
|
# 5 minutes. This is achieved by invoking
|
2069
3806
|
# [CreateParticipantConnection][1] with WEBSOCKET and
|
@@ -2077,8 +3814,8 @@ module Aws::Connect
|
|
2077
3814
|
# * The [quota for concurrent active chats][2] is exceeded. Active chat
|
2078
3815
|
# throttling returns a `LimitExceededException`.
|
2079
3816
|
#
|
2080
|
-
# For more information about
|
2081
|
-
#
|
3817
|
+
# For more information about chat, see [Chat][3] in the *Amazon Connect
|
3818
|
+
# Administrator Guide*.
|
2082
3819
|
#
|
2083
3820
|
#
|
2084
3821
|
#
|
@@ -2101,7 +3838,7 @@ module Aws::Connect
|
|
2101
3838
|
#
|
2102
3839
|
# @option params [Hash<String,String>] :attributes
|
2103
3840
|
# A custom key-value pair using an attribute map. The attributes are
|
2104
|
-
# standard Amazon Connect attributes
|
3841
|
+
# standard Amazon Connect attributes. They can be accessed in contact
|
2105
3842
|
# flows just like any other contact attributes.
|
2106
3843
|
#
|
2107
3844
|
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
@@ -2160,7 +3897,7 @@ module Aws::Connect
|
|
2160
3897
|
req.send_request(options)
|
2161
3898
|
end
|
2162
3899
|
|
2163
|
-
#
|
3900
|
+
# Starts recording the contact when the agent joins the call.
|
2164
3901
|
# StartContactRecording is a one-time action. For example, if you use
|
2165
3902
|
# StopContactRecording to stop recording an ongoing call, you can't use
|
2166
3903
|
# StartContactRecording to restart it. For scenarios where the recording
|
@@ -2188,7 +3925,7 @@ module Aws::Connect
|
|
2188
3925
|
# associated with the first interaction with the contact center.
|
2189
3926
|
#
|
2190
3927
|
# @option params [required, Types::VoiceRecordingConfiguration] :voice_recording_configuration
|
2191
|
-
#
|
3928
|
+
# The person being recorded.
|
2192
3929
|
#
|
2193
3930
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2194
3931
|
#
|
@@ -2212,16 +3949,16 @@ module Aws::Connect
|
|
2212
3949
|
req.send_request(options)
|
2213
3950
|
end
|
2214
3951
|
|
2215
|
-
#
|
2216
|
-
#
|
2217
|
-
#
|
3952
|
+
# Places an outbound call to a contact, and then initiates the contact
|
3953
|
+
# flow. It performs the actions in the contact flow that's specified
|
3954
|
+
# (in `ContactFlowId`).
|
2218
3955
|
#
|
2219
|
-
# Agents
|
2220
|
-
#
|
2221
|
-
# contact, and then puts the contact in queue,
|
2222
|
-
#
|
3956
|
+
# Agents do not initiate the outbound API, which means that they do not
|
3957
|
+
# dial the contact. If the contact flow places an outbound call to a
|
3958
|
+
# contact, and then puts the contact in queue, the call is then routed
|
3959
|
+
# to the agent, like any other inbound case.
|
2223
3960
|
#
|
2224
|
-
# There is a 60
|
3961
|
+
# There is a 60-second dialing timeout for this operation. If the call
|
2225
3962
|
# is not connected after 60 seconds, it fails.
|
2226
3963
|
#
|
2227
3964
|
# <note markdown="1"> UK numbers with a 447 prefix are not allowed by default. Before you
|
@@ -2302,12 +4039,95 @@ module Aws::Connect
|
|
2302
4039
|
#
|
2303
4040
|
# resp.contact_id #=> String
|
2304
4041
|
#
|
2305
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact AWS API Documentation
|
4042
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContact AWS API Documentation
|
4043
|
+
#
|
4044
|
+
# @overload start_outbound_voice_contact(params = {})
|
4045
|
+
# @param [Hash] params ({})
|
4046
|
+
def start_outbound_voice_contact(params = {}, options = {})
|
4047
|
+
req = build_request(:start_outbound_voice_contact, params)
|
4048
|
+
req.send_request(options)
|
4049
|
+
end
|
4050
|
+
|
4051
|
+
# Initiates a contact flow to start a new task.
|
4052
|
+
#
|
4053
|
+
# @option params [required, String] :instance_id
|
4054
|
+
# The identifier of the Amazon Connect instance.
|
4055
|
+
#
|
4056
|
+
# @option params [String] :previous_contact_id
|
4057
|
+
# The identifier of the previous chat, voice, or task contact.
|
4058
|
+
#
|
4059
|
+
# @option params [required, String] :contact_flow_id
|
4060
|
+
# The identifier of the contact flow for initiating the tasks. To see
|
4061
|
+
# the ContactFlowId in the Amazon Connect console user interface, on the
|
4062
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
4063
|
+
# contact flow. On the contact flow page, under the name of the contact
|
4064
|
+
# flow, choose **Show additional flow information**. The ContactFlowId
|
4065
|
+
# is the last part of the ARN, shown here in bold:
|
4066
|
+
#
|
4067
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
4068
|
+
#
|
4069
|
+
# @option params [Hash<String,String>] :attributes
|
4070
|
+
# A custom key-value pair using an attribute map. The attributes are
|
4071
|
+
# standard Amazon Connect attributes, and can be accessed in contact
|
4072
|
+
# flows just like any other contact attributes.
|
4073
|
+
#
|
4074
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
4075
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
4076
|
+
# underscore characters.
|
4077
|
+
#
|
4078
|
+
# @option params [required, String] :name
|
4079
|
+
# The name of a task that is shown to an agent in the Contact Control
|
4080
|
+
# Panel (CCP).
|
4081
|
+
#
|
4082
|
+
# @option params [Hash<String,Types::Reference>] :references
|
4083
|
+
# A formatted URL that is shown to an agent in the Contact Control Panel
|
4084
|
+
# (CCP).
|
4085
|
+
#
|
4086
|
+
# @option params [String] :description
|
4087
|
+
# A description of the task that is shown to an agent in the Contact
|
4088
|
+
# Control Panel (CCP).
|
4089
|
+
#
|
4090
|
+
# @option params [String] :client_token
|
4091
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
4092
|
+
# idempotency of the request.
|
4093
|
+
#
|
4094
|
+
# **A suitable default value is auto-generated.** You should normally
|
4095
|
+
# not need to pass this option.**
|
4096
|
+
#
|
4097
|
+
# @return [Types::StartTaskContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4098
|
+
#
|
4099
|
+
# * {Types::StartTaskContactResponse#contact_id #contact_id} => String
|
4100
|
+
#
|
4101
|
+
# @example Request syntax with placeholder values
|
4102
|
+
#
|
4103
|
+
# resp = client.start_task_contact({
|
4104
|
+
# instance_id: "InstanceId", # required
|
4105
|
+
# previous_contact_id: "ContactId",
|
4106
|
+
# contact_flow_id: "ContactFlowId", # required
|
4107
|
+
# attributes: {
|
4108
|
+
# "AttributeName" => "AttributeValue",
|
4109
|
+
# },
|
4110
|
+
# name: "Name", # required
|
4111
|
+
# references: {
|
4112
|
+
# "ReferenceKey" => {
|
4113
|
+
# value: "ReferenceValue", # required
|
4114
|
+
# type: "URL", # required, accepts URL
|
4115
|
+
# },
|
4116
|
+
# },
|
4117
|
+
# description: "Description",
|
4118
|
+
# client_token: "ClientToken",
|
4119
|
+
# })
|
4120
|
+
#
|
4121
|
+
# @example Response structure
|
4122
|
+
#
|
4123
|
+
# resp.contact_id #=> String
|
4124
|
+
#
|
4125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContact AWS API Documentation
|
2306
4126
|
#
|
2307
|
-
# @overload
|
4127
|
+
# @overload start_task_contact(params = {})
|
2308
4128
|
# @param [Hash] params ({})
|
2309
|
-
def
|
2310
|
-
req = build_request(:
|
4129
|
+
def start_task_contact(params = {}, options = {})
|
4130
|
+
req = build_request(:start_task_contact, params)
|
2311
4131
|
req.send_request(options)
|
2312
4132
|
end
|
2313
4133
|
|
@@ -2337,7 +4157,7 @@ module Aws::Connect
|
|
2337
4157
|
req.send_request(options)
|
2338
4158
|
end
|
2339
4159
|
|
2340
|
-
#
|
4160
|
+
# Stops recording a call when a contact is being recorded.
|
2341
4161
|
# StopContactRecording is a one-time action. If you use
|
2342
4162
|
# StopContactRecording to stop recording an ongoing call, you can't use
|
2343
4163
|
# StartContactRecording to restart it. For scenarios where the recording
|
@@ -2417,8 +4237,8 @@ module Aws::Connect
|
|
2417
4237
|
|
2418
4238
|
# Adds the specified tags to the specified resource.
|
2419
4239
|
#
|
2420
|
-
# The supported resource types are users, routing profiles,
|
2421
|
-
# flows.
|
4240
|
+
# The supported resource types are users, routing profiles, queues,
|
4241
|
+
# quick connects, and contact flows.
|
2422
4242
|
#
|
2423
4243
|
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
2424
4244
|
# Policy Examples][1] in the *Amazon Connect Administrator Guide*.
|
@@ -2484,32 +4304,26 @@ module Aws::Connect
|
|
2484
4304
|
# specified contact.
|
2485
4305
|
#
|
2486
4306
|
# You can add or update attributes for both ongoing and completed
|
2487
|
-
# contacts. For example,
|
2488
|
-
#
|
2489
|
-
# about steps that the agent took during the call that
|
2490
|
-
#
|
2491
|
-
#
|
4307
|
+
# contacts. For example, while the call is active, you can update the
|
4308
|
+
# customer's name or the reason the customer called. You can add notes
|
4309
|
+
# about steps that the agent took during the call that display to the
|
4310
|
+
# next agent that takes the call. You can also update attributes for a
|
4311
|
+
# contact using data from your CRM application and save the data with
|
2492
4312
|
# the contact in Amazon Connect. You could also flag calls for
|
2493
|
-
# additional analysis, such as legal review or
|
4313
|
+
# additional analysis, such as legal review or to identify abusive
|
2494
4314
|
# callers.
|
2495
4315
|
#
|
2496
4316
|
# Contact attributes are available in Amazon Connect for 24 months, and
|
2497
4317
|
# are then deleted.
|
2498
4318
|
#
|
2499
|
-
# This operation is also available in the Amazon Connect Flow language.
|
2500
|
-
# See [UpdateContactAttributes][1].
|
2501
|
-
#
|
2502
4319
|
# **Important:** You cannot use the operation to update attributes for
|
2503
|
-
# contacts that occurred prior to the release of the API,
|
2504
|
-
# 2018. You can update attributes only for contacts that
|
2505
|
-
# the release of the API. If you attempt to update
|
2506
|
-
# contact that occurred prior to the release of the
|
2507
|
-
# returned. This applies also to queued callbacks
|
2508
|
-
# prior to the release of the API but are still
|
2509
|
-
#
|
2510
|
-
#
|
2511
|
-
#
|
2512
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-actions-updatecontactattributes.html
|
4320
|
+
# contacts that occurred prior to the release of the API, which was
|
4321
|
+
# September 12, 2018. You can update attributes only for contacts that
|
4322
|
+
# started after the release of the API. If you attempt to update
|
4323
|
+
# attributes for a contact that occurred prior to the release of the
|
4324
|
+
# API, a 400 error is returned. This applies also to queued callbacks
|
4325
|
+
# that were initiated prior to the release of the API but are still
|
4326
|
+
# active in your instance.
|
2513
4327
|
#
|
2514
4328
|
# @option params [required, String] :initial_contact_id
|
2515
4329
|
# The identifier of the contact. This is the identifier of the contact
|
@@ -2592,6 +4406,13 @@ module Aws::Connect
|
|
2592
4406
|
|
2593
4407
|
# The name of the contact flow.
|
2594
4408
|
#
|
4409
|
+
# You can also create and update contact flows using the [Amazon Connect
|
4410
|
+
# Flow language][1].
|
4411
|
+
#
|
4412
|
+
#
|
4413
|
+
#
|
4414
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
4415
|
+
#
|
2595
4416
|
# @option params [required, String] :instance_id
|
2596
4417
|
# The identifier of the Amazon Connect instance.
|
2597
4418
|
#
|
@@ -2624,6 +4445,365 @@ module Aws::Connect
|
|
2624
4445
|
req.send_request(options)
|
2625
4446
|
end
|
2626
4447
|
|
4448
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4449
|
+
# change.
|
4450
|
+
#
|
4451
|
+
# Updates the value for the specified attribute type.
|
4452
|
+
#
|
4453
|
+
# @option params [required, String] :instance_id
|
4454
|
+
# The identifier of the Amazon Connect instance.
|
4455
|
+
#
|
4456
|
+
# @option params [required, String] :attribute_type
|
4457
|
+
# The type of attribute.
|
4458
|
+
#
|
4459
|
+
# @option params [required, String] :value
|
4460
|
+
# The value for the attribute. Maximum character limit is 100.
|
4461
|
+
#
|
4462
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4463
|
+
#
|
4464
|
+
# @example Request syntax with placeholder values
|
4465
|
+
#
|
4466
|
+
# resp = client.update_instance_attribute({
|
4467
|
+
# instance_id: "InstanceId", # required
|
4468
|
+
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA
|
4469
|
+
# value: "InstanceAttributeValue", # required
|
4470
|
+
# })
|
4471
|
+
#
|
4472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateInstanceAttribute AWS API Documentation
|
4473
|
+
#
|
4474
|
+
# @overload update_instance_attribute(params = {})
|
4475
|
+
# @param [Hash] params ({})
|
4476
|
+
def update_instance_attribute(params = {}, options = {})
|
4477
|
+
req = build_request(:update_instance_attribute, params)
|
4478
|
+
req.send_request(options)
|
4479
|
+
end
|
4480
|
+
|
4481
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4482
|
+
# change.
|
4483
|
+
#
|
4484
|
+
# Updates an existing configuration for a resource type. This API is
|
4485
|
+
# idempotent.
|
4486
|
+
#
|
4487
|
+
# @option params [required, String] :instance_id
|
4488
|
+
# The identifier of the Amazon Connect instance.
|
4489
|
+
#
|
4490
|
+
# @option params [required, String] :association_id
|
4491
|
+
# The existing association identifier that uniquely identifies the
|
4492
|
+
# resource type and storage config for the given instance ID.
|
4493
|
+
#
|
4494
|
+
# @option params [required, String] :resource_type
|
4495
|
+
# A valid resource type.
|
4496
|
+
#
|
4497
|
+
# @option params [required, Types::InstanceStorageConfig] :storage_config
|
4498
|
+
# The storage configuration for the instance.
|
4499
|
+
#
|
4500
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4501
|
+
#
|
4502
|
+
# @example Request syntax with placeholder values
|
4503
|
+
#
|
4504
|
+
# resp = client.update_instance_storage_config({
|
4505
|
+
# instance_id: "InstanceId", # required
|
4506
|
+
# association_id: "AssociationId", # required
|
4507
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
4508
|
+
# storage_config: { # required
|
4509
|
+
# association_id: "AssociationId",
|
4510
|
+
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
4511
|
+
# s3_config: {
|
4512
|
+
# bucket_name: "BucketName", # required
|
4513
|
+
# bucket_prefix: "Prefix", # required
|
4514
|
+
# encryption_config: {
|
4515
|
+
# encryption_type: "KMS", # required, accepts KMS
|
4516
|
+
# key_id: "KeyId", # required
|
4517
|
+
# },
|
4518
|
+
# },
|
4519
|
+
# kinesis_video_stream_config: {
|
4520
|
+
# prefix: "Prefix", # required
|
4521
|
+
# retention_period_hours: 1, # required
|
4522
|
+
# encryption_config: { # required
|
4523
|
+
# encryption_type: "KMS", # required, accepts KMS
|
4524
|
+
# key_id: "KeyId", # required
|
4525
|
+
# },
|
4526
|
+
# },
|
4527
|
+
# kinesis_stream_config: {
|
4528
|
+
# stream_arn: "ARN", # required
|
4529
|
+
# },
|
4530
|
+
# kinesis_firehose_config: {
|
4531
|
+
# firehose_arn: "ARN", # required
|
4532
|
+
# },
|
4533
|
+
# },
|
4534
|
+
# })
|
4535
|
+
#
|
4536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateInstanceStorageConfig AWS API Documentation
|
4537
|
+
#
|
4538
|
+
# @overload update_instance_storage_config(params = {})
|
4539
|
+
# @param [Hash] params ({})
|
4540
|
+
def update_instance_storage_config(params = {}, options = {})
|
4541
|
+
req = build_request(:update_instance_storage_config, params)
|
4542
|
+
req.send_request(options)
|
4543
|
+
end
|
4544
|
+
|
4545
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4546
|
+
# change.
|
4547
|
+
#
|
4548
|
+
# Updates the hours of operation for the specified queue.
|
4549
|
+
#
|
4550
|
+
# @option params [required, String] :instance_id
|
4551
|
+
# The identifier of the Amazon Connect instance.
|
4552
|
+
#
|
4553
|
+
# @option params [required, String] :queue_id
|
4554
|
+
# The identifier for the queue.
|
4555
|
+
#
|
4556
|
+
# @option params [required, String] :hours_of_operation_id
|
4557
|
+
# The identifier for the hours of operation.
|
4558
|
+
#
|
4559
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4560
|
+
#
|
4561
|
+
# @example Request syntax with placeholder values
|
4562
|
+
#
|
4563
|
+
# resp = client.update_queue_hours_of_operation({
|
4564
|
+
# instance_id: "InstanceId", # required
|
4565
|
+
# queue_id: "QueueId", # required
|
4566
|
+
# hours_of_operation_id: "HoursOfOperationId", # required
|
4567
|
+
# })
|
4568
|
+
#
|
4569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueHoursOfOperation AWS API Documentation
|
4570
|
+
#
|
4571
|
+
# @overload update_queue_hours_of_operation(params = {})
|
4572
|
+
# @param [Hash] params ({})
|
4573
|
+
def update_queue_hours_of_operation(params = {}, options = {})
|
4574
|
+
req = build_request(:update_queue_hours_of_operation, params)
|
4575
|
+
req.send_request(options)
|
4576
|
+
end
|
4577
|
+
|
4578
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4579
|
+
# change.
|
4580
|
+
#
|
4581
|
+
# Updates the maximum number of contacts allowed in a queue before it is
|
4582
|
+
# considered full.
|
4583
|
+
#
|
4584
|
+
# @option params [required, String] :instance_id
|
4585
|
+
# The identifier of the Amazon Connect instance.
|
4586
|
+
#
|
4587
|
+
# @option params [required, String] :queue_id
|
4588
|
+
# The identifier for the queue.
|
4589
|
+
#
|
4590
|
+
# @option params [required, Integer] :max_contacts
|
4591
|
+
# The maximum number of contacts that can be in the queue before it is
|
4592
|
+
# considered full.
|
4593
|
+
#
|
4594
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4595
|
+
#
|
4596
|
+
# @example Request syntax with placeholder values
|
4597
|
+
#
|
4598
|
+
# resp = client.update_queue_max_contacts({
|
4599
|
+
# instance_id: "InstanceId", # required
|
4600
|
+
# queue_id: "QueueId", # required
|
4601
|
+
# max_contacts: 1, # required
|
4602
|
+
# })
|
4603
|
+
#
|
4604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueMaxContacts AWS API Documentation
|
4605
|
+
#
|
4606
|
+
# @overload update_queue_max_contacts(params = {})
|
4607
|
+
# @param [Hash] params ({})
|
4608
|
+
def update_queue_max_contacts(params = {}, options = {})
|
4609
|
+
req = build_request(:update_queue_max_contacts, params)
|
4610
|
+
req.send_request(options)
|
4611
|
+
end
|
4612
|
+
|
4613
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4614
|
+
# change.
|
4615
|
+
#
|
4616
|
+
# Updates the name and description of a queue. At least `Name` or
|
4617
|
+
# `Description` must be provided.
|
4618
|
+
#
|
4619
|
+
# @option params [required, String] :instance_id
|
4620
|
+
# The identifier of the Amazon Connect instance.
|
4621
|
+
#
|
4622
|
+
# @option params [required, String] :queue_id
|
4623
|
+
# The identifier for the queue.
|
4624
|
+
#
|
4625
|
+
# @option params [String] :name
|
4626
|
+
# The name of the queue.
|
4627
|
+
#
|
4628
|
+
# @option params [String] :description
|
4629
|
+
# The description of the queue.
|
4630
|
+
#
|
4631
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4632
|
+
#
|
4633
|
+
# @example Request syntax with placeholder values
|
4634
|
+
#
|
4635
|
+
# resp = client.update_queue_name({
|
4636
|
+
# instance_id: "InstanceId", # required
|
4637
|
+
# queue_id: "QueueId", # required
|
4638
|
+
# name: "CommonNameLength127",
|
4639
|
+
# description: "QueueDescription",
|
4640
|
+
# })
|
4641
|
+
#
|
4642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueName AWS API Documentation
|
4643
|
+
#
|
4644
|
+
# @overload update_queue_name(params = {})
|
4645
|
+
# @param [Hash] params ({})
|
4646
|
+
def update_queue_name(params = {}, options = {})
|
4647
|
+
req = build_request(:update_queue_name, params)
|
4648
|
+
req.send_request(options)
|
4649
|
+
end
|
4650
|
+
|
4651
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4652
|
+
# change.
|
4653
|
+
#
|
4654
|
+
# Updates the outbound caller ID name, number, and outbound whisper flow
|
4655
|
+
# for a specified queue.
|
4656
|
+
#
|
4657
|
+
# @option params [required, String] :instance_id
|
4658
|
+
# The identifier of the Amazon Connect instance.
|
4659
|
+
#
|
4660
|
+
# @option params [required, String] :queue_id
|
4661
|
+
# The identifier for the queue.
|
4662
|
+
#
|
4663
|
+
# @option params [required, Types::OutboundCallerConfig] :outbound_caller_config
|
4664
|
+
# The outbound caller ID name, number, and outbound whisper flow.
|
4665
|
+
#
|
4666
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4667
|
+
#
|
4668
|
+
# @example Request syntax with placeholder values
|
4669
|
+
#
|
4670
|
+
# resp = client.update_queue_outbound_caller_config({
|
4671
|
+
# instance_id: "InstanceId", # required
|
4672
|
+
# queue_id: "QueueId", # required
|
4673
|
+
# outbound_caller_config: { # required
|
4674
|
+
# outbound_caller_id_name: "OutboundCallerIdName",
|
4675
|
+
# outbound_caller_id_number_id: "PhoneNumberId",
|
4676
|
+
# outbound_flow_id: "ContactFlowId",
|
4677
|
+
# },
|
4678
|
+
# })
|
4679
|
+
#
|
4680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueOutboundCallerConfig AWS API Documentation
|
4681
|
+
#
|
4682
|
+
# @overload update_queue_outbound_caller_config(params = {})
|
4683
|
+
# @param [Hash] params ({})
|
4684
|
+
def update_queue_outbound_caller_config(params = {}, options = {})
|
4685
|
+
req = build_request(:update_queue_outbound_caller_config, params)
|
4686
|
+
req.send_request(options)
|
4687
|
+
end
|
4688
|
+
|
4689
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4690
|
+
# change.
|
4691
|
+
#
|
4692
|
+
# Updates the status of the queue.
|
4693
|
+
#
|
4694
|
+
# @option params [required, String] :instance_id
|
4695
|
+
# The identifier of the Amazon Connect instance.
|
4696
|
+
#
|
4697
|
+
# @option params [required, String] :queue_id
|
4698
|
+
# The identifier for the queue.
|
4699
|
+
#
|
4700
|
+
# @option params [required, String] :status
|
4701
|
+
# The status of the queue.
|
4702
|
+
#
|
4703
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4704
|
+
#
|
4705
|
+
# @example Request syntax with placeholder values
|
4706
|
+
#
|
4707
|
+
# resp = client.update_queue_status({
|
4708
|
+
# instance_id: "InstanceId", # required
|
4709
|
+
# queue_id: "QueueId", # required
|
4710
|
+
# status: "ENABLED", # required, accepts ENABLED, DISABLED
|
4711
|
+
# })
|
4712
|
+
#
|
4713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQueueStatus AWS API Documentation
|
4714
|
+
#
|
4715
|
+
# @overload update_queue_status(params = {})
|
4716
|
+
# @param [Hash] params ({})
|
4717
|
+
def update_queue_status(params = {}, options = {})
|
4718
|
+
req = build_request(:update_queue_status, params)
|
4719
|
+
req.send_request(options)
|
4720
|
+
end
|
4721
|
+
|
4722
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4723
|
+
# change.
|
4724
|
+
#
|
4725
|
+
# Updates the configuration settings for the specified quick connect.
|
4726
|
+
#
|
4727
|
+
# @option params [required, String] :instance_id
|
4728
|
+
# The identifier of the Amazon Connect instance.
|
4729
|
+
#
|
4730
|
+
# @option params [required, String] :quick_connect_id
|
4731
|
+
# The identifier for the quick connect.
|
4732
|
+
#
|
4733
|
+
# @option params [required, Types::QuickConnectConfig] :quick_connect_config
|
4734
|
+
# Information about the configuration settings for the quick connect.
|
4735
|
+
#
|
4736
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4737
|
+
#
|
4738
|
+
# @example Request syntax with placeholder values
|
4739
|
+
#
|
4740
|
+
# resp = client.update_quick_connect_config({
|
4741
|
+
# instance_id: "InstanceId", # required
|
4742
|
+
# quick_connect_id: "QuickConnectId", # required
|
4743
|
+
# quick_connect_config: { # required
|
4744
|
+
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
4745
|
+
# user_config: {
|
4746
|
+
# user_id: "UserId", # required
|
4747
|
+
# contact_flow_id: "ContactFlowId", # required
|
4748
|
+
# },
|
4749
|
+
# queue_config: {
|
4750
|
+
# queue_id: "QueueId", # required
|
4751
|
+
# contact_flow_id: "ContactFlowId", # required
|
4752
|
+
# },
|
4753
|
+
# phone_config: {
|
4754
|
+
# phone_number: "PhoneNumber", # required
|
4755
|
+
# },
|
4756
|
+
# },
|
4757
|
+
# })
|
4758
|
+
#
|
4759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQuickConnectConfig AWS API Documentation
|
4760
|
+
#
|
4761
|
+
# @overload update_quick_connect_config(params = {})
|
4762
|
+
# @param [Hash] params ({})
|
4763
|
+
def update_quick_connect_config(params = {}, options = {})
|
4764
|
+
req = build_request(:update_quick_connect_config, params)
|
4765
|
+
req.send_request(options)
|
4766
|
+
end
|
4767
|
+
|
4768
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4769
|
+
# change.
|
4770
|
+
#
|
4771
|
+
# Updates the name and description of a quick connect. The request
|
4772
|
+
# accepts the following data in JSON format. At least `Name` or
|
4773
|
+
# `Description` must be provided.
|
4774
|
+
#
|
4775
|
+
# @option params [required, String] :instance_id
|
4776
|
+
# The identifier of the Amazon Connect instance.
|
4777
|
+
#
|
4778
|
+
# @option params [required, String] :quick_connect_id
|
4779
|
+
# The identifier for the quick connect.
|
4780
|
+
#
|
4781
|
+
# @option params [String] :name
|
4782
|
+
# The name of the quick connect.
|
4783
|
+
#
|
4784
|
+
# @option params [String] :description
|
4785
|
+
# The description of the quick connect.
|
4786
|
+
#
|
4787
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4788
|
+
#
|
4789
|
+
# @example Request syntax with placeholder values
|
4790
|
+
#
|
4791
|
+
# resp = client.update_quick_connect_name({
|
4792
|
+
# instance_id: "InstanceId", # required
|
4793
|
+
# quick_connect_id: "QuickConnectId", # required
|
4794
|
+
# name: "QuickConnectName",
|
4795
|
+
# description: "QuickConnectDescription",
|
4796
|
+
# })
|
4797
|
+
#
|
4798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateQuickConnectName AWS API Documentation
|
4799
|
+
#
|
4800
|
+
# @overload update_quick_connect_name(params = {})
|
4801
|
+
# @param [Hash] params ({})
|
4802
|
+
def update_quick_connect_name(params = {}, options = {})
|
4803
|
+
req = build_request(:update_quick_connect_name, params)
|
4804
|
+
req.send_request(options)
|
4805
|
+
end
|
4806
|
+
|
2627
4807
|
# Updates the channels that agents can handle in the Contact Control
|
2628
4808
|
# Panel (CCP) for a routing profile.
|
2629
4809
|
#
|
@@ -2634,7 +4814,8 @@ module Aws::Connect
|
|
2634
4814
|
# The identifier of the routing profile.
|
2635
4815
|
#
|
2636
4816
|
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
2637
|
-
# The channels agents can handle in the Contact Control Panel
|
4817
|
+
# The channels that agents can handle in the Contact Control Panel
|
4818
|
+
# (CCP).
|
2638
4819
|
#
|
2639
4820
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2640
4821
|
#
|
@@ -2645,7 +4826,7 @@ module Aws::Connect
|
|
2645
4826
|
# routing_profile_id: "RoutingProfileId", # required
|
2646
4827
|
# media_concurrencies: [ # required
|
2647
4828
|
# {
|
2648
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
4829
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
2649
4830
|
# concurrency: 1, # required
|
2650
4831
|
# },
|
2651
4832
|
# ],
|
@@ -2737,7 +4918,9 @@ module Aws::Connect
|
|
2737
4918
|
# The identifier of the routing profile.
|
2738
4919
|
#
|
2739
4920
|
# @option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
2740
|
-
# The queues to be updated for this routing profile.
|
4921
|
+
# The queues to be updated for this routing profile. Queues must first
|
4922
|
+
# be associated to the routing profile. You can do this using
|
4923
|
+
# AssociateRoutingProfileQueues.
|
2741
4924
|
#
|
2742
4925
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2743
4926
|
#
|
@@ -2750,7 +4933,7 @@ module Aws::Connect
|
|
2750
4933
|
# {
|
2751
4934
|
# queue_reference: { # required
|
2752
4935
|
# queue_id: "QueueId", # required
|
2753
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
4936
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
2754
4937
|
# },
|
2755
4938
|
# priority: 1, # required
|
2756
4939
|
# delay: 1, # required
|
@@ -2797,16 +4980,88 @@ module Aws::Connect
|
|
2797
4980
|
req.send_request(options)
|
2798
4981
|
end
|
2799
4982
|
|
4983
|
+
# Updates the name of the user hierarchy group.
|
4984
|
+
#
|
4985
|
+
# @option params [required, String] :name
|
4986
|
+
# The name of the hierarchy group. Must not be more than 100 characters.
|
4987
|
+
#
|
4988
|
+
# @option params [required, String] :hierarchy_group_id
|
4989
|
+
# The identifier of the hierarchy group.
|
4990
|
+
#
|
4991
|
+
# @option params [required, String] :instance_id
|
4992
|
+
# The identifier of the Amazon Connect instance.
|
4993
|
+
#
|
4994
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4995
|
+
#
|
4996
|
+
# @example Request syntax with placeholder values
|
4997
|
+
#
|
4998
|
+
# resp = client.update_user_hierarchy_group_name({
|
4999
|
+
# name: "HierarchyGroupName", # required
|
5000
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
5001
|
+
# instance_id: "InstanceId", # required
|
5002
|
+
# })
|
5003
|
+
#
|
5004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyGroupName AWS API Documentation
|
5005
|
+
#
|
5006
|
+
# @overload update_user_hierarchy_group_name(params = {})
|
5007
|
+
# @param [Hash] params ({})
|
5008
|
+
def update_user_hierarchy_group_name(params = {}, options = {})
|
5009
|
+
req = build_request(:update_user_hierarchy_group_name, params)
|
5010
|
+
req.send_request(options)
|
5011
|
+
end
|
5012
|
+
|
5013
|
+
# Updates the user hierarchy structure: add, remove, and rename user
|
5014
|
+
# hierarchy levels.
|
5015
|
+
#
|
5016
|
+
# @option params [required, Types::HierarchyStructureUpdate] :hierarchy_structure
|
5017
|
+
# The hierarchy levels to update.
|
5018
|
+
#
|
5019
|
+
# @option params [required, String] :instance_id
|
5020
|
+
# The identifier of the Amazon Connect instance.
|
5021
|
+
#
|
5022
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5023
|
+
#
|
5024
|
+
# @example Request syntax with placeholder values
|
5025
|
+
#
|
5026
|
+
# resp = client.update_user_hierarchy_structure({
|
5027
|
+
# hierarchy_structure: { # required
|
5028
|
+
# level_one: {
|
5029
|
+
# name: "HierarchyLevelName", # required
|
5030
|
+
# },
|
5031
|
+
# level_two: {
|
5032
|
+
# name: "HierarchyLevelName", # required
|
5033
|
+
# },
|
5034
|
+
# level_three: {
|
5035
|
+
# name: "HierarchyLevelName", # required
|
5036
|
+
# },
|
5037
|
+
# level_four: {
|
5038
|
+
# name: "HierarchyLevelName", # required
|
5039
|
+
# },
|
5040
|
+
# level_five: {
|
5041
|
+
# name: "HierarchyLevelName", # required
|
5042
|
+
# },
|
5043
|
+
# },
|
5044
|
+
# instance_id: "InstanceId", # required
|
5045
|
+
# })
|
5046
|
+
#
|
5047
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyStructure AWS API Documentation
|
5048
|
+
#
|
5049
|
+
# @overload update_user_hierarchy_structure(params = {})
|
5050
|
+
# @param [Hash] params ({})
|
5051
|
+
def update_user_hierarchy_structure(params = {}, options = {})
|
5052
|
+
req = build_request(:update_user_hierarchy_structure, params)
|
5053
|
+
req.send_request(options)
|
5054
|
+
end
|
5055
|
+
|
2800
5056
|
# Updates the identity information for the specified user.
|
2801
5057
|
#
|
2802
|
-
#
|
2803
|
-
#
|
2804
|
-
#
|
2805
|
-
#
|
2806
|
-
#
|
2807
|
-
#
|
2808
|
-
#
|
2809
|
-
# *Amazon Connect Administrator Guide*.
|
5058
|
+
# We strongly recommend limiting who has the ability to invoke
|
5059
|
+
# `UpdateUserIdentityInfo`. Someone with that ability can change the
|
5060
|
+
# login credentials of other users by changing their email address. This
|
5061
|
+
# poses a security risk to your organization. They can change the email
|
5062
|
+
# address of a user to the attacker's email address, and then reset the
|
5063
|
+
# password through email. For more information, see [Best Practices for
|
5064
|
+
# Security Profiles][1] in the *Amazon Connect Administrator Guide*.
|
2810
5065
|
#
|
2811
5066
|
#
|
2812
5067
|
#
|
@@ -2952,7 +5207,7 @@ module Aws::Connect
|
|
2952
5207
|
params: params,
|
2953
5208
|
config: config)
|
2954
5209
|
context[:gem_name] = 'aws-sdk-connect'
|
2955
|
-
context[:gem_version] = '1.
|
5210
|
+
context[:gem_version] = '1.39.0'
|
2956
5211
|
Seahorse::Client::Request.new(handlers, context)
|
2957
5212
|
end
|
2958
5213
|
|