aws-sdk-connect 1.48.0 → 1.52.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/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +430 -29
- data/lib/aws-sdk-connect/client_api.rb +231 -10
- data/lib/aws-sdk-connect/types.rb +588 -21
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +5 -5
@@ -10,6 +10,113 @@
|
|
10
10
|
module Aws::Connect
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# Contains information about an agent status.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] agent_status_arn
|
16
|
+
# The Amazon Resource Name (ARN) of the agent status.
|
17
|
+
# @return [String]
|
18
|
+
#
|
19
|
+
# @!attribute [rw] agent_status_id
|
20
|
+
# The identifier of the agent status.
|
21
|
+
# @return [String]
|
22
|
+
#
|
23
|
+
# @!attribute [rw] name
|
24
|
+
# The name of the agent status.
|
25
|
+
# @return [String]
|
26
|
+
#
|
27
|
+
# @!attribute [rw] description
|
28
|
+
# The description of the agent status.
|
29
|
+
# @return [String]
|
30
|
+
#
|
31
|
+
# @!attribute [rw] type
|
32
|
+
# The type of agent status.
|
33
|
+
# @return [String]
|
34
|
+
#
|
35
|
+
# @!attribute [rw] display_order
|
36
|
+
# The display order of the agent status.
|
37
|
+
# @return [Integer]
|
38
|
+
#
|
39
|
+
# @!attribute [rw] state
|
40
|
+
# The state of the agent status.
|
41
|
+
# @return [String]
|
42
|
+
#
|
43
|
+
# @!attribute [rw] tags
|
44
|
+
# One or more tags.
|
45
|
+
# @return [Hash<String,String>]
|
46
|
+
#
|
47
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentStatus AWS API Documentation
|
48
|
+
#
|
49
|
+
class AgentStatus < Struct.new(
|
50
|
+
:agent_status_arn,
|
51
|
+
:agent_status_id,
|
52
|
+
:name,
|
53
|
+
:description,
|
54
|
+
:type,
|
55
|
+
:display_order,
|
56
|
+
:state,
|
57
|
+
:tags)
|
58
|
+
SENSITIVE = []
|
59
|
+
include Aws::Structure
|
60
|
+
end
|
61
|
+
|
62
|
+
# Summary information for an agent status.
|
63
|
+
#
|
64
|
+
# @!attribute [rw] id
|
65
|
+
# The identifier for an agent status.
|
66
|
+
# @return [String]
|
67
|
+
#
|
68
|
+
# @!attribute [rw] arn
|
69
|
+
# The Amazon Resource Name (ARN) for the agent status.
|
70
|
+
# @return [String]
|
71
|
+
#
|
72
|
+
# @!attribute [rw] name
|
73
|
+
# The name of the agent status.
|
74
|
+
# @return [String]
|
75
|
+
#
|
76
|
+
# @!attribute [rw] type
|
77
|
+
# The type of the agent status.
|
78
|
+
# @return [String]
|
79
|
+
#
|
80
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentStatusSummary AWS API Documentation
|
81
|
+
#
|
82
|
+
class AgentStatusSummary < Struct.new(
|
83
|
+
:id,
|
84
|
+
:arn,
|
85
|
+
:name,
|
86
|
+
:type)
|
87
|
+
SENSITIVE = []
|
88
|
+
include Aws::Structure
|
89
|
+
end
|
90
|
+
|
91
|
+
# Configuration of the answering machine detection.
|
92
|
+
#
|
93
|
+
# @note When making an API call, you may pass AnswerMachineDetectionConfig
|
94
|
+
# data as a hash:
|
95
|
+
#
|
96
|
+
# {
|
97
|
+
# enable_answer_machine_detection: false,
|
98
|
+
# await_answer_machine_prompt: false,
|
99
|
+
# }
|
100
|
+
#
|
101
|
+
# @!attribute [rw] enable_answer_machine_detection
|
102
|
+
# The flag to indicate if answer machine detection analysis needs to
|
103
|
+
# be performed for a voice call. If set to `true`, `TrafficType` must
|
104
|
+
# be set as `CAMPAIGN`.
|
105
|
+
# @return [Boolean]
|
106
|
+
#
|
107
|
+
# @!attribute [rw] await_answer_machine_prompt
|
108
|
+
# Wait for the answering machine prompt.
|
109
|
+
# @return [Boolean]
|
110
|
+
#
|
111
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AnswerMachineDetectionConfig AWS API Documentation
|
112
|
+
#
|
113
|
+
class AnswerMachineDetectionConfig < Struct.new(
|
114
|
+
:enable_answer_machine_detection,
|
115
|
+
:await_answer_machine_prompt)
|
116
|
+
SENSITIVE = []
|
117
|
+
include Aws::Structure
|
118
|
+
end
|
119
|
+
|
13
120
|
# @note When making an API call, you may pass AssociateApprovedOriginRequest
|
14
121
|
# data as a hash:
|
15
122
|
#
|
@@ -470,6 +577,75 @@ module Aws::Connect
|
|
470
577
|
include Aws::Structure
|
471
578
|
end
|
472
579
|
|
580
|
+
# @note When making an API call, you may pass CreateAgentStatusRequest
|
581
|
+
# data as a hash:
|
582
|
+
#
|
583
|
+
# {
|
584
|
+
# instance_id: "InstanceId", # required
|
585
|
+
# name: "AgentStatusName", # required
|
586
|
+
# description: "AgentStatusDescription",
|
587
|
+
# state: "ENABLED", # required, accepts ENABLED, DISABLED
|
588
|
+
# display_order: 1,
|
589
|
+
# tags: {
|
590
|
+
# "TagKey" => "TagValue",
|
591
|
+
# },
|
592
|
+
# }
|
593
|
+
#
|
594
|
+
# @!attribute [rw] instance_id
|
595
|
+
# The identifier of the Amazon Connect instance. You can find the
|
596
|
+
# instanceId in the ARN of the instance.
|
597
|
+
# @return [String]
|
598
|
+
#
|
599
|
+
# @!attribute [rw] name
|
600
|
+
# The name of the status.
|
601
|
+
# @return [String]
|
602
|
+
#
|
603
|
+
# @!attribute [rw] description
|
604
|
+
# The description of the status.
|
605
|
+
# @return [String]
|
606
|
+
#
|
607
|
+
# @!attribute [rw] state
|
608
|
+
# The state of the status.
|
609
|
+
# @return [String]
|
610
|
+
#
|
611
|
+
# @!attribute [rw] display_order
|
612
|
+
# The display order of the status.
|
613
|
+
# @return [Integer]
|
614
|
+
#
|
615
|
+
# @!attribute [rw] tags
|
616
|
+
# One or more tags.
|
617
|
+
# @return [Hash<String,String>]
|
618
|
+
#
|
619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateAgentStatusRequest AWS API Documentation
|
620
|
+
#
|
621
|
+
class CreateAgentStatusRequest < Struct.new(
|
622
|
+
:instance_id,
|
623
|
+
:name,
|
624
|
+
:description,
|
625
|
+
:state,
|
626
|
+
:display_order,
|
627
|
+
:tags)
|
628
|
+
SENSITIVE = []
|
629
|
+
include Aws::Structure
|
630
|
+
end
|
631
|
+
|
632
|
+
# @!attribute [rw] agent_status_arn
|
633
|
+
# The Amazon Resource Name (ARN) of the agent status.
|
634
|
+
# @return [String]
|
635
|
+
#
|
636
|
+
# @!attribute [rw] agent_status_id
|
637
|
+
# The identifier of the agent status.
|
638
|
+
# @return [String]
|
639
|
+
#
|
640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateAgentStatusResponse AWS API Documentation
|
641
|
+
#
|
642
|
+
class CreateAgentStatusResponse < Struct.new(
|
643
|
+
:agent_status_arn,
|
644
|
+
:agent_status_id)
|
645
|
+
SENSITIVE = []
|
646
|
+
include Aws::Structure
|
647
|
+
end
|
648
|
+
|
473
649
|
# @note When making an API call, you may pass CreateContactFlowRequest
|
474
650
|
# data as a hash:
|
475
651
|
#
|
@@ -544,6 +720,88 @@ module Aws::Connect
|
|
544
720
|
include Aws::Structure
|
545
721
|
end
|
546
722
|
|
723
|
+
# @note When making an API call, you may pass CreateHoursOfOperationRequest
|
724
|
+
# data as a hash:
|
725
|
+
#
|
726
|
+
# {
|
727
|
+
# instance_id: "InstanceId", # required
|
728
|
+
# name: "CommonNameLength127", # required
|
729
|
+
# description: "HoursOfOperationDescription",
|
730
|
+
# time_zone: "TimeZone", # required
|
731
|
+
# config: [ # required
|
732
|
+
# {
|
733
|
+
# day: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
734
|
+
# start_time: { # required
|
735
|
+
# hours: 1, # required
|
736
|
+
# minutes: 1, # required
|
737
|
+
# },
|
738
|
+
# end_time: { # required
|
739
|
+
# hours: 1, # required
|
740
|
+
# minutes: 1, # required
|
741
|
+
# },
|
742
|
+
# },
|
743
|
+
# ],
|
744
|
+
# tags: {
|
745
|
+
# "TagKey" => "TagValue",
|
746
|
+
# },
|
747
|
+
# }
|
748
|
+
#
|
749
|
+
# @!attribute [rw] instance_id
|
750
|
+
# The identifier of the Amazon Connect instance. You can find the
|
751
|
+
# instanceId in the ARN of the instance.
|
752
|
+
# @return [String]
|
753
|
+
#
|
754
|
+
# @!attribute [rw] name
|
755
|
+
# The name of the hours of operation.
|
756
|
+
# @return [String]
|
757
|
+
#
|
758
|
+
# @!attribute [rw] description
|
759
|
+
# The description of the hours of operation.
|
760
|
+
# @return [String]
|
761
|
+
#
|
762
|
+
# @!attribute [rw] time_zone
|
763
|
+
# The time zone of the hours of operation.
|
764
|
+
# @return [String]
|
765
|
+
#
|
766
|
+
# @!attribute [rw] config
|
767
|
+
# Configuration information for the hours of operation: day, start
|
768
|
+
# time, and end time.
|
769
|
+
# @return [Array<Types::HoursOfOperationConfig>]
|
770
|
+
#
|
771
|
+
# @!attribute [rw] tags
|
772
|
+
# One or more tags.
|
773
|
+
# @return [Hash<String,String>]
|
774
|
+
#
|
775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateHoursOfOperationRequest AWS API Documentation
|
776
|
+
#
|
777
|
+
class CreateHoursOfOperationRequest < Struct.new(
|
778
|
+
:instance_id,
|
779
|
+
:name,
|
780
|
+
:description,
|
781
|
+
:time_zone,
|
782
|
+
:config,
|
783
|
+
:tags)
|
784
|
+
SENSITIVE = []
|
785
|
+
include Aws::Structure
|
786
|
+
end
|
787
|
+
|
788
|
+
# @!attribute [rw] hours_of_operation_id
|
789
|
+
# The identifier for the hours of operation.
|
790
|
+
# @return [String]
|
791
|
+
#
|
792
|
+
# @!attribute [rw] hours_of_operation_arn
|
793
|
+
# The Amazon Resource Name (ARN) for the hours of operation.
|
794
|
+
# @return [String]
|
795
|
+
#
|
796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateHoursOfOperationResponse AWS API Documentation
|
797
|
+
#
|
798
|
+
class CreateHoursOfOperationResponse < Struct.new(
|
799
|
+
:hours_of_operation_id,
|
800
|
+
:hours_of_operation_arn)
|
801
|
+
SENSITIVE = []
|
802
|
+
include Aws::Structure
|
803
|
+
end
|
804
|
+
|
547
805
|
# @note When making an API call, you may pass CreateInstanceRequest
|
548
806
|
# data as a hash:
|
549
807
|
#
|
@@ -615,11 +873,11 @@ module Aws::Connect
|
|
615
873
|
#
|
616
874
|
# {
|
617
875
|
# instance_id: "InstanceId", # required
|
618
|
-
# integration_type: "EVENT", # required, accepts EVENT
|
876
|
+
# integration_type: "EVENT", # required, accepts EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE
|
619
877
|
# integration_arn: "ARN", # required
|
620
|
-
# source_application_url: "URI",
|
621
|
-
# source_application_name: "SourceApplicationName",
|
622
|
-
# source_type: "SALESFORCE", #
|
878
|
+
# source_application_url: "URI",
|
879
|
+
# source_application_name: "SourceApplicationName",
|
880
|
+
# source_type: "SALESFORCE", # accepts SALESFORCE, ZENDESK
|
623
881
|
# tags: {
|
624
882
|
# "TagKey" => "TagValue",
|
625
883
|
# },
|
@@ -639,15 +897,18 @@ module Aws::Connect
|
|
639
897
|
# @return [String]
|
640
898
|
#
|
641
899
|
# @!attribute [rw] source_application_url
|
642
|
-
# The URL for the external application.
|
900
|
+
# The URL for the external application. This field is only required
|
901
|
+
# for the EVENT integration type.
|
643
902
|
# @return [String]
|
644
903
|
#
|
645
904
|
# @!attribute [rw] source_application_name
|
646
|
-
# The name of the external application.
|
905
|
+
# The name of the external application. This field is only required
|
906
|
+
# for the EVENT integration type.
|
647
907
|
# @return [String]
|
648
908
|
#
|
649
909
|
# @!attribute [rw] source_type
|
650
|
-
# The type of the data source.
|
910
|
+
# The type of the data source. This field is only required for the
|
911
|
+
# EVENT integration type.
|
651
912
|
# @return [String]
|
652
913
|
#
|
653
914
|
# @!attribute [rw] tags
|
@@ -669,7 +930,7 @@ module Aws::Connect
|
|
669
930
|
end
|
670
931
|
|
671
932
|
# @!attribute [rw] integration_association_id
|
672
|
-
# The identifier for the association.
|
933
|
+
# The identifier for the integration association.
|
673
934
|
# @return [String]
|
674
935
|
#
|
675
936
|
# @!attribute [rw] integration_association_arn
|
@@ -946,7 +1207,7 @@ module Aws::Connect
|
|
946
1207
|
# {
|
947
1208
|
# instance_id: "InstanceId", # required
|
948
1209
|
# integration_association_id: "IntegrationAssociationId", # required
|
949
|
-
# use_case_type: "RULES_EVALUATION", # required, accepts RULES_EVALUATION
|
1210
|
+
# use_case_type: "RULES_EVALUATION", # required, accepts RULES_EVALUATION, CONNECT_CAMPAIGNS
|
950
1211
|
# tags: {
|
951
1212
|
# "TagKey" => "TagValue",
|
952
1213
|
# },
|
@@ -958,12 +1219,12 @@ module Aws::Connect
|
|
958
1219
|
# @return [String]
|
959
1220
|
#
|
960
1221
|
# @!attribute [rw] integration_association_id
|
961
|
-
# The identifier for the
|
1222
|
+
# The identifier for the integration association.
|
962
1223
|
# @return [String]
|
963
1224
|
#
|
964
1225
|
# @!attribute [rw] use_case_type
|
965
|
-
# The type of use case to associate to the
|
966
|
-
# Each
|
1226
|
+
# The type of use case to associate to the integration association.
|
1227
|
+
# Each integration association can have only one of each use case
|
967
1228
|
# type.
|
968
1229
|
# @return [String]
|
969
1230
|
#
|
@@ -1271,6 +1532,32 @@ module Aws::Connect
|
|
1271
1532
|
include Aws::Structure
|
1272
1533
|
end
|
1273
1534
|
|
1535
|
+
# @note When making an API call, you may pass DeleteHoursOfOperationRequest
|
1536
|
+
# data as a hash:
|
1537
|
+
#
|
1538
|
+
# {
|
1539
|
+
# instance_id: "InstanceId", # required
|
1540
|
+
# hours_of_operation_id: "HoursOfOperationId", # required
|
1541
|
+
# }
|
1542
|
+
#
|
1543
|
+
# @!attribute [rw] instance_id
|
1544
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1545
|
+
# instanceId in the ARN of the instance.
|
1546
|
+
# @return [String]
|
1547
|
+
#
|
1548
|
+
# @!attribute [rw] hours_of_operation_id
|
1549
|
+
# The identifier for the hours of operation.
|
1550
|
+
# @return [String]
|
1551
|
+
#
|
1552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteHoursOfOperationRequest AWS API Documentation
|
1553
|
+
#
|
1554
|
+
class DeleteHoursOfOperationRequest < Struct.new(
|
1555
|
+
:instance_id,
|
1556
|
+
:hours_of_operation_id)
|
1557
|
+
SENSITIVE = []
|
1558
|
+
include Aws::Structure
|
1559
|
+
end
|
1560
|
+
|
1274
1561
|
# @note When making an API call, you may pass DeleteInstanceRequest
|
1275
1562
|
# data as a hash:
|
1276
1563
|
#
|
@@ -1305,7 +1592,7 @@ module Aws::Connect
|
|
1305
1592
|
# @return [String]
|
1306
1593
|
#
|
1307
1594
|
# @!attribute [rw] integration_association_id
|
1308
|
-
# The identifier for the
|
1595
|
+
# The identifier for the integration association.
|
1309
1596
|
# @return [String]
|
1310
1597
|
#
|
1311
1598
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteIntegrationAssociationRequest AWS API Documentation
|
@@ -1358,7 +1645,7 @@ module Aws::Connect
|
|
1358
1645
|
# @return [String]
|
1359
1646
|
#
|
1360
1647
|
# @!attribute [rw] integration_association_id
|
1361
|
-
# The identifier for the
|
1648
|
+
# The identifier for the integration association.
|
1362
1649
|
# @return [String]
|
1363
1650
|
#
|
1364
1651
|
# @!attribute [rw] use_case_id
|
@@ -1427,6 +1714,44 @@ module Aws::Connect
|
|
1427
1714
|
include Aws::Structure
|
1428
1715
|
end
|
1429
1716
|
|
1717
|
+
# @note When making an API call, you may pass DescribeAgentStatusRequest
|
1718
|
+
# data as a hash:
|
1719
|
+
#
|
1720
|
+
# {
|
1721
|
+
# instance_id: "InstanceId", # required
|
1722
|
+
# agent_status_id: "AgentStatusId", # required
|
1723
|
+
# }
|
1724
|
+
#
|
1725
|
+
# @!attribute [rw] instance_id
|
1726
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1727
|
+
# instanceId in the ARN of the instance.
|
1728
|
+
# @return [String]
|
1729
|
+
#
|
1730
|
+
# @!attribute [rw] agent_status_id
|
1731
|
+
# The identifier for the agent status.
|
1732
|
+
# @return [String]
|
1733
|
+
#
|
1734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeAgentStatusRequest AWS API Documentation
|
1735
|
+
#
|
1736
|
+
class DescribeAgentStatusRequest < Struct.new(
|
1737
|
+
:instance_id,
|
1738
|
+
:agent_status_id)
|
1739
|
+
SENSITIVE = []
|
1740
|
+
include Aws::Structure
|
1741
|
+
end
|
1742
|
+
|
1743
|
+
# @!attribute [rw] agent_status
|
1744
|
+
# The agent status.
|
1745
|
+
# @return [Types::AgentStatus]
|
1746
|
+
#
|
1747
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeAgentStatusResponse AWS API Documentation
|
1748
|
+
#
|
1749
|
+
class DescribeAgentStatusResponse < Struct.new(
|
1750
|
+
:agent_status)
|
1751
|
+
SENSITIVE = []
|
1752
|
+
include Aws::Structure
|
1753
|
+
end
|
1754
|
+
|
1430
1755
|
# @note When making an API call, you may pass DescribeContactFlowRequest
|
1431
1756
|
# data as a hash:
|
1432
1757
|
#
|
@@ -2151,7 +2476,12 @@ module Aws::Connect
|
|
2151
2476
|
# @return [String]
|
2152
2477
|
#
|
2153
2478
|
# @!attribute [rw] key_id
|
2154
|
-
# The
|
2479
|
+
# The full ARN of the encryption key.
|
2480
|
+
#
|
2481
|
+
# <note markdown="1"> Be sure to provide the full ARN of the encryption key, not just the
|
2482
|
+
# ID.
|
2483
|
+
#
|
2484
|
+
# </note>
|
2155
2485
|
# @return [String]
|
2156
2486
|
#
|
2157
2487
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EncryptionConfig AWS API Documentation
|
@@ -2342,7 +2672,10 @@ module Aws::Connect
|
|
2342
2672
|
#
|
2343
2673
|
# : Unit: SECONDS
|
2344
2674
|
#
|
2345
|
-
# When you use groupings, Unit says SECONDS
|
2675
|
+
# When you use groupings, Unit says SECONDS and the Value is
|
2676
|
+
# returned in SECONDS.
|
2677
|
+
#
|
2678
|
+
# When you do not use groupings, Unit says SECONDS but the Value is
|
2346
2679
|
# returned in MILLISECONDS. For example, if you get a response like
|
2347
2680
|
# this:
|
2348
2681
|
#
|
@@ -3125,6 +3458,21 @@ module Aws::Connect
|
|
3125
3458
|
|
3126
3459
|
# Contains information about the hours of operation.
|
3127
3460
|
#
|
3461
|
+
# @note When making an API call, you may pass HoursOfOperationConfig
|
3462
|
+
# data as a hash:
|
3463
|
+
#
|
3464
|
+
# {
|
3465
|
+
# day: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
3466
|
+
# start_time: { # required
|
3467
|
+
# hours: 1, # required
|
3468
|
+
# minutes: 1, # required
|
3469
|
+
# },
|
3470
|
+
# end_time: { # required
|
3471
|
+
# hours: 1, # required
|
3472
|
+
# minutes: 1, # required
|
3473
|
+
# },
|
3474
|
+
# }
|
3475
|
+
#
|
3128
3476
|
# @!attribute [rw] day
|
3129
3477
|
# The day that the hours of operation applies to.
|
3130
3478
|
# @return [String]
|
@@ -3174,6 +3522,14 @@ module Aws::Connect
|
|
3174
3522
|
|
3175
3523
|
# The start time or end time for an hours of operation.
|
3176
3524
|
#
|
3525
|
+
# @note When making an API call, you may pass HoursOfOperationTimeSlice
|
3526
|
+
# data as a hash:
|
3527
|
+
#
|
3528
|
+
# {
|
3529
|
+
# hours: 1, # required
|
3530
|
+
# minutes: 1, # required
|
3531
|
+
# }
|
3532
|
+
#
|
3177
3533
|
# @!attribute [rw] hours
|
3178
3534
|
# The hours.
|
3179
3535
|
# @return [Integer]
|
@@ -3660,6 +4016,64 @@ module Aws::Connect
|
|
3660
4016
|
include Aws::Structure
|
3661
4017
|
end
|
3662
4018
|
|
4019
|
+
# @note When making an API call, you may pass ListAgentStatusRequest
|
4020
|
+
# data as a hash:
|
4021
|
+
#
|
4022
|
+
# {
|
4023
|
+
# instance_id: "InstanceId", # required
|
4024
|
+
# next_token: "NextToken",
|
4025
|
+
# max_results: 1,
|
4026
|
+
# agent_status_types: ["ROUTABLE"], # accepts ROUTABLE, CUSTOM, OFFLINE
|
4027
|
+
# }
|
4028
|
+
#
|
4029
|
+
# @!attribute [rw] instance_id
|
4030
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4031
|
+
# instanceId in the ARN of the instance.
|
4032
|
+
# @return [String]
|
4033
|
+
#
|
4034
|
+
# @!attribute [rw] next_token
|
4035
|
+
# The token for the next set of results. Use the value returned in the
|
4036
|
+
# previous response in the next request to retrieve the next set of
|
4037
|
+
# results.
|
4038
|
+
# @return [String]
|
4039
|
+
#
|
4040
|
+
# @!attribute [rw] max_results
|
4041
|
+
# The maximum number of results to return per page.
|
4042
|
+
# @return [Integer]
|
4043
|
+
#
|
4044
|
+
# @!attribute [rw] agent_status_types
|
4045
|
+
# Available agent status types.
|
4046
|
+
# @return [Array<String>]
|
4047
|
+
#
|
4048
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAgentStatusRequest AWS API Documentation
|
4049
|
+
#
|
4050
|
+
class ListAgentStatusRequest < Struct.new(
|
4051
|
+
:instance_id,
|
4052
|
+
:next_token,
|
4053
|
+
:max_results,
|
4054
|
+
:agent_status_types)
|
4055
|
+
SENSITIVE = []
|
4056
|
+
include Aws::Structure
|
4057
|
+
end
|
4058
|
+
|
4059
|
+
# @!attribute [rw] next_token
|
4060
|
+
# If there are additional results, this is the token for the next set
|
4061
|
+
# of results.
|
4062
|
+
# @return [String]
|
4063
|
+
#
|
4064
|
+
# @!attribute [rw] agent_status_summary_list
|
4065
|
+
# A summary of agent statuses.
|
4066
|
+
# @return [Array<Types::AgentStatusSummary>]
|
4067
|
+
#
|
4068
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAgentStatusResponse AWS API Documentation
|
4069
|
+
#
|
4070
|
+
class ListAgentStatusResponse < Struct.new(
|
4071
|
+
:next_token,
|
4072
|
+
:agent_status_summary_list)
|
4073
|
+
SENSITIVE = []
|
4074
|
+
include Aws::Structure
|
4075
|
+
end
|
4076
|
+
|
3663
4077
|
# @note When making an API call, you may pass ListApprovedOriginsRequest
|
3664
4078
|
# data as a hash:
|
3665
4079
|
#
|
@@ -4041,6 +4455,7 @@ module Aws::Connect
|
|
4041
4455
|
#
|
4042
4456
|
# {
|
4043
4457
|
# instance_id: "InstanceId", # required
|
4458
|
+
# integration_type: "EVENT", # accepts EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE
|
4044
4459
|
# next_token: "NextToken",
|
4045
4460
|
# max_results: 1,
|
4046
4461
|
# }
|
@@ -4050,6 +4465,9 @@ module Aws::Connect
|
|
4050
4465
|
# instanceId in the ARN of the instance.
|
4051
4466
|
# @return [String]
|
4052
4467
|
#
|
4468
|
+
# @!attribute [rw] integration_type
|
4469
|
+
# @return [String]
|
4470
|
+
#
|
4053
4471
|
# @!attribute [rw] next_token
|
4054
4472
|
# The token for the next set of results. Use the value returned in the
|
4055
4473
|
# previous response in the next request to retrieve the next set of
|
@@ -4064,6 +4482,7 @@ module Aws::Connect
|
|
4064
4482
|
#
|
4065
4483
|
class ListIntegrationAssociationsRequest < Struct.new(
|
4066
4484
|
:instance_id,
|
4485
|
+
:integration_type,
|
4067
4486
|
:next_token,
|
4068
4487
|
:max_results)
|
4069
4488
|
SENSITIVE = []
|
@@ -4071,7 +4490,7 @@ module Aws::Connect
|
|
4071
4490
|
end
|
4072
4491
|
|
4073
4492
|
# @!attribute [rw] integration_association_summary_list
|
4074
|
-
# The
|
4493
|
+
# The associations.
|
4075
4494
|
# @return [Array<Types::IntegrationAssociationSummary>]
|
4076
4495
|
#
|
4077
4496
|
# @!attribute [rw] next_token
|
@@ -4731,7 +5150,7 @@ module Aws::Connect
|
|
4731
5150
|
end
|
4732
5151
|
|
4733
5152
|
# Provides summary information about the use cases for the specified
|
4734
|
-
#
|
5153
|
+
# integration association.
|
4735
5154
|
#
|
4736
5155
|
# @note When making an API call, you may pass ListUseCasesRequest
|
4737
5156
|
# data as a hash:
|
@@ -5928,6 +6347,12 @@ module Aws::Connect
|
|
5928
6347
|
# attributes: {
|
5929
6348
|
# "AttributeName" => "AttributeValue",
|
5930
6349
|
# },
|
6350
|
+
# answer_machine_detection_config: {
|
6351
|
+
# enable_answer_machine_detection: false,
|
6352
|
+
# await_answer_machine_prompt: false,
|
6353
|
+
# },
|
6354
|
+
# campaign_id: "CampaignId",
|
6355
|
+
# traffic_type: "GENERAL", # accepts GENERAL, CAMPAIGN
|
5931
6356
|
# }
|
5932
6357
|
#
|
5933
6358
|
# @!attribute [rw] destination_phone_number
|
@@ -5984,6 +6409,22 @@ module Aws::Connect
|
|
5984
6409
|
# underscore characters.
|
5985
6410
|
# @return [Hash<String,String>]
|
5986
6411
|
#
|
6412
|
+
# @!attribute [rw] answer_machine_detection_config
|
6413
|
+
# Configuration of the answering machine detection for this outbound
|
6414
|
+
# call.
|
6415
|
+
# @return [Types::AnswerMachineDetectionConfig]
|
6416
|
+
#
|
6417
|
+
# @!attribute [rw] campaign_id
|
6418
|
+
# The campaign identifier of the outbound communication.
|
6419
|
+
# @return [String]
|
6420
|
+
#
|
6421
|
+
# @!attribute [rw] traffic_type
|
6422
|
+
# Denotes the class of traffic. Calls with different traffic types are
|
6423
|
+
# handled differently by Amazon Connect. The default value is
|
6424
|
+
# `GENERAL`. Use `CAMPAIGN` if `EnableAnswerMachineDetection` is set
|
6425
|
+
# to `true`. For all other cases, use `GENERAL`.
|
6426
|
+
# @return [String]
|
6427
|
+
#
|
5987
6428
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContactRequest AWS API Documentation
|
5988
6429
|
#
|
5989
6430
|
class StartOutboundVoiceContactRequest < Struct.new(
|
@@ -5993,7 +6434,10 @@ module Aws::Connect
|
|
5993
6434
|
:client_token,
|
5994
6435
|
:source_phone_number,
|
5995
6436
|
:queue_id,
|
5996
|
-
:attributes
|
6437
|
+
:attributes,
|
6438
|
+
:answer_machine_detection_config,
|
6439
|
+
:campaign_id,
|
6440
|
+
:traffic_type)
|
5997
6441
|
SENSITIVE = []
|
5998
6442
|
include Aws::Structure
|
5999
6443
|
end
|
@@ -6309,6 +6753,62 @@ module Aws::Connect
|
|
6309
6753
|
include Aws::Structure
|
6310
6754
|
end
|
6311
6755
|
|
6756
|
+
# @note When making an API call, you may pass UpdateAgentStatusRequest
|
6757
|
+
# data as a hash:
|
6758
|
+
#
|
6759
|
+
# {
|
6760
|
+
# instance_id: "InstanceId", # required
|
6761
|
+
# agent_status_id: "AgentStatusId", # required
|
6762
|
+
# name: "AgentStatusName",
|
6763
|
+
# description: "UpdateAgentStatusDescription",
|
6764
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
6765
|
+
# display_order: 1,
|
6766
|
+
# reset_order_number: false,
|
6767
|
+
# }
|
6768
|
+
#
|
6769
|
+
# @!attribute [rw] instance_id
|
6770
|
+
# The identifier of the Amazon Connect instance. You can find the
|
6771
|
+
# instanceId in the ARN of the instance.
|
6772
|
+
# @return [String]
|
6773
|
+
#
|
6774
|
+
# @!attribute [rw] agent_status_id
|
6775
|
+
# The identifier of the agent status.
|
6776
|
+
# @return [String]
|
6777
|
+
#
|
6778
|
+
# @!attribute [rw] name
|
6779
|
+
# The name of the agent status.
|
6780
|
+
# @return [String]
|
6781
|
+
#
|
6782
|
+
# @!attribute [rw] description
|
6783
|
+
# The description of the agent status.
|
6784
|
+
# @return [String]
|
6785
|
+
#
|
6786
|
+
# @!attribute [rw] state
|
6787
|
+
# The state of the agent status.
|
6788
|
+
# @return [String]
|
6789
|
+
#
|
6790
|
+
# @!attribute [rw] display_order
|
6791
|
+
# The display order of the agent status.
|
6792
|
+
# @return [Integer]
|
6793
|
+
#
|
6794
|
+
# @!attribute [rw] reset_order_number
|
6795
|
+
# A number indicating the reset order of the agent status.
|
6796
|
+
# @return [Boolean]
|
6797
|
+
#
|
6798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateAgentStatusRequest AWS API Documentation
|
6799
|
+
#
|
6800
|
+
class UpdateAgentStatusRequest < Struct.new(
|
6801
|
+
:instance_id,
|
6802
|
+
:agent_status_id,
|
6803
|
+
:name,
|
6804
|
+
:description,
|
6805
|
+
:state,
|
6806
|
+
:display_order,
|
6807
|
+
:reset_order_number)
|
6808
|
+
SENSITIVE = []
|
6809
|
+
include Aws::Structure
|
6810
|
+
end
|
6811
|
+
|
6312
6812
|
# @note When making an API call, you may pass UpdateContactAttributesRequest
|
6313
6813
|
# data as a hash:
|
6314
6814
|
#
|
@@ -6427,6 +6927,68 @@ module Aws::Connect
|
|
6427
6927
|
include Aws::Structure
|
6428
6928
|
end
|
6429
6929
|
|
6930
|
+
# @note When making an API call, you may pass UpdateHoursOfOperationRequest
|
6931
|
+
# data as a hash:
|
6932
|
+
#
|
6933
|
+
# {
|
6934
|
+
# instance_id: "InstanceId", # required
|
6935
|
+
# hours_of_operation_id: "HoursOfOperationId", # required
|
6936
|
+
# name: "CommonNameLength127",
|
6937
|
+
# description: "UpdateHoursOfOperationDescription",
|
6938
|
+
# time_zone: "TimeZone",
|
6939
|
+
# config: [
|
6940
|
+
# {
|
6941
|
+
# day: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
6942
|
+
# start_time: { # required
|
6943
|
+
# hours: 1, # required
|
6944
|
+
# minutes: 1, # required
|
6945
|
+
# },
|
6946
|
+
# end_time: { # required
|
6947
|
+
# hours: 1, # required
|
6948
|
+
# minutes: 1, # required
|
6949
|
+
# },
|
6950
|
+
# },
|
6951
|
+
# ],
|
6952
|
+
# }
|
6953
|
+
#
|
6954
|
+
# @!attribute [rw] instance_id
|
6955
|
+
# The identifier of the Amazon Connect instance. You can find the
|
6956
|
+
# instanceId in the ARN of the instance.
|
6957
|
+
# @return [String]
|
6958
|
+
#
|
6959
|
+
# @!attribute [rw] hours_of_operation_id
|
6960
|
+
# The identifier of the hours of operation.
|
6961
|
+
# @return [String]
|
6962
|
+
#
|
6963
|
+
# @!attribute [rw] name
|
6964
|
+
# The name of the hours of operation.
|
6965
|
+
# @return [String]
|
6966
|
+
#
|
6967
|
+
# @!attribute [rw] description
|
6968
|
+
# The description of the hours of operation.
|
6969
|
+
# @return [String]
|
6970
|
+
#
|
6971
|
+
# @!attribute [rw] time_zone
|
6972
|
+
# The time zone of the hours of operation.
|
6973
|
+
# @return [String]
|
6974
|
+
#
|
6975
|
+
# @!attribute [rw] config
|
6976
|
+
# Configuration information of the hours of operation.
|
6977
|
+
# @return [Array<Types::HoursOfOperationConfig>]
|
6978
|
+
#
|
6979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateHoursOfOperationRequest AWS API Documentation
|
6980
|
+
#
|
6981
|
+
class UpdateHoursOfOperationRequest < Struct.new(
|
6982
|
+
:instance_id,
|
6983
|
+
:hours_of_operation_id,
|
6984
|
+
:name,
|
6985
|
+
:description,
|
6986
|
+
:time_zone,
|
6987
|
+
:config)
|
6988
|
+
SENSITIVE = []
|
6989
|
+
include Aws::Structure
|
6990
|
+
end
|
6991
|
+
|
6430
6992
|
# @note When making an API call, you may pass UpdateInstanceAttributeRequest
|
6431
6993
|
# data as a hash:
|
6432
6994
|
#
|
@@ -6443,6 +7005,11 @@ module Aws::Connect
|
|
6443
7005
|
#
|
6444
7006
|
# @!attribute [rw] attribute_type
|
6445
7007
|
# The type of attribute.
|
7008
|
+
#
|
7009
|
+
# <note markdown="1"> Only allowlisted customers can consume USE\_CUSTOM\_TTS\_VOICES. To
|
7010
|
+
# access this feature, contact AWS Support for allowlisting.
|
7011
|
+
#
|
7012
|
+
# </note>
|
6446
7013
|
# @return [String]
|
6447
7014
|
#
|
6448
7015
|
# @!attribute [rw] value
|
@@ -7185,8 +7752,8 @@ module Aws::Connect
|
|
7185
7752
|
# @return [String]
|
7186
7753
|
#
|
7187
7754
|
# @!attribute [rw] use_case_type
|
7188
|
-
# The type of use case to associate to the
|
7189
|
-
# Each
|
7755
|
+
# The type of use case to associate to the integration association.
|
7756
|
+
# Each integration association can have only one of each use case
|
7190
7757
|
# type.
|
7191
7758
|
# @return [String]
|
7192
7759
|
#
|