@aws-sdk/client-connect 3.1110.0 → 3.1112.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.
- package/README.md +35 -0
- package/dist-cjs/index.js +206 -9
- package/dist-es/Connect.js +12 -0
- package/dist-es/commands/CreateExtractionDefinitionCommand.js +4 -0
- package/dist-es/commands/DeleteExtractionDefinitionCommand.js +4 -0
- package/dist-es/commands/DescribeExtractionDefinitionCommand.js +4 -0
- package/dist-es/commands/ListExtractionDefinitionsCommand.js +4 -0
- package/dist-es/commands/UpdateExtractionDefinitionCommand.js +4 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/enums.js +7 -0
- package/dist-es/pagination/ListExtractionDefinitionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +146 -8
- package/dist-types/Connect.d.ts +42 -0
- package/dist-types/ConnectClient.d.ts +7 -2
- package/dist-types/commands/CreateExtractionDefinitionCommand.d.ts +111 -0
- package/dist-types/commands/CreateRuleCommand.d.ts +9 -2
- package/dist-types/commands/CreateTestCaseCommand.d.ts +1 -1
- package/dist-types/commands/CreateTrafficDistributionGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateUseCaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteExtractionDefinitionCommand.d.ts +85 -0
- package/dist-types/commands/DescribeExtractionDefinitionCommand.d.ts +107 -0
- package/dist-types/commands/DescribeRuleCommand.d.ts +9 -2
- package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +1 -1
- package/dist-types/commands/GetCurrentUserDataCommand.d.ts +1 -2
- package/dist-types/commands/ListExtractionDefinitionsCommand.d.ts +98 -0
- package/dist-types/commands/ListRulesCommand.d.ts +3 -3
- package/dist-types/commands/SearchContactEvaluationsCommand.d.ts +1 -1
- package/dist-types/commands/SearchContactFlowModulesCommand.d.ts +1 -1
- package/dist-types/commands/SearchRulesCommand.d.ts +2 -2
- package/dist-types/commands/StartAssistantContactCommand.d.ts +4 -1
- package/dist-types/commands/UpdateExtractionDefinitionCommand.d.ts +100 -0
- package/dist-types/commands/UpdateRuleCommand.d.ts +8 -1
- package/dist-types/commands/UpdateViewMetadataCommand.d.ts +2 -1
- package/dist-types/commands/UpdateWorkspaceMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdateWorkspacePageCommand.d.ts +1 -1
- package/dist-types/commands/UpdateWorkspaceThemeCommand.d.ts +1 -1
- package/dist-types/commands/UpdateWorkspaceVisibilityCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/enums.d.ts +15 -0
- package/dist-types/models/models_0.d.ts +128 -188
- package/dist-types/models/models_1.d.ts +285 -492
- package/dist-types/models/models_2.d.ts +1736 -1606
- package/dist-types/models/models_3.d.ts +2192 -2081
- package/dist-types/models/models_4.d.ts +367 -7
- package/dist-types/pagination/ListExtractionDefinitionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/runtimeConfig.browser.d.ts +40 -40
- package/dist-types/runtimeConfig.d.ts +36 -36
- package/dist-types/runtimeConfig.native.d.ts +38 -38
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/schemas/schemas_0.d.ts +22 -0
- package/dist-types/ts3.4/Connect.d.ts +92 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateExtractionDefinitionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateTestCaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateTrafficDistributionGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateUseCaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteExtractionDefinitionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeExtractionDefinitionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetCurrentMetricDataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetCurrentUserDataCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/ListExtractionDefinitionsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/SearchContactEvaluationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchContactFlowModulesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateExtractionDefinitionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateViewMetadataCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateWorkspaceMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateWorkspacePageCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateWorkspaceThemeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateWorkspaceVisibilityCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/enums.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +31 -46
- package/dist-types/ts3.4/models/models_1.d.ts +72 -72
- package/dist-types/ts3.4/models/models_2.d.ts +89 -102
- package/dist-types/ts3.4/models/models_3.d.ts +112 -104
- package/dist-types/ts3.4/models/models_4.d.ts +109 -14
- package/dist-types/ts3.4/pagination/ListExtractionDefinitionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +56 -58
- package/dist-types/ts3.4/runtimeConfig.d.ts +58 -58
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +60 -62
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +3 -3
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +22 -0
- package/package.json +5 -5
|
@@ -1,462 +1,952 @@
|
|
|
1
|
-
import type { AgentStatusType, ArtifactStatus, AttachmentScope, AutoEvaluationStatus, BooleanComparisonType, Channel, Comparison,
|
|
2
|
-
import type { ActionSummary, AgentConfig, AgentContactReference, AgentStatus, AgentStatusReference, AgentStatusSummary, AnalyticsDataAssociationResult, Application,
|
|
3
|
-
import type { Attribute,
|
|
1
|
+
import type { AgentStatusType, ArtifactStatus, AttachmentScope, AutoEvaluationStatus, BooleanComparisonType, Channel, Comparison, ContactFlowModuleState, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactRecordingType, ContactState, DataTableAttributeValueType, DateTimeComparisonType, DecimalComparisonType, DirectoryType, EntityType, EvaluationFormValidationFindingSeverity, EvaluationFormValidationStatus, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, EventSourceName, ExecutionRecordStatus, FilterV2StringConditionComparisonOperator, FlowAssociationResourceType, Grouping, HistoricalMetricName, InstanceStatus, InstanceStorageResourceType, IntegrationType, IntervalPeriod, LexVersion, ListFlowAssociationResourceType, LocaleCode, MediaType, MetricStatus, MetricType, MonitorCapability, NotificationPriority, NotificationSource, NotificationStatus, NumberComparisonType, OperationalStatus, ParticipantRole, PhoneNumberCountryCode, PhoneNumberType, QueueType, QuickConnectType, RealTimeContactAnalysisOutputType, RealTimeContactAnalysisPostContactSummaryFailureCode, RealTimeContactAnalysisPostContactSummaryStatus, RealTimeContactAnalysisSegmentType, RealTimeContactAnalysisSentimentLabel, RealTimeContactAnalysisStatus, RealTimeContactAnalysisSupportedChannel, ReferenceStatus, ReferenceType, RuleCapabilityTier, RulePublishStatus, SourceType, Statistic, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, ViewStatus, ViewType, VocabularyLanguageCode } from "./enums";
|
|
2
|
+
import type { ActionSummary, AgentConfig, AgentContactReference, AgentStatus, AgentStatusIdentifier, AgentStatusReference, AgentStatusSummary, AnalyticsDataAssociationResult, Application, DataTableLockVersion, Distribution, FlowAssociationSummary, FlowModule, InstanceStorageConfig, LexBot, LexV2Bot, OverrideTimeSlice, PrimaryValueResponse, QueueReference, SecurityProfileItem, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, UserProficiency } from "./models_0";
|
|
3
|
+
import type { Attribute, CurrentMetric, CurrentMetricSortCriteria, DataTableAttribute, EvaluationContactParticipant, EvaluationScore, ExtensionConfiguration, Filters, HierarchyGroupSummary, HoursOfOperationOverride, HoursOfOperationsIdentifier, Notification } from "./models_1";
|
|
4
4
|
/**
|
|
5
|
-
* <p>Data for a user.</p>
|
|
6
5
|
* @public
|
|
7
6
|
*/
|
|
8
|
-
export interface
|
|
7
|
+
export interface GetCurrentMetricDataRequest {
|
|
9
8
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
* user. </p>
|
|
9
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
12
10
|
* @public
|
|
13
11
|
*/
|
|
14
|
-
|
|
12
|
+
InstanceId: string | undefined;
|
|
15
13
|
/**
|
|
16
|
-
* <p>
|
|
14
|
+
* <p>The filters to apply to returned metrics. You can filter up to the following limits:</p>
|
|
15
|
+
* <ul>
|
|
16
|
+
* <li>
|
|
17
|
+
* <p>Queues: 100</p>
|
|
18
|
+
* </li>
|
|
19
|
+
* <li>
|
|
20
|
+
* <p>Routing profiles: 100</p>
|
|
21
|
+
* </li>
|
|
22
|
+
* <li>
|
|
23
|
+
* <p>Channels: 3 (VOICE, CHAT, and TASK channels are supported.)</p>
|
|
24
|
+
* </li>
|
|
25
|
+
* <li>
|
|
26
|
+
* <p>RoutingStepExpressions: 50</p>
|
|
27
|
+
* </li>
|
|
28
|
+
* <li>
|
|
29
|
+
* <p>AgentStatuses: 50</p>
|
|
30
|
+
* </li>
|
|
31
|
+
* <li>
|
|
32
|
+
* <p>Subtypes: 10</p>
|
|
33
|
+
* </li>
|
|
34
|
+
* <li>
|
|
35
|
+
* <p>ValidationTestTypes: 10</p>
|
|
36
|
+
* </li>
|
|
37
|
+
* </ul>
|
|
38
|
+
* <p>Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any
|
|
39
|
+
* channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource
|
|
40
|
+
* IDs and resource ARNs in the same request.</p>
|
|
41
|
+
* <p>When using <code>AgentStatuses</code> as filter make sure Queues is added as primary filter.</p>
|
|
42
|
+
* <p>When using <code>Subtypes</code> as filter make sure Queues is added as primary filter.</p>
|
|
43
|
+
* <p>When using <code>ValidationTestTypes</code> as filter make sure Queues is added as primary filter.</p>
|
|
44
|
+
* <p>When using the <code>RoutingStepExpression</code> filter, you need to pass exactly one <code>QueueId</code>. The
|
|
45
|
+
* filter is also case sensitive so when using the <code>RoutingStepExpression</code> filter, grouping by
|
|
46
|
+
* <code>ROUTING_STEP_EXPRESSION</code> is required.</p>
|
|
47
|
+
* <p>Currently tagging is only supported on the resources that are passed in the filter.</p>
|
|
17
48
|
* @public
|
|
18
49
|
*/
|
|
19
|
-
|
|
50
|
+
Filters: Filters | undefined;
|
|
20
51
|
/**
|
|
21
|
-
* <p>
|
|
52
|
+
* <p>Defines the level of aggregation for metrics data by a dimension(s). Its similar to sorting items into buckets
|
|
53
|
+
* based on a common characteristic, then counting or calculating something for each bucket. For example, when grouped
|
|
54
|
+
* by <code>QUEUE</code>, the metrics returned apply to each queue rather than aggregated for all queues. </p>
|
|
55
|
+
* <p>The grouping list is an ordered list, with the first item in the list defined as the primary grouping. If no
|
|
56
|
+
* grouping is included in the request, the aggregation happens at the instance-level.</p>
|
|
57
|
+
* <ul>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>If you group by <code>CHANNEL</code>, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.</p>
|
|
60
|
+
* </li>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>If you group by <code>AGENT_STATUS</code>, you must include the <code>QUEUE</code> as the primary grouping and
|
|
63
|
+
* use queue filter. When you group by <code>AGENT_STATUS</code>, the only metric available is the
|
|
64
|
+
* <code>AGENTS_ONLINE</code> metric.</p>
|
|
65
|
+
* </li>
|
|
66
|
+
* <li>
|
|
67
|
+
* <p>If you group by <code>SUBTYPE</code> or <code>VALIDATION_TEST_TYPE</code> as secondary grouping then you must include <code>QUEUE</code> as
|
|
68
|
+
* primary grouping and use Queue as filter</p>
|
|
69
|
+
* </li>
|
|
70
|
+
* <li>
|
|
71
|
+
* <p>If you group by <code>ROUTING_PROFILE</code>, you must include either a queue or routing profile filter. In
|
|
72
|
+
* addition, a routing profile filter is required for metrics <code>CONTACTS_SCHEDULED</code>,
|
|
73
|
+
* <code>CONTACTS_IN_QUEUE</code>, and <code> OLDEST_CONTACT_AGE</code>.</p>
|
|
74
|
+
* </li>
|
|
75
|
+
* <li>
|
|
76
|
+
* <p>When using the <code>RoutingStepExpression</code> filter, group by <code>ROUTING_STEP_EXPRESSION</code> is
|
|
77
|
+
* required.</p>
|
|
78
|
+
* </li>
|
|
79
|
+
* </ul>
|
|
22
80
|
* @public
|
|
23
81
|
*/
|
|
24
|
-
|
|
82
|
+
Groupings?: Grouping[] | undefined;
|
|
25
83
|
/**
|
|
26
|
-
* <p>The
|
|
27
|
-
*
|
|
84
|
+
* <p>The metrics to retrieve. Specify the name or metricId, and unit for each metric. The following metrics are available. For a
|
|
85
|
+
* description of all the metrics, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definitions</a> in the <i>Connect Customer Administrator Guide</i>.</p>
|
|
86
|
+
* <note>
|
|
87
|
+
* <p> MetricId should be used to reference custom metrics or out of the box metrics as Arn. If using MetricId, the limit is 10 MetricId per request.</p>
|
|
88
|
+
* </note>
|
|
89
|
+
* <dl>
|
|
90
|
+
* <dt>AGENTS_AFTER_CONTACT_WORK</dt>
|
|
91
|
+
* <dd>
|
|
92
|
+
* <p>Unit: COUNT</p>
|
|
93
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aftercallwork-real-time">ACW</a>
|
|
94
|
+
* </p>
|
|
95
|
+
* </dd>
|
|
96
|
+
* <dt>AGENTS_AVAILABLE</dt>
|
|
97
|
+
* <dd>
|
|
98
|
+
* <p>Unit: COUNT</p>
|
|
99
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#available-real-time">Available</a>
|
|
100
|
+
* </p>
|
|
101
|
+
* </dd>
|
|
102
|
+
* <dt>AGENTS_ERROR</dt>
|
|
103
|
+
* <dd>
|
|
104
|
+
* <p>Unit: COUNT</p>
|
|
105
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#error-real-time">Error</a>
|
|
106
|
+
* </p>
|
|
107
|
+
* </dd>
|
|
108
|
+
* <dt>AGENTS_NON_PRODUCTIVE</dt>
|
|
109
|
+
* <dd>
|
|
110
|
+
* <p>Unit: COUNT</p>
|
|
111
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-productive-time-real-time">NPT (Non-Productive
|
|
112
|
+
* Time)</a>
|
|
113
|
+
* </p>
|
|
114
|
+
* </dd>
|
|
115
|
+
* <dt>AGENTS_ON_CALL</dt>
|
|
116
|
+
* <dd>
|
|
117
|
+
* <p>Unit: COUNT</p>
|
|
118
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#on-call-real-time">On contact</a>
|
|
119
|
+
* </p>
|
|
120
|
+
* </dd>
|
|
121
|
+
* <dt>AGENTS_ON_CONTACT</dt>
|
|
122
|
+
* <dd>
|
|
123
|
+
* <p>Unit: COUNT</p>
|
|
124
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#on-call-real-time">On contact</a>
|
|
125
|
+
* </p>
|
|
126
|
+
* </dd>
|
|
127
|
+
* <dt>AGENTS_ONLINE</dt>
|
|
128
|
+
* <dd>
|
|
129
|
+
* <p>Unit: COUNT</p>
|
|
130
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#online-real-time">Online</a>
|
|
131
|
+
* </p>
|
|
132
|
+
* </dd>
|
|
133
|
+
* <dt>AGENTS_STAFFED</dt>
|
|
134
|
+
* <dd>
|
|
135
|
+
* <p>Unit: COUNT</p>
|
|
136
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#staffed-real-time">Staffed</a>
|
|
137
|
+
* </p>
|
|
138
|
+
* </dd>
|
|
139
|
+
* <dt>CONTACTS_IN_QUEUE</dt>
|
|
140
|
+
* <dd>
|
|
141
|
+
* <p>Unit: COUNT</p>
|
|
142
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#in-queue-real-time">In queue</a>
|
|
143
|
+
* </p>
|
|
144
|
+
* </dd>
|
|
145
|
+
* <dt>CONTACTS_SCHEDULED</dt>
|
|
146
|
+
* <dd>
|
|
147
|
+
* <p>Unit: COUNT</p>
|
|
148
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#scheduled-real-time">Scheduled</a>
|
|
149
|
+
* </p>
|
|
150
|
+
* </dd>
|
|
151
|
+
* <dt>ESTIMATED_WAIT_TIME</dt>
|
|
152
|
+
* <dd>
|
|
153
|
+
* <p>Unit: SECONDS</p>
|
|
154
|
+
* <p>This metric supports filter and grouping combination only used for core routing purpose.
|
|
155
|
+
* Valid filter and grouping use cases:
|
|
156
|
+
* </p>
|
|
157
|
+
* <ul>
|
|
158
|
+
* <li>
|
|
159
|
+
* <p>Filter by a list of [Queues] and a list of [Channels], group by [“QUEUE”, “CHANNEL”]</p>
|
|
160
|
+
* </li>
|
|
161
|
+
* <li>
|
|
162
|
+
* <p>Filter by a singleton list of [Queue], a singleton list of [Channel], a list of [RoutingStepExpression], group by [“ROUTING_STEP_EXPRESSION”].</p>
|
|
163
|
+
* </li>
|
|
164
|
+
* </ul>
|
|
165
|
+
* </dd>
|
|
166
|
+
* <dt>OLDEST_CONTACT_AGE</dt>
|
|
167
|
+
* <dd>
|
|
168
|
+
* <p>Unit: SECONDS</p>
|
|
169
|
+
* <p>When you use groupings, Unit says SECONDS and the Value is returned in SECONDS. </p>
|
|
170
|
+
* <p>When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if
|
|
171
|
+
* you get a response like this:</p>
|
|
172
|
+
* <p>
|
|
173
|
+
* <code>\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" \}, "Value": 24113.0 </code>\}</p>
|
|
174
|
+
* <p>The actual OLDEST_CONTACT_AGE is 24 seconds.</p>
|
|
175
|
+
* <p>When the filter <code>RoutingStepExpression</code> is used, this metric is still calculated from enqueue
|
|
176
|
+
* time. For example, if a contact that has been queued under <code><Expression 1></code> for 10 seconds has
|
|
177
|
+
* expired and <code><Expression 2></code> becomes active, then <code>OLDEST_CONTACT_AGE</code> for this queue
|
|
178
|
+
* will be counted starting from 10, not 0.</p>
|
|
179
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#oldest-real-time">Oldest</a>
|
|
180
|
+
* </p>
|
|
181
|
+
* </dd>
|
|
182
|
+
* <dt>SLOTS_ACTIVE</dt>
|
|
183
|
+
* <dd>
|
|
184
|
+
* <p>Unit: COUNT</p>
|
|
185
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#active-real-time">Active</a>
|
|
186
|
+
* </p>
|
|
187
|
+
* </dd>
|
|
188
|
+
* <dt>SLOTS_AVAILABLE</dt>
|
|
189
|
+
* <dd>
|
|
190
|
+
* <p>Unit: COUNT</p>
|
|
191
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#availability-real-time">Availability</a>
|
|
192
|
+
* </p>
|
|
193
|
+
* </dd>
|
|
194
|
+
* </dl>
|
|
28
195
|
* @public
|
|
29
196
|
*/
|
|
30
|
-
|
|
197
|
+
CurrentMetrics: CurrentMetric[] | undefined;
|
|
31
198
|
/**
|
|
32
|
-
* <p>
|
|
33
|
-
*
|
|
199
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
200
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
201
|
+
* <p>The token expires after 5 minutes from the time it is created. Subsequent requests that use
|
|
202
|
+
* the token must use the same request parameters as the request that generated the token.</p>
|
|
34
203
|
* @public
|
|
35
204
|
*/
|
|
36
|
-
|
|
205
|
+
NextToken?: string | undefined;
|
|
37
206
|
/**
|
|
38
|
-
* <p>
|
|
39
|
-
* slots. This is calculated from <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html">MediaConcurrency</a> of the
|
|
40
|
-
* <code>RoutingProfile</code> assigned to the agent. </p>
|
|
207
|
+
* <p>The maximum number of results to return per page.</p>
|
|
41
208
|
* @public
|
|
42
209
|
*/
|
|
43
|
-
|
|
210
|
+
MaxResults?: number | undefined;
|
|
44
211
|
/**
|
|
45
|
-
* <p>
|
|
46
|
-
*
|
|
212
|
+
* <p>The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources
|
|
213
|
+
* are sorted based on <code>AGENTS_ONLINE</code>, <code>DESCENDING</code>. The metric collection is sorted based on the
|
|
214
|
+
* input metrics.</p>
|
|
215
|
+
* <p>Note the following:</p>
|
|
216
|
+
* <ul>
|
|
217
|
+
* <li>
|
|
218
|
+
* <p>Sorting on <code>SLOTS_ACTIVE</code> and <code>SLOTS_AVAILABLE</code> is not supported.</p>
|
|
219
|
+
* </li>
|
|
220
|
+
* </ul>
|
|
47
221
|
* @public
|
|
48
222
|
*/
|
|
49
|
-
|
|
223
|
+
SortCriteria?: CurrentMetricSortCriteria[] | undefined;
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* <p>Contains the data for a real-time metric.</p>
|
|
227
|
+
* @public
|
|
228
|
+
*/
|
|
229
|
+
export interface CurrentMetricData {
|
|
50
230
|
/**
|
|
51
|
-
* <p>
|
|
231
|
+
* <p>Information about the metric.</p>
|
|
52
232
|
* @public
|
|
53
233
|
*/
|
|
54
|
-
|
|
234
|
+
Metric?: CurrentMetric | undefined;
|
|
55
235
|
/**
|
|
56
|
-
* <p>The
|
|
236
|
+
* <p>The value of the metric.</p>
|
|
57
237
|
* @public
|
|
58
238
|
*/
|
|
59
|
-
|
|
239
|
+
Value?: number | undefined;
|
|
60
240
|
}
|
|
61
241
|
/**
|
|
242
|
+
* <p>Information about the routing profile assigned to the user.</p>
|
|
62
243
|
* @public
|
|
63
244
|
*/
|
|
64
|
-
export interface
|
|
65
|
-
/**
|
|
66
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
67
|
-
* @public
|
|
68
|
-
*/
|
|
69
|
-
NextToken?: string | undefined;
|
|
245
|
+
export interface RoutingProfileReference {
|
|
70
246
|
/**
|
|
71
|
-
* <p>
|
|
247
|
+
* <p>The identifier of the routing profile.</p>
|
|
72
248
|
* @public
|
|
73
249
|
*/
|
|
74
|
-
|
|
250
|
+
Id?: string | undefined;
|
|
75
251
|
/**
|
|
76
|
-
* <p>The
|
|
252
|
+
* <p>The Amazon Resource Name (ARN) of the routing profile.</p>
|
|
77
253
|
* @public
|
|
78
254
|
*/
|
|
79
|
-
|
|
255
|
+
Arn?: string | undefined;
|
|
80
256
|
}
|
|
81
257
|
/**
|
|
258
|
+
* <p>Contains information about the dimensions for a set of metrics.</p>
|
|
82
259
|
* @public
|
|
83
260
|
*/
|
|
84
|
-
export interface
|
|
261
|
+
export interface Dimensions {
|
|
85
262
|
/**
|
|
86
|
-
* <p>
|
|
263
|
+
* <p>Information about the queue for which metrics are returned.</p>
|
|
87
264
|
* @public
|
|
88
265
|
*/
|
|
89
|
-
|
|
266
|
+
Queue?: QueueReference | undefined;
|
|
90
267
|
/**
|
|
91
|
-
* <p>The
|
|
268
|
+
* <p>The channel used for grouping and filters.</p>
|
|
92
269
|
* @public
|
|
93
270
|
*/
|
|
94
|
-
|
|
271
|
+
Channel?: Channel | undefined;
|
|
95
272
|
/**
|
|
96
|
-
* <p>
|
|
273
|
+
* <p>Information about the routing profile assigned to the user.</p>
|
|
97
274
|
* @public
|
|
98
275
|
*/
|
|
99
|
-
|
|
276
|
+
RoutingProfile?: RoutingProfileReference | undefined;
|
|
100
277
|
/**
|
|
101
|
-
* <p>The
|
|
278
|
+
* <p>The expression of a step in a routing criteria.</p>
|
|
102
279
|
* @public
|
|
103
280
|
*/
|
|
104
|
-
|
|
105
|
-
}
|
|
106
|
-
/**
|
|
107
|
-
* <p>Information about the hours of operations with the effective override applied.</p>
|
|
108
|
-
* @public
|
|
109
|
-
*/
|
|
110
|
-
export interface OperationalHour {
|
|
281
|
+
RoutingStepExpression?: string | undefined;
|
|
111
282
|
/**
|
|
112
|
-
* <p>
|
|
283
|
+
* <p>Information about the agent status assigned to the user.</p>
|
|
113
284
|
* @public
|
|
114
285
|
*/
|
|
115
|
-
|
|
286
|
+
AgentStatus?: AgentStatusIdentifier | undefined;
|
|
116
287
|
/**
|
|
117
|
-
* <p>The
|
|
288
|
+
* <p>The subtype of the channel used for the contact.</p>
|
|
118
289
|
* @public
|
|
119
290
|
*/
|
|
120
|
-
|
|
291
|
+
Subtype?: string | undefined;
|
|
292
|
+
/**
|
|
293
|
+
* <p>The testing and simulation type</p>
|
|
294
|
+
* @public
|
|
295
|
+
*/
|
|
296
|
+
ValidationTestType?: string | undefined;
|
|
121
297
|
}
|
|
122
298
|
/**
|
|
123
|
-
* <p>
|
|
299
|
+
* <p>Contains information about a set of real-time metrics.</p>
|
|
124
300
|
* @public
|
|
125
301
|
*/
|
|
126
|
-
export interface
|
|
302
|
+
export interface CurrentMetricResult {
|
|
127
303
|
/**
|
|
128
|
-
* <p>The
|
|
304
|
+
* <p>The dimensions for the metrics.</p>
|
|
129
305
|
* @public
|
|
130
306
|
*/
|
|
131
|
-
|
|
307
|
+
Dimensions?: Dimensions | undefined;
|
|
132
308
|
/**
|
|
133
|
-
* <p>
|
|
309
|
+
* <p>The set of metrics.</p>
|
|
134
310
|
* @public
|
|
135
311
|
*/
|
|
136
|
-
|
|
312
|
+
Collections?: CurrentMetricData[] | undefined;
|
|
137
313
|
}
|
|
138
314
|
/**
|
|
139
|
-
* <p>Information about hours of operation override</p>
|
|
140
315
|
* @public
|
|
141
316
|
*/
|
|
142
|
-
export interface
|
|
317
|
+
export interface GetCurrentMetricDataResponse {
|
|
143
318
|
/**
|
|
144
|
-
* <p>
|
|
319
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
320
|
+
* <p>The token expires after 5 minutes from the time it is created. Subsequent requests that use
|
|
321
|
+
* the token must use the same request parameters as the request that generated the token.</p>
|
|
145
322
|
* @public
|
|
146
323
|
*/
|
|
147
|
-
|
|
324
|
+
NextToken?: string | undefined;
|
|
148
325
|
/**
|
|
149
|
-
* <p>
|
|
326
|
+
* <p>Information about the real-time metrics.</p>
|
|
150
327
|
* @public
|
|
151
328
|
*/
|
|
152
|
-
|
|
329
|
+
MetricResults?: CurrentMetricResult[] | undefined;
|
|
153
330
|
/**
|
|
154
|
-
* <p>
|
|
331
|
+
* <p>The time at which the metrics were retrieved and cached for pagination.</p>
|
|
155
332
|
* @public
|
|
156
333
|
*/
|
|
157
|
-
|
|
334
|
+
DataSnapshotTime?: Date | undefined;
|
|
158
335
|
/**
|
|
159
|
-
* <p>
|
|
336
|
+
* <p>The total count of the result, regardless of the current page size. </p>
|
|
160
337
|
* @public
|
|
161
338
|
*/
|
|
162
|
-
|
|
339
|
+
ApproximateTotalCount?: number | undefined;
|
|
163
340
|
}
|
|
164
341
|
/**
|
|
165
|
-
* <p>
|
|
342
|
+
* <p>Filters user data based on the contact information that is associated to the users. It contains a list of <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">contact states</a>.</p>
|
|
166
343
|
* @public
|
|
167
344
|
*/
|
|
168
|
-
export interface
|
|
169
|
-
/**
|
|
170
|
-
* <p>The date that the hours of operation override applies to.</p>
|
|
171
|
-
* @public
|
|
172
|
-
*/
|
|
173
|
-
Date?: string | undefined;
|
|
345
|
+
export interface ContactFilter {
|
|
174
346
|
/**
|
|
175
|
-
* <p>
|
|
347
|
+
* <p>A list of up to 9 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">contact
|
|
348
|
+
* states</a>.</p>
|
|
176
349
|
* @public
|
|
177
350
|
*/
|
|
178
|
-
|
|
351
|
+
ContactStates?: ContactState[] | undefined;
|
|
179
352
|
}
|
|
180
353
|
/**
|
|
354
|
+
* <p>A filter for the user data.</p>
|
|
181
355
|
* @public
|
|
182
356
|
*/
|
|
183
|
-
export interface
|
|
357
|
+
export interface UserDataFilters {
|
|
184
358
|
/**
|
|
185
|
-
* <p>
|
|
359
|
+
* <p>A list of up to 100 queues or ARNs.</p>
|
|
186
360
|
* @public
|
|
187
361
|
*/
|
|
188
|
-
|
|
362
|
+
Queues?: string[] | undefined;
|
|
189
363
|
/**
|
|
190
|
-
* <p>
|
|
191
|
-
*
|
|
192
|
-
* <i> Administrator Guide</i>.</p>
|
|
364
|
+
* <p>A filter for the user data based on the contact information that is associated to the user. It contains a list
|
|
365
|
+
* of contact states. </p>
|
|
193
366
|
* @public
|
|
194
367
|
*/
|
|
195
|
-
|
|
368
|
+
ContactFilter?: ContactFilter | undefined;
|
|
196
369
|
/**
|
|
197
|
-
* <p>
|
|
370
|
+
* <p>A list of up to 100 routing profile IDs or ARNs.</p>
|
|
198
371
|
* @public
|
|
199
372
|
*/
|
|
200
|
-
|
|
373
|
+
RoutingProfiles?: string[] | undefined;
|
|
374
|
+
/**
|
|
375
|
+
* <p>A list of up to 100 agent IDs or ARNs.</p>
|
|
376
|
+
* @public
|
|
377
|
+
*/
|
|
378
|
+
Agents?: string[] | undefined;
|
|
379
|
+
/**
|
|
380
|
+
* <p>A UserHierarchyGroup ID or ARN.</p>
|
|
381
|
+
* @public
|
|
382
|
+
*/
|
|
383
|
+
UserHierarchyGroups?: string[] | undefined;
|
|
201
384
|
}
|
|
202
385
|
/**
|
|
203
386
|
* @public
|
|
204
387
|
*/
|
|
205
|
-
export interface
|
|
388
|
+
export interface GetCurrentUserDataRequest {
|
|
206
389
|
/**
|
|
207
390
|
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
208
391
|
* @public
|
|
209
392
|
*/
|
|
210
393
|
InstanceId: string | undefined;
|
|
211
394
|
/**
|
|
212
|
-
* <p>The
|
|
395
|
+
* <p>The filters to apply to returned user data. You can filter up to the following limits:</p>
|
|
396
|
+
* <ul>
|
|
397
|
+
* <li>
|
|
398
|
+
* <p>Queues: 100</p>
|
|
399
|
+
* </li>
|
|
400
|
+
* <li>
|
|
401
|
+
* <p>Routing profiles: 100</p>
|
|
402
|
+
* </li>
|
|
403
|
+
* <li>
|
|
404
|
+
* <p>Agents: 100</p>
|
|
405
|
+
* </li>
|
|
406
|
+
* <li>
|
|
407
|
+
* <p>Contact states: 9</p>
|
|
408
|
+
* </li>
|
|
409
|
+
* <li>
|
|
410
|
+
* <p>User hierarchy groups: 1</p>
|
|
411
|
+
* </li>
|
|
412
|
+
* </ul>
|
|
413
|
+
* <p> The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can
|
|
414
|
+
* be passed from queues, routing profiles, agents, and user hierarchy groups. </p>
|
|
415
|
+
* <p>Currently tagging is only supported on the resources that are passed in the filter.</p>
|
|
213
416
|
* @public
|
|
214
417
|
*/
|
|
215
|
-
|
|
418
|
+
Filters: UserDataFilters | undefined;
|
|
216
419
|
/**
|
|
217
|
-
* <p>The
|
|
420
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
421
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
218
422
|
* @public
|
|
219
423
|
*/
|
|
220
|
-
|
|
424
|
+
NextToken?: string | undefined;
|
|
425
|
+
/**
|
|
426
|
+
* <p>The maximum number of results to return per page.</p>
|
|
427
|
+
* @public
|
|
428
|
+
*/
|
|
429
|
+
MaxResults?: number | undefined;
|
|
221
430
|
}
|
|
222
431
|
/**
|
|
223
|
-
* <p>Information about
|
|
432
|
+
* <p>Information about the hierarchy group.</p>
|
|
224
433
|
* @public
|
|
225
434
|
*/
|
|
226
|
-
export interface
|
|
435
|
+
export interface HierarchyGroupSummaryReference {
|
|
227
436
|
/**
|
|
228
|
-
* <p>The identifier
|
|
437
|
+
* <p>The unique identifier for the hierarchy group.</p>
|
|
229
438
|
* @public
|
|
230
439
|
*/
|
|
231
|
-
|
|
440
|
+
Id?: string | undefined;
|
|
232
441
|
/**
|
|
233
|
-
* <p>The
|
|
442
|
+
* <p>The Amazon Resource Name (ARN) for the hierarchy group. </p>
|
|
234
443
|
* @public
|
|
235
444
|
*/
|
|
236
|
-
|
|
445
|
+
Arn?: string | undefined;
|
|
237
446
|
}
|
|
238
447
|
/**
|
|
239
|
-
* <p>Information about
|
|
240
|
-
* issue or quality improvement opportunity for the evaluation form.</p>
|
|
448
|
+
* <p>Information about the levels in the hierarchy group.</p>
|
|
241
449
|
* @public
|
|
242
450
|
*/
|
|
243
|
-
export interface
|
|
451
|
+
export interface HierarchyPathReference {
|
|
244
452
|
/**
|
|
245
|
-
* <p>
|
|
453
|
+
* <p>Information about level one.</p>
|
|
246
454
|
* @public
|
|
247
455
|
*/
|
|
248
|
-
|
|
456
|
+
LevelOne?: HierarchyGroupSummaryReference | undefined;
|
|
249
457
|
/**
|
|
250
|
-
* <p>
|
|
458
|
+
* <p>Information about level two.</p>
|
|
251
459
|
* @public
|
|
252
460
|
*/
|
|
253
|
-
|
|
461
|
+
LevelTwo?: HierarchyGroupSummaryReference | undefined;
|
|
254
462
|
/**
|
|
255
|
-
* <p>
|
|
463
|
+
* <p>Information about level three.</p>
|
|
256
464
|
* @public
|
|
257
465
|
*/
|
|
258
|
-
|
|
466
|
+
LevelThree?: HierarchyGroupSummaryReference | undefined;
|
|
259
467
|
/**
|
|
260
|
-
* <p>
|
|
468
|
+
* <p>Information about level four.</p>
|
|
261
469
|
* @public
|
|
262
470
|
*/
|
|
263
|
-
|
|
471
|
+
LevelFour?: HierarchyGroupSummaryReference | undefined;
|
|
264
472
|
/**
|
|
265
|
-
* <p>
|
|
473
|
+
* <p>Information about level five.</p>
|
|
266
474
|
* @public
|
|
267
475
|
*/
|
|
268
|
-
|
|
476
|
+
LevelFive?: HierarchyGroupSummaryReference | undefined;
|
|
269
477
|
}
|
|
270
478
|
/**
|
|
479
|
+
* <p>Information about the user.</p>
|
|
271
480
|
* @public
|
|
272
481
|
*/
|
|
273
|
-
export interface
|
|
482
|
+
export interface UserReference {
|
|
274
483
|
/**
|
|
275
|
-
* <p>The
|
|
276
|
-
* <code>COMPLETED</code>, <code>FAILED</code>.</p>
|
|
484
|
+
* <p>The unique identifier for the user.</p>
|
|
277
485
|
* @public
|
|
278
486
|
*/
|
|
279
|
-
|
|
487
|
+
Id?: string | undefined;
|
|
280
488
|
/**
|
|
281
|
-
* <p>The
|
|
282
|
-
* <code>FAILED</code>.</p>
|
|
489
|
+
* <p>The Amazon Resource Name (ARN) for the user.</p>
|
|
283
490
|
* @public
|
|
284
491
|
*/
|
|
285
|
-
|
|
492
|
+
Arn?: string | undefined;
|
|
493
|
+
}
|
|
494
|
+
/**
|
|
495
|
+
* <p>Data for a user.</p>
|
|
496
|
+
* @public
|
|
497
|
+
*/
|
|
498
|
+
export interface UserData {
|
|
286
499
|
/**
|
|
287
|
-
* <p>
|
|
500
|
+
* <p>Information about the user for the data that is returned. It contains the <code>resourceId</code> and ARN of the
|
|
501
|
+
* user. </p>
|
|
288
502
|
* @public
|
|
289
503
|
*/
|
|
290
|
-
|
|
504
|
+
User?: UserReference | undefined;
|
|
291
505
|
/**
|
|
292
|
-
* <p>
|
|
506
|
+
* <p>Information about the routing profile that is assigned to the user.</p>
|
|
293
507
|
* @public
|
|
294
508
|
*/
|
|
295
|
-
|
|
509
|
+
RoutingProfile?: RoutingProfileReference | undefined;
|
|
296
510
|
/**
|
|
297
|
-
* <p>
|
|
511
|
+
* <p>Contains information about the levels of a hierarchy group assigned to a user.</p>
|
|
298
512
|
* @public
|
|
299
513
|
*/
|
|
300
|
-
|
|
514
|
+
HierarchyPath?: HierarchyPathReference | undefined;
|
|
301
515
|
/**
|
|
302
|
-
* <p>
|
|
303
|
-
*
|
|
304
|
-
* <code>COMPLETED</code>.</p>
|
|
516
|
+
* <p>The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor
|
|
517
|
+
* manually changes in the real-time metrics report.</p>
|
|
305
518
|
* @public
|
|
306
519
|
*/
|
|
307
|
-
|
|
520
|
+
Status?: AgentStatusReference | undefined;
|
|
521
|
+
/**
|
|
522
|
+
* <p>A map of available slots by channel. The key is a channel name. The value is an integer: the available number of
|
|
523
|
+
* slots. </p>
|
|
524
|
+
* @public
|
|
525
|
+
*/
|
|
526
|
+
AvailableSlotsByChannel?: Partial<Record<Channel, number>> | undefined;
|
|
527
|
+
/**
|
|
528
|
+
* <p>A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of
|
|
529
|
+
* slots. This is calculated from <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html">MediaConcurrency</a> of the
|
|
530
|
+
* <code>RoutingProfile</code> assigned to the agent. </p>
|
|
531
|
+
* @public
|
|
532
|
+
*/
|
|
533
|
+
MaxSlotsByChannel?: Partial<Record<Channel, number>> | undefined;
|
|
534
|
+
/**
|
|
535
|
+
* <p> A map of active slots by channel. The key is a channel name. The value is an integer: the number of active
|
|
536
|
+
* slots. </p>
|
|
537
|
+
* @public
|
|
538
|
+
*/
|
|
539
|
+
ActiveSlotsByChannel?: Partial<Record<Channel, number>> | undefined;
|
|
540
|
+
/**
|
|
541
|
+
* <p>A list of contact reference information.</p>
|
|
542
|
+
* @public
|
|
543
|
+
*/
|
|
544
|
+
Contacts?: AgentContactReference[] | undefined;
|
|
545
|
+
/**
|
|
546
|
+
* <p>The Next status of the agent.</p>
|
|
547
|
+
* @public
|
|
548
|
+
*/
|
|
549
|
+
NextStatus?: string | undefined;
|
|
308
550
|
}
|
|
309
551
|
/**
|
|
310
552
|
* @public
|
|
311
553
|
*/
|
|
312
|
-
export interface
|
|
554
|
+
export interface GetCurrentUserDataResponse {
|
|
313
555
|
/**
|
|
314
|
-
* <p>
|
|
556
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
557
|
+
* @public
|
|
558
|
+
*/
|
|
559
|
+
NextToken?: string | undefined;
|
|
560
|
+
/**
|
|
561
|
+
* <p>A list of the user data that is returned.</p>
|
|
562
|
+
* @public
|
|
563
|
+
*/
|
|
564
|
+
UserDataList?: UserData[] | undefined;
|
|
565
|
+
/**
|
|
566
|
+
* <p>The total count of the result, regardless of the current page size.</p>
|
|
567
|
+
* @public
|
|
568
|
+
*/
|
|
569
|
+
ApproximateTotalCount?: number | undefined;
|
|
570
|
+
}
|
|
571
|
+
/**
|
|
572
|
+
* @public
|
|
573
|
+
*/
|
|
574
|
+
export interface GetEffectiveHoursOfOperationsRequest {
|
|
575
|
+
/**
|
|
576
|
+
* <p>The identifier of the Connect Customer instance.</p>
|
|
315
577
|
* @public
|
|
316
578
|
*/
|
|
317
579
|
InstanceId: string | undefined;
|
|
580
|
+
/**
|
|
581
|
+
* <p>The identifier for the hours of operation.</p>
|
|
582
|
+
* @public
|
|
583
|
+
*/
|
|
584
|
+
HoursOfOperationId: string | undefined;
|
|
585
|
+
/**
|
|
586
|
+
* <p>The date from when the hours of operation are listed.</p>
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
FromDate: string | undefined;
|
|
590
|
+
/**
|
|
591
|
+
* <p>The date until when the hours of operation are listed.</p>
|
|
592
|
+
* @public
|
|
593
|
+
*/
|
|
594
|
+
ToDate: string | undefined;
|
|
318
595
|
}
|
|
319
596
|
/**
|
|
320
|
-
* <p>
|
|
597
|
+
* <p>Information about the hours of operations with the effective override applied.</p>
|
|
321
598
|
* @public
|
|
322
599
|
*/
|
|
323
|
-
export interface
|
|
600
|
+
export interface OperationalHour {
|
|
324
601
|
/**
|
|
325
|
-
* <p>
|
|
602
|
+
* <p>The start time that your contact center opens.</p>
|
|
326
603
|
* @public
|
|
327
604
|
*/
|
|
328
|
-
|
|
605
|
+
Start?: OverrideTimeSlice | undefined;
|
|
329
606
|
/**
|
|
330
|
-
* <p>
|
|
607
|
+
* <p>The end time that your contact center closes.</p>
|
|
331
608
|
* @public
|
|
332
609
|
*/
|
|
333
|
-
|
|
610
|
+
End?: OverrideTimeSlice | undefined;
|
|
611
|
+
}
|
|
612
|
+
/**
|
|
613
|
+
* <p>Information about the hours of operations with the effective override applied.</p>
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
export interface EffectiveHoursOfOperations {
|
|
334
617
|
/**
|
|
335
|
-
* <p>
|
|
618
|
+
* <p>The date that the hours of operation or overrides applies to.</p>
|
|
336
619
|
* @public
|
|
337
620
|
*/
|
|
338
|
-
|
|
621
|
+
Date?: string | undefined;
|
|
339
622
|
/**
|
|
340
|
-
* <p>
|
|
623
|
+
* <p>Information about the hours of operations with the effective override applied.</p>
|
|
341
624
|
* @public
|
|
342
625
|
*/
|
|
343
|
-
|
|
626
|
+
OperationalHours?: OperationalHour[] | undefined;
|
|
344
627
|
}
|
|
345
628
|
/**
|
|
629
|
+
* <p>Information about hours of operation override</p>
|
|
346
630
|
* @public
|
|
347
631
|
*/
|
|
348
|
-
export interface
|
|
632
|
+
export interface OverrideHour {
|
|
349
633
|
/**
|
|
350
|
-
* <p>The
|
|
634
|
+
* <p>The start time or end time for an hours of operation override.</p>
|
|
351
635
|
* @public
|
|
352
636
|
*/
|
|
353
|
-
|
|
637
|
+
Start?: OverrideTimeSlice | undefined;
|
|
354
638
|
/**
|
|
355
|
-
* <p>The
|
|
639
|
+
* <p>The start time or end time for an hours of operation override.</p>
|
|
356
640
|
* @public
|
|
357
641
|
*/
|
|
358
|
-
|
|
642
|
+
End?: OverrideTimeSlice | undefined;
|
|
359
643
|
/**
|
|
360
|
-
* <p>
|
|
644
|
+
* <p>Unique identifier name for the override.</p>
|
|
361
645
|
* @public
|
|
362
646
|
*/
|
|
363
|
-
|
|
647
|
+
OverrideName?: string | undefined;
|
|
364
648
|
/**
|
|
365
|
-
* <p>
|
|
649
|
+
* <p>Indicates whether the status is open or closed during the override period. This status determines how the override modifies the base hours of operation schedule.</p>
|
|
366
650
|
* @public
|
|
367
651
|
*/
|
|
368
|
-
|
|
652
|
+
OperationalStatus?: OperationalStatus | undefined;
|
|
369
653
|
}
|
|
370
654
|
/**
|
|
655
|
+
* <p>Information about the hours of operation overrides which contribute to effective hours of operations.</p>
|
|
371
656
|
* @public
|
|
372
657
|
*/
|
|
373
|
-
export interface
|
|
658
|
+
export interface EffectiveOverrideHours {
|
|
374
659
|
/**
|
|
375
|
-
* <p>The
|
|
660
|
+
* <p>The date that the hours of operation override applies to.</p>
|
|
376
661
|
* @public
|
|
377
662
|
*/
|
|
378
|
-
|
|
663
|
+
Date?: string | undefined;
|
|
379
664
|
/**
|
|
380
|
-
* <p>
|
|
381
|
-
* <ul>
|
|
382
|
-
* <li>
|
|
383
|
-
* <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code>
|
|
384
|
-
* </p>
|
|
385
|
-
* </li>
|
|
386
|
-
* <li>
|
|
387
|
-
* <p>Amazon Web Services End User Messaging Social phone number ARN when using
|
|
388
|
-
* <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
|
|
389
|
-
* </p>
|
|
390
|
-
* </li>
|
|
391
|
-
* </ul>
|
|
665
|
+
* <p>Information about the hours of operation overrides that apply to a specific date.</p>
|
|
392
666
|
* @public
|
|
393
667
|
*/
|
|
394
|
-
|
|
668
|
+
OverrideHours?: OverrideHour[] | undefined;
|
|
669
|
+
}
|
|
670
|
+
/**
|
|
671
|
+
* @public
|
|
672
|
+
*/
|
|
673
|
+
export interface GetEffectiveHoursOfOperationsResponse {
|
|
395
674
|
/**
|
|
396
|
-
* <p>
|
|
675
|
+
* <p>Information about the effective hours of operations.</p>
|
|
397
676
|
* @public
|
|
398
677
|
*/
|
|
399
|
-
|
|
678
|
+
EffectiveHoursOfOperationList?: EffectiveHoursOfOperations[] | undefined;
|
|
679
|
+
/**
|
|
680
|
+
* <p>Information about override configurations applied to the base hours of operation to calculate the effective hours.</p>
|
|
681
|
+
* <p>For more information about how override types are applied, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html">Build your list of overrides</a> in the
|
|
682
|
+
* <i> Administrator Guide</i>.</p>
|
|
683
|
+
* @public
|
|
684
|
+
*/
|
|
685
|
+
EffectiveOverrideHoursList?: EffectiveOverrideHours[] | undefined;
|
|
686
|
+
/**
|
|
687
|
+
* <p>The time zone for the hours of operation.</p>
|
|
688
|
+
* @public
|
|
689
|
+
*/
|
|
690
|
+
TimeZone?: string | undefined;
|
|
400
691
|
}
|
|
401
692
|
/**
|
|
402
693
|
* @public
|
|
403
694
|
*/
|
|
404
|
-
export interface
|
|
695
|
+
export interface GetEvaluationFormValidationRequest {
|
|
405
696
|
/**
|
|
406
|
-
* <p>The identifier of the
|
|
697
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
407
698
|
* @public
|
|
408
699
|
*/
|
|
409
|
-
|
|
700
|
+
InstanceId: string | undefined;
|
|
410
701
|
/**
|
|
411
|
-
* <p>The identifier
|
|
702
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
412
703
|
* @public
|
|
413
704
|
*/
|
|
414
|
-
|
|
705
|
+
EvaluationFormId: string | undefined;
|
|
415
706
|
/**
|
|
416
|
-
* <p>
|
|
707
|
+
* <p>The version of the evaluation form to retrieve validation results for.</p>
|
|
417
708
|
* @public
|
|
418
709
|
*/
|
|
419
|
-
|
|
710
|
+
EvaluationFormVersion?: number | undefined;
|
|
420
711
|
}
|
|
421
712
|
/**
|
|
422
|
-
* <p>
|
|
713
|
+
* <p>Information about an evaluation form item affected by a validation finding.</p>
|
|
423
714
|
* @public
|
|
424
715
|
*/
|
|
425
|
-
export interface
|
|
716
|
+
export interface EvaluationFormValidationFindingItem {
|
|
426
717
|
/**
|
|
427
|
-
* <p>The
|
|
718
|
+
* <p>The identifier of the evaluation form item (question or section) affected by the finding.</p>
|
|
428
719
|
* @public
|
|
429
720
|
*/
|
|
430
|
-
|
|
721
|
+
RefId?: string | undefined;
|
|
431
722
|
/**
|
|
432
|
-
* <p>The
|
|
723
|
+
* <p>The specific property of the evaluation form item that the finding relates to.</p>
|
|
433
724
|
* @public
|
|
434
725
|
*/
|
|
435
|
-
|
|
726
|
+
Property?: string | undefined;
|
|
436
727
|
}
|
|
437
728
|
/**
|
|
438
|
-
* <p>
|
|
729
|
+
* <p>Information about a finding from the evaluation form validation process. Each finding identifies a structural
|
|
730
|
+
* issue or quality improvement opportunity for the evaluation form.</p>
|
|
439
731
|
* @public
|
|
440
732
|
*/
|
|
441
|
-
export interface
|
|
733
|
+
export interface EvaluationFormValidationFinding {
|
|
442
734
|
/**
|
|
443
|
-
* <p>
|
|
444
|
-
*
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
*
|
|
454
|
-
*
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
*
|
|
459
|
-
*
|
|
735
|
+
* <p>A code that identifies the type of validation issue found.</p>
|
|
736
|
+
* @public
|
|
737
|
+
*/
|
|
738
|
+
IssueCode: string | undefined;
|
|
739
|
+
/**
|
|
740
|
+
* <p>A list of evaluation form items affected by this finding.</p>
|
|
741
|
+
* @public
|
|
742
|
+
*/
|
|
743
|
+
Items?: EvaluationFormValidationFindingItem[] | undefined;
|
|
744
|
+
/**
|
|
745
|
+
* <p>A description of the validation issue.</p>
|
|
746
|
+
* @public
|
|
747
|
+
*/
|
|
748
|
+
Description: string | undefined;
|
|
749
|
+
/**
|
|
750
|
+
* <p>A suggested fix for the validation issue.</p>
|
|
751
|
+
* @public
|
|
752
|
+
*/
|
|
753
|
+
Suggestion?: string | undefined;
|
|
754
|
+
/**
|
|
755
|
+
* <p>The severity of the finding. Valid values: <code>WARNING</code>, <code>ERROR</code>.</p>
|
|
756
|
+
* @public
|
|
757
|
+
*/
|
|
758
|
+
Severity: EvaluationFormValidationFindingSeverity | undefined;
|
|
759
|
+
}
|
|
760
|
+
/**
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
export interface GetEvaluationFormValidationResponse {
|
|
764
|
+
/**
|
|
765
|
+
* <p>The current status of the validation process. Valid values: <code>IN_PROGRESS</code>,
|
|
766
|
+
* <code>COMPLETED</code>, <code>FAILED</code>.</p>
|
|
767
|
+
* @public
|
|
768
|
+
*/
|
|
769
|
+
Status: EvaluationFormValidationStatus | undefined;
|
|
770
|
+
/**
|
|
771
|
+
* <p>The reason the validation failed. This field is populated only when the status is
|
|
772
|
+
* <code>FAILED</code>.</p>
|
|
773
|
+
* @public
|
|
774
|
+
*/
|
|
775
|
+
FailureReason?: string | undefined;
|
|
776
|
+
/**
|
|
777
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
778
|
+
* @public
|
|
779
|
+
*/
|
|
780
|
+
EvaluationFormId: string | undefined;
|
|
781
|
+
/**
|
|
782
|
+
* <p>A version of the evaluation form.</p>
|
|
783
|
+
* @public
|
|
784
|
+
*/
|
|
785
|
+
EvaluationFormVersion: number | undefined;
|
|
786
|
+
/**
|
|
787
|
+
* <p>The timestamp when the validation process was started.</p>
|
|
788
|
+
* @public
|
|
789
|
+
*/
|
|
790
|
+
StartedTime: Date | undefined;
|
|
791
|
+
/**
|
|
792
|
+
* <p>A list of findings from the validation process. Each finding identifies a structural issue or quality
|
|
793
|
+
* improvement for the evaluation form, and may include a suggested fix. This field is populated when the status is
|
|
794
|
+
* <code>COMPLETED</code>.</p>
|
|
795
|
+
* @public
|
|
796
|
+
*/
|
|
797
|
+
Findings?: EvaluationFormValidationFinding[] | undefined;
|
|
798
|
+
}
|
|
799
|
+
/**
|
|
800
|
+
* @public
|
|
801
|
+
*/
|
|
802
|
+
export interface GetFederationTokenRequest {
|
|
803
|
+
/**
|
|
804
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
805
|
+
* @public
|
|
806
|
+
*/
|
|
807
|
+
InstanceId: string | undefined;
|
|
808
|
+
}
|
|
809
|
+
/**
|
|
810
|
+
* <p>Contains credentials to use for federation.</p>
|
|
811
|
+
* @public
|
|
812
|
+
*/
|
|
813
|
+
export interface Credentials {
|
|
814
|
+
/**
|
|
815
|
+
* <p>An access token generated for a federated user to access Connect Customer.</p>
|
|
816
|
+
* @public
|
|
817
|
+
*/
|
|
818
|
+
AccessToken?: string | undefined;
|
|
819
|
+
/**
|
|
820
|
+
* <p>A token generated with an expiration time for the session a user is logged in to Connect Customer.</p>
|
|
821
|
+
* @public
|
|
822
|
+
*/
|
|
823
|
+
AccessTokenExpiration?: Date | undefined;
|
|
824
|
+
/**
|
|
825
|
+
* <p>Renews a token generated for a user to access the Connect Customer instance.</p>
|
|
826
|
+
* @public
|
|
827
|
+
*/
|
|
828
|
+
RefreshToken?: string | undefined;
|
|
829
|
+
/**
|
|
830
|
+
* <p>Renews the expiration timer for a generated token.</p>
|
|
831
|
+
* @public
|
|
832
|
+
*/
|
|
833
|
+
RefreshTokenExpiration?: Date | undefined;
|
|
834
|
+
}
|
|
835
|
+
/**
|
|
836
|
+
* @public
|
|
837
|
+
*/
|
|
838
|
+
export interface GetFederationTokenResponse {
|
|
839
|
+
/**
|
|
840
|
+
* <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
|
|
841
|
+
* @public
|
|
842
|
+
*/
|
|
843
|
+
UserId?: string | undefined;
|
|
844
|
+
/**
|
|
845
|
+
* <p>The Amazon Resource Name (ARN) of the user.</p>
|
|
846
|
+
* @public
|
|
847
|
+
*/
|
|
848
|
+
UserArn?: string | undefined;
|
|
849
|
+
/**
|
|
850
|
+
* <p>The credentials to use for federation.</p>
|
|
851
|
+
* @public
|
|
852
|
+
*/
|
|
853
|
+
Credentials?: Credentials | undefined;
|
|
854
|
+
/**
|
|
855
|
+
* <p>The URL to sign into the user's instance. </p>
|
|
856
|
+
* @public
|
|
857
|
+
*/
|
|
858
|
+
SignInUrl?: string | undefined;
|
|
859
|
+
}
|
|
860
|
+
/**
|
|
861
|
+
* @public
|
|
862
|
+
*/
|
|
863
|
+
export interface GetFlowAssociationRequest {
|
|
864
|
+
/**
|
|
865
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
866
|
+
* @public
|
|
867
|
+
*/
|
|
868
|
+
InstanceId: string | undefined;
|
|
869
|
+
/**
|
|
870
|
+
* <p>The identifier of the resource.</p>
|
|
871
|
+
* <ul>
|
|
872
|
+
* <li>
|
|
873
|
+
* <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code>
|
|
874
|
+
* </p>
|
|
875
|
+
* </li>
|
|
876
|
+
* <li>
|
|
877
|
+
* <p>Amazon Web Services End User Messaging Social phone number ARN when using
|
|
878
|
+
* <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
|
|
879
|
+
* </p>
|
|
880
|
+
* </li>
|
|
881
|
+
* </ul>
|
|
882
|
+
* @public
|
|
883
|
+
*/
|
|
884
|
+
ResourceId: string | undefined;
|
|
885
|
+
/**
|
|
886
|
+
* <p>A valid resource type.</p>
|
|
887
|
+
* @public
|
|
888
|
+
*/
|
|
889
|
+
ResourceType: FlowAssociationResourceType | undefined;
|
|
890
|
+
}
|
|
891
|
+
/**
|
|
892
|
+
* @public
|
|
893
|
+
*/
|
|
894
|
+
export interface GetFlowAssociationResponse {
|
|
895
|
+
/**
|
|
896
|
+
* <p>The identifier of the resource.</p>
|
|
897
|
+
* @public
|
|
898
|
+
*/
|
|
899
|
+
ResourceId?: string | undefined;
|
|
900
|
+
/**
|
|
901
|
+
* <p>The identifier of the flow.</p>
|
|
902
|
+
* @public
|
|
903
|
+
*/
|
|
904
|
+
FlowId?: string | undefined;
|
|
905
|
+
/**
|
|
906
|
+
* <p>A valid resource type.</p>
|
|
907
|
+
* @public
|
|
908
|
+
*/
|
|
909
|
+
ResourceType?: FlowAssociationResourceType | undefined;
|
|
910
|
+
}
|
|
911
|
+
/**
|
|
912
|
+
* <p>Contains information about the threshold for service level metrics.</p>
|
|
913
|
+
* @public
|
|
914
|
+
*/
|
|
915
|
+
export interface Threshold {
|
|
916
|
+
/**
|
|
917
|
+
* <p>The type of comparison. Only "less than" (LT) comparisons are supported.</p>
|
|
918
|
+
* @public
|
|
919
|
+
*/
|
|
920
|
+
Comparison?: Comparison | undefined;
|
|
921
|
+
/**
|
|
922
|
+
* <p>The threshold value to compare.</p>
|
|
923
|
+
* @public
|
|
924
|
+
*/
|
|
925
|
+
ThresholdValue?: number | undefined;
|
|
926
|
+
}
|
|
927
|
+
/**
|
|
928
|
+
* <p>Contains information about a historical metric. </p>
|
|
929
|
+
* @public
|
|
930
|
+
*/
|
|
931
|
+
export interface HistoricalMetric {
|
|
932
|
+
/**
|
|
933
|
+
* <p>The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed
|
|
934
|
+
* description in the <i>Connect Customer Administrator Guide</i>. </p>
|
|
935
|
+
* <dl>
|
|
936
|
+
* <dt>ABANDON_TIME</dt>
|
|
937
|
+
* <dd>
|
|
938
|
+
* <p>Unit: SECONDS</p>
|
|
939
|
+
* <p>Statistic: AVG</p>
|
|
940
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon
|
|
941
|
+
* time</a>
|
|
942
|
+
* </p>
|
|
943
|
+
* </dd>
|
|
944
|
+
* <dt>AFTER_CONTACT_WORK_TIME</dt>
|
|
945
|
+
* <dd>
|
|
946
|
+
* <p>Unit: SECONDS</p>
|
|
947
|
+
* <p>Statistic: AVG</p>
|
|
948
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time">After contact work time</a>
|
|
949
|
+
* </p>
|
|
460
950
|
* </dd>
|
|
461
951
|
* <dt>API_CONTACTS_HANDLED</dt>
|
|
462
952
|
* <dd>
|
|
@@ -5353,85 +5843,157 @@ export interface ListEvaluationFormVersionsResponse {
|
|
|
5353
5843
|
/**
|
|
5354
5844
|
* @public
|
|
5355
5845
|
*/
|
|
5356
|
-
export interface
|
|
5846
|
+
export interface ListExtractionDefinitionsRequest {
|
|
5357
5847
|
/**
|
|
5358
5848
|
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
5359
5849
|
* @public
|
|
5360
5850
|
*/
|
|
5361
5851
|
InstanceId: string | undefined;
|
|
5362
5852
|
/**
|
|
5363
|
-
* <p>
|
|
5853
|
+
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
5364
5854
|
* @public
|
|
5365
5855
|
*/
|
|
5366
|
-
|
|
5856
|
+
MaxResults?: number | undefined;
|
|
5367
5857
|
/**
|
|
5368
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
5369
|
-
*
|
|
5858
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
5859
|
+
* the next request to retrieve the next set of results.</p>
|
|
5370
5860
|
* @public
|
|
5371
5861
|
*/
|
|
5372
5862
|
NextToken?: string | undefined;
|
|
5373
|
-
/**
|
|
5374
|
-
* <p>The maximum number of results to return per page.</p>
|
|
5375
|
-
* @public
|
|
5376
|
-
*/
|
|
5377
|
-
MaxResults?: number | undefined;
|
|
5378
5863
|
}
|
|
5379
5864
|
/**
|
|
5865
|
+
* <p>Summary information about an extraction definition.</p>
|
|
5380
5866
|
* @public
|
|
5381
5867
|
*/
|
|
5382
|
-
export interface
|
|
5868
|
+
export interface ExtractionDefinitionSummary {
|
|
5383
5869
|
/**
|
|
5384
|
-
* <p>
|
|
5870
|
+
* <p>The name of the extraction definition.</p>
|
|
5385
5871
|
* @public
|
|
5386
5872
|
*/
|
|
5387
|
-
|
|
5873
|
+
Name: string | undefined;
|
|
5388
5874
|
/**
|
|
5389
|
-
* <p>
|
|
5875
|
+
* <p>The identifier of the extraction definition.</p>
|
|
5390
5876
|
* @public
|
|
5391
5877
|
*/
|
|
5392
|
-
|
|
5393
|
-
}
|
|
5394
|
-
/**
|
|
5395
|
-
* @public
|
|
5396
|
-
*/
|
|
5397
|
-
export interface ListHoursOfOperationOverridesRequest {
|
|
5878
|
+
ExtractionDefinitionId: string | undefined;
|
|
5398
5879
|
/**
|
|
5399
|
-
* <p>The
|
|
5880
|
+
* <p>The Amazon Resource Name (ARN) of the extraction definition.</p>
|
|
5400
5881
|
* @public
|
|
5401
5882
|
*/
|
|
5402
|
-
|
|
5883
|
+
ExtractionDefinitionArn: string | undefined;
|
|
5403
5884
|
/**
|
|
5404
|
-
* <p>The
|
|
5885
|
+
* <p>The timestamp when the extraction definition was created.</p>
|
|
5405
5886
|
* @public
|
|
5406
5887
|
*/
|
|
5407
|
-
|
|
5888
|
+
CreatedTime: Date | undefined;
|
|
5408
5889
|
/**
|
|
5409
|
-
* <p>The
|
|
5410
|
-
* retrieve the next set of results.</p>
|
|
5890
|
+
* <p>The timestamp when the extraction definition was last updated.</p>
|
|
5411
5891
|
* @public
|
|
5412
5892
|
*/
|
|
5413
|
-
|
|
5893
|
+
LastUpdatedTime: Date | undefined;
|
|
5414
5894
|
/**
|
|
5415
|
-
* <p>The
|
|
5895
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the extraction definition.</p>
|
|
5416
5896
|
* @public
|
|
5417
5897
|
*/
|
|
5418
|
-
|
|
5898
|
+
LastUpdatedBy: string | undefined;
|
|
5419
5899
|
}
|
|
5420
5900
|
/**
|
|
5421
5901
|
* @public
|
|
5422
5902
|
*/
|
|
5423
|
-
export interface
|
|
5903
|
+
export interface ListExtractionDefinitionsResponse {
|
|
5424
5904
|
/**
|
|
5425
|
-
* <p>
|
|
5426
|
-
* retrieve the next set of results.</p>
|
|
5905
|
+
* <p>Information about the extraction definitions.</p>
|
|
5427
5906
|
* @public
|
|
5428
5907
|
*/
|
|
5429
|
-
|
|
5908
|
+
ExtractionDefinitionSummaryList: ExtractionDefinitionSummary[] | undefined;
|
|
5430
5909
|
/**
|
|
5431
|
-
* <p>
|
|
5910
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
5432
5911
|
* @public
|
|
5433
5912
|
*/
|
|
5434
|
-
|
|
5913
|
+
NextToken?: string | undefined;
|
|
5914
|
+
}
|
|
5915
|
+
/**
|
|
5916
|
+
* @public
|
|
5917
|
+
*/
|
|
5918
|
+
export interface ListFlowAssociationsRequest {
|
|
5919
|
+
/**
|
|
5920
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
5921
|
+
* @public
|
|
5922
|
+
*/
|
|
5923
|
+
InstanceId: string | undefined;
|
|
5924
|
+
/**
|
|
5925
|
+
* <p>A valid resource type.</p>
|
|
5926
|
+
* @public
|
|
5927
|
+
*/
|
|
5928
|
+
ResourceType?: ListFlowAssociationResourceType | undefined;
|
|
5929
|
+
/**
|
|
5930
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
5931
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
5932
|
+
* @public
|
|
5933
|
+
*/
|
|
5934
|
+
NextToken?: string | undefined;
|
|
5935
|
+
/**
|
|
5936
|
+
* <p>The maximum number of results to return per page.</p>
|
|
5937
|
+
* @public
|
|
5938
|
+
*/
|
|
5939
|
+
MaxResults?: number | undefined;
|
|
5940
|
+
}
|
|
5941
|
+
/**
|
|
5942
|
+
* @public
|
|
5943
|
+
*/
|
|
5944
|
+
export interface ListFlowAssociationsResponse {
|
|
5945
|
+
/**
|
|
5946
|
+
* <p>Summary of flow associations.</p>
|
|
5947
|
+
* @public
|
|
5948
|
+
*/
|
|
5949
|
+
FlowAssociationSummaryList?: FlowAssociationSummary[] | undefined;
|
|
5950
|
+
/**
|
|
5951
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
5952
|
+
* @public
|
|
5953
|
+
*/
|
|
5954
|
+
NextToken?: string | undefined;
|
|
5955
|
+
}
|
|
5956
|
+
/**
|
|
5957
|
+
* @public
|
|
5958
|
+
*/
|
|
5959
|
+
export interface ListHoursOfOperationOverridesRequest {
|
|
5960
|
+
/**
|
|
5961
|
+
* <p>The identifier of the Connect Customer instance.</p>
|
|
5962
|
+
* @public
|
|
5963
|
+
*/
|
|
5964
|
+
InstanceId: string | undefined;
|
|
5965
|
+
/**
|
|
5966
|
+
* <p>The identifier for the hours of operation.</p>
|
|
5967
|
+
* @public
|
|
5968
|
+
*/
|
|
5969
|
+
HoursOfOperationId: string | undefined;
|
|
5970
|
+
/**
|
|
5971
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
5972
|
+
* retrieve the next set of results.</p>
|
|
5973
|
+
* @public
|
|
5974
|
+
*/
|
|
5975
|
+
NextToken?: string | undefined;
|
|
5976
|
+
/**
|
|
5977
|
+
* <p>The maximum number of results to return per page.</p>
|
|
5978
|
+
* @public
|
|
5979
|
+
*/
|
|
5980
|
+
MaxResults?: number | undefined;
|
|
5981
|
+
}
|
|
5982
|
+
/**
|
|
5983
|
+
* @public
|
|
5984
|
+
*/
|
|
5985
|
+
export interface ListHoursOfOperationOverridesResponse {
|
|
5986
|
+
/**
|
|
5987
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
5988
|
+
* retrieve the next set of results.</p>
|
|
5989
|
+
* @public
|
|
5990
|
+
*/
|
|
5991
|
+
NextToken?: string | undefined;
|
|
5992
|
+
/**
|
|
5993
|
+
* <p>Information about the hours of operation override.</p>
|
|
5994
|
+
* @public
|
|
5995
|
+
*/
|
|
5996
|
+
HoursOfOperationOverrideList?: HoursOfOperationOverride[] | undefined;
|
|
5435
5997
|
/**
|
|
5436
5998
|
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
5437
5999
|
* @public
|
|
@@ -7141,391 +7703,28 @@ export interface RoutingProfileManualAssignmentQueueConfigSummary {
|
|
|
7141
7703
|
*/
|
|
7142
7704
|
QueueName: string | undefined;
|
|
7143
7705
|
/**
|
|
7144
|
-
* <p>The channels this queue supports. Valid Values: CHAT | TASK | EMAIL </p>
|
|
7145
|
-
* <important>
|
|
7146
|
-
* <p>VOICE is not supported. The information shown below is incorrect. We're working to correct it. </p>
|
|
7147
|
-
* </important>
|
|
7148
|
-
* @public
|
|
7149
|
-
*/
|
|
7150
|
-
Channel: Channel | undefined;
|
|
7151
|
-
}
|
|
7152
|
-
/**
|
|
7153
|
-
* @public
|
|
7154
|
-
*/
|
|
7155
|
-
export interface ListRoutingProfileManualAssignmentQueuesResponse {
|
|
7156
|
-
/**
|
|
7157
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7158
|
-
* @public
|
|
7159
|
-
*/
|
|
7160
|
-
NextToken?: string | undefined;
|
|
7161
|
-
/**
|
|
7162
|
-
* <p>Information about the manual assignment queues associated with the routing profile.</p>
|
|
7163
|
-
* @public
|
|
7164
|
-
*/
|
|
7165
|
-
RoutingProfileManualAssignmentQueueConfigSummaryList?: RoutingProfileManualAssignmentQueueConfigSummary[] | undefined;
|
|
7166
|
-
/**
|
|
7167
|
-
* <p>The timestamp when this resource was last modified.</p>
|
|
7168
|
-
* @public
|
|
7169
|
-
*/
|
|
7170
|
-
LastModifiedTime?: Date | undefined;
|
|
7171
|
-
/**
|
|
7172
|
-
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
7173
|
-
* @public
|
|
7174
|
-
*/
|
|
7175
|
-
LastModifiedRegion?: string | undefined;
|
|
7176
|
-
}
|
|
7177
|
-
/**
|
|
7178
|
-
* @public
|
|
7179
|
-
*/
|
|
7180
|
-
export interface ListRoutingProfileQueuesRequest {
|
|
7181
|
-
/**
|
|
7182
|
-
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
7183
|
-
* @public
|
|
7184
|
-
*/
|
|
7185
|
-
InstanceId: string | undefined;
|
|
7186
|
-
/**
|
|
7187
|
-
* <p>The identifier of the routing profile.</p>
|
|
7188
|
-
* @public
|
|
7189
|
-
*/
|
|
7190
|
-
RoutingProfileId: string | undefined;
|
|
7191
|
-
/**
|
|
7192
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7193
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
7194
|
-
* @public
|
|
7195
|
-
*/
|
|
7196
|
-
NextToken?: string | undefined;
|
|
7197
|
-
/**
|
|
7198
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
7199
|
-
* @public
|
|
7200
|
-
*/
|
|
7201
|
-
MaxResults?: number | undefined;
|
|
7202
|
-
}
|
|
7203
|
-
/**
|
|
7204
|
-
* <p>Contains summary information about a routing profile queue.</p>
|
|
7205
|
-
* @public
|
|
7206
|
-
*/
|
|
7207
|
-
export interface RoutingProfileQueueConfigSummary {
|
|
7208
|
-
/**
|
|
7209
|
-
* <p>The identifier for the queue.</p>
|
|
7210
|
-
* @public
|
|
7211
|
-
*/
|
|
7212
|
-
QueueId: string | undefined;
|
|
7213
|
-
/**
|
|
7214
|
-
* <p>The Amazon Resource Name (ARN) of the queue.</p>
|
|
7215
|
-
* @public
|
|
7216
|
-
*/
|
|
7217
|
-
QueueArn: string | undefined;
|
|
7218
|
-
/**
|
|
7219
|
-
* <p>The name of the queue.</p>
|
|
7220
|
-
* @public
|
|
7221
|
-
*/
|
|
7222
|
-
QueueName: string | undefined;
|
|
7223
|
-
/**
|
|
7224
|
-
* <p>The order in which contacts are to be handled for the queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html">Queues: priority and
|
|
7225
|
-
* delay</a>.</p>
|
|
7226
|
-
* @public
|
|
7227
|
-
*/
|
|
7228
|
-
Priority: number | undefined;
|
|
7229
|
-
/**
|
|
7230
|
-
* <p>The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For
|
|
7231
|
-
* more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html">Queues: priority and delay</a> in the
|
|
7232
|
-
* <i>Connect Customer Administrator Guide</i>.</p>
|
|
7233
|
-
* @public
|
|
7234
|
-
*/
|
|
7235
|
-
Delay: number | undefined;
|
|
7236
|
-
/**
|
|
7237
|
-
* <p>The channels this queue supports.</p>
|
|
7238
|
-
* @public
|
|
7239
|
-
*/
|
|
7240
|
-
Channel: Channel | undefined;
|
|
7241
|
-
}
|
|
7242
|
-
/**
|
|
7243
|
-
* @public
|
|
7244
|
-
*/
|
|
7245
|
-
export interface ListRoutingProfileQueuesResponse {
|
|
7246
|
-
/**
|
|
7247
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7248
|
-
* @public
|
|
7249
|
-
*/
|
|
7250
|
-
NextToken?: string | undefined;
|
|
7251
|
-
/**
|
|
7252
|
-
* <p>Information about the routing profiles.</p>
|
|
7253
|
-
* @public
|
|
7254
|
-
*/
|
|
7255
|
-
RoutingProfileQueueConfigSummaryList?: RoutingProfileQueueConfigSummary[] | undefined;
|
|
7256
|
-
/**
|
|
7257
|
-
* <p>The timestamp when this resource was last modified.</p>
|
|
7258
|
-
* @public
|
|
7259
|
-
*/
|
|
7260
|
-
LastModifiedTime?: Date | undefined;
|
|
7261
|
-
/**
|
|
7262
|
-
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
7263
|
-
* @public
|
|
7264
|
-
*/
|
|
7265
|
-
LastModifiedRegion?: string | undefined;
|
|
7266
|
-
}
|
|
7267
|
-
/**
|
|
7268
|
-
* @public
|
|
7269
|
-
*/
|
|
7270
|
-
export interface ListRoutingProfilesRequest {
|
|
7271
|
-
/**
|
|
7272
|
-
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
7273
|
-
* @public
|
|
7274
|
-
*/
|
|
7275
|
-
InstanceId: string | undefined;
|
|
7276
|
-
/**
|
|
7277
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7278
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
7279
|
-
* @public
|
|
7280
|
-
*/
|
|
7281
|
-
NextToken?: string | undefined;
|
|
7282
|
-
/**
|
|
7283
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
7284
|
-
* @public
|
|
7285
|
-
*/
|
|
7286
|
-
MaxResults?: number | undefined;
|
|
7287
|
-
}
|
|
7288
|
-
/**
|
|
7289
|
-
* <p>Contains summary information about a routing profile.</p>
|
|
7290
|
-
* @public
|
|
7291
|
-
*/
|
|
7292
|
-
export interface RoutingProfileSummary {
|
|
7293
|
-
/**
|
|
7294
|
-
* <p>The identifier of the routing profile.</p>
|
|
7295
|
-
* @public
|
|
7296
|
-
*/
|
|
7297
|
-
Id?: string | undefined;
|
|
7298
|
-
/**
|
|
7299
|
-
* <p>The Amazon Resource Name (ARN) of the routing profile.</p>
|
|
7300
|
-
* @public
|
|
7301
|
-
*/
|
|
7302
|
-
Arn?: string | undefined;
|
|
7303
|
-
/**
|
|
7304
|
-
* <p>The name of the routing profile.</p>
|
|
7305
|
-
* @public
|
|
7306
|
-
*/
|
|
7307
|
-
Name?: string | undefined;
|
|
7308
|
-
/**
|
|
7309
|
-
* <p>The timestamp when this resource was last modified.</p>
|
|
7310
|
-
* @public
|
|
7311
|
-
*/
|
|
7312
|
-
LastModifiedTime?: Date | undefined;
|
|
7313
|
-
/**
|
|
7314
|
-
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
7315
|
-
* @public
|
|
7316
|
-
*/
|
|
7317
|
-
LastModifiedRegion?: string | undefined;
|
|
7318
|
-
}
|
|
7319
|
-
/**
|
|
7320
|
-
* @public
|
|
7321
|
-
*/
|
|
7322
|
-
export interface ListRoutingProfilesResponse {
|
|
7323
|
-
/**
|
|
7324
|
-
* <p>Information about the routing profiles.</p>
|
|
7325
|
-
* @public
|
|
7326
|
-
*/
|
|
7327
|
-
RoutingProfileSummaryList?: RoutingProfileSummary[] | undefined;
|
|
7328
|
-
/**
|
|
7329
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7330
|
-
* @public
|
|
7331
|
-
*/
|
|
7332
|
-
NextToken?: string | undefined;
|
|
7333
|
-
}
|
|
7334
|
-
/**
|
|
7335
|
-
* @public
|
|
7336
|
-
*/
|
|
7337
|
-
export interface ListRulesRequest {
|
|
7338
|
-
/**
|
|
7339
|
-
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
7340
|
-
* @public
|
|
7341
|
-
*/
|
|
7342
|
-
InstanceId: string | undefined;
|
|
7343
|
-
/**
|
|
7344
|
-
* <p>The publish status of the rule.</p>
|
|
7345
|
-
* @public
|
|
7346
|
-
*/
|
|
7347
|
-
PublishStatus?: RulePublishStatus | undefined;
|
|
7348
|
-
/**
|
|
7349
|
-
* <p>The name of the event source.</p>
|
|
7350
|
-
* @public
|
|
7351
|
-
*/
|
|
7352
|
-
EventSourceName?: EventSourceName | undefined;
|
|
7353
|
-
/**
|
|
7354
|
-
* <p>The maximum number of results to return per page.</p>
|
|
7355
|
-
* @public
|
|
7356
|
-
*/
|
|
7357
|
-
MaxResults?: number | undefined;
|
|
7358
|
-
/**
|
|
7359
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7360
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
7361
|
-
* @public
|
|
7362
|
-
*/
|
|
7363
|
-
NextToken?: string | undefined;
|
|
7364
|
-
}
|
|
7365
|
-
/**
|
|
7366
|
-
* <p>A list of <code>ActionTypes</code> associated with a rule. </p>
|
|
7367
|
-
* @public
|
|
7368
|
-
*/
|
|
7369
|
-
export interface RuleSummary {
|
|
7370
|
-
/**
|
|
7371
|
-
* <p>The name of the rule.</p>
|
|
7372
|
-
* @public
|
|
7373
|
-
*/
|
|
7374
|
-
Name: string | undefined;
|
|
7375
|
-
/**
|
|
7376
|
-
* <p>A unique identifier for the rule.</p>
|
|
7377
|
-
* @public
|
|
7378
|
-
*/
|
|
7379
|
-
RuleId: string | undefined;
|
|
7380
|
-
/**
|
|
7381
|
-
* <p>The Amazon Resource Name (ARN) of the rule.</p>
|
|
7382
|
-
* @public
|
|
7383
|
-
*/
|
|
7384
|
-
RuleArn: string | undefined;
|
|
7385
|
-
/**
|
|
7386
|
-
* <p>The name of the event source.</p>
|
|
7387
|
-
* @public
|
|
7388
|
-
*/
|
|
7389
|
-
EventSourceName: EventSourceName | undefined;
|
|
7390
|
-
/**
|
|
7391
|
-
* <p>The publish status of the rule.</p>
|
|
7392
|
-
* @public
|
|
7393
|
-
*/
|
|
7394
|
-
PublishStatus: RulePublishStatus | undefined;
|
|
7395
|
-
/**
|
|
7396
|
-
* <p>The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example,
|
|
7397
|
-
* <code>GenerativeAI</code>).</p>
|
|
7398
|
-
* @public
|
|
7399
|
-
*/
|
|
7400
|
-
RuleCapabilityTiers?: RuleCapabilityTier[] | undefined;
|
|
7401
|
-
/**
|
|
7402
|
-
* <p>A list of ActionTypes associated with a rule. </p>
|
|
7403
|
-
* @public
|
|
7404
|
-
*/
|
|
7405
|
-
ActionSummaries: ActionSummary[] | undefined;
|
|
7406
|
-
/**
|
|
7407
|
-
* <p>The timestamp for when the rule was created. </p>
|
|
7408
|
-
* @public
|
|
7409
|
-
*/
|
|
7410
|
-
CreatedTime: Date | undefined;
|
|
7411
|
-
/**
|
|
7412
|
-
* <p>The timestamp for when the rule was last updated.</p>
|
|
7413
|
-
* @public
|
|
7414
|
-
*/
|
|
7415
|
-
LastUpdatedTime: Date | undefined;
|
|
7416
|
-
}
|
|
7417
|
-
/**
|
|
7418
|
-
* @public
|
|
7419
|
-
*/
|
|
7420
|
-
export interface ListRulesResponse {
|
|
7421
|
-
/**
|
|
7422
|
-
* <p>Summary information about a rule.</p>
|
|
7423
|
-
* @public
|
|
7424
|
-
*/
|
|
7425
|
-
RuleSummaryList: RuleSummary[] | undefined;
|
|
7426
|
-
/**
|
|
7427
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7428
|
-
* @public
|
|
7429
|
-
*/
|
|
7430
|
-
NextToken?: string | undefined;
|
|
7431
|
-
}
|
|
7432
|
-
/**
|
|
7433
|
-
* @public
|
|
7434
|
-
*/
|
|
7435
|
-
export interface ListSecurityKeysRequest {
|
|
7436
|
-
/**
|
|
7437
|
-
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
7438
|
-
* @public
|
|
7439
|
-
*/
|
|
7440
|
-
InstanceId: string | undefined;
|
|
7441
|
-
/**
|
|
7442
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7443
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
7444
|
-
* @public
|
|
7445
|
-
*/
|
|
7446
|
-
NextToken?: string | undefined;
|
|
7447
|
-
/**
|
|
7448
|
-
* <p>The maximum number of results to return per page.</p>
|
|
7449
|
-
* @public
|
|
7450
|
-
*/
|
|
7451
|
-
MaxResults?: number | undefined;
|
|
7452
|
-
}
|
|
7453
|
-
/**
|
|
7454
|
-
* <p>Configuration information of the security key.</p>
|
|
7455
|
-
* @public
|
|
7456
|
-
*/
|
|
7457
|
-
export interface SecurityKey {
|
|
7458
|
-
/**
|
|
7459
|
-
* <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
|
|
7460
|
-
* @public
|
|
7461
|
-
*/
|
|
7462
|
-
AssociationId?: string | undefined;
|
|
7463
|
-
/**
|
|
7464
|
-
* <p>The key of the security key.</p>
|
|
7465
|
-
* @public
|
|
7466
|
-
*/
|
|
7467
|
-
Key?: string | undefined;
|
|
7468
|
-
/**
|
|
7469
|
-
* <p>When the security key was created.</p>
|
|
7470
|
-
* @public
|
|
7471
|
-
*/
|
|
7472
|
-
CreationTime?: Date | undefined;
|
|
7473
|
-
}
|
|
7474
|
-
/**
|
|
7475
|
-
* @public
|
|
7476
|
-
*/
|
|
7477
|
-
export interface ListSecurityKeysResponse {
|
|
7478
|
-
/**
|
|
7479
|
-
* <p>The security keys.</p>
|
|
7480
|
-
* @public
|
|
7481
|
-
*/
|
|
7482
|
-
SecurityKeys?: SecurityKey[] | undefined;
|
|
7483
|
-
/**
|
|
7484
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7485
|
-
* @public
|
|
7486
|
-
*/
|
|
7487
|
-
NextToken?: string | undefined;
|
|
7488
|
-
}
|
|
7489
|
-
/**
|
|
7490
|
-
* @public
|
|
7491
|
-
*/
|
|
7492
|
-
export interface ListSecurityProfileApplicationsRequest {
|
|
7493
|
-
/**
|
|
7494
|
-
* <p>The identifier for the security profle.</p>
|
|
7495
|
-
* @public
|
|
7496
|
-
*/
|
|
7497
|
-
SecurityProfileId: string | undefined;
|
|
7498
|
-
/**
|
|
7499
|
-
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
7500
|
-
* @public
|
|
7501
|
-
*/
|
|
7502
|
-
InstanceId: string | undefined;
|
|
7503
|
-
/**
|
|
7504
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7505
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
7506
|
-
* @public
|
|
7507
|
-
*/
|
|
7508
|
-
NextToken?: string | undefined;
|
|
7509
|
-
/**
|
|
7510
|
-
* <p>The maximum number of results to return per page.</p>
|
|
7706
|
+
* <p>The channels this queue supports. Valid Values: CHAT | TASK | EMAIL </p>
|
|
7707
|
+
* <important>
|
|
7708
|
+
* <p>VOICE is not supported. The information shown below is incorrect. We're working to correct it. </p>
|
|
7709
|
+
* </important>
|
|
7511
7710
|
* @public
|
|
7512
7711
|
*/
|
|
7513
|
-
|
|
7712
|
+
Channel: Channel | undefined;
|
|
7514
7713
|
}
|
|
7515
7714
|
/**
|
|
7516
7715
|
* @public
|
|
7517
7716
|
*/
|
|
7518
|
-
export interface
|
|
7717
|
+
export interface ListRoutingProfileManualAssignmentQueuesResponse {
|
|
7519
7718
|
/**
|
|
7520
|
-
* <p>
|
|
7719
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7521
7720
|
* @public
|
|
7522
7721
|
*/
|
|
7523
|
-
|
|
7722
|
+
NextToken?: string | undefined;
|
|
7524
7723
|
/**
|
|
7525
|
-
* <p>
|
|
7724
|
+
* <p>Information about the manual assignment queues associated with the routing profile.</p>
|
|
7526
7725
|
* @public
|
|
7527
7726
|
*/
|
|
7528
|
-
|
|
7727
|
+
RoutingProfileManualAssignmentQueueConfigSummaryList?: RoutingProfileManualAssignmentQueueConfigSummary[] | undefined;
|
|
7529
7728
|
/**
|
|
7530
7729
|
* <p>The timestamp when this resource was last modified.</p>
|
|
7531
7730
|
* @public
|
|
@@ -7540,96 +7739,82 @@ export interface ListSecurityProfileApplicationsResponse {
|
|
|
7540
7739
|
/**
|
|
7541
7740
|
* @public
|
|
7542
7741
|
*/
|
|
7543
|
-
export interface
|
|
7742
|
+
export interface ListRoutingProfileQueuesRequest {
|
|
7544
7743
|
/**
|
|
7545
|
-
* <p>
|
|
7744
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
7546
7745
|
* @public
|
|
7547
7746
|
*/
|
|
7548
|
-
|
|
7747
|
+
InstanceId: string | undefined;
|
|
7549
7748
|
/**
|
|
7550
|
-
* <p>
|
|
7749
|
+
* <p>The identifier of the routing profile.</p>
|
|
7551
7750
|
* @public
|
|
7552
7751
|
*/
|
|
7553
|
-
|
|
7752
|
+
RoutingProfileId: string | undefined;
|
|
7554
7753
|
/**
|
|
7555
|
-
* <p>
|
|
7556
|
-
*
|
|
7754
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7755
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
7557
7756
|
* @public
|
|
7558
7757
|
*/
|
|
7559
7758
|
NextToken?: string | undefined;
|
|
7560
7759
|
/**
|
|
7561
|
-
* <p>
|
|
7760
|
+
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
7562
7761
|
* @public
|
|
7563
7762
|
*/
|
|
7564
7763
|
MaxResults?: number | undefined;
|
|
7565
7764
|
}
|
|
7566
7765
|
/**
|
|
7766
|
+
* <p>Contains summary information about a routing profile queue.</p>
|
|
7567
7767
|
* @public
|
|
7568
7768
|
*/
|
|
7569
|
-
export interface
|
|
7570
|
-
/**
|
|
7571
|
-
* <p> A list of Flow Modules an AI Agent can invoke as a tool. </p>
|
|
7572
|
-
* @public
|
|
7573
|
-
*/
|
|
7574
|
-
AllowedFlowModules?: FlowModule[] | undefined;
|
|
7575
|
-
/**
|
|
7576
|
-
* <p> The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
7577
|
-
* retrieve the next set of results. </p>
|
|
7578
|
-
* @public
|
|
7579
|
-
*/
|
|
7580
|
-
NextToken?: string | undefined;
|
|
7769
|
+
export interface RoutingProfileQueueConfigSummary {
|
|
7581
7770
|
/**
|
|
7582
|
-
* <p>
|
|
7771
|
+
* <p>The identifier for the queue.</p>
|
|
7583
7772
|
* @public
|
|
7584
7773
|
*/
|
|
7585
|
-
|
|
7774
|
+
QueueId: string | undefined;
|
|
7586
7775
|
/**
|
|
7587
|
-
* <p>
|
|
7776
|
+
* <p>The Amazon Resource Name (ARN) of the queue.</p>
|
|
7588
7777
|
* @public
|
|
7589
7778
|
*/
|
|
7590
|
-
|
|
7591
|
-
}
|
|
7592
|
-
/**
|
|
7593
|
-
* @public
|
|
7594
|
-
*/
|
|
7595
|
-
export interface ListSecurityProfilePermissionsRequest {
|
|
7779
|
+
QueueArn: string | undefined;
|
|
7596
7780
|
/**
|
|
7597
|
-
* <p>The
|
|
7781
|
+
* <p>The name of the queue.</p>
|
|
7598
7782
|
* @public
|
|
7599
7783
|
*/
|
|
7600
|
-
|
|
7784
|
+
QueueName: string | undefined;
|
|
7601
7785
|
/**
|
|
7602
|
-
* <p>The
|
|
7786
|
+
* <p>The order in which contacts are to be handled for the queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html">Queues: priority and
|
|
7787
|
+
* delay</a>.</p>
|
|
7603
7788
|
* @public
|
|
7604
7789
|
*/
|
|
7605
|
-
|
|
7790
|
+
Priority: number | undefined;
|
|
7606
7791
|
/**
|
|
7607
|
-
* <p>The
|
|
7608
|
-
*
|
|
7792
|
+
* <p>The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For
|
|
7793
|
+
* more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html">Queues: priority and delay</a> in the
|
|
7794
|
+
* <i>Connect Customer Administrator Guide</i>.</p>
|
|
7609
7795
|
* @public
|
|
7610
7796
|
*/
|
|
7611
|
-
|
|
7797
|
+
Delay: number | undefined;
|
|
7612
7798
|
/**
|
|
7613
|
-
* <p>The
|
|
7799
|
+
* <p>The channels this queue supports.</p>
|
|
7614
7800
|
* @public
|
|
7615
7801
|
*/
|
|
7616
|
-
|
|
7802
|
+
Channel: Channel | undefined;
|
|
7617
7803
|
}
|
|
7618
7804
|
/**
|
|
7619
7805
|
* @public
|
|
7620
7806
|
*/
|
|
7621
|
-
export interface
|
|
7807
|
+
export interface ListRoutingProfileQueuesResponse {
|
|
7622
7808
|
/**
|
|
7623
|
-
* <p>
|
|
7624
|
-
* permissions</a>.</p>
|
|
7809
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7625
7810
|
* @public
|
|
7626
7811
|
*/
|
|
7627
|
-
|
|
7812
|
+
NextToken?: string | undefined;
|
|
7628
7813
|
/**
|
|
7629
|
-
* <p>
|
|
7814
|
+
* <p>Information about the routing profiles.</p>
|
|
7630
7815
|
* @public
|
|
7631
7816
|
*/
|
|
7632
|
-
|
|
7817
|
+
RoutingProfileQueueConfigSummaryList?: RoutingProfileQueueConfigSummary[] | undefined;
|
|
7633
7818
|
/**
|
|
7634
7819
|
* <p>The timestamp when this resource was last modified.</p>
|
|
7635
7820
|
* @public
|
|
@@ -7644,7 +7829,7 @@ export interface ListSecurityProfilePermissionsResponse {
|
|
|
7644
7829
|
/**
|
|
7645
7830
|
* @public
|
|
7646
7831
|
*/
|
|
7647
|
-
export interface
|
|
7832
|
+
export interface ListRoutingProfilesRequest {
|
|
7648
7833
|
/**
|
|
7649
7834
|
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
7650
7835
|
* @public
|
|
@@ -7663,22 +7848,22 @@ export interface ListSecurityProfilesRequest {
|
|
|
7663
7848
|
MaxResults?: number | undefined;
|
|
7664
7849
|
}
|
|
7665
7850
|
/**
|
|
7666
|
-
* <p>Contains information about a
|
|
7851
|
+
* <p>Contains summary information about a routing profile.</p>
|
|
7667
7852
|
* @public
|
|
7668
7853
|
*/
|
|
7669
|
-
export interface
|
|
7854
|
+
export interface RoutingProfileSummary {
|
|
7670
7855
|
/**
|
|
7671
|
-
* <p>The identifier of the
|
|
7856
|
+
* <p>The identifier of the routing profile.</p>
|
|
7672
7857
|
* @public
|
|
7673
7858
|
*/
|
|
7674
7859
|
Id?: string | undefined;
|
|
7675
7860
|
/**
|
|
7676
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
7861
|
+
* <p>The Amazon Resource Name (ARN) of the routing profile.</p>
|
|
7677
7862
|
* @public
|
|
7678
7863
|
*/
|
|
7679
7864
|
Arn?: string | undefined;
|
|
7680
7865
|
/**
|
|
7681
|
-
* <p>The name of the
|
|
7866
|
+
* <p>The name of the routing profile.</p>
|
|
7682
7867
|
* @public
|
|
7683
7868
|
*/
|
|
7684
7869
|
Name?: string | undefined;
|
|
@@ -7696,12 +7881,12 @@ export interface SecurityProfileSummary {
|
|
|
7696
7881
|
/**
|
|
7697
7882
|
* @public
|
|
7698
7883
|
*/
|
|
7699
|
-
export interface
|
|
7884
|
+
export interface ListRoutingProfilesResponse {
|
|
7700
7885
|
/**
|
|
7701
|
-
* <p>Information about the
|
|
7886
|
+
* <p>Information about the routing profiles.</p>
|
|
7702
7887
|
* @public
|
|
7703
7888
|
*/
|
|
7704
|
-
|
|
7889
|
+
RoutingProfileSummaryList?: RoutingProfileSummary[] | undefined;
|
|
7705
7890
|
/**
|
|
7706
7891
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7707
7892
|
* @public
|
|
@@ -7711,148 +7896,172 @@ export interface ListSecurityProfilesResponse {
|
|
|
7711
7896
|
/**
|
|
7712
7897
|
* @public
|
|
7713
7898
|
*/
|
|
7714
|
-
export interface
|
|
7899
|
+
export interface ListRulesRequest {
|
|
7715
7900
|
/**
|
|
7716
|
-
* <p>The
|
|
7717
|
-
* an ARN. To locate the ARN for an instance, for example, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">Find your Connect Customer instance ID/ARN</a>. </p>
|
|
7901
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
7718
7902
|
* @public
|
|
7719
7903
|
*/
|
|
7720
|
-
|
|
7721
|
-
}
|
|
7722
|
-
/**
|
|
7723
|
-
* @public
|
|
7724
|
-
*/
|
|
7725
|
-
export interface ListTagsForResourceResponse {
|
|
7904
|
+
InstanceId: string | undefined;
|
|
7726
7905
|
/**
|
|
7727
|
-
* <p>
|
|
7906
|
+
* <p>The publish status of the rule.</p>
|
|
7728
7907
|
* @public
|
|
7729
7908
|
*/
|
|
7730
|
-
|
|
7731
|
-
}
|
|
7732
|
-
/**
|
|
7733
|
-
* @public
|
|
7734
|
-
*/
|
|
7735
|
-
export interface ListTaskTemplatesRequest {
|
|
7909
|
+
PublishStatus?: RulePublishStatus | undefined;
|
|
7736
7910
|
/**
|
|
7737
|
-
* <p>The
|
|
7911
|
+
* <p>The name of the event source.</p>
|
|
7738
7912
|
* @public
|
|
7739
7913
|
*/
|
|
7740
|
-
|
|
7914
|
+
EventSourceName?: EventSourceName | undefined;
|
|
7915
|
+
/**
|
|
7916
|
+
* <p>The maximum number of results to return per page.</p>
|
|
7917
|
+
* @public
|
|
7918
|
+
*/
|
|
7919
|
+
MaxResults?: number | undefined;
|
|
7741
7920
|
/**
|
|
7742
7921
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7743
7922
|
* response in the next request to retrieve the next set of results.</p>
|
|
7744
|
-
* <important>
|
|
7745
|
-
* <p>It is not expected that you set this because the value returned in the previous response is always null.</p>
|
|
7746
|
-
* </important>
|
|
7747
7923
|
* @public
|
|
7748
7924
|
*/
|
|
7749
7925
|
NextToken?: string | undefined;
|
|
7926
|
+
}
|
|
7927
|
+
/**
|
|
7928
|
+
* <p>A list of <code>ActionTypes</code> associated with a rule. </p>
|
|
7929
|
+
* @public
|
|
7930
|
+
*/
|
|
7931
|
+
export interface RuleSummary {
|
|
7750
7932
|
/**
|
|
7751
|
-
* <p>The
|
|
7752
|
-
* <important>
|
|
7753
|
-
* <p>It is not expected that you set this.</p>
|
|
7754
|
-
* </important>
|
|
7933
|
+
* <p>The name of the rule.</p>
|
|
7755
7934
|
* @public
|
|
7756
7935
|
*/
|
|
7757
|
-
|
|
7936
|
+
Name: string | undefined;
|
|
7758
7937
|
/**
|
|
7759
|
-
* <p>
|
|
7760
|
-
* Tasks can only be created from <code>ACTIVE</code> templates.
|
|
7761
|
-
* If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
|
|
7938
|
+
* <p>A unique identifier for the rule.</p>
|
|
7762
7939
|
* @public
|
|
7763
7940
|
*/
|
|
7764
|
-
|
|
7941
|
+
RuleId: string | undefined;
|
|
7765
7942
|
/**
|
|
7766
|
-
* <p>The
|
|
7943
|
+
* <p>The Amazon Resource Name (ARN) of the rule.</p>
|
|
7767
7944
|
* @public
|
|
7768
7945
|
*/
|
|
7769
|
-
|
|
7770
|
-
}
|
|
7771
|
-
/**
|
|
7772
|
-
* <p>Contains summary information about the task template.</p>
|
|
7773
|
-
* @public
|
|
7774
|
-
*/
|
|
7775
|
-
export interface TaskTemplateMetadata {
|
|
7946
|
+
RuleArn: string | undefined;
|
|
7776
7947
|
/**
|
|
7777
|
-
* <p>
|
|
7948
|
+
* <p>The name of the event source.</p>
|
|
7778
7949
|
* @public
|
|
7779
7950
|
*/
|
|
7780
|
-
|
|
7951
|
+
EventSourceName: EventSourceName | undefined;
|
|
7781
7952
|
/**
|
|
7782
|
-
* <p>The
|
|
7953
|
+
* <p>The publish status of the rule.</p>
|
|
7783
7954
|
* @public
|
|
7784
7955
|
*/
|
|
7785
|
-
|
|
7956
|
+
PublishStatus: RulePublishStatus | undefined;
|
|
7786
7957
|
/**
|
|
7787
|
-
* <p>The
|
|
7958
|
+
* <p>The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example,
|
|
7959
|
+
* <code>GenerativeAI</code>).</p>
|
|
7788
7960
|
* @public
|
|
7789
7961
|
*/
|
|
7790
|
-
|
|
7962
|
+
RuleCapabilityTiers?: RuleCapabilityTier[] | undefined;
|
|
7791
7963
|
/**
|
|
7792
|
-
* <p>
|
|
7964
|
+
* <p>A list of ActionTypes associated with a rule. </p>
|
|
7793
7965
|
* @public
|
|
7794
7966
|
*/
|
|
7795
|
-
|
|
7967
|
+
ActionSummaries: ActionSummary[] | undefined;
|
|
7796
7968
|
/**
|
|
7797
|
-
* <p>
|
|
7798
|
-
* Tasks can only be created from <code>ACTIVE</code> templates.
|
|
7799
|
-
* If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
|
|
7969
|
+
* <p>The timestamp for when the rule was created. </p>
|
|
7800
7970
|
* @public
|
|
7801
7971
|
*/
|
|
7802
|
-
|
|
7972
|
+
CreatedTime: Date | undefined;
|
|
7803
7973
|
/**
|
|
7804
|
-
* <p>The timestamp when the
|
|
7974
|
+
* <p>The timestamp for when the rule was last updated.</p>
|
|
7805
7975
|
* @public
|
|
7806
7976
|
*/
|
|
7807
|
-
|
|
7977
|
+
LastUpdatedTime: Date | undefined;
|
|
7978
|
+
}
|
|
7979
|
+
/**
|
|
7980
|
+
* @public
|
|
7981
|
+
*/
|
|
7982
|
+
export interface ListRulesResponse {
|
|
7808
7983
|
/**
|
|
7809
|
-
* <p>
|
|
7984
|
+
* <p>Summary information about a rule.</p>
|
|
7810
7985
|
* @public
|
|
7811
7986
|
*/
|
|
7812
|
-
|
|
7987
|
+
RuleSummaryList: RuleSummary[] | undefined;
|
|
7988
|
+
/**
|
|
7989
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7990
|
+
* @public
|
|
7991
|
+
*/
|
|
7992
|
+
NextToken?: string | undefined;
|
|
7813
7993
|
}
|
|
7814
7994
|
/**
|
|
7815
7995
|
* @public
|
|
7816
7996
|
*/
|
|
7817
|
-
export interface
|
|
7997
|
+
export interface ListSecurityKeysRequest {
|
|
7818
7998
|
/**
|
|
7819
|
-
* <p>
|
|
7999
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
7820
8000
|
* @public
|
|
7821
8001
|
*/
|
|
7822
|
-
|
|
8002
|
+
InstanceId: string | undefined;
|
|
7823
8003
|
/**
|
|
7824
|
-
* <p>
|
|
7825
|
-
*
|
|
7826
|
-
* <p>This is always returned as a null in the response.</p>
|
|
7827
|
-
* </important>
|
|
8004
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8005
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
7828
8006
|
* @public
|
|
7829
8007
|
*/
|
|
7830
8008
|
NextToken?: string | undefined;
|
|
8009
|
+
/**
|
|
8010
|
+
* <p>The maximum number of results to return per page.</p>
|
|
8011
|
+
* @public
|
|
8012
|
+
*/
|
|
8013
|
+
MaxResults?: number | undefined;
|
|
7831
8014
|
}
|
|
7832
8015
|
/**
|
|
8016
|
+
* <p>Configuration information of the security key.</p>
|
|
7833
8017
|
* @public
|
|
7834
8018
|
*/
|
|
7835
|
-
export interface
|
|
8019
|
+
export interface SecurityKey {
|
|
7836
8020
|
/**
|
|
7837
|
-
* <p>The identifier
|
|
8021
|
+
* <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
|
|
7838
8022
|
* @public
|
|
7839
8023
|
*/
|
|
7840
|
-
|
|
8024
|
+
AssociationId?: string | undefined;
|
|
8025
|
+
/**
|
|
8026
|
+
* <p>The key of the security key.</p>
|
|
8027
|
+
* @public
|
|
8028
|
+
*/
|
|
8029
|
+
Key?: string | undefined;
|
|
8030
|
+
/**
|
|
8031
|
+
* <p>When the security key was created.</p>
|
|
8032
|
+
* @public
|
|
8033
|
+
*/
|
|
8034
|
+
CreationTime?: Date | undefined;
|
|
8035
|
+
}
|
|
8036
|
+
/**
|
|
8037
|
+
* @public
|
|
8038
|
+
*/
|
|
8039
|
+
export interface ListSecurityKeysResponse {
|
|
8040
|
+
/**
|
|
8041
|
+
* <p>The security keys.</p>
|
|
8042
|
+
* @public
|
|
8043
|
+
*/
|
|
8044
|
+
SecurityKeys?: SecurityKey[] | undefined;
|
|
7841
8045
|
/**
|
|
7842
|
-
* <p>
|
|
8046
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7843
8047
|
* @public
|
|
7844
8048
|
*/
|
|
7845
|
-
|
|
8049
|
+
NextToken?: string | undefined;
|
|
8050
|
+
}
|
|
8051
|
+
/**
|
|
8052
|
+
* @public
|
|
8053
|
+
*/
|
|
8054
|
+
export interface ListSecurityProfileApplicationsRequest {
|
|
7846
8055
|
/**
|
|
7847
|
-
* <p>The identifier
|
|
8056
|
+
* <p>The identifier for the security profle.</p>
|
|
7848
8057
|
* @public
|
|
7849
8058
|
*/
|
|
7850
|
-
|
|
8059
|
+
SecurityProfileId: string | undefined;
|
|
7851
8060
|
/**
|
|
7852
|
-
* <p>
|
|
8061
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
7853
8062
|
* @public
|
|
7854
8063
|
*/
|
|
7855
|
-
|
|
8064
|
+
InstanceId: string | undefined;
|
|
7856
8065
|
/**
|
|
7857
8066
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7858
8067
|
* response in the next request to retrieve the next set of results.</p>
|
|
@@ -7866,80 +8075,96 @@ export interface ListTestCaseExecutionRecordsRequest {
|
|
|
7866
8075
|
MaxResults?: number | undefined;
|
|
7867
8076
|
}
|
|
7868
8077
|
/**
|
|
7869
|
-
* <p>Contains information about a test case execution record.</p>
|
|
7870
8078
|
* @public
|
|
7871
8079
|
*/
|
|
7872
|
-
export interface
|
|
8080
|
+
export interface ListSecurityProfileApplicationsResponse {
|
|
7873
8081
|
/**
|
|
7874
|
-
* <p>
|
|
8082
|
+
* <p>A list of the third-party application's metadata.</p>
|
|
7875
8083
|
* @public
|
|
7876
8084
|
*/
|
|
7877
|
-
|
|
8085
|
+
Applications?: Application[] | undefined;
|
|
7878
8086
|
/**
|
|
7879
|
-
* <p>
|
|
8087
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7880
8088
|
* @public
|
|
7881
8089
|
*/
|
|
7882
|
-
|
|
8090
|
+
NextToken?: string | undefined;
|
|
7883
8091
|
/**
|
|
7884
|
-
* <p>The timestamp when
|
|
8092
|
+
* <p>The timestamp when this resource was last modified.</p>
|
|
7885
8093
|
* @public
|
|
7886
8094
|
*/
|
|
7887
|
-
|
|
8095
|
+
LastModifiedTime?: Date | undefined;
|
|
7888
8096
|
/**
|
|
7889
|
-
* <p>The
|
|
8097
|
+
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
7890
8098
|
* @public
|
|
7891
8099
|
*/
|
|
7892
|
-
|
|
8100
|
+
LastModifiedRegion?: string | undefined;
|
|
7893
8101
|
}
|
|
7894
8102
|
/**
|
|
7895
8103
|
* @public
|
|
7896
8104
|
*/
|
|
7897
|
-
export interface
|
|
8105
|
+
export interface ListSecurityProfileFlowModulesRequest {
|
|
7898
8106
|
/**
|
|
7899
|
-
* <p>
|
|
8107
|
+
* <p> The identifier for the security profile. </p>
|
|
7900
8108
|
* @public
|
|
7901
8109
|
*/
|
|
7902
|
-
|
|
8110
|
+
SecurityProfileId: string | undefined;
|
|
7903
8111
|
/**
|
|
7904
|
-
* <p>
|
|
8112
|
+
* <p> The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
8113
|
+
* @public
|
|
8114
|
+
*/
|
|
8115
|
+
InstanceId: string | undefined;
|
|
8116
|
+
/**
|
|
8117
|
+
* <p> The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
8118
|
+
* retrieve the next set of results. </p>
|
|
7905
8119
|
* @public
|
|
7906
8120
|
*/
|
|
7907
8121
|
NextToken?: string | undefined;
|
|
8122
|
+
/**
|
|
8123
|
+
* <p> The maximum number of results to return per page. The default MaxResult size is 100. </p>
|
|
8124
|
+
* @public
|
|
8125
|
+
*/
|
|
8126
|
+
MaxResults?: number | undefined;
|
|
7908
8127
|
}
|
|
7909
8128
|
/**
|
|
7910
8129
|
* @public
|
|
7911
8130
|
*/
|
|
7912
|
-
export interface
|
|
8131
|
+
export interface ListSecurityProfileFlowModulesResponse {
|
|
7913
8132
|
/**
|
|
7914
|
-
* <p>
|
|
8133
|
+
* <p> A list of Flow Modules an AI Agent can invoke as a tool. </p>
|
|
7915
8134
|
* @public
|
|
7916
8135
|
*/
|
|
7917
|
-
|
|
8136
|
+
AllowedFlowModules?: FlowModule[] | undefined;
|
|
7918
8137
|
/**
|
|
7919
|
-
* <p>
|
|
8138
|
+
* <p> The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
8139
|
+
* retrieve the next set of results. </p>
|
|
7920
8140
|
* @public
|
|
7921
8141
|
*/
|
|
7922
|
-
|
|
8142
|
+
NextToken?: string | undefined;
|
|
7923
8143
|
/**
|
|
7924
|
-
* <p>
|
|
8144
|
+
* <p> The time the flow module was last modified. </p>
|
|
7925
8145
|
* @public
|
|
7926
8146
|
*/
|
|
7927
|
-
|
|
8147
|
+
LastModifiedTime?: Date | undefined;
|
|
7928
8148
|
/**
|
|
7929
|
-
* <p>
|
|
8149
|
+
* <p> The Region that flow module was last modified in. </p>
|
|
7930
8150
|
* @public
|
|
7931
8151
|
*/
|
|
7932
|
-
|
|
8152
|
+
LastModifiedRegion?: string | undefined;
|
|
8153
|
+
}
|
|
8154
|
+
/**
|
|
8155
|
+
* @public
|
|
8156
|
+
*/
|
|
8157
|
+
export interface ListSecurityProfilePermissionsRequest {
|
|
7933
8158
|
/**
|
|
7934
|
-
* <p>
|
|
8159
|
+
* <p>The identifier for the security profle.</p>
|
|
7935
8160
|
* @public
|
|
7936
8161
|
*/
|
|
7937
|
-
|
|
8162
|
+
SecurityProfileId: string | undefined;
|
|
7938
8163
|
/**
|
|
7939
|
-
* <p>
|
|
8164
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
7940
8165
|
* @public
|
|
7941
8166
|
*/
|
|
7942
|
-
|
|
8167
|
+
InstanceId: string | undefined;
|
|
7943
8168
|
/**
|
|
7944
8169
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7945
8170
|
* response in the next request to retrieve the next set of results.</p>
|
|
@@ -7953,62 +8178,37 @@ export interface ListTestCaseExecutionsRequest {
|
|
|
7953
8178
|
MaxResults?: number | undefined;
|
|
7954
8179
|
}
|
|
7955
8180
|
/**
|
|
7956
|
-
* <p>Contains information about a test case execution.</p>
|
|
7957
8181
|
* @public
|
|
7958
8182
|
*/
|
|
7959
|
-
export interface
|
|
7960
|
-
/**
|
|
7961
|
-
* <p>The timestamp when the test case execution started.</p>
|
|
7962
|
-
* @public
|
|
7963
|
-
*/
|
|
7964
|
-
StartTime?: Date | undefined;
|
|
7965
|
-
/**
|
|
7966
|
-
* <p>The timestamp when the test case execution ended.</p>
|
|
7967
|
-
* @public
|
|
7968
|
-
*/
|
|
7969
|
-
EndTime?: Date | undefined;
|
|
7970
|
-
/**
|
|
7971
|
-
* <p>The identifier of the test case execution.</p>
|
|
7972
|
-
* @public
|
|
7973
|
-
*/
|
|
7974
|
-
TestCaseExecutionId?: string | undefined;
|
|
7975
|
-
/**
|
|
7976
|
-
* <p>The identifier of the test case.</p>
|
|
7977
|
-
* @public
|
|
7978
|
-
*/
|
|
7979
|
-
TestCaseId?: string | undefined;
|
|
8183
|
+
export interface ListSecurityProfilePermissionsResponse {
|
|
7980
8184
|
/**
|
|
7981
|
-
* <p>The
|
|
8185
|
+
* <p>The permissions granted to the security profile. For a complete list of valid permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
|
|
8186
|
+
* permissions</a>.</p>
|
|
7982
8187
|
* @public
|
|
7983
8188
|
*/
|
|
7984
|
-
|
|
8189
|
+
Permissions?: string[] | undefined;
|
|
7985
8190
|
/**
|
|
7986
|
-
* <p>
|
|
8191
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7987
8192
|
* @public
|
|
7988
8193
|
*/
|
|
7989
|
-
|
|
7990
|
-
}
|
|
7991
|
-
/**
|
|
7992
|
-
* @public
|
|
7993
|
-
*/
|
|
7994
|
-
export interface ListTestCaseExecutionsResponse {
|
|
8194
|
+
NextToken?: string | undefined;
|
|
7995
8195
|
/**
|
|
7996
|
-
* <p>
|
|
8196
|
+
* <p>The timestamp when this resource was last modified.</p>
|
|
7997
8197
|
* @public
|
|
7998
8198
|
*/
|
|
7999
|
-
|
|
8199
|
+
LastModifiedTime?: Date | undefined;
|
|
8000
8200
|
/**
|
|
8001
|
-
* <p>
|
|
8201
|
+
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
8002
8202
|
* @public
|
|
8003
8203
|
*/
|
|
8004
|
-
|
|
8204
|
+
LastModifiedRegion?: string | undefined;
|
|
8005
8205
|
}
|
|
8006
8206
|
/**
|
|
8007
8207
|
* @public
|
|
8008
8208
|
*/
|
|
8009
|
-
export interface
|
|
8209
|
+
export interface ListSecurityProfilesRequest {
|
|
8010
8210
|
/**
|
|
8011
|
-
* <p>The identifier of the Amazon
|
|
8211
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
8012
8212
|
* @public
|
|
8013
8213
|
*/
|
|
8014
8214
|
InstanceId: string | undefined;
|
|
@@ -8019,43 +8219,38 @@ export interface ListTestCasesRequest {
|
|
|
8019
8219
|
*/
|
|
8020
8220
|
NextToken?: string | undefined;
|
|
8021
8221
|
/**
|
|
8022
|
-
* <p>The maximum number of results to return per page.</p>
|
|
8222
|
+
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
8023
8223
|
* @public
|
|
8024
8224
|
*/
|
|
8025
8225
|
MaxResults?: number | undefined;
|
|
8026
8226
|
}
|
|
8027
8227
|
/**
|
|
8028
|
-
* <p>Contains
|
|
8228
|
+
* <p>Contains information about a security profile.</p>
|
|
8029
8229
|
* @public
|
|
8030
8230
|
*/
|
|
8031
|
-
export interface
|
|
8231
|
+
export interface SecurityProfileSummary {
|
|
8032
8232
|
/**
|
|
8033
|
-
* <p>The identifier of the
|
|
8233
|
+
* <p>The identifier of the security profile.</p>
|
|
8034
8234
|
* @public
|
|
8035
8235
|
*/
|
|
8036
8236
|
Id?: string | undefined;
|
|
8037
8237
|
/**
|
|
8038
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
8238
|
+
* <p>The Amazon Resource Name (ARN) of the security profile.</p>
|
|
8039
8239
|
* @public
|
|
8040
8240
|
*/
|
|
8041
8241
|
Arn?: string | undefined;
|
|
8042
8242
|
/**
|
|
8043
|
-
* <p>The name of the
|
|
8243
|
+
* <p>The name of the security profile.</p>
|
|
8044
8244
|
* @public
|
|
8045
8245
|
*/
|
|
8046
8246
|
Name?: string | undefined;
|
|
8047
8247
|
/**
|
|
8048
|
-
* <p>The
|
|
8049
|
-
* @public
|
|
8050
|
-
*/
|
|
8051
|
-
Status?: TestCaseStatus | undefined;
|
|
8052
|
-
/**
|
|
8053
|
-
* <p>The time at which the test case was last modified.</p>
|
|
8248
|
+
* <p>The timestamp when this resource was last modified.</p>
|
|
8054
8249
|
* @public
|
|
8055
8250
|
*/
|
|
8056
8251
|
LastModifiedTime?: Date | undefined;
|
|
8057
8252
|
/**
|
|
8058
|
-
* <p>The
|
|
8253
|
+
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
8059
8254
|
* @public
|
|
8060
8255
|
*/
|
|
8061
8256
|
LastModifiedRegion?: string | undefined;
|
|
@@ -8063,12 +8258,12 @@ export interface TestCaseSummary {
|
|
|
8063
8258
|
/**
|
|
8064
8259
|
* @public
|
|
8065
8260
|
*/
|
|
8066
|
-
export interface
|
|
8261
|
+
export interface ListSecurityProfilesResponse {
|
|
8067
8262
|
/**
|
|
8068
|
-
* <p>Information about the
|
|
8263
|
+
* <p>Information about the security profiles.</p>
|
|
8069
8264
|
* @public
|
|
8070
8265
|
*/
|
|
8071
|
-
|
|
8266
|
+
SecurityProfileSummaryList?: SecurityProfileSummary[] | undefined;
|
|
8072
8267
|
/**
|
|
8073
8268
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8074
8269
|
* @public
|
|
@@ -8078,176 +8273,148 @@ export interface ListTestCasesResponse {
|
|
|
8078
8273
|
/**
|
|
8079
8274
|
* @public
|
|
8080
8275
|
*/
|
|
8081
|
-
export interface
|
|
8082
|
-
/**
|
|
8083
|
-
* <p>The maximum number of results to return per page.</p>
|
|
8084
|
-
* @public
|
|
8085
|
-
*/
|
|
8086
|
-
MaxResults?: number | undefined;
|
|
8087
|
-
/**
|
|
8088
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8089
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8090
|
-
* @public
|
|
8091
|
-
*/
|
|
8092
|
-
NextToken?: string | undefined;
|
|
8276
|
+
export interface ListTagsForResourceRequest {
|
|
8093
8277
|
/**
|
|
8094
|
-
* <p>The
|
|
8278
|
+
* <p>The Amazon Resource Name (ARN) of the resource. All Connect Customer resources (instances, queues, flows, routing profiles, etc) have
|
|
8279
|
+
* an ARN. To locate the ARN for an instance, for example, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">Find your Connect Customer instance ID/ARN</a>. </p>
|
|
8095
8280
|
* @public
|
|
8096
8281
|
*/
|
|
8097
|
-
|
|
8282
|
+
resourceArn: string | undefined;
|
|
8098
8283
|
}
|
|
8099
8284
|
/**
|
|
8100
|
-
* <p>Information about traffic distribution groups.</p>
|
|
8101
8285
|
* @public
|
|
8102
8286
|
*/
|
|
8103
|
-
export interface
|
|
8287
|
+
export interface ListTagsForResourceResponse {
|
|
8104
8288
|
/**
|
|
8105
|
-
* <p>
|
|
8106
|
-
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
8107
|
-
* The ARN must be provided if the call is from the replicated Region.</p>
|
|
8289
|
+
* <p>Information about the tags.</p>
|
|
8108
8290
|
* @public
|
|
8109
8291
|
*/
|
|
8110
|
-
|
|
8292
|
+
tags?: Record<string, string> | undefined;
|
|
8293
|
+
}
|
|
8294
|
+
/**
|
|
8295
|
+
* @public
|
|
8296
|
+
*/
|
|
8297
|
+
export interface ListTaskTemplatesRequest {
|
|
8111
8298
|
/**
|
|
8112
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
8299
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
8113
8300
|
* @public
|
|
8114
8301
|
*/
|
|
8115
|
-
|
|
8302
|
+
InstanceId: string | undefined;
|
|
8116
8303
|
/**
|
|
8117
|
-
* <p>The
|
|
8304
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8305
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
8306
|
+
* <important>
|
|
8307
|
+
* <p>It is not expected that you set this because the value returned in the previous response is always null.</p>
|
|
8308
|
+
* </important>
|
|
8118
8309
|
* @public
|
|
8119
8310
|
*/
|
|
8120
|
-
|
|
8311
|
+
NextToken?: string | undefined;
|
|
8121
8312
|
/**
|
|
8122
|
-
* <p>The
|
|
8313
|
+
* <p>The maximum number of results to return per page.</p>
|
|
8314
|
+
* <important>
|
|
8315
|
+
* <p>It is not expected that you set this.</p>
|
|
8316
|
+
* </important>
|
|
8123
8317
|
* @public
|
|
8124
8318
|
*/
|
|
8125
|
-
|
|
8319
|
+
MaxResults?: number | undefined;
|
|
8126
8320
|
/**
|
|
8127
|
-
* <p>
|
|
8128
|
-
*
|
|
8129
|
-
*
|
|
8130
|
-
* <p>
|
|
8131
|
-
* <code>CREATION_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a>
|
|
8132
|
-
* operation is still in progress and has not yet completed.</p>
|
|
8133
|
-
* </li>
|
|
8134
|
-
* <li>
|
|
8135
|
-
* <p>
|
|
8136
|
-
* <code>ACTIVE</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a>
|
|
8137
|
-
* operation has succeeded.</p>
|
|
8138
|
-
* </li>
|
|
8139
|
-
* <li>
|
|
8140
|
-
* <p>
|
|
8141
|
-
* <code>CREATION_FAILED</code> indicates that the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a>
|
|
8142
|
-
* operation has failed.</p>
|
|
8143
|
-
* </li>
|
|
8144
|
-
* <li>
|
|
8145
|
-
* <p>
|
|
8146
|
-
* <code>PENDING_DELETION</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html">DeleteTrafficDistributionGroup</a>
|
|
8147
|
-
* operation is still in progress and has not yet completed.</p>
|
|
8148
|
-
* </li>
|
|
8149
|
-
* <li>
|
|
8150
|
-
* <p>
|
|
8151
|
-
* <code>DELETION_FAILED</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html">DeleteTrafficDistributionGroup</a>
|
|
8152
|
-
* operation has failed.</p>
|
|
8153
|
-
* </li>
|
|
8154
|
-
* <li>
|
|
8155
|
-
* <p>
|
|
8156
|
-
* <code>UPDATE_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html">UpdateTrafficDistributionGroup</a>
|
|
8157
|
-
* operation is still in progress and has not yet completed.</p>
|
|
8158
|
-
* </li>
|
|
8159
|
-
* </ul>
|
|
8321
|
+
* <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
|
|
8322
|
+
* Tasks can only be created from <code>ACTIVE</code> templates.
|
|
8323
|
+
* If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
|
|
8160
8324
|
* @public
|
|
8161
8325
|
*/
|
|
8162
|
-
Status?:
|
|
8326
|
+
Status?: TaskTemplateStatus | undefined;
|
|
8163
8327
|
/**
|
|
8164
|
-
* <p>
|
|
8165
|
-
* replication. The default traffic distribution group cannot be deleted by the
|
|
8166
|
-
* <code>DeleteTrafficDistributionGroup</code> API. The default traffic distribution group is deleted as
|
|
8167
|
-
* part of the process for deleting a replica.</p>
|
|
8328
|
+
* <p>The name of the task template.</p>
|
|
8168
8329
|
* @public
|
|
8169
8330
|
*/
|
|
8170
|
-
|
|
8331
|
+
Name?: string | undefined;
|
|
8171
8332
|
}
|
|
8172
8333
|
/**
|
|
8334
|
+
* <p>Contains summary information about the task template.</p>
|
|
8173
8335
|
* @public
|
|
8174
8336
|
*/
|
|
8175
|
-
export interface
|
|
8337
|
+
export interface TaskTemplateMetadata {
|
|
8176
8338
|
/**
|
|
8177
|
-
* <p>
|
|
8339
|
+
* <p>A unique identifier for the task template.</p>
|
|
8178
8340
|
* @public
|
|
8179
8341
|
*/
|
|
8180
|
-
|
|
8342
|
+
Id?: string | undefined;
|
|
8181
8343
|
/**
|
|
8182
|
-
* <p>
|
|
8344
|
+
* <p>The Amazon Resource Name (ARN) of the task template.</p>
|
|
8183
8345
|
* @public
|
|
8184
8346
|
*/
|
|
8185
|
-
|
|
8186
|
-
}
|
|
8187
|
-
/**
|
|
8188
|
-
* @public
|
|
8189
|
-
*/
|
|
8190
|
-
export interface ListTrafficDistributionGroupUsersRequest {
|
|
8347
|
+
Arn?: string | undefined;
|
|
8191
8348
|
/**
|
|
8192
|
-
* <p>The
|
|
8193
|
-
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
8194
|
-
* The ARN must be provided if the call is from the replicated Region.</p>
|
|
8349
|
+
* <p>The name of the task template.</p>
|
|
8195
8350
|
* @public
|
|
8196
8351
|
*/
|
|
8197
|
-
|
|
8352
|
+
Name?: string | undefined;
|
|
8198
8353
|
/**
|
|
8199
|
-
* <p>The
|
|
8354
|
+
* <p>The description of the task template.</p>
|
|
8200
8355
|
* @public
|
|
8201
8356
|
*/
|
|
8202
|
-
|
|
8357
|
+
Description?: string | undefined;
|
|
8203
8358
|
/**
|
|
8204
|
-
* <p>
|
|
8205
|
-
*
|
|
8359
|
+
* <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
|
|
8360
|
+
* Tasks can only be created from <code>ACTIVE</code> templates.
|
|
8361
|
+
* If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
|
|
8206
8362
|
* @public
|
|
8207
8363
|
*/
|
|
8208
|
-
|
|
8209
|
-
}
|
|
8210
|
-
/**
|
|
8211
|
-
* <p>Summary information about a traffic distribution group user.</p>
|
|
8212
|
-
* @public
|
|
8213
|
-
*/
|
|
8214
|
-
export interface TrafficDistributionGroupUserSummary {
|
|
8364
|
+
Status?: TaskTemplateStatus | undefined;
|
|
8215
8365
|
/**
|
|
8216
|
-
* <p>The
|
|
8366
|
+
* <p>The timestamp when the task template was last modified.</p>
|
|
8217
8367
|
* @public
|
|
8218
8368
|
*/
|
|
8219
|
-
|
|
8369
|
+
LastModifiedTime?: Date | undefined;
|
|
8370
|
+
/**
|
|
8371
|
+
* <p>The timestamp when the task template was created.</p>
|
|
8372
|
+
* @public
|
|
8373
|
+
*/
|
|
8374
|
+
CreatedTime?: Date | undefined;
|
|
8220
8375
|
}
|
|
8221
8376
|
/**
|
|
8222
8377
|
* @public
|
|
8223
8378
|
*/
|
|
8224
|
-
export interface
|
|
8379
|
+
export interface ListTaskTemplatesResponse {
|
|
8225
8380
|
/**
|
|
8226
|
-
* <p>
|
|
8381
|
+
* <p>Provides details about a list of task templates belonging to an instance.</p>
|
|
8227
8382
|
* @public
|
|
8228
8383
|
*/
|
|
8229
|
-
|
|
8384
|
+
TaskTemplates?: TaskTemplateMetadata[] | undefined;
|
|
8230
8385
|
/**
|
|
8231
|
-
* <p>
|
|
8386
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8387
|
+
* <important>
|
|
8388
|
+
* <p>This is always returned as a null in the response.</p>
|
|
8389
|
+
* </important>
|
|
8232
8390
|
* @public
|
|
8233
8391
|
*/
|
|
8234
|
-
|
|
8392
|
+
NextToken?: string | undefined;
|
|
8235
8393
|
}
|
|
8236
8394
|
/**
|
|
8237
|
-
* <p>Provides summary information about the use cases for the specified integration association.</p>
|
|
8238
8395
|
* @public
|
|
8239
8396
|
*/
|
|
8240
|
-
export interface
|
|
8397
|
+
export interface ListTestCaseExecutionRecordsRequest {
|
|
8241
8398
|
/**
|
|
8242
|
-
* <p>The identifier of the
|
|
8399
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
8243
8400
|
* @public
|
|
8244
8401
|
*/
|
|
8245
8402
|
InstanceId: string | undefined;
|
|
8246
8403
|
/**
|
|
8247
|
-
* <p>The identifier
|
|
8404
|
+
* <p>The identifier of the test case.</p>
|
|
8248
8405
|
* @public
|
|
8249
8406
|
*/
|
|
8250
|
-
|
|
8407
|
+
TestCaseId: string | undefined;
|
|
8408
|
+
/**
|
|
8409
|
+
* <p>The identifier of the test case execution.</p>
|
|
8410
|
+
* @public
|
|
8411
|
+
*/
|
|
8412
|
+
TestCaseExecutionId: string | undefined;
|
|
8413
|
+
/**
|
|
8414
|
+
* <p>Filter execution records by status.</p>
|
|
8415
|
+
* @public
|
|
8416
|
+
*/
|
|
8417
|
+
Status?: TestCaseExecutionStatus | undefined;
|
|
8251
8418
|
/**
|
|
8252
8419
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8253
8420
|
* response in the next request to retrieve the next set of results.</p>
|
|
@@ -8261,38 +8428,40 @@ export interface ListUseCasesRequest {
|
|
|
8261
8428
|
MaxResults?: number | undefined;
|
|
8262
8429
|
}
|
|
8263
8430
|
/**
|
|
8264
|
-
* <p>Contains
|
|
8265
|
-
* use
|
|
8266
|
-
* case.</p>
|
|
8431
|
+
* <p>Contains information about a test case execution record.</p>
|
|
8267
8432
|
* @public
|
|
8268
8433
|
*/
|
|
8269
|
-
export interface
|
|
8434
|
+
export interface ExecutionRecord {
|
|
8270
8435
|
/**
|
|
8271
|
-
* <p>The identifier
|
|
8436
|
+
* <p>The identifier of the execution record.</p>
|
|
8272
8437
|
* @public
|
|
8273
8438
|
*/
|
|
8274
|
-
|
|
8439
|
+
ObservationId?: string | undefined;
|
|
8275
8440
|
/**
|
|
8276
|
-
* <p>The
|
|
8441
|
+
* <p>The status of the action execution.</p>
|
|
8277
8442
|
* @public
|
|
8278
8443
|
*/
|
|
8279
|
-
|
|
8444
|
+
Status?: ExecutionRecordStatus | undefined;
|
|
8280
8445
|
/**
|
|
8281
|
-
* <p>The
|
|
8282
|
-
* of each use case type.</p>
|
|
8446
|
+
* <p>The timestamp when the action was executed.</p>
|
|
8283
8447
|
* @public
|
|
8284
8448
|
*/
|
|
8285
|
-
|
|
8449
|
+
Timestamp?: Date | undefined;
|
|
8450
|
+
/**
|
|
8451
|
+
* <p>The details of the executed record.</p>
|
|
8452
|
+
* @public
|
|
8453
|
+
*/
|
|
8454
|
+
Record?: string | undefined;
|
|
8286
8455
|
}
|
|
8287
8456
|
/**
|
|
8288
8457
|
* @public
|
|
8289
8458
|
*/
|
|
8290
|
-
export interface
|
|
8459
|
+
export interface ListTestCaseExecutionRecordsResponse {
|
|
8291
8460
|
/**
|
|
8292
|
-
* <p>
|
|
8461
|
+
* <p>An array of test case execution record objects.</p>
|
|
8293
8462
|
* @public
|
|
8294
8463
|
*/
|
|
8295
|
-
|
|
8464
|
+
ExecutionRecords?: ExecutionRecord[] | undefined;
|
|
8296
8465
|
/**
|
|
8297
8466
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8298
8467
|
* @public
|
|
@@ -8302,191 +8471,181 @@ export interface ListUseCasesResponse {
|
|
|
8302
8471
|
/**
|
|
8303
8472
|
* @public
|
|
8304
8473
|
*/
|
|
8305
|
-
export interface
|
|
8474
|
+
export interface ListTestCaseExecutionsRequest {
|
|
8306
8475
|
/**
|
|
8307
|
-
* <p>The identifier of the
|
|
8476
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
8308
8477
|
* @public
|
|
8309
8478
|
*/
|
|
8310
8479
|
InstanceId: string | undefined;
|
|
8311
8480
|
/**
|
|
8312
|
-
* <p>
|
|
8313
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8481
|
+
* <p>Filter executions by test case identifier.</p>
|
|
8314
8482
|
* @public
|
|
8315
8483
|
*/
|
|
8316
|
-
|
|
8484
|
+
TestCaseId?: string | undefined;
|
|
8317
8485
|
/**
|
|
8318
|
-
* <p>
|
|
8486
|
+
* <p>Filter executions by test case name.</p>
|
|
8319
8487
|
* @public
|
|
8320
8488
|
*/
|
|
8321
|
-
|
|
8322
|
-
}
|
|
8323
|
-
/**
|
|
8324
|
-
* @public
|
|
8325
|
-
*/
|
|
8326
|
-
export interface ListUserHierarchyGroupsResponse {
|
|
8489
|
+
TestCaseName?: string | undefined;
|
|
8327
8490
|
/**
|
|
8328
|
-
* <p>
|
|
8491
|
+
* <p>Filter executions that started after this time.</p>
|
|
8329
8492
|
* @public
|
|
8330
8493
|
*/
|
|
8331
|
-
|
|
8494
|
+
StartTime?: number | undefined;
|
|
8332
8495
|
/**
|
|
8333
|
-
* <p>
|
|
8496
|
+
* <p>Filter executions that started before this time.</p>
|
|
8334
8497
|
* @public
|
|
8335
8498
|
*/
|
|
8336
|
-
|
|
8337
|
-
}
|
|
8338
|
-
/**
|
|
8339
|
-
* @public
|
|
8340
|
-
*/
|
|
8341
|
-
export interface ListUserNotificationsRequest {
|
|
8499
|
+
EndTime?: number | undefined;
|
|
8342
8500
|
/**
|
|
8343
|
-
* <p>
|
|
8501
|
+
* <p>Filter executions by status.</p>
|
|
8344
8502
|
* @public
|
|
8345
8503
|
*/
|
|
8346
|
-
|
|
8504
|
+
Status?: TestCaseExecutionStatus | undefined;
|
|
8347
8505
|
/**
|
|
8348
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8506
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8507
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
8349
8508
|
* @public
|
|
8350
8509
|
*/
|
|
8351
8510
|
NextToken?: string | undefined;
|
|
8352
8511
|
/**
|
|
8353
|
-
* <p>The maximum number of results to return per page
|
|
8512
|
+
* <p>The maximum number of results to return per page.</p>
|
|
8354
8513
|
* @public
|
|
8355
8514
|
*/
|
|
8356
8515
|
MaxResults?: number | undefined;
|
|
8357
|
-
/**
|
|
8358
|
-
* <p>The identifier of the user.</p>
|
|
8359
|
-
* @public
|
|
8360
|
-
*/
|
|
8361
|
-
UserId: string | undefined;
|
|
8362
8516
|
}
|
|
8363
8517
|
/**
|
|
8364
|
-
* <p>
|
|
8518
|
+
* <p>Contains information about a test case execution.</p>
|
|
8365
8519
|
* @public
|
|
8366
8520
|
*/
|
|
8367
|
-
export interface
|
|
8368
|
-
/**
|
|
8369
|
-
* <p>The unique identifier for the notification.</p>
|
|
8370
|
-
* @public
|
|
8371
|
-
*/
|
|
8372
|
-
NotificationId?: string | undefined;
|
|
8521
|
+
export interface TestCaseExecution {
|
|
8373
8522
|
/**
|
|
8374
|
-
* <p>The
|
|
8523
|
+
* <p>The timestamp when the test case execution started.</p>
|
|
8375
8524
|
* @public
|
|
8376
8525
|
*/
|
|
8377
|
-
|
|
8526
|
+
StartTime?: Date | undefined;
|
|
8378
8527
|
/**
|
|
8379
|
-
* <p>The
|
|
8528
|
+
* <p>The timestamp when the test case execution ended.</p>
|
|
8380
8529
|
* @public
|
|
8381
8530
|
*/
|
|
8382
|
-
|
|
8531
|
+
EndTime?: Date | undefined;
|
|
8383
8532
|
/**
|
|
8384
|
-
* <p>The identifier of the
|
|
8533
|
+
* <p>The identifier of the test case execution.</p>
|
|
8385
8534
|
* @public
|
|
8386
8535
|
*/
|
|
8387
|
-
|
|
8536
|
+
TestCaseExecutionId?: string | undefined;
|
|
8388
8537
|
/**
|
|
8389
|
-
* <p>The
|
|
8538
|
+
* <p>The identifier of the test case.</p>
|
|
8390
8539
|
* @public
|
|
8391
8540
|
*/
|
|
8392
|
-
|
|
8541
|
+
TestCaseId?: string | undefined;
|
|
8393
8542
|
/**
|
|
8394
|
-
* <p>The
|
|
8543
|
+
* <p>The status of the test case execution.</p>
|
|
8395
8544
|
* @public
|
|
8396
8545
|
*/
|
|
8397
|
-
|
|
8546
|
+
TestCaseExecutionStatus?: TestCaseExecutionStatus | undefined;
|
|
8398
8547
|
/**
|
|
8399
|
-
* <p>The
|
|
8548
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
8400
8549
|
* @public
|
|
8401
8550
|
*/
|
|
8402
|
-
|
|
8551
|
+
Tags?: Record<string, string> | undefined;
|
|
8552
|
+
}
|
|
8553
|
+
/**
|
|
8554
|
+
* @public
|
|
8555
|
+
*/
|
|
8556
|
+
export interface ListTestCaseExecutionsResponse {
|
|
8403
8557
|
/**
|
|
8404
|
-
* <p>
|
|
8558
|
+
* <p>An array of test case execution summary objects.</p>
|
|
8405
8559
|
* @public
|
|
8406
8560
|
*/
|
|
8407
|
-
|
|
8561
|
+
TestCaseExecutions?: TestCaseExecution[] | undefined;
|
|
8408
8562
|
/**
|
|
8409
|
-
* <p>
|
|
8563
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8410
8564
|
* @public
|
|
8411
8565
|
*/
|
|
8412
|
-
|
|
8566
|
+
NextToken?: string | undefined;
|
|
8413
8567
|
}
|
|
8414
8568
|
/**
|
|
8415
8569
|
* @public
|
|
8416
8570
|
*/
|
|
8417
|
-
export interface
|
|
8571
|
+
export interface ListTestCasesRequest {
|
|
8418
8572
|
/**
|
|
8419
|
-
* <p>
|
|
8573
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
8420
8574
|
* @public
|
|
8421
8575
|
*/
|
|
8422
|
-
|
|
8576
|
+
InstanceId: string | undefined;
|
|
8423
8577
|
/**
|
|
8424
|
-
* <p>The token for the next set of results.
|
|
8578
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8579
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
8425
8580
|
* @public
|
|
8426
8581
|
*/
|
|
8427
8582
|
NextToken?: string | undefined;
|
|
8583
|
+
/**
|
|
8584
|
+
* <p>The maximum number of results to return per page.</p>
|
|
8585
|
+
* @public
|
|
8586
|
+
*/
|
|
8587
|
+
MaxResults?: number | undefined;
|
|
8428
8588
|
}
|
|
8429
8589
|
/**
|
|
8590
|
+
* <p>Contains summary information about a test case.</p>
|
|
8430
8591
|
* @public
|
|
8431
8592
|
*/
|
|
8432
|
-
export interface
|
|
8593
|
+
export interface TestCaseSummary {
|
|
8433
8594
|
/**
|
|
8434
|
-
* <p>The identifier of the
|
|
8435
|
-
* instance.</p>
|
|
8595
|
+
* <p>The identifier of the test case.</p>
|
|
8436
8596
|
* @public
|
|
8437
8597
|
*/
|
|
8438
|
-
|
|
8598
|
+
Id?: string | undefined;
|
|
8439
8599
|
/**
|
|
8440
|
-
* <p>The
|
|
8600
|
+
* <p>The Amazon Resource Name (ARN) of the test case.</p>
|
|
8441
8601
|
* @public
|
|
8442
8602
|
*/
|
|
8443
|
-
|
|
8603
|
+
Arn?: string | undefined;
|
|
8444
8604
|
/**
|
|
8445
|
-
* <p>The
|
|
8446
|
-
* retrieve the next set of results.</p>
|
|
8605
|
+
* <p>The name of the test case.</p>
|
|
8447
8606
|
* @public
|
|
8448
8607
|
*/
|
|
8449
|
-
|
|
8608
|
+
Name?: string | undefined;
|
|
8450
8609
|
/**
|
|
8451
|
-
* <p>The
|
|
8610
|
+
* <p>The status of the test case.</p>
|
|
8452
8611
|
* @public
|
|
8453
8612
|
*/
|
|
8454
|
-
|
|
8455
|
-
}
|
|
8456
|
-
/**
|
|
8457
|
-
* @public
|
|
8458
|
-
*/
|
|
8459
|
-
export interface ListUserProficienciesResponse {
|
|
8613
|
+
Status?: TestCaseStatus | undefined;
|
|
8460
8614
|
/**
|
|
8461
|
-
* <p>
|
|
8615
|
+
* <p>The time at which the test case was last modified.</p>
|
|
8462
8616
|
* @public
|
|
8463
8617
|
*/
|
|
8464
|
-
|
|
8618
|
+
LastModifiedTime?: Date | undefined;
|
|
8465
8619
|
/**
|
|
8466
|
-
* <p>
|
|
8620
|
+
* <p>The region in which the test case was last modified.</p>
|
|
8467
8621
|
* @public
|
|
8468
8622
|
*/
|
|
8469
|
-
|
|
8623
|
+
LastModifiedRegion?: string | undefined;
|
|
8624
|
+
}
|
|
8625
|
+
/**
|
|
8626
|
+
* @public
|
|
8627
|
+
*/
|
|
8628
|
+
export interface ListTestCasesResponse {
|
|
8470
8629
|
/**
|
|
8471
|
-
* <p>
|
|
8630
|
+
* <p>Information about the tests.</p>
|
|
8472
8631
|
* @public
|
|
8473
8632
|
*/
|
|
8474
|
-
|
|
8633
|
+
TestCaseSummaryList?: TestCaseSummary[] | undefined;
|
|
8475
8634
|
/**
|
|
8476
|
-
* <p>
|
|
8635
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8477
8636
|
* @public
|
|
8478
8637
|
*/
|
|
8479
|
-
|
|
8638
|
+
NextToken?: string | undefined;
|
|
8480
8639
|
}
|
|
8481
8640
|
/**
|
|
8482
8641
|
* @public
|
|
8483
8642
|
*/
|
|
8484
|
-
export interface
|
|
8643
|
+
export interface ListTrafficDistributionGroupsRequest {
|
|
8485
8644
|
/**
|
|
8486
|
-
* <p>The
|
|
8645
|
+
* <p>The maximum number of results to return per page.</p>
|
|
8487
8646
|
* @public
|
|
8488
8647
|
*/
|
|
8489
|
-
|
|
8648
|
+
MaxResults?: number | undefined;
|
|
8490
8649
|
/**
|
|
8491
8650
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8492
8651
|
* response in the next request to retrieve the next set of results.</p>
|
|
@@ -8494,155 +8653,226 @@ export interface ListUsersRequest {
|
|
|
8494
8653
|
*/
|
|
8495
8654
|
NextToken?: string | undefined;
|
|
8496
8655
|
/**
|
|
8497
|
-
* <p>The
|
|
8656
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
8498
8657
|
* @public
|
|
8499
8658
|
*/
|
|
8500
|
-
|
|
8659
|
+
InstanceId?: string | undefined;
|
|
8501
8660
|
}
|
|
8502
8661
|
/**
|
|
8503
|
-
* <p>
|
|
8662
|
+
* <p>Information about traffic distribution groups.</p>
|
|
8504
8663
|
* @public
|
|
8505
8664
|
*/
|
|
8506
|
-
export interface
|
|
8665
|
+
export interface TrafficDistributionGroupSummary {
|
|
8507
8666
|
/**
|
|
8508
|
-
* <p>The identifier of the
|
|
8667
|
+
* <p>The identifier of the traffic distribution group.
|
|
8668
|
+
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
8669
|
+
* The ARN must be provided if the call is from the replicated Region.</p>
|
|
8509
8670
|
* @public
|
|
8510
8671
|
*/
|
|
8511
8672
|
Id?: string | undefined;
|
|
8512
8673
|
/**
|
|
8513
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
8674
|
+
* <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
|
|
8514
8675
|
* @public
|
|
8515
8676
|
*/
|
|
8516
8677
|
Arn?: string | undefined;
|
|
8517
8678
|
/**
|
|
8518
|
-
* <p>The
|
|
8679
|
+
* <p>The name of the traffic distribution group.</p>
|
|
8519
8680
|
* @public
|
|
8520
8681
|
*/
|
|
8521
|
-
|
|
8682
|
+
Name?: string | undefined;
|
|
8522
8683
|
/**
|
|
8523
|
-
* <p>The
|
|
8684
|
+
* <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
|
|
8524
8685
|
* @public
|
|
8525
8686
|
*/
|
|
8526
|
-
|
|
8687
|
+
InstanceArn?: string | undefined;
|
|
8527
8688
|
/**
|
|
8528
|
-
* <p>The
|
|
8689
|
+
* <p>The status of the traffic distribution group. </p>
|
|
8690
|
+
* <ul>
|
|
8691
|
+
* <li>
|
|
8692
|
+
* <p>
|
|
8693
|
+
* <code>CREATION_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a>
|
|
8694
|
+
* operation is still in progress and has not yet completed.</p>
|
|
8695
|
+
* </li>
|
|
8696
|
+
* <li>
|
|
8697
|
+
* <p>
|
|
8698
|
+
* <code>ACTIVE</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a>
|
|
8699
|
+
* operation has succeeded.</p>
|
|
8700
|
+
* </li>
|
|
8701
|
+
* <li>
|
|
8702
|
+
* <p>
|
|
8703
|
+
* <code>CREATION_FAILED</code> indicates that the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a>
|
|
8704
|
+
* operation has failed.</p>
|
|
8705
|
+
* </li>
|
|
8706
|
+
* <li>
|
|
8707
|
+
* <p>
|
|
8708
|
+
* <code>PENDING_DELETION</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html">DeleteTrafficDistributionGroup</a>
|
|
8709
|
+
* operation is still in progress and has not yet completed.</p>
|
|
8710
|
+
* </li>
|
|
8711
|
+
* <li>
|
|
8712
|
+
* <p>
|
|
8713
|
+
* <code>DELETION_FAILED</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html">DeleteTrafficDistributionGroup</a>
|
|
8714
|
+
* operation has failed.</p>
|
|
8715
|
+
* </li>
|
|
8716
|
+
* <li>
|
|
8717
|
+
* <p>
|
|
8718
|
+
* <code>UPDATE_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html">UpdateTrafficDistributionGroup</a>
|
|
8719
|
+
* operation is still in progress and has not yet completed.</p>
|
|
8720
|
+
* </li>
|
|
8721
|
+
* </ul>
|
|
8529
8722
|
* @public
|
|
8530
8723
|
*/
|
|
8531
|
-
|
|
8724
|
+
Status?: TrafficDistributionGroupStatus | undefined;
|
|
8725
|
+
/**
|
|
8726
|
+
* <p>Whether this is the default traffic distribution group created during instance
|
|
8727
|
+
* replication. The default traffic distribution group cannot be deleted by the
|
|
8728
|
+
* <code>DeleteTrafficDistributionGroup</code> API. The default traffic distribution group is deleted as
|
|
8729
|
+
* part of the process for deleting a replica.</p>
|
|
8730
|
+
* @public
|
|
8731
|
+
*/
|
|
8732
|
+
IsDefault?: boolean | undefined;
|
|
8532
8733
|
}
|
|
8533
8734
|
/**
|
|
8534
8735
|
* @public
|
|
8535
8736
|
*/
|
|
8536
|
-
export interface
|
|
8737
|
+
export interface ListTrafficDistributionGroupsResponse {
|
|
8537
8738
|
/**
|
|
8538
|
-
* <p>
|
|
8739
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8539
8740
|
* @public
|
|
8540
8741
|
*/
|
|
8541
|
-
|
|
8742
|
+
NextToken?: string | undefined;
|
|
8542
8743
|
/**
|
|
8543
|
-
* <p>
|
|
8744
|
+
* <p>A list of traffic distribution groups.</p>
|
|
8544
8745
|
* @public
|
|
8545
8746
|
*/
|
|
8546
|
-
|
|
8747
|
+
TrafficDistributionGroupSummaryList?: TrafficDistributionGroupSummary[] | undefined;
|
|
8547
8748
|
}
|
|
8548
8749
|
/**
|
|
8549
8750
|
* @public
|
|
8550
8751
|
*/
|
|
8551
|
-
export interface
|
|
8752
|
+
export interface ListTrafficDistributionGroupUsersRequest {
|
|
8552
8753
|
/**
|
|
8553
|
-
* <p>The identifier of the
|
|
8554
|
-
*
|
|
8754
|
+
* <p>The identifier of the traffic distribution group.
|
|
8755
|
+
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
8756
|
+
* The ARN must be provided if the call is from the replicated Region.</p>
|
|
8555
8757
|
* @public
|
|
8556
8758
|
*/
|
|
8557
|
-
|
|
8759
|
+
TrafficDistributionGroupId: string | undefined;
|
|
8558
8760
|
/**
|
|
8559
|
-
* <p>The
|
|
8761
|
+
* <p>The maximum number of results to return per page.</p>
|
|
8560
8762
|
* @public
|
|
8561
8763
|
*/
|
|
8562
|
-
|
|
8764
|
+
MaxResults?: number | undefined;
|
|
8563
8765
|
/**
|
|
8564
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8565
|
-
*
|
|
8766
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8767
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
8566
8768
|
* @public
|
|
8567
8769
|
*/
|
|
8568
8770
|
NextToken?: string | undefined;
|
|
8771
|
+
}
|
|
8772
|
+
/**
|
|
8773
|
+
* <p>Summary information about a traffic distribution group user.</p>
|
|
8774
|
+
* @public
|
|
8775
|
+
*/
|
|
8776
|
+
export interface TrafficDistributionGroupUserSummary {
|
|
8569
8777
|
/**
|
|
8570
|
-
* <p>The
|
|
8778
|
+
* <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
|
|
8571
8779
|
* @public
|
|
8572
8780
|
*/
|
|
8573
|
-
|
|
8781
|
+
UserId?: string | undefined;
|
|
8574
8782
|
}
|
|
8575
8783
|
/**
|
|
8576
|
-
* <p>A summary of a view's metadata.</p>
|
|
8577
8784
|
* @public
|
|
8578
8785
|
*/
|
|
8579
|
-
export interface
|
|
8786
|
+
export interface ListTrafficDistributionGroupUsersResponse {
|
|
8580
8787
|
/**
|
|
8581
|
-
* <p>
|
|
8788
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8582
8789
|
* @public
|
|
8583
8790
|
*/
|
|
8584
|
-
|
|
8791
|
+
NextToken?: string | undefined;
|
|
8585
8792
|
/**
|
|
8586
|
-
* <p>
|
|
8793
|
+
* <p>A list of traffic distribution group users.</p>
|
|
8587
8794
|
* @public
|
|
8588
8795
|
*/
|
|
8589
|
-
|
|
8796
|
+
TrafficDistributionGroupUserSummaryList?: TrafficDistributionGroupUserSummary[] | undefined;
|
|
8797
|
+
}
|
|
8798
|
+
/**
|
|
8799
|
+
* <p>Provides summary information about the use cases for the specified integration association.</p>
|
|
8800
|
+
* @public
|
|
8801
|
+
*/
|
|
8802
|
+
export interface ListUseCasesRequest {
|
|
8590
8803
|
/**
|
|
8591
|
-
* <p>The
|
|
8804
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
8592
8805
|
* @public
|
|
8593
8806
|
*/
|
|
8594
|
-
|
|
8807
|
+
InstanceId: string | undefined;
|
|
8595
8808
|
/**
|
|
8596
|
-
* <p>The
|
|
8809
|
+
* <p>The identifier for the integration association.</p>
|
|
8597
8810
|
* @public
|
|
8598
8811
|
*/
|
|
8599
|
-
|
|
8812
|
+
IntegrationAssociationId: string | undefined;
|
|
8600
8813
|
/**
|
|
8601
|
-
* <p>
|
|
8602
|
-
*
|
|
8814
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8815
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
8603
8816
|
* @public
|
|
8604
8817
|
*/
|
|
8605
|
-
|
|
8818
|
+
NextToken?: string | undefined;
|
|
8606
8819
|
/**
|
|
8607
|
-
* <p>The
|
|
8820
|
+
* <p>The maximum number of results to return per page.</p>
|
|
8608
8821
|
* @public
|
|
8609
8822
|
*/
|
|
8610
|
-
|
|
8823
|
+
MaxResults?: number | undefined;
|
|
8611
8824
|
}
|
|
8612
8825
|
/**
|
|
8826
|
+
* <p>Contains the
|
|
8827
|
+
* use
|
|
8828
|
+
* case.</p>
|
|
8613
8829
|
* @public
|
|
8614
8830
|
*/
|
|
8615
|
-
export interface
|
|
8831
|
+
export interface UseCase {
|
|
8616
8832
|
/**
|
|
8617
|
-
* <p>
|
|
8833
|
+
* <p>The identifier for the use case.</p>
|
|
8618
8834
|
* @public
|
|
8619
8835
|
*/
|
|
8620
|
-
|
|
8836
|
+
UseCaseId?: string | undefined;
|
|
8621
8837
|
/**
|
|
8622
|
-
* <p>The
|
|
8623
|
-
* retrieve the next set of results.</p>
|
|
8838
|
+
* <p>The Amazon Resource Name (ARN) for the use case.</p>
|
|
8624
8839
|
* @public
|
|
8625
8840
|
*/
|
|
8626
|
-
|
|
8841
|
+
UseCaseArn?: string | undefined;
|
|
8842
|
+
/**
|
|
8843
|
+
* <p>The type of use case to associate to the integration association. Each integration association can have only one
|
|
8844
|
+
* of each use case type.</p>
|
|
8845
|
+
* @public
|
|
8846
|
+
*/
|
|
8847
|
+
UseCaseType?: UseCaseType | undefined;
|
|
8627
8848
|
}
|
|
8628
8849
|
/**
|
|
8629
8850
|
* @public
|
|
8630
8851
|
*/
|
|
8631
|
-
export interface
|
|
8852
|
+
export interface ListUseCasesResponse {
|
|
8632
8853
|
/**
|
|
8633
|
-
* <p>The
|
|
8634
|
-
* instance.</p>
|
|
8854
|
+
* <p>The use cases.</p>
|
|
8635
8855
|
* @public
|
|
8636
8856
|
*/
|
|
8637
|
-
|
|
8857
|
+
UseCaseSummaryList?: UseCase[] | undefined;
|
|
8638
8858
|
/**
|
|
8639
|
-
* <p>
|
|
8859
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8640
8860
|
* @public
|
|
8641
8861
|
*/
|
|
8642
|
-
|
|
8862
|
+
NextToken?: string | undefined;
|
|
8863
|
+
}
|
|
8864
|
+
/**
|
|
8865
|
+
* @public
|
|
8866
|
+
*/
|
|
8867
|
+
export interface ListUserHierarchyGroupsRequest {
|
|
8643
8868
|
/**
|
|
8644
|
-
* <p>The
|
|
8645
|
-
*
|
|
8869
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
8870
|
+
* @public
|
|
8871
|
+
*/
|
|
8872
|
+
InstanceId: string | undefined;
|
|
8873
|
+
/**
|
|
8874
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8875
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
8646
8876
|
* @public
|
|
8647
8877
|
*/
|
|
8648
8878
|
NextToken?: string | undefined;
|
|
@@ -8653,120 +8883,126 @@ export interface ListViewVersionsRequest {
|
|
|
8653
8883
|
MaxResults?: number | undefined;
|
|
8654
8884
|
}
|
|
8655
8885
|
/**
|
|
8656
|
-
* <p>A summary of a view version's metadata.</p>
|
|
8657
8886
|
* @public
|
|
8658
8887
|
*/
|
|
8659
|
-
export interface
|
|
8660
|
-
/**
|
|
8661
|
-
* <p>The identifier of the view version.</p>
|
|
8662
|
-
* @public
|
|
8663
|
-
*/
|
|
8664
|
-
Id?: string | undefined;
|
|
8888
|
+
export interface ListUserHierarchyGroupsResponse {
|
|
8665
8889
|
/**
|
|
8666
|
-
* <p>
|
|
8890
|
+
* <p>Information about the hierarchy groups.</p>
|
|
8667
8891
|
* @public
|
|
8668
8892
|
*/
|
|
8669
|
-
|
|
8893
|
+
UserHierarchyGroupSummaryList?: HierarchyGroupSummary[] | undefined;
|
|
8670
8894
|
/**
|
|
8671
|
-
* <p>
|
|
8895
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8672
8896
|
* @public
|
|
8673
8897
|
*/
|
|
8674
|
-
|
|
8898
|
+
NextToken?: string | undefined;
|
|
8899
|
+
}
|
|
8900
|
+
/**
|
|
8901
|
+
* @public
|
|
8902
|
+
*/
|
|
8903
|
+
export interface ListUserNotificationsRequest {
|
|
8675
8904
|
/**
|
|
8676
|
-
* <p>The
|
|
8905
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
8677
8906
|
* @public
|
|
8678
8907
|
*/
|
|
8679
|
-
|
|
8908
|
+
InstanceId: string | undefined;
|
|
8680
8909
|
/**
|
|
8681
|
-
* <p>The
|
|
8910
|
+
* <p>The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.</p>
|
|
8682
8911
|
* @public
|
|
8683
8912
|
*/
|
|
8684
|
-
|
|
8913
|
+
NextToken?: string | undefined;
|
|
8685
8914
|
/**
|
|
8686
|
-
* <p>The
|
|
8915
|
+
* <p>The maximum number of results to return per page. Valid range is 1-1000.</p>
|
|
8687
8916
|
* @public
|
|
8688
8917
|
*/
|
|
8689
|
-
|
|
8918
|
+
MaxResults?: number | undefined;
|
|
8690
8919
|
/**
|
|
8691
|
-
* <p>The
|
|
8920
|
+
* <p>The identifier of the user.</p>
|
|
8692
8921
|
* @public
|
|
8693
8922
|
*/
|
|
8694
|
-
|
|
8923
|
+
UserId: string | undefined;
|
|
8695
8924
|
}
|
|
8696
8925
|
/**
|
|
8926
|
+
* <p>Summary information about a notification for a specific user, including the user's read status.</p>
|
|
8697
8927
|
* @public
|
|
8698
8928
|
*/
|
|
8699
|
-
export interface
|
|
8929
|
+
export interface UserNotificationSummary {
|
|
8700
8930
|
/**
|
|
8701
|
-
* <p>
|
|
8931
|
+
* <p>The unique identifier for the notification.</p>
|
|
8702
8932
|
* @public
|
|
8703
8933
|
*/
|
|
8704
|
-
|
|
8934
|
+
NotificationId?: string | undefined;
|
|
8935
|
+
/**
|
|
8936
|
+
* <p>The status of the notification for this user. Valid values are READ, UNREAD, and HIDDEN.</p>
|
|
8937
|
+
* @public
|
|
8938
|
+
*/
|
|
8939
|
+
NotificationStatus?: NotificationStatus | undefined;
|
|
8940
|
+
/**
|
|
8941
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
8942
|
+
* @public
|
|
8943
|
+
*/
|
|
8944
|
+
InstanceId?: string | undefined;
|
|
8945
|
+
/**
|
|
8946
|
+
* <p>The identifier of the recipient user.</p>
|
|
8947
|
+
* @public
|
|
8948
|
+
*/
|
|
8949
|
+
RecipientId?: string | undefined;
|
|
8705
8950
|
/**
|
|
8706
|
-
* <p>The
|
|
8707
|
-
* retrieve the next set of results.</p>
|
|
8951
|
+
* <p>The localized content of the notification.</p>
|
|
8708
8952
|
* @public
|
|
8709
8953
|
*/
|
|
8710
|
-
|
|
8711
|
-
}
|
|
8712
|
-
/**
|
|
8713
|
-
* @public
|
|
8714
|
-
*/
|
|
8715
|
-
export interface ListWorkspaceMediaRequest {
|
|
8954
|
+
Content?: Partial<Record<LocaleCode, string>> | undefined;
|
|
8716
8955
|
/**
|
|
8717
|
-
* <p>The
|
|
8718
|
-
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
8956
|
+
* <p>The priority level of the notification.</p>
|
|
8719
8957
|
* @public
|
|
8720
8958
|
*/
|
|
8721
|
-
|
|
8959
|
+
Priority?: NotificationPriority | undefined;
|
|
8722
8960
|
/**
|
|
8723
|
-
* <p>The
|
|
8961
|
+
* <p>The source that created the notification. Valid values are CUSTOMER, RULES, and SYSTEM.</p>
|
|
8724
8962
|
* @public
|
|
8725
8963
|
*/
|
|
8726
|
-
|
|
8727
|
-
}
|
|
8728
|
-
/**
|
|
8729
|
-
* <p>Contains information about a media asset used in a workspace.</p>
|
|
8730
|
-
* @public
|
|
8731
|
-
*/
|
|
8732
|
-
export interface MediaItem {
|
|
8964
|
+
Source?: NotificationSource | undefined;
|
|
8733
8965
|
/**
|
|
8734
|
-
* <p>The
|
|
8735
|
-
* <code>IMAGE_LOGO_HORIZONTAL</code>.</p>
|
|
8966
|
+
* <p>The timestamp when the notification was created.</p>
|
|
8736
8967
|
* @public
|
|
8737
8968
|
*/
|
|
8738
|
-
|
|
8969
|
+
CreatedAt?: Date | undefined;
|
|
8739
8970
|
/**
|
|
8740
|
-
* <p>The
|
|
8971
|
+
* <p>The timestamp when the notification expires.</p>
|
|
8741
8972
|
* @public
|
|
8742
8973
|
*/
|
|
8743
|
-
|
|
8974
|
+
ExpiresAt?: Date | undefined;
|
|
8744
8975
|
}
|
|
8745
8976
|
/**
|
|
8746
8977
|
* @public
|
|
8747
8978
|
*/
|
|
8748
|
-
export interface
|
|
8979
|
+
export interface ListUserNotificationsResponse {
|
|
8749
8980
|
/**
|
|
8750
|
-
* <p>A list of
|
|
8981
|
+
* <p>A list of notifications sent to the specified user.</p>
|
|
8751
8982
|
* @public
|
|
8752
8983
|
*/
|
|
8753
|
-
|
|
8984
|
+
UserNotifications?: UserNotificationSummary[] | undefined;
|
|
8985
|
+
/**
|
|
8986
|
+
* <p>The token for the next set of results. If present, there are more results available.</p>
|
|
8987
|
+
* @public
|
|
8988
|
+
*/
|
|
8989
|
+
NextToken?: string | undefined;
|
|
8754
8990
|
}
|
|
8755
8991
|
/**
|
|
8756
8992
|
* @public
|
|
8757
8993
|
*/
|
|
8758
|
-
export interface
|
|
8994
|
+
export interface ListUserProficienciesRequest {
|
|
8759
8995
|
/**
|
|
8760
|
-
* <p>The identifier of the
|
|
8761
|
-
*
|
|
8996
|
+
* <p>The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the
|
|
8997
|
+
* instance.</p>
|
|
8762
8998
|
* @public
|
|
8763
8999
|
*/
|
|
8764
9000
|
InstanceId: string | undefined;
|
|
8765
9001
|
/**
|
|
8766
|
-
* <p>The identifier of the
|
|
9002
|
+
* <p>The identifier of the user account.</p>
|
|
8767
9003
|
* @public
|
|
8768
9004
|
*/
|
|
8769
|
-
|
|
9005
|
+
UserId: string | undefined;
|
|
8770
9006
|
/**
|
|
8771
9007
|
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
8772
9008
|
* retrieve the next set of results.</p>
|
|
@@ -8780,95 +9016,78 @@ export interface ListWorkspacePagesRequest {
|
|
|
8780
9016
|
MaxResults?: number | undefined;
|
|
8781
9017
|
}
|
|
8782
9018
|
/**
|
|
8783
|
-
* <p>Contains information about a page configuration in a workspace, including the view assigned to the page.</p>
|
|
8784
9019
|
* @public
|
|
8785
9020
|
*/
|
|
8786
|
-
export interface
|
|
8787
|
-
/**
|
|
8788
|
-
* <p>The Amazon Resource Name (ARN) of the view associated with this page.</p>
|
|
8789
|
-
* @public
|
|
8790
|
-
*/
|
|
8791
|
-
ResourceArn?: string | undefined;
|
|
8792
|
-
/**
|
|
8793
|
-
* <p>The page identifier. System pages include <code>HOME</code> and <code>AGENT_EXPERIENCE</code>.</p>
|
|
8794
|
-
* @public
|
|
8795
|
-
*/
|
|
8796
|
-
Page?: string | undefined;
|
|
9021
|
+
export interface ListUserProficienciesResponse {
|
|
8797
9022
|
/**
|
|
8798
|
-
* <p>
|
|
9023
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8799
9024
|
* @public
|
|
8800
9025
|
*/
|
|
8801
|
-
|
|
9026
|
+
NextToken?: string | undefined;
|
|
8802
9027
|
/**
|
|
8803
|
-
* <p>
|
|
9028
|
+
* <p>Information about the user proficiencies.</p>
|
|
8804
9029
|
* @public
|
|
8805
9030
|
*/
|
|
8806
|
-
|
|
8807
|
-
}
|
|
8808
|
-
/**
|
|
8809
|
-
* @public
|
|
8810
|
-
*/
|
|
8811
|
-
export interface ListWorkspacePagesResponse {
|
|
9031
|
+
UserProficiencyList?: UserProficiency[] | undefined;
|
|
8812
9032
|
/**
|
|
8813
|
-
* <p>
|
|
9033
|
+
* <p>The last time that the user's proficiencies are were modified.</p>
|
|
8814
9034
|
* @public
|
|
8815
9035
|
*/
|
|
8816
|
-
|
|
9036
|
+
LastModifiedTime?: Date | undefined;
|
|
8817
9037
|
/**
|
|
8818
|
-
* <p>
|
|
9038
|
+
* <p>The region in which a user's proficiencies were last modified.</p>
|
|
8819
9039
|
* @public
|
|
8820
9040
|
*/
|
|
8821
|
-
|
|
9041
|
+
LastModifiedRegion?: string | undefined;
|
|
8822
9042
|
}
|
|
8823
9043
|
/**
|
|
8824
9044
|
* @public
|
|
8825
9045
|
*/
|
|
8826
|
-
export interface
|
|
9046
|
+
export interface ListUsersRequest {
|
|
8827
9047
|
/**
|
|
8828
|
-
* <p>The identifier of the
|
|
8829
|
-
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
9048
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
8830
9049
|
* @public
|
|
8831
9050
|
*/
|
|
8832
9051
|
InstanceId: string | undefined;
|
|
8833
9052
|
/**
|
|
8834
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8835
|
-
*
|
|
9053
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
9054
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
8836
9055
|
* @public
|
|
8837
9056
|
*/
|
|
8838
9057
|
NextToken?: string | undefined;
|
|
8839
9058
|
/**
|
|
8840
|
-
* <p>The maximum number of results to return per page.</p>
|
|
9059
|
+
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
8841
9060
|
* @public
|
|
8842
9061
|
*/
|
|
8843
9062
|
MaxResults?: number | undefined;
|
|
8844
9063
|
}
|
|
8845
9064
|
/**
|
|
8846
|
-
* <p>Contains summary information about a
|
|
9065
|
+
* <p>Contains summary information about a user.</p>
|
|
8847
9066
|
* @public
|
|
8848
9067
|
*/
|
|
8849
|
-
export interface
|
|
9068
|
+
export interface UserSummary {
|
|
8850
9069
|
/**
|
|
8851
|
-
* <p>The
|
|
9070
|
+
* <p>The identifier of the user account.</p>
|
|
8852
9071
|
* @public
|
|
8853
9072
|
*/
|
|
8854
9073
|
Id?: string | undefined;
|
|
8855
9074
|
/**
|
|
8856
|
-
* <p>The
|
|
9075
|
+
* <p>The Amazon Resource Name (ARN) of the user account.</p>
|
|
8857
9076
|
* @public
|
|
8858
9077
|
*/
|
|
8859
|
-
|
|
9078
|
+
Arn?: string | undefined;
|
|
8860
9079
|
/**
|
|
8861
|
-
* <p>The
|
|
9080
|
+
* <p>The Connect Customer user name of the user account.</p>
|
|
8862
9081
|
* @public
|
|
8863
9082
|
*/
|
|
8864
|
-
|
|
9083
|
+
Username?: string | undefined;
|
|
8865
9084
|
/**
|
|
8866
|
-
* <p>The timestamp when
|
|
9085
|
+
* <p>The timestamp when this resource was last modified.</p>
|
|
8867
9086
|
* @public
|
|
8868
9087
|
*/
|
|
8869
9088
|
LastModifiedTime?: Date | undefined;
|
|
8870
9089
|
/**
|
|
8871
|
-
* <p>The Amazon Web Services Region where
|
|
9090
|
+
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
8872
9091
|
* @public
|
|
8873
9092
|
*/
|
|
8874
9093
|
LastModifiedRegion?: string | undefined;
|
|
@@ -8876,22 +9095,22 @@ export interface WorkspaceSummary {
|
|
|
8876
9095
|
/**
|
|
8877
9096
|
* @public
|
|
8878
9097
|
*/
|
|
8879
|
-
export interface
|
|
9098
|
+
export interface ListUsersResponse {
|
|
8880
9099
|
/**
|
|
8881
|
-
* <p>
|
|
9100
|
+
* <p>Information about the users.</p>
|
|
8882
9101
|
* @public
|
|
8883
9102
|
*/
|
|
8884
|
-
|
|
9103
|
+
UserSummaryList?: UserSummary[] | undefined;
|
|
8885
9104
|
/**
|
|
8886
|
-
* <p>
|
|
9105
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8887
9106
|
* @public
|
|
8888
9107
|
*/
|
|
8889
|
-
|
|
9108
|
+
NextToken?: string | undefined;
|
|
8890
9109
|
}
|
|
8891
9110
|
/**
|
|
8892
9111
|
* @public
|
|
8893
9112
|
*/
|
|
8894
|
-
export interface
|
|
9113
|
+
export interface ListViewsRequest {
|
|
8895
9114
|
/**
|
|
8896
9115
|
* <p>The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the
|
|
8897
9116
|
* instance.</p>
|
|
@@ -8899,840 +9118,751 @@ export interface MonitorContactRequest {
|
|
|
8899
9118
|
*/
|
|
8900
9119
|
InstanceId: string | undefined;
|
|
8901
9120
|
/**
|
|
8902
|
-
* <p>The
|
|
8903
|
-
* @public
|
|
8904
|
-
*/
|
|
8905
|
-
ContactId: string | undefined;
|
|
8906
|
-
/**
|
|
8907
|
-
* <p>The identifier of the user account.</p>
|
|
9121
|
+
* <p>The type of the view.</p>
|
|
8908
9122
|
* @public
|
|
8909
9123
|
*/
|
|
8910
|
-
|
|
9124
|
+
Type?: ViewType | undefined;
|
|
8911
9125
|
/**
|
|
8912
|
-
* <p>
|
|
8913
|
-
*
|
|
9126
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
9127
|
+
* retrieve the next set of results.</p>
|
|
8914
9128
|
* @public
|
|
8915
9129
|
*/
|
|
8916
|
-
|
|
9130
|
+
NextToken?: string | undefined;
|
|
8917
9131
|
/**
|
|
8918
|
-
* <p>
|
|
8919
|
-
* request. If not provided, the Amazon Web Services
|
|
8920
|
-
* SDK populates this field. For more information about idempotency, see
|
|
8921
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
9132
|
+
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
8922
9133
|
* @public
|
|
8923
9134
|
*/
|
|
8924
|
-
|
|
9135
|
+
MaxResults?: number | undefined;
|
|
8925
9136
|
}
|
|
8926
9137
|
/**
|
|
9138
|
+
* <p>A summary of a view's metadata.</p>
|
|
8927
9139
|
* @public
|
|
8928
9140
|
*/
|
|
8929
|
-
export interface
|
|
9141
|
+
export interface ViewSummary {
|
|
8930
9142
|
/**
|
|
8931
|
-
* <p>The identifier of the
|
|
9143
|
+
* <p>The identifier of the view.</p>
|
|
8932
9144
|
* @public
|
|
8933
9145
|
*/
|
|
8934
|
-
|
|
9146
|
+
Id?: string | undefined;
|
|
8935
9147
|
/**
|
|
8936
|
-
* <p>The ARN of the
|
|
9148
|
+
* <p>The Amazon Resource Name (ARN) of the view.</p>
|
|
8937
9149
|
* @public
|
|
8938
9150
|
*/
|
|
8939
|
-
|
|
8940
|
-
}
|
|
8941
|
-
/**
|
|
8942
|
-
* @public
|
|
8943
|
-
*/
|
|
8944
|
-
export interface PauseContactRequest {
|
|
9151
|
+
Arn?: string | undefined;
|
|
8945
9152
|
/**
|
|
8946
|
-
* <p>The
|
|
9153
|
+
* <p>The name of the view.</p>
|
|
8947
9154
|
* @public
|
|
8948
9155
|
*/
|
|
8949
|
-
|
|
9156
|
+
Name?: string | undefined;
|
|
8950
9157
|
/**
|
|
8951
|
-
* <p>The
|
|
8952
|
-
* instance.</p>
|
|
9158
|
+
* <p>The type of the view.</p>
|
|
8953
9159
|
* @public
|
|
8954
9160
|
*/
|
|
8955
|
-
|
|
9161
|
+
Type?: ViewType | undefined;
|
|
8956
9162
|
/**
|
|
8957
|
-
* <p>
|
|
9163
|
+
* <p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The <code>PUBLISHED</code>
|
|
9164
|
+
* status will initiate validation on the content.</p>
|
|
8958
9165
|
* @public
|
|
8959
9166
|
*/
|
|
8960
|
-
|
|
9167
|
+
Status?: ViewStatus | undefined;
|
|
9168
|
+
/**
|
|
9169
|
+
* <p>The description of the view.</p>
|
|
9170
|
+
* @public
|
|
9171
|
+
*/
|
|
9172
|
+
Description?: string | undefined;
|
|
8961
9173
|
}
|
|
8962
9174
|
/**
|
|
8963
9175
|
* @public
|
|
8964
9176
|
*/
|
|
8965
|
-
export interface
|
|
9177
|
+
export interface ListViewsResponse {
|
|
9178
|
+
/**
|
|
9179
|
+
* <p>A list of view summaries.</p>
|
|
9180
|
+
* @public
|
|
9181
|
+
*/
|
|
9182
|
+
ViewsSummaryList?: ViewSummary[] | undefined;
|
|
9183
|
+
/**
|
|
9184
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
9185
|
+
* retrieve the next set of results.</p>
|
|
9186
|
+
* @public
|
|
9187
|
+
*/
|
|
9188
|
+
NextToken?: string | undefined;
|
|
8966
9189
|
}
|
|
8967
9190
|
/**
|
|
8968
9191
|
* @public
|
|
8969
9192
|
*/
|
|
8970
|
-
export interface
|
|
9193
|
+
export interface ListViewVersionsRequest {
|
|
8971
9194
|
/**
|
|
8972
|
-
* <p>The identifier of the
|
|
9195
|
+
* <p>The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the
|
|
9196
|
+
* instance.</p>
|
|
8973
9197
|
* @public
|
|
8974
9198
|
*/
|
|
8975
|
-
|
|
9199
|
+
InstanceId: string | undefined;
|
|
8976
9200
|
/**
|
|
8977
|
-
* <p>The identifier of the
|
|
9201
|
+
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>
|
|
8978
9202
|
* @public
|
|
8979
9203
|
*/
|
|
8980
|
-
|
|
9204
|
+
ViewId: string | undefined;
|
|
8981
9205
|
/**
|
|
8982
|
-
* <p>The
|
|
9206
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
9207
|
+
* retrieve the next set of results.</p>
|
|
8983
9208
|
* @public
|
|
8984
9209
|
*/
|
|
8985
|
-
|
|
8986
|
-
|
|
8987
|
-
|
|
8988
|
-
|
|
8989
|
-
|
|
8990
|
-
|
|
9210
|
+
NextToken?: string | undefined;
|
|
9211
|
+
/**
|
|
9212
|
+
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
9213
|
+
* @public
|
|
9214
|
+
*/
|
|
9215
|
+
MaxResults?: number | undefined;
|
|
8991
9216
|
}
|
|
8992
9217
|
/**
|
|
9218
|
+
* <p>A summary of a view version's metadata.</p>
|
|
8993
9219
|
* @public
|
|
8994
9220
|
*/
|
|
8995
|
-
export interface
|
|
9221
|
+
export interface ViewVersionSummary {
|
|
8996
9222
|
/**
|
|
8997
|
-
* <p>
|
|
9223
|
+
* <p>The identifier of the view version.</p>
|
|
8998
9224
|
* @public
|
|
8999
9225
|
*/
|
|
9000
|
-
|
|
9226
|
+
Id?: string | undefined;
|
|
9001
9227
|
/**
|
|
9002
|
-
* <p>
|
|
9003
|
-
* request. If not provided, the Amazon Web Services
|
|
9004
|
-
* SDK populates this field. For more information about idempotency, see
|
|
9005
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
9228
|
+
* <p>The Amazon Resource Name (ARN) of the view version.</p>
|
|
9006
9229
|
* @public
|
|
9007
9230
|
*/
|
|
9008
|
-
|
|
9009
|
-
}
|
|
9010
|
-
/**
|
|
9011
|
-
* @public
|
|
9012
|
-
*/
|
|
9013
|
-
export interface ReplicateInstanceRequest {
|
|
9231
|
+
Arn?: string | undefined;
|
|
9014
9232
|
/**
|
|
9015
|
-
* <p>The
|
|
9233
|
+
* <p>The description of the view version.</p>
|
|
9016
9234
|
* @public
|
|
9017
9235
|
*/
|
|
9018
|
-
|
|
9236
|
+
Description?: string | undefined;
|
|
9019
9237
|
/**
|
|
9020
|
-
* <p>The
|
|
9238
|
+
* <p>The name of the view version.</p>
|
|
9239
|
+
* @public
|
|
9240
|
+
*/
|
|
9241
|
+
Name?: string | undefined;
|
|
9242
|
+
/**
|
|
9243
|
+
* <p>The type of the view version.</p>
|
|
9021
9244
|
* @public
|
|
9022
9245
|
*/
|
|
9023
|
-
|
|
9246
|
+
Type?: ViewType | undefined;
|
|
9024
9247
|
/**
|
|
9025
|
-
* <p>
|
|
9026
|
-
* request. If not provided, the Amazon Web Services
|
|
9027
|
-
* SDK populates this field. For more information about idempotency, see
|
|
9028
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
9248
|
+
* <p>The sequentially incremented version of the view version.</p>
|
|
9029
9249
|
* @public
|
|
9030
9250
|
*/
|
|
9031
|
-
|
|
9251
|
+
Version?: number | undefined;
|
|
9032
9252
|
/**
|
|
9033
|
-
* <p>The
|
|
9253
|
+
* <p>The description of the view version.</p>
|
|
9034
9254
|
* @public
|
|
9035
9255
|
*/
|
|
9036
|
-
|
|
9256
|
+
VersionDescription?: string | undefined;
|
|
9037
9257
|
}
|
|
9038
9258
|
/**
|
|
9039
9259
|
* @public
|
|
9040
9260
|
*/
|
|
9041
|
-
export interface
|
|
9261
|
+
export interface ListViewVersionsResponse {
|
|
9042
9262
|
/**
|
|
9043
|
-
* <p>
|
|
9044
|
-
* The replicated instance has the same identifier as the instance it was replicated from.</p>
|
|
9263
|
+
* <p>A list of view version summaries.</p>
|
|
9045
9264
|
* @public
|
|
9046
9265
|
*/
|
|
9047
|
-
|
|
9266
|
+
ViewVersionSummaryList?: ViewVersionSummary[] | undefined;
|
|
9048
9267
|
/**
|
|
9049
|
-
* <p>The
|
|
9268
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
9269
|
+
* retrieve the next set of results.</p>
|
|
9050
9270
|
* @public
|
|
9051
9271
|
*/
|
|
9052
|
-
|
|
9272
|
+
NextToken?: string | undefined;
|
|
9053
9273
|
}
|
|
9054
9274
|
/**
|
|
9055
9275
|
* @public
|
|
9056
9276
|
*/
|
|
9057
|
-
export interface
|
|
9277
|
+
export interface ListWorkspaceMediaRequest {
|
|
9058
9278
|
/**
|
|
9059
|
-
* <p>The identifier of the
|
|
9279
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in
|
|
9280
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
9060
9281
|
* @public
|
|
9061
9282
|
*/
|
|
9062
|
-
|
|
9283
|
+
InstanceId: string | undefined;
|
|
9063
9284
|
/**
|
|
9064
|
-
* <p>The identifier of the
|
|
9065
|
-
* instance.</p>
|
|
9285
|
+
* <p>The identifier of the workspace.</p>
|
|
9066
9286
|
* @public
|
|
9067
9287
|
*/
|
|
9068
|
-
|
|
9288
|
+
WorkspaceId: string | undefined;
|
|
9289
|
+
}
|
|
9290
|
+
/**
|
|
9291
|
+
* <p>Contains information about a media asset used in a workspace.</p>
|
|
9292
|
+
* @public
|
|
9293
|
+
*/
|
|
9294
|
+
export interface MediaItem {
|
|
9069
9295
|
/**
|
|
9070
|
-
* <p>The
|
|
9296
|
+
* <p>The type of media. Valid values are: <code>IMAGE_LOGO_FAVICON</code> and
|
|
9297
|
+
* <code>IMAGE_LOGO_HORIZONTAL</code>.</p>
|
|
9071
9298
|
* @public
|
|
9072
9299
|
*/
|
|
9073
|
-
|
|
9300
|
+
Type?: MediaType | undefined;
|
|
9301
|
+
/**
|
|
9302
|
+
* <p>The source URL or data for the media asset.</p>
|
|
9303
|
+
* @public
|
|
9304
|
+
*/
|
|
9305
|
+
Source?: string | undefined;
|
|
9074
9306
|
}
|
|
9075
9307
|
/**
|
|
9076
9308
|
* @public
|
|
9077
9309
|
*/
|
|
9078
|
-
export interface
|
|
9310
|
+
export interface ListWorkspaceMediaResponse {
|
|
9311
|
+
/**
|
|
9312
|
+
* <p>A list of media assets for the workspace.</p>
|
|
9313
|
+
* @public
|
|
9314
|
+
*/
|
|
9315
|
+
Media?: MediaItem[] | undefined;
|
|
9079
9316
|
}
|
|
9080
9317
|
/**
|
|
9081
9318
|
* @public
|
|
9082
9319
|
*/
|
|
9083
|
-
export interface
|
|
9320
|
+
export interface ListWorkspacePagesRequest {
|
|
9084
9321
|
/**
|
|
9085
|
-
* <p>The identifier of the Connect
|
|
9322
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in
|
|
9323
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
9086
9324
|
* @public
|
|
9087
9325
|
*/
|
|
9088
9326
|
InstanceId: string | undefined;
|
|
9089
9327
|
/**
|
|
9090
|
-
* <p>The identifier of the
|
|
9328
|
+
* <p>The identifier of the workspace.</p>
|
|
9091
9329
|
* @public
|
|
9092
9330
|
*/
|
|
9093
|
-
|
|
9331
|
+
WorkspaceId: string | undefined;
|
|
9094
9332
|
/**
|
|
9095
|
-
* <p>The
|
|
9096
|
-
* the
|
|
9333
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
9334
|
+
* retrieve the next set of results.</p>
|
|
9097
9335
|
* @public
|
|
9098
9336
|
*/
|
|
9099
|
-
|
|
9337
|
+
NextToken?: string | undefined;
|
|
9100
9338
|
/**
|
|
9101
|
-
* <p>The
|
|
9339
|
+
* <p>The maximum number of results to return per page.</p>
|
|
9102
9340
|
* @public
|
|
9103
9341
|
*/
|
|
9104
|
-
|
|
9105
|
-
}
|
|
9106
|
-
/**
|
|
9107
|
-
* @public
|
|
9108
|
-
*/
|
|
9109
|
-
export interface ResumeContactRecordingResponse {
|
|
9342
|
+
MaxResults?: number | undefined;
|
|
9110
9343
|
}
|
|
9111
9344
|
/**
|
|
9345
|
+
* <p>Contains information about a page configuration in a workspace, including the view assigned to the page.</p>
|
|
9112
9346
|
* @public
|
|
9113
9347
|
*/
|
|
9114
|
-
export interface
|
|
9348
|
+
export interface WorkspacePage {
|
|
9115
9349
|
/**
|
|
9116
|
-
* <p>The
|
|
9350
|
+
* <p>The Amazon Resource Name (ARN) of the view associated with this page.</p>
|
|
9117
9351
|
* @public
|
|
9118
9352
|
*/
|
|
9119
|
-
|
|
9353
|
+
ResourceArn?: string | undefined;
|
|
9120
9354
|
/**
|
|
9121
|
-
* <p>
|
|
9355
|
+
* <p>The page identifier. System pages include <code>HOME</code> and <code>AGENT_EXPERIENCE</code>.</p>
|
|
9122
9356
|
* @public
|
|
9123
9357
|
*/
|
|
9124
|
-
|
|
9358
|
+
Page?: string | undefined;
|
|
9125
9359
|
/**
|
|
9126
|
-
* <p>The
|
|
9360
|
+
* <p>The URL-friendly identifier for the page.</p>
|
|
9127
9361
|
* @public
|
|
9128
9362
|
*/
|
|
9129
|
-
|
|
9363
|
+
Slug?: string | undefined;
|
|
9364
|
+
/**
|
|
9365
|
+
* <p>A JSON string containing input parameters passed to the view when the page is rendered.</p>
|
|
9366
|
+
* @public
|
|
9367
|
+
*/
|
|
9368
|
+
InputData?: string | undefined;
|
|
9130
9369
|
}
|
|
9131
9370
|
/**
|
|
9132
9371
|
* @public
|
|
9133
9372
|
*/
|
|
9134
|
-
export interface
|
|
9135
|
-
/**
|
|
9136
|
-
* <p>The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
|
|
9137
|
-
* @public
|
|
9138
|
-
*/
|
|
9139
|
-
TargetArn?: string | undefined;
|
|
9373
|
+
export interface ListWorkspacePagesResponse {
|
|
9140
9374
|
/**
|
|
9141
|
-
* <p>
|
|
9142
|
-
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
|
|
9143
|
-
* instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
|
|
9375
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
9144
9376
|
* @public
|
|
9145
9377
|
*/
|
|
9146
|
-
|
|
9378
|
+
NextToken?: string | undefined;
|
|
9147
9379
|
/**
|
|
9148
|
-
* <p>
|
|
9380
|
+
* <p>A list of page configurations in the workspace.</p>
|
|
9149
9381
|
* @public
|
|
9150
9382
|
*/
|
|
9151
|
-
|
|
9383
|
+
WorkspacePageList: WorkspacePage[] | undefined;
|
|
9384
|
+
}
|
|
9385
|
+
/**
|
|
9386
|
+
* @public
|
|
9387
|
+
*/
|
|
9388
|
+
export interface ListWorkspacesRequest {
|
|
9152
9389
|
/**
|
|
9153
|
-
* <p>The
|
|
9390
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in
|
|
9391
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
9154
9392
|
* @public
|
|
9155
9393
|
*/
|
|
9156
|
-
|
|
9394
|
+
InstanceId: string | undefined;
|
|
9157
9395
|
/**
|
|
9158
|
-
* <p>The
|
|
9396
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
9397
|
+
* retrieve the next set of results.</p>
|
|
9159
9398
|
* @public
|
|
9160
9399
|
*/
|
|
9161
|
-
|
|
9400
|
+
NextToken?: string | undefined;
|
|
9162
9401
|
/**
|
|
9163
9402
|
* <p>The maximum number of results to return per page.</p>
|
|
9164
9403
|
* @public
|
|
9165
9404
|
*/
|
|
9166
9405
|
MaxResults?: number | undefined;
|
|
9167
|
-
/**
|
|
9168
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
9169
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
9170
|
-
* @public
|
|
9171
|
-
*/
|
|
9172
|
-
NextToken?: string | undefined;
|
|
9173
9406
|
}
|
|
9174
9407
|
/**
|
|
9175
|
-
* <p>
|
|
9408
|
+
* <p>Contains summary information about a workspace.</p>
|
|
9176
9409
|
* @public
|
|
9177
9410
|
*/
|
|
9178
|
-
export interface
|
|
9411
|
+
export interface WorkspaceSummary {
|
|
9179
9412
|
/**
|
|
9180
|
-
* <p>The
|
|
9413
|
+
* <p>The unique identifier of the workspace.</p>
|
|
9181
9414
|
* @public
|
|
9182
9415
|
*/
|
|
9183
|
-
|
|
9416
|
+
Id?: string | undefined;
|
|
9184
9417
|
/**
|
|
9185
|
-
* <p>The
|
|
9418
|
+
* <p>The name of the workspace.</p>
|
|
9186
9419
|
* @public
|
|
9187
9420
|
*/
|
|
9188
|
-
|
|
9421
|
+
Name?: string | undefined;
|
|
9189
9422
|
/**
|
|
9190
|
-
* <p>The
|
|
9423
|
+
* <p>The Amazon Resource Name (ARN) of the workspace.</p>
|
|
9191
9424
|
* @public
|
|
9192
9425
|
*/
|
|
9193
|
-
|
|
9194
|
-
}
|
|
9195
|
-
/**
|
|
9196
|
-
* @public
|
|
9197
|
-
*/
|
|
9198
|
-
export interface SearchAvailablePhoneNumbersResponse {
|
|
9426
|
+
Arn?: string | undefined;
|
|
9199
9427
|
/**
|
|
9200
|
-
* <p>
|
|
9428
|
+
* <p>The timestamp when the workspace was last modified.</p>
|
|
9201
9429
|
* @public
|
|
9202
9430
|
*/
|
|
9203
|
-
|
|
9431
|
+
LastModifiedTime?: Date | undefined;
|
|
9204
9432
|
/**
|
|
9205
|
-
* <p>
|
|
9433
|
+
* <p>The Amazon Web Services Region where the workspace was last modified.</p>
|
|
9206
9434
|
* @public
|
|
9207
9435
|
*/
|
|
9208
|
-
|
|
9436
|
+
LastModifiedRegion?: string | undefined;
|
|
9209
9437
|
}
|
|
9210
9438
|
/**
|
|
9211
|
-
* <p>A boolean search condition for Search APIs.</p>
|
|
9212
9439
|
* @public
|
|
9213
9440
|
*/
|
|
9214
|
-
export interface
|
|
9441
|
+
export interface ListWorkspacesResponse {
|
|
9215
9442
|
/**
|
|
9216
|
-
* <p>
|
|
9443
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
9217
9444
|
* @public
|
|
9218
9445
|
*/
|
|
9219
|
-
|
|
9446
|
+
NextToken?: string | undefined;
|
|
9220
9447
|
/**
|
|
9221
|
-
* <p>
|
|
9448
|
+
* <p>A summary list of workspaces.</p>
|
|
9222
9449
|
* @public
|
|
9223
9450
|
*/
|
|
9224
|
-
|
|
9451
|
+
WorkspaceSummaryList: WorkspaceSummary[] | undefined;
|
|
9225
9452
|
}
|
|
9226
9453
|
/**
|
|
9227
|
-
* <p>A datetime search condition for Search APIs.</p>
|
|
9228
9454
|
* @public
|
|
9229
9455
|
*/
|
|
9230
|
-
export interface
|
|
9456
|
+
export interface MonitorContactRequest {
|
|
9231
9457
|
/**
|
|
9232
|
-
* <p>
|
|
9458
|
+
* <p>The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the
|
|
9459
|
+
* instance.</p>
|
|
9233
9460
|
* @public
|
|
9234
9461
|
*/
|
|
9235
|
-
|
|
9462
|
+
InstanceId: string | undefined;
|
|
9236
9463
|
/**
|
|
9237
|
-
* <p>
|
|
9464
|
+
* <p>The identifier of the contact.</p>
|
|
9238
9465
|
* @public
|
|
9239
9466
|
*/
|
|
9240
|
-
|
|
9467
|
+
ContactId: string | undefined;
|
|
9241
9468
|
/**
|
|
9242
|
-
* <p>
|
|
9469
|
+
* <p>The identifier of the user account.</p>
|
|
9243
9470
|
* @public
|
|
9244
9471
|
*/
|
|
9245
|
-
|
|
9472
|
+
UserId: string | undefined;
|
|
9246
9473
|
/**
|
|
9247
|
-
* <p>
|
|
9474
|
+
* <p>Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to
|
|
9475
|
+
* escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.</p>
|
|
9248
9476
|
* @public
|
|
9249
9477
|
*/
|
|
9250
|
-
|
|
9478
|
+
AllowedMonitorCapabilities?: MonitorCapability[] | undefined;
|
|
9479
|
+
/**
|
|
9480
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
9481
|
+
* request. If not provided, the Amazon Web Services
|
|
9482
|
+
* SDK populates this field. For more information about idempotency, see
|
|
9483
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
9484
|
+
* @public
|
|
9485
|
+
*/
|
|
9486
|
+
ClientToken?: string | undefined;
|
|
9251
9487
|
}
|
|
9252
9488
|
/**
|
|
9253
|
-
* <p>A decimal search condition for Search APIs.</p>
|
|
9254
9489
|
* @public
|
|
9255
9490
|
*/
|
|
9256
|
-
export interface
|
|
9257
|
-
/**
|
|
9258
|
-
* <p>A name of the decimal property to be searched.</p>
|
|
9259
|
-
* @public
|
|
9260
|
-
*/
|
|
9261
|
-
FieldName?: string | undefined;
|
|
9262
|
-
/**
|
|
9263
|
-
* <p>A minimum value of the decimal property.</p>
|
|
9264
|
-
* @public
|
|
9265
|
-
*/
|
|
9266
|
-
MinValue?: number | undefined;
|
|
9491
|
+
export interface MonitorContactResponse {
|
|
9267
9492
|
/**
|
|
9268
|
-
* <p>
|
|
9493
|
+
* <p>The identifier of the contact.</p>
|
|
9269
9494
|
* @public
|
|
9270
9495
|
*/
|
|
9271
|
-
|
|
9496
|
+
ContactId?: string | undefined;
|
|
9272
9497
|
/**
|
|
9273
|
-
* <p>The
|
|
9498
|
+
* <p>The ARN of the contact.</p>
|
|
9274
9499
|
* @public
|
|
9275
9500
|
*/
|
|
9276
|
-
|
|
9501
|
+
ContactArn?: string | undefined;
|
|
9277
9502
|
}
|
|
9278
9503
|
/**
|
|
9279
|
-
* <p>A leaf node condition which can be used to specify a numeric condition.</p>
|
|
9280
|
-
* <note>
|
|
9281
|
-
* <p>The currently supported value for <code>FieldName</code> is <code>limit</code>.</p>
|
|
9282
|
-
* </note>
|
|
9283
9504
|
* @public
|
|
9284
9505
|
*/
|
|
9285
|
-
export interface
|
|
9286
|
-
/**
|
|
9287
|
-
* <p>The name of the field in the number condition.</p>
|
|
9288
|
-
* @public
|
|
9289
|
-
*/
|
|
9290
|
-
FieldName?: string | undefined;
|
|
9506
|
+
export interface PauseContactRequest {
|
|
9291
9507
|
/**
|
|
9292
|
-
* <p>The
|
|
9508
|
+
* <p>The identifier of the contact.</p>
|
|
9293
9509
|
* @public
|
|
9294
9510
|
*/
|
|
9295
|
-
|
|
9511
|
+
ContactId: string | undefined;
|
|
9296
9512
|
/**
|
|
9297
|
-
* <p>The
|
|
9513
|
+
* <p>The identifier of the Connect Customer instance. You can find the <code>instanceId</code> in the ARN of the
|
|
9514
|
+
* instance.</p>
|
|
9298
9515
|
* @public
|
|
9299
9516
|
*/
|
|
9300
|
-
|
|
9517
|
+
InstanceId: string | undefined;
|
|
9301
9518
|
/**
|
|
9302
|
-
* <p>The
|
|
9519
|
+
* <p>The identifier of the flow.</p>
|
|
9303
9520
|
* @public
|
|
9304
9521
|
*/
|
|
9305
|
-
|
|
9522
|
+
ContactFlowId?: string | undefined;
|
|
9306
9523
|
}
|
|
9307
9524
|
/**
|
|
9308
|
-
* <p>The value of a contact evaluation attribute condition.</p>
|
|
9309
9525
|
* @public
|
|
9310
9526
|
*/
|
|
9311
|
-
export interface
|
|
9312
|
-
/**
|
|
9313
|
-
* <p>A string value for the attribute.</p>
|
|
9314
|
-
* @public
|
|
9315
|
-
*/
|
|
9316
|
-
StringValue?: string | undefined;
|
|
9527
|
+
export interface PauseContactResponse {
|
|
9317
9528
|
}
|
|
9318
9529
|
/**
|
|
9319
|
-
* <p>An attribute condition for contact evaluation filtering.</p>
|
|
9320
9530
|
* @public
|
|
9321
9531
|
*/
|
|
9322
|
-
export interface
|
|
9532
|
+
export interface PutUserStatusRequest {
|
|
9323
9533
|
/**
|
|
9324
|
-
* <p>The
|
|
9534
|
+
* <p>The identifier of the user.</p>
|
|
9325
9535
|
* @public
|
|
9326
9536
|
*/
|
|
9327
|
-
|
|
9537
|
+
UserId: string | undefined;
|
|
9328
9538
|
/**
|
|
9329
|
-
* <p>The
|
|
9539
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
9330
9540
|
* @public
|
|
9331
9541
|
*/
|
|
9332
|
-
|
|
9542
|
+
InstanceId: string | undefined;
|
|
9333
9543
|
/**
|
|
9334
|
-
* <p>The
|
|
9544
|
+
* <p>The identifier of the agent status.</p>
|
|
9335
9545
|
* @public
|
|
9336
9546
|
*/
|
|
9337
|
-
|
|
9547
|
+
AgentStatusId: string | undefined;
|
|
9548
|
+
}
|
|
9549
|
+
/**
|
|
9550
|
+
* @public
|
|
9551
|
+
*/
|
|
9552
|
+
export interface PutUserStatusResponse {
|
|
9338
9553
|
}
|
|
9339
9554
|
/**
|
|
9340
|
-
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
|
|
9341
9555
|
* @public
|
|
9342
9556
|
*/
|
|
9343
|
-
export interface
|
|
9557
|
+
export interface ReleasePhoneNumberRequest {
|
|
9344
9558
|
/**
|
|
9345
|
-
* <p>A
|
|
9559
|
+
* <p>A unique identifier for the phone number.</p>
|
|
9346
9560
|
* @public
|
|
9347
9561
|
*/
|
|
9348
|
-
|
|
9562
|
+
PhoneNumberId: string | undefined;
|
|
9349
9563
|
/**
|
|
9350
|
-
* <p>A
|
|
9564
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
9565
|
+
* request. If not provided, the Amazon Web Services
|
|
9566
|
+
* SDK populates this field. For more information about idempotency, see
|
|
9567
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
9351
9568
|
* @public
|
|
9352
9569
|
*/
|
|
9353
|
-
|
|
9570
|
+
ClientToken?: string | undefined;
|
|
9354
9571
|
}
|
|
9355
9572
|
/**
|
|
9356
|
-
* <p>An object that can be used to specify tag conditions and attribute conditions inside the
|
|
9357
|
-
* <code>SearchFilter</code> for contact evaluations. This accepts an <code>OR</code> or <code>AND</code>
|
|
9358
|
-
* (List of List) input where:</p>
|
|
9359
|
-
* <ul>
|
|
9360
|
-
* <li>
|
|
9361
|
-
* <p>The top level list specifies conditions that need to be applied with <code>OR</code> operator.</p>
|
|
9362
|
-
* </li>
|
|
9363
|
-
* <li>
|
|
9364
|
-
* <p>The inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
|
|
9365
|
-
* </li>
|
|
9366
|
-
* </ul>
|
|
9367
9573
|
* @public
|
|
9368
9574
|
*/
|
|
9369
|
-
export interface
|
|
9575
|
+
export interface ReplicateInstanceRequest {
|
|
9370
9576
|
/**
|
|
9371
|
-
* <p>
|
|
9577
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. You can provide the <code>InstanceId</code>, or the entire ARN.</p>
|
|
9372
9578
|
* @public
|
|
9373
9579
|
*/
|
|
9374
|
-
|
|
9580
|
+
InstanceId: string | undefined;
|
|
9375
9581
|
/**
|
|
9376
|
-
* <p>
|
|
9582
|
+
* <p>The Amazon Web Services Region where to replicate the Connect Customer instance.</p>
|
|
9377
9583
|
* @public
|
|
9378
9584
|
*/
|
|
9379
|
-
|
|
9585
|
+
ReplicaRegion: string | undefined;
|
|
9380
9586
|
/**
|
|
9381
|
-
* <p>A
|
|
9587
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
9588
|
+
* request. If not provided, the Amazon Web Services
|
|
9589
|
+
* SDK populates this field. For more information about idempotency, see
|
|
9590
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
9382
9591
|
* @public
|
|
9383
9592
|
*/
|
|
9384
|
-
|
|
9593
|
+
ClientToken?: string | undefined;
|
|
9385
9594
|
/**
|
|
9386
|
-
* <p>
|
|
9595
|
+
* <p>The alias for the replicated instance. The <code>ReplicaAlias</code> must be unique.</p>
|
|
9387
9596
|
* @public
|
|
9388
9597
|
*/
|
|
9389
|
-
|
|
9598
|
+
ReplicaAlias: string | undefined;
|
|
9390
9599
|
}
|
|
9391
9600
|
/**
|
|
9392
|
-
* <p>Filters to be applied to search results.</p>
|
|
9393
9601
|
* @public
|
|
9394
9602
|
*/
|
|
9395
|
-
export interface
|
|
9603
|
+
export interface ReplicateInstanceResponse {
|
|
9396
9604
|
/**
|
|
9397
|
-
* <p>
|
|
9605
|
+
* <p>The identifier of the replicated instance. You can find the <code>instanceId</code> in the ARN of the instance.
|
|
9606
|
+
* The replicated instance has the same identifier as the instance it was replicated from.</p>
|
|
9398
9607
|
* @public
|
|
9399
9608
|
*/
|
|
9400
|
-
|
|
9609
|
+
Id?: string | undefined;
|
|
9401
9610
|
/**
|
|
9402
|
-
* <p>
|
|
9611
|
+
* <p>The Amazon Resource Name (ARN) of the replicated instance.</p>
|
|
9403
9612
|
* @public
|
|
9404
9613
|
*/
|
|
9405
|
-
|
|
9614
|
+
Arn?: string | undefined;
|
|
9406
9615
|
}
|
|
9407
9616
|
/**
|
|
9408
|
-
* <p>Metadata information about an evaluation search.</p>
|
|
9409
9617
|
* @public
|
|
9410
9618
|
*/
|
|
9411
|
-
export interface
|
|
9619
|
+
export interface ResumeContactRequest {
|
|
9412
9620
|
/**
|
|
9413
|
-
* <p>The identifier of the contact
|
|
9621
|
+
* <p>The identifier of the contact.</p>
|
|
9414
9622
|
* @public
|
|
9415
9623
|
*/
|
|
9416
9624
|
ContactId: string | undefined;
|
|
9417
9625
|
/**
|
|
9418
|
-
* <p>The
|
|
9419
|
-
*
|
|
9420
|
-
*/
|
|
9421
|
-
EvaluatorArn: string | undefined;
|
|
9422
|
-
/**
|
|
9423
|
-
* <p>The unique ID of the agent who handled the contact.</p>
|
|
9424
|
-
* @public
|
|
9425
|
-
*/
|
|
9426
|
-
ContactAgentId?: string | undefined;
|
|
9427
|
-
/**
|
|
9428
|
-
* <p>The calibration session ID that this evaluation belongs to.</p>
|
|
9429
|
-
* @public
|
|
9430
|
-
*/
|
|
9431
|
-
CalibrationSessionId?: string | undefined;
|
|
9432
|
-
/**
|
|
9433
|
-
* <p>The total evaluation score expressed as a percentage.</p>
|
|
9434
|
-
* @public
|
|
9435
|
-
*/
|
|
9436
|
-
ScorePercentage?: number | undefined;
|
|
9437
|
-
/**
|
|
9438
|
-
* <p>The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this
|
|
9439
|
-
* flag is true.</p>
|
|
9440
|
-
* @public
|
|
9441
|
-
*/
|
|
9442
|
-
ScoreAutomaticFail?: boolean | undefined;
|
|
9443
|
-
/**
|
|
9444
|
-
* <p>The flag to mark the item as not applicable for scoring.</p>
|
|
9445
|
-
* @public
|
|
9446
|
-
*/
|
|
9447
|
-
ScoreNotApplicable?: boolean | undefined;
|
|
9448
|
-
/**
|
|
9449
|
-
* <p>Whether auto-evaluation is enabled.</p>
|
|
9450
|
-
* @public
|
|
9451
|
-
*/
|
|
9452
|
-
AutoEvaluationEnabled?: boolean | undefined;
|
|
9453
|
-
/**
|
|
9454
|
-
* <p>The status of the contact auto evaluation. </p>
|
|
9455
|
-
* @public
|
|
9456
|
-
*/
|
|
9457
|
-
AutoEvaluationStatus?: AutoEvaluationStatus | undefined;
|
|
9458
|
-
/**
|
|
9459
|
-
* <p>When the evaluation was acknowledged by the agent.</p>
|
|
9460
|
-
* @public
|
|
9461
|
-
*/
|
|
9462
|
-
AcknowledgedTime?: Date | undefined;
|
|
9463
|
-
/**
|
|
9464
|
-
* <p>The agent who acknowledged the evaluation.</p>
|
|
9626
|
+
* <p>The identifier of the Connect Customer instance. You can find the <code>instanceId</code> in the ARN of the
|
|
9627
|
+
* instance.</p>
|
|
9465
9628
|
* @public
|
|
9466
9629
|
*/
|
|
9467
|
-
|
|
9630
|
+
InstanceId: string | undefined;
|
|
9468
9631
|
/**
|
|
9469
|
-
* <p>The
|
|
9632
|
+
* <p>The identifier of the flow.</p>
|
|
9470
9633
|
* @public
|
|
9471
9634
|
*/
|
|
9472
|
-
|
|
9635
|
+
ContactFlowId?: string | undefined;
|
|
9636
|
+
}
|
|
9637
|
+
/**
|
|
9638
|
+
* @public
|
|
9639
|
+
*/
|
|
9640
|
+
export interface ResumeContactResponse {
|
|
9641
|
+
}
|
|
9642
|
+
/**
|
|
9643
|
+
* @public
|
|
9644
|
+
*/
|
|
9645
|
+
export interface ResumeContactRecordingRequest {
|
|
9473
9646
|
/**
|
|
9474
|
-
* <p>
|
|
9647
|
+
* <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
9475
9648
|
* @public
|
|
9476
9649
|
*/
|
|
9477
|
-
|
|
9650
|
+
InstanceId: string | undefined;
|
|
9478
9651
|
/**
|
|
9479
|
-
* <p>
|
|
9652
|
+
* <p>The identifier of the contact.</p>
|
|
9480
9653
|
* @public
|
|
9481
9654
|
*/
|
|
9482
|
-
|
|
9655
|
+
ContactId: string | undefined;
|
|
9483
9656
|
/**
|
|
9484
|
-
* <p>
|
|
9657
|
+
* <p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with
|
|
9658
|
+
* the contact center.</p>
|
|
9485
9659
|
* @public
|
|
9486
9660
|
*/
|
|
9487
|
-
|
|
9661
|
+
InitialContactId: string | undefined;
|
|
9488
9662
|
/**
|
|
9489
|
-
* <p>
|
|
9663
|
+
* <p>The type of recording being operated on.</p>
|
|
9490
9664
|
* @public
|
|
9491
9665
|
*/
|
|
9492
|
-
|
|
9666
|
+
ContactRecordingType?: ContactRecordingType | undefined;
|
|
9667
|
+
}
|
|
9668
|
+
/**
|
|
9669
|
+
* @public
|
|
9670
|
+
*/
|
|
9671
|
+
export interface ResumeContactRecordingResponse {
|
|
9672
|
+
}
|
|
9673
|
+
/**
|
|
9674
|
+
* @public
|
|
9675
|
+
*/
|
|
9676
|
+
export interface SearchAgentStatusesResponse {
|
|
9493
9677
|
/**
|
|
9494
|
-
* <p>The
|
|
9678
|
+
* <p>The search criteria to be used to return agent statuses.</p>
|
|
9495
9679
|
* @public
|
|
9496
9680
|
*/
|
|
9497
|
-
|
|
9681
|
+
AgentStatuses?: AgentStatus[] | undefined;
|
|
9498
9682
|
/**
|
|
9499
|
-
* <p>
|
|
9683
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
9500
9684
|
* @public
|
|
9501
9685
|
*/
|
|
9502
|
-
|
|
9686
|
+
NextToken?: string | undefined;
|
|
9503
9687
|
/**
|
|
9504
|
-
* <p>The
|
|
9688
|
+
* <p>The total number of agent statuses which matched your search query.</p>
|
|
9505
9689
|
* @public
|
|
9506
9690
|
*/
|
|
9507
|
-
|
|
9691
|
+
ApproximateTotalCount?: number | undefined;
|
|
9508
9692
|
}
|
|
9509
9693
|
/**
|
|
9510
|
-
* <p>Summary of evaluation obtained from the search operation.</p>
|
|
9511
9694
|
* @public
|
|
9512
9695
|
*/
|
|
9513
|
-
export interface
|
|
9514
|
-
/**
|
|
9515
|
-
* <p>A unique identifier for the contact evaluation.</p>
|
|
9516
|
-
* @public
|
|
9517
|
-
*/
|
|
9518
|
-
EvaluationId: string | undefined;
|
|
9696
|
+
export interface SearchAvailablePhoneNumbersRequest {
|
|
9519
9697
|
/**
|
|
9520
|
-
* <p>The Amazon Resource Name (ARN) for
|
|
9698
|
+
* <p>The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
|
|
9521
9699
|
* @public
|
|
9522
9700
|
*/
|
|
9523
|
-
|
|
9701
|
+
TargetArn?: string | undefined;
|
|
9524
9702
|
/**
|
|
9525
|
-
* <p>The
|
|
9703
|
+
* <p>The identifier of the Connect Customer instance that phone numbers are claimed to. You
|
|
9704
|
+
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
|
|
9705
|
+
* instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
|
|
9526
9706
|
* @public
|
|
9527
9707
|
*/
|
|
9528
|
-
|
|
9708
|
+
InstanceId?: string | undefined;
|
|
9529
9709
|
/**
|
|
9530
|
-
* <p>
|
|
9710
|
+
* <p>The ISO country code.</p>
|
|
9531
9711
|
* @public
|
|
9532
9712
|
*/
|
|
9533
|
-
|
|
9713
|
+
PhoneNumberCountryCode: PhoneNumberCountryCode | undefined;
|
|
9534
9714
|
/**
|
|
9535
|
-
* <p>
|
|
9715
|
+
* <p>The type of phone number.</p>
|
|
9536
9716
|
* @public
|
|
9537
9717
|
*/
|
|
9538
|
-
|
|
9718
|
+
PhoneNumberType: PhoneNumberType | undefined;
|
|
9539
9719
|
/**
|
|
9540
|
-
* <p>
|
|
9720
|
+
* <p>The prefix of the phone number. If provided, it must contain <code>+</code> as part of the country code.</p>
|
|
9541
9721
|
* @public
|
|
9542
9722
|
*/
|
|
9543
|
-
|
|
9723
|
+
PhoneNumberPrefix?: string | undefined;
|
|
9544
9724
|
/**
|
|
9545
|
-
* <p>The
|
|
9725
|
+
* <p>The maximum number of results to return per page.</p>
|
|
9546
9726
|
* @public
|
|
9547
9727
|
*/
|
|
9548
|
-
|
|
9728
|
+
MaxResults?: number | undefined;
|
|
9549
9729
|
/**
|
|
9550
|
-
* <p>
|
|
9730
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
9731
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
9551
9732
|
* @public
|
|
9552
9733
|
*/
|
|
9553
|
-
|
|
9734
|
+
NextToken?: string | undefined;
|
|
9735
|
+
}
|
|
9736
|
+
/**
|
|
9737
|
+
* <p>Information about available phone numbers.</p>
|
|
9738
|
+
* @public
|
|
9739
|
+
*/
|
|
9740
|
+
export interface AvailableNumberSummary {
|
|
9554
9741
|
/**
|
|
9555
|
-
* <p>The
|
|
9742
|
+
* <p>The phone number. Phone numbers are formatted <code>[+] [country code] [subscriber number including area code]</code>.</p>
|
|
9556
9743
|
* @public
|
|
9557
9744
|
*/
|
|
9558
|
-
|
|
9745
|
+
PhoneNumber?: string | undefined;
|
|
9559
9746
|
/**
|
|
9560
|
-
* <p>The
|
|
9747
|
+
* <p>The ISO country code.</p>
|
|
9561
9748
|
* @public
|
|
9562
9749
|
*/
|
|
9563
|
-
|
|
9750
|
+
PhoneNumberCountryCode?: PhoneNumberCountryCode | undefined;
|
|
9564
9751
|
/**
|
|
9565
|
-
* <p>The
|
|
9752
|
+
* <p>The type of phone number.</p>
|
|
9566
9753
|
* @public
|
|
9567
9754
|
*/
|
|
9568
|
-
|
|
9755
|
+
PhoneNumberType?: PhoneNumberType | undefined;
|
|
9569
9756
|
}
|
|
9570
9757
|
/**
|
|
9571
9758
|
* @public
|
|
9572
9759
|
*/
|
|
9573
|
-
export interface
|
|
9574
|
-
/**
|
|
9575
|
-
* <p>Contains information about contact evaluations.</p>
|
|
9576
|
-
* @public
|
|
9577
|
-
*/
|
|
9578
|
-
EvaluationSearchSummaryList?: EvaluationSearchSummary[] | undefined;
|
|
9760
|
+
export interface SearchAvailablePhoneNumbersResponse {
|
|
9579
9761
|
/**
|
|
9580
9762
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
9581
9763
|
* @public
|
|
9582
9764
|
*/
|
|
9583
9765
|
NextToken?: string | undefined;
|
|
9584
9766
|
/**
|
|
9585
|
-
* <p>
|
|
9767
|
+
* <p>A list of available phone numbers that you can claim to your Connect Customer instance or traffic distribution group.</p>
|
|
9586
9768
|
* @public
|
|
9587
9769
|
*/
|
|
9588
|
-
|
|
9770
|
+
AvailableNumbersList?: AvailableNumberSummary[] | undefined;
|
|
9589
9771
|
}
|
|
9590
9772
|
/**
|
|
9591
|
-
* <p>
|
|
9592
|
-
* <code>OR</code> of <code>AND</code> (List of List) input where:</p>
|
|
9593
|
-
* <ul>
|
|
9594
|
-
* <li>
|
|
9595
|
-
* <p>Top level list specifies conditions that need to be applied with <code>OR</code> operator</p>
|
|
9596
|
-
* </li>
|
|
9597
|
-
* <li>
|
|
9598
|
-
* <p>Inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
|
|
9599
|
-
* </li>
|
|
9600
|
-
* </ul>
|
|
9773
|
+
* <p>A boolean search condition for Search APIs.</p>
|
|
9601
9774
|
* @public
|
|
9602
9775
|
*/
|
|
9603
|
-
export interface
|
|
9604
|
-
/**
|
|
9605
|
-
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
9606
|
-
* @public
|
|
9607
|
-
*/
|
|
9608
|
-
OrConditions?: TagCondition[][] | undefined;
|
|
9776
|
+
export interface BooleanCondition {
|
|
9609
9777
|
/**
|
|
9610
|
-
* <p>A
|
|
9778
|
+
* <p>A name of the property to be searched.</p>
|
|
9611
9779
|
* @public
|
|
9612
9780
|
*/
|
|
9613
|
-
|
|
9781
|
+
FieldName?: string | undefined;
|
|
9614
9782
|
/**
|
|
9615
|
-
* <p>
|
|
9783
|
+
* <p>Boolean property comparison type.</p>
|
|
9616
9784
|
* @public
|
|
9617
9785
|
*/
|
|
9618
|
-
|
|
9786
|
+
ComparisonType?: BooleanComparisonType | undefined;
|
|
9619
9787
|
}
|
|
9620
9788
|
/**
|
|
9621
|
-
* <p>
|
|
9789
|
+
* <p>A datetime search condition for Search APIs.</p>
|
|
9622
9790
|
* @public
|
|
9623
9791
|
*/
|
|
9624
|
-
export interface
|
|
9792
|
+
export interface DateTimeCondition {
|
|
9625
9793
|
/**
|
|
9626
|
-
* <p>
|
|
9627
|
-
* <code>OR</code> of <code>AND</code> (List of List) input where:</p>
|
|
9628
|
-
* <ul>
|
|
9629
|
-
* <li>
|
|
9630
|
-
* <p>Top level list specifies conditions that need to be applied with <code>OR</code> operator</p>
|
|
9631
|
-
* </li>
|
|
9632
|
-
* <li>
|
|
9633
|
-
* <p>Inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
|
|
9634
|
-
* </li>
|
|
9635
|
-
* </ul>
|
|
9794
|
+
* <p>A name of the datetime property to be searched</p>
|
|
9636
9795
|
* @public
|
|
9637
9796
|
*/
|
|
9638
|
-
|
|
9639
|
-
}
|
|
9640
|
-
/**
|
|
9641
|
-
* @public
|
|
9642
|
-
*/
|
|
9643
|
-
export interface SearchContactFlowModulesResponse {
|
|
9797
|
+
FieldName?: string | undefined;
|
|
9644
9798
|
/**
|
|
9645
|
-
* <p>
|
|
9799
|
+
* <p>A minimum value of the property.</p>
|
|
9646
9800
|
* @public
|
|
9647
9801
|
*/
|
|
9648
|
-
|
|
9802
|
+
MinValue?: string | undefined;
|
|
9649
9803
|
/**
|
|
9650
|
-
* <p>
|
|
9804
|
+
* <p>A maximum value of the property.</p>
|
|
9651
9805
|
* @public
|
|
9652
9806
|
*/
|
|
9653
|
-
|
|
9807
|
+
MaxValue?: string | undefined;
|
|
9654
9808
|
/**
|
|
9655
|
-
* <p>
|
|
9809
|
+
* <p>Datetime property comparison type.</p>
|
|
9656
9810
|
* @public
|
|
9657
9811
|
*/
|
|
9658
|
-
|
|
9812
|
+
ComparisonType?: DateTimeComparisonType | undefined;
|
|
9659
9813
|
}
|
|
9660
9814
|
/**
|
|
9661
|
-
* <p>
|
|
9815
|
+
* <p>A decimal search condition for Search APIs.</p>
|
|
9662
9816
|
* @public
|
|
9663
9817
|
*/
|
|
9664
|
-
export interface
|
|
9818
|
+
export interface DecimalCondition {
|
|
9665
9819
|
/**
|
|
9666
|
-
* <p>
|
|
9820
|
+
* <p>A name of the decimal property to be searched.</p>
|
|
9667
9821
|
* @public
|
|
9668
9822
|
*/
|
|
9669
|
-
|
|
9670
|
-
|
|
9671
|
-
|
|
9672
|
-
|
|
9673
|
-
|
|
9674
|
-
|
|
9675
|
-
export interface ContactFlowAttributeAndCondition {
|
|
9823
|
+
FieldName?: string | undefined;
|
|
9824
|
+
/**
|
|
9825
|
+
* <p>A minimum value of the decimal property.</p>
|
|
9826
|
+
* @public
|
|
9827
|
+
*/
|
|
9828
|
+
MinValue?: number | undefined;
|
|
9676
9829
|
/**
|
|
9677
|
-
* <p>
|
|
9830
|
+
* <p>A maximum value of the decimal property.</p>
|
|
9678
9831
|
* @public
|
|
9679
9832
|
*/
|
|
9680
|
-
|
|
9833
|
+
MaxValue?: number | undefined;
|
|
9681
9834
|
/**
|
|
9682
|
-
* <p>
|
|
9835
|
+
* <p>The type of comparison to be made when evaluating the decimal condition.</p>
|
|
9683
9836
|
* @public
|
|
9684
9837
|
*/
|
|
9685
|
-
|
|
9838
|
+
ComparisonType?: DecimalComparisonType | undefined;
|
|
9686
9839
|
}
|
|
9687
9840
|
/**
|
|
9688
|
-
* <p>
|
|
9841
|
+
* <p>A leaf node condition which can be used to specify a numeric condition.</p>
|
|
9842
|
+
* <note>
|
|
9843
|
+
* <p>The currently supported value for <code>FieldName</code> is <code>limit</code>.</p>
|
|
9844
|
+
* </note>
|
|
9689
9845
|
* @public
|
|
9690
9846
|
*/
|
|
9691
|
-
export interface
|
|
9692
|
-
/**
|
|
9693
|
-
* <p> A list of conditions which would be applied together with an OR condition.</p>
|
|
9694
|
-
* @public
|
|
9695
|
-
*/
|
|
9696
|
-
OrConditions?: ContactFlowAttributeAndCondition[] | undefined;
|
|
9697
|
-
/**
|
|
9698
|
-
* <p> A list of conditions which would be applied together with a AND condition.</p>
|
|
9699
|
-
* @public
|
|
9700
|
-
*/
|
|
9701
|
-
AndCondition?: ContactFlowAttributeAndCondition | undefined;
|
|
9847
|
+
export interface NumberCondition {
|
|
9702
9848
|
/**
|
|
9703
|
-
* <p>
|
|
9704
|
-
* </p>
|
|
9849
|
+
* <p>The name of the field in the number condition.</p>
|
|
9705
9850
|
* @public
|
|
9706
9851
|
*/
|
|
9707
|
-
|
|
9852
|
+
FieldName?: string | undefined;
|
|
9708
9853
|
/**
|
|
9709
|
-
* <p>
|
|
9854
|
+
* <p>The minValue to be used while evaluating the number condition.</p>
|
|
9710
9855
|
* @public
|
|
9711
9856
|
*/
|
|
9712
|
-
|
|
9713
|
-
}
|
|
9714
|
-
/**
|
|
9715
|
-
* <p>Filters to be applied to search results.</p>
|
|
9716
|
-
* @public
|
|
9717
|
-
*/
|
|
9718
|
-
export interface ContactFlowSearchFilter {
|
|
9857
|
+
MinValue?: number | undefined;
|
|
9719
9858
|
/**
|
|
9720
|
-
* <p>
|
|
9721
|
-
* <code>OR</code> of <code>AND</code> (List of List) input where:</p>
|
|
9722
|
-
* <ul>
|
|
9723
|
-
* <li>
|
|
9724
|
-
* <p>Top level list specifies conditions that need to be applied with <code>OR</code> operator</p>
|
|
9725
|
-
* </li>
|
|
9726
|
-
* <li>
|
|
9727
|
-
* <p>Inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
|
|
9728
|
-
* </li>
|
|
9729
|
-
* </ul>
|
|
9859
|
+
* <p>The maxValue to be used while evaluating the number condition.</p>
|
|
9730
9860
|
* @public
|
|
9731
9861
|
*/
|
|
9732
|
-
|
|
9862
|
+
MaxValue?: number | undefined;
|
|
9733
9863
|
/**
|
|
9734
|
-
* <p>
|
|
9864
|
+
* <p>The type of comparison to be made when evaluating the number condition.</p>
|
|
9735
9865
|
* @public
|
|
9736
9866
|
*/
|
|
9737
|
-
|
|
9867
|
+
ComparisonType?: NumberComparisonType | undefined;
|
|
9738
9868
|
}
|