aws-sdk-connect 1.31.0 → 1.36.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 +2089 -185
- data/lib/aws-sdk-connect/client_api.rb +1204 -0
- data/lib/aws-sdk-connect/errors.rb +90 -0
- data/lib/aws-sdk-connect/types.rb +4163 -1465
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4f3571397e5474ff0008968a6ee4aa91ecf96c9f1e1786dcc364c42343e210ad
|
4
|
+
data.tar.gz: 6626de4b09b940cfa0a7d7fdbc47687136e1b7e7fa8cb80528adee9a8dcdf2b9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 54851af1738088322dbb0037f95c51f94378bdf5a402807060ec364e770f1f77fbbf0bebf6978e1d0e7575e42766f896c0aab3f49d678a060ddecf546b90eee6
|
7
|
+
data.tar.gz: 4059e50f5cf92862bd8d0a334b7cd30c962c0110192ac44624c0c84973bfc1b47e6b771d0aad6af1538ebafafe2bf0d1a2d7be7754f58afcc47083ba66096051
|
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.36.0'
|
52
52
|
|
53
53
|
end
|
@@ -327,121 +327,855 @@ module Aws::Connect
|
|
327
327
|
|
328
328
|
# @!group API Operations
|
329
329
|
|
330
|
+
# Associates an approved origin to an Amazon Connect instance.
|
331
|
+
#
|
332
|
+
# @option params [required, String] :instance_id
|
333
|
+
# The identifier of the Amazon Connect instance.
|
334
|
+
#
|
335
|
+
# @option params [required, String] :origin
|
336
|
+
# The domain to add to your allow list.
|
337
|
+
#
|
338
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
339
|
+
#
|
340
|
+
# @example Request syntax with placeholder values
|
341
|
+
#
|
342
|
+
# resp = client.associate_approved_origin({
|
343
|
+
# instance_id: "InstanceId", # required
|
344
|
+
# origin: "Origin", # required
|
345
|
+
# })
|
346
|
+
#
|
347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateApprovedOrigin AWS API Documentation
|
348
|
+
#
|
349
|
+
# @overload associate_approved_origin(params = {})
|
350
|
+
# @param [Hash] params ({})
|
351
|
+
def associate_approved_origin(params = {}, options = {})
|
352
|
+
req = build_request(:associate_approved_origin, params)
|
353
|
+
req.send_request(options)
|
354
|
+
end
|
355
|
+
|
356
|
+
# Associates a storage resource type for the first time. You can only
|
357
|
+
# associate one type of storage configuration in a single call. This
|
358
|
+
# means, for example, that you can't define an instance with multiple
|
359
|
+
# S3 buckets for storing chat transcripts.
|
360
|
+
#
|
361
|
+
# This API does not create a resource that doesn't exist. It only
|
362
|
+
# associates it to the instance. Ensure that the resource being
|
363
|
+
# specified in the storage configuration, like an Amazon S3 bucket,
|
364
|
+
# exists when being used for association.
|
365
|
+
#
|
366
|
+
# @option params [required, String] :instance_id
|
367
|
+
# The identifier of the Amazon Connect instance.
|
368
|
+
#
|
369
|
+
# @option params [required, String] :resource_type
|
370
|
+
# A valid resource type.
|
371
|
+
#
|
372
|
+
# @option params [required, Types::InstanceStorageConfig] :storage_config
|
373
|
+
# A valid storage type.
|
374
|
+
#
|
375
|
+
# @return [Types::AssociateInstanceStorageConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
376
|
+
#
|
377
|
+
# * {Types::AssociateInstanceStorageConfigResponse#association_id #association_id} => String
|
378
|
+
#
|
379
|
+
# @example Request syntax with placeholder values
|
380
|
+
#
|
381
|
+
# resp = client.associate_instance_storage_config({
|
382
|
+
# instance_id: "InstanceId", # required
|
383
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
384
|
+
# storage_config: { # required
|
385
|
+
# association_id: "AssociationId",
|
386
|
+
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
387
|
+
# s3_config: {
|
388
|
+
# bucket_name: "BucketName", # required
|
389
|
+
# bucket_prefix: "Prefix", # required
|
390
|
+
# encryption_config: {
|
391
|
+
# encryption_type: "KMS", # required, accepts KMS
|
392
|
+
# key_id: "KeyId", # required
|
393
|
+
# },
|
394
|
+
# },
|
395
|
+
# kinesis_video_stream_config: {
|
396
|
+
# prefix: "Prefix", # required
|
397
|
+
# retention_period_hours: 1, # required
|
398
|
+
# encryption_config: { # required
|
399
|
+
# encryption_type: "KMS", # required, accepts KMS
|
400
|
+
# key_id: "KeyId", # required
|
401
|
+
# },
|
402
|
+
# },
|
403
|
+
# kinesis_stream_config: {
|
404
|
+
# stream_arn: "ARN", # required
|
405
|
+
# },
|
406
|
+
# kinesis_firehose_config: {
|
407
|
+
# firehose_arn: "ARN", # required
|
408
|
+
# },
|
409
|
+
# },
|
410
|
+
# })
|
411
|
+
#
|
412
|
+
# @example Response structure
|
413
|
+
#
|
414
|
+
# resp.association_id #=> String
|
415
|
+
#
|
416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateInstanceStorageConfig AWS API Documentation
|
417
|
+
#
|
418
|
+
# @overload associate_instance_storage_config(params = {})
|
419
|
+
# @param [Hash] params ({})
|
420
|
+
def associate_instance_storage_config(params = {}, options = {})
|
421
|
+
req = build_request(:associate_instance_storage_config, params)
|
422
|
+
req.send_request(options)
|
423
|
+
end
|
424
|
+
|
425
|
+
# Allows the specified Amazon Connect instance to access the specified
|
426
|
+
# Lambda function.
|
427
|
+
#
|
428
|
+
# @option params [required, String] :instance_id
|
429
|
+
# The identifier of the Amazon Connect instance.
|
430
|
+
#
|
431
|
+
# @option params [required, String] :function_arn
|
432
|
+
# The Amazon Resource Name (ARN) for the Lambda function being
|
433
|
+
# associated. Maximum number of characters allowed is 140.
|
434
|
+
#
|
435
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
436
|
+
#
|
437
|
+
# @example Request syntax with placeholder values
|
438
|
+
#
|
439
|
+
# resp = client.associate_lambda_function({
|
440
|
+
# instance_id: "InstanceId", # required
|
441
|
+
# function_arn: "FunctionArn", # required
|
442
|
+
# })
|
443
|
+
#
|
444
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateLambdaFunction AWS API Documentation
|
445
|
+
#
|
446
|
+
# @overload associate_lambda_function(params = {})
|
447
|
+
# @param [Hash] params ({})
|
448
|
+
def associate_lambda_function(params = {}, options = {})
|
449
|
+
req = build_request(:associate_lambda_function, params)
|
450
|
+
req.send_request(options)
|
451
|
+
end
|
452
|
+
|
453
|
+
# Allows the specified Amazon Connect instance to access the specified
|
454
|
+
# Amazon Lex bot.
|
455
|
+
#
|
456
|
+
# @option params [required, String] :instance_id
|
457
|
+
# The identifier of the Amazon Connect instance.
|
458
|
+
#
|
459
|
+
# @option params [required, Types::LexBot] :lex_bot
|
460
|
+
# The Amazon Lex box to associate with the instance.
|
461
|
+
#
|
462
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
463
|
+
#
|
464
|
+
# @example Request syntax with placeholder values
|
465
|
+
#
|
466
|
+
# resp = client.associate_lex_bot({
|
467
|
+
# instance_id: "InstanceId", # required
|
468
|
+
# lex_bot: { # required
|
469
|
+
# name: "BotName",
|
470
|
+
# lex_region: "LexRegion",
|
471
|
+
# },
|
472
|
+
# })
|
473
|
+
#
|
474
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateLexBot AWS API Documentation
|
475
|
+
#
|
476
|
+
# @overload associate_lex_bot(params = {})
|
477
|
+
# @param [Hash] params ({})
|
478
|
+
def associate_lex_bot(params = {}, options = {})
|
479
|
+
req = build_request(:associate_lex_bot, params)
|
480
|
+
req.send_request(options)
|
481
|
+
end
|
482
|
+
|
483
|
+
# Associates a set of queues with a routing profile.
|
484
|
+
#
|
485
|
+
# @option params [required, String] :instance_id
|
486
|
+
# The identifier of the Amazon Connect instance.
|
487
|
+
#
|
488
|
+
# @option params [required, String] :routing_profile_id
|
489
|
+
# The identifier of the routing profile.
|
490
|
+
#
|
491
|
+
# @option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
492
|
+
# The queues to associate with this routing profile.
|
493
|
+
#
|
494
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
495
|
+
#
|
496
|
+
# @example Request syntax with placeholder values
|
497
|
+
#
|
498
|
+
# resp = client.associate_routing_profile_queues({
|
499
|
+
# instance_id: "InstanceId", # required
|
500
|
+
# routing_profile_id: "RoutingProfileId", # required
|
501
|
+
# queue_configs: [ # required
|
502
|
+
# {
|
503
|
+
# queue_reference: { # required
|
504
|
+
# queue_id: "QueueId", # required
|
505
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
506
|
+
# },
|
507
|
+
# priority: 1, # required
|
508
|
+
# delay: 1, # required
|
509
|
+
# },
|
510
|
+
# ],
|
511
|
+
# })
|
512
|
+
#
|
513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateRoutingProfileQueues AWS API Documentation
|
514
|
+
#
|
515
|
+
# @overload associate_routing_profile_queues(params = {})
|
516
|
+
# @param [Hash] params ({})
|
517
|
+
def associate_routing_profile_queues(params = {}, options = {})
|
518
|
+
req = build_request(:associate_routing_profile_queues, params)
|
519
|
+
req.send_request(options)
|
520
|
+
end
|
521
|
+
|
522
|
+
# Associates a security key to the instance.
|
523
|
+
#
|
524
|
+
# @option params [required, String] :instance_id
|
525
|
+
# The identifier of the Amazon Connect instance.
|
526
|
+
#
|
527
|
+
# @option params [required, String] :key
|
528
|
+
# A valid security key in PEM format.
|
529
|
+
#
|
530
|
+
# @return [Types::AssociateSecurityKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
531
|
+
#
|
532
|
+
# * {Types::AssociateSecurityKeyResponse#association_id #association_id} => String
|
533
|
+
#
|
534
|
+
# @example Request syntax with placeholder values
|
535
|
+
#
|
536
|
+
# resp = client.associate_security_key({
|
537
|
+
# instance_id: "InstanceId", # required
|
538
|
+
# key: "PEM", # required
|
539
|
+
# })
|
540
|
+
#
|
541
|
+
# @example Response structure
|
542
|
+
#
|
543
|
+
# resp.association_id #=> String
|
544
|
+
#
|
545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateSecurityKey AWS API Documentation
|
546
|
+
#
|
547
|
+
# @overload associate_security_key(params = {})
|
548
|
+
# @param [Hash] params ({})
|
549
|
+
def associate_security_key(params = {}, options = {})
|
550
|
+
req = build_request(:associate_security_key, params)
|
551
|
+
req.send_request(options)
|
552
|
+
end
|
553
|
+
|
554
|
+
# Creates a contact flow for the specified Amazon Connect instance.
|
555
|
+
#
|
556
|
+
# You can also create and update contact flows using the [Amazon Connect
|
557
|
+
# Flow language][1].
|
558
|
+
#
|
559
|
+
#
|
560
|
+
#
|
561
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
562
|
+
#
|
563
|
+
# @option params [required, String] :instance_id
|
564
|
+
# The identifier of the Amazon Connect instance.
|
565
|
+
#
|
566
|
+
# @option params [required, String] :name
|
567
|
+
# The name of the contact flow.
|
568
|
+
#
|
569
|
+
# @option params [required, String] :type
|
570
|
+
# The type of the contact flow. For descriptions of the available types,
|
571
|
+
# see [Choose a Contact Flow Type][1] in the *Amazon Connect
|
572
|
+
# Administrator Guide*.
|
573
|
+
#
|
574
|
+
#
|
575
|
+
#
|
576
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
|
577
|
+
#
|
578
|
+
# @option params [String] :description
|
579
|
+
# The description of the contact flow.
|
580
|
+
#
|
581
|
+
# @option params [required, String] :content
|
582
|
+
# The content of the contact flow.
|
583
|
+
#
|
584
|
+
# @option params [Hash<String,String>] :tags
|
585
|
+
# One or more tags.
|
586
|
+
#
|
587
|
+
# @return [Types::CreateContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
588
|
+
#
|
589
|
+
# * {Types::CreateContactFlowResponse#contact_flow_id #contact_flow_id} => String
|
590
|
+
# * {Types::CreateContactFlowResponse#contact_flow_arn #contact_flow_arn} => String
|
591
|
+
#
|
592
|
+
# @example Request syntax with placeholder values
|
593
|
+
#
|
594
|
+
# resp = client.create_contact_flow({
|
595
|
+
# instance_id: "InstanceId", # required
|
596
|
+
# name: "ContactFlowName", # required
|
597
|
+
# type: "CONTACT_FLOW", # required, accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
598
|
+
# description: "ContactFlowDescription",
|
599
|
+
# content: "ContactFlowContent", # required
|
600
|
+
# tags: {
|
601
|
+
# "TagKey" => "TagValue",
|
602
|
+
# },
|
603
|
+
# })
|
604
|
+
#
|
605
|
+
# @example Response structure
|
606
|
+
#
|
607
|
+
# resp.contact_flow_id #=> String
|
608
|
+
# resp.contact_flow_arn #=> String
|
609
|
+
#
|
610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlow AWS API Documentation
|
611
|
+
#
|
612
|
+
# @overload create_contact_flow(params = {})
|
613
|
+
# @param [Hash] params ({})
|
614
|
+
def create_contact_flow(params = {}, options = {})
|
615
|
+
req = build_request(:create_contact_flow, params)
|
616
|
+
req.send_request(options)
|
617
|
+
end
|
618
|
+
|
619
|
+
# Initiates an Amazon Connect instance with all the supported channels
|
620
|
+
# enabled. It does not attach any storage (such as Amazon S3, or
|
621
|
+
# Kinesis) or allow for any configurations on features such as Contact
|
622
|
+
# Lens for Amazon Connect.
|
623
|
+
#
|
624
|
+
# @option params [String] :client_token
|
625
|
+
# The idempotency token.
|
626
|
+
#
|
627
|
+
# @option params [required, String] :identity_management_type
|
628
|
+
# The type of identity management for your Amazon Connect users.
|
629
|
+
#
|
630
|
+
# @option params [String] :instance_alias
|
631
|
+
# The name for your instance.
|
632
|
+
#
|
633
|
+
# @option params [String] :directory_id
|
634
|
+
# The identifier for the directory.
|
635
|
+
#
|
636
|
+
# @option params [required, Boolean] :inbound_calls_enabled
|
637
|
+
# Whether your contact center handles incoming contacts.
|
638
|
+
#
|
639
|
+
# @option params [required, Boolean] :outbound_calls_enabled
|
640
|
+
# Whether your contact center allows outbound calls.
|
641
|
+
#
|
642
|
+
# @return [Types::CreateInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
643
|
+
#
|
644
|
+
# * {Types::CreateInstanceResponse#id #id} => String
|
645
|
+
# * {Types::CreateInstanceResponse#arn #arn} => String
|
646
|
+
#
|
647
|
+
# @example Request syntax with placeholder values
|
648
|
+
#
|
649
|
+
# resp = client.create_instance({
|
650
|
+
# client_token: "ClientToken",
|
651
|
+
# identity_management_type: "SAML", # required, accepts SAML, CONNECT_MANAGED, EXISTING_DIRECTORY
|
652
|
+
# instance_alias: "DirectoryAlias",
|
653
|
+
# directory_id: "DirectoryId",
|
654
|
+
# inbound_calls_enabled: false, # required
|
655
|
+
# outbound_calls_enabled: false, # required
|
656
|
+
# })
|
657
|
+
#
|
658
|
+
# @example Response structure
|
659
|
+
#
|
660
|
+
# resp.id #=> String
|
661
|
+
# resp.arn #=> String
|
662
|
+
#
|
663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateInstance AWS API Documentation
|
664
|
+
#
|
665
|
+
# @overload create_instance(params = {})
|
666
|
+
# @param [Hash] params ({})
|
667
|
+
def create_instance(params = {}, options = {})
|
668
|
+
req = build_request(:create_instance, params)
|
669
|
+
req.send_request(options)
|
670
|
+
end
|
671
|
+
|
672
|
+
# Creates a new routing profile.
|
673
|
+
#
|
674
|
+
# @option params [required, String] :instance_id
|
675
|
+
# The identifier of the Amazon Connect instance.
|
676
|
+
#
|
677
|
+
# @option params [required, String] :name
|
678
|
+
# The name of the routing profile. Must not be more than 127 characters.
|
679
|
+
#
|
680
|
+
# @option params [required, String] :description
|
681
|
+
# Description of the routing profile. Must not be more than 250
|
682
|
+
# characters.
|
683
|
+
#
|
684
|
+
# @option params [required, String] :default_outbound_queue_id
|
685
|
+
# The default outbound queue for the routing profile.
|
686
|
+
#
|
687
|
+
# @option params [Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
688
|
+
# The inbound queues associated with the routing profile. If no queue is
|
689
|
+
# added, the agent can only make outbound calls.
|
690
|
+
#
|
691
|
+
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
692
|
+
# The channels agents can handle in the Contact Control Panel (CCP) for
|
693
|
+
# this routing profile.
|
694
|
+
#
|
695
|
+
# @option params [Hash<String,String>] :tags
|
696
|
+
# One or more tags.
|
697
|
+
#
|
698
|
+
# @return [Types::CreateRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
699
|
+
#
|
700
|
+
# * {Types::CreateRoutingProfileResponse#routing_profile_arn #routing_profile_arn} => String
|
701
|
+
# * {Types::CreateRoutingProfileResponse#routing_profile_id #routing_profile_id} => String
|
702
|
+
#
|
703
|
+
# @example Request syntax with placeholder values
|
704
|
+
#
|
705
|
+
# resp = client.create_routing_profile({
|
706
|
+
# instance_id: "InstanceId", # required
|
707
|
+
# name: "RoutingProfileName", # required
|
708
|
+
# description: "RoutingProfileDescription", # required
|
709
|
+
# default_outbound_queue_id: "QueueId", # required
|
710
|
+
# queue_configs: [
|
711
|
+
# {
|
712
|
+
# queue_reference: { # required
|
713
|
+
# queue_id: "QueueId", # required
|
714
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
715
|
+
# },
|
716
|
+
# priority: 1, # required
|
717
|
+
# delay: 1, # required
|
718
|
+
# },
|
719
|
+
# ],
|
720
|
+
# media_concurrencies: [ # required
|
721
|
+
# {
|
722
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
723
|
+
# concurrency: 1, # required
|
724
|
+
# },
|
725
|
+
# ],
|
726
|
+
# tags: {
|
727
|
+
# "TagKey" => "TagValue",
|
728
|
+
# },
|
729
|
+
# })
|
730
|
+
#
|
731
|
+
# @example Response structure
|
732
|
+
#
|
733
|
+
# resp.routing_profile_arn #=> String
|
734
|
+
# resp.routing_profile_id #=> String
|
735
|
+
#
|
736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRoutingProfile AWS API Documentation
|
737
|
+
#
|
738
|
+
# @overload create_routing_profile(params = {})
|
739
|
+
# @param [Hash] params ({})
|
740
|
+
def create_routing_profile(params = {}, options = {})
|
741
|
+
req = build_request(:create_routing_profile, params)
|
742
|
+
req.send_request(options)
|
743
|
+
end
|
744
|
+
|
330
745
|
# Creates a user account for the specified Amazon Connect instance.
|
331
746
|
#
|
332
|
-
#
|
333
|
-
#
|
334
|
-
#
|
335
|
-
#
|
336
|
-
#
|
747
|
+
# For information about how to create user accounts using the Amazon
|
748
|
+
# Connect console, see [Add Users][1] in the *Amazon Connect
|
749
|
+
# Administrator Guide*.
|
750
|
+
#
|
751
|
+
#
|
752
|
+
#
|
753
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html
|
754
|
+
#
|
755
|
+
# @option params [required, String] :username
|
756
|
+
# The user name for the account. For instances not using SAML for
|
757
|
+
# identity management, the user name can include up to 20 characters. If
|
758
|
+
# you are using SAML for identity management, the user name can include
|
759
|
+
# up to 64 characters from \[a-zA-Z0-9\_-.\\@\]+.
|
760
|
+
#
|
761
|
+
# @option params [String] :password
|
762
|
+
# The password for the user account. A password is required if you are
|
763
|
+
# using Amazon Connect for identity management. Otherwise, it is an
|
764
|
+
# error to include a password.
|
765
|
+
#
|
766
|
+
# @option params [Types::UserIdentityInfo] :identity_info
|
767
|
+
# The information about the identity of the user.
|
768
|
+
#
|
769
|
+
# @option params [required, Types::UserPhoneConfig] :phone_config
|
770
|
+
# The phone settings for the user.
|
771
|
+
#
|
772
|
+
# @option params [String] :directory_user_id
|
773
|
+
# The identifier of the user account in the directory used for identity
|
774
|
+
# management. If Amazon Connect cannot access the directory, you can
|
775
|
+
# specify this identifier to authenticate users. If you include the
|
776
|
+
# identifier, we assume that Amazon Connect cannot access the directory.
|
777
|
+
# Otherwise, the identity information is used to authenticate users from
|
778
|
+
# your directory.
|
779
|
+
#
|
780
|
+
# This parameter is required if you are using an existing directory for
|
781
|
+
# identity management in Amazon Connect when Amazon Connect cannot
|
782
|
+
# access your directory to authenticate users. If you are using SAML for
|
783
|
+
# identity management and include this parameter, an error is returned.
|
784
|
+
#
|
785
|
+
# @option params [required, Array<String>] :security_profile_ids
|
786
|
+
# The identifier of the security profile for the user.
|
787
|
+
#
|
788
|
+
# @option params [required, String] :routing_profile_id
|
789
|
+
# The identifier of the routing profile for the user.
|
790
|
+
#
|
791
|
+
# @option params [String] :hierarchy_group_id
|
792
|
+
# The identifier of the hierarchy group for the user.
|
793
|
+
#
|
794
|
+
# @option params [required, String] :instance_id
|
795
|
+
# The identifier of the Amazon Connect instance.
|
796
|
+
#
|
797
|
+
# @option params [Hash<String,String>] :tags
|
798
|
+
# One or more tags.
|
799
|
+
#
|
800
|
+
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
801
|
+
#
|
802
|
+
# * {Types::CreateUserResponse#user_id #user_id} => String
|
803
|
+
# * {Types::CreateUserResponse#user_arn #user_arn} => String
|
804
|
+
#
|
805
|
+
# @example Request syntax with placeholder values
|
806
|
+
#
|
807
|
+
# resp = client.create_user({
|
808
|
+
# username: "AgentUsername", # required
|
809
|
+
# password: "Password",
|
810
|
+
# identity_info: {
|
811
|
+
# first_name: "AgentFirstName",
|
812
|
+
# last_name: "AgentLastName",
|
813
|
+
# email: "Email",
|
814
|
+
# },
|
815
|
+
# phone_config: { # required
|
816
|
+
# phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
|
817
|
+
# auto_accept: false,
|
818
|
+
# after_contact_work_time_limit: 1,
|
819
|
+
# desk_phone_number: "PhoneNumber",
|
820
|
+
# },
|
821
|
+
# directory_user_id: "DirectoryUserId",
|
822
|
+
# security_profile_ids: ["SecurityProfileId"], # required
|
823
|
+
# routing_profile_id: "RoutingProfileId", # required
|
824
|
+
# hierarchy_group_id: "HierarchyGroupId",
|
825
|
+
# instance_id: "InstanceId", # required
|
826
|
+
# tags: {
|
827
|
+
# "TagKey" => "TagValue",
|
828
|
+
# },
|
829
|
+
# })
|
830
|
+
#
|
831
|
+
# @example Response structure
|
832
|
+
#
|
833
|
+
# resp.user_id #=> String
|
834
|
+
# resp.user_arn #=> String
|
835
|
+
#
|
836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUser AWS API Documentation
|
837
|
+
#
|
838
|
+
# @overload create_user(params = {})
|
839
|
+
# @param [Hash] params ({})
|
840
|
+
def create_user(params = {}, options = {})
|
841
|
+
req = build_request(:create_user, params)
|
842
|
+
req.send_request(options)
|
843
|
+
end
|
844
|
+
|
845
|
+
# Creates a new user hierarchy group.
|
846
|
+
#
|
847
|
+
# @option params [required, String] :name
|
848
|
+
# The name of the user hierarchy group. Must not be more than 100
|
849
|
+
# characters.
|
850
|
+
#
|
851
|
+
# @option params [String] :parent_group_id
|
852
|
+
# The identifier for the parent hierarchy group. The user hierarchy is
|
853
|
+
# created at level one if the parent group ID is null.
|
854
|
+
#
|
855
|
+
# @option params [required, String] :instance_id
|
856
|
+
# The identifier of the Amazon Connect instance.
|
857
|
+
#
|
858
|
+
# @return [Types::CreateUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
859
|
+
#
|
860
|
+
# * {Types::CreateUserHierarchyGroupResponse#hierarchy_group_id #hierarchy_group_id} => String
|
861
|
+
# * {Types::CreateUserHierarchyGroupResponse#hierarchy_group_arn #hierarchy_group_arn} => String
|
862
|
+
#
|
863
|
+
# @example Request syntax with placeholder values
|
864
|
+
#
|
865
|
+
# resp = client.create_user_hierarchy_group({
|
866
|
+
# name: "HierarchyGroupName", # required
|
867
|
+
# parent_group_id: "HierarchyGroupId",
|
868
|
+
# instance_id: "InstanceId", # required
|
869
|
+
# })
|
870
|
+
#
|
871
|
+
# @example Response structure
|
872
|
+
#
|
873
|
+
# resp.hierarchy_group_id #=> String
|
874
|
+
# resp.hierarchy_group_arn #=> String
|
875
|
+
#
|
876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserHierarchyGroup AWS API Documentation
|
877
|
+
#
|
878
|
+
# @overload create_user_hierarchy_group(params = {})
|
879
|
+
# @param [Hash] params ({})
|
880
|
+
def create_user_hierarchy_group(params = {}, options = {})
|
881
|
+
req = build_request(:create_user_hierarchy_group, params)
|
882
|
+
req.send_request(options)
|
883
|
+
end
|
884
|
+
|
885
|
+
# Deletes the Amazon Connect instance.
|
886
|
+
#
|
887
|
+
# @option params [required, String] :instance_id
|
888
|
+
# The identifier of the Amazon Connect instance.
|
889
|
+
#
|
890
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
891
|
+
#
|
892
|
+
# @example Request syntax with placeholder values
|
893
|
+
#
|
894
|
+
# resp = client.delete_instance({
|
895
|
+
# instance_id: "InstanceId", # required
|
896
|
+
# })
|
897
|
+
#
|
898
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteInstance AWS API Documentation
|
899
|
+
#
|
900
|
+
# @overload delete_instance(params = {})
|
901
|
+
# @param [Hash] params ({})
|
902
|
+
def delete_instance(params = {}, options = {})
|
903
|
+
req = build_request(:delete_instance, params)
|
904
|
+
req.send_request(options)
|
905
|
+
end
|
906
|
+
|
907
|
+
# Deletes a user account from the specified Amazon Connect instance.
|
908
|
+
#
|
909
|
+
# For information about what happens to a user's data when their
|
910
|
+
# account is deleted, see [Delete Users from Your Amazon Connect
|
911
|
+
# Instance][1] in the *Amazon Connect Administrator Guide*.
|
912
|
+
#
|
913
|
+
#
|
914
|
+
#
|
915
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html
|
916
|
+
#
|
917
|
+
# @option params [required, String] :instance_id
|
918
|
+
# The identifier of the Amazon Connect instance.
|
919
|
+
#
|
920
|
+
# @option params [required, String] :user_id
|
921
|
+
# The identifier of the user.
|
922
|
+
#
|
923
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
924
|
+
#
|
925
|
+
# @example Request syntax with placeholder values
|
926
|
+
#
|
927
|
+
# resp = client.delete_user({
|
928
|
+
# instance_id: "InstanceId", # required
|
929
|
+
# user_id: "UserId", # required
|
930
|
+
# })
|
931
|
+
#
|
932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUser AWS API Documentation
|
933
|
+
#
|
934
|
+
# @overload delete_user(params = {})
|
935
|
+
# @param [Hash] params ({})
|
936
|
+
def delete_user(params = {}, options = {})
|
937
|
+
req = build_request(:delete_user, params)
|
938
|
+
req.send_request(options)
|
939
|
+
end
|
940
|
+
|
941
|
+
# Deletes an existing user hierarchy group. It must not be associated
|
942
|
+
# with any agents or have any active child groups.
|
943
|
+
#
|
944
|
+
# @option params [required, String] :hierarchy_group_id
|
945
|
+
# The identifier of the hierarchy group.
|
946
|
+
#
|
947
|
+
# @option params [required, String] :instance_id
|
948
|
+
# The identifier of the Amazon Connect instance.
|
949
|
+
#
|
950
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
951
|
+
#
|
952
|
+
# @example Request syntax with placeholder values
|
953
|
+
#
|
954
|
+
# resp = client.delete_user_hierarchy_group({
|
955
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
956
|
+
# instance_id: "InstanceId", # required
|
957
|
+
# })
|
958
|
+
#
|
959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUserHierarchyGroup AWS API Documentation
|
960
|
+
#
|
961
|
+
# @overload delete_user_hierarchy_group(params = {})
|
962
|
+
# @param [Hash] params ({})
|
963
|
+
def delete_user_hierarchy_group(params = {}, options = {})
|
964
|
+
req = build_request(:delete_user_hierarchy_group, params)
|
965
|
+
req.send_request(options)
|
966
|
+
end
|
967
|
+
|
968
|
+
# Describes the specified contact flow.
|
969
|
+
#
|
970
|
+
# You can also create and update contact flows using the [Amazon Connect
|
971
|
+
# Flow language][1].
|
337
972
|
#
|
338
|
-
# @option params [String] :password
|
339
|
-
# The password for the user account. A password is required if you are
|
340
|
-
# using Amazon Connect for identity management. Otherwise, it is an
|
341
|
-
# error to include a password.
|
342
973
|
#
|
343
|
-
# @option params [Types::UserIdentityInfo] :identity_info
|
344
|
-
# The information about the identity of the user.
|
345
974
|
#
|
346
|
-
#
|
347
|
-
# The phone settings for the user.
|
975
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
348
976
|
#
|
349
|
-
# @option params [String] :
|
350
|
-
# The identifier of the
|
351
|
-
# management. If Amazon Connect cannot access the directory, you can
|
352
|
-
# specify this identifier to authenticate users. If you include the
|
353
|
-
# identifier, we assume that Amazon Connect cannot access the directory.
|
354
|
-
# Otherwise, the identity information is used to authenticate users from
|
355
|
-
# your directory.
|
977
|
+
# @option params [required, String] :instance_id
|
978
|
+
# The identifier of the Amazon Connect instance.
|
356
979
|
#
|
357
|
-
#
|
358
|
-
#
|
359
|
-
# access your directory to authenticate users. If you are using SAML for
|
360
|
-
# identity management and include this parameter, an error is returned.
|
980
|
+
# @option params [required, String] :contact_flow_id
|
981
|
+
# The identifier of the contact flow.
|
361
982
|
#
|
362
|
-
# @
|
363
|
-
# The identifier of the security profile for the user.
|
983
|
+
# @return [Types::DescribeContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
364
984
|
#
|
365
|
-
#
|
366
|
-
# The identifier of the routing profile for the user.
|
985
|
+
# * {Types::DescribeContactFlowResponse#contact_flow #contact_flow} => Types::ContactFlow
|
367
986
|
#
|
368
|
-
# @
|
369
|
-
#
|
987
|
+
# @example Request syntax with placeholder values
|
988
|
+
#
|
989
|
+
# resp = client.describe_contact_flow({
|
990
|
+
# instance_id: "InstanceId", # required
|
991
|
+
# contact_flow_id: "ContactFlowId", # required
|
992
|
+
# })
|
993
|
+
#
|
994
|
+
# @example Response structure
|
995
|
+
#
|
996
|
+
# resp.contact_flow.arn #=> String
|
997
|
+
# resp.contact_flow.id #=> String
|
998
|
+
# resp.contact_flow.name #=> String
|
999
|
+
# resp.contact_flow.type #=> String, one of "CONTACT_FLOW", "CUSTOMER_QUEUE", "CUSTOMER_HOLD", "CUSTOMER_WHISPER", "AGENT_HOLD", "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", "QUEUE_TRANSFER"
|
1000
|
+
# resp.contact_flow.description #=> String
|
1001
|
+
# resp.contact_flow.content #=> String
|
1002
|
+
# resp.contact_flow.tags #=> Hash
|
1003
|
+
# resp.contact_flow.tags["TagKey"] #=> String
|
1004
|
+
#
|
1005
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlow AWS API Documentation
|
1006
|
+
#
|
1007
|
+
# @overload describe_contact_flow(params = {})
|
1008
|
+
# @param [Hash] params ({})
|
1009
|
+
def describe_contact_flow(params = {}, options = {})
|
1010
|
+
req = build_request(:describe_contact_flow, params)
|
1011
|
+
req.send_request(options)
|
1012
|
+
end
|
1013
|
+
|
1014
|
+
# Returns the current state of the specified instance identifier. It
|
1015
|
+
# tracks the instance while it is being created and returns an error
|
1016
|
+
# status if applicable.
|
1017
|
+
#
|
1018
|
+
# If an instance is not created successfully, the instance status reason
|
1019
|
+
# field returns details relevant to the reason. The instance in a failed
|
1020
|
+
# state is returned only for 24 hours after the CreateInstance API was
|
1021
|
+
# invoked.
|
370
1022
|
#
|
371
1023
|
# @option params [required, String] :instance_id
|
372
1024
|
# The identifier of the Amazon Connect instance.
|
373
1025
|
#
|
374
|
-
# @
|
375
|
-
# One or more tags.
|
1026
|
+
# @return [Types::DescribeInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
376
1027
|
#
|
377
|
-
#
|
1028
|
+
# * {Types::DescribeInstanceResponse#instance #instance} => Types::Instance
|
378
1029
|
#
|
379
|
-
#
|
380
|
-
#
|
1030
|
+
# @example Request syntax with placeholder values
|
1031
|
+
#
|
1032
|
+
# resp = client.describe_instance({
|
1033
|
+
# instance_id: "InstanceId", # required
|
1034
|
+
# })
|
1035
|
+
#
|
1036
|
+
# @example Response structure
|
1037
|
+
#
|
1038
|
+
# resp.instance.id #=> String
|
1039
|
+
# resp.instance.arn #=> String
|
1040
|
+
# resp.instance.identity_management_type #=> String, one of "SAML", "CONNECT_MANAGED", "EXISTING_DIRECTORY"
|
1041
|
+
# resp.instance.instance_alias #=> String
|
1042
|
+
# resp.instance.created_time #=> Time
|
1043
|
+
# resp.instance.service_role #=> String
|
1044
|
+
# resp.instance.instance_status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED"
|
1045
|
+
# resp.instance.status_reason.message #=> String
|
1046
|
+
# resp.instance.inbound_calls_enabled #=> Boolean
|
1047
|
+
# resp.instance.outbound_calls_enabled #=> Boolean
|
1048
|
+
#
|
1049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstance AWS API Documentation
|
1050
|
+
#
|
1051
|
+
# @overload describe_instance(params = {})
|
1052
|
+
# @param [Hash] params ({})
|
1053
|
+
def describe_instance(params = {}, options = {})
|
1054
|
+
req = build_request(:describe_instance, params)
|
1055
|
+
req.send_request(options)
|
1056
|
+
end
|
1057
|
+
|
1058
|
+
# Describes the specified instance attribute.
|
1059
|
+
#
|
1060
|
+
# @option params [required, String] :instance_id
|
1061
|
+
# The identifier of the Amazon Connect instance.
|
1062
|
+
#
|
1063
|
+
# @option params [required, String] :attribute_type
|
1064
|
+
# The type of attribute.
|
1065
|
+
#
|
1066
|
+
# @return [Types::DescribeInstanceAttributeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1067
|
+
#
|
1068
|
+
# * {Types::DescribeInstanceAttributeResponse#attribute #attribute} => Types::Attribute
|
381
1069
|
#
|
382
1070
|
# @example Request syntax with placeholder values
|
383
1071
|
#
|
384
|
-
# resp = client.
|
385
|
-
# username: "AgentUsername", # required
|
386
|
-
# password: "Password",
|
387
|
-
# identity_info: {
|
388
|
-
# first_name: "AgentFirstName",
|
389
|
-
# last_name: "AgentLastName",
|
390
|
-
# email: "Email",
|
391
|
-
# },
|
392
|
-
# phone_config: { # required
|
393
|
-
# phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
|
394
|
-
# auto_accept: false,
|
395
|
-
# after_contact_work_time_limit: 1,
|
396
|
-
# desk_phone_number: "PhoneNumber",
|
397
|
-
# },
|
398
|
-
# directory_user_id: "DirectoryUserId",
|
399
|
-
# security_profile_ids: ["SecurityProfileId"], # required
|
400
|
-
# routing_profile_id: "RoutingProfileId", # required
|
401
|
-
# hierarchy_group_id: "HierarchyGroupId",
|
1072
|
+
# resp = client.describe_instance_attribute({
|
402
1073
|
# instance_id: "InstanceId", # required
|
403
|
-
#
|
404
|
-
# "TagKey" => "TagValue",
|
405
|
-
# },
|
1074
|
+
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA
|
406
1075
|
# })
|
407
1076
|
#
|
408
1077
|
# @example Response structure
|
409
1078
|
#
|
410
|
-
# resp.
|
411
|
-
# resp.
|
1079
|
+
# 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"
|
1080
|
+
# resp.attribute.value #=> String
|
412
1081
|
#
|
413
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
1082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceAttribute AWS API Documentation
|
414
1083
|
#
|
415
|
-
# @overload
|
1084
|
+
# @overload describe_instance_attribute(params = {})
|
416
1085
|
# @param [Hash] params ({})
|
417
|
-
def
|
418
|
-
req = build_request(:
|
1086
|
+
def describe_instance_attribute(params = {}, options = {})
|
1087
|
+
req = build_request(:describe_instance_attribute, params)
|
419
1088
|
req.send_request(options)
|
420
1089
|
end
|
421
1090
|
|
422
|
-
#
|
1091
|
+
# Retrieves the current storage configurations for the specified
|
1092
|
+
# resource type, association ID, and instance ID.
|
423
1093
|
#
|
424
1094
|
# @option params [required, String] :instance_id
|
425
1095
|
# The identifier of the Amazon Connect instance.
|
426
1096
|
#
|
427
|
-
# @option params [required, String] :
|
428
|
-
# The identifier
|
1097
|
+
# @option params [required, String] :association_id
|
1098
|
+
# The existing association identifier that uniquely identifies the
|
1099
|
+
# resource type and storage config for the given instance ID.
|
429
1100
|
#
|
430
|
-
# @
|
1101
|
+
# @option params [required, String] :resource_type
|
1102
|
+
# A valid resource type.
|
1103
|
+
#
|
1104
|
+
# @return [Types::DescribeInstanceStorageConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1105
|
+
#
|
1106
|
+
# * {Types::DescribeInstanceStorageConfigResponse#storage_config #storage_config} => Types::InstanceStorageConfig
|
431
1107
|
#
|
432
1108
|
# @example Request syntax with placeholder values
|
433
1109
|
#
|
434
|
-
# resp = client.
|
1110
|
+
# resp = client.describe_instance_storage_config({
|
435
1111
|
# instance_id: "InstanceId", # required
|
436
|
-
#
|
1112
|
+
# association_id: "AssociationId", # required
|
1113
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
437
1114
|
# })
|
438
1115
|
#
|
439
|
-
# @
|
1116
|
+
# @example Response structure
|
440
1117
|
#
|
441
|
-
#
|
1118
|
+
# resp.storage_config.association_id #=> String
|
1119
|
+
# resp.storage_config.storage_type #=> String, one of "S3", "KINESIS_VIDEO_STREAM", "KINESIS_STREAM", "KINESIS_FIREHOSE"
|
1120
|
+
# resp.storage_config.s3_config.bucket_name #=> String
|
1121
|
+
# resp.storage_config.s3_config.bucket_prefix #=> String
|
1122
|
+
# resp.storage_config.s3_config.encryption_config.encryption_type #=> String, one of "KMS"
|
1123
|
+
# resp.storage_config.s3_config.encryption_config.key_id #=> String
|
1124
|
+
# resp.storage_config.kinesis_video_stream_config.prefix #=> String
|
1125
|
+
# resp.storage_config.kinesis_video_stream_config.retention_period_hours #=> Integer
|
1126
|
+
# resp.storage_config.kinesis_video_stream_config.encryption_config.encryption_type #=> String, one of "KMS"
|
1127
|
+
# resp.storage_config.kinesis_video_stream_config.encryption_config.key_id #=> String
|
1128
|
+
# resp.storage_config.kinesis_stream_config.stream_arn #=> String
|
1129
|
+
# resp.storage_config.kinesis_firehose_config.firehose_arn #=> String
|
1130
|
+
#
|
1131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceStorageConfig AWS API Documentation
|
1132
|
+
#
|
1133
|
+
# @overload describe_instance_storage_config(params = {})
|
442
1134
|
# @param [Hash] params ({})
|
443
|
-
def
|
444
|
-
req = build_request(:
|
1135
|
+
def describe_instance_storage_config(params = {}, options = {})
|
1136
|
+
req = build_request(:describe_instance_storage_config, params)
|
1137
|
+
req.send_request(options)
|
1138
|
+
end
|
1139
|
+
|
1140
|
+
# Describes the specified routing profile.
|
1141
|
+
#
|
1142
|
+
# @option params [required, String] :instance_id
|
1143
|
+
# The identifier of the Amazon Connect instance.
|
1144
|
+
#
|
1145
|
+
# @option params [required, String] :routing_profile_id
|
1146
|
+
# The identifier of the routing profile.
|
1147
|
+
#
|
1148
|
+
# @return [Types::DescribeRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1149
|
+
#
|
1150
|
+
# * {Types::DescribeRoutingProfileResponse#routing_profile #routing_profile} => Types::RoutingProfile
|
1151
|
+
#
|
1152
|
+
# @example Request syntax with placeholder values
|
1153
|
+
#
|
1154
|
+
# resp = client.describe_routing_profile({
|
1155
|
+
# instance_id: "InstanceId", # required
|
1156
|
+
# routing_profile_id: "RoutingProfileId", # required
|
1157
|
+
# })
|
1158
|
+
#
|
1159
|
+
# @example Response structure
|
1160
|
+
#
|
1161
|
+
# resp.routing_profile.instance_id #=> String
|
1162
|
+
# resp.routing_profile.name #=> String
|
1163
|
+
# resp.routing_profile.routing_profile_arn #=> String
|
1164
|
+
# resp.routing_profile.routing_profile_id #=> String
|
1165
|
+
# resp.routing_profile.description #=> String
|
1166
|
+
# resp.routing_profile.media_concurrencies #=> Array
|
1167
|
+
# resp.routing_profile.media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT"
|
1168
|
+
# resp.routing_profile.media_concurrencies[0].concurrency #=> Integer
|
1169
|
+
# resp.routing_profile.default_outbound_queue_id #=> String
|
1170
|
+
# resp.routing_profile.tags #=> Hash
|
1171
|
+
# resp.routing_profile.tags["TagKey"] #=> String
|
1172
|
+
#
|
1173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfile AWS API Documentation
|
1174
|
+
#
|
1175
|
+
# @overload describe_routing_profile(params = {})
|
1176
|
+
# @param [Hash] params ({})
|
1177
|
+
def describe_routing_profile(params = {}, options = {})
|
1178
|
+
req = build_request(:describe_routing_profile, params)
|
445
1179
|
req.send_request(options)
|
446
1180
|
end
|
447
1181
|
|
@@ -589,6 +1323,185 @@ module Aws::Connect
|
|
589
1323
|
req.send_request(options)
|
590
1324
|
end
|
591
1325
|
|
1326
|
+
# Revokes access to integrated applications from Amazon Connect.
|
1327
|
+
#
|
1328
|
+
# @option params [required, String] :instance_id
|
1329
|
+
# The identifier of the Amazon Connect instance.
|
1330
|
+
#
|
1331
|
+
# @option params [required, String] :origin
|
1332
|
+
# The domain URL of the integrated application.
|
1333
|
+
#
|
1334
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1335
|
+
#
|
1336
|
+
# @example Request syntax with placeholder values
|
1337
|
+
#
|
1338
|
+
# resp = client.disassociate_approved_origin({
|
1339
|
+
# instance_id: "InstanceId", # required
|
1340
|
+
# origin: "Origin", # required
|
1341
|
+
# })
|
1342
|
+
#
|
1343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateApprovedOrigin AWS API Documentation
|
1344
|
+
#
|
1345
|
+
# @overload disassociate_approved_origin(params = {})
|
1346
|
+
# @param [Hash] params ({})
|
1347
|
+
def disassociate_approved_origin(params = {}, options = {})
|
1348
|
+
req = build_request(:disassociate_approved_origin, params)
|
1349
|
+
req.send_request(options)
|
1350
|
+
end
|
1351
|
+
|
1352
|
+
# Removes the storage type configurations for the specified resource
|
1353
|
+
# type and association ID.
|
1354
|
+
#
|
1355
|
+
# @option params [required, String] :instance_id
|
1356
|
+
# The identifier of the Amazon Connect instance.
|
1357
|
+
#
|
1358
|
+
# @option params [required, String] :association_id
|
1359
|
+
# The existing association identifier that uniquely identifies the
|
1360
|
+
# resource type and storage config for the given instance ID.
|
1361
|
+
#
|
1362
|
+
# @option params [required, String] :resource_type
|
1363
|
+
# A valid resource type.
|
1364
|
+
#
|
1365
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1366
|
+
#
|
1367
|
+
# @example Request syntax with placeholder values
|
1368
|
+
#
|
1369
|
+
# resp = client.disassociate_instance_storage_config({
|
1370
|
+
# instance_id: "InstanceId", # required
|
1371
|
+
# association_id: "AssociationId", # required
|
1372
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
1373
|
+
# })
|
1374
|
+
#
|
1375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateInstanceStorageConfig AWS API Documentation
|
1376
|
+
#
|
1377
|
+
# @overload disassociate_instance_storage_config(params = {})
|
1378
|
+
# @param [Hash] params ({})
|
1379
|
+
def disassociate_instance_storage_config(params = {}, options = {})
|
1380
|
+
req = build_request(:disassociate_instance_storage_config, params)
|
1381
|
+
req.send_request(options)
|
1382
|
+
end
|
1383
|
+
|
1384
|
+
# Remove the Lambda function from the drop-down options available in the
|
1385
|
+
# relevant contact flow blocks.
|
1386
|
+
#
|
1387
|
+
# @option params [required, String] :instance_id
|
1388
|
+
# The identifier of the Amazon Connect instance..
|
1389
|
+
#
|
1390
|
+
# @option params [required, String] :function_arn
|
1391
|
+
# The Amazon Resource Name (ARN) of the Lambda function being
|
1392
|
+
# disassociated.
|
1393
|
+
#
|
1394
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1395
|
+
#
|
1396
|
+
# @example Request syntax with placeholder values
|
1397
|
+
#
|
1398
|
+
# resp = client.disassociate_lambda_function({
|
1399
|
+
# instance_id: "InstanceId", # required
|
1400
|
+
# function_arn: "FunctionArn", # required
|
1401
|
+
# })
|
1402
|
+
#
|
1403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateLambdaFunction AWS API Documentation
|
1404
|
+
#
|
1405
|
+
# @overload disassociate_lambda_function(params = {})
|
1406
|
+
# @param [Hash] params ({})
|
1407
|
+
def disassociate_lambda_function(params = {}, options = {})
|
1408
|
+
req = build_request(:disassociate_lambda_function, params)
|
1409
|
+
req.send_request(options)
|
1410
|
+
end
|
1411
|
+
|
1412
|
+
# Revokes authorization from the specified instance to access the
|
1413
|
+
# specified Amazon Lex bot.
|
1414
|
+
#
|
1415
|
+
# @option params [required, String] :instance_id
|
1416
|
+
# The identifier of the Amazon Connect instance.
|
1417
|
+
#
|
1418
|
+
# @option params [required, String] :bot_name
|
1419
|
+
# The name of the Amazon Lex bot. Maximum character limit of 50.
|
1420
|
+
#
|
1421
|
+
# @option params [required, String] :lex_region
|
1422
|
+
# The Region in which the Amazon Lex bot has been created.
|
1423
|
+
#
|
1424
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1425
|
+
#
|
1426
|
+
# @example Request syntax with placeholder values
|
1427
|
+
#
|
1428
|
+
# resp = client.disassociate_lex_bot({
|
1429
|
+
# instance_id: "InstanceId", # required
|
1430
|
+
# bot_name: "BotName", # required
|
1431
|
+
# lex_region: "LexRegion", # required
|
1432
|
+
# })
|
1433
|
+
#
|
1434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateLexBot AWS API Documentation
|
1435
|
+
#
|
1436
|
+
# @overload disassociate_lex_bot(params = {})
|
1437
|
+
# @param [Hash] params ({})
|
1438
|
+
def disassociate_lex_bot(params = {}, options = {})
|
1439
|
+
req = build_request(:disassociate_lex_bot, params)
|
1440
|
+
req.send_request(options)
|
1441
|
+
end
|
1442
|
+
|
1443
|
+
# Disassociates a set of queues from a routing profile.
|
1444
|
+
#
|
1445
|
+
# @option params [required, String] :instance_id
|
1446
|
+
# The identifier of the Amazon Connect instance.
|
1447
|
+
#
|
1448
|
+
# @option params [required, String] :routing_profile_id
|
1449
|
+
# The identifier of the routing profile.
|
1450
|
+
#
|
1451
|
+
# @option params [required, Array<Types::RoutingProfileQueueReference>] :queue_references
|
1452
|
+
# The queues to disassociate from this routing profile.
|
1453
|
+
#
|
1454
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1455
|
+
#
|
1456
|
+
# @example Request syntax with placeholder values
|
1457
|
+
#
|
1458
|
+
# resp = client.disassociate_routing_profile_queues({
|
1459
|
+
# instance_id: "InstanceId", # required
|
1460
|
+
# routing_profile_id: "RoutingProfileId", # required
|
1461
|
+
# queue_references: [ # required
|
1462
|
+
# {
|
1463
|
+
# queue_id: "QueueId", # required
|
1464
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
1465
|
+
# },
|
1466
|
+
# ],
|
1467
|
+
# })
|
1468
|
+
#
|
1469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateRoutingProfileQueues AWS API Documentation
|
1470
|
+
#
|
1471
|
+
# @overload disassociate_routing_profile_queues(params = {})
|
1472
|
+
# @param [Hash] params ({})
|
1473
|
+
def disassociate_routing_profile_queues(params = {}, options = {})
|
1474
|
+
req = build_request(:disassociate_routing_profile_queues, params)
|
1475
|
+
req.send_request(options)
|
1476
|
+
end
|
1477
|
+
|
1478
|
+
# Deletes the specified security key.
|
1479
|
+
#
|
1480
|
+
# @option params [required, String] :instance_id
|
1481
|
+
# The identifier of the Amazon Connect instance.
|
1482
|
+
#
|
1483
|
+
# @option params [required, String] :association_id
|
1484
|
+
# The existing association identifier that uniquely identifies the
|
1485
|
+
# resource type and storage config for the given instance ID.
|
1486
|
+
#
|
1487
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1488
|
+
#
|
1489
|
+
# @example Request syntax with placeholder values
|
1490
|
+
#
|
1491
|
+
# resp = client.disassociate_security_key({
|
1492
|
+
# instance_id: "InstanceId", # required
|
1493
|
+
# association_id: "AssociationId", # required
|
1494
|
+
# })
|
1495
|
+
#
|
1496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateSecurityKey AWS API Documentation
|
1497
|
+
#
|
1498
|
+
# @overload disassociate_security_key(params = {})
|
1499
|
+
# @param [Hash] params ({})
|
1500
|
+
def disassociate_security_key(params = {}, options = {})
|
1501
|
+
req = build_request(:disassociate_security_key, params)
|
1502
|
+
req.send_request(options)
|
1503
|
+
end
|
1504
|
+
|
592
1505
|
# Retrieves the contact attributes for the specified contact.
|
593
1506
|
#
|
594
1507
|
# @option params [required, String] :instance_id
|
@@ -625,12 +1538,12 @@ module Aws::Connect
|
|
625
1538
|
# Gets the real-time metric data from the specified Amazon Connect
|
626
1539
|
# instance.
|
627
1540
|
#
|
628
|
-
# For
|
629
|
-
# *Amazon Connect Administrator Guide*.
|
1541
|
+
# For a description of each metric, see [Real-time Metrics
|
1542
|
+
# Definitions][1] in the *Amazon Connect Administrator Guide*.
|
630
1543
|
#
|
631
1544
|
#
|
632
1545
|
#
|
633
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-
|
1546
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
634
1547
|
#
|
635
1548
|
# @option params [required, String] :instance_id
|
636
1549
|
# The identifier of the Amazon Connect instance.
|
@@ -639,79 +1552,126 @@ module Aws::Connect
|
|
639
1552
|
# The queues, up to 100, or channels, to use to filter the metrics
|
640
1553
|
# returned. Metric data is retrieved only for the resources associated
|
641
1554
|
# with the queues or channels included in the filter. You can include
|
642
|
-
# both queue IDs and queue ARNs in the same request.
|
643
|
-
#
|
1555
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
1556
|
+
# `CHAT` channels are supported.
|
644
1557
|
#
|
645
1558
|
# @option params [Array<String>] :groupings
|
646
1559
|
# The grouping applied to the metrics returned. For example, when
|
647
1560
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
648
1561
|
# than aggregated for all queues. If you group by `CHANNEL`, you should
|
649
|
-
# include a Channels filter.
|
1562
|
+
# include a Channels filter. Both `VOICE` and `CHAT` channels are
|
1563
|
+
# supported.
|
650
1564
|
#
|
651
1565
|
# If no `Grouping` is included in the request, a summary of metrics is
|
652
1566
|
# returned.
|
653
1567
|
#
|
654
1568
|
# @option params [required, Array<Types::CurrentMetric>] :current_metrics
|
655
1569
|
# The metrics to retrieve. Specify the name and unit for each metric.
|
656
|
-
# The following metrics are available. For a description of
|
657
|
-
# see [Real-time Metrics Definitions][1] in the *Amazon Connect
|
1570
|
+
# The following metrics are available. For a description of all the
|
1571
|
+
# metrics, see [Real-time Metrics Definitions][1] in the *Amazon Connect
|
658
1572
|
# Administrator Guide*.
|
659
1573
|
#
|
660
1574
|
# AGENTS\_AFTER\_CONTACT\_WORK
|
661
1575
|
#
|
662
1576
|
# : Unit: COUNT
|
663
1577
|
#
|
1578
|
+
# Name in real-time metrics report: [ACW][2]
|
1579
|
+
#
|
664
1580
|
# AGENTS\_AVAILABLE
|
665
1581
|
#
|
666
1582
|
# : Unit: COUNT
|
667
1583
|
#
|
1584
|
+
# Name in real-time metrics report: [Available][3]
|
1585
|
+
#
|
668
1586
|
# AGENTS\_ERROR
|
669
1587
|
#
|
670
1588
|
# : Unit: COUNT
|
671
1589
|
#
|
1590
|
+
# Name in real-time metrics report: [Error][4]
|
1591
|
+
#
|
672
1592
|
# AGENTS\_NON\_PRODUCTIVE
|
673
1593
|
#
|
674
1594
|
# : Unit: COUNT
|
675
1595
|
#
|
1596
|
+
# Name in real-time metrics report: [NPT (Non-Productive Time)][5]
|
1597
|
+
#
|
676
1598
|
# AGENTS\_ON\_CALL
|
677
1599
|
#
|
678
1600
|
# : Unit: COUNT
|
679
1601
|
#
|
1602
|
+
# Name in real-time metrics report: [On contact][6]
|
1603
|
+
#
|
680
1604
|
# AGENTS\_ON\_CONTACT
|
681
1605
|
#
|
682
1606
|
# : Unit: COUNT
|
683
1607
|
#
|
1608
|
+
# Name in real-time metrics report: [On contact][6]
|
1609
|
+
#
|
684
1610
|
# AGENTS\_ONLINE
|
685
1611
|
#
|
686
1612
|
# : Unit: COUNT
|
687
1613
|
#
|
1614
|
+
# Name in real-time metrics report: [Online][7]
|
1615
|
+
#
|
688
1616
|
# AGENTS\_STAFFED
|
689
1617
|
#
|
690
1618
|
# : Unit: COUNT
|
691
1619
|
#
|
1620
|
+
# Name in real-time metrics report: [Staffed][8]
|
1621
|
+
#
|
692
1622
|
# CONTACTS\_IN\_QUEUE
|
693
1623
|
#
|
694
1624
|
# : Unit: COUNT
|
695
1625
|
#
|
1626
|
+
# Name in real-time metrics report: [In queue][9]
|
1627
|
+
#
|
696
1628
|
# CONTACTS\_SCHEDULED
|
697
1629
|
#
|
698
1630
|
# : Unit: COUNT
|
699
1631
|
#
|
1632
|
+
# Name in real-time metrics report: [Scheduled][10]
|
1633
|
+
#
|
700
1634
|
# OLDEST\_CONTACT\_AGE
|
701
1635
|
#
|
702
1636
|
# : Unit: SECONDS
|
703
1637
|
#
|
1638
|
+
# When you use groupings, Unit says SECONDS but the Value is returned
|
1639
|
+
# in MILLISECONDS. For example, if you get a response like this:
|
1640
|
+
#
|
1641
|
+
# `\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" \},
|
1642
|
+
# "Value": 24113.0 `\\}
|
1643
|
+
#
|
1644
|
+
# The actual OLDEST\_CONTACT\_AGE is 24 seconds.
|
1645
|
+
#
|
1646
|
+
# Name in real-time metrics report: [Oldest][11]
|
1647
|
+
#
|
704
1648
|
# SLOTS\_ACTIVE
|
705
1649
|
#
|
706
1650
|
# : Unit: COUNT
|
707
1651
|
#
|
1652
|
+
# Name in real-time metrics report: [Active][12]
|
1653
|
+
#
|
708
1654
|
# SLOTS\_AVAILABLE
|
709
1655
|
#
|
710
1656
|
# : Unit: COUNT
|
711
1657
|
#
|
1658
|
+
# Name in real-time metrics report: [Availability][13]
|
1659
|
+
#
|
712
1660
|
#
|
713
1661
|
#
|
714
1662
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html
|
1663
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time
|
1664
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time
|
1665
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time
|
1666
|
+
# [5]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time
|
1667
|
+
# [6]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time
|
1668
|
+
# [7]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time
|
1669
|
+
# [8]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time
|
1670
|
+
# [9]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time
|
1671
|
+
# [10]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time
|
1672
|
+
# [11]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time
|
1673
|
+
# [12]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time
|
1674
|
+
# [13]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time
|
715
1675
|
#
|
716
1676
|
# @option params [String] :next_token
|
717
1677
|
# The token for the next set of results. Use the value returned in the
|
@@ -808,12 +1768,12 @@ module Aws::Connect
|
|
808
1768
|
# Gets historical metric data from the specified Amazon Connect
|
809
1769
|
# instance.
|
810
1770
|
#
|
811
|
-
# For
|
812
|
-
# *Amazon Connect Administrator Guide*.
|
1771
|
+
# For a description of each historical metric, see [Historical Metrics
|
1772
|
+
# Definitions][1] in the *Amazon Connect Administrator Guide*.
|
813
1773
|
#
|
814
1774
|
#
|
815
1775
|
#
|
816
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics.html
|
1776
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
817
1777
|
#
|
818
1778
|
# @option params [required, String] :instance_id
|
819
1779
|
# The identifier of the Amazon Connect instance.
|
@@ -840,8 +1800,8 @@ module Aws::Connect
|
|
840
1800
|
# The queues, up to 100, or channels, to use to filter the metrics
|
841
1801
|
# returned. Metric data is retrieved only for the resources associated
|
842
1802
|
# with the queues or channels included in the filter. You can include
|
843
|
-
# both queue IDs and queue ARNs in the same request.
|
844
|
-
#
|
1803
|
+
# both queue IDs and queue ARNs in the same request. Both `VOICE` and
|
1804
|
+
# `CHAT` channels are supported.
|
845
1805
|
#
|
846
1806
|
# @option params [Array<String>] :groupings
|
847
1807
|
# The grouping applied to the metrics returned. For example, when
|
@@ -968,55 +1928,388 @@ module Aws::Connect
|
|
968
1928
|
#
|
969
1929
|
# Statistic: AVG
|
970
1930
|
#
|
971
|
-
# HOLD\_TIME
|
1931
|
+
# HOLD\_TIME
|
1932
|
+
#
|
1933
|
+
# : Unit: SECONDS
|
1934
|
+
#
|
1935
|
+
# Statistic: AVG
|
1936
|
+
#
|
1937
|
+
# INTERACTION\_AND\_HOLD\_TIME
|
1938
|
+
#
|
1939
|
+
# : Unit: SECONDS
|
1940
|
+
#
|
1941
|
+
# Statistic: AVG
|
1942
|
+
#
|
1943
|
+
# INTERACTION\_TIME
|
1944
|
+
#
|
1945
|
+
# : Unit: SECONDS
|
1946
|
+
#
|
1947
|
+
# Statistic: AVG
|
1948
|
+
#
|
1949
|
+
# OCCUPANCY
|
1950
|
+
#
|
1951
|
+
# : Unit: PERCENT
|
1952
|
+
#
|
1953
|
+
# Statistic: AVG
|
1954
|
+
#
|
1955
|
+
# QUEUE\_ANSWER\_TIME
|
1956
|
+
#
|
1957
|
+
# : Unit: SECONDS
|
1958
|
+
#
|
1959
|
+
# Statistic: AVG
|
1960
|
+
#
|
1961
|
+
# QUEUED\_TIME
|
1962
|
+
#
|
1963
|
+
# : Unit: SECONDS
|
1964
|
+
#
|
1965
|
+
# Statistic: MAX
|
1966
|
+
#
|
1967
|
+
# SERVICE\_LEVEL
|
1968
|
+
#
|
1969
|
+
# : Unit: PERCENT
|
1970
|
+
#
|
1971
|
+
# Statistic: AVG
|
1972
|
+
#
|
1973
|
+
# Threshold: Only "Less than" comparisons are supported, with the
|
1974
|
+
# following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120,
|
1975
|
+
# 180, 240, 300, 600
|
1976
|
+
#
|
1977
|
+
#
|
1978
|
+
#
|
1979
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
1980
|
+
#
|
1981
|
+
# @option params [String] :next_token
|
1982
|
+
# The token for the next set of results. Use the value returned in the
|
1983
|
+
# previous response in the next request to retrieve the next set of
|
1984
|
+
# results.
|
1985
|
+
#
|
1986
|
+
# @option params [Integer] :max_results
|
1987
|
+
# The maximimum number of results to return per page.
|
1988
|
+
#
|
1989
|
+
# @return [Types::GetMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1990
|
+
#
|
1991
|
+
# * {Types::GetMetricDataResponse#next_token #next_token} => String
|
1992
|
+
# * {Types::GetMetricDataResponse#metric_results #metric_results} => Array<Types::HistoricalMetricResult>
|
1993
|
+
#
|
1994
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1995
|
+
#
|
1996
|
+
# @example Request syntax with placeholder values
|
1997
|
+
#
|
1998
|
+
# resp = client.get_metric_data({
|
1999
|
+
# instance_id: "InstanceId", # required
|
2000
|
+
# start_time: Time.now, # required
|
2001
|
+
# end_time: Time.now, # required
|
2002
|
+
# filters: { # required
|
2003
|
+
# queues: ["QueueId"],
|
2004
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT
|
2005
|
+
# },
|
2006
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
2007
|
+
# historical_metrics: [ # required
|
2008
|
+
# {
|
2009
|
+
# 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
|
2010
|
+
# threshold: {
|
2011
|
+
# comparison: "LT", # accepts LT
|
2012
|
+
# threshold_value: 1.0,
|
2013
|
+
# },
|
2014
|
+
# statistic: "SUM", # accepts SUM, MAX, AVG
|
2015
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
2016
|
+
# },
|
2017
|
+
# ],
|
2018
|
+
# next_token: "NextToken",
|
2019
|
+
# max_results: 1,
|
2020
|
+
# })
|
2021
|
+
#
|
2022
|
+
# @example Response structure
|
2023
|
+
#
|
2024
|
+
# resp.next_token #=> String
|
2025
|
+
# resp.metric_results #=> Array
|
2026
|
+
# resp.metric_results[0].dimensions.queue.id #=> String
|
2027
|
+
# resp.metric_results[0].dimensions.queue.arn #=> String
|
2028
|
+
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
2029
|
+
# resp.metric_results[0].collections #=> Array
|
2030
|
+
# 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"
|
2031
|
+
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
2032
|
+
# resp.metric_results[0].collections[0].metric.threshold.threshold_value #=> Float
|
2033
|
+
# resp.metric_results[0].collections[0].metric.statistic #=> String, one of "SUM", "MAX", "AVG"
|
2034
|
+
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
2035
|
+
# resp.metric_results[0].collections[0].value #=> Float
|
2036
|
+
#
|
2037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricData AWS API Documentation
|
2038
|
+
#
|
2039
|
+
# @overload get_metric_data(params = {})
|
2040
|
+
# @param [Hash] params ({})
|
2041
|
+
def get_metric_data(params = {}, options = {})
|
2042
|
+
req = build_request(:get_metric_data, params)
|
2043
|
+
req.send_request(options)
|
2044
|
+
end
|
2045
|
+
|
2046
|
+
# Returns a paginated list of all approved origins associated with the
|
2047
|
+
# instance.
|
2048
|
+
#
|
2049
|
+
# @option params [required, String] :instance_id
|
2050
|
+
# The identifier of the Amazon Connect instance.
|
2051
|
+
#
|
2052
|
+
# @option params [String] :next_token
|
2053
|
+
# The token for the next set of results. Use the value returned in the
|
2054
|
+
# previous response in the next request to retrieve the next set of
|
2055
|
+
# results.
|
2056
|
+
#
|
2057
|
+
# @option params [Integer] :max_results
|
2058
|
+
# The maximimum number of results to return per page.
|
2059
|
+
#
|
2060
|
+
# @return [Types::ListApprovedOriginsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2061
|
+
#
|
2062
|
+
# * {Types::ListApprovedOriginsResponse#origins #origins} => Array<String>
|
2063
|
+
# * {Types::ListApprovedOriginsResponse#next_token #next_token} => String
|
2064
|
+
#
|
2065
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2066
|
+
#
|
2067
|
+
# @example Request syntax with placeholder values
|
2068
|
+
#
|
2069
|
+
# resp = client.list_approved_origins({
|
2070
|
+
# instance_id: "InstanceId", # required
|
2071
|
+
# next_token: "NextToken",
|
2072
|
+
# max_results: 1,
|
2073
|
+
# })
|
2074
|
+
#
|
2075
|
+
# @example Response structure
|
2076
|
+
#
|
2077
|
+
# resp.origins #=> Array
|
2078
|
+
# resp.origins[0] #=> String
|
2079
|
+
# resp.next_token #=> String
|
2080
|
+
#
|
2081
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListApprovedOrigins AWS API Documentation
|
2082
|
+
#
|
2083
|
+
# @overload list_approved_origins(params = {})
|
2084
|
+
# @param [Hash] params ({})
|
2085
|
+
def list_approved_origins(params = {}, options = {})
|
2086
|
+
req = build_request(:list_approved_origins, params)
|
2087
|
+
req.send_request(options)
|
2088
|
+
end
|
2089
|
+
|
2090
|
+
# Provides information about the contact flows for the specified Amazon
|
2091
|
+
# Connect instance.
|
2092
|
+
#
|
2093
|
+
# You can also create and update contact flows using the [Amazon Connect
|
2094
|
+
# Flow language][1].
|
2095
|
+
#
|
2096
|
+
# For more information about contact flows, see [Contact Flows][2] in
|
2097
|
+
# the *Amazon Connect Administrator Guide*.
|
2098
|
+
#
|
2099
|
+
#
|
2100
|
+
#
|
2101
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
2102
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html
|
2103
|
+
#
|
2104
|
+
# @option params [required, String] :instance_id
|
2105
|
+
# The identifier of the Amazon Connect instance.
|
2106
|
+
#
|
2107
|
+
# @option params [Array<String>] :contact_flow_types
|
2108
|
+
# The type of contact flow.
|
2109
|
+
#
|
2110
|
+
# @option params [String] :next_token
|
2111
|
+
# The token for the next set of results. Use the value returned in the
|
2112
|
+
# previous response in the next request to retrieve the next set of
|
2113
|
+
# results.
|
2114
|
+
#
|
2115
|
+
# @option params [Integer] :max_results
|
2116
|
+
# The maximimum number of results to return per page.
|
2117
|
+
#
|
2118
|
+
# @return [Types::ListContactFlowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2119
|
+
#
|
2120
|
+
# * {Types::ListContactFlowsResponse#contact_flow_summary_list #contact_flow_summary_list} => Array<Types::ContactFlowSummary>
|
2121
|
+
# * {Types::ListContactFlowsResponse#next_token #next_token} => String
|
2122
|
+
#
|
2123
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2124
|
+
#
|
2125
|
+
# @example Request syntax with placeholder values
|
2126
|
+
#
|
2127
|
+
# resp = client.list_contact_flows({
|
2128
|
+
# instance_id: "InstanceId", # required
|
2129
|
+
# contact_flow_types: ["CONTACT_FLOW"], # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
2130
|
+
# next_token: "NextToken",
|
2131
|
+
# max_results: 1,
|
2132
|
+
# })
|
2133
|
+
#
|
2134
|
+
# @example Response structure
|
2135
|
+
#
|
2136
|
+
# resp.contact_flow_summary_list #=> Array
|
2137
|
+
# resp.contact_flow_summary_list[0].id #=> String
|
2138
|
+
# resp.contact_flow_summary_list[0].arn #=> String
|
2139
|
+
# resp.contact_flow_summary_list[0].name #=> String
|
2140
|
+
# 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"
|
2141
|
+
# resp.next_token #=> String
|
2142
|
+
#
|
2143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlows AWS API Documentation
|
2144
|
+
#
|
2145
|
+
# @overload list_contact_flows(params = {})
|
2146
|
+
# @param [Hash] params ({})
|
2147
|
+
def list_contact_flows(params = {}, options = {})
|
2148
|
+
req = build_request(:list_contact_flows, params)
|
2149
|
+
req.send_request(options)
|
2150
|
+
end
|
2151
|
+
|
2152
|
+
# Provides information about the hours of operation for the specified
|
2153
|
+
# Amazon Connect instance.
|
2154
|
+
#
|
2155
|
+
# For more information about hours of operation, see [Set the Hours of
|
2156
|
+
# Operation for a Queue][1] in the *Amazon Connect Administrator Guide*.
|
2157
|
+
#
|
2158
|
+
#
|
2159
|
+
#
|
2160
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html
|
2161
|
+
#
|
2162
|
+
# @option params [required, String] :instance_id
|
2163
|
+
# The identifier of the Amazon Connect instance.
|
2164
|
+
#
|
2165
|
+
# @option params [String] :next_token
|
2166
|
+
# The token for the next set of results. Use the value returned in the
|
2167
|
+
# previous response in the next request to retrieve the next set of
|
2168
|
+
# results.
|
2169
|
+
#
|
2170
|
+
# @option params [Integer] :max_results
|
2171
|
+
# The maximimum number of results to return per page.
|
2172
|
+
#
|
2173
|
+
# @return [Types::ListHoursOfOperationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2174
|
+
#
|
2175
|
+
# * {Types::ListHoursOfOperationsResponse#hours_of_operation_summary_list #hours_of_operation_summary_list} => Array<Types::HoursOfOperationSummary>
|
2176
|
+
# * {Types::ListHoursOfOperationsResponse#next_token #next_token} => String
|
2177
|
+
#
|
2178
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2179
|
+
#
|
2180
|
+
# @example Request syntax with placeholder values
|
2181
|
+
#
|
2182
|
+
# resp = client.list_hours_of_operations({
|
2183
|
+
# instance_id: "InstanceId", # required
|
2184
|
+
# next_token: "NextToken",
|
2185
|
+
# max_results: 1,
|
2186
|
+
# })
|
2187
|
+
#
|
2188
|
+
# @example Response structure
|
2189
|
+
#
|
2190
|
+
# resp.hours_of_operation_summary_list #=> Array
|
2191
|
+
# resp.hours_of_operation_summary_list[0].id #=> String
|
2192
|
+
# resp.hours_of_operation_summary_list[0].arn #=> String
|
2193
|
+
# resp.hours_of_operation_summary_list[0].name #=> String
|
2194
|
+
# resp.next_token #=> String
|
2195
|
+
#
|
2196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperations AWS API Documentation
|
2197
|
+
#
|
2198
|
+
# @overload list_hours_of_operations(params = {})
|
2199
|
+
# @param [Hash] params ({})
|
2200
|
+
def list_hours_of_operations(params = {}, options = {})
|
2201
|
+
req = build_request(:list_hours_of_operations, params)
|
2202
|
+
req.send_request(options)
|
2203
|
+
end
|
2204
|
+
|
2205
|
+
# Returns a paginated list of all attribute types for the given
|
2206
|
+
# instance.
|
2207
|
+
#
|
2208
|
+
# @option params [required, String] :instance_id
|
2209
|
+
# The identifier of the Amazon Connect instance.
|
972
2210
|
#
|
973
|
-
#
|
2211
|
+
# @option params [String] :next_token
|
2212
|
+
# The token for the next set of results. Use the value returned in the
|
2213
|
+
# previous response in the next request to retrieve the next set of
|
2214
|
+
# results.
|
974
2215
|
#
|
975
|
-
#
|
2216
|
+
# @option params [Integer] :max_results
|
2217
|
+
# The maximimum number of results to return per page.
|
976
2218
|
#
|
977
|
-
#
|
2219
|
+
# @return [Types::ListInstanceAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
978
2220
|
#
|
979
|
-
#
|
2221
|
+
# * {Types::ListInstanceAttributesResponse#attributes #attributes} => Array<Types::Attribute>
|
2222
|
+
# * {Types::ListInstanceAttributesResponse#next_token #next_token} => String
|
980
2223
|
#
|
981
|
-
#
|
2224
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
982
2225
|
#
|
983
|
-
#
|
2226
|
+
# @example Request syntax with placeholder values
|
984
2227
|
#
|
985
|
-
#
|
2228
|
+
# resp = client.list_instance_attributes({
|
2229
|
+
# instance_id: "InstanceId", # required
|
2230
|
+
# next_token: "NextToken",
|
2231
|
+
# max_results: 1,
|
2232
|
+
# })
|
986
2233
|
#
|
987
|
-
#
|
2234
|
+
# @example Response structure
|
988
2235
|
#
|
989
|
-
#
|
2236
|
+
# resp.attributes #=> Array
|
2237
|
+
# 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"
|
2238
|
+
# resp.attributes[0].value #=> String
|
2239
|
+
# resp.next_token #=> String
|
990
2240
|
#
|
991
|
-
#
|
2241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceAttributes AWS API Documentation
|
992
2242
|
#
|
993
|
-
#
|
2243
|
+
# @overload list_instance_attributes(params = {})
|
2244
|
+
# @param [Hash] params ({})
|
2245
|
+
def list_instance_attributes(params = {}, options = {})
|
2246
|
+
req = build_request(:list_instance_attributes, params)
|
2247
|
+
req.send_request(options)
|
2248
|
+
end
|
2249
|
+
|
2250
|
+
# Returns a paginated list of storage configs for the identified
|
2251
|
+
# instance and resource type.
|
994
2252
|
#
|
995
|
-
#
|
2253
|
+
# @option params [required, String] :instance_id
|
2254
|
+
# The identifier of the Amazon Connect instance.
|
996
2255
|
#
|
997
|
-
#
|
2256
|
+
# @option params [required, String] :resource_type
|
2257
|
+
# A valid resource type.
|
998
2258
|
#
|
999
|
-
#
|
2259
|
+
# @option params [String] :next_token
|
2260
|
+
# The token for the next set of results. Use the value returned in the
|
2261
|
+
# previous response in the next request to retrieve the next set of
|
2262
|
+
# results.
|
1000
2263
|
#
|
1001
|
-
#
|
2264
|
+
# @option params [Integer] :max_results
|
2265
|
+
# The maximimum number of results to return per page.
|
1002
2266
|
#
|
1003
|
-
#
|
2267
|
+
# @return [Types::ListInstanceStorageConfigsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1004
2268
|
#
|
1005
|
-
#
|
2269
|
+
# * {Types::ListInstanceStorageConfigsResponse#storage_configs #storage_configs} => Array<Types::InstanceStorageConfig>
|
2270
|
+
# * {Types::ListInstanceStorageConfigsResponse#next_token #next_token} => String
|
1006
2271
|
#
|
1007
|
-
#
|
2272
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1008
2273
|
#
|
1009
|
-
#
|
2274
|
+
# @example Request syntax with placeholder values
|
1010
2275
|
#
|
1011
|
-
#
|
2276
|
+
# resp = client.list_instance_storage_configs({
|
2277
|
+
# instance_id: "InstanceId", # required
|
2278
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
2279
|
+
# next_token: "NextToken",
|
2280
|
+
# max_results: 1,
|
2281
|
+
# })
|
1012
2282
|
#
|
1013
|
-
#
|
1014
|
-
# following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120,
|
1015
|
-
# 180, 240, 300, 600
|
2283
|
+
# @example Response structure
|
1016
2284
|
#
|
2285
|
+
# resp.storage_configs #=> Array
|
2286
|
+
# resp.storage_configs[0].association_id #=> String
|
2287
|
+
# resp.storage_configs[0].storage_type #=> String, one of "S3", "KINESIS_VIDEO_STREAM", "KINESIS_STREAM", "KINESIS_FIREHOSE"
|
2288
|
+
# resp.storage_configs[0].s3_config.bucket_name #=> String
|
2289
|
+
# resp.storage_configs[0].s3_config.bucket_prefix #=> String
|
2290
|
+
# resp.storage_configs[0].s3_config.encryption_config.encryption_type #=> String, one of "KMS"
|
2291
|
+
# resp.storage_configs[0].s3_config.encryption_config.key_id #=> String
|
2292
|
+
# resp.storage_configs[0].kinesis_video_stream_config.prefix #=> String
|
2293
|
+
# resp.storage_configs[0].kinesis_video_stream_config.retention_period_hours #=> Integer
|
2294
|
+
# resp.storage_configs[0].kinesis_video_stream_config.encryption_config.encryption_type #=> String, one of "KMS"
|
2295
|
+
# resp.storage_configs[0].kinesis_video_stream_config.encryption_config.key_id #=> String
|
2296
|
+
# resp.storage_configs[0].kinesis_stream_config.stream_arn #=> String
|
2297
|
+
# resp.storage_configs[0].kinesis_firehose_config.firehose_arn #=> String
|
2298
|
+
# resp.next_token #=> String
|
1017
2299
|
#
|
2300
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceStorageConfigs AWS API Documentation
|
1018
2301
|
#
|
1019
|
-
#
|
2302
|
+
# @overload list_instance_storage_configs(params = {})
|
2303
|
+
# @param [Hash] params ({})
|
2304
|
+
def list_instance_storage_configs(params = {}, options = {})
|
2305
|
+
req = build_request(:list_instance_storage_configs, params)
|
2306
|
+
req.send_request(options)
|
2307
|
+
end
|
2308
|
+
|
2309
|
+
# Return a list of instances which are in active state,
|
2310
|
+
# creation-in-progress state, and failed state. Instances that aren't
|
2311
|
+
# successfully created (they are in a failed state) are returned only
|
2312
|
+
# for 24 hours after the CreateInstance API was invoked.
|
1020
2313
|
#
|
1021
2314
|
# @option params [String] :next_token
|
1022
2315
|
# The token for the next set of results. Use the value returned in the
|
@@ -1026,72 +2319,49 @@ module Aws::Connect
|
|
1026
2319
|
# @option params [Integer] :max_results
|
1027
2320
|
# The maximimum number of results to return per page.
|
1028
2321
|
#
|
1029
|
-
# @return [Types::
|
2322
|
+
# @return [Types::ListInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1030
2323
|
#
|
1031
|
-
# * {Types::
|
1032
|
-
# * {Types::
|
2324
|
+
# * {Types::ListInstancesResponse#instance_summary_list #instance_summary_list} => Array<Types::InstanceSummary>
|
2325
|
+
# * {Types::ListInstancesResponse#next_token #next_token} => String
|
1033
2326
|
#
|
1034
2327
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1035
2328
|
#
|
1036
2329
|
# @example Request syntax with placeholder values
|
1037
2330
|
#
|
1038
|
-
# resp = client.
|
1039
|
-
# instance_id: "InstanceId", # required
|
1040
|
-
# start_time: Time.now, # required
|
1041
|
-
# end_time: Time.now, # required
|
1042
|
-
# filters: { # required
|
1043
|
-
# queues: ["QueueId"],
|
1044
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
1045
|
-
# },
|
1046
|
-
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
1047
|
-
# historical_metrics: [ # required
|
1048
|
-
# {
|
1049
|
-
# 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
|
1050
|
-
# threshold: {
|
1051
|
-
# comparison: "LT", # accepts LT
|
1052
|
-
# threshold_value: 1.0,
|
1053
|
-
# },
|
1054
|
-
# statistic: "SUM", # accepts SUM, MAX, AVG
|
1055
|
-
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
1056
|
-
# },
|
1057
|
-
# ],
|
2331
|
+
# resp = client.list_instances({
|
1058
2332
|
# next_token: "NextToken",
|
1059
2333
|
# max_results: 1,
|
1060
2334
|
# })
|
1061
2335
|
#
|
1062
2336
|
# @example Response structure
|
1063
2337
|
#
|
2338
|
+
# resp.instance_summary_list #=> Array
|
2339
|
+
# resp.instance_summary_list[0].id #=> String
|
2340
|
+
# resp.instance_summary_list[0].arn #=> String
|
2341
|
+
# resp.instance_summary_list[0].identity_management_type #=> String, one of "SAML", "CONNECT_MANAGED", "EXISTING_DIRECTORY"
|
2342
|
+
# resp.instance_summary_list[0].instance_alias #=> String
|
2343
|
+
# resp.instance_summary_list[0].created_time #=> Time
|
2344
|
+
# resp.instance_summary_list[0].service_role #=> String
|
2345
|
+
# resp.instance_summary_list[0].instance_status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED"
|
2346
|
+
# resp.instance_summary_list[0].inbound_calls_enabled #=> Boolean
|
2347
|
+
# resp.instance_summary_list[0].outbound_calls_enabled #=> Boolean
|
1064
2348
|
# resp.next_token #=> String
|
1065
|
-
# resp.metric_results #=> Array
|
1066
|
-
# resp.metric_results[0].dimensions.queue.id #=> String
|
1067
|
-
# resp.metric_results[0].dimensions.queue.arn #=> String
|
1068
|
-
# resp.metric_results[0].dimensions.channel #=> String, one of "VOICE", "CHAT"
|
1069
|
-
# resp.metric_results[0].collections #=> Array
|
1070
|
-
# 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"
|
1071
|
-
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
1072
|
-
# resp.metric_results[0].collections[0].metric.threshold.threshold_value #=> Float
|
1073
|
-
# resp.metric_results[0].collections[0].metric.statistic #=> String, one of "SUM", "MAX", "AVG"
|
1074
|
-
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
1075
|
-
# resp.metric_results[0].collections[0].value #=> Float
|
1076
2349
|
#
|
1077
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstances AWS API Documentation
|
1078
2351
|
#
|
1079
|
-
# @overload
|
2352
|
+
# @overload list_instances(params = {})
|
1080
2353
|
# @param [Hash] params ({})
|
1081
|
-
def
|
1082
|
-
req = build_request(:
|
2354
|
+
def list_instances(params = {}, options = {})
|
2355
|
+
req = build_request(:list_instances, params)
|
1083
2356
|
req.send_request(options)
|
1084
2357
|
end
|
1085
2358
|
|
1086
|
-
#
|
1087
|
-
#
|
2359
|
+
# Returns a paginated list of all the Lambda functions that show up in
|
2360
|
+
# the drop-down options in the relevant contact flow blocks.
|
1088
2361
|
#
|
1089
2362
|
# @option params [required, String] :instance_id
|
1090
2363
|
# The identifier of the Amazon Connect instance.
|
1091
2364
|
#
|
1092
|
-
# @option params [Array<String>] :contact_flow_types
|
1093
|
-
# The type of contact flow.
|
1094
|
-
#
|
1095
2365
|
# @option params [String] :next_token
|
1096
2366
|
# The token for the next set of results. Use the value returned in the
|
1097
2367
|
# previous response in the next request to retrieve the next set of
|
@@ -1100,42 +2370,38 @@ module Aws::Connect
|
|
1100
2370
|
# @option params [Integer] :max_results
|
1101
2371
|
# The maximimum number of results to return per page.
|
1102
2372
|
#
|
1103
|
-
# @return [Types::
|
2373
|
+
# @return [Types::ListLambdaFunctionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1104
2374
|
#
|
1105
|
-
# * {Types::
|
1106
|
-
# * {Types::
|
2375
|
+
# * {Types::ListLambdaFunctionsResponse#lambda_functions #lambda_functions} => Array<String>
|
2376
|
+
# * {Types::ListLambdaFunctionsResponse#next_token #next_token} => String
|
1107
2377
|
#
|
1108
2378
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1109
2379
|
#
|
1110
2380
|
# @example Request syntax with placeholder values
|
1111
2381
|
#
|
1112
|
-
# resp = client.
|
2382
|
+
# resp = client.list_lambda_functions({
|
1113
2383
|
# instance_id: "InstanceId", # required
|
1114
|
-
# contact_flow_types: ["CONTACT_FLOW"], # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
1115
2384
|
# next_token: "NextToken",
|
1116
2385
|
# max_results: 1,
|
1117
2386
|
# })
|
1118
2387
|
#
|
1119
2388
|
# @example Response structure
|
1120
2389
|
#
|
1121
|
-
# resp.
|
1122
|
-
# resp.
|
1123
|
-
# resp.contact_flow_summary_list[0].arn #=> String
|
1124
|
-
# resp.contact_flow_summary_list[0].name #=> String
|
1125
|
-
# 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"
|
2390
|
+
# resp.lambda_functions #=> Array
|
2391
|
+
# resp.lambda_functions[0] #=> String
|
1126
2392
|
# resp.next_token #=> String
|
1127
2393
|
#
|
1128
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLambdaFunctions AWS API Documentation
|
1129
2395
|
#
|
1130
|
-
# @overload
|
2396
|
+
# @overload list_lambda_functions(params = {})
|
1131
2397
|
# @param [Hash] params ({})
|
1132
|
-
def
|
1133
|
-
req = build_request(:
|
2398
|
+
def list_lambda_functions(params = {}, options = {})
|
2399
|
+
req = build_request(:list_lambda_functions, params)
|
1134
2400
|
req.send_request(options)
|
1135
2401
|
end
|
1136
2402
|
|
1137
|
-
#
|
1138
|
-
#
|
2403
|
+
# Returns a paginated list of all the Amazon Lex bots currently
|
2404
|
+
# associated with the instance.
|
1139
2405
|
#
|
1140
2406
|
# @option params [required, String] :instance_id
|
1141
2407
|
# The identifier of the Amazon Connect instance.
|
@@ -1148,16 +2414,16 @@ module Aws::Connect
|
|
1148
2414
|
# @option params [Integer] :max_results
|
1149
2415
|
# The maximimum number of results to return per page.
|
1150
2416
|
#
|
1151
|
-
# @return [Types::
|
2417
|
+
# @return [Types::ListLexBotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1152
2418
|
#
|
1153
|
-
# * {Types::
|
1154
|
-
# * {Types::
|
2419
|
+
# * {Types::ListLexBotsResponse#lex_bots #lex_bots} => Array<Types::LexBot>
|
2420
|
+
# * {Types::ListLexBotsResponse#next_token #next_token} => String
|
1155
2421
|
#
|
1156
2422
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1157
2423
|
#
|
1158
2424
|
# @example Request syntax with placeholder values
|
1159
2425
|
#
|
1160
|
-
# resp = client.
|
2426
|
+
# resp = client.list_lex_bots({
|
1161
2427
|
# instance_id: "InstanceId", # required
|
1162
2428
|
# next_token: "NextToken",
|
1163
2429
|
# max_results: 1,
|
@@ -1165,24 +2431,31 @@ module Aws::Connect
|
|
1165
2431
|
#
|
1166
2432
|
# @example Response structure
|
1167
2433
|
#
|
1168
|
-
# resp.
|
1169
|
-
# resp.
|
1170
|
-
# resp.
|
1171
|
-
# resp.hours_of_operation_summary_list[0].name #=> String
|
2434
|
+
# resp.lex_bots #=> Array
|
2435
|
+
# resp.lex_bots[0].name #=> String
|
2436
|
+
# resp.lex_bots[0].lex_region #=> String
|
1172
2437
|
# resp.next_token #=> String
|
1173
2438
|
#
|
1174
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLexBots AWS API Documentation
|
1175
2440
|
#
|
1176
|
-
# @overload
|
2441
|
+
# @overload list_lex_bots(params = {})
|
1177
2442
|
# @param [Hash] params ({})
|
1178
|
-
def
|
1179
|
-
req = build_request(:
|
2443
|
+
def list_lex_bots(params = {}, options = {})
|
2444
|
+
req = build_request(:list_lex_bots, params)
|
1180
2445
|
req.send_request(options)
|
1181
2446
|
end
|
1182
2447
|
|
1183
2448
|
# Provides information about the phone numbers for the specified Amazon
|
1184
2449
|
# Connect instance.
|
1185
2450
|
#
|
2451
|
+
# For more information about phone numbers, see [Set Up Phone Numbers
|
2452
|
+
# for Your Contact Center][1] in the *Amazon Connect Administrator
|
2453
|
+
# Guide*.
|
2454
|
+
#
|
2455
|
+
#
|
2456
|
+
#
|
2457
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
|
2458
|
+
#
|
1186
2459
|
# @option params [required, String] :instance_id
|
1187
2460
|
# The identifier of the Amazon Connect instance.
|
1188
2461
|
#
|
@@ -1236,9 +2509,62 @@ module Aws::Connect
|
|
1236
2509
|
req.send_request(options)
|
1237
2510
|
end
|
1238
2511
|
|
2512
|
+
# Provides information about the prompts for the specified Amazon
|
2513
|
+
# Connect instance.
|
2514
|
+
#
|
2515
|
+
# @option params [required, String] :instance_id
|
2516
|
+
# The identifier of the Amazon Connect instance.
|
2517
|
+
#
|
2518
|
+
# @option params [String] :next_token
|
2519
|
+
# The token for the next set of results. Use the value returned in the
|
2520
|
+
# previous response in the next request to retrieve the next set of
|
2521
|
+
# results.
|
2522
|
+
#
|
2523
|
+
# @option params [Integer] :max_results
|
2524
|
+
# The maximum number of results to return per page.
|
2525
|
+
#
|
2526
|
+
# @return [Types::ListPromptsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2527
|
+
#
|
2528
|
+
# * {Types::ListPromptsResponse#prompt_summary_list #prompt_summary_list} => Array<Types::PromptSummary>
|
2529
|
+
# * {Types::ListPromptsResponse#next_token #next_token} => String
|
2530
|
+
#
|
2531
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2532
|
+
#
|
2533
|
+
# @example Request syntax with placeholder values
|
2534
|
+
#
|
2535
|
+
# resp = client.list_prompts({
|
2536
|
+
# instance_id: "InstanceId", # required
|
2537
|
+
# next_token: "NextToken",
|
2538
|
+
# max_results: 1,
|
2539
|
+
# })
|
2540
|
+
#
|
2541
|
+
# @example Response structure
|
2542
|
+
#
|
2543
|
+
# resp.prompt_summary_list #=> Array
|
2544
|
+
# resp.prompt_summary_list[0].id #=> String
|
2545
|
+
# resp.prompt_summary_list[0].arn #=> String
|
2546
|
+
# resp.prompt_summary_list[0].name #=> String
|
2547
|
+
# resp.next_token #=> String
|
2548
|
+
#
|
2549
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPrompts AWS API Documentation
|
2550
|
+
#
|
2551
|
+
# @overload list_prompts(params = {})
|
2552
|
+
# @param [Hash] params ({})
|
2553
|
+
def list_prompts(params = {}, options = {})
|
2554
|
+
req = build_request(:list_prompts, params)
|
2555
|
+
req.send_request(options)
|
2556
|
+
end
|
2557
|
+
|
1239
2558
|
# Provides information about the queues for the specified Amazon Connect
|
1240
2559
|
# instance.
|
1241
2560
|
#
|
2561
|
+
# For more information about queues, see [Queues: Standard and Agent][1]
|
2562
|
+
# in the *Amazon Connect Administrator Guide*.
|
2563
|
+
#
|
2564
|
+
#
|
2565
|
+
#
|
2566
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html
|
2567
|
+
#
|
1242
2568
|
# @option params [required, String] :instance_id
|
1243
2569
|
# The identifier of the Amazon Connect instance.
|
1244
2570
|
#
|
@@ -1287,9 +2613,70 @@ module Aws::Connect
|
|
1287
2613
|
req.send_request(options)
|
1288
2614
|
end
|
1289
2615
|
|
2616
|
+
# List the queues associated with a routing profile.
|
2617
|
+
#
|
2618
|
+
# @option params [required, String] :instance_id
|
2619
|
+
# The identifier of the Amazon Connect instance.
|
2620
|
+
#
|
2621
|
+
# @option params [required, String] :routing_profile_id
|
2622
|
+
# The identifier of the routing profile.
|
2623
|
+
#
|
2624
|
+
# @option params [String] :next_token
|
2625
|
+
# The token for the next set of results. Use the value returned in the
|
2626
|
+
# previous response in the next request to retrieve the next set of
|
2627
|
+
# results.
|
2628
|
+
#
|
2629
|
+
# @option params [Integer] :max_results
|
2630
|
+
# The maximimum number of results to return per page.
|
2631
|
+
#
|
2632
|
+
# @return [Types::ListRoutingProfileQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2633
|
+
#
|
2634
|
+
# * {Types::ListRoutingProfileQueuesResponse#next_token #next_token} => String
|
2635
|
+
# * {Types::ListRoutingProfileQueuesResponse#routing_profile_queue_config_summary_list #routing_profile_queue_config_summary_list} => Array<Types::RoutingProfileQueueConfigSummary>
|
2636
|
+
#
|
2637
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2638
|
+
#
|
2639
|
+
# @example Request syntax with placeholder values
|
2640
|
+
#
|
2641
|
+
# resp = client.list_routing_profile_queues({
|
2642
|
+
# instance_id: "InstanceId", # required
|
2643
|
+
# routing_profile_id: "RoutingProfileId", # required
|
2644
|
+
# next_token: "NextToken",
|
2645
|
+
# max_results: 1,
|
2646
|
+
# })
|
2647
|
+
#
|
2648
|
+
# @example Response structure
|
2649
|
+
#
|
2650
|
+
# resp.next_token #=> String
|
2651
|
+
# resp.routing_profile_queue_config_summary_list #=> Array
|
2652
|
+
# resp.routing_profile_queue_config_summary_list[0].queue_id #=> String
|
2653
|
+
# resp.routing_profile_queue_config_summary_list[0].queue_arn #=> String
|
2654
|
+
# resp.routing_profile_queue_config_summary_list[0].queue_name #=> String
|
2655
|
+
# resp.routing_profile_queue_config_summary_list[0].priority #=> Integer
|
2656
|
+
# resp.routing_profile_queue_config_summary_list[0].delay #=> Integer
|
2657
|
+
# resp.routing_profile_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT"
|
2658
|
+
#
|
2659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueues AWS API Documentation
|
2660
|
+
#
|
2661
|
+
# @overload list_routing_profile_queues(params = {})
|
2662
|
+
# @param [Hash] params ({})
|
2663
|
+
def list_routing_profile_queues(params = {}, options = {})
|
2664
|
+
req = build_request(:list_routing_profile_queues, params)
|
2665
|
+
req.send_request(options)
|
2666
|
+
end
|
2667
|
+
|
1290
2668
|
# Provides summary information about the routing profiles for the
|
1291
2669
|
# specified Amazon Connect instance.
|
1292
2670
|
#
|
2671
|
+
# For more information about routing profiles, see [Routing Profiles][1]
|
2672
|
+
# and [Create a Routing Profile][2] in the *Amazon Connect Administrator
|
2673
|
+
# Guide*.
|
2674
|
+
#
|
2675
|
+
#
|
2676
|
+
#
|
2677
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html
|
2678
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html
|
2679
|
+
#
|
1293
2680
|
# @option params [required, String] :instance_id
|
1294
2681
|
# The identifier of the Amazon Connect instance.
|
1295
2682
|
#
|
@@ -1333,9 +2720,62 @@ module Aws::Connect
|
|
1333
2720
|
req.send_request(options)
|
1334
2721
|
end
|
1335
2722
|
|
2723
|
+
# Returns a paginated list of all security keys associated with the
|
2724
|
+
# instance.
|
2725
|
+
#
|
2726
|
+
# @option params [required, String] :instance_id
|
2727
|
+
# The identifier of the Amazon Connect instance.
|
2728
|
+
#
|
2729
|
+
# @option params [String] :next_token
|
2730
|
+
# The token for the next set of results. Use the value returned in the
|
2731
|
+
# previous response in the next request to retrieve the next set of
|
2732
|
+
# results.
|
2733
|
+
#
|
2734
|
+
# @option params [Integer] :max_results
|
2735
|
+
# The maximimum number of results to return per page.
|
2736
|
+
#
|
2737
|
+
# @return [Types::ListSecurityKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2738
|
+
#
|
2739
|
+
# * {Types::ListSecurityKeysResponse#security_keys #security_keys} => Array<Types::SecurityKey>
|
2740
|
+
# * {Types::ListSecurityKeysResponse#next_token #next_token} => String
|
2741
|
+
#
|
2742
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2743
|
+
#
|
2744
|
+
# @example Request syntax with placeholder values
|
2745
|
+
#
|
2746
|
+
# resp = client.list_security_keys({
|
2747
|
+
# instance_id: "InstanceId", # required
|
2748
|
+
# next_token: "NextToken",
|
2749
|
+
# max_results: 1,
|
2750
|
+
# })
|
2751
|
+
#
|
2752
|
+
# @example Response structure
|
2753
|
+
#
|
2754
|
+
# resp.security_keys #=> Array
|
2755
|
+
# resp.security_keys[0].association_id #=> String
|
2756
|
+
# resp.security_keys[0].key #=> String
|
2757
|
+
# resp.security_keys[0].creation_time #=> Time
|
2758
|
+
# resp.next_token #=> String
|
2759
|
+
#
|
2760
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityKeys AWS API Documentation
|
2761
|
+
#
|
2762
|
+
# @overload list_security_keys(params = {})
|
2763
|
+
# @param [Hash] params ({})
|
2764
|
+
def list_security_keys(params = {}, options = {})
|
2765
|
+
req = build_request(:list_security_keys, params)
|
2766
|
+
req.send_request(options)
|
2767
|
+
end
|
2768
|
+
|
1336
2769
|
# Provides summary information about the security profiles for the
|
1337
2770
|
# specified Amazon Connect instance.
|
1338
2771
|
#
|
2772
|
+
# For more information about security profiles, see [Security
|
2773
|
+
# Profiles][1] in the *Amazon Connect Administrator Guide*.
|
2774
|
+
#
|
2775
|
+
#
|
2776
|
+
#
|
2777
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
|
2778
|
+
#
|
1339
2779
|
# @option params [required, String] :instance_id
|
1340
2780
|
# The identifier of the Amazon Connect instance.
|
1341
2781
|
#
|
@@ -1381,6 +2821,13 @@ module Aws::Connect
|
|
1381
2821
|
|
1382
2822
|
# Lists the tags for the specified resource.
|
1383
2823
|
#
|
2824
|
+
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
2825
|
+
# Policy Examples][1] in the *Amazon Connect Administrator Guide*.
|
2826
|
+
#
|
2827
|
+
#
|
2828
|
+
#
|
2829
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
|
2830
|
+
#
|
1384
2831
|
# @option params [required, String] :resource_arn
|
1385
2832
|
# The Amazon Resource Name (ARN) of the resource.
|
1386
2833
|
#
|
@@ -1411,6 +2858,13 @@ module Aws::Connect
|
|
1411
2858
|
# Provides summary information about the hierarchy groups for the
|
1412
2859
|
# specified Amazon Connect instance.
|
1413
2860
|
#
|
2861
|
+
# For more information about agent hierarchies, see [Set Up Agent
|
2862
|
+
# Hierarchies][1] in the *Amazon Connect Administrator Guide*.
|
2863
|
+
#
|
2864
|
+
#
|
2865
|
+
#
|
2866
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html
|
2867
|
+
#
|
1414
2868
|
# @option params [required, String] :instance_id
|
1415
2869
|
# The identifier of the Amazon Connect instance.
|
1416
2870
|
#
|
@@ -1545,15 +2999,35 @@ module Aws::Connect
|
|
1545
2999
|
# [CreateParticipantConnection][1] with WEBSOCKET and
|
1546
3000
|
# CONNECTION\_CREDENTIALS.
|
1547
3001
|
#
|
3002
|
+
# A 429 error occurs in two situations:
|
3003
|
+
#
|
3004
|
+
# * API rate limit is exceeded. API TPS throttling returns a
|
3005
|
+
# `TooManyRequests` exception from the API Gateway.
|
3006
|
+
#
|
3007
|
+
# * The [quota for concurrent active chats][2] is exceeded. Active chat
|
3008
|
+
# throttling returns a `LimitExceededException`.
|
3009
|
+
#
|
3010
|
+
# For more information about how chat works, see [Chat][3] in the
|
3011
|
+
# *Amazon Connect Administrator Guide*.
|
3012
|
+
#
|
1548
3013
|
#
|
1549
3014
|
#
|
1550
3015
|
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
3016
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
3017
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/chat.html
|
1551
3018
|
#
|
1552
3019
|
# @option params [required, String] :instance_id
|
1553
3020
|
# The identifier of the Amazon Connect instance.
|
1554
3021
|
#
|
1555
3022
|
# @option params [required, String] :contact_flow_id
|
1556
|
-
# The identifier of the contact flow for the chat.
|
3023
|
+
# The identifier of the contact flow for initiating the chat. To see the
|
3024
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
3025
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
3026
|
+
# contact flow. On the contact flow page, under the name of the contact
|
3027
|
+
# flow, choose **Show additional flow information**. The ContactFlowId
|
3028
|
+
# is the last part of the ARN, shown here in bold:
|
3029
|
+
#
|
3030
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
1557
3031
|
#
|
1558
3032
|
# @option params [Hash<String,String>] :attributes
|
1559
3033
|
# A custom key-value pair using an attribute map. The attributes are
|
@@ -1680,11 +3154,29 @@ module Aws::Connect
|
|
1680
3154
|
# There is a 60 second dialing timeout for this operation. If the call
|
1681
3155
|
# is not connected after 60 seconds, it fails.
|
1682
3156
|
#
|
3157
|
+
# <note markdown="1"> UK numbers with a 447 prefix are not allowed by default. Before you
|
3158
|
+
# can dial these UK mobile numbers, you must submit a service quota
|
3159
|
+
# increase request. For more information, see [Amazon Connect Service
|
3160
|
+
# Quotas][1] in the *Amazon Connect Administrator Guide*.
|
3161
|
+
#
|
3162
|
+
# </note>
|
3163
|
+
#
|
3164
|
+
#
|
3165
|
+
#
|
3166
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
3167
|
+
#
|
1683
3168
|
# @option params [required, String] :destination_phone_number
|
1684
3169
|
# The phone number of the customer, in E.164 format.
|
1685
3170
|
#
|
1686
3171
|
# @option params [required, String] :contact_flow_id
|
1687
|
-
# The identifier of the contact flow for the outbound call.
|
3172
|
+
# The identifier of the contact flow for the outbound call. To see the
|
3173
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
3174
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
3175
|
+
# contact flow. On the contact flow page, under the name of the contact
|
3176
|
+
# flow, choose **Show additional flow information**. The ContactFlowId
|
3177
|
+
# is the last part of the ARN, shown here in bold:
|
3178
|
+
#
|
3179
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
1688
3180
|
#
|
1689
3181
|
# @option params [required, String] :instance_id
|
1690
3182
|
# The identifier of the Amazon Connect instance.
|
@@ -1855,7 +3347,15 @@ module Aws::Connect
|
|
1855
3347
|
|
1856
3348
|
# Adds the specified tags to the specified resource.
|
1857
3349
|
#
|
1858
|
-
# The supported resource
|
3350
|
+
# The supported resource types are users, routing profiles, and contact
|
3351
|
+
# flows.
|
3352
|
+
#
|
3353
|
+
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
3354
|
+
# Policy Examples][1] in the *Amazon Connect Administrator Guide*.
|
3355
|
+
#
|
3356
|
+
#
|
3357
|
+
#
|
3358
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
|
1859
3359
|
#
|
1860
3360
|
# @option params [required, String] :resource_arn
|
1861
3361
|
# The Amazon Resource Name (ARN) of the resource.
|
@@ -1970,6 +3470,324 @@ module Aws::Connect
|
|
1970
3470
|
req.send_request(options)
|
1971
3471
|
end
|
1972
3472
|
|
3473
|
+
# Updates the specified contact flow.
|
3474
|
+
#
|
3475
|
+
# You can also create and update contact flows using the [Amazon Connect
|
3476
|
+
# Flow language][1].
|
3477
|
+
#
|
3478
|
+
#
|
3479
|
+
#
|
3480
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
3481
|
+
#
|
3482
|
+
# @option params [required, String] :instance_id
|
3483
|
+
# The identifier of the Amazon Connect instance.
|
3484
|
+
#
|
3485
|
+
# @option params [required, String] :contact_flow_id
|
3486
|
+
# The identifier of the contact flow.
|
3487
|
+
#
|
3488
|
+
# @option params [required, String] :content
|
3489
|
+
# The JSON string that represents contact flow’s content. For an
|
3490
|
+
# example, see [Example contact flow in Amazon Connect Flow language][1]
|
3491
|
+
# in the *Amazon Connect Administrator Guide*.
|
3492
|
+
#
|
3493
|
+
#
|
3494
|
+
#
|
3495
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language-example.html
|
3496
|
+
#
|
3497
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3498
|
+
#
|
3499
|
+
# @example Request syntax with placeholder values
|
3500
|
+
#
|
3501
|
+
# resp = client.update_contact_flow_content({
|
3502
|
+
# instance_id: "InstanceId", # required
|
3503
|
+
# contact_flow_id: "ContactFlowId", # required
|
3504
|
+
# content: "ContactFlowContent", # required
|
3505
|
+
# })
|
3506
|
+
#
|
3507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowContent AWS API Documentation
|
3508
|
+
#
|
3509
|
+
# @overload update_contact_flow_content(params = {})
|
3510
|
+
# @param [Hash] params ({})
|
3511
|
+
def update_contact_flow_content(params = {}, options = {})
|
3512
|
+
req = build_request(:update_contact_flow_content, params)
|
3513
|
+
req.send_request(options)
|
3514
|
+
end
|
3515
|
+
|
3516
|
+
# The name of the contact flow.
|
3517
|
+
#
|
3518
|
+
# You can also create and update contact flows using the [Amazon Connect
|
3519
|
+
# Flow language][1].
|
3520
|
+
#
|
3521
|
+
#
|
3522
|
+
#
|
3523
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
3524
|
+
#
|
3525
|
+
# @option params [required, String] :instance_id
|
3526
|
+
# The identifier of the Amazon Connect instance.
|
3527
|
+
#
|
3528
|
+
# @option params [required, String] :contact_flow_id
|
3529
|
+
# The identifier of the contact flow.
|
3530
|
+
#
|
3531
|
+
# @option params [String] :name
|
3532
|
+
# The name of the contact flow.
|
3533
|
+
#
|
3534
|
+
# @option params [String] :description
|
3535
|
+
# The description of the contact flow.
|
3536
|
+
#
|
3537
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3538
|
+
#
|
3539
|
+
# @example Request syntax with placeholder values
|
3540
|
+
#
|
3541
|
+
# resp = client.update_contact_flow_name({
|
3542
|
+
# instance_id: "InstanceId", # required
|
3543
|
+
# contact_flow_id: "ContactFlowId", # required
|
3544
|
+
# name: "ContactFlowName",
|
3545
|
+
# description: "ContactFlowDescription",
|
3546
|
+
# })
|
3547
|
+
#
|
3548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowName AWS API Documentation
|
3549
|
+
#
|
3550
|
+
# @overload update_contact_flow_name(params = {})
|
3551
|
+
# @param [Hash] params ({})
|
3552
|
+
def update_contact_flow_name(params = {}, options = {})
|
3553
|
+
req = build_request(:update_contact_flow_name, params)
|
3554
|
+
req.send_request(options)
|
3555
|
+
end
|
3556
|
+
|
3557
|
+
# Updates the value for the specified attribute type.
|
3558
|
+
#
|
3559
|
+
# @option params [required, String] :instance_id
|
3560
|
+
# The identifier of the Amazon Connect instance.
|
3561
|
+
#
|
3562
|
+
# @option params [required, String] :attribute_type
|
3563
|
+
# The type of attribute.
|
3564
|
+
#
|
3565
|
+
# @option params [required, String] :value
|
3566
|
+
# The value for the attribute. Maximum character limit is 100.
|
3567
|
+
#
|
3568
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3569
|
+
#
|
3570
|
+
# @example Request syntax with placeholder values
|
3571
|
+
#
|
3572
|
+
# resp = client.update_instance_attribute({
|
3573
|
+
# instance_id: "InstanceId", # required
|
3574
|
+
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA
|
3575
|
+
# value: "InstanceAttributeValue", # required
|
3576
|
+
# })
|
3577
|
+
#
|
3578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateInstanceAttribute AWS API Documentation
|
3579
|
+
#
|
3580
|
+
# @overload update_instance_attribute(params = {})
|
3581
|
+
# @param [Hash] params ({})
|
3582
|
+
def update_instance_attribute(params = {}, options = {})
|
3583
|
+
req = build_request(:update_instance_attribute, params)
|
3584
|
+
req.send_request(options)
|
3585
|
+
end
|
3586
|
+
|
3587
|
+
# Updates an existing configuration for a resource type. This API is
|
3588
|
+
# idempotent.
|
3589
|
+
#
|
3590
|
+
# @option params [required, String] :instance_id
|
3591
|
+
# The identifier of the Amazon Connect instance.
|
3592
|
+
#
|
3593
|
+
# @option params [required, String] :association_id
|
3594
|
+
# The existing association identifier that uniquely identifies the
|
3595
|
+
# resource type and storage config for the given instance ID.
|
3596
|
+
#
|
3597
|
+
# @option params [required, String] :resource_type
|
3598
|
+
# A valid resource type.
|
3599
|
+
#
|
3600
|
+
# @option params [required, Types::InstanceStorageConfig] :storage_config
|
3601
|
+
# The storage configuration for the instance.
|
3602
|
+
#
|
3603
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3604
|
+
#
|
3605
|
+
# @example Request syntax with placeholder values
|
3606
|
+
#
|
3607
|
+
# resp = client.update_instance_storage_config({
|
3608
|
+
# instance_id: "InstanceId", # required
|
3609
|
+
# association_id: "AssociationId", # required
|
3610
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
3611
|
+
# storage_config: { # required
|
3612
|
+
# association_id: "AssociationId",
|
3613
|
+
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
3614
|
+
# s3_config: {
|
3615
|
+
# bucket_name: "BucketName", # required
|
3616
|
+
# bucket_prefix: "Prefix", # required
|
3617
|
+
# encryption_config: {
|
3618
|
+
# encryption_type: "KMS", # required, accepts KMS
|
3619
|
+
# key_id: "KeyId", # required
|
3620
|
+
# },
|
3621
|
+
# },
|
3622
|
+
# kinesis_video_stream_config: {
|
3623
|
+
# prefix: "Prefix", # required
|
3624
|
+
# retention_period_hours: 1, # required
|
3625
|
+
# encryption_config: { # required
|
3626
|
+
# encryption_type: "KMS", # required, accepts KMS
|
3627
|
+
# key_id: "KeyId", # required
|
3628
|
+
# },
|
3629
|
+
# },
|
3630
|
+
# kinesis_stream_config: {
|
3631
|
+
# stream_arn: "ARN", # required
|
3632
|
+
# },
|
3633
|
+
# kinesis_firehose_config: {
|
3634
|
+
# firehose_arn: "ARN", # required
|
3635
|
+
# },
|
3636
|
+
# },
|
3637
|
+
# })
|
3638
|
+
#
|
3639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateInstanceStorageConfig AWS API Documentation
|
3640
|
+
#
|
3641
|
+
# @overload update_instance_storage_config(params = {})
|
3642
|
+
# @param [Hash] params ({})
|
3643
|
+
def update_instance_storage_config(params = {}, options = {})
|
3644
|
+
req = build_request(:update_instance_storage_config, params)
|
3645
|
+
req.send_request(options)
|
3646
|
+
end
|
3647
|
+
|
3648
|
+
# Updates the channels that agents can handle in the Contact Control
|
3649
|
+
# Panel (CCP) for a routing profile.
|
3650
|
+
#
|
3651
|
+
# @option params [required, String] :instance_id
|
3652
|
+
# The identifier of the Amazon Connect instance.
|
3653
|
+
#
|
3654
|
+
# @option params [required, String] :routing_profile_id
|
3655
|
+
# The identifier of the routing profile.
|
3656
|
+
#
|
3657
|
+
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
3658
|
+
# The channels agents can handle in the Contact Control Panel (CCP).
|
3659
|
+
#
|
3660
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3661
|
+
#
|
3662
|
+
# @example Request syntax with placeholder values
|
3663
|
+
#
|
3664
|
+
# resp = client.update_routing_profile_concurrency({
|
3665
|
+
# instance_id: "InstanceId", # required
|
3666
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3667
|
+
# media_concurrencies: [ # required
|
3668
|
+
# {
|
3669
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
3670
|
+
# concurrency: 1, # required
|
3671
|
+
# },
|
3672
|
+
# ],
|
3673
|
+
# })
|
3674
|
+
#
|
3675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileConcurrency AWS API Documentation
|
3676
|
+
#
|
3677
|
+
# @overload update_routing_profile_concurrency(params = {})
|
3678
|
+
# @param [Hash] params ({})
|
3679
|
+
def update_routing_profile_concurrency(params = {}, options = {})
|
3680
|
+
req = build_request(:update_routing_profile_concurrency, params)
|
3681
|
+
req.send_request(options)
|
3682
|
+
end
|
3683
|
+
|
3684
|
+
# Updates the default outbound queue of a routing profile.
|
3685
|
+
#
|
3686
|
+
# @option params [required, String] :instance_id
|
3687
|
+
# The identifier of the Amazon Connect instance.
|
3688
|
+
#
|
3689
|
+
# @option params [required, String] :routing_profile_id
|
3690
|
+
# The identifier of the routing profile.
|
3691
|
+
#
|
3692
|
+
# @option params [required, String] :default_outbound_queue_id
|
3693
|
+
# The identifier for the default outbound queue.
|
3694
|
+
#
|
3695
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3696
|
+
#
|
3697
|
+
# @example Request syntax with placeholder values
|
3698
|
+
#
|
3699
|
+
# resp = client.update_routing_profile_default_outbound_queue({
|
3700
|
+
# instance_id: "InstanceId", # required
|
3701
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3702
|
+
# default_outbound_queue_id: "QueueId", # required
|
3703
|
+
# })
|
3704
|
+
#
|
3705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue AWS API Documentation
|
3706
|
+
#
|
3707
|
+
# @overload update_routing_profile_default_outbound_queue(params = {})
|
3708
|
+
# @param [Hash] params ({})
|
3709
|
+
def update_routing_profile_default_outbound_queue(params = {}, options = {})
|
3710
|
+
req = build_request(:update_routing_profile_default_outbound_queue, params)
|
3711
|
+
req.send_request(options)
|
3712
|
+
end
|
3713
|
+
|
3714
|
+
# Updates the name and description of a routing profile. The request
|
3715
|
+
# accepts the following data in JSON format. At least `Name` or
|
3716
|
+
# `Description` must be provided.
|
3717
|
+
#
|
3718
|
+
# @option params [required, String] :instance_id
|
3719
|
+
# The identifier of the Amazon Connect instance.
|
3720
|
+
#
|
3721
|
+
# @option params [required, String] :routing_profile_id
|
3722
|
+
# The identifier of the routing profile.
|
3723
|
+
#
|
3724
|
+
# @option params [String] :name
|
3725
|
+
# The name of the routing profile. Must not be more than 127 characters.
|
3726
|
+
#
|
3727
|
+
# @option params [String] :description
|
3728
|
+
# The description of the routing profile. Must not be more than 250
|
3729
|
+
# characters.
|
3730
|
+
#
|
3731
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3732
|
+
#
|
3733
|
+
# @example Request syntax with placeholder values
|
3734
|
+
#
|
3735
|
+
# resp = client.update_routing_profile_name({
|
3736
|
+
# instance_id: "InstanceId", # required
|
3737
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3738
|
+
# name: "RoutingProfileName",
|
3739
|
+
# description: "RoutingProfileDescription",
|
3740
|
+
# })
|
3741
|
+
#
|
3742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileName AWS API Documentation
|
3743
|
+
#
|
3744
|
+
# @overload update_routing_profile_name(params = {})
|
3745
|
+
# @param [Hash] params ({})
|
3746
|
+
def update_routing_profile_name(params = {}, options = {})
|
3747
|
+
req = build_request(:update_routing_profile_name, params)
|
3748
|
+
req.send_request(options)
|
3749
|
+
end
|
3750
|
+
|
3751
|
+
# Updates the properties associated with a set of queues for a routing
|
3752
|
+
# profile.
|
3753
|
+
#
|
3754
|
+
# @option params [required, String] :instance_id
|
3755
|
+
# The identifier of the Amazon Connect instance.
|
3756
|
+
#
|
3757
|
+
# @option params [required, String] :routing_profile_id
|
3758
|
+
# The identifier of the routing profile.
|
3759
|
+
#
|
3760
|
+
# @option params [required, Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
3761
|
+
# The queues to be updated for this routing profile.
|
3762
|
+
#
|
3763
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3764
|
+
#
|
3765
|
+
# @example Request syntax with placeholder values
|
3766
|
+
#
|
3767
|
+
# resp = client.update_routing_profile_queues({
|
3768
|
+
# instance_id: "InstanceId", # required
|
3769
|
+
# routing_profile_id: "RoutingProfileId", # required
|
3770
|
+
# queue_configs: [ # required
|
3771
|
+
# {
|
3772
|
+
# queue_reference: { # required
|
3773
|
+
# queue_id: "QueueId", # required
|
3774
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT
|
3775
|
+
# },
|
3776
|
+
# priority: 1, # required
|
3777
|
+
# delay: 1, # required
|
3778
|
+
# },
|
3779
|
+
# ],
|
3780
|
+
# })
|
3781
|
+
#
|
3782
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileQueues AWS API Documentation
|
3783
|
+
#
|
3784
|
+
# @overload update_routing_profile_queues(params = {})
|
3785
|
+
# @param [Hash] params ({})
|
3786
|
+
def update_routing_profile_queues(params = {}, options = {})
|
3787
|
+
req = build_request(:update_routing_profile_queues, params)
|
3788
|
+
req.send_request(options)
|
3789
|
+
end
|
3790
|
+
|
1973
3791
|
# Assigns the specified hierarchy group to the specified user.
|
1974
3792
|
#
|
1975
3793
|
# @option params [String] :hierarchy_group_id
|
@@ -2000,8 +3818,94 @@ module Aws::Connect
|
|
2000
3818
|
req.send_request(options)
|
2001
3819
|
end
|
2002
3820
|
|
3821
|
+
# Updates the name of the user hierarchy group.
|
3822
|
+
#
|
3823
|
+
# @option params [required, String] :name
|
3824
|
+
# The name of the hierarchy group. Must not be more than 100 characters.
|
3825
|
+
#
|
3826
|
+
# @option params [required, String] :hierarchy_group_id
|
3827
|
+
# The identifier of the hierarchy group.
|
3828
|
+
#
|
3829
|
+
# @option params [required, String] :instance_id
|
3830
|
+
# The identifier of the Amazon Connect instance.
|
3831
|
+
#
|
3832
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3833
|
+
#
|
3834
|
+
# @example Request syntax with placeholder values
|
3835
|
+
#
|
3836
|
+
# resp = client.update_user_hierarchy_group_name({
|
3837
|
+
# name: "HierarchyGroupName", # required
|
3838
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
3839
|
+
# instance_id: "InstanceId", # required
|
3840
|
+
# })
|
3841
|
+
#
|
3842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyGroupName AWS API Documentation
|
3843
|
+
#
|
3844
|
+
# @overload update_user_hierarchy_group_name(params = {})
|
3845
|
+
# @param [Hash] params ({})
|
3846
|
+
def update_user_hierarchy_group_name(params = {}, options = {})
|
3847
|
+
req = build_request(:update_user_hierarchy_group_name, params)
|
3848
|
+
req.send_request(options)
|
3849
|
+
end
|
3850
|
+
|
3851
|
+
# Updates the user hierarchy structure: add, remove, and rename user
|
3852
|
+
# hierarchy levels.
|
3853
|
+
#
|
3854
|
+
# @option params [required, Types::HierarchyStructureUpdate] :hierarchy_structure
|
3855
|
+
# The hierarchy levels to update.
|
3856
|
+
#
|
3857
|
+
# @option params [required, String] :instance_id
|
3858
|
+
# The identifier of the Amazon Connect instance.
|
3859
|
+
#
|
3860
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3861
|
+
#
|
3862
|
+
# @example Request syntax with placeholder values
|
3863
|
+
#
|
3864
|
+
# resp = client.update_user_hierarchy_structure({
|
3865
|
+
# hierarchy_structure: { # required
|
3866
|
+
# level_one: {
|
3867
|
+
# name: "HierarchyLevelName", # required
|
3868
|
+
# },
|
3869
|
+
# level_two: {
|
3870
|
+
# name: "HierarchyLevelName", # required
|
3871
|
+
# },
|
3872
|
+
# level_three: {
|
3873
|
+
# name: "HierarchyLevelName", # required
|
3874
|
+
# },
|
3875
|
+
# level_four: {
|
3876
|
+
# name: "HierarchyLevelName", # required
|
3877
|
+
# },
|
3878
|
+
# level_five: {
|
3879
|
+
# name: "HierarchyLevelName", # required
|
3880
|
+
# },
|
3881
|
+
# },
|
3882
|
+
# instance_id: "InstanceId", # required
|
3883
|
+
# })
|
3884
|
+
#
|
3885
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyStructure AWS API Documentation
|
3886
|
+
#
|
3887
|
+
# @overload update_user_hierarchy_structure(params = {})
|
3888
|
+
# @param [Hash] params ({})
|
3889
|
+
def update_user_hierarchy_structure(params = {}, options = {})
|
3890
|
+
req = build_request(:update_user_hierarchy_structure, params)
|
3891
|
+
req.send_request(options)
|
3892
|
+
end
|
3893
|
+
|
2003
3894
|
# Updates the identity information for the specified user.
|
2004
3895
|
#
|
3896
|
+
# Someone with the ability to invoke `UpdateUserIndentityInfo` can
|
3897
|
+
# change the login credentials of other users by changing their email
|
3898
|
+
# address. This poses a security risk to your organization. They can
|
3899
|
+
# change the email address of a user to the attacker's email address,
|
3900
|
+
# and then reset the password through email. We strongly recommend
|
3901
|
+
# limiting who has the ability to invoke `UpdateUserIndentityInfo`. For
|
3902
|
+
# more information, see [Best Practices for Security Profiles][1] in the
|
3903
|
+
# *Amazon Connect Administrator Guide*.
|
3904
|
+
#
|
3905
|
+
#
|
3906
|
+
#
|
3907
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html
|
3908
|
+
#
|
2005
3909
|
# @option params [required, Types::UserIdentityInfo] :identity_info
|
2006
3910
|
# The identity information for the user.
|
2007
3911
|
#
|
@@ -2142,7 +4046,7 @@ module Aws::Connect
|
|
2142
4046
|
params: params,
|
2143
4047
|
config: config)
|
2144
4048
|
context[:gem_name] = 'aws-sdk-connect'
|
2145
|
-
context[:gem_version] = '1.
|
4049
|
+
context[:gem_version] = '1.36.0'
|
2146
4050
|
Seahorse::Client::Request.new(handlers, context)
|
2147
4051
|
end
|
2148
4052
|
|