@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
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
|
|
2
|
+
import { CancelHarvestJobCommandInput, CancelHarvestJobCommandOutput } from "./commands/CancelHarvestJobCommand";
|
|
2
3
|
import { CreateChannelCommandInput, CreateChannelCommandOutput } from "./commands/CreateChannelCommand";
|
|
3
4
|
import { CreateChannelGroupCommandInput, CreateChannelGroupCommandOutput } from "./commands/CreateChannelGroupCommand";
|
|
5
|
+
import { CreateHarvestJobCommandInput, CreateHarvestJobCommandOutput } from "./commands/CreateHarvestJobCommand";
|
|
4
6
|
import { CreateOriginEndpointCommandInput, CreateOriginEndpointCommandOutput } from "./commands/CreateOriginEndpointCommand";
|
|
5
7
|
import { DeleteChannelCommandInput, DeleteChannelCommandOutput } from "./commands/DeleteChannelCommand";
|
|
6
8
|
import { DeleteChannelGroupCommandInput, DeleteChannelGroupCommandOutput } from "./commands/DeleteChannelGroupCommand";
|
|
@@ -10,10 +12,12 @@ import { DeleteOriginEndpointPolicyCommandInput, DeleteOriginEndpointPolicyComma
|
|
|
10
12
|
import { GetChannelCommandInput, GetChannelCommandOutput } from "./commands/GetChannelCommand";
|
|
11
13
|
import { GetChannelGroupCommandInput, GetChannelGroupCommandOutput } from "./commands/GetChannelGroupCommand";
|
|
12
14
|
import { GetChannelPolicyCommandInput, GetChannelPolicyCommandOutput } from "./commands/GetChannelPolicyCommand";
|
|
15
|
+
import { GetHarvestJobCommandInput, GetHarvestJobCommandOutput } from "./commands/GetHarvestJobCommand";
|
|
13
16
|
import { GetOriginEndpointCommandInput, GetOriginEndpointCommandOutput } from "./commands/GetOriginEndpointCommand";
|
|
14
17
|
import { GetOriginEndpointPolicyCommandInput, GetOriginEndpointPolicyCommandOutput } from "./commands/GetOriginEndpointPolicyCommand";
|
|
15
18
|
import { ListChannelGroupsCommandInput, ListChannelGroupsCommandOutput } from "./commands/ListChannelGroupsCommand";
|
|
16
19
|
import { ListChannelsCommandInput, ListChannelsCommandOutput } from "./commands/ListChannelsCommand";
|
|
20
|
+
import { ListHarvestJobsCommandInput, ListHarvestJobsCommandOutput } from "./commands/ListHarvestJobsCommand";
|
|
17
21
|
import { ListOriginEndpointsCommandInput, ListOriginEndpointsCommandOutput } from "./commands/ListOriginEndpointsCommand";
|
|
18
22
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
19
23
|
import { PutChannelPolicyCommandInput, PutChannelPolicyCommandOutput } from "./commands/PutChannelPolicyCommand";
|
|
@@ -25,6 +29,12 @@ import { UpdateChannelGroupCommandInput, UpdateChannelGroupCommandOutput } from
|
|
|
25
29
|
import { UpdateOriginEndpointCommandInput, UpdateOriginEndpointCommandOutput } from "./commands/UpdateOriginEndpointCommand";
|
|
26
30
|
import { MediaPackageV2Client } from "./MediaPackageV2Client";
|
|
27
31
|
export interface MediaPackageV2 {
|
|
32
|
+
/**
|
|
33
|
+
* @see {@link CancelHarvestJobCommand}
|
|
34
|
+
*/
|
|
35
|
+
cancelHarvestJob(args: CancelHarvestJobCommandInput, options?: __HttpHandlerOptions): Promise<CancelHarvestJobCommandOutput>;
|
|
36
|
+
cancelHarvestJob(args: CancelHarvestJobCommandInput, cb: (err: any, data?: CancelHarvestJobCommandOutput) => void): void;
|
|
37
|
+
cancelHarvestJob(args: CancelHarvestJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelHarvestJobCommandOutput) => void): void;
|
|
28
38
|
/**
|
|
29
39
|
* @see {@link CreateChannelCommand}
|
|
30
40
|
*/
|
|
@@ -37,6 +47,12 @@ export interface MediaPackageV2 {
|
|
|
37
47
|
createChannelGroup(args: CreateChannelGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelGroupCommandOutput>;
|
|
38
48
|
createChannelGroup(args: CreateChannelGroupCommandInput, cb: (err: any, data?: CreateChannelGroupCommandOutput) => void): void;
|
|
39
49
|
createChannelGroup(args: CreateChannelGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelGroupCommandOutput) => void): void;
|
|
50
|
+
/**
|
|
51
|
+
* @see {@link CreateHarvestJobCommand}
|
|
52
|
+
*/
|
|
53
|
+
createHarvestJob(args: CreateHarvestJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateHarvestJobCommandOutput>;
|
|
54
|
+
createHarvestJob(args: CreateHarvestJobCommandInput, cb: (err: any, data?: CreateHarvestJobCommandOutput) => void): void;
|
|
55
|
+
createHarvestJob(args: CreateHarvestJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHarvestJobCommandOutput) => void): void;
|
|
40
56
|
/**
|
|
41
57
|
* @see {@link CreateOriginEndpointCommand}
|
|
42
58
|
*/
|
|
@@ -91,6 +107,12 @@ export interface MediaPackageV2 {
|
|
|
91
107
|
getChannelPolicy(args: GetChannelPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetChannelPolicyCommandOutput>;
|
|
92
108
|
getChannelPolicy(args: GetChannelPolicyCommandInput, cb: (err: any, data?: GetChannelPolicyCommandOutput) => void): void;
|
|
93
109
|
getChannelPolicy(args: GetChannelPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelPolicyCommandOutput) => void): void;
|
|
110
|
+
/**
|
|
111
|
+
* @see {@link GetHarvestJobCommand}
|
|
112
|
+
*/
|
|
113
|
+
getHarvestJob(args: GetHarvestJobCommandInput, options?: __HttpHandlerOptions): Promise<GetHarvestJobCommandOutput>;
|
|
114
|
+
getHarvestJob(args: GetHarvestJobCommandInput, cb: (err: any, data?: GetHarvestJobCommandOutput) => void): void;
|
|
115
|
+
getHarvestJob(args: GetHarvestJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHarvestJobCommandOutput) => void): void;
|
|
94
116
|
/**
|
|
95
117
|
* @see {@link GetOriginEndpointCommand}
|
|
96
118
|
*/
|
|
@@ -116,6 +138,12 @@ export interface MediaPackageV2 {
|
|
|
116
138
|
listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelsCommandOutput>;
|
|
117
139
|
listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
|
|
118
140
|
listChannels(args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
|
|
141
|
+
/**
|
|
142
|
+
* @see {@link ListHarvestJobsCommand}
|
|
143
|
+
*/
|
|
144
|
+
listHarvestJobs(args: ListHarvestJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListHarvestJobsCommandOutput>;
|
|
145
|
+
listHarvestJobs(args: ListHarvestJobsCommandInput, cb: (err: any, data?: ListHarvestJobsCommandOutput) => void): void;
|
|
146
|
+
listHarvestJobs(args: ListHarvestJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHarvestJobsCommandOutput) => void): void;
|
|
119
147
|
/**
|
|
120
148
|
* @see {@link ListOriginEndpointsCommand}
|
|
121
149
|
*/
|
|
@@ -7,8 +7,10 @@ import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol
|
|
|
7
7
|
import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
|
|
8
8
|
import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
|
|
9
9
|
import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
|
|
10
|
+
import { CancelHarvestJobCommandInput, CancelHarvestJobCommandOutput } from "./commands/CancelHarvestJobCommand";
|
|
10
11
|
import { CreateChannelCommandInput, CreateChannelCommandOutput } from "./commands/CreateChannelCommand";
|
|
11
12
|
import { CreateChannelGroupCommandInput, CreateChannelGroupCommandOutput } from "./commands/CreateChannelGroupCommand";
|
|
13
|
+
import { CreateHarvestJobCommandInput, CreateHarvestJobCommandOutput } from "./commands/CreateHarvestJobCommand";
|
|
12
14
|
import { CreateOriginEndpointCommandInput, CreateOriginEndpointCommandOutput } from "./commands/CreateOriginEndpointCommand";
|
|
13
15
|
import { DeleteChannelCommandInput, DeleteChannelCommandOutput } from "./commands/DeleteChannelCommand";
|
|
14
16
|
import { DeleteChannelGroupCommandInput, DeleteChannelGroupCommandOutput } from "./commands/DeleteChannelGroupCommand";
|
|
@@ -18,10 +20,12 @@ import { DeleteOriginEndpointPolicyCommandInput, DeleteOriginEndpointPolicyComma
|
|
|
18
20
|
import { GetChannelCommandInput, GetChannelCommandOutput } from "./commands/GetChannelCommand";
|
|
19
21
|
import { GetChannelGroupCommandInput, GetChannelGroupCommandOutput } from "./commands/GetChannelGroupCommand";
|
|
20
22
|
import { GetChannelPolicyCommandInput, GetChannelPolicyCommandOutput } from "./commands/GetChannelPolicyCommand";
|
|
23
|
+
import { GetHarvestJobCommandInput, GetHarvestJobCommandOutput } from "./commands/GetHarvestJobCommand";
|
|
21
24
|
import { GetOriginEndpointCommandInput, GetOriginEndpointCommandOutput } from "./commands/GetOriginEndpointCommand";
|
|
22
25
|
import { GetOriginEndpointPolicyCommandInput, GetOriginEndpointPolicyCommandOutput } from "./commands/GetOriginEndpointPolicyCommand";
|
|
23
26
|
import { ListChannelGroupsCommandInput, ListChannelGroupsCommandOutput } from "./commands/ListChannelGroupsCommand";
|
|
24
27
|
import { ListChannelsCommandInput, ListChannelsCommandOutput } from "./commands/ListChannelsCommand";
|
|
28
|
+
import { ListHarvestJobsCommandInput, ListHarvestJobsCommandOutput } from "./commands/ListHarvestJobsCommand";
|
|
25
29
|
import { ListOriginEndpointsCommandInput, ListOriginEndpointsCommandOutput } from "./commands/ListOriginEndpointsCommand";
|
|
26
30
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
27
31
|
import { PutChannelPolicyCommandInput, PutChannelPolicyCommandOutput } from "./commands/PutChannelPolicyCommand";
|
|
@@ -37,11 +41,11 @@ export { __Client };
|
|
|
37
41
|
/**
|
|
38
42
|
* @public
|
|
39
43
|
*/
|
|
40
|
-
export type ServiceInputTypes = CreateChannelCommandInput | CreateChannelGroupCommandInput | CreateOriginEndpointCommandInput | DeleteChannelCommandInput | DeleteChannelGroupCommandInput | DeleteChannelPolicyCommandInput | DeleteOriginEndpointCommandInput | DeleteOriginEndpointPolicyCommandInput | GetChannelCommandInput | GetChannelGroupCommandInput | GetChannelPolicyCommandInput | GetOriginEndpointCommandInput | GetOriginEndpointPolicyCommandInput | ListChannelGroupsCommandInput | ListChannelsCommandInput | ListOriginEndpointsCommandInput | ListTagsForResourceCommandInput | PutChannelPolicyCommandInput | PutOriginEndpointPolicyCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateChannelCommandInput | UpdateChannelGroupCommandInput | UpdateOriginEndpointCommandInput;
|
|
44
|
+
export type ServiceInputTypes = CancelHarvestJobCommandInput | CreateChannelCommandInput | CreateChannelGroupCommandInput | CreateHarvestJobCommandInput | CreateOriginEndpointCommandInput | DeleteChannelCommandInput | DeleteChannelGroupCommandInput | DeleteChannelPolicyCommandInput | DeleteOriginEndpointCommandInput | DeleteOriginEndpointPolicyCommandInput | GetChannelCommandInput | GetChannelGroupCommandInput | GetChannelPolicyCommandInput | GetHarvestJobCommandInput | GetOriginEndpointCommandInput | GetOriginEndpointPolicyCommandInput | ListChannelGroupsCommandInput | ListChannelsCommandInput | ListHarvestJobsCommandInput | ListOriginEndpointsCommandInput | ListTagsForResourceCommandInput | PutChannelPolicyCommandInput | PutOriginEndpointPolicyCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateChannelCommandInput | UpdateChannelGroupCommandInput | UpdateOriginEndpointCommandInput;
|
|
41
45
|
/**
|
|
42
46
|
* @public
|
|
43
47
|
*/
|
|
44
|
-
export type ServiceOutputTypes = CreateChannelCommandOutput | CreateChannelGroupCommandOutput | CreateOriginEndpointCommandOutput | DeleteChannelCommandOutput | DeleteChannelGroupCommandOutput | DeleteChannelPolicyCommandOutput | DeleteOriginEndpointCommandOutput | DeleteOriginEndpointPolicyCommandOutput | GetChannelCommandOutput | GetChannelGroupCommandOutput | GetChannelPolicyCommandOutput | GetOriginEndpointCommandOutput | GetOriginEndpointPolicyCommandOutput | ListChannelGroupsCommandOutput | ListChannelsCommandOutput | ListOriginEndpointsCommandOutput | ListTagsForResourceCommandOutput | PutChannelPolicyCommandOutput | PutOriginEndpointPolicyCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateChannelCommandOutput | UpdateChannelGroupCommandOutput | UpdateOriginEndpointCommandOutput;
|
|
48
|
+
export type ServiceOutputTypes = CancelHarvestJobCommandOutput | CreateChannelCommandOutput | CreateChannelGroupCommandOutput | CreateHarvestJobCommandOutput | CreateOriginEndpointCommandOutput | DeleteChannelCommandOutput | DeleteChannelGroupCommandOutput | DeleteChannelPolicyCommandOutput | DeleteOriginEndpointCommandOutput | DeleteOriginEndpointPolicyCommandOutput | GetChannelCommandOutput | GetChannelGroupCommandOutput | GetChannelPolicyCommandOutput | GetHarvestJobCommandOutput | GetOriginEndpointCommandOutput | GetOriginEndpointPolicyCommandOutput | ListChannelGroupsCommandOutput | ListChannelsCommandOutput | ListHarvestJobsCommandOutput | ListOriginEndpointsCommandOutput | ListTagsForResourceCommandOutput | PutChannelPolicyCommandOutput | PutOriginEndpointPolicyCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateChannelCommandOutput | UpdateChannelGroupCommandOutput | UpdateOriginEndpointCommandOutput;
|
|
45
49
|
/**
|
|
46
50
|
* @public
|
|
47
51
|
*/
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { MediaPackageV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MediaPackageV2Client";
|
|
4
|
+
import { CancelHarvestJobRequest, CancelHarvestJobResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CancelHarvestJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CancelHarvestJobCommandInput extends CancelHarvestJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CancelHarvestJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CancelHarvestJobCommandOutput extends CancelHarvestJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CancelHarvestJobCommand_base: {
|
|
25
|
+
new (input: CancelHarvestJobCommandInput): import("@smithy/smithy-client").CommandImpl<CancelHarvestJobCommandInput, CancelHarvestJobCommandOutput, MediaPackageV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CancelHarvestJobCommandInput): import("@smithy/smithy-client").CommandImpl<CancelHarvestJobCommandInput, CancelHarvestJobCommandOutput, MediaPackageV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Cancels an in-progress harvest job.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { MediaPackageV2Client, CancelHarvestJobCommand } from "@aws-sdk/client-mediapackagev2"; // ES Modules import
|
|
35
|
+
* // const { MediaPackageV2Client, CancelHarvestJobCommand } = require("@aws-sdk/client-mediapackagev2"); // CommonJS import
|
|
36
|
+
* const client = new MediaPackageV2Client(config);
|
|
37
|
+
* const input = { // CancelHarvestJobRequest
|
|
38
|
+
* ChannelGroupName: "STRING_VALUE", // required
|
|
39
|
+
* ChannelName: "STRING_VALUE", // required
|
|
40
|
+
* OriginEndpointName: "STRING_VALUE", // required
|
|
41
|
+
* HarvestJobName: "STRING_VALUE", // required
|
|
42
|
+
* ETag: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new CancelHarvestJobCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // {};
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param CancelHarvestJobCommandInput - {@link CancelHarvestJobCommandInput}
|
|
51
|
+
* @returns {@link CancelHarvestJobCommandOutput}
|
|
52
|
+
* @see {@link CancelHarvestJobCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link CancelHarvestJobCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link MediaPackageV2ClientResolvedConfig | config} for MediaPackageV2Client's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
57
|
+
* <p>You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ConflictException} (client fault)
|
|
60
|
+
* <p>Updating or deleting this resource can cause an inconsistent state.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServerException} (server fault)
|
|
63
|
+
* <p>Indicates that an error from the service occurred while trying to process a request.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
|
+
* <p>The specified resource doesn't exist.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
69
|
+
* <p>The request throughput limit was exceeded.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ValidationException} (client fault)
|
|
72
|
+
* <p>The input failed to meet the constraints specified by the AWS service.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link MediaPackageV2ServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
|
|
76
|
+
*
|
|
77
|
+
* @public
|
|
78
|
+
* @example Cancel a Harvest Job
|
|
79
|
+
* ```javascript
|
|
80
|
+
* //
|
|
81
|
+
* const input = {
|
|
82
|
+
* "ChannelGroupName": "exampleChannelGroup",
|
|
83
|
+
* "ChannelName": "exampleChannelName",
|
|
84
|
+
* "HarvestJobName": "HarvestJobName",
|
|
85
|
+
* "OriginEndpointName": "exampleOriginEndpointName"
|
|
86
|
+
* };
|
|
87
|
+
* const command = new CancelHarvestJobCommand(input);
|
|
88
|
+
* await client.send(command);
|
|
89
|
+
* // example id: example-1
|
|
90
|
+
* ```
|
|
91
|
+
*
|
|
92
|
+
*/
|
|
93
|
+
export declare class CancelHarvestJobCommand extends CancelHarvestJobCommand_base {
|
|
94
|
+
/** @internal type navigation helper, not in runtime. */
|
|
95
|
+
protected static __types: {
|
|
96
|
+
api: {
|
|
97
|
+
input: CancelHarvestJobRequest;
|
|
98
|
+
output: {};
|
|
99
|
+
};
|
|
100
|
+
sdk: {
|
|
101
|
+
input: CancelHarvestJobCommandInput;
|
|
102
|
+
output: CancelHarvestJobCommandOutput;
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
}
|
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { MediaPackageV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MediaPackageV2Client";
|
|
4
|
+
import { CreateHarvestJobRequest, CreateHarvestJobResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateHarvestJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateHarvestJobCommandInput extends CreateHarvestJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateHarvestJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateHarvestJobCommandOutput extends CreateHarvestJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateHarvestJobCommand_base: {
|
|
25
|
+
new (input: CreateHarvestJobCommandInput): import("@smithy/smithy-client").CommandImpl<CreateHarvestJobCommandInput, CreateHarvestJobCommandOutput, MediaPackageV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CreateHarvestJobCommandInput): import("@smithy/smithy-client").CommandImpl<CreateHarvestJobCommandInput, CreateHarvestJobCommandOutput, MediaPackageV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { MediaPackageV2Client, CreateHarvestJobCommand } from "@aws-sdk/client-mediapackagev2"; // ES Modules import
|
|
35
|
+
* // const { MediaPackageV2Client, CreateHarvestJobCommand } = require("@aws-sdk/client-mediapackagev2"); // CommonJS import
|
|
36
|
+
* const client = new MediaPackageV2Client(config);
|
|
37
|
+
* const input = { // CreateHarvestJobRequest
|
|
38
|
+
* ChannelGroupName: "STRING_VALUE", // required
|
|
39
|
+
* ChannelName: "STRING_VALUE", // required
|
|
40
|
+
* OriginEndpointName: "STRING_VALUE", // required
|
|
41
|
+
* Description: "STRING_VALUE",
|
|
42
|
+
* HarvestedManifests: { // HarvestedManifests
|
|
43
|
+
* HlsManifests: [ // HarvestedHlsManifestsList
|
|
44
|
+
* { // HarvestedHlsManifest
|
|
45
|
+
* ManifestName: "STRING_VALUE", // required
|
|
46
|
+
* },
|
|
47
|
+
* ],
|
|
48
|
+
* DashManifests: [ // HarvestedDashManifestsList
|
|
49
|
+
* { // HarvestedDashManifest
|
|
50
|
+
* ManifestName: "STRING_VALUE", // required
|
|
51
|
+
* },
|
|
52
|
+
* ],
|
|
53
|
+
* LowLatencyHlsManifests: [ // HarvestedLowLatencyHlsManifestsList
|
|
54
|
+
* { // HarvestedLowLatencyHlsManifest
|
|
55
|
+
* ManifestName: "STRING_VALUE", // required
|
|
56
|
+
* },
|
|
57
|
+
* ],
|
|
58
|
+
* },
|
|
59
|
+
* ScheduleConfiguration: { // HarvesterScheduleConfiguration
|
|
60
|
+
* StartTime: new Date("TIMESTAMP"), // required
|
|
61
|
+
* EndTime: new Date("TIMESTAMP"), // required
|
|
62
|
+
* },
|
|
63
|
+
* Destination: { // Destination
|
|
64
|
+
* S3Destination: { // S3DestinationConfig
|
|
65
|
+
* BucketName: "STRING_VALUE", // required
|
|
66
|
+
* DestinationPath: "STRING_VALUE", // required
|
|
67
|
+
* },
|
|
68
|
+
* },
|
|
69
|
+
* ClientToken: "STRING_VALUE",
|
|
70
|
+
* HarvestJobName: "STRING_VALUE",
|
|
71
|
+
* Tags: { // TagMap
|
|
72
|
+
* "<keys>": "STRING_VALUE",
|
|
73
|
+
* },
|
|
74
|
+
* };
|
|
75
|
+
* const command = new CreateHarvestJobCommand(input);
|
|
76
|
+
* const response = await client.send(command);
|
|
77
|
+
* // { // CreateHarvestJobResponse
|
|
78
|
+
* // ChannelGroupName: "STRING_VALUE", // required
|
|
79
|
+
* // ChannelName: "STRING_VALUE", // required
|
|
80
|
+
* // OriginEndpointName: "STRING_VALUE", // required
|
|
81
|
+
* // Destination: { // Destination
|
|
82
|
+
* // S3Destination: { // S3DestinationConfig
|
|
83
|
+
* // BucketName: "STRING_VALUE", // required
|
|
84
|
+
* // DestinationPath: "STRING_VALUE", // required
|
|
85
|
+
* // },
|
|
86
|
+
* // },
|
|
87
|
+
* // HarvestJobName: "STRING_VALUE", // required
|
|
88
|
+
* // HarvestedManifests: { // HarvestedManifests
|
|
89
|
+
* // HlsManifests: [ // HarvestedHlsManifestsList
|
|
90
|
+
* // { // HarvestedHlsManifest
|
|
91
|
+
* // ManifestName: "STRING_VALUE", // required
|
|
92
|
+
* // },
|
|
93
|
+
* // ],
|
|
94
|
+
* // DashManifests: [ // HarvestedDashManifestsList
|
|
95
|
+
* // { // HarvestedDashManifest
|
|
96
|
+
* // ManifestName: "STRING_VALUE", // required
|
|
97
|
+
* // },
|
|
98
|
+
* // ],
|
|
99
|
+
* // LowLatencyHlsManifests: [ // HarvestedLowLatencyHlsManifestsList
|
|
100
|
+
* // { // HarvestedLowLatencyHlsManifest
|
|
101
|
+
* // ManifestName: "STRING_VALUE", // required
|
|
102
|
+
* // },
|
|
103
|
+
* // ],
|
|
104
|
+
* // },
|
|
105
|
+
* // Description: "STRING_VALUE",
|
|
106
|
+
* // ScheduleConfiguration: { // HarvesterScheduleConfiguration
|
|
107
|
+
* // StartTime: new Date("TIMESTAMP"), // required
|
|
108
|
+
* // EndTime: new Date("TIMESTAMP"), // required
|
|
109
|
+
* // },
|
|
110
|
+
* // Arn: "STRING_VALUE", // required
|
|
111
|
+
* // CreatedAt: new Date("TIMESTAMP"), // required
|
|
112
|
+
* // ModifiedAt: new Date("TIMESTAMP"), // required
|
|
113
|
+
* // Status: "QUEUED" || "IN_PROGRESS" || "CANCELLED" || "COMPLETED" || "FAILED", // required
|
|
114
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
115
|
+
* // ETag: "STRING_VALUE",
|
|
116
|
+
* // Tags: { // TagMap
|
|
117
|
+
* // "<keys>": "STRING_VALUE",
|
|
118
|
+
* // },
|
|
119
|
+
* // };
|
|
120
|
+
*
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* @param CreateHarvestJobCommandInput - {@link CreateHarvestJobCommandInput}
|
|
124
|
+
* @returns {@link CreateHarvestJobCommandOutput}
|
|
125
|
+
* @see {@link CreateHarvestJobCommandInput} for command's `input` shape.
|
|
126
|
+
* @see {@link CreateHarvestJobCommandOutput} for command's `response` shape.
|
|
127
|
+
* @see {@link MediaPackageV2ClientResolvedConfig | config} for MediaPackageV2Client's `config` shape.
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
130
|
+
* <p>You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.</p>
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link ConflictException} (client fault)
|
|
133
|
+
* <p>Updating or deleting this resource can cause an inconsistent state.</p>
|
|
134
|
+
*
|
|
135
|
+
* @throws {@link InternalServerException} (server fault)
|
|
136
|
+
* <p>Indicates that an error from the service occurred while trying to process a request.</p>
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
139
|
+
* <p>The specified resource doesn't exist.</p>
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
142
|
+
* <p>The request would cause a service quota to be exceeded.</p>
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
145
|
+
* <p>The request throughput limit was exceeded.</p>
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link ValidationException} (client fault)
|
|
148
|
+
* <p>The input failed to meet the constraints specified by the AWS service.</p>
|
|
149
|
+
*
|
|
150
|
+
* @throws {@link MediaPackageV2ServiceException}
|
|
151
|
+
* <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
|
|
152
|
+
*
|
|
153
|
+
* @public
|
|
154
|
+
* @example Creating a Harvest Job
|
|
155
|
+
* ```javascript
|
|
156
|
+
* //
|
|
157
|
+
* const input = {
|
|
158
|
+
* "ChannelGroupName": "exampleChannelGroup",
|
|
159
|
+
* "ChannelName": "exampleChannelName",
|
|
160
|
+
* "Description": "Example HarvestJob description",
|
|
161
|
+
* "Destination": {
|
|
162
|
+
* "S3Destination": {
|
|
163
|
+
* "BucketName": "harvestJobS3DestinationBucket",
|
|
164
|
+
* "DestinationPath": "manifests"
|
|
165
|
+
* }
|
|
166
|
+
* },
|
|
167
|
+
* "HarvestedManifests": {
|
|
168
|
+
* "DashManifests": [
|
|
169
|
+
* {
|
|
170
|
+
* "ManifestName": "DashManifest"
|
|
171
|
+
* }
|
|
172
|
+
* ],
|
|
173
|
+
* "HlsManifests": [
|
|
174
|
+
* {
|
|
175
|
+
* "ManifestName": "HlsManifest"
|
|
176
|
+
* }
|
|
177
|
+
* ],
|
|
178
|
+
* "LowLatencyHlsManifests": [
|
|
179
|
+
* {
|
|
180
|
+
* "ManifestName": "LowLatencyHlsManifest"
|
|
181
|
+
* }
|
|
182
|
+
* ]
|
|
183
|
+
* },
|
|
184
|
+
* "OriginEndpointName": "exampleOriginEndpointName",
|
|
185
|
+
* "ScheduleConfiguration": {
|
|
186
|
+
* "EndTime": "2024-05-28T12:00:00.00Z",
|
|
187
|
+
* "StartTime": "2024-05-28T06:00:00.00Z"
|
|
188
|
+
* }
|
|
189
|
+
* };
|
|
190
|
+
* const command = new CreateHarvestJobCommand(input);
|
|
191
|
+
* const response = await client.send(command);
|
|
192
|
+
* /* response ==
|
|
193
|
+
* {
|
|
194
|
+
* "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName",
|
|
195
|
+
* "ChannelGroupName": "exampleChannelGroup",
|
|
196
|
+
* "ChannelName": "exampleChannelName",
|
|
197
|
+
* "CreatedAt": "2024-05-28T09:36:00.00Z",
|
|
198
|
+
* "Description": "Example HarvestJob description",
|
|
199
|
+
* "Destination": {
|
|
200
|
+
* "S3Destination": {
|
|
201
|
+
* "BucketName": "harvestJobS3DestinationBucket",
|
|
202
|
+
* "DestinationPath": "manifests"
|
|
203
|
+
* }
|
|
204
|
+
* },
|
|
205
|
+
* "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=",
|
|
206
|
+
* "HarvestJobName": "HarvestJobName",
|
|
207
|
+
* "HarvestedManifests": {
|
|
208
|
+
* "DashManifests": [
|
|
209
|
+
* {
|
|
210
|
+
* "ManifestName": "DashManifest"
|
|
211
|
+
* }
|
|
212
|
+
* ],
|
|
213
|
+
* "HlsManifests": [
|
|
214
|
+
* {
|
|
215
|
+
* "ManifestName": "HlsManifest"
|
|
216
|
+
* }
|
|
217
|
+
* ],
|
|
218
|
+
* "LowLatencyHlsManifests": [
|
|
219
|
+
* {
|
|
220
|
+
* "ManifestName": "LowLatencyHlsManifest"
|
|
221
|
+
* }
|
|
222
|
+
* ]
|
|
223
|
+
* },
|
|
224
|
+
* "ModifiedAt": "2024-05-28T09:36:00.00Z",
|
|
225
|
+
* "OriginEndpointName": "exampleOriginEndpointName",
|
|
226
|
+
* "ScheduleConfiguration": {
|
|
227
|
+
* "EndTime": "2024-05-28T12:00:00.00Z",
|
|
228
|
+
* "StartTime": "2024-05-28T06:00:00.00Z"
|
|
229
|
+
* },
|
|
230
|
+
* "Status": "QUEUED",
|
|
231
|
+
* "Tags": {
|
|
232
|
+
* "key1": "value1",
|
|
233
|
+
* "key2": "value2"
|
|
234
|
+
* }
|
|
235
|
+
* }
|
|
236
|
+
* *\/
|
|
237
|
+
* // example id: example-1
|
|
238
|
+
* ```
|
|
239
|
+
*
|
|
240
|
+
*/
|
|
241
|
+
export declare class CreateHarvestJobCommand extends CreateHarvestJobCommand_base {
|
|
242
|
+
/** @internal type navigation helper, not in runtime. */
|
|
243
|
+
protected static __types: {
|
|
244
|
+
api: {
|
|
245
|
+
input: CreateHarvestJobRequest;
|
|
246
|
+
output: CreateHarvestJobResponse;
|
|
247
|
+
};
|
|
248
|
+
sdk: {
|
|
249
|
+
input: CreateHarvestJobCommandInput;
|
|
250
|
+
output: CreateHarvestJobCommandOutput;
|
|
251
|
+
};
|
|
252
|
+
};
|
|
253
|
+
}
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { MediaPackageV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MediaPackageV2Client";
|
|
4
|
+
import { GetHarvestJobRequest, GetHarvestJobResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetHarvestJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetHarvestJobCommandInput extends GetHarvestJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetHarvestJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetHarvestJobCommandOutput extends GetHarvestJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetHarvestJobCommand_base: {
|
|
25
|
+
new (input: GetHarvestJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetHarvestJobCommandInput, GetHarvestJobCommandOutput, MediaPackageV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetHarvestJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetHarvestJobCommandInput, GetHarvestJobCommandOutput, MediaPackageV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves the details of a specific harvest job.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { MediaPackageV2Client, GetHarvestJobCommand } from "@aws-sdk/client-mediapackagev2"; // ES Modules import
|
|
35
|
+
* // const { MediaPackageV2Client, GetHarvestJobCommand } = require("@aws-sdk/client-mediapackagev2"); // CommonJS import
|
|
36
|
+
* const client = new MediaPackageV2Client(config);
|
|
37
|
+
* const input = { // GetHarvestJobRequest
|
|
38
|
+
* ChannelGroupName: "STRING_VALUE", // required
|
|
39
|
+
* ChannelName: "STRING_VALUE", // required
|
|
40
|
+
* OriginEndpointName: "STRING_VALUE", // required
|
|
41
|
+
* HarvestJobName: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetHarvestJobCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetHarvestJobResponse
|
|
46
|
+
* // ChannelGroupName: "STRING_VALUE", // required
|
|
47
|
+
* // ChannelName: "STRING_VALUE", // required
|
|
48
|
+
* // OriginEndpointName: "STRING_VALUE", // required
|
|
49
|
+
* // Destination: { // Destination
|
|
50
|
+
* // S3Destination: { // S3DestinationConfig
|
|
51
|
+
* // BucketName: "STRING_VALUE", // required
|
|
52
|
+
* // DestinationPath: "STRING_VALUE", // required
|
|
53
|
+
* // },
|
|
54
|
+
* // },
|
|
55
|
+
* // HarvestJobName: "STRING_VALUE", // required
|
|
56
|
+
* // HarvestedManifests: { // HarvestedManifests
|
|
57
|
+
* // HlsManifests: [ // HarvestedHlsManifestsList
|
|
58
|
+
* // { // HarvestedHlsManifest
|
|
59
|
+
* // ManifestName: "STRING_VALUE", // required
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // DashManifests: [ // HarvestedDashManifestsList
|
|
63
|
+
* // { // HarvestedDashManifest
|
|
64
|
+
* // ManifestName: "STRING_VALUE", // required
|
|
65
|
+
* // },
|
|
66
|
+
* // ],
|
|
67
|
+
* // LowLatencyHlsManifests: [ // HarvestedLowLatencyHlsManifestsList
|
|
68
|
+
* // { // HarvestedLowLatencyHlsManifest
|
|
69
|
+
* // ManifestName: "STRING_VALUE", // required
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // },
|
|
73
|
+
* // Description: "STRING_VALUE",
|
|
74
|
+
* // ScheduleConfiguration: { // HarvesterScheduleConfiguration
|
|
75
|
+
* // StartTime: new Date("TIMESTAMP"), // required
|
|
76
|
+
* // EndTime: new Date("TIMESTAMP"), // required
|
|
77
|
+
* // },
|
|
78
|
+
* // Arn: "STRING_VALUE", // required
|
|
79
|
+
* // CreatedAt: new Date("TIMESTAMP"), // required
|
|
80
|
+
* // ModifiedAt: new Date("TIMESTAMP"), // required
|
|
81
|
+
* // Status: "QUEUED" || "IN_PROGRESS" || "CANCELLED" || "COMPLETED" || "FAILED", // required
|
|
82
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
83
|
+
* // ETag: "STRING_VALUE",
|
|
84
|
+
* // Tags: { // TagMap
|
|
85
|
+
* // "<keys>": "STRING_VALUE",
|
|
86
|
+
* // },
|
|
87
|
+
* // };
|
|
88
|
+
*
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
91
|
+
* @param GetHarvestJobCommandInput - {@link GetHarvestJobCommandInput}
|
|
92
|
+
* @returns {@link GetHarvestJobCommandOutput}
|
|
93
|
+
* @see {@link GetHarvestJobCommandInput} for command's `input` shape.
|
|
94
|
+
* @see {@link GetHarvestJobCommandOutput} for command's `response` shape.
|
|
95
|
+
* @see {@link MediaPackageV2ClientResolvedConfig | config} for MediaPackageV2Client's `config` shape.
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
98
|
+
* <p>You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link InternalServerException} (server fault)
|
|
101
|
+
* <p>Indicates that an error from the service occurred while trying to process a request.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
104
|
+
* <p>The specified resource doesn't exist.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
107
|
+
* <p>The request throughput limit was exceeded.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link ValidationException} (client fault)
|
|
110
|
+
* <p>The input failed to meet the constraints specified by the AWS service.</p>
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link MediaPackageV2ServiceException}
|
|
113
|
+
* <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
|
|
114
|
+
*
|
|
115
|
+
* @public
|
|
116
|
+
* @example Getting a Harvest Job
|
|
117
|
+
* ```javascript
|
|
118
|
+
* //
|
|
119
|
+
* const input = {
|
|
120
|
+
* "ChannelGroupName": "exampleChannelGroup",
|
|
121
|
+
* "ChannelName": "exampleChannelName",
|
|
122
|
+
* "HarvestJobName": "HarvestJobName",
|
|
123
|
+
* "OriginEndpointName": "exampleOriginEndpointName"
|
|
124
|
+
* };
|
|
125
|
+
* const command = new GetHarvestJobCommand(input);
|
|
126
|
+
* const response = await client.send(command);
|
|
127
|
+
* /* response ==
|
|
128
|
+
* {
|
|
129
|
+
* "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName",
|
|
130
|
+
* "ChannelGroupName": "exampleChannelGroup",
|
|
131
|
+
* "ChannelName": "exampleChannelName",
|
|
132
|
+
* "CreatedAt": "2024-05-28T09:36:00.00Z",
|
|
133
|
+
* "Description": "Example HarvestJob description",
|
|
134
|
+
* "Destination": {
|
|
135
|
+
* "S3Destination": {
|
|
136
|
+
* "BucketName": "harvestJobS3DestinationBucket",
|
|
137
|
+
* "DestinationPath": "manifests"
|
|
138
|
+
* }
|
|
139
|
+
* },
|
|
140
|
+
* "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=",
|
|
141
|
+
* "HarvestJobName": "HarvestJobName",
|
|
142
|
+
* "HarvestedManifests": {
|
|
143
|
+
* "DashManifests": [
|
|
144
|
+
* {
|
|
145
|
+
* "ManifestName": "DashManifest"
|
|
146
|
+
* }
|
|
147
|
+
* ],
|
|
148
|
+
* "HlsManifests": [
|
|
149
|
+
* {
|
|
150
|
+
* "ManifestName": "HlsManifest"
|
|
151
|
+
* }
|
|
152
|
+
* ],
|
|
153
|
+
* "LowLatencyHlsManifests": [
|
|
154
|
+
* {
|
|
155
|
+
* "ManifestName": "LowLatencyHlsManifest"
|
|
156
|
+
* }
|
|
157
|
+
* ]
|
|
158
|
+
* },
|
|
159
|
+
* "ModifiedAt": "2024-05-28T09:36:00.00Z",
|
|
160
|
+
* "OriginEndpointName": "exampleOriginEndpointName",
|
|
161
|
+
* "ScheduleConfiguration": {
|
|
162
|
+
* "EndTime": "2024-05-28T12:00:00.00Z",
|
|
163
|
+
* "StartTime": "2024-05-28T06:00:00.00Z"
|
|
164
|
+
* },
|
|
165
|
+
* "Status": "QUEUED",
|
|
166
|
+
* "Tags": {
|
|
167
|
+
* "key1": "value1",
|
|
168
|
+
* "key2": "value2"
|
|
169
|
+
* }
|
|
170
|
+
* }
|
|
171
|
+
* *\/
|
|
172
|
+
* // example id: example-1
|
|
173
|
+
* ```
|
|
174
|
+
*
|
|
175
|
+
*/
|
|
176
|
+
export declare class GetHarvestJobCommand extends GetHarvestJobCommand_base {
|
|
177
|
+
/** @internal type navigation helper, not in runtime. */
|
|
178
|
+
protected static __types: {
|
|
179
|
+
api: {
|
|
180
|
+
input: GetHarvestJobRequest;
|
|
181
|
+
output: GetHarvestJobResponse;
|
|
182
|
+
};
|
|
183
|
+
sdk: {
|
|
184
|
+
input: GetHarvestJobCommandInput;
|
|
185
|
+
output: GetHarvestJobCommandOutput;
|
|
186
|
+
};
|
|
187
|
+
};
|
|
188
|
+
}
|