@aws-sdk/client-connect 3.989.0 → 3.990.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 +56 -0
- package/dist-cjs/index.js +149 -0
- package/dist-cjs/schemas/schemas_0.js +222 -36
- package/dist-es/Connect.js +16 -0
- package/dist-es/commands/CreateNotificationCommand.js +16 -0
- package/dist-es/commands/DeleteNotificationCommand.js +16 -0
- package/dist-es/commands/DescribeNotificationCommand.js +16 -0
- package/dist-es/commands/ListNotificationsCommand.js +16 -0
- package/dist-es/commands/ListUserNotificationsCommand.js +16 -0
- package/dist-es/commands/SearchNotificationsCommand.js +16 -0
- package/dist-es/commands/UpdateNotificationContentCommand.js +16 -0
- package/dist-es/commands/UpdateUserNotificationStatusCommand.js +16 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/enums.js +32 -0
- package/dist-es/schemas/schemas_0.js +194 -9
- package/dist-types/Connect.d.ts +56 -0
- package/dist-types/ConnectClient.d.ts +10 -2
- package/dist-types/commands/CreateNotificationCommand.d.ts +109 -0
- package/dist-types/commands/DeleteNotificationCommand.d.ts +91 -0
- package/dist-types/commands/DescribeNotificationCommand.d.ts +110 -0
- package/dist-types/commands/GetTrafficDistributionCommand.d.ts +2 -1
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/ImportWorkspaceMediaCommand.d.ts +1 -1
- package/dist-types/commands/ListNotificationsCommand.d.ts +114 -0
- package/dist-types/commands/ListUserNotificationsCommand.d.ts +110 -0
- package/dist-types/commands/SearchNotificationsCommand.d.ts +165 -0
- package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +1 -2
- package/dist-types/commands/SearchUsersCommand.d.ts +1 -2
- package/dist-types/commands/SearchViewsCommand.d.ts +1 -2
- package/dist-types/commands/SearchVocabulariesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateNotificationContentCommand.d.ts +94 -0
- package/dist-types/commands/UpdateUserNotificationStatusCommand.d.ts +95 -0
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/models/enums.d.ts +72 -0
- package/dist-types/models/models_0.d.ts +64 -48
- package/dist-types/models/models_1.d.ts +151 -140
- package/dist-types/models/models_2.d.ts +402 -469
- package/dist-types/models/models_3.d.ts +545 -4
- package/dist-types/schemas/schemas_0.d.ts +29 -0
- package/dist-types/ts3.4/Connect.d.ts +136 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +48 -0
- package/dist-types/ts3.4/commands/CreateNotificationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteNotificationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeNotificationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetTrafficDistributionCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ImportPhoneNumberCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ImportWorkspaceMediaCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListNotificationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListUserNotificationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SearchNotificationsCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/SearchUserHierarchyGroupsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/SearchViewsCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/SearchVocabulariesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateNotificationContentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateUserNotificationStatusCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/enums.d.ts +41 -0
- package/dist-types/ts3.4/models/models_0.d.ts +16 -11
- package/dist-types/ts3.4/models/models_1.d.ts +40 -34
- package/dist-types/ts3.4/models/models_2.d.ts +90 -98
- package/dist-types/ts3.4/models/models_3.d.ts +126 -7
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +29 -0
- package/package.json +6 -6
|
@@ -1,6 +1,144 @@
|
|
|
1
|
-
import { AgentStatusType, ArtifactStatus, AutoEvaluationStatus, BooleanComparisonType, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DateComparisonType, DateTimeComparisonType, DecimalComparisonType, DirectoryType, EntityType, EvaluationFormLanguageCode, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, EventSourceName, ExecutionRecordStatus,
|
|
2
|
-
import { type AgentHierarchyGroups, type ControlPlaneAttributeFilter, type DataTableLockVersion, type LexV2Bot,
|
|
3
|
-
import { type EvaluationContactParticipant, type EvaluationScore, Attribute, ContactFlow, ContactFlowModule, DataTable, DataTableAttribute,
|
|
1
|
+
import { AgentStatusType, ArtifactStatus, AutoEvaluationStatus, BooleanComparisonType, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DateComparisonType, DateTimeComparisonType, DecimalComparisonType, DirectoryType, EntityType, EvaluationFormLanguageCode, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, EventSourceName, ExecutionRecordStatus, InstanceStatus, InstanceStorageResourceType, IntegrationType, LexVersion, ListFlowAssociationResourceType, LocaleCode, MediaType, MonitorCapability, NotificationPriority, NotificationSource, NotificationStatus, NumberComparisonType, ParticipantRole, PhoneNumberCountryCode, PhoneNumberType, QueueType, QuickConnectType, RealTimeContactAnalysisOutputType, RealTimeContactAnalysisPostContactSummaryFailureCode, RealTimeContactAnalysisPostContactSummaryStatus, RealTimeContactAnalysisSegmentType, RealTimeContactAnalysisSentimentLabel, RealTimeContactAnalysisStatus, RealTimeContactAnalysisSupportedChannel, ReferenceStatus, ReferenceType, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SortableFieldName, SortOrder, SourceType, StringComparisonType, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TrafficDistributionGroupStatus, UseCaseType, ViewStatus, ViewType, VocabularyLanguageCode } from "./enums";
|
|
2
|
+
import { type AgentConfig, type AgentHierarchyGroups, type ControlPlaneAttributeFilter, type DataTableLockVersion, type LexV2Bot, ActionSummary, AgentStatus, AgentStatusSummary, AliasConfiguration, AnalyticsDataAssociationResult, Application, Distribution, FlowAssociationSummary, FlowModule, InstanceStorageConfig, LexBot, PrimaryValueResponse, SecurityProfileItem, TagCondition, UserProficiency } from "./models_0";
|
|
3
|
+
import { type EvaluationContactParticipant, type EvaluationScore, Attribute, ContactFlow, ContactFlowModule, DataTable, DataTableAttribute, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationOverride, HoursOfOperationsIdentifier, Notification, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, SignInDistribution, TestCase } from "./models_1";
|
|
4
|
+
/**
|
|
5
|
+
* <p>The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both
|
|
6
|
+
* the instance and its replica(s).</p>
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export interface SignInConfig {
|
|
10
|
+
/**
|
|
11
|
+
* <p>Information about traffic distributions.</p>
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
Distributions: SignInDistribution[] | undefined;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* <p>The distribution of traffic between the instance and its replicas.</p>
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export interface TelephonyConfig {
|
|
21
|
+
/**
|
|
22
|
+
* <p>Information about traffic distributions.</p>
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
Distributions: Distribution[] | undefined;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
export interface GetTrafficDistributionResponse {
|
|
31
|
+
/**
|
|
32
|
+
* <p>The distribution of traffic between the instance and its replicas.</p>
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
TelephonyConfig?: TelephonyConfig | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* <p>The identifier of the traffic distribution group.
|
|
38
|
+
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
39
|
+
* The ARN must be provided if the call is from the replicated Region.</p>
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
Id?: string | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
Arn?: string | undefined;
|
|
48
|
+
/**
|
|
49
|
+
* <p>The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both
|
|
50
|
+
* the instance and its replica(s).</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
SignInConfig?: SignInConfig | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* <p>The distribution of agents between the instance and its replica(s).</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
AgentConfig?: AgentConfig | undefined;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
export interface ImportPhoneNumberRequest {
|
|
64
|
+
/**
|
|
65
|
+
* <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>
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
InstanceId: string | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* <p>The claimed phone number ARN being imported from the external service, such as Amazon Web Services End User
|
|
71
|
+
* Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number to import
|
|
72
|
+
* from Amazon Web Services End User Messaging.</p>
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
SourcePhoneNumberArn: string | undefined;
|
|
76
|
+
/**
|
|
77
|
+
* <p>The description of the phone number.</p>
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
PhoneNumberDescription?: string | undefined;
|
|
81
|
+
/**
|
|
82
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
Tags?: Record<string, string> | undefined;
|
|
86
|
+
/**
|
|
87
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
88
|
+
* request. If not provided, the Amazon Web Services
|
|
89
|
+
* SDK populates this field. For more information about idempotency, see
|
|
90
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
ClientToken?: string | undefined;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export interface ImportPhoneNumberResponse {
|
|
99
|
+
/**
|
|
100
|
+
* <p>A unique identifier for the phone number.</p>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
PhoneNumberId?: string | undefined;
|
|
104
|
+
/**
|
|
105
|
+
* <p>The Amazon Resource Name (ARN) of the phone number.</p>
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
PhoneNumberArn?: string | undefined;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
export interface ImportWorkspaceMediaRequest {
|
|
114
|
+
/**
|
|
115
|
+
* <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
|
|
116
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
InstanceId: string | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* <p>The identifier of the workspace.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
WorkspaceId: string | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* <p>The type of media. Valid values are: <code>IMAGE_LOGO_FAVICON</code> and
|
|
127
|
+
* <code>IMAGE_LOGO_HORIZONTAL</code>.</p>
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
MediaType: MediaType | undefined;
|
|
131
|
+
/**
|
|
132
|
+
* <p>The media source. Can be an S3 presigned URL or a base64-encoded string.</p>
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
MediaSource: string | undefined;
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
export interface ImportWorkspaceMediaResponse {
|
|
141
|
+
}
|
|
4
142
|
/**
|
|
5
143
|
* @public
|
|
6
144
|
*/
|
|
@@ -2385,6 +2523,41 @@ export interface ListLexBotsResponse {
|
|
|
2385
2523
|
*/
|
|
2386
2524
|
NextToken?: string | undefined;
|
|
2387
2525
|
}
|
|
2526
|
+
/**
|
|
2527
|
+
* @public
|
|
2528
|
+
*/
|
|
2529
|
+
export interface ListNotificationsRequest {
|
|
2530
|
+
/**
|
|
2531
|
+
* <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>
|
|
2532
|
+
* @public
|
|
2533
|
+
*/
|
|
2534
|
+
InstanceId: string | undefined;
|
|
2535
|
+
/**
|
|
2536
|
+
* <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>
|
|
2537
|
+
* @public
|
|
2538
|
+
*/
|
|
2539
|
+
NextToken?: string | undefined;
|
|
2540
|
+
/**
|
|
2541
|
+
* <p>The maximum number of results to return per page. Valid range is 1-100.</p>
|
|
2542
|
+
* @public
|
|
2543
|
+
*/
|
|
2544
|
+
MaxResults?: number | undefined;
|
|
2545
|
+
}
|
|
2546
|
+
/**
|
|
2547
|
+
* @public
|
|
2548
|
+
*/
|
|
2549
|
+
export interface ListNotificationsResponse {
|
|
2550
|
+
/**
|
|
2551
|
+
* <p>The token for the next set of results. If present, there are more results available.</p>
|
|
2552
|
+
* @public
|
|
2553
|
+
*/
|
|
2554
|
+
NextToken?: string | undefined;
|
|
2555
|
+
/**
|
|
2556
|
+
* <p>A list of notification summaries.</p>
|
|
2557
|
+
* @public
|
|
2558
|
+
*/
|
|
2559
|
+
NotificationSummaryList: Notification[] | undefined;
|
|
2560
|
+
}
|
|
2388
2561
|
/**
|
|
2389
2562
|
* @public
|
|
2390
2563
|
*/
|
|
@@ -4686,6 +4859,97 @@ export interface ListUserHierarchyGroupsResponse {
|
|
|
4686
4859
|
*/
|
|
4687
4860
|
NextToken?: string | undefined;
|
|
4688
4861
|
}
|
|
4862
|
+
/**
|
|
4863
|
+
* @public
|
|
4864
|
+
*/
|
|
4865
|
+
export interface ListUserNotificationsRequest {
|
|
4866
|
+
/**
|
|
4867
|
+
* <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>
|
|
4868
|
+
* @public
|
|
4869
|
+
*/
|
|
4870
|
+
InstanceId: string | undefined;
|
|
4871
|
+
/**
|
|
4872
|
+
* <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>
|
|
4873
|
+
* @public
|
|
4874
|
+
*/
|
|
4875
|
+
NextToken?: string | undefined;
|
|
4876
|
+
/**
|
|
4877
|
+
* <p>The maximum number of results to return per page. Valid range is 1-1000.</p>
|
|
4878
|
+
* @public
|
|
4879
|
+
*/
|
|
4880
|
+
MaxResults?: number | undefined;
|
|
4881
|
+
/**
|
|
4882
|
+
* <p>The identifier of the user.</p>
|
|
4883
|
+
* @public
|
|
4884
|
+
*/
|
|
4885
|
+
UserId: string | undefined;
|
|
4886
|
+
}
|
|
4887
|
+
/**
|
|
4888
|
+
* <p>Summary information about a notification for a specific user, including the user's read status.</p>
|
|
4889
|
+
* @public
|
|
4890
|
+
*/
|
|
4891
|
+
export interface UserNotificationSummary {
|
|
4892
|
+
/**
|
|
4893
|
+
* <p>The unique identifier for the notification.</p>
|
|
4894
|
+
* @public
|
|
4895
|
+
*/
|
|
4896
|
+
NotificationId?: string | undefined;
|
|
4897
|
+
/**
|
|
4898
|
+
* <p>The status of the notification for this user. Valid values are READ, UNREAD, and HIDDEN.</p>
|
|
4899
|
+
* @public
|
|
4900
|
+
*/
|
|
4901
|
+
NotificationStatus?: NotificationStatus | undefined;
|
|
4902
|
+
/**
|
|
4903
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
4904
|
+
* @public
|
|
4905
|
+
*/
|
|
4906
|
+
InstanceId?: string | undefined;
|
|
4907
|
+
/**
|
|
4908
|
+
* <p>The identifier of the recipient user.</p>
|
|
4909
|
+
* @public
|
|
4910
|
+
*/
|
|
4911
|
+
RecipientId?: string | undefined;
|
|
4912
|
+
/**
|
|
4913
|
+
* <p>The localized content of the notification.</p>
|
|
4914
|
+
* @public
|
|
4915
|
+
*/
|
|
4916
|
+
Content?: Partial<Record<LocaleCode, string>> | undefined;
|
|
4917
|
+
/**
|
|
4918
|
+
* <p>The priority level of the notification.</p>
|
|
4919
|
+
* @public
|
|
4920
|
+
*/
|
|
4921
|
+
Priority?: NotificationPriority | undefined;
|
|
4922
|
+
/**
|
|
4923
|
+
* <p>The source that created the notification. Valid values are CUSTOMER, RULES, and SYSTEM.</p>
|
|
4924
|
+
* @public
|
|
4925
|
+
*/
|
|
4926
|
+
Source?: NotificationSource | undefined;
|
|
4927
|
+
/**
|
|
4928
|
+
* <p>The timestamp when the notification was created.</p>
|
|
4929
|
+
* @public
|
|
4930
|
+
*/
|
|
4931
|
+
CreatedAt?: Date | undefined;
|
|
4932
|
+
/**
|
|
4933
|
+
* <p>The timestamp when the notification expires.</p>
|
|
4934
|
+
* @public
|
|
4935
|
+
*/
|
|
4936
|
+
ExpiresAt?: Date | undefined;
|
|
4937
|
+
}
|
|
4938
|
+
/**
|
|
4939
|
+
* @public
|
|
4940
|
+
*/
|
|
4941
|
+
export interface ListUserNotificationsResponse {
|
|
4942
|
+
/**
|
|
4943
|
+
* <p>A list of notifications sent to the specified user.</p>
|
|
4944
|
+
* @public
|
|
4945
|
+
*/
|
|
4946
|
+
UserNotifications?: UserNotificationSummary[] | undefined;
|
|
4947
|
+
/**
|
|
4948
|
+
* <p>The token for the next set of results. If present, there are more results available.</p>
|
|
4949
|
+
* @public
|
|
4950
|
+
*/
|
|
4951
|
+
NextToken?: string | undefined;
|
|
4952
|
+
}
|
|
4689
4953
|
/**
|
|
4690
4954
|
* @public
|
|
4691
4955
|
*/
|
|
@@ -6669,73 +6933,165 @@ export interface SearchHoursOfOperationsResponse {
|
|
|
6669
6933
|
ApproximateTotalCount?: number | undefined;
|
|
6670
6934
|
}
|
|
6671
6935
|
/**
|
|
6936
|
+
* <p>Filters to apply when searching for notifications.</p>
|
|
6672
6937
|
* @public
|
|
6673
6938
|
*/
|
|
6674
|
-
export interface
|
|
6939
|
+
export interface NotificationSearchFilter {
|
|
6675
6940
|
/**
|
|
6676
|
-
* <p>
|
|
6941
|
+
* <p>Attribute-based filters to apply to the search results.</p>
|
|
6677
6942
|
* @public
|
|
6678
6943
|
*/
|
|
6679
|
-
|
|
6944
|
+
AttributeFilter?: ControlPlaneAttributeFilter | undefined;
|
|
6945
|
+
}
|
|
6946
|
+
/**
|
|
6947
|
+
* <p>Summary information about a notification returned from a search operation.</p>
|
|
6948
|
+
* @public
|
|
6949
|
+
*/
|
|
6950
|
+
export interface NotificationSearchSummary {
|
|
6680
6951
|
/**
|
|
6681
|
-
* <p>The
|
|
6682
|
-
* retrieve the next set of results.</p>
|
|
6952
|
+
* <p>The unique identifier for the notification.</p>
|
|
6683
6953
|
* @public
|
|
6684
6954
|
*/
|
|
6685
|
-
|
|
6955
|
+
Id?: string | undefined;
|
|
6686
6956
|
/**
|
|
6687
|
-
* <p>The
|
|
6957
|
+
* <p>The Amazon Resource Name (ARN) of the notification.</p>
|
|
6688
6958
|
* @public
|
|
6689
6959
|
*/
|
|
6690
|
-
|
|
6691
|
-
}
|
|
6692
|
-
/**
|
|
6693
|
-
* <p>Filters to be applied to search results.</p>
|
|
6694
|
-
* @public
|
|
6695
|
-
*/
|
|
6696
|
-
export interface PromptSearchFilter {
|
|
6960
|
+
Arn?: string | undefined;
|
|
6697
6961
|
/**
|
|
6698
|
-
* <p>
|
|
6699
|
-
* <code>OR</code> of <code>AND</code> (List of List) input where:</p>
|
|
6700
|
-
* <ul>
|
|
6701
|
-
* <li>
|
|
6702
|
-
* <p>Top level list specifies conditions that need to be applied with <code>OR</code> operator</p>
|
|
6703
|
-
* </li>
|
|
6704
|
-
* <li>
|
|
6705
|
-
* <p>Inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
|
|
6706
|
-
* </li>
|
|
6707
|
-
* </ul>
|
|
6962
|
+
* <p>The identifier of the Amazon Connect instance.</p>
|
|
6708
6963
|
* @public
|
|
6709
6964
|
*/
|
|
6710
|
-
|
|
6711
|
-
}
|
|
6712
|
-
/**
|
|
6713
|
-
* @public
|
|
6714
|
-
*/
|
|
6715
|
-
export interface SearchPromptsResponse {
|
|
6965
|
+
InstanceId?: string | undefined;
|
|
6716
6966
|
/**
|
|
6717
|
-
* <p>
|
|
6967
|
+
* <p>The localized content of the notification.</p>
|
|
6718
6968
|
* @public
|
|
6719
6969
|
*/
|
|
6720
|
-
|
|
6970
|
+
Content?: Partial<Record<LocaleCode, string>> | undefined;
|
|
6721
6971
|
/**
|
|
6722
|
-
* <p>
|
|
6972
|
+
* <p>The priority level of the notification.</p>
|
|
6723
6973
|
* @public
|
|
6724
6974
|
*/
|
|
6725
|
-
|
|
6975
|
+
Priority?: NotificationPriority | undefined;
|
|
6726
6976
|
/**
|
|
6727
|
-
* <p>
|
|
6977
|
+
* <p>A list of recipient Amazon Resource Names (ARNs).</p>
|
|
6728
6978
|
* @public
|
|
6729
6979
|
*/
|
|
6730
|
-
|
|
6731
|
-
}
|
|
6732
|
-
/**
|
|
6733
|
-
* <p>Filters to be applied to search results.</p>
|
|
6734
|
-
* @public
|
|
6735
|
-
*/
|
|
6736
|
-
export interface QueueSearchFilter {
|
|
6980
|
+
Recipients?: string[] | undefined;
|
|
6737
6981
|
/**
|
|
6738
|
-
* <p>
|
|
6982
|
+
* <p>The timestamp when the notification was created.</p>
|
|
6983
|
+
* @public
|
|
6984
|
+
*/
|
|
6985
|
+
CreatedAt?: Date | undefined;
|
|
6986
|
+
/**
|
|
6987
|
+
* <p>The timestamp when the notification expires.</p>
|
|
6988
|
+
* @public
|
|
6989
|
+
*/
|
|
6990
|
+
ExpiresAt?: Date | undefined;
|
|
6991
|
+
/**
|
|
6992
|
+
* <p>The AWS Region where the notification was last modified.</p>
|
|
6993
|
+
* @public
|
|
6994
|
+
*/
|
|
6995
|
+
LastModifiedRegion?: string | undefined;
|
|
6996
|
+
/**
|
|
6997
|
+
* <p>The timestamp when the notification was last modified.</p>
|
|
6998
|
+
* @public
|
|
6999
|
+
*/
|
|
7000
|
+
LastModifiedTime?: Date | undefined;
|
|
7001
|
+
/**
|
|
7002
|
+
* <p>The tags associated with the notification.</p>
|
|
7003
|
+
* @public
|
|
7004
|
+
*/
|
|
7005
|
+
Tags?: Record<string, string> | undefined;
|
|
7006
|
+
}
|
|
7007
|
+
/**
|
|
7008
|
+
* @public
|
|
7009
|
+
*/
|
|
7010
|
+
export interface SearchNotificationsResponse {
|
|
7011
|
+
/**
|
|
7012
|
+
* <p>A list of notifications matching the search criteria.</p>
|
|
7013
|
+
* @public
|
|
7014
|
+
*/
|
|
7015
|
+
Notifications?: NotificationSearchSummary[] | undefined;
|
|
7016
|
+
/**
|
|
7017
|
+
* <p>The token for the next set of results. If present, there are more results available.</p>
|
|
7018
|
+
* @public
|
|
7019
|
+
*/
|
|
7020
|
+
NextToken?: string | undefined;
|
|
7021
|
+
/**
|
|
7022
|
+
* <p>The approximate total number of notifications matching the search criteria.</p>
|
|
7023
|
+
* @public
|
|
7024
|
+
*/
|
|
7025
|
+
ApproximateTotalCount?: number | undefined;
|
|
7026
|
+
}
|
|
7027
|
+
/**
|
|
7028
|
+
* @public
|
|
7029
|
+
*/
|
|
7030
|
+
export interface SearchPredefinedAttributesResponse {
|
|
7031
|
+
/**
|
|
7032
|
+
* <p>Predefined attributes matched by the search criteria.</p>
|
|
7033
|
+
* @public
|
|
7034
|
+
*/
|
|
7035
|
+
PredefinedAttributes?: PredefinedAttribute[] | undefined;
|
|
7036
|
+
/**
|
|
7037
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
7038
|
+
* retrieve the next set of results.</p>
|
|
7039
|
+
* @public
|
|
7040
|
+
*/
|
|
7041
|
+
NextToken?: string | undefined;
|
|
7042
|
+
/**
|
|
7043
|
+
* <p>The approximate number of predefined attributes which matched your search query.</p>
|
|
7044
|
+
* @public
|
|
7045
|
+
*/
|
|
7046
|
+
ApproximateTotalCount?: number | undefined;
|
|
7047
|
+
}
|
|
7048
|
+
/**
|
|
7049
|
+
* <p>Filters to be applied to search results.</p>
|
|
7050
|
+
* @public
|
|
7051
|
+
*/
|
|
7052
|
+
export interface PromptSearchFilter {
|
|
7053
|
+
/**
|
|
7054
|
+
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an
|
|
7055
|
+
* <code>OR</code> of <code>AND</code> (List of List) input where:</p>
|
|
7056
|
+
* <ul>
|
|
7057
|
+
* <li>
|
|
7058
|
+
* <p>Top level list specifies conditions that need to be applied with <code>OR</code> operator</p>
|
|
7059
|
+
* </li>
|
|
7060
|
+
* <li>
|
|
7061
|
+
* <p>Inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
|
|
7062
|
+
* </li>
|
|
7063
|
+
* </ul>
|
|
7064
|
+
* @public
|
|
7065
|
+
*/
|
|
7066
|
+
TagFilter?: ControlPlaneTagFilter | undefined;
|
|
7067
|
+
}
|
|
7068
|
+
/**
|
|
7069
|
+
* @public
|
|
7070
|
+
*/
|
|
7071
|
+
export interface SearchPromptsResponse {
|
|
7072
|
+
/**
|
|
7073
|
+
* <p>Information about the prompts.</p>
|
|
7074
|
+
* @public
|
|
7075
|
+
*/
|
|
7076
|
+
Prompts?: Prompt[] | undefined;
|
|
7077
|
+
/**
|
|
7078
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7079
|
+
* @public
|
|
7080
|
+
*/
|
|
7081
|
+
NextToken?: string | undefined;
|
|
7082
|
+
/**
|
|
7083
|
+
* <p>The total number of quick connects which matched your search query.</p>
|
|
7084
|
+
* @public
|
|
7085
|
+
*/
|
|
7086
|
+
ApproximateTotalCount?: number | undefined;
|
|
7087
|
+
}
|
|
7088
|
+
/**
|
|
7089
|
+
* <p>Filters to be applied to search results.</p>
|
|
7090
|
+
* @public
|
|
7091
|
+
*/
|
|
7092
|
+
export interface QueueSearchFilter {
|
|
7093
|
+
/**
|
|
7094
|
+
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an
|
|
6739
7095
|
* <code>OR</code> of <code>AND</code> (List of List) input where:</p>
|
|
6740
7096
|
* <ul>
|
|
6741
7097
|
* <li>
|
|
@@ -7112,426 +7468,3 @@ export interface UserHierarchyGroupSearchFilter {
|
|
|
7112
7468
|
*/
|
|
7113
7469
|
AttributeFilter?: ControlPlaneAttributeFilter | undefined;
|
|
7114
7470
|
}
|
|
7115
|
-
/**
|
|
7116
|
-
* @public
|
|
7117
|
-
*/
|
|
7118
|
-
export interface SearchUserHierarchyGroupsResponse {
|
|
7119
|
-
/**
|
|
7120
|
-
* <p>Information about the userHierarchyGroups.</p>
|
|
7121
|
-
* @public
|
|
7122
|
-
*/
|
|
7123
|
-
UserHierarchyGroups?: HierarchyGroup[] | undefined;
|
|
7124
|
-
/**
|
|
7125
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7126
|
-
* @public
|
|
7127
|
-
*/
|
|
7128
|
-
NextToken?: string | undefined;
|
|
7129
|
-
/**
|
|
7130
|
-
* <p>The total number of userHierarchyGroups which matched your search query.</p>
|
|
7131
|
-
* @public
|
|
7132
|
-
*/
|
|
7133
|
-
ApproximateTotalCount?: number | undefined;
|
|
7134
|
-
}
|
|
7135
|
-
/**
|
|
7136
|
-
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
7137
|
-
* @public
|
|
7138
|
-
*/
|
|
7139
|
-
export interface HierarchyGroupCondition {
|
|
7140
|
-
/**
|
|
7141
|
-
* <p>The value in the hierarchy group condition.</p>
|
|
7142
|
-
* @public
|
|
7143
|
-
*/
|
|
7144
|
-
Value?: string | undefined;
|
|
7145
|
-
/**
|
|
7146
|
-
* <p>The type of hierarchy group match.</p>
|
|
7147
|
-
* @public
|
|
7148
|
-
*/
|
|
7149
|
-
HierarchyGroupMatchType?: HierarchyGroupMatchType | undefined;
|
|
7150
|
-
}
|
|
7151
|
-
/**
|
|
7152
|
-
* <p>A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and
|
|
7153
|
-
* ProficiencyLimit.</p>
|
|
7154
|
-
* @public
|
|
7155
|
-
*/
|
|
7156
|
-
export interface Condition {
|
|
7157
|
-
/**
|
|
7158
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
7159
|
-
* <note>
|
|
7160
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code> and <code>value</code>.</p>
|
|
7161
|
-
* </note>
|
|
7162
|
-
* @public
|
|
7163
|
-
*/
|
|
7164
|
-
StringCondition?: StringCondition | undefined;
|
|
7165
|
-
/**
|
|
7166
|
-
* <p>A leaf node condition which can be used to specify a numeric condition.</p>
|
|
7167
|
-
* @public
|
|
7168
|
-
*/
|
|
7169
|
-
NumberCondition?: NumberCondition | undefined;
|
|
7170
|
-
}
|
|
7171
|
-
/**
|
|
7172
|
-
* <p>A leaf node condition which can be used to specify a List condition to search users with attributes included in
|
|
7173
|
-
* Lists like Proficiencies.</p>
|
|
7174
|
-
* @public
|
|
7175
|
-
*/
|
|
7176
|
-
export interface ListCondition {
|
|
7177
|
-
/**
|
|
7178
|
-
* <p>The type of target list that will be used to filter the users.</p>
|
|
7179
|
-
* @public
|
|
7180
|
-
*/
|
|
7181
|
-
TargetListType?: TargetListType | undefined;
|
|
7182
|
-
/**
|
|
7183
|
-
* <p>A list of Condition objects which would be applied together with an AND condition.</p>
|
|
7184
|
-
* @public
|
|
7185
|
-
*/
|
|
7186
|
-
Conditions?: Condition[] | undefined;
|
|
7187
|
-
}
|
|
7188
|
-
/**
|
|
7189
|
-
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
|
|
7190
|
-
* @public
|
|
7191
|
-
*/
|
|
7192
|
-
export interface AttributeAndCondition {
|
|
7193
|
-
/**
|
|
7194
|
-
* <p>A leaf node condition which can be used to specify a tag condition.</p>
|
|
7195
|
-
* @public
|
|
7196
|
-
*/
|
|
7197
|
-
TagConditions?: TagCondition[] | undefined;
|
|
7198
|
-
/**
|
|
7199
|
-
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
7200
|
-
* @public
|
|
7201
|
-
*/
|
|
7202
|
-
HierarchyGroupCondition?: HierarchyGroupCondition | undefined;
|
|
7203
|
-
}
|
|
7204
|
-
/**
|
|
7205
|
-
* <p>An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the
|
|
7206
|
-
* <code>SearchFilter</code>.</p>
|
|
7207
|
-
* <p>This accepts an <code>OR</code> of <code>AND</code> (List of List) input where:</p>
|
|
7208
|
-
* <ul>
|
|
7209
|
-
* <li>
|
|
7210
|
-
* <p>The top level list specifies conditions that need to be applied with <code>OR</code> operator</p>
|
|
7211
|
-
* </li>
|
|
7212
|
-
* <li>
|
|
7213
|
-
* <p>The inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
|
|
7214
|
-
* </li>
|
|
7215
|
-
* </ul>
|
|
7216
|
-
* <note>
|
|
7217
|
-
* <p>Only one field can be populated. Maximum number of allowed Tag conditions is 25. Maximum number of allowed
|
|
7218
|
-
* Hierarchy Group conditions is 20.</p>
|
|
7219
|
-
* </note>
|
|
7220
|
-
* @public
|
|
7221
|
-
*/
|
|
7222
|
-
export interface ControlPlaneUserAttributeFilter {
|
|
7223
|
-
/**
|
|
7224
|
-
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
7225
|
-
* @public
|
|
7226
|
-
*/
|
|
7227
|
-
OrConditions?: AttributeAndCondition[] | undefined;
|
|
7228
|
-
/**
|
|
7229
|
-
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
|
|
7230
|
-
* @public
|
|
7231
|
-
*/
|
|
7232
|
-
AndCondition?: AttributeAndCondition | undefined;
|
|
7233
|
-
/**
|
|
7234
|
-
* <p>A leaf node condition which can be used to specify a tag condition, for example, <code>HAVE BPO = 123</code>.
|
|
7235
|
-
* </p>
|
|
7236
|
-
* @public
|
|
7237
|
-
*/
|
|
7238
|
-
TagCondition?: TagCondition | undefined;
|
|
7239
|
-
/**
|
|
7240
|
-
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
7241
|
-
* @public
|
|
7242
|
-
*/
|
|
7243
|
-
HierarchyGroupCondition?: HierarchyGroupCondition | undefined;
|
|
7244
|
-
}
|
|
7245
|
-
/**
|
|
7246
|
-
* <p>Filters to be applied to search results.</p>
|
|
7247
|
-
* @public
|
|
7248
|
-
*/
|
|
7249
|
-
export interface UserSearchFilter {
|
|
7250
|
-
/**
|
|
7251
|
-
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an
|
|
7252
|
-
* <code>OR</code> of <code>AND</code> (List of List) input where:</p>
|
|
7253
|
-
* <ul>
|
|
7254
|
-
* <li>
|
|
7255
|
-
* <p>Top level list specifies conditions that need to be applied with <code>OR</code> operator</p>
|
|
7256
|
-
* </li>
|
|
7257
|
-
* <li>
|
|
7258
|
-
* <p>Inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
|
|
7259
|
-
* </li>
|
|
7260
|
-
* </ul>
|
|
7261
|
-
* @public
|
|
7262
|
-
*/
|
|
7263
|
-
TagFilter?: ControlPlaneTagFilter | undefined;
|
|
7264
|
-
/**
|
|
7265
|
-
* <p>An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the
|
|
7266
|
-
* SearchFilter.</p>
|
|
7267
|
-
* <p>This accepts an <code>OR</code> of <code>AND</code> (List of List) input where:</p>
|
|
7268
|
-
* <ul>
|
|
7269
|
-
* <li>
|
|
7270
|
-
* <p>The top level list specifies conditions that need to be applied with <code>OR</code> operator.</p>
|
|
7271
|
-
* </li>
|
|
7272
|
-
* <li>
|
|
7273
|
-
* <p>The inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
|
|
7274
|
-
* </li>
|
|
7275
|
-
* </ul>
|
|
7276
|
-
* <note>
|
|
7277
|
-
* <p>Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain
|
|
7278
|
-
* TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request
|
|
7279
|
-
* will throw AccessDeniedException.</p>
|
|
7280
|
-
* </note>
|
|
7281
|
-
* @public
|
|
7282
|
-
*/
|
|
7283
|
-
UserAttributeFilter?: ControlPlaneUserAttributeFilter | undefined;
|
|
7284
|
-
}
|
|
7285
|
-
/**
|
|
7286
|
-
* <p>The user's first name and last name.</p>
|
|
7287
|
-
* @public
|
|
7288
|
-
*/
|
|
7289
|
-
export interface UserIdentityInfoLite {
|
|
7290
|
-
/**
|
|
7291
|
-
* <p>The user's first name.</p>
|
|
7292
|
-
* @public
|
|
7293
|
-
*/
|
|
7294
|
-
FirstName?: string | undefined;
|
|
7295
|
-
/**
|
|
7296
|
-
* <p>The user's last name.</p>
|
|
7297
|
-
* @public
|
|
7298
|
-
*/
|
|
7299
|
-
LastName?: string | undefined;
|
|
7300
|
-
}
|
|
7301
|
-
/**
|
|
7302
|
-
* <p>Information about the returned users.</p>
|
|
7303
|
-
* @public
|
|
7304
|
-
*/
|
|
7305
|
-
export interface UserSearchSummary {
|
|
7306
|
-
/**
|
|
7307
|
-
* <p>The Amazon Resource Name (ARN) of the user.</p>
|
|
7308
|
-
* @public
|
|
7309
|
-
*/
|
|
7310
|
-
Arn?: string | undefined;
|
|
7311
|
-
/**
|
|
7312
|
-
* <p>The directory identifier of the user.</p>
|
|
7313
|
-
* @public
|
|
7314
|
-
*/
|
|
7315
|
-
DirectoryUserId?: string | undefined;
|
|
7316
|
-
/**
|
|
7317
|
-
* <p>The identifier of the user's hierarchy group.</p>
|
|
7318
|
-
* @public
|
|
7319
|
-
*/
|
|
7320
|
-
HierarchyGroupId?: string | undefined;
|
|
7321
|
-
/**
|
|
7322
|
-
* <p>The identifier of the user's summary.</p>
|
|
7323
|
-
* @public
|
|
7324
|
-
*/
|
|
7325
|
-
Id?: string | undefined;
|
|
7326
|
-
/**
|
|
7327
|
-
* <p>The user's first name and last name.</p>
|
|
7328
|
-
* @public
|
|
7329
|
-
*/
|
|
7330
|
-
IdentityInfo?: UserIdentityInfoLite | undefined;
|
|
7331
|
-
/**
|
|
7332
|
-
* <p>Contains information about the phone configuration settings for a user.</p>
|
|
7333
|
-
* @public
|
|
7334
|
-
*/
|
|
7335
|
-
PhoneConfig?: UserPhoneConfig | undefined;
|
|
7336
|
-
/**
|
|
7337
|
-
* <p>The identifier of the user's routing profile.</p>
|
|
7338
|
-
* @public
|
|
7339
|
-
*/
|
|
7340
|
-
RoutingProfileId?: string | undefined;
|
|
7341
|
-
/**
|
|
7342
|
-
* <p>The identifiers of the user's security profiles.</p>
|
|
7343
|
-
* @public
|
|
7344
|
-
*/
|
|
7345
|
-
SecurityProfileIds?: string[] | undefined;
|
|
7346
|
-
/**
|
|
7347
|
-
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
7348
|
-
* @public
|
|
7349
|
-
*/
|
|
7350
|
-
Tags?: Record<string, string> | undefined;
|
|
7351
|
-
/**
|
|
7352
|
-
* <p>The name of the user.</p>
|
|
7353
|
-
* @public
|
|
7354
|
-
*/
|
|
7355
|
-
Username?: string | undefined;
|
|
7356
|
-
/**
|
|
7357
|
-
* <p>The list of auto-accept configuration settings for each channel.</p>
|
|
7358
|
-
* @public
|
|
7359
|
-
*/
|
|
7360
|
-
AutoAcceptConfigs?: AutoAcceptConfig[] | undefined;
|
|
7361
|
-
/**
|
|
7362
|
-
* <p>The list of after contact work (ACW) timeout configuration settings for each channel.</p>
|
|
7363
|
-
* @public
|
|
7364
|
-
*/
|
|
7365
|
-
AfterContactWorkConfigs?: AfterContactWorkConfigPerChannel[] | undefined;
|
|
7366
|
-
/**
|
|
7367
|
-
* <p>The list of phone number configuration settings for each channel.</p>
|
|
7368
|
-
* @public
|
|
7369
|
-
*/
|
|
7370
|
-
PhoneNumberConfigs?: PhoneNumberConfig[] | undefined;
|
|
7371
|
-
/**
|
|
7372
|
-
* <p>The list of persistent connection configuration settings for each channel.</p>
|
|
7373
|
-
* @public
|
|
7374
|
-
*/
|
|
7375
|
-
PersistentConnectionConfigs?: PersistentConnectionConfig[] | undefined;
|
|
7376
|
-
/**
|
|
7377
|
-
* <p>The list of voice enhancement configuration settings for each channel.</p>
|
|
7378
|
-
* @public
|
|
7379
|
-
*/
|
|
7380
|
-
VoiceEnhancementConfigs?: VoiceEnhancementConfig[] | undefined;
|
|
7381
|
-
}
|
|
7382
|
-
/**
|
|
7383
|
-
* @public
|
|
7384
|
-
*/
|
|
7385
|
-
export interface SearchUsersResponse {
|
|
7386
|
-
/**
|
|
7387
|
-
* <p>Information about the users.</p>
|
|
7388
|
-
* @public
|
|
7389
|
-
*/
|
|
7390
|
-
Users?: UserSearchSummary[] | undefined;
|
|
7391
|
-
/**
|
|
7392
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7393
|
-
* @public
|
|
7394
|
-
*/
|
|
7395
|
-
NextToken?: string | undefined;
|
|
7396
|
-
/**
|
|
7397
|
-
* <p>The total number of users who matched your search query.</p>
|
|
7398
|
-
* @public
|
|
7399
|
-
*/
|
|
7400
|
-
ApproximateTotalCount?: number | undefined;
|
|
7401
|
-
}
|
|
7402
|
-
/**
|
|
7403
|
-
* <p>Defines filters to apply when searching for views, such as tag-based filters.</p>
|
|
7404
|
-
* @public
|
|
7405
|
-
*/
|
|
7406
|
-
export interface ViewSearchFilter {
|
|
7407
|
-
/**
|
|
7408
|
-
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an
|
|
7409
|
-
* <code>OR</code> or <code>AND</code> (List of List) input where:</p>
|
|
7410
|
-
* <ul>
|
|
7411
|
-
* <li>
|
|
7412
|
-
* <p>The top level list specifies conditions that need to be applied with <code>OR</code> operator.</p>
|
|
7413
|
-
* </li>
|
|
7414
|
-
* <li>
|
|
7415
|
-
* <p>The inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
|
|
7416
|
-
* </li>
|
|
7417
|
-
* </ul>
|
|
7418
|
-
* @public
|
|
7419
|
-
*/
|
|
7420
|
-
AttributeFilter?: ControlPlaneAttributeFilter | undefined;
|
|
7421
|
-
}
|
|
7422
|
-
/**
|
|
7423
|
-
* @public
|
|
7424
|
-
*/
|
|
7425
|
-
export interface SearchViewsResponse {
|
|
7426
|
-
/**
|
|
7427
|
-
* <p>A list of views that match the search criteria.</p>
|
|
7428
|
-
* @public
|
|
7429
|
-
*/
|
|
7430
|
-
Views?: View[] | undefined;
|
|
7431
|
-
/**
|
|
7432
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7433
|
-
* @public
|
|
7434
|
-
*/
|
|
7435
|
-
NextToken?: string | undefined;
|
|
7436
|
-
/**
|
|
7437
|
-
* <p>The approximate total number of views that match the search criteria.</p>
|
|
7438
|
-
* @public
|
|
7439
|
-
*/
|
|
7440
|
-
ApproximateTotalCount?: number | undefined;
|
|
7441
|
-
}
|
|
7442
|
-
/**
|
|
7443
|
-
* @public
|
|
7444
|
-
*/
|
|
7445
|
-
export interface SearchVocabulariesRequest {
|
|
7446
|
-
/**
|
|
7447
|
-
* <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>
|
|
7448
|
-
* @public
|
|
7449
|
-
*/
|
|
7450
|
-
InstanceId: string | undefined;
|
|
7451
|
-
/**
|
|
7452
|
-
* <p>The maximum number of results to return per page.</p>
|
|
7453
|
-
* @public
|
|
7454
|
-
*/
|
|
7455
|
-
MaxResults?: number | undefined;
|
|
7456
|
-
/**
|
|
7457
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7458
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
7459
|
-
* @public
|
|
7460
|
-
*/
|
|
7461
|
-
NextToken?: string | undefined;
|
|
7462
|
-
/**
|
|
7463
|
-
* <p>The current state of the custom vocabulary.</p>
|
|
7464
|
-
* @public
|
|
7465
|
-
*/
|
|
7466
|
-
State?: VocabularyState | undefined;
|
|
7467
|
-
/**
|
|
7468
|
-
* <p>The starting pattern of the name of the vocabulary.</p>
|
|
7469
|
-
* @public
|
|
7470
|
-
*/
|
|
7471
|
-
NameStartsWith?: string | undefined;
|
|
7472
|
-
/**
|
|
7473
|
-
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
7474
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
7475
|
-
* </p>
|
|
7476
|
-
* @public
|
|
7477
|
-
*/
|
|
7478
|
-
LanguageCode?: VocabularyLanguageCode | undefined;
|
|
7479
|
-
}
|
|
7480
|
-
/**
|
|
7481
|
-
* <p>Contains summary information about the custom vocabulary.</p>
|
|
7482
|
-
* @public
|
|
7483
|
-
*/
|
|
7484
|
-
export interface VocabularySummary {
|
|
7485
|
-
/**
|
|
7486
|
-
* <p>A unique name of the custom vocabulary.</p>
|
|
7487
|
-
* @public
|
|
7488
|
-
*/
|
|
7489
|
-
Name: string | undefined;
|
|
7490
|
-
/**
|
|
7491
|
-
* <p>The identifier of the custom vocabulary.</p>
|
|
7492
|
-
* @public
|
|
7493
|
-
*/
|
|
7494
|
-
Id: string | undefined;
|
|
7495
|
-
/**
|
|
7496
|
-
* <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>
|
|
7497
|
-
* @public
|
|
7498
|
-
*/
|
|
7499
|
-
Arn: string | undefined;
|
|
7500
|
-
/**
|
|
7501
|
-
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
7502
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
7503
|
-
* </p>
|
|
7504
|
-
* @public
|
|
7505
|
-
*/
|
|
7506
|
-
LanguageCode: VocabularyLanguageCode | undefined;
|
|
7507
|
-
/**
|
|
7508
|
-
* <p>The current state of the custom vocabulary.</p>
|
|
7509
|
-
* @public
|
|
7510
|
-
*/
|
|
7511
|
-
State: VocabularyState | undefined;
|
|
7512
|
-
/**
|
|
7513
|
-
* <p>The timestamp when the custom vocabulary was last modified.</p>
|
|
7514
|
-
* @public
|
|
7515
|
-
*/
|
|
7516
|
-
LastModifiedTime: Date | undefined;
|
|
7517
|
-
/**
|
|
7518
|
-
* <p>The reason why the custom vocabulary was not created.</p>
|
|
7519
|
-
* @public
|
|
7520
|
-
*/
|
|
7521
|
-
FailureReason?: string | undefined;
|
|
7522
|
-
}
|
|
7523
|
-
/**
|
|
7524
|
-
* @public
|
|
7525
|
-
*/
|
|
7526
|
-
export interface SearchVocabulariesResponse {
|
|
7527
|
-
/**
|
|
7528
|
-
* <p>The list of the available custom vocabularies.</p>
|
|
7529
|
-
* @public
|
|
7530
|
-
*/
|
|
7531
|
-
VocabularySummaryList?: VocabularySummary[] | undefined;
|
|
7532
|
-
/**
|
|
7533
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7534
|
-
* @public
|
|
7535
|
-
*/
|
|
7536
|
-
NextToken?: string | undefined;
|
|
7537
|
-
}
|