aws-sdk-connect 1.54.0 → 1.58.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +777 -30
- data/lib/aws-sdk-connect/client_api.rb +534 -19
- data/lib/aws-sdk-connect/errors.rb +48 -0
- data/lib/aws-sdk-connect/types.rb +1210 -108
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +4 -4
@@ -10,6 +10,38 @@
|
|
10
10
|
module Aws::Connect
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# You do not have sufficient permissions to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# Information about the agent who accepted the contact.
|
27
|
+
#
|
28
|
+
# @!attribute [rw] id
|
29
|
+
# The identifier of the agent who accepted the contact.
|
30
|
+
# @return [String]
|
31
|
+
#
|
32
|
+
# @!attribute [rw] connected_to_agent_timestamp
|
33
|
+
# The timestamp when the contact was connected to the agent.
|
34
|
+
# @return [Time]
|
35
|
+
#
|
36
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentInfo AWS API Documentation
|
37
|
+
#
|
38
|
+
class AgentInfo < Struct.new(
|
39
|
+
:id,
|
40
|
+
:connected_to_agent_timestamp)
|
41
|
+
SENSITIVE = []
|
42
|
+
include Aws::Structure
|
43
|
+
end
|
44
|
+
|
13
45
|
# Contains information about an agent status.
|
14
46
|
#
|
15
47
|
# @!attribute [rw] agent_status_arn
|
@@ -41,7 +73,8 @@ module Aws::Connect
|
|
41
73
|
# @return [String]
|
42
74
|
#
|
43
75
|
# @!attribute [rw] tags
|
44
|
-
#
|
76
|
+
# The tags used to organize, track, or control access for this
|
77
|
+
# resource.
|
45
78
|
# @return [Hash<String,String>]
|
46
79
|
#
|
47
80
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentStatus AWS API Documentation
|
@@ -418,6 +451,31 @@ module Aws::Connect
|
|
418
451
|
include Aws::Structure
|
419
452
|
end
|
420
453
|
|
454
|
+
# Information about the attachment reference if the `referenceType` is
|
455
|
+
# `ATTACHMENT`. Otherwise, null.
|
456
|
+
#
|
457
|
+
# @!attribute [rw] name
|
458
|
+
# Identifier of the attachment reference.
|
459
|
+
# @return [String]
|
460
|
+
#
|
461
|
+
# @!attribute [rw] value
|
462
|
+
# Contains the location path of the attachment reference.
|
463
|
+
# @return [String]
|
464
|
+
#
|
465
|
+
# @!attribute [rw] status
|
466
|
+
# Status of an attachment reference type.
|
467
|
+
# @return [String]
|
468
|
+
#
|
469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AttachmentReference AWS API Documentation
|
470
|
+
#
|
471
|
+
class AttachmentReference < Struct.new(
|
472
|
+
:name,
|
473
|
+
:value,
|
474
|
+
:status)
|
475
|
+
SENSITIVE = []
|
476
|
+
include Aws::Structure
|
477
|
+
end
|
478
|
+
|
421
479
|
# A toggle for an individual feature at the instance level.
|
422
480
|
#
|
423
481
|
# @!attribute [rw] attribute_type
|
@@ -443,8 +501,8 @@ module Aws::Connect
|
|
443
501
|
# data as a hash:
|
444
502
|
#
|
445
503
|
# {
|
446
|
-
# content_type: "ChatContentType",
|
447
|
-
# content: "ChatContent",
|
504
|
+
# content_type: "ChatContentType", # required
|
505
|
+
# content: "ChatContent", # required
|
448
506
|
# }
|
449
507
|
#
|
450
508
|
# @!attribute [rw] content_type
|
@@ -488,6 +546,95 @@ module Aws::Connect
|
|
488
546
|
include Aws::Structure
|
489
547
|
end
|
490
548
|
|
549
|
+
# Contains information about a contact.
|
550
|
+
#
|
551
|
+
# @!attribute [rw] arn
|
552
|
+
# The Amazon Resource Name (ARN) for the contact.
|
553
|
+
# @return [String]
|
554
|
+
#
|
555
|
+
# @!attribute [rw] id
|
556
|
+
# The identifier for the contact.
|
557
|
+
# @return [String]
|
558
|
+
#
|
559
|
+
# @!attribute [rw] initial_contact_id
|
560
|
+
# If this contact is related to other contacts, this is the ID of the
|
561
|
+
# initial contact.
|
562
|
+
# @return [String]
|
563
|
+
#
|
564
|
+
# @!attribute [rw] previous_contact_id
|
565
|
+
# If this contact is not the first contact, this is the ID of the
|
566
|
+
# previous contact.
|
567
|
+
# @return [String]
|
568
|
+
#
|
569
|
+
# @!attribute [rw] initiation_method
|
570
|
+
# Indicates how the contact was initiated.
|
571
|
+
# @return [String]
|
572
|
+
#
|
573
|
+
# @!attribute [rw] name
|
574
|
+
# The name of the contact.
|
575
|
+
# @return [String]
|
576
|
+
#
|
577
|
+
# @!attribute [rw] description
|
578
|
+
# The description of the contact.
|
579
|
+
# @return [String]
|
580
|
+
#
|
581
|
+
# @!attribute [rw] channel
|
582
|
+
# How the contact reached your contact center.
|
583
|
+
# @return [String]
|
584
|
+
#
|
585
|
+
# @!attribute [rw] queue_info
|
586
|
+
# If this contact was queued, this contains information about the
|
587
|
+
# queue.
|
588
|
+
# @return [Types::QueueInfo]
|
589
|
+
#
|
590
|
+
# @!attribute [rw] agent_info
|
591
|
+
# Information about the agent who accepted the contact.
|
592
|
+
# @return [Types::AgentInfo]
|
593
|
+
#
|
594
|
+
# @!attribute [rw] initiation_timestamp
|
595
|
+
# The date and time this contact was initiated, in UTC time. For
|
596
|
+
# `INBOUND`, this is when the contact arrived. For `OUTBOUND`, this is
|
597
|
+
# when the agent began dialing. For `CALLBACK`, this is when the
|
598
|
+
# callback contact was created. For `TRANSFER` and `QUEUE_TRANSFER`,
|
599
|
+
# this is when the transfer was initiated. For `API`, this is when the
|
600
|
+
# request arrived.
|
601
|
+
# @return [Time]
|
602
|
+
#
|
603
|
+
# @!attribute [rw] disconnect_timestamp
|
604
|
+
# The timestamp when the customer endpoint disconnected from Amazon
|
605
|
+
# Connect.
|
606
|
+
# @return [Time]
|
607
|
+
#
|
608
|
+
# @!attribute [rw] last_update_timestamp
|
609
|
+
# The timestamp when contact was last updated.
|
610
|
+
# @return [Time]
|
611
|
+
#
|
612
|
+
# @!attribute [rw] scheduled_timestamp
|
613
|
+
# The timestamp, in Unix epoch time format, at which to start running
|
614
|
+
# the inbound flow.
|
615
|
+
# @return [Time]
|
616
|
+
#
|
617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Contact AWS API Documentation
|
618
|
+
#
|
619
|
+
class Contact < Struct.new(
|
620
|
+
:arn,
|
621
|
+
:id,
|
622
|
+
:initial_contact_id,
|
623
|
+
:previous_contact_id,
|
624
|
+
:initiation_method,
|
625
|
+
:name,
|
626
|
+
:description,
|
627
|
+
:channel,
|
628
|
+
:queue_info,
|
629
|
+
:agent_info,
|
630
|
+
:initiation_timestamp,
|
631
|
+
:disconnect_timestamp,
|
632
|
+
:last_update_timestamp,
|
633
|
+
:scheduled_timestamp)
|
634
|
+
SENSITIVE = []
|
635
|
+
include Aws::Structure
|
636
|
+
end
|
637
|
+
|
491
638
|
# Contains information about a contact flow.
|
492
639
|
#
|
493
640
|
# @!attribute [rw] arn
|
@@ -512,6 +659,10 @@ module Aws::Connect
|
|
512
659
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
|
513
660
|
# @return [String]
|
514
661
|
#
|
662
|
+
# @!attribute [rw] state
|
663
|
+
# The type of contact flow.
|
664
|
+
# @return [String]
|
665
|
+
#
|
515
666
|
# @!attribute [rw] description
|
516
667
|
# The description of the contact flow.
|
517
668
|
# @return [String]
|
@@ -531,6 +682,7 @@ module Aws::Connect
|
|
531
682
|
:id,
|
532
683
|
:name,
|
533
684
|
:type,
|
685
|
+
:state,
|
534
686
|
:description,
|
535
687
|
:content,
|
536
688
|
:tags)
|
@@ -538,6 +690,85 @@ module Aws::Connect
|
|
538
690
|
include Aws::Structure
|
539
691
|
end
|
540
692
|
|
693
|
+
# Contains information about a contact flow module.
|
694
|
+
#
|
695
|
+
# @!attribute [rw] arn
|
696
|
+
# The Amazon Resource Name (ARN).
|
697
|
+
# @return [String]
|
698
|
+
#
|
699
|
+
# @!attribute [rw] id
|
700
|
+
# The identifier of the contact flow module.
|
701
|
+
# @return [String]
|
702
|
+
#
|
703
|
+
# @!attribute [rw] name
|
704
|
+
# The name of the contact flow module.
|
705
|
+
# @return [String]
|
706
|
+
#
|
707
|
+
# @!attribute [rw] content
|
708
|
+
# The content of the contact flow module.
|
709
|
+
# @return [String]
|
710
|
+
#
|
711
|
+
# @!attribute [rw] description
|
712
|
+
# The description of the contact flow module.
|
713
|
+
# @return [String]
|
714
|
+
#
|
715
|
+
# @!attribute [rw] state
|
716
|
+
# The type of contact flow module.
|
717
|
+
# @return [String]
|
718
|
+
#
|
719
|
+
# @!attribute [rw] status
|
720
|
+
# The status of the contact flow module.
|
721
|
+
# @return [String]
|
722
|
+
#
|
723
|
+
# @!attribute [rw] tags
|
724
|
+
# The tags used to organize, track, or control access for this
|
725
|
+
# resource.
|
726
|
+
# @return [Hash<String,String>]
|
727
|
+
#
|
728
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlowModule AWS API Documentation
|
729
|
+
#
|
730
|
+
class ContactFlowModule < Struct.new(
|
731
|
+
:arn,
|
732
|
+
:id,
|
733
|
+
:name,
|
734
|
+
:content,
|
735
|
+
:description,
|
736
|
+
:state,
|
737
|
+
:status,
|
738
|
+
:tags)
|
739
|
+
SENSITIVE = []
|
740
|
+
include Aws::Structure
|
741
|
+
end
|
742
|
+
|
743
|
+
# Contains summary information about a contact flow.
|
744
|
+
#
|
745
|
+
# @!attribute [rw] id
|
746
|
+
# The identifier of the contact flow module.
|
747
|
+
# @return [String]
|
748
|
+
#
|
749
|
+
# @!attribute [rw] arn
|
750
|
+
# The Amazon Resource Name (ARN) of the contact flow module.
|
751
|
+
# @return [String]
|
752
|
+
#
|
753
|
+
# @!attribute [rw] name
|
754
|
+
# The name of the contact flow module.
|
755
|
+
# @return [String]
|
756
|
+
#
|
757
|
+
# @!attribute [rw] state
|
758
|
+
# The type of contact flow module.
|
759
|
+
# @return [String]
|
760
|
+
#
|
761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlowModuleSummary AWS API Documentation
|
762
|
+
#
|
763
|
+
class ContactFlowModuleSummary < Struct.new(
|
764
|
+
:id,
|
765
|
+
:arn,
|
766
|
+
:name,
|
767
|
+
:state)
|
768
|
+
SENSITIVE = []
|
769
|
+
include Aws::Structure
|
770
|
+
end
|
771
|
+
|
541
772
|
# The contact flow has not been published.
|
542
773
|
#
|
543
774
|
# @!attribute [rw] message
|
@@ -576,13 +807,18 @@ module Aws::Connect
|
|
576
807
|
# The type of contact flow.
|
577
808
|
# @return [String]
|
578
809
|
#
|
810
|
+
# @!attribute [rw] contact_flow_state
|
811
|
+
# The type of contact flow.
|
812
|
+
# @return [String]
|
813
|
+
#
|
579
814
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlowSummary AWS API Documentation
|
580
815
|
#
|
581
816
|
class ContactFlowSummary < Struct.new(
|
582
817
|
:id,
|
583
818
|
:arn,
|
584
819
|
:name,
|
585
|
-
:contact_flow_type
|
820
|
+
:contact_flow_type,
|
821
|
+
:contact_flow_state)
|
586
822
|
SENSITIVE = []
|
587
823
|
include Aws::Structure
|
588
824
|
end
|
@@ -637,7 +873,8 @@ module Aws::Connect
|
|
637
873
|
# @return [Integer]
|
638
874
|
#
|
639
875
|
# @!attribute [rw] tags
|
640
|
-
#
|
876
|
+
# The tags used to organize, track, or control access for this
|
877
|
+
# resource.
|
641
878
|
# @return [Hash<String,String>]
|
642
879
|
#
|
643
880
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateAgentStatusRequest AWS API Documentation
|
@@ -670,6 +907,80 @@ module Aws::Connect
|
|
670
907
|
include Aws::Structure
|
671
908
|
end
|
672
909
|
|
910
|
+
# @note When making an API call, you may pass CreateContactFlowModuleRequest
|
911
|
+
# data as a hash:
|
912
|
+
#
|
913
|
+
# {
|
914
|
+
# instance_id: "InstanceId", # required
|
915
|
+
# name: "ContactFlowModuleName", # required
|
916
|
+
# description: "ContactFlowModuleDescription",
|
917
|
+
# content: "ContactFlowModuleContent", # required
|
918
|
+
# tags: {
|
919
|
+
# "TagKey" => "TagValue",
|
920
|
+
# },
|
921
|
+
# client_token: "ClientToken",
|
922
|
+
# }
|
923
|
+
#
|
924
|
+
# @!attribute [rw] instance_id
|
925
|
+
# The identifier of the Amazon Connect instance. You can find the
|
926
|
+
# instanceId in the ARN of the instance.
|
927
|
+
# @return [String]
|
928
|
+
#
|
929
|
+
# @!attribute [rw] name
|
930
|
+
# The name of the contact flow module.
|
931
|
+
# @return [String]
|
932
|
+
#
|
933
|
+
# @!attribute [rw] description
|
934
|
+
# The description of the contact flow module.
|
935
|
+
# @return [String]
|
936
|
+
#
|
937
|
+
# @!attribute [rw] content
|
938
|
+
# The content of the contact flow module.
|
939
|
+
# @return [String]
|
940
|
+
#
|
941
|
+
# @!attribute [rw] tags
|
942
|
+
# The tags used to organize, track, or control access for this
|
943
|
+
# resource.
|
944
|
+
# @return [Hash<String,String>]
|
945
|
+
#
|
946
|
+
# @!attribute [rw] client_token
|
947
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
948
|
+
# idempotency of the request.
|
949
|
+
#
|
950
|
+
# **A suitable default value is auto-generated.** You should normally
|
951
|
+
# not need to pass this option.
|
952
|
+
# @return [String]
|
953
|
+
#
|
954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowModuleRequest AWS API Documentation
|
955
|
+
#
|
956
|
+
class CreateContactFlowModuleRequest < Struct.new(
|
957
|
+
:instance_id,
|
958
|
+
:name,
|
959
|
+
:description,
|
960
|
+
:content,
|
961
|
+
:tags,
|
962
|
+
:client_token)
|
963
|
+
SENSITIVE = []
|
964
|
+
include Aws::Structure
|
965
|
+
end
|
966
|
+
|
967
|
+
# @!attribute [rw] id
|
968
|
+
# The identifier of the contact flow module.
|
969
|
+
# @return [String]
|
970
|
+
#
|
971
|
+
# @!attribute [rw] arn
|
972
|
+
# The Amazon Resource Name (ARN) of the contact flow module.
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowModuleResponse AWS API Documentation
|
976
|
+
#
|
977
|
+
class CreateContactFlowModuleResponse < Struct.new(
|
978
|
+
:id,
|
979
|
+
:arn)
|
980
|
+
SENSITIVE = []
|
981
|
+
include Aws::Structure
|
982
|
+
end
|
983
|
+
|
673
984
|
# @note When making an API call, you may pass CreateContactFlowRequest
|
674
985
|
# data as a hash:
|
675
986
|
#
|
@@ -793,7 +1104,8 @@ module Aws::Connect
|
|
793
1104
|
# @return [Array<Types::HoursOfOperationConfig>]
|
794
1105
|
#
|
795
1106
|
# @!attribute [rw] tags
|
796
|
-
#
|
1107
|
+
# The tags used to organize, track, or control access for this
|
1108
|
+
# resource.
|
797
1109
|
# @return [Hash<String,String>]
|
798
1110
|
#
|
799
1111
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateHoursOfOperationRequest AWS API Documentation
|
@@ -936,7 +1248,8 @@ module Aws::Connect
|
|
936
1248
|
# @return [String]
|
937
1249
|
#
|
938
1250
|
# @!attribute [rw] tags
|
939
|
-
#
|
1251
|
+
# The tags used to organize, track, or control access for this
|
1252
|
+
# resource.
|
940
1253
|
# @return [Hash<String,String>]
|
941
1254
|
#
|
942
1255
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateIntegrationAssociationRequest AWS API Documentation
|
@@ -1021,7 +1334,8 @@ module Aws::Connect
|
|
1021
1334
|
# @return [Array<String>]
|
1022
1335
|
#
|
1023
1336
|
# @!attribute [rw] tags
|
1024
|
-
#
|
1337
|
+
# The tags used to organize, track, or control access for this
|
1338
|
+
# resource.
|
1025
1339
|
# @return [Hash<String,String>]
|
1026
1340
|
#
|
1027
1341
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQueueRequest AWS API Documentation
|
@@ -1100,7 +1414,8 @@ module Aws::Connect
|
|
1100
1414
|
# @return [Types::QuickConnectConfig]
|
1101
1415
|
#
|
1102
1416
|
# @!attribute [rw] tags
|
1103
|
-
#
|
1417
|
+
# The tags used to organize, track, or control access for this
|
1418
|
+
# resource.
|
1104
1419
|
# @return [Hash<String,String>]
|
1105
1420
|
#
|
1106
1421
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQuickConnectRequest AWS API Documentation
|
@@ -1225,6 +1540,70 @@ module Aws::Connect
|
|
1225
1540
|
include Aws::Structure
|
1226
1541
|
end
|
1227
1542
|
|
1543
|
+
# @note When making an API call, you may pass CreateSecurityProfileRequest
|
1544
|
+
# data as a hash:
|
1545
|
+
#
|
1546
|
+
# {
|
1547
|
+
# security_profile_name: "SecurityProfileName", # required
|
1548
|
+
# description: "SecurityProfileDescription",
|
1549
|
+
# permissions: ["SecurityProfilePermission"],
|
1550
|
+
# instance_id: "InstanceId", # required
|
1551
|
+
# tags: {
|
1552
|
+
# "TagKey" => "TagValue",
|
1553
|
+
# },
|
1554
|
+
# }
|
1555
|
+
#
|
1556
|
+
# @!attribute [rw] security_profile_name
|
1557
|
+
# The name of the security profile.
|
1558
|
+
# @return [String]
|
1559
|
+
#
|
1560
|
+
# @!attribute [rw] description
|
1561
|
+
# The description of the security profile.
|
1562
|
+
# @return [String]
|
1563
|
+
#
|
1564
|
+
# @!attribute [rw] permissions
|
1565
|
+
# Permissions assigned to the security profile.
|
1566
|
+
# @return [Array<String>]
|
1567
|
+
#
|
1568
|
+
# @!attribute [rw] instance_id
|
1569
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1570
|
+
# instanceId in the ARN of the instance.
|
1571
|
+
# @return [String]
|
1572
|
+
#
|
1573
|
+
# @!attribute [rw] tags
|
1574
|
+
# The tags used to organize, track, or control access for this
|
1575
|
+
# resource.
|
1576
|
+
# @return [Hash<String,String>]
|
1577
|
+
#
|
1578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateSecurityProfileRequest AWS API Documentation
|
1579
|
+
#
|
1580
|
+
class CreateSecurityProfileRequest < Struct.new(
|
1581
|
+
:security_profile_name,
|
1582
|
+
:description,
|
1583
|
+
:permissions,
|
1584
|
+
:instance_id,
|
1585
|
+
:tags)
|
1586
|
+
SENSITIVE = []
|
1587
|
+
include Aws::Structure
|
1588
|
+
end
|
1589
|
+
|
1590
|
+
# @!attribute [rw] security_profile_id
|
1591
|
+
# The identifier for the security profle.
|
1592
|
+
# @return [String]
|
1593
|
+
#
|
1594
|
+
# @!attribute [rw] security_profile_arn
|
1595
|
+
# The Amazon Resource Name (ARN) for the security profile.
|
1596
|
+
# @return [String]
|
1597
|
+
#
|
1598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateSecurityProfileResponse AWS API Documentation
|
1599
|
+
#
|
1600
|
+
class CreateSecurityProfileResponse < Struct.new(
|
1601
|
+
:security_profile_id,
|
1602
|
+
:security_profile_arn)
|
1603
|
+
SENSITIVE = []
|
1604
|
+
include Aws::Structure
|
1605
|
+
end
|
1606
|
+
|
1228
1607
|
# @note When making an API call, you may pass CreateUseCaseRequest
|
1229
1608
|
# data as a hash:
|
1230
1609
|
#
|
@@ -1253,7 +1632,8 @@ module Aws::Connect
|
|
1253
1632
|
# @return [String]
|
1254
1633
|
#
|
1255
1634
|
# @!attribute [rw] tags
|
1256
|
-
#
|
1635
|
+
# The tags used to organize, track, or control access for this
|
1636
|
+
# resource.
|
1257
1637
|
# @return [Hash<String,String>]
|
1258
1638
|
#
|
1259
1639
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUseCaseRequest AWS API Documentation
|
@@ -1432,7 +1812,7 @@ module Aws::Connect
|
|
1432
1812
|
:hierarchy_group_id,
|
1433
1813
|
:instance_id,
|
1434
1814
|
:tags)
|
1435
|
-
SENSITIVE = [
|
1815
|
+
SENSITIVE = []
|
1436
1816
|
include Aws::Structure
|
1437
1817
|
end
|
1438
1818
|
|
@@ -1498,7 +1878,7 @@ module Aws::Connect
|
|
1498
1878
|
#
|
1499
1879
|
# {
|
1500
1880
|
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
|
1501
|
-
# unit: "SECONDS", # accepts SECONDS,
|
1881
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
1502
1882
|
# }
|
1503
1883
|
#
|
1504
1884
|
# @!attribute [rw] name
|
@@ -1556,6 +1936,62 @@ module Aws::Connect
|
|
1556
1936
|
include Aws::Structure
|
1557
1937
|
end
|
1558
1938
|
|
1939
|
+
# @note When making an API call, you may pass DeleteContactFlowModuleRequest
|
1940
|
+
# data as a hash:
|
1941
|
+
#
|
1942
|
+
# {
|
1943
|
+
# instance_id: "InstanceId", # required
|
1944
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
1945
|
+
# }
|
1946
|
+
#
|
1947
|
+
# @!attribute [rw] instance_id
|
1948
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1949
|
+
# instanceId in the ARN of the instance.
|
1950
|
+
# @return [String]
|
1951
|
+
#
|
1952
|
+
# @!attribute [rw] contact_flow_module_id
|
1953
|
+
# The identifier of the contact flow module.
|
1954
|
+
# @return [String]
|
1955
|
+
#
|
1956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactFlowModuleRequest AWS API Documentation
|
1957
|
+
#
|
1958
|
+
class DeleteContactFlowModuleRequest < Struct.new(
|
1959
|
+
:instance_id,
|
1960
|
+
:contact_flow_module_id)
|
1961
|
+
SENSITIVE = []
|
1962
|
+
include Aws::Structure
|
1963
|
+
end
|
1964
|
+
|
1965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactFlowModuleResponse AWS API Documentation
|
1966
|
+
#
|
1967
|
+
class DeleteContactFlowModuleResponse < Aws::EmptyStructure; end
|
1968
|
+
|
1969
|
+
# @note When making an API call, you may pass DeleteContactFlowRequest
|
1970
|
+
# data as a hash:
|
1971
|
+
#
|
1972
|
+
# {
|
1973
|
+
# instance_id: "InstanceId", # required
|
1974
|
+
# contact_flow_id: "ContactFlowId", # required
|
1975
|
+
# }
|
1976
|
+
#
|
1977
|
+
# @!attribute [rw] instance_id
|
1978
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1979
|
+
# instanceId in the ARN of the instance.
|
1980
|
+
# @return [String]
|
1981
|
+
#
|
1982
|
+
# @!attribute [rw] contact_flow_id
|
1983
|
+
# The identifier of the contact flow.
|
1984
|
+
# @return [String]
|
1985
|
+
#
|
1986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactFlowRequest AWS API Documentation
|
1987
|
+
#
|
1988
|
+
class DeleteContactFlowRequest < Struct.new(
|
1989
|
+
:instance_id,
|
1990
|
+
:contact_flow_id)
|
1991
|
+
SENSITIVE = []
|
1992
|
+
include Aws::Structure
|
1993
|
+
end
|
1994
|
+
|
1559
1995
|
# @note When making an API call, you may pass DeleteHoursOfOperationRequest
|
1560
1996
|
# data as a hash:
|
1561
1997
|
#
|
@@ -1654,6 +2090,32 @@ module Aws::Connect
|
|
1654
2090
|
include Aws::Structure
|
1655
2091
|
end
|
1656
2092
|
|
2093
|
+
# @note When making an API call, you may pass DeleteSecurityProfileRequest
|
2094
|
+
# data as a hash:
|
2095
|
+
#
|
2096
|
+
# {
|
2097
|
+
# instance_id: "InstanceId", # required
|
2098
|
+
# security_profile_id: "SecurityProfileId", # required
|
2099
|
+
# }
|
2100
|
+
#
|
2101
|
+
# @!attribute [rw] instance_id
|
2102
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2103
|
+
# instanceId in the ARN of the instance.
|
2104
|
+
# @return [String]
|
2105
|
+
#
|
2106
|
+
# @!attribute [rw] security_profile_id
|
2107
|
+
# The identifier for the security profle.
|
2108
|
+
# @return [String]
|
2109
|
+
#
|
2110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteSecurityProfileRequest AWS API Documentation
|
2111
|
+
#
|
2112
|
+
class DeleteSecurityProfileRequest < Struct.new(
|
2113
|
+
:instance_id,
|
2114
|
+
:security_profile_id)
|
2115
|
+
SENSITIVE = []
|
2116
|
+
include Aws::Structure
|
2117
|
+
end
|
2118
|
+
|
1657
2119
|
# @note When making an API call, you may pass DeleteUseCaseRequest
|
1658
2120
|
# data as a hash:
|
1659
2121
|
#
|
@@ -1776,6 +2238,44 @@ module Aws::Connect
|
|
1776
2238
|
include Aws::Structure
|
1777
2239
|
end
|
1778
2240
|
|
2241
|
+
# @note When making an API call, you may pass DescribeContactFlowModuleRequest
|
2242
|
+
# data as a hash:
|
2243
|
+
#
|
2244
|
+
# {
|
2245
|
+
# instance_id: "InstanceId", # required
|
2246
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
2247
|
+
# }
|
2248
|
+
#
|
2249
|
+
# @!attribute [rw] instance_id
|
2250
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2251
|
+
# instanceId in the ARN of the instance.
|
2252
|
+
# @return [String]
|
2253
|
+
#
|
2254
|
+
# @!attribute [rw] contact_flow_module_id
|
2255
|
+
# The identifier of the contact flow module.
|
2256
|
+
# @return [String]
|
2257
|
+
#
|
2258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowModuleRequest AWS API Documentation
|
2259
|
+
#
|
2260
|
+
class DescribeContactFlowModuleRequest < Struct.new(
|
2261
|
+
:instance_id,
|
2262
|
+
:contact_flow_module_id)
|
2263
|
+
SENSITIVE = []
|
2264
|
+
include Aws::Structure
|
2265
|
+
end
|
2266
|
+
|
2267
|
+
# @!attribute [rw] contact_flow_module
|
2268
|
+
# Information about the contact flow module.
|
2269
|
+
# @return [Types::ContactFlowModule]
|
2270
|
+
#
|
2271
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowModuleResponse AWS API Documentation
|
2272
|
+
#
|
2273
|
+
class DescribeContactFlowModuleResponse < Struct.new(
|
2274
|
+
:contact_flow_module)
|
2275
|
+
SENSITIVE = []
|
2276
|
+
include Aws::Structure
|
2277
|
+
end
|
2278
|
+
|
1779
2279
|
# @note When making an API call, you may pass DescribeContactFlowRequest
|
1780
2280
|
# data as a hash:
|
1781
2281
|
#
|
@@ -1788,27 +2288,65 @@ module Aws::Connect
|
|
1788
2288
|
# The identifier of the Amazon Connect instance.
|
1789
2289
|
# @return [String]
|
1790
2290
|
#
|
1791
|
-
# @!attribute [rw] contact_flow_id
|
1792
|
-
# The identifier of the contact flow.
|
2291
|
+
# @!attribute [rw] contact_flow_id
|
2292
|
+
# The identifier of the contact flow.
|
2293
|
+
# @return [String]
|
2294
|
+
#
|
2295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowRequest AWS API Documentation
|
2296
|
+
#
|
2297
|
+
class DescribeContactFlowRequest < Struct.new(
|
2298
|
+
:instance_id,
|
2299
|
+
:contact_flow_id)
|
2300
|
+
SENSITIVE = []
|
2301
|
+
include Aws::Structure
|
2302
|
+
end
|
2303
|
+
|
2304
|
+
# @!attribute [rw] contact_flow
|
2305
|
+
# Information about the contact flow.
|
2306
|
+
# @return [Types::ContactFlow]
|
2307
|
+
#
|
2308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowResponse AWS API Documentation
|
2309
|
+
#
|
2310
|
+
class DescribeContactFlowResponse < Struct.new(
|
2311
|
+
:contact_flow)
|
2312
|
+
SENSITIVE = []
|
2313
|
+
include Aws::Structure
|
2314
|
+
end
|
2315
|
+
|
2316
|
+
# @note When making an API call, you may pass DescribeContactRequest
|
2317
|
+
# data as a hash:
|
2318
|
+
#
|
2319
|
+
# {
|
2320
|
+
# instance_id: "InstanceId", # required
|
2321
|
+
# contact_id: "ContactId", # required
|
2322
|
+
# }
|
2323
|
+
#
|
2324
|
+
# @!attribute [rw] instance_id
|
2325
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2326
|
+
# instanceId in the ARN of the instance.
|
2327
|
+
# @return [String]
|
2328
|
+
#
|
2329
|
+
# @!attribute [rw] contact_id
|
2330
|
+
# The identifier of the contact.
|
1793
2331
|
# @return [String]
|
1794
2332
|
#
|
1795
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactRequest AWS API Documentation
|
1796
2334
|
#
|
1797
|
-
class
|
2335
|
+
class DescribeContactRequest < Struct.new(
|
1798
2336
|
:instance_id,
|
1799
|
-
:
|
2337
|
+
:contact_id)
|
1800
2338
|
SENSITIVE = []
|
1801
2339
|
include Aws::Structure
|
1802
2340
|
end
|
1803
2341
|
|
1804
|
-
# @!attribute [rw]
|
1805
|
-
# Information about the contact
|
1806
|
-
# @return [Types::
|
2342
|
+
# @!attribute [rw] contact
|
2343
|
+
# Information about the contact.
|
2344
|
+
# @return [Types::Contact]
|
1807
2345
|
#
|
1808
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
2346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactResponse AWS API Documentation
|
1809
2347
|
#
|
1810
|
-
class
|
1811
|
-
:
|
2348
|
+
class DescribeContactResponse < Struct.new(
|
2349
|
+
:contact)
|
1812
2350
|
SENSITIVE = []
|
1813
2351
|
include Aws::Structure
|
1814
2352
|
end
|
@@ -2080,6 +2618,44 @@ module Aws::Connect
|
|
2080
2618
|
include Aws::Structure
|
2081
2619
|
end
|
2082
2620
|
|
2621
|
+
# @note When making an API call, you may pass DescribeSecurityProfileRequest
|
2622
|
+
# data as a hash:
|
2623
|
+
#
|
2624
|
+
# {
|
2625
|
+
# security_profile_id: "SecurityProfileId", # required
|
2626
|
+
# instance_id: "InstanceId", # required
|
2627
|
+
# }
|
2628
|
+
#
|
2629
|
+
# @!attribute [rw] security_profile_id
|
2630
|
+
# The identifier for the security profle.
|
2631
|
+
# @return [String]
|
2632
|
+
#
|
2633
|
+
# @!attribute [rw] instance_id
|
2634
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2635
|
+
# instanceId in the ARN of the instance.
|
2636
|
+
# @return [String]
|
2637
|
+
#
|
2638
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeSecurityProfileRequest AWS API Documentation
|
2639
|
+
#
|
2640
|
+
class DescribeSecurityProfileRequest < Struct.new(
|
2641
|
+
:security_profile_id,
|
2642
|
+
:instance_id)
|
2643
|
+
SENSITIVE = []
|
2644
|
+
include Aws::Structure
|
2645
|
+
end
|
2646
|
+
|
2647
|
+
# @!attribute [rw] security_profile
|
2648
|
+
# The security profile.
|
2649
|
+
# @return [Types::SecurityProfile]
|
2650
|
+
#
|
2651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeSecurityProfileResponse AWS API Documentation
|
2652
|
+
#
|
2653
|
+
class DescribeSecurityProfileResponse < Struct.new(
|
2654
|
+
:security_profile)
|
2655
|
+
SENSITIVE = []
|
2656
|
+
include Aws::Structure
|
2657
|
+
end
|
2658
|
+
|
2083
2659
|
# @note When making an API call, you may pass DescribeUserHierarchyGroupRequest
|
2084
2660
|
# data as a hash:
|
2085
2661
|
#
|
@@ -2212,21 +2788,11 @@ module Aws::Connect
|
|
2212
2788
|
# The channel used for grouping and filters.
|
2213
2789
|
# @return [String]
|
2214
2790
|
#
|
2215
|
-
# @!attribute [rw] routing_profile
|
2216
|
-
# The routing profile.
|
2217
|
-
# @return [Types::RoutingProfileReference]
|
2218
|
-
#
|
2219
|
-
# @!attribute [rw] instance_reference
|
2220
|
-
# The instance reference.
|
2221
|
-
# @return [Types::InstanceReference]
|
2222
|
-
#
|
2223
2791
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Dimensions AWS API Documentation
|
2224
2792
|
#
|
2225
2793
|
class Dimensions < Struct.new(
|
2226
2794
|
:queue,
|
2227
|
-
:channel
|
2228
|
-
:routing_profile,
|
2229
|
-
:instance_reference)
|
2795
|
+
:channel)
|
2230
2796
|
SENSITIVE = []
|
2231
2797
|
include Aws::Structure
|
2232
2798
|
end
|
@@ -2534,7 +3100,6 @@ module Aws::Connect
|
|
2534
3100
|
#
|
2535
3101
|
# {
|
2536
3102
|
# queues: ["QueueId"],
|
2537
|
-
# routing_profiles: ["RoutingProfileId"],
|
2538
3103
|
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
2539
3104
|
# }
|
2540
3105
|
#
|
@@ -2543,10 +3108,6 @@ module Aws::Connect
|
|
2543
3108
|
# queues per request.
|
2544
3109
|
# @return [Array<String>]
|
2545
3110
|
#
|
2546
|
-
# @!attribute [rw] routing_profiles
|
2547
|
-
# The filters used to sort routing profiles.
|
2548
|
-
# @return [Array<String>]
|
2549
|
-
#
|
2550
3111
|
# @!attribute [rw] channels
|
2551
3112
|
# The channel to use to filter the metrics.
|
2552
3113
|
# @return [Array<String>]
|
@@ -2555,7 +3116,6 @@ module Aws::Connect
|
|
2555
3116
|
#
|
2556
3117
|
class Filters < Struct.new(
|
2557
3118
|
:queues,
|
2558
|
-
:routing_profiles,
|
2559
3119
|
:channels)
|
2560
3120
|
SENSITIVE = []
|
2561
3121
|
include Aws::Structure
|
@@ -2605,14 +3165,13 @@ module Aws::Connect
|
|
2605
3165
|
# instance_id: "InstanceId", # required
|
2606
3166
|
# filters: { # required
|
2607
3167
|
# queues: ["QueueId"],
|
2608
|
-
# routing_profiles: ["RoutingProfileId"],
|
2609
3168
|
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
2610
3169
|
# },
|
2611
|
-
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
3170
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
2612
3171
|
# current_metrics: [ # required
|
2613
3172
|
# {
|
2614
3173
|
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
|
2615
|
-
# unit: "SECONDS", # accepts SECONDS,
|
3174
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
2616
3175
|
# },
|
2617
3176
|
# ],
|
2618
3177
|
# next_token: "NextToken",
|
@@ -2852,19 +3411,18 @@ module Aws::Connect
|
|
2852
3411
|
# end_time: Time.now, # required
|
2853
3412
|
# filters: { # required
|
2854
3413
|
# queues: ["QueueId"],
|
2855
|
-
# routing_profiles: ["RoutingProfileId"],
|
2856
3414
|
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
2857
3415
|
# },
|
2858
|
-
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
3416
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
2859
3417
|
# historical_metrics: [ # required
|
2860
3418
|
# {
|
2861
|
-
# 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,
|
3419
|
+
# 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
|
2862
3420
|
# threshold: {
|
2863
3421
|
# comparison: "LT", # accepts LT
|
2864
3422
|
# threshold_value: 1.0,
|
2865
3423
|
# },
|
2866
3424
|
# statistic: "SUM", # accepts SUM, MAX, AVG
|
2867
|
-
# unit: "SECONDS", # accepts SECONDS,
|
3425
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
2868
3426
|
# },
|
2869
3427
|
# ],
|
2870
3428
|
# next_token: "NextToken",
|
@@ -3380,13 +3938,13 @@ module Aws::Connect
|
|
3380
3938
|
# data as a hash:
|
3381
3939
|
#
|
3382
3940
|
# {
|
3383
|
-
# 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,
|
3941
|
+
# 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
|
3384
3942
|
# threshold: {
|
3385
3943
|
# comparison: "LT", # accepts LT
|
3386
3944
|
# threshold_value: 1.0,
|
3387
3945
|
# },
|
3388
3946
|
# statistic: "SUM", # accepts SUM, MAX, AVG
|
3389
|
-
# unit: "SECONDS", # accepts SECONDS,
|
3947
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
3390
3948
|
# }
|
3391
3949
|
#
|
3392
3950
|
# @!attribute [rw] name
|
@@ -3481,7 +4039,8 @@ module Aws::Connect
|
|
3481
4039
|
# @return [Array<Types::HoursOfOperationConfig>]
|
3482
4040
|
#
|
3483
4041
|
# @!attribute [rw] tags
|
3484
|
-
#
|
4042
|
+
# The tags used to organize, track, or control access for this
|
4043
|
+
# resource.
|
3485
4044
|
# @return [Hash<String,String>]
|
3486
4045
|
#
|
3487
4046
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HoursOfOperation AWS API Documentation
|
@@ -3589,6 +4148,19 @@ module Aws::Connect
|
|
3589
4148
|
include Aws::Structure
|
3590
4149
|
end
|
3591
4150
|
|
4151
|
+
# An entity with the same name already exists.
|
4152
|
+
#
|
4153
|
+
# @!attribute [rw] message
|
4154
|
+
# @return [String]
|
4155
|
+
#
|
4156
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/IdempotencyException AWS API Documentation
|
4157
|
+
#
|
4158
|
+
class IdempotencyException < Struct.new(
|
4159
|
+
:message)
|
4160
|
+
SENSITIVE = []
|
4161
|
+
include Aws::Structure
|
4162
|
+
end
|
4163
|
+
|
3592
4164
|
# The Amazon Connect instance.
|
3593
4165
|
#
|
3594
4166
|
# @!attribute [rw] id
|
@@ -3649,25 +4221,6 @@ module Aws::Connect
|
|
3649
4221
|
include Aws::Structure
|
3650
4222
|
end
|
3651
4223
|
|
3652
|
-
# The instance reference.
|
3653
|
-
#
|
3654
|
-
# @!attribute [rw] id
|
3655
|
-
# The identifier of the instance reference.
|
3656
|
-
# @return [String]
|
3657
|
-
#
|
3658
|
-
# @!attribute [rw] arn
|
3659
|
-
# The Amazon Resource Name (ARN) of the instance reference.
|
3660
|
-
# @return [String]
|
3661
|
-
#
|
3662
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InstanceReference AWS API Documentation
|
3663
|
-
#
|
3664
|
-
class InstanceReference < Struct.new(
|
3665
|
-
:id,
|
3666
|
-
:arn)
|
3667
|
-
SENSITIVE = []
|
3668
|
-
include Aws::Structure
|
3669
|
-
end
|
3670
|
-
|
3671
4224
|
# Relevant details why the instance was not successfully created.
|
3672
4225
|
#
|
3673
4226
|
# @!attribute [rw] message
|
@@ -3885,6 +4438,19 @@ module Aws::Connect
|
|
3885
4438
|
include Aws::Structure
|
3886
4439
|
end
|
3887
4440
|
|
4441
|
+
# The problems with the module. Please fix before trying again.
|
4442
|
+
#
|
4443
|
+
# @!attribute [rw] problems
|
4444
|
+
# @return [Array<Types::ProblemDetail>]
|
4445
|
+
#
|
4446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvalidContactFlowModuleException AWS API Documentation
|
4447
|
+
#
|
4448
|
+
class InvalidContactFlowModuleException < Struct.new(
|
4449
|
+
:problems)
|
4450
|
+
SENSITIVE = []
|
4451
|
+
include Aws::Structure
|
4452
|
+
end
|
4453
|
+
|
3888
4454
|
# One or more of the specified parameters are not valid.
|
3889
4455
|
#
|
3890
4456
|
# @!attribute [rw] message
|
@@ -4246,6 +4812,64 @@ module Aws::Connect
|
|
4246
4812
|
include Aws::Structure
|
4247
4813
|
end
|
4248
4814
|
|
4815
|
+
# @note When making an API call, you may pass ListContactFlowModulesRequest
|
4816
|
+
# data as a hash:
|
4817
|
+
#
|
4818
|
+
# {
|
4819
|
+
# instance_id: "InstanceId", # required
|
4820
|
+
# next_token: "NextToken",
|
4821
|
+
# max_results: 1,
|
4822
|
+
# contact_flow_module_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
4823
|
+
# }
|
4824
|
+
#
|
4825
|
+
# @!attribute [rw] instance_id
|
4826
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4827
|
+
# instanceId in the ARN of the instance.
|
4828
|
+
# @return [String]
|
4829
|
+
#
|
4830
|
+
# @!attribute [rw] next_token
|
4831
|
+
# The token for the next set of results. Use the value returned in the
|
4832
|
+
# previous response in the next request to retrieve the next set of
|
4833
|
+
# results.
|
4834
|
+
# @return [String]
|
4835
|
+
#
|
4836
|
+
# @!attribute [rw] max_results
|
4837
|
+
# The maximum number of results to return per page.
|
4838
|
+
# @return [Integer]
|
4839
|
+
#
|
4840
|
+
# @!attribute [rw] contact_flow_module_state
|
4841
|
+
# The state of the contact flow module.
|
4842
|
+
# @return [String]
|
4843
|
+
#
|
4844
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowModulesRequest AWS API Documentation
|
4845
|
+
#
|
4846
|
+
class ListContactFlowModulesRequest < Struct.new(
|
4847
|
+
:instance_id,
|
4848
|
+
:next_token,
|
4849
|
+
:max_results,
|
4850
|
+
:contact_flow_module_state)
|
4851
|
+
SENSITIVE = []
|
4852
|
+
include Aws::Structure
|
4853
|
+
end
|
4854
|
+
|
4855
|
+
# @!attribute [rw] contact_flow_modules_summary_list
|
4856
|
+
# Information about the contact flow module.
|
4857
|
+
# @return [Array<Types::ContactFlowModuleSummary>]
|
4858
|
+
#
|
4859
|
+
# @!attribute [rw] next_token
|
4860
|
+
# If there are additional results, this is the token for the next set
|
4861
|
+
# of results.
|
4862
|
+
# @return [String]
|
4863
|
+
#
|
4864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowModulesResponse AWS API Documentation
|
4865
|
+
#
|
4866
|
+
class ListContactFlowModulesResponse < Struct.new(
|
4867
|
+
:contact_flow_modules_summary_list,
|
4868
|
+
:next_token)
|
4869
|
+
SENSITIVE = []
|
4870
|
+
include Aws::Structure
|
4871
|
+
end
|
4872
|
+
|
4249
4873
|
# @note When making an API call, you may pass ListContactFlowsRequest
|
4250
4874
|
# data as a hash:
|
4251
4875
|
#
|
@@ -4304,6 +4928,69 @@ module Aws::Connect
|
|
4304
4928
|
include Aws::Structure
|
4305
4929
|
end
|
4306
4930
|
|
4931
|
+
# @note When making an API call, you may pass ListContactReferencesRequest
|
4932
|
+
# data as a hash:
|
4933
|
+
#
|
4934
|
+
# {
|
4935
|
+
# instance_id: "InstanceId", # required
|
4936
|
+
# contact_id: "ContactId", # required
|
4937
|
+
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT
|
4938
|
+
# next_token: "NextToken",
|
4939
|
+
# }
|
4940
|
+
#
|
4941
|
+
# @!attribute [rw] instance_id
|
4942
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4943
|
+
# instanceId in the ARN of the instance.
|
4944
|
+
# @return [String]
|
4945
|
+
#
|
4946
|
+
# @!attribute [rw] contact_id
|
4947
|
+
# The identifier of the initial contact.
|
4948
|
+
# @return [String]
|
4949
|
+
#
|
4950
|
+
# @!attribute [rw] reference_types
|
4951
|
+
# The type of reference.
|
4952
|
+
# @return [Array<String>]
|
4953
|
+
#
|
4954
|
+
# @!attribute [rw] next_token
|
4955
|
+
# The token for the next set of results. Use the value returned in the
|
4956
|
+
# previous response in the next request to retrieve the next set of
|
4957
|
+
# results.
|
4958
|
+
#
|
4959
|
+
# This is not expected to be set, because the value returned in the
|
4960
|
+
# previous response is always null.
|
4961
|
+
# @return [String]
|
4962
|
+
#
|
4963
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactReferencesRequest AWS API Documentation
|
4964
|
+
#
|
4965
|
+
class ListContactReferencesRequest < Struct.new(
|
4966
|
+
:instance_id,
|
4967
|
+
:contact_id,
|
4968
|
+
:reference_types,
|
4969
|
+
:next_token)
|
4970
|
+
SENSITIVE = []
|
4971
|
+
include Aws::Structure
|
4972
|
+
end
|
4973
|
+
|
4974
|
+
# @!attribute [rw] reference_summary_list
|
4975
|
+
# Information about the contact flows.
|
4976
|
+
# @return [Array<Types::ReferenceSummary>]
|
4977
|
+
#
|
4978
|
+
# @!attribute [rw] next_token
|
4979
|
+
# If there are additional results, this is the token for the next set
|
4980
|
+
# of results.
|
4981
|
+
#
|
4982
|
+
# This is always returned as null in the response.
|
4983
|
+
# @return [String]
|
4984
|
+
#
|
4985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactReferencesResponse AWS API Documentation
|
4986
|
+
#
|
4987
|
+
class ListContactReferencesResponse < Struct.new(
|
4988
|
+
:reference_summary_list,
|
4989
|
+
:next_token)
|
4990
|
+
SENSITIVE = []
|
4991
|
+
include Aws::Structure
|
4992
|
+
end
|
4993
|
+
|
4307
4994
|
# @note When making an API call, you may pass ListHoursOfOperationsRequest
|
4308
4995
|
# data as a hash:
|
4309
4996
|
#
|
@@ -4527,6 +5214,7 @@ module Aws::Connect
|
|
4527
5214
|
# @return [String]
|
4528
5215
|
#
|
4529
5216
|
# @!attribute [rw] integration_type
|
5217
|
+
# The integration type.
|
4530
5218
|
# @return [String]
|
4531
5219
|
#
|
4532
5220
|
# @!attribute [rw] next_token
|
@@ -5128,6 +5816,64 @@ module Aws::Connect
|
|
5128
5816
|
include Aws::Structure
|
5129
5817
|
end
|
5130
5818
|
|
5819
|
+
# @note When making an API call, you may pass ListSecurityProfilePermissionsRequest
|
5820
|
+
# data as a hash:
|
5821
|
+
#
|
5822
|
+
# {
|
5823
|
+
# security_profile_id: "SecurityProfileId", # required
|
5824
|
+
# instance_id: "InstanceId", # required
|
5825
|
+
# next_token: "NextToken",
|
5826
|
+
# max_results: 1,
|
5827
|
+
# }
|
5828
|
+
#
|
5829
|
+
# @!attribute [rw] security_profile_id
|
5830
|
+
# The identifier for the security profle.
|
5831
|
+
# @return [String]
|
5832
|
+
#
|
5833
|
+
# @!attribute [rw] instance_id
|
5834
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5835
|
+
# instanceId in the ARN of the instance.
|
5836
|
+
# @return [String]
|
5837
|
+
#
|
5838
|
+
# @!attribute [rw] next_token
|
5839
|
+
# The token for the next set of results. Use the value returned in the
|
5840
|
+
# previous response in the next request to retrieve the next set of
|
5841
|
+
# results.
|
5842
|
+
# @return [String]
|
5843
|
+
#
|
5844
|
+
# @!attribute [rw] max_results
|
5845
|
+
# The maximum number of results to return per page.
|
5846
|
+
# @return [Integer]
|
5847
|
+
#
|
5848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfilePermissionsRequest AWS API Documentation
|
5849
|
+
#
|
5850
|
+
class ListSecurityProfilePermissionsRequest < Struct.new(
|
5851
|
+
:security_profile_id,
|
5852
|
+
:instance_id,
|
5853
|
+
:next_token,
|
5854
|
+
:max_results)
|
5855
|
+
SENSITIVE = []
|
5856
|
+
include Aws::Structure
|
5857
|
+
end
|
5858
|
+
|
5859
|
+
# @!attribute [rw] permissions
|
5860
|
+
# The permissions granted to the security profile.
|
5861
|
+
# @return [Array<String>]
|
5862
|
+
#
|
5863
|
+
# @!attribute [rw] next_token
|
5864
|
+
# If there are additional results, this is the token for the next set
|
5865
|
+
# of results.
|
5866
|
+
# @return [String]
|
5867
|
+
#
|
5868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfilePermissionsResponse AWS API Documentation
|
5869
|
+
#
|
5870
|
+
class ListSecurityProfilePermissionsResponse < Struct.new(
|
5871
|
+
:permissions,
|
5872
|
+
:next_token)
|
5873
|
+
SENSITIVE = []
|
5874
|
+
include Aws::Structure
|
5875
|
+
end
|
5876
|
+
|
5131
5877
|
# @note When making an API call, you may pass ListSecurityProfilesRequest
|
5132
5878
|
# data as a hash:
|
5133
5879
|
#
|
@@ -5610,7 +6356,8 @@ module Aws::Connect
|
|
5610
6356
|
# @return [String]
|
5611
6357
|
#
|
5612
6358
|
# @!attribute [rw] tags
|
5613
|
-
#
|
6359
|
+
# The tags used to organize, track, or control access for this
|
6360
|
+
# resource.
|
5614
6361
|
# @return [Hash<String,String>]
|
5615
6362
|
#
|
5616
6363
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Queue AWS API Documentation
|
@@ -5629,6 +6376,25 @@ module Aws::Connect
|
|
5629
6376
|
include Aws::Structure
|
5630
6377
|
end
|
5631
6378
|
|
6379
|
+
# If this contact was queued, this contains information about the queue.
|
6380
|
+
#
|
6381
|
+
# @!attribute [rw] id
|
6382
|
+
# The identifier of the agent who accepted the contact.
|
6383
|
+
# @return [String]
|
6384
|
+
#
|
6385
|
+
# @!attribute [rw] enqueue_timestamp
|
6386
|
+
# The timestamp when the contact was added to the queue.
|
6387
|
+
# @return [Time]
|
6388
|
+
#
|
6389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueInfo AWS API Documentation
|
6390
|
+
#
|
6391
|
+
class QueueInfo < Struct.new(
|
6392
|
+
:id,
|
6393
|
+
:enqueue_timestamp)
|
6394
|
+
SENSITIVE = []
|
6395
|
+
include Aws::Structure
|
6396
|
+
end
|
6397
|
+
|
5632
6398
|
# Contains information about a queue for a quick connect. The contact
|
5633
6399
|
# flow must be of type Transfer to Queue.
|
5634
6400
|
#
|
@@ -5668,16 +6434,11 @@ module Aws::Connect
|
|
5668
6434
|
# The Amazon Resource Name (ARN) of the queue.
|
5669
6435
|
# @return [String]
|
5670
6436
|
#
|
5671
|
-
# @!attribute [rw] queue_type
|
5672
|
-
# The type of queue.
|
5673
|
-
# @return [String]
|
5674
|
-
#
|
5675
6437
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueReference AWS API Documentation
|
5676
6438
|
#
|
5677
6439
|
class QueueReference < Struct.new(
|
5678
6440
|
:id,
|
5679
|
-
:arn
|
5680
|
-
:queue_type)
|
6441
|
+
:arn)
|
5681
6442
|
SENSITIVE = []
|
5682
6443
|
include Aws::Structure
|
5683
6444
|
end
|
@@ -5734,7 +6495,8 @@ module Aws::Connect
|
|
5734
6495
|
# @return [Types::QuickConnectConfig]
|
5735
6496
|
#
|
5736
6497
|
# @!attribute [rw] tags
|
5737
|
-
#
|
6498
|
+
# The tags used to organize, track, or control access for this
|
6499
|
+
# resource.
|
5738
6500
|
# @return [Hash<String,String>]
|
5739
6501
|
#
|
5740
6502
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QuickConnect AWS API Documentation
|
@@ -5843,25 +6605,58 @@ module Aws::Connect
|
|
5843
6605
|
#
|
5844
6606
|
# {
|
5845
6607
|
# value: "ReferenceValue", # required
|
5846
|
-
# type: "URL", # required, accepts URL, ATTACHMENT
|
6608
|
+
# type: "URL", # required, accepts URL, ATTACHMENT
|
5847
6609
|
# }
|
5848
6610
|
#
|
5849
6611
|
# @!attribute [rw] value
|
5850
|
-
# A
|
5851
|
-
#
|
6612
|
+
# A valid value for the reference. For example, for a URL reference, a
|
6613
|
+
# formatted URL that is displayed to an agent in the Contact Control
|
6614
|
+
# Panel (CCP).
|
5852
6615
|
# @return [String]
|
5853
6616
|
#
|
5854
6617
|
# @!attribute [rw] type
|
5855
|
-
#
|
6618
|
+
# The type of the reference. Only `URL` type can be added or updated
|
6619
|
+
# on a contact.
|
5856
6620
|
# @return [String]
|
5857
6621
|
#
|
5858
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Reference AWS API Documentation
|
6622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Reference AWS API Documentation
|
6623
|
+
#
|
6624
|
+
class Reference < Struct.new(
|
6625
|
+
:value,
|
6626
|
+
:type)
|
6627
|
+
SENSITIVE = []
|
6628
|
+
include Aws::Structure
|
6629
|
+
end
|
6630
|
+
|
6631
|
+
# Contains summary information about a reference. `ReferenceSummary`
|
6632
|
+
# contains only one non null field between the URL and attachment based
|
6633
|
+
# on the reference type.
|
6634
|
+
#
|
6635
|
+
# @note ReferenceSummary is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ReferenceSummary corresponding to the set member.
|
6636
|
+
#
|
6637
|
+
# @!attribute [rw] url
|
6638
|
+
# Information about the URL reference if the `referenceType` is `URL`.
|
6639
|
+
# Otherwise, null.
|
6640
|
+
# @return [Types::UrlReference]
|
5859
6641
|
#
|
5860
|
-
|
5861
|
-
|
5862
|
-
|
6642
|
+
# @!attribute [rw] attachment
|
6643
|
+
# Information about the attachment reference if the `referenceType` is
|
6644
|
+
# `ATTACHMENT`. Otherwise, null.
|
6645
|
+
# @return [Types::AttachmentReference]
|
6646
|
+
#
|
6647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReferenceSummary AWS API Documentation
|
6648
|
+
#
|
6649
|
+
class ReferenceSummary < Struct.new(
|
6650
|
+
:url,
|
6651
|
+
:attachment,
|
6652
|
+
:unknown)
|
5863
6653
|
SENSITIVE = []
|
5864
6654
|
include Aws::Structure
|
6655
|
+
include Aws::Structure::Union
|
6656
|
+
|
6657
|
+
class Url < ReferenceSummary; end
|
6658
|
+
class Attachment < ReferenceSummary; end
|
6659
|
+
class Unknown < ReferenceSummary; end
|
5865
6660
|
end
|
5866
6661
|
|
5867
6662
|
# A resource already has that name.
|
@@ -6130,25 +6925,6 @@ module Aws::Connect
|
|
6130
6925
|
include Aws::Structure
|
6131
6926
|
end
|
6132
6927
|
|
6133
|
-
# The routing profile reference.
|
6134
|
-
#
|
6135
|
-
# @!attribute [rw] id
|
6136
|
-
# The identifier of the routing profile reference.
|
6137
|
-
# @return [String]
|
6138
|
-
#
|
6139
|
-
# @!attribute [rw] arn
|
6140
|
-
# The Amazon Resource Name (ARN) of the routing profile reference.
|
6141
|
-
# @return [String]
|
6142
|
-
#
|
6143
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileReference AWS API Documentation
|
6144
|
-
#
|
6145
|
-
class RoutingProfileReference < Struct.new(
|
6146
|
-
:id,
|
6147
|
-
:arn)
|
6148
|
-
SENSITIVE = []
|
6149
|
-
include Aws::Structure
|
6150
|
-
end
|
6151
|
-
|
6152
6928
|
# Contains summary information about a routing profile.
|
6153
6929
|
#
|
6154
6930
|
# @!attribute [rw] id
|
@@ -6235,6 +7011,46 @@ module Aws::Connect
|
|
6235
7011
|
include Aws::Structure
|
6236
7012
|
end
|
6237
7013
|
|
7014
|
+
# Contains information about a security profile.
|
7015
|
+
#
|
7016
|
+
# @!attribute [rw] id
|
7017
|
+
# The identifier for the security profile.
|
7018
|
+
# @return [String]
|
7019
|
+
#
|
7020
|
+
# @!attribute [rw] organization_resource_id
|
7021
|
+
# The organization resource identifier for the security profile.
|
7022
|
+
# @return [String]
|
7023
|
+
#
|
7024
|
+
# @!attribute [rw] arn
|
7025
|
+
# The Amazon Resource Name (ARN) for the secruity profile.
|
7026
|
+
# @return [String]
|
7027
|
+
#
|
7028
|
+
# @!attribute [rw] security_profile_name
|
7029
|
+
# The name for the security profile.
|
7030
|
+
# @return [String]
|
7031
|
+
#
|
7032
|
+
# @!attribute [rw] description
|
7033
|
+
# The description of the security profile.
|
7034
|
+
# @return [String]
|
7035
|
+
#
|
7036
|
+
# @!attribute [rw] tags
|
7037
|
+
# The tags used to organize, track, or control access for this
|
7038
|
+
# resource.
|
7039
|
+
# @return [Hash<String,String>]
|
7040
|
+
#
|
7041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SecurityProfile AWS API Documentation
|
7042
|
+
#
|
7043
|
+
class SecurityProfile < Struct.new(
|
7044
|
+
:id,
|
7045
|
+
:organization_resource_id,
|
7046
|
+
:arn,
|
7047
|
+
:security_profile_name,
|
7048
|
+
:description,
|
7049
|
+
:tags)
|
7050
|
+
SENSITIVE = []
|
7051
|
+
include Aws::Structure
|
7052
|
+
end
|
7053
|
+
|
6238
7054
|
# Contains information about a security profile.
|
6239
7055
|
#
|
6240
7056
|
# @!attribute [rw] id
|
@@ -6285,8 +7101,8 @@ module Aws::Connect
|
|
6285
7101
|
# display_name: "DisplayName", # required
|
6286
7102
|
# },
|
6287
7103
|
# initial_message: {
|
6288
|
-
# content_type: "ChatContentType",
|
6289
|
-
# content: "ChatContent",
|
7104
|
+
# content_type: "ChatContentType", # required
|
7105
|
+
# content: "ChatContent", # required
|
6290
7106
|
# },
|
6291
7107
|
# client_token: "ClientToken",
|
6292
7108
|
# }
|
@@ -6612,11 +7428,12 @@ module Aws::Connect
|
|
6612
7428
|
# references: {
|
6613
7429
|
# "ReferenceKey" => {
|
6614
7430
|
# value: "ReferenceValue", # required
|
6615
|
-
# type: "URL", # required, accepts URL, ATTACHMENT
|
7431
|
+
# type: "URL", # required, accepts URL, ATTACHMENT
|
6616
7432
|
# },
|
6617
7433
|
# },
|
6618
7434
|
# description: "Description",
|
6619
7435
|
# client_token: "ClientToken",
|
7436
|
+
# scheduled_time: Time.now,
|
6620
7437
|
# }
|
6621
7438
|
#
|
6622
7439
|
# @!attribute [rw] instance_id
|
@@ -6672,6 +7489,12 @@ module Aws::Connect
|
|
6672
7489
|
# not need to pass this option.
|
6673
7490
|
# @return [String]
|
6674
7491
|
#
|
7492
|
+
# @!attribute [rw] scheduled_time
|
7493
|
+
# The timestamp, in Unix Epoch seconds format, at which to start
|
7494
|
+
# running the inbound contact flow. The scheduled time cannot be in
|
7495
|
+
# the past. It must be within up to 6 days in future.
|
7496
|
+
# @return [Time]
|
7497
|
+
#
|
6675
7498
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactRequest AWS API Documentation
|
6676
7499
|
#
|
6677
7500
|
class StartTaskContactRequest < Struct.new(
|
@@ -6682,7 +7505,8 @@ module Aws::Connect
|
|
6682
7505
|
:name,
|
6683
7506
|
:references,
|
6684
7507
|
:description,
|
6685
|
-
:client_token
|
7508
|
+
:client_token,
|
7509
|
+
:scheduled_time)
|
6686
7510
|
SENSITIVE = []
|
6687
7511
|
include Aws::Structure
|
6688
7512
|
end
|
@@ -7072,6 +7896,134 @@ module Aws::Connect
|
|
7072
7896
|
include Aws::Structure
|
7073
7897
|
end
|
7074
7898
|
|
7899
|
+
# @note When making an API call, you may pass UpdateContactFlowMetadataRequest
|
7900
|
+
# data as a hash:
|
7901
|
+
#
|
7902
|
+
# {
|
7903
|
+
# instance_id: "InstanceId", # required
|
7904
|
+
# contact_flow_id: "ContactFlowId", # required
|
7905
|
+
# name: "ContactFlowName",
|
7906
|
+
# description: "ContactFlowDescription",
|
7907
|
+
# contact_flow_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
7908
|
+
# }
|
7909
|
+
#
|
7910
|
+
# @!attribute [rw] instance_id
|
7911
|
+
# The identifier of the Amazon Connect instance. You can find the
|
7912
|
+
# instanceId in the ARN of the instance.
|
7913
|
+
# @return [String]
|
7914
|
+
#
|
7915
|
+
# @!attribute [rw] contact_flow_id
|
7916
|
+
# The identifier of the contact flow.
|
7917
|
+
# @return [String]
|
7918
|
+
#
|
7919
|
+
# @!attribute [rw] name
|
7920
|
+
# TThe name of the contact flow.
|
7921
|
+
# @return [String]
|
7922
|
+
#
|
7923
|
+
# @!attribute [rw] description
|
7924
|
+
# The description of the contact flow.
|
7925
|
+
# @return [String]
|
7926
|
+
#
|
7927
|
+
# @!attribute [rw] contact_flow_state
|
7928
|
+
# The state of contact flow.
|
7929
|
+
# @return [String]
|
7930
|
+
#
|
7931
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowMetadataRequest AWS API Documentation
|
7932
|
+
#
|
7933
|
+
class UpdateContactFlowMetadataRequest < Struct.new(
|
7934
|
+
:instance_id,
|
7935
|
+
:contact_flow_id,
|
7936
|
+
:name,
|
7937
|
+
:description,
|
7938
|
+
:contact_flow_state)
|
7939
|
+
SENSITIVE = []
|
7940
|
+
include Aws::Structure
|
7941
|
+
end
|
7942
|
+
|
7943
|
+
# @note When making an API call, you may pass UpdateContactFlowModuleContentRequest
|
7944
|
+
# data as a hash:
|
7945
|
+
#
|
7946
|
+
# {
|
7947
|
+
# instance_id: "InstanceId", # required
|
7948
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
7949
|
+
# content: "ContactFlowModuleContent", # required
|
7950
|
+
# }
|
7951
|
+
#
|
7952
|
+
# @!attribute [rw] instance_id
|
7953
|
+
# The identifier of the Amazon Connect instance. You can find the
|
7954
|
+
# instanceId in the ARN of the instance.
|
7955
|
+
# @return [String]
|
7956
|
+
#
|
7957
|
+
# @!attribute [rw] contact_flow_module_id
|
7958
|
+
# The identifier of the contact flow module.
|
7959
|
+
# @return [String]
|
7960
|
+
#
|
7961
|
+
# @!attribute [rw] content
|
7962
|
+
# The content of the contact flow module.
|
7963
|
+
# @return [String]
|
7964
|
+
#
|
7965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleContentRequest AWS API Documentation
|
7966
|
+
#
|
7967
|
+
class UpdateContactFlowModuleContentRequest < Struct.new(
|
7968
|
+
:instance_id,
|
7969
|
+
:contact_flow_module_id,
|
7970
|
+
:content)
|
7971
|
+
SENSITIVE = []
|
7972
|
+
include Aws::Structure
|
7973
|
+
end
|
7974
|
+
|
7975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleContentResponse AWS API Documentation
|
7976
|
+
#
|
7977
|
+
class UpdateContactFlowModuleContentResponse < Aws::EmptyStructure; end
|
7978
|
+
|
7979
|
+
# @note When making an API call, you may pass UpdateContactFlowModuleMetadataRequest
|
7980
|
+
# data as a hash:
|
7981
|
+
#
|
7982
|
+
# {
|
7983
|
+
# instance_id: "InstanceId", # required
|
7984
|
+
# contact_flow_module_id: "ContactFlowModuleId", # required
|
7985
|
+
# name: "ContactFlowModuleName",
|
7986
|
+
# description: "ContactFlowModuleDescription",
|
7987
|
+
# state: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
7988
|
+
# }
|
7989
|
+
#
|
7990
|
+
# @!attribute [rw] instance_id
|
7991
|
+
# The identifier of the Amazon Connect instance. You can find the
|
7992
|
+
# instanceId in the ARN of the instance.
|
7993
|
+
# @return [String]
|
7994
|
+
#
|
7995
|
+
# @!attribute [rw] contact_flow_module_id
|
7996
|
+
# The identifier of the contact flow module.
|
7997
|
+
# @return [String]
|
7998
|
+
#
|
7999
|
+
# @!attribute [rw] name
|
8000
|
+
# The name of the contact flow module.
|
8001
|
+
# @return [String]
|
8002
|
+
#
|
8003
|
+
# @!attribute [rw] description
|
8004
|
+
# The description of the contact flow module.
|
8005
|
+
# @return [String]
|
8006
|
+
#
|
8007
|
+
# @!attribute [rw] state
|
8008
|
+
# The state of contact flow module.
|
8009
|
+
# @return [String]
|
8010
|
+
#
|
8011
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleMetadataRequest AWS API Documentation
|
8012
|
+
#
|
8013
|
+
class UpdateContactFlowModuleMetadataRequest < Struct.new(
|
8014
|
+
:instance_id,
|
8015
|
+
:contact_flow_module_id,
|
8016
|
+
:name,
|
8017
|
+
:description,
|
8018
|
+
:state)
|
8019
|
+
SENSITIVE = []
|
8020
|
+
include Aws::Structure
|
8021
|
+
end
|
8022
|
+
|
8023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleMetadataResponse AWS API Documentation
|
8024
|
+
#
|
8025
|
+
class UpdateContactFlowModuleMetadataResponse < Aws::EmptyStructure; end
|
8026
|
+
|
7075
8027
|
# @note When making an API call, you may pass UpdateContactFlowNameRequest
|
7076
8028
|
# data as a hash:
|
7077
8029
|
#
|
@@ -7109,6 +8061,99 @@ module Aws::Connect
|
|
7109
8061
|
include Aws::Structure
|
7110
8062
|
end
|
7111
8063
|
|
8064
|
+
# @note When making an API call, you may pass UpdateContactRequest
|
8065
|
+
# data as a hash:
|
8066
|
+
#
|
8067
|
+
# {
|
8068
|
+
# instance_id: "InstanceId", # required
|
8069
|
+
# contact_id: "ContactId", # required
|
8070
|
+
# name: "Name",
|
8071
|
+
# description: "Description",
|
8072
|
+
# references: {
|
8073
|
+
# "ReferenceKey" => {
|
8074
|
+
# value: "ReferenceValue", # required
|
8075
|
+
# type: "URL", # required, accepts URL, ATTACHMENT
|
8076
|
+
# },
|
8077
|
+
# },
|
8078
|
+
# }
|
8079
|
+
#
|
8080
|
+
# @!attribute [rw] instance_id
|
8081
|
+
# The identifier of the Amazon Connect instance. You can find the
|
8082
|
+
# instanceId in the ARN of the instance.
|
8083
|
+
# @return [String]
|
8084
|
+
#
|
8085
|
+
# @!attribute [rw] contact_id
|
8086
|
+
# The identifier of the contact. This is the identifier of the contact
|
8087
|
+
# associated with the first interaction with your contact center.
|
8088
|
+
# @return [String]
|
8089
|
+
#
|
8090
|
+
# @!attribute [rw] name
|
8091
|
+
# The name of the contact.
|
8092
|
+
# @return [String]
|
8093
|
+
#
|
8094
|
+
# @!attribute [rw] description
|
8095
|
+
# The description of the contact.
|
8096
|
+
# @return [String]
|
8097
|
+
#
|
8098
|
+
# @!attribute [rw] references
|
8099
|
+
# A formatted URL that is shown to an agent in the Contact Control
|
8100
|
+
# Panel (CCP).
|
8101
|
+
# @return [Hash<String,Types::Reference>]
|
8102
|
+
#
|
8103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactRequest AWS API Documentation
|
8104
|
+
#
|
8105
|
+
class UpdateContactRequest < Struct.new(
|
8106
|
+
:instance_id,
|
8107
|
+
:contact_id,
|
8108
|
+
:name,
|
8109
|
+
:description,
|
8110
|
+
:references)
|
8111
|
+
SENSITIVE = []
|
8112
|
+
include Aws::Structure
|
8113
|
+
end
|
8114
|
+
|
8115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactResponse AWS API Documentation
|
8116
|
+
#
|
8117
|
+
class UpdateContactResponse < Aws::EmptyStructure; end
|
8118
|
+
|
8119
|
+
# @note When making an API call, you may pass UpdateContactScheduleRequest
|
8120
|
+
# data as a hash:
|
8121
|
+
#
|
8122
|
+
# {
|
8123
|
+
# instance_id: "InstanceId", # required
|
8124
|
+
# contact_id: "ContactId", # required
|
8125
|
+
# scheduled_time: Time.now, # required
|
8126
|
+
# }
|
8127
|
+
#
|
8128
|
+
# @!attribute [rw] instance_id
|
8129
|
+
# The identifier of the Amazon Connect instance. You can find the
|
8130
|
+
# instanceId in the ARN of the instance.
|
8131
|
+
# @return [String]
|
8132
|
+
#
|
8133
|
+
# @!attribute [rw] contact_id
|
8134
|
+
# The identifier of the contact.
|
8135
|
+
# @return [String]
|
8136
|
+
#
|
8137
|
+
# @!attribute [rw] scheduled_time
|
8138
|
+
# The timestamp, in Unix Epoch seconds format, at which to start
|
8139
|
+
# running the inbound contact flow. The scheduled time cannot be in
|
8140
|
+
# the past. It must be within up to 6 days in future.
|
8141
|
+
# @return [Time]
|
8142
|
+
#
|
8143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactScheduleRequest AWS API Documentation
|
8144
|
+
#
|
8145
|
+
class UpdateContactScheduleRequest < Struct.new(
|
8146
|
+
:instance_id,
|
8147
|
+
:contact_id,
|
8148
|
+
:scheduled_time)
|
8149
|
+
SENSITIVE = []
|
8150
|
+
include Aws::Structure
|
8151
|
+
end
|
8152
|
+
|
8153
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactScheduleResponse AWS API Documentation
|
8154
|
+
#
|
8155
|
+
class UpdateContactScheduleResponse < Aws::EmptyStructure; end
|
8156
|
+
|
7112
8157
|
# @note When making an API call, you may pass UpdateHoursOfOperationRequest
|
7113
8158
|
# data as a hash:
|
7114
8159
|
#
|
@@ -7679,6 +8724,44 @@ module Aws::Connect
|
|
7679
8724
|
include Aws::Structure
|
7680
8725
|
end
|
7681
8726
|
|
8727
|
+
# @note When making an API call, you may pass UpdateSecurityProfileRequest
|
8728
|
+
# data as a hash:
|
8729
|
+
#
|
8730
|
+
# {
|
8731
|
+
# description: "SecurityProfileDescription",
|
8732
|
+
# permissions: ["SecurityProfilePermission"],
|
8733
|
+
# security_profile_id: "SecurityProfileId", # required
|
8734
|
+
# instance_id: "InstanceId", # required
|
8735
|
+
# }
|
8736
|
+
#
|
8737
|
+
# @!attribute [rw] description
|
8738
|
+
# The description of the security profile.
|
8739
|
+
# @return [String]
|
8740
|
+
#
|
8741
|
+
# @!attribute [rw] permissions
|
8742
|
+
# The permissions granted to a security profile.
|
8743
|
+
# @return [Array<String>]
|
8744
|
+
#
|
8745
|
+
# @!attribute [rw] security_profile_id
|
8746
|
+
# The identifier for the security profle.
|
8747
|
+
# @return [String]
|
8748
|
+
#
|
8749
|
+
# @!attribute [rw] instance_id
|
8750
|
+
# The identifier of the Amazon Connect instance. You can find the
|
8751
|
+
# instanceId in the ARN of the instance.
|
8752
|
+
# @return [String]
|
8753
|
+
#
|
8754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateSecurityProfileRequest AWS API Documentation
|
8755
|
+
#
|
8756
|
+
class UpdateSecurityProfileRequest < Struct.new(
|
8757
|
+
:description,
|
8758
|
+
:permissions,
|
8759
|
+
:security_profile_id,
|
8760
|
+
:instance_id)
|
8761
|
+
SENSITIVE = []
|
8762
|
+
include Aws::Structure
|
8763
|
+
end
|
8764
|
+
|
7682
8765
|
# @note When making an API call, you may pass UpdateUserHierarchyGroupNameRequest
|
7683
8766
|
# data as a hash:
|
7684
8767
|
#
|
@@ -7923,6 +9006,25 @@ module Aws::Connect
|
|
7923
9006
|
include Aws::Structure
|
7924
9007
|
end
|
7925
9008
|
|
9009
|
+
# The URL reference.
|
9010
|
+
#
|
9011
|
+
# @!attribute [rw] name
|
9012
|
+
# Identifier of the URL reference.
|
9013
|
+
# @return [String]
|
9014
|
+
#
|
9015
|
+
# @!attribute [rw] value
|
9016
|
+
# A valid URL.
|
9017
|
+
# @return [String]
|
9018
|
+
#
|
9019
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UrlReference AWS API Documentation
|
9020
|
+
#
|
9021
|
+
class UrlReference < Struct.new(
|
9022
|
+
:name,
|
9023
|
+
:value)
|
9024
|
+
SENSITIVE = []
|
9025
|
+
include Aws::Structure
|
9026
|
+
end
|
9027
|
+
|
7926
9028
|
# Contains the use case.
|
7927
9029
|
#
|
7928
9030
|
# @!attribute [rw] use_case_id
|