@aws-sdk/client-elementalinference 3.1054.0 → 3.1056.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 +42 -0
- package/dist-cjs/index.js +123 -0
- package/dist-cjs/schemas/schemas_0.js +144 -14
- package/dist-es/ElementalInference.js +14 -0
- package/dist-es/commands/CreateDictionaryCommand.js +16 -0
- package/dist-es/commands/DeleteDictionaryCommand.js +16 -0
- package/dist-es/commands/ExportDictionaryEntriesCommand.js +16 -0
- package/dist-es/commands/GetDictionaryCommand.js +16 -0
- package/dist-es/commands/ListDictionariesCommand.js +16 -0
- package/dist-es/commands/UpdateDictionaryCommand.js +16 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/models/enums.js +31 -0
- package/dist-es/pagination/ListDictionariesPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +142 -13
- package/dist-types/ElementalInference.d.ts +50 -0
- package/dist-types/ElementalInferenceClient.d.ts +8 -2
- package/dist-types/commands/AssociateFeedCommand.d.ts +14 -5
- package/dist-types/commands/CreateDictionaryCommand.d.ts +109 -0
- package/dist-types/commands/CreateFeedCommand.d.ts +23 -5
- package/dist-types/commands/DeleteDictionaryCommand.d.ts +96 -0
- package/dist-types/commands/DeleteFeedCommand.d.ts +4 -4
- package/dist-types/commands/DisassociateFeedCommand.d.ts +4 -4
- package/dist-types/commands/ExportDictionaryEntriesCommand.d.ts +91 -0
- package/dist-types/commands/GetDictionaryCommand.d.ts +101 -0
- package/dist-types/commands/GetFeedCommand.d.ts +11 -2
- package/dist-types/commands/ListDictionariesCommand.d.ts +98 -0
- package/dist-types/commands/ListFeedsCommand.d.ts +3 -3
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -3
- package/dist-types/commands/TagResourceCommand.d.ts +4 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UpdateDictionaryCommand.d.ts +107 -0
- package/dist-types/commands/UpdateFeedCommand.d.ts +23 -5
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/models/enums.d.ts +63 -0
- package/dist-types/models/errors.d.ts +4 -4
- package/dist-types/models/models_0.d.ts +399 -52
- package/dist-types/pagination/ListDictionariesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +21 -0
- package/dist-types/ts3.4/ElementalInference.d.ts +110 -0
- package/dist-types/ts3.4/ElementalInferenceClient.d.ts +36 -0
- package/dist-types/ts3.4/commands/CreateDictionaryCommand.d.ts +52 -0
- package/dist-types/ts3.4/commands/DeleteDictionaryCommand.d.ts +52 -0
- package/dist-types/ts3.4/commands/ExportDictionaryEntriesCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/GetDictionaryCommand.d.ts +52 -0
- package/dist-types/ts3.4/commands/ListDictionariesCommand.d.ts +52 -0
- package/dist-types/ts3.4/commands/UpdateDictionaryCommand.d.ts +52 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/enums.d.ts +39 -0
- package/dist-types/ts3.4/models/models_0.d.ts +100 -1
- package/dist-types/ts3.4/pagination/ListDictionariesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +21 -0
- package/package.json +6 -6
|
@@ -1,11 +1,27 @@
|
|
|
1
|
-
import type { FeedStatus, OutputStatus } from "./enums";
|
|
1
|
+
import type { DictionaryLanguage, DictionaryStatus, FeedStatus, OutputStatus, ProfanityFilterMode, TranscriptionLanguage } from "./enums";
|
|
2
|
+
/**
|
|
3
|
+
* <p>The width and height of the output video. Used in SubtitlingConfig to determine subtitle layout. </p>
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface AspectRatio {
|
|
7
|
+
/**
|
|
8
|
+
* <p>The width component of the aspect ratio (for example, 16 in a 16:9 ratio).</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
width: number | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The height component of the aspect ratio (for example, 9 in a 16:9 ratio).</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
height: number | undefined;
|
|
17
|
+
}
|
|
2
18
|
/**
|
|
3
19
|
* <p>A type of OutputConfig, used when the output in a feed is for the clip feature.</p>
|
|
4
20
|
* @public
|
|
5
21
|
*/
|
|
6
22
|
export interface ClippingConfig {
|
|
7
23
|
/**
|
|
8
|
-
* <p>
|
|
24
|
+
* <p>A string that you want Elemental Inference to always include in the event clipping metadata for this output. The string might identify the sports event in the source media, for example. </p>
|
|
9
25
|
* @public
|
|
10
26
|
*/
|
|
11
27
|
callbackMetadata?: string | undefined;
|
|
@@ -17,10 +33,36 @@ export interface ClippingConfig {
|
|
|
17
33
|
export interface CroppingConfig {
|
|
18
34
|
}
|
|
19
35
|
/**
|
|
20
|
-
* <p>
|
|
36
|
+
* <p>A type of OutputConfig, used when the output in a feed is for the smart subtitling feature. smart subtitling uses automatic speech recognition (ASR) to generate live TTML subtitles from the audio in your source media. </p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
export interface SubtitlingConfig {
|
|
40
|
+
/**
|
|
41
|
+
* <p>The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por. </p>
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
language: TranscriptionLanguage | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* <p>The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths. </p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
aspectRatio?: AspectRatio | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary. </p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
dictionary?: string | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* <p>Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript). </p>
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
profanityFilter?: ProfanityFilterMode | undefined;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* <p>Contains one typed output. It is used in the CreateOutput, GetOutput, and Update Output structures.</p>
|
|
21
63
|
* @public
|
|
22
64
|
*/
|
|
23
|
-
export type OutputConfig = OutputConfig.ClippingMember | OutputConfig.CroppingMember | OutputConfig.$UnknownMember;
|
|
65
|
+
export type OutputConfig = OutputConfig.ClippingMember | OutputConfig.CroppingMember | OutputConfig.SubtitlingMember | OutputConfig.$UnknownMember;
|
|
24
66
|
/**
|
|
25
67
|
* @public
|
|
26
68
|
*/
|
|
@@ -32,6 +74,7 @@ export declare namespace OutputConfig {
|
|
|
32
74
|
interface CroppingMember {
|
|
33
75
|
cropping: CroppingConfig;
|
|
34
76
|
clipping?: never;
|
|
77
|
+
subtitling?: never;
|
|
35
78
|
$unknown?: never;
|
|
36
79
|
}
|
|
37
80
|
/**
|
|
@@ -41,6 +84,17 @@ export declare namespace OutputConfig {
|
|
|
41
84
|
interface ClippingMember {
|
|
42
85
|
cropping?: never;
|
|
43
86
|
clipping: ClippingConfig;
|
|
87
|
+
subtitling?: never;
|
|
88
|
+
$unknown?: never;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* <p>The output config type that applies to the smart subtitling feature.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
interface SubtitlingMember {
|
|
95
|
+
cropping?: never;
|
|
96
|
+
clipping?: never;
|
|
97
|
+
subtitling: SubtitlingConfig;
|
|
44
98
|
$unknown?: never;
|
|
45
99
|
}
|
|
46
100
|
/**
|
|
@@ -49,6 +103,7 @@ export declare namespace OutputConfig {
|
|
|
49
103
|
interface $UnknownMember {
|
|
50
104
|
cropping?: never;
|
|
51
105
|
clipping?: never;
|
|
106
|
+
subtitling?: never;
|
|
52
107
|
$unknown: [string, any];
|
|
53
108
|
}
|
|
54
109
|
/**
|
|
@@ -58,11 +113,12 @@ export declare namespace OutputConfig {
|
|
|
58
113
|
interface Visitor<T> {
|
|
59
114
|
cropping: (value: CroppingConfig) => T;
|
|
60
115
|
clipping: (value: ClippingConfig) => T;
|
|
116
|
+
subtitling: (value: SubtitlingConfig) => T;
|
|
61
117
|
_: (name: string, value: any) => T;
|
|
62
118
|
}
|
|
63
119
|
}
|
|
64
120
|
/**
|
|
65
|
-
* <p>Contains configuration information about one output in a feed. It is used in the AssociateFeed and the CreateFeed actions
|
|
121
|
+
* <p>Contains configuration information about one output in a feed. It is used in the AssociateFeed and the CreateFeed actions. </p>
|
|
66
122
|
* @public
|
|
67
123
|
*/
|
|
68
124
|
export interface CreateOutput {
|
|
@@ -72,7 +128,7 @@ export interface CreateOutput {
|
|
|
72
128
|
*/
|
|
73
129
|
name: string | undefined;
|
|
74
130
|
/**
|
|
75
|
-
* <p>A typed property for an output in a feed. It
|
|
131
|
+
* <p>A typed property for an output in a feed. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature. </p>
|
|
76
132
|
* @public
|
|
77
133
|
*/
|
|
78
134
|
outputConfig: OutputConfig | undefined;
|
|
@@ -97,17 +153,17 @@ export interface AssociateFeedRequest {
|
|
|
97
153
|
*/
|
|
98
154
|
id: string | undefined;
|
|
99
155
|
/**
|
|
100
|
-
* <p>An identifier for the resource.
|
|
156
|
+
* <p>An identifier for the resource. This name must not resemble an ARN.</p> <p>The resource is the source media that the feed will process. The name you assign should help you to later identify the source media that belongs to the feed. In this way, you will know which source media to push to the feed (using PutMedia). </p>
|
|
101
157
|
* @public
|
|
102
158
|
*/
|
|
103
159
|
associatedResourceName?: string | undefined;
|
|
104
160
|
/**
|
|
105
|
-
* <p>
|
|
161
|
+
* <p>An array of one or more outputs that you want to add to this feed now, to supplement any outputs that you specified when you created or updated the feed. </p>
|
|
106
162
|
* @public
|
|
107
163
|
*/
|
|
108
164
|
outputs: CreateOutput[] | undefined;
|
|
109
165
|
/**
|
|
110
|
-
* <p>Set to true if you want to do a dry run of the associate action.</p>
|
|
166
|
+
* <p>Set to true if you want to do a dry run of the associate action.</p> <p>Elemental Inference will validate that the real request would succeed without actually making any changes. A dry run catches errors such as missing IAM permissions, quota limits exceeded, conflicting outputs, and so on. If the dry run fails, the action returns a 4xx error code. After you've fixed the errors, resubmit the request. </p>
|
|
111
167
|
* @public
|
|
112
168
|
*/
|
|
113
169
|
dryRun?: boolean | undefined;
|
|
@@ -117,38 +173,103 @@ export interface AssociateFeedRequest {
|
|
|
117
173
|
*/
|
|
118
174
|
export interface AssociateFeedResponse {
|
|
119
175
|
/**
|
|
120
|
-
* <p>The
|
|
176
|
+
* <p>The ARN of the feed.</p>
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
arn: string | undefined;
|
|
180
|
+
/**
|
|
181
|
+
* <p>The ID of the feed.</p>
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
id: string | undefined;
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
export interface CreateDictionaryRequest {
|
|
190
|
+
/**
|
|
191
|
+
* <p>A user-friendly name for this dictionary.</p>
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
name: string | undefined;
|
|
195
|
+
/**
|
|
196
|
+
* <p>The language of the dictionary entries. Specify the language using an ISO 639-2/T three-letter code. Supported values: eng, fra, ita, deu, spa, por. </p>
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
language: DictionaryLanguage | undefined;
|
|
200
|
+
/**
|
|
201
|
+
* <p>The dictionary entries payload. Contains the custom words and phrases for the dictionary. Maximum size is 40,960 characters. </p>
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
entries?: string | undefined;
|
|
205
|
+
/**
|
|
206
|
+
* <p>Optional tags to associate with the dictionary.</p>
|
|
207
|
+
* @public
|
|
208
|
+
*/
|
|
209
|
+
tags?: Record<string, string> | undefined;
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* @public
|
|
213
|
+
*/
|
|
214
|
+
export interface CreateDictionaryResponse {
|
|
215
|
+
/**
|
|
216
|
+
* <p>The name that you specified in the request.</p>
|
|
217
|
+
* @public
|
|
218
|
+
*/
|
|
219
|
+
name: string | undefined;
|
|
220
|
+
/**
|
|
221
|
+
* <p>The ARN of the dictionary.</p>
|
|
121
222
|
* @public
|
|
122
223
|
*/
|
|
123
224
|
arn: string | undefined;
|
|
124
225
|
/**
|
|
125
|
-
* <p>
|
|
226
|
+
* <p>A unique ID that Elemental Inference assigns to the dictionary.</p>
|
|
126
227
|
* @public
|
|
127
228
|
*/
|
|
128
229
|
id: string | undefined;
|
|
230
|
+
/**
|
|
231
|
+
* <p>The language of the dictionary.</p>
|
|
232
|
+
* @public
|
|
233
|
+
*/
|
|
234
|
+
language: DictionaryLanguage | undefined;
|
|
235
|
+
/**
|
|
236
|
+
* <p>The current status of the dictionary. After creation succeeds, the status will be AVAILABLE. </p>
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
status: DictionaryStatus | undefined;
|
|
240
|
+
/**
|
|
241
|
+
* <p>A list of feed IDs that reference this dictionary.</p>
|
|
242
|
+
* @public
|
|
243
|
+
*/
|
|
244
|
+
references?: string[] | undefined;
|
|
245
|
+
/**
|
|
246
|
+
* <p>Any tags that you included when you created the dictionary.</p>
|
|
247
|
+
* @public
|
|
248
|
+
*/
|
|
249
|
+
tags?: Record<string, string> | undefined;
|
|
129
250
|
}
|
|
130
251
|
/**
|
|
131
252
|
* @public
|
|
132
253
|
*/
|
|
133
254
|
export interface CreateFeedRequest {
|
|
134
255
|
/**
|
|
135
|
-
* <p>A name for this feed.</p>
|
|
256
|
+
* <p>A user-friendly name for this feed.</p>
|
|
136
257
|
* @public
|
|
137
258
|
*/
|
|
138
259
|
name: string | undefined;
|
|
139
260
|
/**
|
|
140
|
-
* <p>An array of outputs for this feed. Each output represents a specific Elemental Inference feature. For example,
|
|
261
|
+
* <p>An array of outputs for this feed. Each output represents a specific Elemental Inference feature. For example, there is one output type for the smart crop feature. You must specify at least one output, but you can later add outputs using AssociateFeed, or add, modify, and delete outputs using UpdateFeed. </p>
|
|
141
262
|
* @public
|
|
142
263
|
*/
|
|
143
264
|
outputs: CreateOutput[] | undefined;
|
|
144
265
|
/**
|
|
145
|
-
* <p>
|
|
266
|
+
* <p>Optional tags. You can also add tags later, using TagResource.</p>
|
|
146
267
|
* @public
|
|
147
268
|
*/
|
|
148
269
|
tags?: Record<string, string> | undefined;
|
|
149
270
|
}
|
|
150
271
|
/**
|
|
151
|
-
* <p>Contains information about the resource that is associated with a feed. It is used in the FeedSummary that is used in the response of a ListFeeds action
|
|
272
|
+
* <p>Contains information about the resource that is associated with a feed. It is used in the FeedSummary that is used in the response of a ListFeeds action. </p>
|
|
152
273
|
* @public
|
|
153
274
|
*/
|
|
154
275
|
export interface FeedAssociation {
|
|
@@ -159,17 +280,17 @@ export interface FeedAssociation {
|
|
|
159
280
|
associatedResourceName: string | undefined;
|
|
160
281
|
}
|
|
161
282
|
/**
|
|
162
|
-
* <p>Contains configuration information about one output in a feed. It is used in the GetFeed
|
|
283
|
+
* <p>Contains configuration information about one output in a feed. It is used in the GetFeed response. </p>
|
|
163
284
|
* @public
|
|
164
285
|
*/
|
|
165
286
|
export interface GetOutput {
|
|
166
287
|
/**
|
|
167
|
-
* <p>The
|
|
288
|
+
* <p>The name of the output.</p>
|
|
168
289
|
* @public
|
|
169
290
|
*/
|
|
170
291
|
name: string | undefined;
|
|
171
292
|
/**
|
|
172
|
-
* <p>A typed property for an output in a feed. It
|
|
293
|
+
* <p>A typed property for an output in a feed. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature. </p>
|
|
173
294
|
* @public
|
|
174
295
|
*/
|
|
175
296
|
outputConfig: OutputConfig | undefined;
|
|
@@ -184,7 +305,7 @@ export interface GetOutput {
|
|
|
184
305
|
*/
|
|
185
306
|
description?: string | undefined;
|
|
186
307
|
/**
|
|
187
|
-
* <p>True means that the output was originally created in the feed
|
|
308
|
+
* <p>True means that the output was originally created in the feed using AssociateFeed. False means it was created using CreateFeed or UpdateFeed. </p> <p>You will need this value if you use UpdateFeed to modify the list of outputs in the feed.</p>
|
|
188
309
|
* @public
|
|
189
310
|
*/
|
|
190
311
|
fromAssociation?: boolean | undefined;
|
|
@@ -199,7 +320,7 @@ export interface CreateFeedResponse {
|
|
|
199
320
|
*/
|
|
200
321
|
arn: string | undefined;
|
|
201
322
|
/**
|
|
202
|
-
* <p>The name that you specified.</p>
|
|
323
|
+
* <p>The name that you specified in the request.</p>
|
|
203
324
|
* @public
|
|
204
325
|
*/
|
|
205
326
|
name: string | undefined;
|
|
@@ -209,22 +330,22 @@ export interface CreateFeedResponse {
|
|
|
209
330
|
*/
|
|
210
331
|
id: string | undefined;
|
|
211
332
|
/**
|
|
212
|
-
* <p>
|
|
333
|
+
* <p>An array of endpoints for the feed. Typically, there is only one endpoint. The feed receives source media at this endpoint (when the calling application calls PutMedia) and returns the resulting metadata to this endpoint (when the calling application calls GetMetadata). </p>
|
|
213
334
|
* @public
|
|
214
335
|
*/
|
|
215
336
|
dataEndpoints: string[] | undefined;
|
|
216
337
|
/**
|
|
217
|
-
* <p>
|
|
338
|
+
* <p>Repeats the outputs that you specified in the request.</p>
|
|
218
339
|
* @public
|
|
219
340
|
*/
|
|
220
341
|
outputs: GetOutput[] | undefined;
|
|
221
342
|
/**
|
|
222
|
-
* <p>The current status of the feed. After creation of the feed has succeeded, the status will be AVAILABLE
|
|
343
|
+
* <p>The current status of the feed. After creation of the feed has succeeded, the status will be AVAILABLE. </p>
|
|
223
344
|
* @public
|
|
224
345
|
*/
|
|
225
346
|
status: FeedStatus | undefined;
|
|
226
347
|
/**
|
|
227
|
-
* <p>The association for this feed. When you create the feed, this property is empty. You must associate a resource with the feed using AssociateFeed
|
|
348
|
+
* <p>The association for this feed. When you create the feed, this property is empty. You must associate a resource with the feed using AssociateFeed or UpdateFeed. </p>
|
|
228
349
|
* @public
|
|
229
350
|
*/
|
|
230
351
|
association?: FeedAssociation | undefined;
|
|
@@ -234,6 +355,36 @@ export interface CreateFeedResponse {
|
|
|
234
355
|
*/
|
|
235
356
|
tags?: Record<string, string> | undefined;
|
|
236
357
|
}
|
|
358
|
+
/**
|
|
359
|
+
* @public
|
|
360
|
+
*/
|
|
361
|
+
export interface DeleteDictionaryRequest {
|
|
362
|
+
/**
|
|
363
|
+
* <p>The ID of the dictionary to delete.</p>
|
|
364
|
+
* @public
|
|
365
|
+
*/
|
|
366
|
+
id: string | undefined;
|
|
367
|
+
}
|
|
368
|
+
/**
|
|
369
|
+
* @public
|
|
370
|
+
*/
|
|
371
|
+
export interface DeleteDictionaryResponse {
|
|
372
|
+
/**
|
|
373
|
+
* <p>The ARN of the deleted dictionary.</p>
|
|
374
|
+
* @public
|
|
375
|
+
*/
|
|
376
|
+
arn: string | undefined;
|
|
377
|
+
/**
|
|
378
|
+
* <p>The ID of the deleted dictionary.</p>
|
|
379
|
+
* @public
|
|
380
|
+
*/
|
|
381
|
+
id: string | undefined;
|
|
382
|
+
/**
|
|
383
|
+
* <p>The status of the dictionary after deletion.</p>
|
|
384
|
+
* @public
|
|
385
|
+
*/
|
|
386
|
+
status: DictionaryStatus | undefined;
|
|
387
|
+
}
|
|
237
388
|
/**
|
|
238
389
|
* @public
|
|
239
390
|
*/
|
|
@@ -259,11 +410,207 @@ export interface DeleteFeedResponse {
|
|
|
259
410
|
*/
|
|
260
411
|
id: string | undefined;
|
|
261
412
|
/**
|
|
262
|
-
* <p>The current status of the feed. When deletion of the feed has succeeded, the status will be DELETED
|
|
413
|
+
* <p>The current status of the feed. When deletion of the feed has succeeded, the status will be DELETED. </p>
|
|
263
414
|
* @public
|
|
264
415
|
*/
|
|
265
416
|
status: FeedStatus | undefined;
|
|
266
417
|
}
|
|
418
|
+
/**
|
|
419
|
+
* @public
|
|
420
|
+
*/
|
|
421
|
+
export interface ExportDictionaryEntriesRequest {
|
|
422
|
+
/**
|
|
423
|
+
* <p>The ID of the dictionary whose entries you want to export.</p>
|
|
424
|
+
* @public
|
|
425
|
+
*/
|
|
426
|
+
id: string | undefined;
|
|
427
|
+
}
|
|
428
|
+
/**
|
|
429
|
+
* @public
|
|
430
|
+
*/
|
|
431
|
+
export interface ExportDictionaryEntriesResponse {
|
|
432
|
+
/**
|
|
433
|
+
* <p>The dictionary entries payload.</p>
|
|
434
|
+
* @public
|
|
435
|
+
*/
|
|
436
|
+
entries?: string | undefined;
|
|
437
|
+
}
|
|
438
|
+
/**
|
|
439
|
+
* @public
|
|
440
|
+
*/
|
|
441
|
+
export interface GetDictionaryRequest {
|
|
442
|
+
/**
|
|
443
|
+
* <p>The ID of the dictionary to retrieve.</p>
|
|
444
|
+
* @public
|
|
445
|
+
*/
|
|
446
|
+
id: string | undefined;
|
|
447
|
+
}
|
|
448
|
+
/**
|
|
449
|
+
* @public
|
|
450
|
+
*/
|
|
451
|
+
export interface GetDictionaryResponse {
|
|
452
|
+
/**
|
|
453
|
+
* <p>The name of the dictionary.</p>
|
|
454
|
+
* @public
|
|
455
|
+
*/
|
|
456
|
+
name: string | undefined;
|
|
457
|
+
/**
|
|
458
|
+
* <p>The ARN of the dictionary.</p>
|
|
459
|
+
* @public
|
|
460
|
+
*/
|
|
461
|
+
arn: string | undefined;
|
|
462
|
+
/**
|
|
463
|
+
* <p>The ID of the dictionary.</p>
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
466
|
+
id: string | undefined;
|
|
467
|
+
/**
|
|
468
|
+
* <p>The language of the dictionary.</p>
|
|
469
|
+
* @public
|
|
470
|
+
*/
|
|
471
|
+
language: DictionaryLanguage | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* <p>The current status of the dictionary.</p>
|
|
474
|
+
* @public
|
|
475
|
+
*/
|
|
476
|
+
status: DictionaryStatus | undefined;
|
|
477
|
+
/**
|
|
478
|
+
* <p>A list of feed IDs that reference this dictionary.</p>
|
|
479
|
+
* @public
|
|
480
|
+
*/
|
|
481
|
+
references?: string[] | undefined;
|
|
482
|
+
/**
|
|
483
|
+
* <p>The tags associated with the dictionary.</p>
|
|
484
|
+
* @public
|
|
485
|
+
*/
|
|
486
|
+
tags?: Record<string, string> | undefined;
|
|
487
|
+
}
|
|
488
|
+
/**
|
|
489
|
+
* @public
|
|
490
|
+
*/
|
|
491
|
+
export interface ListDictionariesRequest {
|
|
492
|
+
/**
|
|
493
|
+
* <p>The maximum number of results to return per API request. Valid range: 1 to 100.</p>
|
|
494
|
+
* @public
|
|
495
|
+
*/
|
|
496
|
+
maxResults?: number | undefined;
|
|
497
|
+
/**
|
|
498
|
+
* <p>The token that identifies the next batch of results to return.</p>
|
|
499
|
+
* @public
|
|
500
|
+
*/
|
|
501
|
+
nextToken?: string | undefined;
|
|
502
|
+
}
|
|
503
|
+
/**
|
|
504
|
+
* <p>Contains summary information about a dictionary. Used in the ListDictionaries response. </p>
|
|
505
|
+
* @public
|
|
506
|
+
*/
|
|
507
|
+
export interface DictionarySummary {
|
|
508
|
+
/**
|
|
509
|
+
* <p>The ARN of the dictionary.</p>
|
|
510
|
+
* @public
|
|
511
|
+
*/
|
|
512
|
+
arn: string | undefined;
|
|
513
|
+
/**
|
|
514
|
+
* <p>The ID of the dictionary.</p>
|
|
515
|
+
* @public
|
|
516
|
+
*/
|
|
517
|
+
id: string | undefined;
|
|
518
|
+
/**
|
|
519
|
+
* <p>The name of the dictionary.</p>
|
|
520
|
+
* @public
|
|
521
|
+
*/
|
|
522
|
+
name: string | undefined;
|
|
523
|
+
/**
|
|
524
|
+
* <p>The language of the dictionary.</p>
|
|
525
|
+
* @public
|
|
526
|
+
*/
|
|
527
|
+
language: DictionaryLanguage | undefined;
|
|
528
|
+
/**
|
|
529
|
+
* <p>The status of the dictionary.</p>
|
|
530
|
+
* @public
|
|
531
|
+
*/
|
|
532
|
+
status: DictionaryStatus | undefined;
|
|
533
|
+
}
|
|
534
|
+
/**
|
|
535
|
+
* @public
|
|
536
|
+
*/
|
|
537
|
+
export interface ListDictionariesResponse {
|
|
538
|
+
/**
|
|
539
|
+
* <p>A list of DictionarySummary objects.</p>
|
|
540
|
+
* @public
|
|
541
|
+
*/
|
|
542
|
+
dictionaries: DictionarySummary[] | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* <p>The token to use to retrieve the next batch of results.</p>
|
|
545
|
+
* @public
|
|
546
|
+
*/
|
|
547
|
+
nextToken?: string | undefined;
|
|
548
|
+
}
|
|
549
|
+
/**
|
|
550
|
+
* @public
|
|
551
|
+
*/
|
|
552
|
+
export interface UpdateDictionaryRequest {
|
|
553
|
+
/**
|
|
554
|
+
* <p>The ID of the dictionary to update.</p>
|
|
555
|
+
* @public
|
|
556
|
+
*/
|
|
557
|
+
id: string | undefined;
|
|
558
|
+
/**
|
|
559
|
+
* <p>A new name for the dictionary. If not specified, the name is not changed.</p>
|
|
560
|
+
* @public
|
|
561
|
+
*/
|
|
562
|
+
name?: string | undefined;
|
|
563
|
+
/**
|
|
564
|
+
* <p>A new language for the dictionary. If not specified, the language is not changed.</p>
|
|
565
|
+
* @public
|
|
566
|
+
*/
|
|
567
|
+
language?: DictionaryLanguage | undefined;
|
|
568
|
+
/**
|
|
569
|
+
* <p>New dictionary entries. If not specified, the entries are not changed.</p>
|
|
570
|
+
* @public
|
|
571
|
+
*/
|
|
572
|
+
entries?: string | undefined;
|
|
573
|
+
}
|
|
574
|
+
/**
|
|
575
|
+
* @public
|
|
576
|
+
*/
|
|
577
|
+
export interface UpdateDictionaryResponse {
|
|
578
|
+
/**
|
|
579
|
+
* <p>The updated or original name of the dictionary.</p>
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
name: string | undefined;
|
|
583
|
+
/**
|
|
584
|
+
* <p>The ARN of the dictionary.</p>
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
arn: string | undefined;
|
|
588
|
+
/**
|
|
589
|
+
* <p>The ID of the dictionary.</p>
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
id: string | undefined;
|
|
593
|
+
/**
|
|
594
|
+
* <p>The updated or original language of the dictionary.</p>
|
|
595
|
+
* @public
|
|
596
|
+
*/
|
|
597
|
+
language: DictionaryLanguage | undefined;
|
|
598
|
+
/**
|
|
599
|
+
* <p>The current status of the dictionary.</p>
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
status: DictionaryStatus | undefined;
|
|
603
|
+
/**
|
|
604
|
+
* <p>A list of feed IDs that reference this dictionary.</p>
|
|
605
|
+
* @public
|
|
606
|
+
*/
|
|
607
|
+
references?: string[] | undefined;
|
|
608
|
+
/**
|
|
609
|
+
* <p>Any tags associated with the dictionary.</p>
|
|
610
|
+
* @public
|
|
611
|
+
*/
|
|
612
|
+
tags?: Record<string, string> | undefined;
|
|
613
|
+
}
|
|
267
614
|
/**
|
|
268
615
|
* @public
|
|
269
616
|
*/
|
|
@@ -274,12 +621,12 @@ export interface DisassociateFeedRequest {
|
|
|
274
621
|
*/
|
|
275
622
|
id: string | undefined;
|
|
276
623
|
/**
|
|
277
|
-
* <p>The name of the resource currently associated with the feed
|
|
624
|
+
* <p>The name of the resource currently associated with the feed.</p>
|
|
278
625
|
* @public
|
|
279
626
|
*/
|
|
280
627
|
associatedResourceName?: string | undefined;
|
|
281
628
|
/**
|
|
282
|
-
* <p>Set to true if you want to do a dry run of the disassociate action.</p>
|
|
629
|
+
* <p>Set to true if you want to do a dry run of the disassociate action.</p> <p>Elemental Inference will validate that the real request would succeed without actually making any changes. A dry run catches errors such as missing IAM permissions. If the dry run fails, the action returns a 4xx error code. </p>
|
|
283
630
|
* @public
|
|
284
631
|
*/
|
|
285
632
|
dryRun?: boolean | undefined;
|
|
@@ -289,12 +636,12 @@ export interface DisassociateFeedRequest {
|
|
|
289
636
|
*/
|
|
290
637
|
export interface DisassociateFeedResponse {
|
|
291
638
|
/**
|
|
292
|
-
* <p>The
|
|
639
|
+
* <p>The ARN of the feed.</p>
|
|
293
640
|
* @public
|
|
294
641
|
*/
|
|
295
642
|
arn: string | undefined;
|
|
296
643
|
/**
|
|
297
|
-
* <p>The
|
|
644
|
+
* <p>The ID of the feed.</p>
|
|
298
645
|
* @public
|
|
299
646
|
*/
|
|
300
647
|
id: string | undefined;
|
|
@@ -319,37 +666,37 @@ export interface GetFeedResponse {
|
|
|
319
666
|
*/
|
|
320
667
|
arn: string | undefined;
|
|
321
668
|
/**
|
|
322
|
-
* <p>The name of the feed
|
|
669
|
+
* <p>The name of the feed.</p>
|
|
323
670
|
* @public
|
|
324
671
|
*/
|
|
325
672
|
name: string | undefined;
|
|
326
673
|
/**
|
|
327
|
-
* <p>The ID of the feed
|
|
674
|
+
* <p>The ID of the feed.</p>
|
|
328
675
|
* @public
|
|
329
676
|
*/
|
|
330
677
|
id: string | undefined;
|
|
331
678
|
/**
|
|
332
|
-
* <p>The dataEndpoints of the feed
|
|
679
|
+
* <p>The dataEndpoints of the feed.</p>
|
|
333
680
|
* @public
|
|
334
681
|
*/
|
|
335
682
|
dataEndpoints: string[] | undefined;
|
|
336
683
|
/**
|
|
337
|
-
* <p>An array of the outputs in the feed
|
|
684
|
+
* <p>An array of the outputs in the feed.</p>
|
|
338
685
|
* @public
|
|
339
686
|
*/
|
|
340
687
|
outputs: GetOutput[] | undefined;
|
|
341
688
|
/**
|
|
342
|
-
* <p>The status of the feed
|
|
689
|
+
* <p>The status of the feed.</p>
|
|
343
690
|
* @public
|
|
344
691
|
*/
|
|
345
692
|
status: FeedStatus | undefined;
|
|
346
693
|
/**
|
|
347
|
-
* <p>Information about the resource
|
|
694
|
+
* <p>Information about the resource that is associated with the feed. It's possible that there is no associated resource. This is not an error. </p>
|
|
348
695
|
* @public
|
|
349
696
|
*/
|
|
350
697
|
association?: FeedAssociation | undefined;
|
|
351
698
|
/**
|
|
352
|
-
* <p>A list of the tags, if any, for the feed
|
|
699
|
+
* <p>A list of the tags, if any, for the feed.</p>
|
|
353
700
|
* @public
|
|
354
701
|
*/
|
|
355
702
|
tags?: Record<string, string> | undefined;
|
|
@@ -359,18 +706,18 @@ export interface GetFeedResponse {
|
|
|
359
706
|
*/
|
|
360
707
|
export interface ListFeedsRequest {
|
|
361
708
|
/**
|
|
362
|
-
* <p>The maximum number of results to return per API request.</p> <p>For example, you submit a list request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)</p> <p>The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page
|
|
709
|
+
* <p>The maximum number of results to return per API request.</p> <p>For example, you submit a list request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) </p> <p>The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page. </p> <p>Valid Range: Minimum value of 1. Maximum value of 1000.</p>
|
|
363
710
|
* @public
|
|
364
711
|
*/
|
|
365
712
|
maxResults?: number | undefined;
|
|
366
713
|
/**
|
|
367
|
-
* <p>The token that identifies the batch of results that you want to see.</p> <p>For example, you submit a
|
|
714
|
+
* <p>The token that identifies the batch of results that you want to see.</p> <p>For example, you submit a ListFeeds request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFeeds request a second time and specify the NextToken value. </p>
|
|
368
715
|
* @public
|
|
369
716
|
*/
|
|
370
717
|
nextToken?: string | undefined;
|
|
371
718
|
}
|
|
372
719
|
/**
|
|
373
|
-
* <p>Contains configuration information about a feed. It is used in the ListFeeds
|
|
720
|
+
* <p>Contains configuration information about a feed. It is used in the ListFeeds response. </p>
|
|
374
721
|
* @public
|
|
375
722
|
*/
|
|
376
723
|
export interface FeedSummary {
|
|
@@ -405,28 +752,28 @@ export interface FeedSummary {
|
|
|
405
752
|
*/
|
|
406
753
|
export interface ListFeedsResponse {
|
|
407
754
|
/**
|
|
408
|
-
* <p>A list of
|
|
755
|
+
* <p>A list of FeedSummary objects.</p>
|
|
409
756
|
* @public
|
|
410
757
|
*/
|
|
411
758
|
feeds: FeedSummary[] | undefined;
|
|
412
759
|
/**
|
|
413
|
-
* <p>The token that identifies the batch of results that you want to see. For example, you submit a list request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the list request a second time and specify the NextToken value
|
|
760
|
+
* <p>The token that identifies the batch of results that you want to see. For example, you submit a list request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the list request a second time and specify the NextToken value. </p>
|
|
414
761
|
* @public
|
|
415
762
|
*/
|
|
416
763
|
nextToken?: string | undefined;
|
|
417
764
|
}
|
|
418
765
|
/**
|
|
419
|
-
* <p>Contains configuration information about one output in a feed. It is used in the UpdateFeed action
|
|
766
|
+
* <p>Contains configuration information about one output in a feed. It is used in the UpdateFeed action. </p>
|
|
420
767
|
* @public
|
|
421
768
|
*/
|
|
422
769
|
export interface UpdateOutput {
|
|
423
770
|
/**
|
|
424
|
-
* <p>The name
|
|
771
|
+
* <p>The name of the output.</p>
|
|
425
772
|
* @public
|
|
426
773
|
*/
|
|
427
774
|
name: string | undefined;
|
|
428
775
|
/**
|
|
429
|
-
* <p>A typed property for an output in a feed. It
|
|
776
|
+
* <p>A typed property for an output in a feed. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature. </p>
|
|
430
777
|
* @public
|
|
431
778
|
*/
|
|
432
779
|
outputConfig: OutputConfig | undefined;
|
|
@@ -441,7 +788,7 @@ export interface UpdateOutput {
|
|
|
441
788
|
*/
|
|
442
789
|
description?: string | undefined;
|
|
443
790
|
/**
|
|
444
|
-
* <p>
|
|
791
|
+
* <p>Elemental Inference originally sets this parameter to True if this output was created by AssociateFeed or to False if this output was created by CreateFeed or UpdateFeed. </p> <p>You must not change this value. Therefore, use GetFeed to determine the current value. Then in the UpdateFeed request, if the current value is True, include this parameter with a value of True. If it's False, omit the parameter. </p>
|
|
445
792
|
* @public
|
|
446
793
|
*/
|
|
447
794
|
fromAssociation?: boolean | undefined;
|
|
@@ -451,7 +798,7 @@ export interface UpdateOutput {
|
|
|
451
798
|
*/
|
|
452
799
|
export interface UpdateFeedRequest {
|
|
453
800
|
/**
|
|
454
|
-
* <p>Required. You can specify the existing name (to leave it unchanged) or a new name
|
|
801
|
+
* <p>Required. You can specify the existing name (to leave it unchanged) or a new name. </p>
|
|
455
802
|
* @public
|
|
456
803
|
*/
|
|
457
804
|
name: string | undefined;
|
|
@@ -491,22 +838,22 @@ export interface UpdateFeedResponse {
|
|
|
491
838
|
*/
|
|
492
839
|
dataEndpoints: string[] | undefined;
|
|
493
840
|
/**
|
|
494
|
-
* <p>The array of outputs in the feed. You might have left this array unchanged, or you might have changed it
|
|
841
|
+
* <p>The array of outputs in the feed. You might have left this array unchanged, or you might have changed it. </p>
|
|
495
842
|
* @public
|
|
496
843
|
*/
|
|
497
844
|
outputs: GetOutput[] | undefined;
|
|
498
845
|
/**
|
|
499
|
-
* <p>The status of the
|
|
846
|
+
* <p>The status of the feed.</p>
|
|
500
847
|
* @public
|
|
501
848
|
*/
|
|
502
849
|
status: FeedStatus | undefined;
|
|
503
850
|
/**
|
|
504
|
-
* <p>
|
|
851
|
+
* <p>Information about the resource that is associated with the feed, if any.</p>
|
|
505
852
|
* @public
|
|
506
853
|
*/
|
|
507
854
|
association?: FeedAssociation | undefined;
|
|
508
855
|
/**
|
|
509
|
-
* <p>The
|
|
856
|
+
* <p>The tags associated with the feed.</p>
|
|
510
857
|
* @public
|
|
511
858
|
*/
|
|
512
859
|
tags?: Record<string, string> | undefined;
|
|
@@ -516,7 +863,7 @@ export interface UpdateFeedResponse {
|
|
|
516
863
|
*/
|
|
517
864
|
export interface ListTagsForResourceRequest {
|
|
518
865
|
/**
|
|
519
|
-
* <p>The ARN of the resource whose tags you want to query
|
|
866
|
+
* <p>The ARN of the resource whose tags you want to query.</p>
|
|
520
867
|
* @public
|
|
521
868
|
*/
|
|
522
869
|
resourceArn: string | undefined;
|
|
@@ -536,7 +883,7 @@ export interface ListTagsForResourceResponse {
|
|
|
536
883
|
*/
|
|
537
884
|
export interface TagResourceRequest {
|
|
538
885
|
/**
|
|
539
|
-
* <p>The ARN of the resource where you want to add tags
|
|
886
|
+
* <p>The ARN of the resource where you want to add tags.</p>
|
|
540
887
|
* @public
|
|
541
888
|
*/
|
|
542
889
|
resourceArn: string | undefined;
|