@aws-sdk/client-data-pipeline 3.295.0 → 3.297.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/dist-types/DataPipeline.d.ts +284 -264
- package/dist-types/DataPipelineClient.d.ts +24 -4
- package/dist-types/commands/ActivatePipelineCommand.d.ts +18 -2
- package/dist-types/commands/AddTagsCommand.d.ts +16 -0
- package/dist-types/commands/CreatePipelineCommand.d.ts +19 -3
- package/dist-types/commands/DeactivatePipelineCommand.d.ts +16 -0
- package/dist-types/commands/DeletePipelineCommand.d.ts +17 -1
- package/dist-types/commands/DescribeObjectsCommand.d.ts +40 -24
- package/dist-types/commands/DescribePipelinesCommand.d.ts +42 -26
- package/dist-types/commands/EvaluateExpressionCommand.d.ts +19 -3
- package/dist-types/commands/GetPipelineDefinitionCommand.d.ts +43 -27
- package/dist-types/commands/ListPipelinesCommand.d.ts +23 -7
- package/dist-types/commands/PollForTaskCommand.d.ts +56 -40
- package/dist-types/commands/PutPipelineDefinitionCommand.d.ts +71 -55
- package/dist-types/commands/QueryObjectsCommand.d.ts +22 -6
- package/dist-types/commands/RemoveTagsCommand.d.ts +16 -0
- package/dist-types/commands/ReportTaskProgressCommand.d.ts +21 -5
- package/dist-types/commands/ReportTaskRunnerHeartbeatCommand.d.ts +19 -3
- package/dist-types/commands/SetStatusCommand.d.ts +18 -2
- package/dist-types/commands/SetTaskStatusCommand.d.ts +19 -3
- package/dist-types/commands/ValidatePipelineDefinitionCommand.d.ts +73 -57
- package/dist-types/models/DataPipelineServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +62 -0
- package/dist-types/pagination/DescribeObjectsPaginator.d.ts +3 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListPipelinesPaginator.d.ts +3 -0
- package/dist-types/pagination/QueryObjectsPaginator.d.ts +3 -0
- package/package.json +29 -29
|
@@ -27,15 +27,24 @@ import { SetStatusCommandInput, SetStatusCommandOutput } from "./commands/SetSta
|
|
|
27
27
|
import { SetTaskStatusCommandInput, SetTaskStatusCommandOutput } from "./commands/SetTaskStatusCommand";
|
|
28
28
|
import { ValidatePipelineDefinitionCommandInput, ValidatePipelineDefinitionCommandOutput } from "./commands/ValidatePipelineDefinitionCommand";
|
|
29
29
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
30
|
+
/**
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
30
33
|
export type ServiceInputTypes = ActivatePipelineCommandInput | AddTagsCommandInput | CreatePipelineCommandInput | DeactivatePipelineCommandInput | DeletePipelineCommandInput | DescribeObjectsCommandInput | DescribePipelinesCommandInput | EvaluateExpressionCommandInput | GetPipelineDefinitionCommandInput | ListPipelinesCommandInput | PollForTaskCommandInput | PutPipelineDefinitionCommandInput | QueryObjectsCommandInput | RemoveTagsCommandInput | ReportTaskProgressCommandInput | ReportTaskRunnerHeartbeatCommandInput | SetStatusCommandInput | SetTaskStatusCommandInput | ValidatePipelineDefinitionCommandInput;
|
|
34
|
+
/**
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
31
37
|
export type ServiceOutputTypes = ActivatePipelineCommandOutput | AddTagsCommandOutput | CreatePipelineCommandOutput | DeactivatePipelineCommandOutput | DeletePipelineCommandOutput | DescribeObjectsCommandOutput | DescribePipelinesCommandOutput | EvaluateExpressionCommandOutput | GetPipelineDefinitionCommandOutput | ListPipelinesCommandOutput | PollForTaskCommandOutput | PutPipelineDefinitionCommandOutput | QueryObjectsCommandOutput | RemoveTagsCommandOutput | ReportTaskProgressCommandOutput | ReportTaskRunnerHeartbeatCommandOutput | SetStatusCommandOutput | SetTaskStatusCommandOutput | ValidatePipelineDefinitionCommandOutput;
|
|
38
|
+
/**
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
32
41
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
33
42
|
/**
|
|
34
43
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
35
44
|
*/
|
|
36
45
|
requestHandler?: __HttpHandler;
|
|
37
46
|
/**
|
|
38
|
-
* A constructor for a class implementing the {@link
|
|
47
|
+
* A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
|
|
39
48
|
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
40
49
|
* @internal
|
|
41
50
|
*/
|
|
@@ -125,23 +134,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
125
134
|
*/
|
|
126
135
|
logger?: __Logger;
|
|
127
136
|
/**
|
|
128
|
-
* The {@link
|
|
137
|
+
* The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
129
138
|
*/
|
|
130
139
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
131
140
|
}
|
|
141
|
+
/**
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
132
144
|
type DataPipelineClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
133
145
|
/**
|
|
134
|
-
*
|
|
146
|
+
* @public
|
|
147
|
+
*
|
|
148
|
+
* The configuration interface of DataPipelineClient class constructor that set the region, credentials and other options.
|
|
135
149
|
*/
|
|
136
150
|
export interface DataPipelineClientConfig extends DataPipelineClientConfigType {
|
|
137
151
|
}
|
|
152
|
+
/**
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
138
155
|
type DataPipelineClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
139
156
|
/**
|
|
140
|
-
*
|
|
157
|
+
* @public
|
|
158
|
+
*
|
|
159
|
+
* The resolved configuration interface of DataPipelineClient class. This is resolved and normalized from the {@link DataPipelineClientConfig | constructor configuration interface}.
|
|
141
160
|
*/
|
|
142
161
|
export interface DataPipelineClientResolvedConfig extends DataPipelineClientResolvedConfigType {
|
|
143
162
|
}
|
|
144
163
|
/**
|
|
164
|
+
* @public
|
|
145
165
|
* <p>AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline
|
|
146
166
|
* handles the details of scheduling and ensuring that data dependencies are met so that your application
|
|
147
167
|
* can focus on processing the data.</p>
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DataPipelineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataPipelineClient";
|
|
5
5
|
import { ActivatePipelineInput, ActivatePipelineOutput } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link ActivatePipelineCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface ActivatePipelineCommandInput extends ActivatePipelineInput {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link ActivatePipelineCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface ActivatePipelineCommandOutput extends ActivatePipelineOutput, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation,
|
|
18
23
|
* activation fails.</p>
|
|
19
24
|
* <p>If you need to pause the pipeline to investigate an issue with a component, such as a data source or script,
|
|
@@ -30,7 +35,7 @@ export interface ActivatePipelineCommandOutput extends ActivatePipelineOutput, _
|
|
|
30
35
|
* X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
|
|
31
36
|
* Authorization: AuthParams
|
|
32
37
|
*
|
|
33
|
-
* {"pipelineId": "df-06372391ZG65EXAMPLE"}
|
|
38
|
+
* \{"pipelineId": "df-06372391ZG65EXAMPLE"\}
|
|
34
39
|
*
|
|
35
40
|
* </request>
|
|
36
41
|
* <response>
|
|
@@ -41,7 +46,7 @@ export interface ActivatePipelineCommandOutput extends ActivatePipelineOutput, _
|
|
|
41
46
|
* Content-Length: 2
|
|
42
47
|
* Date: Mon, 12 Nov 2012 17:50:53 GMT
|
|
43
48
|
*
|
|
44
|
-
* {}
|
|
49
|
+
* \{\}
|
|
45
50
|
*
|
|
46
51
|
* </response>
|
|
47
52
|
* </examples>
|
|
@@ -55,6 +60,8 @@ export interface ActivatePipelineCommandOutput extends ActivatePipelineOutput, _
|
|
|
55
60
|
* const response = await client.send(command);
|
|
56
61
|
* ```
|
|
57
62
|
*
|
|
63
|
+
* @param ActivatePipelineCommandInput - {@link ActivatePipelineCommandInput}
|
|
64
|
+
* @returns {@link ActivatePipelineCommandOutput}
|
|
58
65
|
* @see {@link ActivatePipelineCommandInput} for command's `input` shape.
|
|
59
66
|
* @see {@link ActivatePipelineCommandOutput} for command's `response` shape.
|
|
60
67
|
* @see {@link DataPipelineClientResolvedConfig | config} for DataPipelineClient's `config` shape.
|
|
@@ -76,11 +83,20 @@ export interface ActivatePipelineCommandOutput extends ActivatePipelineOutput, _
|
|
|
76
83
|
export declare class ActivatePipelineCommand extends $Command<ActivatePipelineCommandInput, ActivatePipelineCommandOutput, DataPipelineClientResolvedConfig> {
|
|
77
84
|
readonly input: ActivatePipelineCommandInput;
|
|
78
85
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
86
|
+
/**
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
79
89
|
constructor(input: ActivatePipelineCommandInput);
|
|
80
90
|
/**
|
|
81
91
|
* @internal
|
|
82
92
|
*/
|
|
83
93
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ActivatePipelineCommandInput, ActivatePipelineCommandOutput>;
|
|
94
|
+
/**
|
|
95
|
+
* @internal
|
|
96
|
+
*/
|
|
84
97
|
private serialize;
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
85
101
|
private deserialize;
|
|
86
102
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DataPipelineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataPipelineClient";
|
|
5
5
|
import { AddTagsInput, AddTagsOutput } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link AddTagsCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface AddTagsCommandInput extends AddTagsInput {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link AddTagsCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Adds or modifies tags for the specified pipeline.</p>
|
|
18
23
|
* @example
|
|
19
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -25,6 +30,8 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
|
|
|
25
30
|
* const response = await client.send(command);
|
|
26
31
|
* ```
|
|
27
32
|
*
|
|
33
|
+
* @param AddTagsCommandInput - {@link AddTagsCommandInput}
|
|
34
|
+
* @returns {@link AddTagsCommandOutput}
|
|
28
35
|
* @see {@link AddTagsCommandInput} for command's `input` shape.
|
|
29
36
|
* @see {@link AddTagsCommandOutput} for command's `response` shape.
|
|
30
37
|
* @see {@link DataPipelineClientResolvedConfig | config} for DataPipelineClient's `config` shape.
|
|
@@ -46,11 +53,20 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
|
|
|
46
53
|
export declare class AddTagsCommand extends $Command<AddTagsCommandInput, AddTagsCommandOutput, DataPipelineClientResolvedConfig> {
|
|
47
54
|
readonly input: AddTagsCommandInput;
|
|
48
55
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
56
|
+
/**
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
49
59
|
constructor(input: AddTagsCommandInput);
|
|
50
60
|
/**
|
|
51
61
|
* @internal
|
|
52
62
|
*/
|
|
53
63
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AddTagsCommandInput, AddTagsCommandOutput>;
|
|
64
|
+
/**
|
|
65
|
+
* @internal
|
|
66
|
+
*/
|
|
54
67
|
private serialize;
|
|
68
|
+
/**
|
|
69
|
+
* @internal
|
|
70
|
+
*/
|
|
55
71
|
private deserialize;
|
|
56
72
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DataPipelineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataPipelineClient";
|
|
5
5
|
import { CreatePipelineInput, CreatePipelineOutput } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link CreatePipelineCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface CreatePipelineCommandInput extends CreatePipelineInput {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link CreatePipelineCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Creates a new, empty pipeline. Use <a>PutPipelineDefinition</a> to populate the pipeline.</p>
|
|
18
23
|
*
|
|
19
24
|
* <examples>
|
|
@@ -27,9 +32,9 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met
|
|
|
27
32
|
* X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
|
|
28
33
|
* Authorization: AuthParams
|
|
29
34
|
*
|
|
30
|
-
* {"name": "myPipeline",
|
|
35
|
+
* \{"name": "myPipeline",
|
|
31
36
|
* "uniqueId": "123456789",
|
|
32
|
-
* "description": "This is my first pipeline"}
|
|
37
|
+
* "description": "This is my first pipeline"\}
|
|
33
38
|
*
|
|
34
39
|
* </request>
|
|
35
40
|
*
|
|
@@ -41,7 +46,7 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met
|
|
|
41
46
|
* Content-Length: 40
|
|
42
47
|
* Date: Mon, 12 Nov 2012 17:50:53 GMT
|
|
43
48
|
*
|
|
44
|
-
* {"pipelineId": "df-06372391ZG65EXAMPLE"}
|
|
49
|
+
* \{"pipelineId": "df-06372391ZG65EXAMPLE"\}
|
|
45
50
|
*
|
|
46
51
|
* </response>
|
|
47
52
|
* </examples>
|
|
@@ -55,6 +60,8 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met
|
|
|
55
60
|
* const response = await client.send(command);
|
|
56
61
|
* ```
|
|
57
62
|
*
|
|
63
|
+
* @param CreatePipelineCommandInput - {@link CreatePipelineCommandInput}
|
|
64
|
+
* @returns {@link CreatePipelineCommandOutput}
|
|
58
65
|
* @see {@link CreatePipelineCommandInput} for command's `input` shape.
|
|
59
66
|
* @see {@link CreatePipelineCommandOutput} for command's `response` shape.
|
|
60
67
|
* @see {@link DataPipelineClientResolvedConfig | config} for DataPipelineClient's `config` shape.
|
|
@@ -70,11 +77,20 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met
|
|
|
70
77
|
export declare class CreatePipelineCommand extends $Command<CreatePipelineCommandInput, CreatePipelineCommandOutput, DataPipelineClientResolvedConfig> {
|
|
71
78
|
readonly input: CreatePipelineCommandInput;
|
|
72
79
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
80
|
+
/**
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
73
83
|
constructor(input: CreatePipelineCommandInput);
|
|
74
84
|
/**
|
|
75
85
|
* @internal
|
|
76
86
|
*/
|
|
77
87
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePipelineCommandInput, CreatePipelineCommandOutput>;
|
|
88
|
+
/**
|
|
89
|
+
* @internal
|
|
90
|
+
*/
|
|
78
91
|
private serialize;
|
|
92
|
+
/**
|
|
93
|
+
* @internal
|
|
94
|
+
*/
|
|
79
95
|
private deserialize;
|
|
80
96
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DataPipelineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataPipelineClient";
|
|
5
5
|
import { DeactivatePipelineInput, DeactivatePipelineOutput } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DeactivatePipelineCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DeactivatePipelineCommandInput extends DeactivatePipelineInput {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DeactivatePipelineCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DeactivatePipelineCommandOutput extends DeactivatePipelineOutput, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Deactivates the specified running pipeline. The pipeline is set to the <code>DEACTIVATING</code>
|
|
18
23
|
* state until the deactivation process completes.</p>
|
|
19
24
|
* <p>To resume a deactivated pipeline, use <a>ActivatePipeline</a>. By default, the pipeline resumes from the last completed execution.
|
|
@@ -28,6 +33,8 @@ export interface DeactivatePipelineCommandOutput extends DeactivatePipelineOutpu
|
|
|
28
33
|
* const response = await client.send(command);
|
|
29
34
|
* ```
|
|
30
35
|
*
|
|
36
|
+
* @param DeactivatePipelineCommandInput - {@link DeactivatePipelineCommandInput}
|
|
37
|
+
* @returns {@link DeactivatePipelineCommandOutput}
|
|
31
38
|
* @see {@link DeactivatePipelineCommandInput} for command's `input` shape.
|
|
32
39
|
* @see {@link DeactivatePipelineCommandOutput} for command's `response` shape.
|
|
33
40
|
* @see {@link DataPipelineClientResolvedConfig | config} for DataPipelineClient's `config` shape.
|
|
@@ -49,11 +56,20 @@ export interface DeactivatePipelineCommandOutput extends DeactivatePipelineOutpu
|
|
|
49
56
|
export declare class DeactivatePipelineCommand extends $Command<DeactivatePipelineCommandInput, DeactivatePipelineCommandOutput, DataPipelineClientResolvedConfig> {
|
|
50
57
|
readonly input: DeactivatePipelineCommandInput;
|
|
51
58
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
59
|
+
/**
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
52
62
|
constructor(input: DeactivatePipelineCommandInput);
|
|
53
63
|
/**
|
|
54
64
|
* @internal
|
|
55
65
|
*/
|
|
56
66
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeactivatePipelineCommandInput, DeactivatePipelineCommandOutput>;
|
|
67
|
+
/**
|
|
68
|
+
* @internal
|
|
69
|
+
*/
|
|
57
70
|
private serialize;
|
|
71
|
+
/**
|
|
72
|
+
* @internal
|
|
73
|
+
*/
|
|
58
74
|
private deserialize;
|
|
59
75
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DataPipelineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataPipelineClient";
|
|
5
5
|
import { DeletePipelineInput } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DeletePipelineCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DeletePipelineCommandInput extends DeletePipelineInput {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DeletePipelineCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DeletePipelineCommandOutput extends __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Deletes a pipeline, its pipeline definition, and its run history.
|
|
18
23
|
* AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.</p>
|
|
19
24
|
* <p>Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline.
|
|
@@ -31,7 +36,7 @@ export interface DeletePipelineCommandOutput extends __MetadataBearer {
|
|
|
31
36
|
* X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
|
|
32
37
|
* Authorization: AuthParams
|
|
33
38
|
*
|
|
34
|
-
* {"pipelineId": "df-06372391ZG65EXAMPLE"}
|
|
39
|
+
* \{"pipelineId": "df-06372391ZG65EXAMPLE"\}
|
|
35
40
|
*
|
|
36
41
|
* </request>
|
|
37
42
|
*
|
|
@@ -56,6 +61,8 @@ export interface DeletePipelineCommandOutput extends __MetadataBearer {
|
|
|
56
61
|
* const response = await client.send(command);
|
|
57
62
|
* ```
|
|
58
63
|
*
|
|
64
|
+
* @param DeletePipelineCommandInput - {@link DeletePipelineCommandInput}
|
|
65
|
+
* @returns {@link DeletePipelineCommandOutput}
|
|
59
66
|
* @see {@link DeletePipelineCommandInput} for command's `input` shape.
|
|
60
67
|
* @see {@link DeletePipelineCommandOutput} for command's `response` shape.
|
|
61
68
|
* @see {@link DataPipelineClientResolvedConfig | config} for DataPipelineClient's `config` shape.
|
|
@@ -74,11 +81,20 @@ export interface DeletePipelineCommandOutput extends __MetadataBearer {
|
|
|
74
81
|
export declare class DeletePipelineCommand extends $Command<DeletePipelineCommandInput, DeletePipelineCommandOutput, DataPipelineClientResolvedConfig> {
|
|
75
82
|
readonly input: DeletePipelineCommandInput;
|
|
76
83
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
84
|
+
/**
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
77
87
|
constructor(input: DeletePipelineCommandInput);
|
|
78
88
|
/**
|
|
79
89
|
* @internal
|
|
80
90
|
*/
|
|
81
91
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePipelineCommandInput, DeletePipelineCommandOutput>;
|
|
92
|
+
/**
|
|
93
|
+
* @internal
|
|
94
|
+
*/
|
|
82
95
|
private serialize;
|
|
96
|
+
/**
|
|
97
|
+
* @internal
|
|
98
|
+
*/
|
|
83
99
|
private deserialize;
|
|
84
100
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DataPipelineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataPipelineClient";
|
|
5
5
|
import { DescribeObjectsInput, DescribeObjectsOutput } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DescribeObjectsCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DescribeObjectsCommandInput extends DescribeObjectsInput {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DescribeObjectsCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DescribeObjectsCommandOutput extends DescribeObjectsOutput, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of
|
|
18
23
|
* a set of fields that define the properties of the object.</p>
|
|
19
24
|
*
|
|
@@ -28,10 +33,10 @@ export interface DescribeObjectsCommandOutput extends DescribeObjectsOutput, __M
|
|
|
28
33
|
* X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
|
|
29
34
|
* Authorization: AuthParams
|
|
30
35
|
*
|
|
31
|
-
* {"pipelineId": "df-06372391ZG65EXAMPLE",
|
|
36
|
+
* \{"pipelineId": "df-06372391ZG65EXAMPLE",
|
|
32
37
|
* "objectIds":
|
|
33
38
|
* ["Schedule"],
|
|
34
|
-
* "evaluateExpressions": true}
|
|
39
|
+
* "evaluateExpressions": true\}
|
|
35
40
|
*
|
|
36
41
|
* </request>
|
|
37
42
|
*
|
|
@@ -42,34 +47,34 @@ export interface DescribeObjectsCommandOutput extends DescribeObjectsOutput, __M
|
|
|
42
47
|
* Content-Length: 1488
|
|
43
48
|
* Date: Mon, 12 Nov 2012 17:50:53 GMT
|
|
44
49
|
*
|
|
45
|
-
* {"hasMoreResults": false,
|
|
50
|
+
* \{"hasMoreResults": false,
|
|
46
51
|
* "pipelineObjects":
|
|
47
52
|
* [
|
|
48
|
-
* {"fields":
|
|
53
|
+
* \{"fields":
|
|
49
54
|
* [
|
|
50
|
-
* {"key": "startDateTime",
|
|
51
|
-
* "stringValue": "2012-12-12T00:00:00"},
|
|
52
|
-
* {"key": "parent",
|
|
53
|
-
* "refValue": "Default"},
|
|
54
|
-
* {"key": "@sphere",
|
|
55
|
-
* "stringValue": "COMPONENT"},
|
|
56
|
-
* {"key": "type",
|
|
57
|
-
* "stringValue": "Schedule"},
|
|
58
|
-
* {"key": "period",
|
|
59
|
-
* "stringValue": "1 hour"},
|
|
60
|
-
* {"key": "endDateTime",
|
|
61
|
-
* "stringValue": "2012-12-21T18:00:00"},
|
|
62
|
-
* {"key": "@version",
|
|
63
|
-
* "stringValue": "1"},
|
|
64
|
-
* {"key": "@status",
|
|
65
|
-
* "stringValue": "PENDING"},
|
|
66
|
-
* {"key": "@pipelineId",
|
|
67
|
-
* "stringValue": "df-06372391ZG65EXAMPLE"}
|
|
55
|
+
* \{"key": "startDateTime",
|
|
56
|
+
* "stringValue": "2012-12-12T00:00:00"\},
|
|
57
|
+
* \{"key": "parent",
|
|
58
|
+
* "refValue": "Default"\},
|
|
59
|
+
* \{"key": "@sphere",
|
|
60
|
+
* "stringValue": "COMPONENT"\},
|
|
61
|
+
* \{"key": "type",
|
|
62
|
+
* "stringValue": "Schedule"\},
|
|
63
|
+
* \{"key": "period",
|
|
64
|
+
* "stringValue": "1 hour"\},
|
|
65
|
+
* \{"key": "endDateTime",
|
|
66
|
+
* "stringValue": "2012-12-21T18:00:00"\},
|
|
67
|
+
* \{"key": "@version",
|
|
68
|
+
* "stringValue": "1"\},
|
|
69
|
+
* \{"key": "@status",
|
|
70
|
+
* "stringValue": "PENDING"\},
|
|
71
|
+
* \{"key": "@pipelineId",
|
|
72
|
+
* "stringValue": "df-06372391ZG65EXAMPLE"\}
|
|
68
73
|
* ],
|
|
69
74
|
* "id": "Schedule",
|
|
70
|
-
* "name": "Schedule"}
|
|
75
|
+
* "name": "Schedule"\}
|
|
71
76
|
* ]
|
|
72
|
-
* }
|
|
77
|
+
* \}
|
|
73
78
|
*
|
|
74
79
|
* </response>
|
|
75
80
|
* </examples>
|
|
@@ -83,6 +88,8 @@ export interface DescribeObjectsCommandOutput extends DescribeObjectsOutput, __M
|
|
|
83
88
|
* const response = await client.send(command);
|
|
84
89
|
* ```
|
|
85
90
|
*
|
|
91
|
+
* @param DescribeObjectsCommandInput - {@link DescribeObjectsCommandInput}
|
|
92
|
+
* @returns {@link DescribeObjectsCommandOutput}
|
|
86
93
|
* @see {@link DescribeObjectsCommandInput} for command's `input` shape.
|
|
87
94
|
* @see {@link DescribeObjectsCommandOutput} for command's `response` shape.
|
|
88
95
|
* @see {@link DataPipelineClientResolvedConfig | config} for DataPipelineClient's `config` shape.
|
|
@@ -104,11 +111,20 @@ export interface DescribeObjectsCommandOutput extends DescribeObjectsOutput, __M
|
|
|
104
111
|
export declare class DescribeObjectsCommand extends $Command<DescribeObjectsCommandInput, DescribeObjectsCommandOutput, DataPipelineClientResolvedConfig> {
|
|
105
112
|
readonly input: DescribeObjectsCommandInput;
|
|
106
113
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
114
|
+
/**
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
107
117
|
constructor(input: DescribeObjectsCommandInput);
|
|
108
118
|
/**
|
|
109
119
|
* @internal
|
|
110
120
|
*/
|
|
111
121
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeObjectsCommandInput, DescribeObjectsCommandOutput>;
|
|
122
|
+
/**
|
|
123
|
+
* @internal
|
|
124
|
+
*/
|
|
112
125
|
private serialize;
|
|
126
|
+
/**
|
|
127
|
+
* @internal
|
|
128
|
+
*/
|
|
113
129
|
private deserialize;
|
|
114
130
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DataPipelineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataPipelineClient";
|
|
5
5
|
import { DescribePipelinesInput, DescribePipelinesOutput } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DescribePipelinesCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DescribePipelinesCommandInput extends DescribePipelinesInput {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DescribePipelinesCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DescribePipelinesCommandOutput extends DescribePipelinesOutput, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier,
|
|
18
23
|
* its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines
|
|
19
24
|
* that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines
|
|
@@ -31,9 +36,9 @@ export interface DescribePipelinesCommandOutput extends DescribePipelinesOutput,
|
|
|
31
36
|
* X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
|
|
32
37
|
* Authorization: AuthParams
|
|
33
38
|
*
|
|
34
|
-
* {"pipelineIds":
|
|
39
|
+
* \{"pipelineIds":
|
|
35
40
|
* ["df-08785951KAKJEXAMPLE"]
|
|
36
|
-
* }
|
|
41
|
+
* \}
|
|
37
42
|
*
|
|
38
43
|
* </request>
|
|
39
44
|
*
|
|
@@ -44,36 +49,36 @@ export interface DescribePipelinesCommandOutput extends DescribePipelinesOutput,
|
|
|
44
49
|
* Content-Length: 767
|
|
45
50
|
* Date: Mon, 12 Nov 2012 17:50:53 GMT
|
|
46
51
|
*
|
|
47
|
-
* {"pipelineDescriptionList":
|
|
52
|
+
* \{"pipelineDescriptionList":
|
|
48
53
|
* [
|
|
49
|
-
* {"description": "This is my first pipeline",
|
|
54
|
+
* \{"description": "This is my first pipeline",
|
|
50
55
|
* "fields":
|
|
51
56
|
* [
|
|
52
|
-
* {"key": "@pipelineState",
|
|
53
|
-
* "stringValue": "SCHEDULED"},
|
|
54
|
-
* {"key": "description",
|
|
55
|
-
* "stringValue": "This is my first pipeline"},
|
|
56
|
-
* {"key": "name",
|
|
57
|
-
* "stringValue": "myPipeline"},
|
|
58
|
-
* {"key": "@creationTime",
|
|
59
|
-
* "stringValue": "2012-12-13T01:24:06"},
|
|
60
|
-
* {"key": "@id",
|
|
61
|
-
* "stringValue": "df-0937003356ZJEXAMPLE"},
|
|
62
|
-
* {"key": "@sphere",
|
|
63
|
-
* "stringValue": "PIPELINE"},
|
|
64
|
-
* {"key": "@version",
|
|
65
|
-
* "stringValue": "1"},
|
|
66
|
-
* {"key": "@userId",
|
|
67
|
-
* "stringValue": "924374875933"},
|
|
68
|
-
* {"key": "@accountId",
|
|
69
|
-
* "stringValue": "924374875933"},
|
|
70
|
-
* {"key": "uniqueId",
|
|
71
|
-
* "stringValue": "1234567890"}
|
|
57
|
+
* \{"key": "@pipelineState",
|
|
58
|
+
* "stringValue": "SCHEDULED"\},
|
|
59
|
+
* \{"key": "description",
|
|
60
|
+
* "stringValue": "This is my first pipeline"\},
|
|
61
|
+
* \{"key": "name",
|
|
62
|
+
* "stringValue": "myPipeline"\},
|
|
63
|
+
* \{"key": "@creationTime",
|
|
64
|
+
* "stringValue": "2012-12-13T01:24:06"\},
|
|
65
|
+
* \{"key": "@id",
|
|
66
|
+
* "stringValue": "df-0937003356ZJEXAMPLE"\},
|
|
67
|
+
* \{"key": "@sphere",
|
|
68
|
+
* "stringValue": "PIPELINE"\},
|
|
69
|
+
* \{"key": "@version",
|
|
70
|
+
* "stringValue": "1"\},
|
|
71
|
+
* \{"key": "@userId",
|
|
72
|
+
* "stringValue": "924374875933"\},
|
|
73
|
+
* \{"key": "@accountId",
|
|
74
|
+
* "stringValue": "924374875933"\},
|
|
75
|
+
* \{"key": "uniqueId",
|
|
76
|
+
* "stringValue": "1234567890"\}
|
|
72
77
|
* ],
|
|
73
78
|
* "name": "myPipeline",
|
|
74
|
-
* "pipelineId": "df-0937003356ZJEXAMPLE"}
|
|
79
|
+
* "pipelineId": "df-0937003356ZJEXAMPLE"\}
|
|
75
80
|
* ]
|
|
76
|
-
* }
|
|
81
|
+
* \}
|
|
77
82
|
* </response>
|
|
78
83
|
* </examples>
|
|
79
84
|
* @example
|
|
@@ -86,6 +91,8 @@ export interface DescribePipelinesCommandOutput extends DescribePipelinesOutput,
|
|
|
86
91
|
* const response = await client.send(command);
|
|
87
92
|
* ```
|
|
88
93
|
*
|
|
94
|
+
* @param DescribePipelinesCommandInput - {@link DescribePipelinesCommandInput}
|
|
95
|
+
* @returns {@link DescribePipelinesCommandOutput}
|
|
89
96
|
* @see {@link DescribePipelinesCommandInput} for command's `input` shape.
|
|
90
97
|
* @see {@link DescribePipelinesCommandOutput} for command's `response` shape.
|
|
91
98
|
* @see {@link DataPipelineClientResolvedConfig | config} for DataPipelineClient's `config` shape.
|
|
@@ -107,11 +114,20 @@ export interface DescribePipelinesCommandOutput extends DescribePipelinesOutput,
|
|
|
107
114
|
export declare class DescribePipelinesCommand extends $Command<DescribePipelinesCommandInput, DescribePipelinesCommandOutput, DataPipelineClientResolvedConfig> {
|
|
108
115
|
readonly input: DescribePipelinesCommandInput;
|
|
109
116
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
117
|
+
/**
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
110
120
|
constructor(input: DescribePipelinesCommandInput);
|
|
111
121
|
/**
|
|
112
122
|
* @internal
|
|
113
123
|
*/
|
|
114
124
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribePipelinesCommandInput, DescribePipelinesCommandOutput>;
|
|
125
|
+
/**
|
|
126
|
+
* @internal
|
|
127
|
+
*/
|
|
115
128
|
private serialize;
|
|
129
|
+
/**
|
|
130
|
+
* @internal
|
|
131
|
+
*/
|
|
116
132
|
private deserialize;
|
|
117
133
|
}
|