@aws-sdk/client-mediapackagev2 3.679.0 → 3.682.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 +33 -1
- package/dist-cjs/index.js +388 -32
- package/dist-es/MediaPackageV2.js +8 -0
- package/dist-es/commands/CancelHarvestJobCommand.js +22 -0
- package/dist-es/commands/CreateHarvestJobCommand.js +22 -0
- package/dist-es/commands/GetHarvestJobCommand.js +22 -0
- package/dist-es/commands/ListHarvestJobsCommand.js +22 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/models_0.js +35 -19
- package/dist-es/pagination/ListHarvestJobsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +192 -3
- package/dist-es/waiters/index.js +1 -0
- package/dist-es/waiters/waitForHarvestJobFinished.js +67 -0
- package/dist-types/MediaPackageV2.d.ts +28 -0
- package/dist-types/MediaPackageV2Client.d.ts +6 -2
- package/dist-types/commands/CancelHarvestJobCommand.d.ts +105 -0
- package/dist-types/commands/CreateHarvestJobCommand.d.ts +253 -0
- package/dist-types/commands/GetHarvestJobCommand.d.ts +188 -0
- package/dist-types/commands/ListHarvestJobsCommand.d.ts +473 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +580 -52
- package/dist-types/pagination/ListHarvestJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
- package/dist-types/ts3.4/MediaPackageV2.d.ts +68 -0
- package/dist-types/ts3.4/MediaPackageV2Client.d.ts +24 -0
- package/dist-types/ts3.4/commands/CancelHarvestJobCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateHarvestJobCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetHarvestJobCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListHarvestJobsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +157 -26
- package/dist-types/ts3.4/pagination/ListHarvestJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
- package/dist-types/ts3.4/waiters/index.d.ts +1 -0
- package/dist-types/ts3.4/waiters/waitForHarvestJobFinished.d.ts +11 -0
- package/dist-types/waiters/index.d.ts +1 -0
- package/dist-types/waiters/waitForHarvestJobFinished.d.ts +14 -0
- package/package.json +7 -6
|
@@ -37,35 +37,39 @@ export declare const AdMarkerHls: {
|
|
|
37
37
|
*/
|
|
38
38
|
export type AdMarkerHls = (typeof AdMarkerHls)[keyof typeof AdMarkerHls];
|
|
39
39
|
/**
|
|
40
|
-
* <p>The configuration of the channel group.</p>
|
|
41
40
|
* @public
|
|
42
41
|
*/
|
|
43
|
-
export interface
|
|
42
|
+
export interface CancelHarvestJobRequest {
|
|
44
43
|
/**
|
|
45
|
-
* <p>The name
|
|
44
|
+
* <p>The name of the channel group containing the channel from which the harvest job is running.</p>
|
|
46
45
|
* @public
|
|
47
46
|
*/
|
|
48
47
|
ChannelGroupName: string | undefined;
|
|
49
48
|
/**
|
|
50
|
-
* <p>The
|
|
49
|
+
* <p>The name of the channel from which the harvest job is running.</p>
|
|
51
50
|
* @public
|
|
52
51
|
*/
|
|
53
|
-
|
|
52
|
+
ChannelName: string | undefined;
|
|
54
53
|
/**
|
|
55
|
-
* <p>The
|
|
54
|
+
* <p>The name of the origin endpoint that the harvest job is harvesting from. This cannot be changed after the harvest job is submitted.</p>
|
|
56
55
|
* @public
|
|
57
56
|
*/
|
|
58
|
-
|
|
57
|
+
OriginEndpointName: string | undefined;
|
|
59
58
|
/**
|
|
60
|
-
* <p>The
|
|
59
|
+
* <p>The name of the harvest job to cancel. This name must be unique within the channel and cannot be changed after the harvest job is submitted.</p>
|
|
61
60
|
* @public
|
|
62
61
|
*/
|
|
63
|
-
|
|
62
|
+
HarvestJobName: string | undefined;
|
|
64
63
|
/**
|
|
65
|
-
* <p>
|
|
64
|
+
* <p>The current Entity Tag (ETag) associated with the harvest job. Used for concurrency control.</p>
|
|
66
65
|
* @public
|
|
67
66
|
*/
|
|
68
|
-
|
|
67
|
+
ETag?: string;
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
export interface CancelHarvestJobResponse {
|
|
69
73
|
}
|
|
70
74
|
/**
|
|
71
75
|
* @public
|
|
@@ -100,37 +104,49 @@ export declare class ConflictException extends __BaseException {
|
|
|
100
104
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
101
105
|
}
|
|
102
106
|
/**
|
|
107
|
+
* <p>Indicates that an error from the service occurred while trying to process a request.</p>
|
|
103
108
|
* @public
|
|
104
109
|
*/
|
|
105
|
-
export
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
*/
|
|
110
|
-
ChannelGroupName: string | undefined;
|
|
110
|
+
export declare class InternalServerException extends __BaseException {
|
|
111
|
+
readonly name: "InternalServerException";
|
|
112
|
+
readonly $fault: "server";
|
|
113
|
+
Message?: string;
|
|
111
114
|
/**
|
|
112
|
-
*
|
|
113
|
-
* @public
|
|
115
|
+
* @internal
|
|
114
116
|
*/
|
|
115
|
-
|
|
117
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
116
118
|
}
|
|
117
119
|
/**
|
|
118
120
|
* @public
|
|
121
|
+
* @enum
|
|
119
122
|
*/
|
|
120
|
-
export
|
|
121
|
-
|
|
123
|
+
export declare const ResourceTypeNotFound: {
|
|
124
|
+
readonly CHANNEL: "CHANNEL";
|
|
125
|
+
readonly CHANNEL_GROUP: "CHANNEL_GROUP";
|
|
126
|
+
readonly HARVEST_JOB: "HARVEST_JOB";
|
|
127
|
+
readonly ORIGIN_ENDPOINT: "ORIGIN_ENDPOINT";
|
|
128
|
+
};
|
|
122
129
|
/**
|
|
123
|
-
* <p>Indicates that an error from the service occurred while trying to process a request.</p>
|
|
124
130
|
* @public
|
|
125
131
|
*/
|
|
126
|
-
export
|
|
127
|
-
|
|
128
|
-
|
|
132
|
+
export type ResourceTypeNotFound = (typeof ResourceTypeNotFound)[keyof typeof ResourceTypeNotFound];
|
|
133
|
+
/**
|
|
134
|
+
* <p>The specified resource doesn't exist.</p>
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
138
|
+
readonly name: "ResourceNotFoundException";
|
|
139
|
+
readonly $fault: "client";
|
|
129
140
|
Message?: string;
|
|
141
|
+
/**
|
|
142
|
+
* <p>The specified resource type wasn't found.</p>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
ResourceTypeNotFound?: ResourceTypeNotFound;
|
|
130
146
|
/**
|
|
131
147
|
* @internal
|
|
132
148
|
*/
|
|
133
|
-
constructor(opts: __ExceptionOptionType<
|
|
149
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
134
150
|
}
|
|
135
151
|
/**
|
|
136
152
|
* <p>The request throughput limit was exceeded.</p>
|
|
@@ -161,6 +177,13 @@ export declare const ValidationExceptionType: {
|
|
|
161
177
|
readonly ENCRYPTION_CONTRACT_WITHOUT_AUDIO_RENDITION_INCOMPATIBLE: "ENCRYPTION_CONTRACT_WITHOUT_AUDIO_RENDITION_INCOMPATIBLE";
|
|
162
178
|
readonly ENCRYPTION_METHOD_CONTAINER_TYPE_MISMATCH: "ENCRYPTION_METHOD_CONTAINER_TYPE_MISMATCH";
|
|
163
179
|
readonly END_TIME_EARLIER_THAN_START_TIME: "END_TIME_EARLIER_THAN_START_TIME";
|
|
180
|
+
readonly HARVESTED_MANIFEST_HAS_START_END_FILTER_CONFIGURATION: "HARVESTED_MANIFEST_HAS_START_END_FILTER_CONFIGURATION";
|
|
181
|
+
readonly HARVESTED_MANIFEST_NOT_FOUND_ON_ENDPOINT: "HARVESTED_MANIFEST_NOT_FOUND_ON_ENDPOINT";
|
|
182
|
+
readonly HARVEST_JOB_CUSTOMER_ENDPOINT_READ_ACCESS_DENIED: "HARVEST_JOB_CUSTOMER_ENDPOINT_READ_ACCESS_DENIED";
|
|
183
|
+
readonly HARVEST_JOB_INELIGIBLE_FOR_CANCELLATION: "HARVEST_JOB_INELIGIBLE_FOR_CANCELLATION";
|
|
184
|
+
readonly HARVEST_JOB_S3_DESTINATION_MISSING_OR_INCOMPLETE: "HARVEST_JOB_S3_DESTINATION_MISSING_OR_INCOMPLETE";
|
|
185
|
+
readonly HARVEST_JOB_UNABLE_TO_WRITE_TO_S3_DESTINATION: "HARVEST_JOB_UNABLE_TO_WRITE_TO_S3_DESTINATION";
|
|
186
|
+
readonly INVALID_HARVEST_JOB_DURATION: "INVALID_HARVEST_JOB_DURATION";
|
|
164
187
|
readonly INVALID_MANIFEST_FILTER: "INVALID_MANIFEST_FILTER";
|
|
165
188
|
readonly INVALID_PAGINATION_MAX_RESULTS: "INVALID_PAGINATION_MAX_RESULTS";
|
|
166
189
|
readonly INVALID_PAGINATION_TOKEN: "INVALID_PAGINATION_TOKEN";
|
|
@@ -188,6 +211,7 @@ export declare const ValidationExceptionType: {
|
|
|
188
211
|
readonly SOURCE_DISRUPTIONS_ENABLED_INCORRECTLY: "SOURCE_DISRUPTIONS_ENABLED_INCORRECTLY";
|
|
189
212
|
readonly START_TAG_TIME_OFFSET_INVALID: "START_TAG_TIME_OFFSET_INVALID";
|
|
190
213
|
readonly TIMING_SOURCE_MISSING: "TIMING_SOURCE_MISSING";
|
|
214
|
+
readonly TOO_MANY_IN_PROGRESS_HARVEST_JOBS: "TOO_MANY_IN_PROGRESS_HARVEST_JOBS";
|
|
191
215
|
readonly TS_CONTAINER_TYPE_WITH_DASH_MANIFEST: "TS_CONTAINER_TYPE_WITH_DASH_MANIFEST";
|
|
192
216
|
readonly UPDATE_PERIOD_SMALLER_THAN_SEGMENT_DURATION: "UPDATE_PERIOD_SMALLER_THAN_SEGMENT_DURATION";
|
|
193
217
|
readonly URL_INVALID: "URL_INVALID";
|
|
@@ -223,24 +247,40 @@ export declare class ValidationException extends __BaseException {
|
|
|
223
247
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
224
248
|
}
|
|
225
249
|
/**
|
|
250
|
+
* <p>The configuration of the channel group.</p>
|
|
226
251
|
* @public
|
|
227
252
|
*/
|
|
228
|
-
export interface
|
|
253
|
+
export interface ChannelGroupListConfiguration {
|
|
229
254
|
/**
|
|
230
255
|
* <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
|
|
231
256
|
* @public
|
|
232
257
|
*/
|
|
233
258
|
ChannelGroupName: string | undefined;
|
|
234
259
|
/**
|
|
235
|
-
* <p>The
|
|
260
|
+
* <p>The Amazon Resource Name (ARN) associated with the resource.</p>
|
|
236
261
|
* @public
|
|
237
262
|
*/
|
|
238
|
-
|
|
263
|
+
Arn: string | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* <p>The date and time the channel group was created.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
CreatedAt: Date | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* <p>The date and time the channel group was modified.</p>
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
ModifiedAt: Date | undefined;
|
|
274
|
+
/**
|
|
275
|
+
* <p>Any descriptive information that you want to add to the channel group for future identification purposes.</p>
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
Description?: string;
|
|
239
279
|
}
|
|
240
280
|
/**
|
|
241
281
|
* @public
|
|
242
282
|
*/
|
|
243
|
-
export interface
|
|
283
|
+
export interface DeleteChannelPolicyRequest {
|
|
244
284
|
/**
|
|
245
285
|
* <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
|
|
246
286
|
* @public
|
|
@@ -251,42 +291,46 @@ export interface GetChannelPolicyResponse {
|
|
|
251
291
|
* @public
|
|
252
292
|
*/
|
|
253
293
|
ChannelName: string | undefined;
|
|
254
|
-
/**
|
|
255
|
-
* <p>The policy assigned to the channel.</p>
|
|
256
|
-
* @public
|
|
257
|
-
*/
|
|
258
|
-
Policy: string | undefined;
|
|
259
294
|
}
|
|
260
295
|
/**
|
|
261
296
|
* @public
|
|
262
|
-
* @enum
|
|
263
297
|
*/
|
|
264
|
-
export
|
|
265
|
-
|
|
266
|
-
readonly CHANNEL_GROUP: "CHANNEL_GROUP";
|
|
267
|
-
readonly ORIGIN_ENDPOINT: "ORIGIN_ENDPOINT";
|
|
268
|
-
};
|
|
298
|
+
export interface DeleteChannelPolicyResponse {
|
|
299
|
+
}
|
|
269
300
|
/**
|
|
270
301
|
* @public
|
|
271
302
|
*/
|
|
272
|
-
export
|
|
303
|
+
export interface GetChannelPolicyRequest {
|
|
304
|
+
/**
|
|
305
|
+
* <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
|
|
306
|
+
* @public
|
|
307
|
+
*/
|
|
308
|
+
ChannelGroupName: string | undefined;
|
|
309
|
+
/**
|
|
310
|
+
* <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
ChannelName: string | undefined;
|
|
314
|
+
}
|
|
273
315
|
/**
|
|
274
|
-
* <p>The specified resource doesn't exist.</p>
|
|
275
316
|
* @public
|
|
276
317
|
*/
|
|
277
|
-
export
|
|
278
|
-
readonly name: "ResourceNotFoundException";
|
|
279
|
-
readonly $fault: "client";
|
|
280
|
-
Message?: string;
|
|
318
|
+
export interface GetChannelPolicyResponse {
|
|
281
319
|
/**
|
|
282
|
-
* <p>The
|
|
320
|
+
* <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
|
|
283
321
|
* @public
|
|
284
322
|
*/
|
|
285
|
-
|
|
323
|
+
ChannelGroupName: string | undefined;
|
|
286
324
|
/**
|
|
287
|
-
*
|
|
325
|
+
* <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
|
|
326
|
+
* @public
|
|
288
327
|
*/
|
|
289
|
-
|
|
328
|
+
ChannelName: string | undefined;
|
|
329
|
+
/**
|
|
330
|
+
* <p>The policy assigned to the channel.</p>
|
|
331
|
+
* @public
|
|
332
|
+
*/
|
|
333
|
+
Policy: string | undefined;
|
|
290
334
|
}
|
|
291
335
|
/**
|
|
292
336
|
* @public
|
|
@@ -2462,6 +2506,490 @@ export interface GetChannelGroupResponse {
|
|
|
2462
2506
|
*/
|
|
2463
2507
|
Tags?: Record<string, string>;
|
|
2464
2508
|
}
|
|
2509
|
+
/**
|
|
2510
|
+
* <p>Configuration parameters for where in an S3 bucket to place the harvested content.</p>
|
|
2511
|
+
* @public
|
|
2512
|
+
*/
|
|
2513
|
+
export interface S3DestinationConfig {
|
|
2514
|
+
/**
|
|
2515
|
+
* <p>The name of an S3 bucket within which harvested content will be exported.</p>
|
|
2516
|
+
* @public
|
|
2517
|
+
*/
|
|
2518
|
+
BucketName: string | undefined;
|
|
2519
|
+
/**
|
|
2520
|
+
* <p>The path within the specified S3 bucket where the harvested content will be placed.</p>
|
|
2521
|
+
* @public
|
|
2522
|
+
*/
|
|
2523
|
+
DestinationPath: string | undefined;
|
|
2524
|
+
}
|
|
2525
|
+
/**
|
|
2526
|
+
* <p>The configuration for the destination where the harvested content will be exported.</p>
|
|
2527
|
+
* @public
|
|
2528
|
+
*/
|
|
2529
|
+
export interface Destination {
|
|
2530
|
+
/**
|
|
2531
|
+
* <p>The configuration for exporting harvested content to an S3 bucket. This includes details such as the bucket name and destination path within the bucket.</p>
|
|
2532
|
+
* @public
|
|
2533
|
+
*/
|
|
2534
|
+
S3Destination: S3DestinationConfig | undefined;
|
|
2535
|
+
}
|
|
2536
|
+
/**
|
|
2537
|
+
* <p>Information about a harvested DASH manifest.</p>
|
|
2538
|
+
* @public
|
|
2539
|
+
*/
|
|
2540
|
+
export interface HarvestedDashManifest {
|
|
2541
|
+
/**
|
|
2542
|
+
* <p>The name of the harvested DASH manifest.</p>
|
|
2543
|
+
* @public
|
|
2544
|
+
*/
|
|
2545
|
+
ManifestName: string | undefined;
|
|
2546
|
+
}
|
|
2547
|
+
/**
|
|
2548
|
+
* <p>Information about a harvested HLS manifest.</p>
|
|
2549
|
+
* @public
|
|
2550
|
+
*/
|
|
2551
|
+
export interface HarvestedHlsManifest {
|
|
2552
|
+
/**
|
|
2553
|
+
* <p>The name of the harvested HLS manifest.</p>
|
|
2554
|
+
* @public
|
|
2555
|
+
*/
|
|
2556
|
+
ManifestName: string | undefined;
|
|
2557
|
+
}
|
|
2558
|
+
/**
|
|
2559
|
+
* <p>Information about a harvested Low-Latency HLS manifest.</p>
|
|
2560
|
+
* @public
|
|
2561
|
+
*/
|
|
2562
|
+
export interface HarvestedLowLatencyHlsManifest {
|
|
2563
|
+
/**
|
|
2564
|
+
* <p>The name of the harvested Low-Latency HLS manifest.</p>
|
|
2565
|
+
* @public
|
|
2566
|
+
*/
|
|
2567
|
+
ManifestName: string | undefined;
|
|
2568
|
+
}
|
|
2569
|
+
/**
|
|
2570
|
+
* <p>A collection of harvested manifests of different types.</p>
|
|
2571
|
+
* @public
|
|
2572
|
+
*/
|
|
2573
|
+
export interface HarvestedManifests {
|
|
2574
|
+
/**
|
|
2575
|
+
* <p>A list of harvested HLS manifests.</p>
|
|
2576
|
+
* @public
|
|
2577
|
+
*/
|
|
2578
|
+
HlsManifests?: HarvestedHlsManifest[];
|
|
2579
|
+
/**
|
|
2580
|
+
* <p>A list of harvested DASH manifests.</p>
|
|
2581
|
+
* @public
|
|
2582
|
+
*/
|
|
2583
|
+
DashManifests?: HarvestedDashManifest[];
|
|
2584
|
+
/**
|
|
2585
|
+
* <p>A list of harvested Low-Latency HLS manifests.</p>
|
|
2586
|
+
* @public
|
|
2587
|
+
*/
|
|
2588
|
+
LowLatencyHlsManifests?: HarvestedLowLatencyHlsManifest[];
|
|
2589
|
+
}
|
|
2590
|
+
/**
|
|
2591
|
+
* <p>Defines the schedule configuration for a harvest job.</p>
|
|
2592
|
+
* @public
|
|
2593
|
+
*/
|
|
2594
|
+
export interface HarvesterScheduleConfiguration {
|
|
2595
|
+
/**
|
|
2596
|
+
* <p>The start time for the harvest job.</p>
|
|
2597
|
+
* @public
|
|
2598
|
+
*/
|
|
2599
|
+
StartTime: Date | undefined;
|
|
2600
|
+
/**
|
|
2601
|
+
* <p>The end time for the harvest job.</p>
|
|
2602
|
+
* @public
|
|
2603
|
+
*/
|
|
2604
|
+
EndTime: Date | undefined;
|
|
2605
|
+
}
|
|
2606
|
+
/**
|
|
2607
|
+
* <p>The request object for creating a new harvest job.</p>
|
|
2608
|
+
* @public
|
|
2609
|
+
*/
|
|
2610
|
+
export interface CreateHarvestJobRequest {
|
|
2611
|
+
/**
|
|
2612
|
+
* <p>The name of the channel group containing the channel from which to harvest content.</p>
|
|
2613
|
+
* @public
|
|
2614
|
+
*/
|
|
2615
|
+
ChannelGroupName: string | undefined;
|
|
2616
|
+
/**
|
|
2617
|
+
* <p>The name of the channel from which to harvest content.</p>
|
|
2618
|
+
* @public
|
|
2619
|
+
*/
|
|
2620
|
+
ChannelName: string | undefined;
|
|
2621
|
+
/**
|
|
2622
|
+
* <p>The name of the origin endpoint from which to harvest content.</p>
|
|
2623
|
+
* @public
|
|
2624
|
+
*/
|
|
2625
|
+
OriginEndpointName: string | undefined;
|
|
2626
|
+
/**
|
|
2627
|
+
* <p>An optional description for the harvest job.</p>
|
|
2628
|
+
* @public
|
|
2629
|
+
*/
|
|
2630
|
+
Description?: string;
|
|
2631
|
+
/**
|
|
2632
|
+
* <p>A list of manifests to be harvested.</p>
|
|
2633
|
+
* @public
|
|
2634
|
+
*/
|
|
2635
|
+
HarvestedManifests: HarvestedManifests | undefined;
|
|
2636
|
+
/**
|
|
2637
|
+
* <p>The configuration for when the harvest job should run, including start and end times.</p>
|
|
2638
|
+
* @public
|
|
2639
|
+
*/
|
|
2640
|
+
ScheduleConfiguration: HarvesterScheduleConfiguration | undefined;
|
|
2641
|
+
/**
|
|
2642
|
+
* <p>The S3 destination where the harvested content will be placed.</p>
|
|
2643
|
+
* @public
|
|
2644
|
+
*/
|
|
2645
|
+
Destination: Destination | undefined;
|
|
2646
|
+
/**
|
|
2647
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
|
|
2648
|
+
* @public
|
|
2649
|
+
*/
|
|
2650
|
+
ClientToken?: string;
|
|
2651
|
+
/**
|
|
2652
|
+
* <p>A name for the harvest job. This name must be unique within the channel.</p>
|
|
2653
|
+
* @public
|
|
2654
|
+
*/
|
|
2655
|
+
HarvestJobName?: string;
|
|
2656
|
+
/**
|
|
2657
|
+
* <p>A collection of tags associated with the harvest job.</p>
|
|
2658
|
+
* @public
|
|
2659
|
+
*/
|
|
2660
|
+
Tags?: Record<string, string>;
|
|
2661
|
+
}
|
|
2662
|
+
/**
|
|
2663
|
+
* @public
|
|
2664
|
+
* @enum
|
|
2665
|
+
*/
|
|
2666
|
+
export declare const HarvestJobStatus: {
|
|
2667
|
+
readonly CANCELLED: "CANCELLED";
|
|
2668
|
+
readonly COMPLETED: "COMPLETED";
|
|
2669
|
+
readonly FAILED: "FAILED";
|
|
2670
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
2671
|
+
readonly QUEUED: "QUEUED";
|
|
2672
|
+
};
|
|
2673
|
+
/**
|
|
2674
|
+
* @public
|
|
2675
|
+
*/
|
|
2676
|
+
export type HarvestJobStatus = (typeof HarvestJobStatus)[keyof typeof HarvestJobStatus];
|
|
2677
|
+
/**
|
|
2678
|
+
* <p>The response object returned after creating a harvest job.</p>
|
|
2679
|
+
* @public
|
|
2680
|
+
*/
|
|
2681
|
+
export interface CreateHarvestJobResponse {
|
|
2682
|
+
/**
|
|
2683
|
+
* <p>The name of the channel group containing the channel from which content is being harvested.</p>
|
|
2684
|
+
* @public
|
|
2685
|
+
*/
|
|
2686
|
+
ChannelGroupName: string | undefined;
|
|
2687
|
+
/**
|
|
2688
|
+
* <p>The name of the channel from which content is being harvested.</p>
|
|
2689
|
+
* @public
|
|
2690
|
+
*/
|
|
2691
|
+
ChannelName: string | undefined;
|
|
2692
|
+
/**
|
|
2693
|
+
* <p>The name of the origin endpoint from which content is being harvested.</p>
|
|
2694
|
+
* @public
|
|
2695
|
+
*/
|
|
2696
|
+
OriginEndpointName: string | undefined;
|
|
2697
|
+
/**
|
|
2698
|
+
* <p>The S3 destination where the harvested content will be placed.</p>
|
|
2699
|
+
* @public
|
|
2700
|
+
*/
|
|
2701
|
+
Destination: Destination | undefined;
|
|
2702
|
+
/**
|
|
2703
|
+
* <p>The name of the created harvest job.</p>
|
|
2704
|
+
* @public
|
|
2705
|
+
*/
|
|
2706
|
+
HarvestJobName: string | undefined;
|
|
2707
|
+
/**
|
|
2708
|
+
* <p>A list of manifests that will be harvested.</p>
|
|
2709
|
+
* @public
|
|
2710
|
+
*/
|
|
2711
|
+
HarvestedManifests: HarvestedManifests | undefined;
|
|
2712
|
+
/**
|
|
2713
|
+
* <p>The description of the harvest job, if provided.</p>
|
|
2714
|
+
* @public
|
|
2715
|
+
*/
|
|
2716
|
+
Description?: string;
|
|
2717
|
+
/**
|
|
2718
|
+
* <p>The configuration for when the harvest job will run, including start and end times.</p>
|
|
2719
|
+
* @public
|
|
2720
|
+
*/
|
|
2721
|
+
ScheduleConfiguration: HarvesterScheduleConfiguration | undefined;
|
|
2722
|
+
/**
|
|
2723
|
+
* <p>The Amazon Resource Name (ARN) of the created harvest job.</p>
|
|
2724
|
+
* @public
|
|
2725
|
+
*/
|
|
2726
|
+
Arn: string | undefined;
|
|
2727
|
+
/**
|
|
2728
|
+
* <p>The date and time the harvest job was created.</p>
|
|
2729
|
+
* @public
|
|
2730
|
+
*/
|
|
2731
|
+
CreatedAt: Date | undefined;
|
|
2732
|
+
/**
|
|
2733
|
+
* <p>The date and time the harvest job was last modified.</p>
|
|
2734
|
+
* @public
|
|
2735
|
+
*/
|
|
2736
|
+
ModifiedAt: Date | undefined;
|
|
2737
|
+
/**
|
|
2738
|
+
* <p>The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED).</p>
|
|
2739
|
+
* @public
|
|
2740
|
+
*/
|
|
2741
|
+
Status: HarvestJobStatus | undefined;
|
|
2742
|
+
/**
|
|
2743
|
+
* <p>An error message if the harvest job creation failed.</p>
|
|
2744
|
+
* @public
|
|
2745
|
+
*/
|
|
2746
|
+
ErrorMessage?: string;
|
|
2747
|
+
/**
|
|
2748
|
+
* <p>The current version of the harvest job. Used for concurrency control.</p>
|
|
2749
|
+
* @public
|
|
2750
|
+
*/
|
|
2751
|
+
ETag?: string;
|
|
2752
|
+
/**
|
|
2753
|
+
* <p>A collection of tags associated with the harvest job.</p>
|
|
2754
|
+
* @public
|
|
2755
|
+
*/
|
|
2756
|
+
Tags?: Record<string, string>;
|
|
2757
|
+
}
|
|
2758
|
+
/**
|
|
2759
|
+
* <p>The request object for retrieving a specific harvest job.</p>
|
|
2760
|
+
* @public
|
|
2761
|
+
*/
|
|
2762
|
+
export interface GetHarvestJobRequest {
|
|
2763
|
+
/**
|
|
2764
|
+
* <p>The name of the channel group containing the channel associated with the harvest job.</p>
|
|
2765
|
+
* @public
|
|
2766
|
+
*/
|
|
2767
|
+
ChannelGroupName: string | undefined;
|
|
2768
|
+
/**
|
|
2769
|
+
* <p>The name of the channel associated with the harvest job.</p>
|
|
2770
|
+
* @public
|
|
2771
|
+
*/
|
|
2772
|
+
ChannelName: string | undefined;
|
|
2773
|
+
/**
|
|
2774
|
+
* <p>The name of the origin endpoint associated with the harvest job.</p>
|
|
2775
|
+
* @public
|
|
2776
|
+
*/
|
|
2777
|
+
OriginEndpointName: string | undefined;
|
|
2778
|
+
/**
|
|
2779
|
+
* <p>The name of the harvest job to retrieve.</p>
|
|
2780
|
+
* @public
|
|
2781
|
+
*/
|
|
2782
|
+
HarvestJobName: string | undefined;
|
|
2783
|
+
}
|
|
2784
|
+
/**
|
|
2785
|
+
* <p>The response object containing the details of the requested harvest job.</p>
|
|
2786
|
+
* @public
|
|
2787
|
+
*/
|
|
2788
|
+
export interface GetHarvestJobResponse {
|
|
2789
|
+
/**
|
|
2790
|
+
* <p>The name of the channel group containing the channel associated with the harvest job.</p>
|
|
2791
|
+
* @public
|
|
2792
|
+
*/
|
|
2793
|
+
ChannelGroupName: string | undefined;
|
|
2794
|
+
/**
|
|
2795
|
+
* <p>The name of the channel associated with the harvest job.</p>
|
|
2796
|
+
* @public
|
|
2797
|
+
*/
|
|
2798
|
+
ChannelName: string | undefined;
|
|
2799
|
+
/**
|
|
2800
|
+
* <p>The name of the origin endpoint associated with the harvest job.</p>
|
|
2801
|
+
* @public
|
|
2802
|
+
*/
|
|
2803
|
+
OriginEndpointName: string | undefined;
|
|
2804
|
+
/**
|
|
2805
|
+
* <p>The S3 destination where the harvested content is being placed.</p>
|
|
2806
|
+
* @public
|
|
2807
|
+
*/
|
|
2808
|
+
Destination: Destination | undefined;
|
|
2809
|
+
/**
|
|
2810
|
+
* <p>The name of the harvest job.</p>
|
|
2811
|
+
* @public
|
|
2812
|
+
*/
|
|
2813
|
+
HarvestJobName: string | undefined;
|
|
2814
|
+
/**
|
|
2815
|
+
* <p>A list of manifests that are being or have been harvested.</p>
|
|
2816
|
+
* @public
|
|
2817
|
+
*/
|
|
2818
|
+
HarvestedManifests: HarvestedManifests | undefined;
|
|
2819
|
+
/**
|
|
2820
|
+
* <p>The description of the harvest job, if provided.</p>
|
|
2821
|
+
* @public
|
|
2822
|
+
*/
|
|
2823
|
+
Description?: string;
|
|
2824
|
+
/**
|
|
2825
|
+
* <p>The configuration for when the harvest job is scheduled to run, including start and end times.</p>
|
|
2826
|
+
* @public
|
|
2827
|
+
*/
|
|
2828
|
+
ScheduleConfiguration: HarvesterScheduleConfiguration | undefined;
|
|
2829
|
+
/**
|
|
2830
|
+
* <p>The Amazon Resource Name (ARN) of the harvest job.</p>
|
|
2831
|
+
* @public
|
|
2832
|
+
*/
|
|
2833
|
+
Arn: string | undefined;
|
|
2834
|
+
/**
|
|
2835
|
+
* <p>The date and time when the harvest job was created.</p>
|
|
2836
|
+
* @public
|
|
2837
|
+
*/
|
|
2838
|
+
CreatedAt: Date | undefined;
|
|
2839
|
+
/**
|
|
2840
|
+
* <p>The date and time when the harvest job was last modified.</p>
|
|
2841
|
+
* @public
|
|
2842
|
+
*/
|
|
2843
|
+
ModifiedAt: Date | undefined;
|
|
2844
|
+
/**
|
|
2845
|
+
* <p>The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).</p>
|
|
2846
|
+
* @public
|
|
2847
|
+
*/
|
|
2848
|
+
Status: HarvestJobStatus | undefined;
|
|
2849
|
+
/**
|
|
2850
|
+
* <p>An error message if the harvest job encountered any issues.</p>
|
|
2851
|
+
* @public
|
|
2852
|
+
*/
|
|
2853
|
+
ErrorMessage?: string;
|
|
2854
|
+
/**
|
|
2855
|
+
* <p>The current version of the harvest job. Used for concurrency control.</p>
|
|
2856
|
+
* @public
|
|
2857
|
+
*/
|
|
2858
|
+
ETag?: string;
|
|
2859
|
+
/**
|
|
2860
|
+
* <p>A collection of tags associated with the harvest job.</p>
|
|
2861
|
+
* @public
|
|
2862
|
+
*/
|
|
2863
|
+
Tags?: Record<string, string>;
|
|
2864
|
+
}
|
|
2865
|
+
/**
|
|
2866
|
+
* <p>The request object for listing harvest jobs.</p>
|
|
2867
|
+
* @public
|
|
2868
|
+
*/
|
|
2869
|
+
export interface ListHarvestJobsRequest {
|
|
2870
|
+
/**
|
|
2871
|
+
* <p>The name of the channel group to filter the harvest jobs by. If specified, only harvest jobs associated with channels in this group will be returned.</p>
|
|
2872
|
+
* @public
|
|
2873
|
+
*/
|
|
2874
|
+
ChannelGroupName: string | undefined;
|
|
2875
|
+
/**
|
|
2876
|
+
* <p>The name of the channel to filter the harvest jobs by. If specified, only harvest jobs associated with this channel will be returned.</p>
|
|
2877
|
+
* @public
|
|
2878
|
+
*/
|
|
2879
|
+
ChannelName?: string;
|
|
2880
|
+
/**
|
|
2881
|
+
* <p>The name of the origin endpoint to filter the harvest jobs by. If specified, only harvest jobs associated with this origin endpoint will be returned.</p>
|
|
2882
|
+
* @public
|
|
2883
|
+
*/
|
|
2884
|
+
OriginEndpointName?: string;
|
|
2885
|
+
/**
|
|
2886
|
+
* <p>The status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned.</p>
|
|
2887
|
+
* @public
|
|
2888
|
+
*/
|
|
2889
|
+
Status?: HarvestJobStatus;
|
|
2890
|
+
/**
|
|
2891
|
+
* <p>The maximum number of harvest jobs to return in a single request. If not specified, a default value will be used.</p>
|
|
2892
|
+
* @public
|
|
2893
|
+
*/
|
|
2894
|
+
MaxResults?: number;
|
|
2895
|
+
/**
|
|
2896
|
+
* <p>A token used for pagination. Provide this value in subsequent requests to retrieve the next set of results.</p>
|
|
2897
|
+
* @public
|
|
2898
|
+
*/
|
|
2899
|
+
NextToken?: string;
|
|
2900
|
+
}
|
|
2901
|
+
/**
|
|
2902
|
+
* <p>Represents a harvest job resource in MediaPackage v2, which is used to export content from an origin endpoint to an S3 bucket.</p>
|
|
2903
|
+
* @public
|
|
2904
|
+
*/
|
|
2905
|
+
export interface HarvestJob {
|
|
2906
|
+
/**
|
|
2907
|
+
* <p>The name of the channel group containing the channel associated with this harvest job.</p>
|
|
2908
|
+
* @public
|
|
2909
|
+
*/
|
|
2910
|
+
ChannelGroupName: string | undefined;
|
|
2911
|
+
/**
|
|
2912
|
+
* <p>The name of the channel associated with this harvest job.</p>
|
|
2913
|
+
* @public
|
|
2914
|
+
*/
|
|
2915
|
+
ChannelName: string | undefined;
|
|
2916
|
+
/**
|
|
2917
|
+
* <p>The name of the origin endpoint associated with this harvest job.</p>
|
|
2918
|
+
* @public
|
|
2919
|
+
*/
|
|
2920
|
+
OriginEndpointName: string | undefined;
|
|
2921
|
+
/**
|
|
2922
|
+
* <p>The S3 destination where the harvested content will be placed.</p>
|
|
2923
|
+
* @public
|
|
2924
|
+
*/
|
|
2925
|
+
Destination: Destination | undefined;
|
|
2926
|
+
/**
|
|
2927
|
+
* <p>The name of the harvest job.</p>
|
|
2928
|
+
* @public
|
|
2929
|
+
*/
|
|
2930
|
+
HarvestJobName: string | undefined;
|
|
2931
|
+
/**
|
|
2932
|
+
* <p>A list of manifests that are being or have been harvested.</p>
|
|
2933
|
+
* @public
|
|
2934
|
+
*/
|
|
2935
|
+
HarvestedManifests: HarvestedManifests | undefined;
|
|
2936
|
+
/**
|
|
2937
|
+
* <p>An optional description of the harvest job.</p>
|
|
2938
|
+
* @public
|
|
2939
|
+
*/
|
|
2940
|
+
Description?: string;
|
|
2941
|
+
/**
|
|
2942
|
+
* <p>The configuration for when the harvest job is scheduled to run.</p>
|
|
2943
|
+
* @public
|
|
2944
|
+
*/
|
|
2945
|
+
ScheduleConfiguration: HarvesterScheduleConfiguration | undefined;
|
|
2946
|
+
/**
|
|
2947
|
+
* <p>The Amazon Resource Name (ARN) of the harvest job.</p>
|
|
2948
|
+
* @public
|
|
2949
|
+
*/
|
|
2950
|
+
Arn: string | undefined;
|
|
2951
|
+
/**
|
|
2952
|
+
* <p>The date and time when the harvest job was created.</p>
|
|
2953
|
+
* @public
|
|
2954
|
+
*/
|
|
2955
|
+
CreatedAt: Date | undefined;
|
|
2956
|
+
/**
|
|
2957
|
+
* <p>The date and time when the harvest job was last modified.</p>
|
|
2958
|
+
* @public
|
|
2959
|
+
*/
|
|
2960
|
+
ModifiedAt: Date | undefined;
|
|
2961
|
+
/**
|
|
2962
|
+
* <p>The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).</p>
|
|
2963
|
+
* @public
|
|
2964
|
+
*/
|
|
2965
|
+
Status: HarvestJobStatus | undefined;
|
|
2966
|
+
/**
|
|
2967
|
+
* <p>An error message if the harvest job encountered any issues.</p>
|
|
2968
|
+
* @public
|
|
2969
|
+
*/
|
|
2970
|
+
ErrorMessage?: string;
|
|
2971
|
+
/**
|
|
2972
|
+
* <p>The current version of the harvest job. Used for concurrency control.</p>
|
|
2973
|
+
* @public
|
|
2974
|
+
*/
|
|
2975
|
+
ETag?: string;
|
|
2976
|
+
}
|
|
2977
|
+
/**
|
|
2978
|
+
* <p>The response object containing the list of harvest jobs that match the specified criteria.</p>
|
|
2979
|
+
* @public
|
|
2980
|
+
*/
|
|
2981
|
+
export interface ListHarvestJobsResponse {
|
|
2982
|
+
/**
|
|
2983
|
+
* <p>An array of harvest job objects that match the specified criteria.</p>
|
|
2984
|
+
* @public
|
|
2985
|
+
*/
|
|
2986
|
+
Items?: HarvestJob[];
|
|
2987
|
+
/**
|
|
2988
|
+
* <p>A token used for pagination. Include this value in subsequent requests to retrieve the next set of results. If null, there are no more results to retrieve.</p>
|
|
2989
|
+
* @public
|
|
2990
|
+
*/
|
|
2991
|
+
NextToken?: string;
|
|
2992
|
+
}
|
|
2465
2993
|
/**
|
|
2466
2994
|
* @public
|
|
2467
2995
|
*/
|