@aws-sdk/client-data-pipeline 3.36.0 → 3.39.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/CHANGELOG.md +42 -0
- package/dist-cjs/DataPipeline.js +0 -19
- package/dist-cjs/DataPipelineClient.js +0 -24
- package/dist-cjs/commands/ActivatePipelineCommand.js +0 -54
- package/dist-cjs/commands/AddTagsCommand.js +0 -24
- package/dist-cjs/commands/CreatePipelineCommand.js +0 -54
- package/dist-cjs/commands/DeactivatePipelineCommand.js +0 -27
- package/dist-cjs/commands/DeletePipelineCommand.js +0 -55
- package/dist-cjs/commands/DescribeObjectsCommand.js +0 -82
- package/dist-cjs/commands/DescribePipelinesCommand.js +0 -85
- package/dist-cjs/commands/EvaluateExpressionCommand.js +0 -54
- package/dist-cjs/commands/GetPipelineDefinitionCommand.js +0 -88
- package/dist-cjs/commands/ListPipelinesCommand.js +0 -55
- package/dist-cjs/commands/PollForTaskCommand.js +0 -102
- package/dist-cjs/commands/PutPipelineDefinitionCommand.js +0 -183
- package/dist-cjs/commands/QueryObjectsCommand.js +0 -62
- package/dist-cjs/commands/RemoveTagsCommand.js +0 -24
- package/dist-cjs/commands/ReportTaskProgressCommand.js +0 -61
- package/dist-cjs/commands/ReportTaskRunnerHeartbeatCommand.js +0 -56
- package/dist-cjs/commands/SetStatusCommand.js +0 -56
- package/dist-cjs/commands/SetTaskStatusCommand.js +0 -54
- package/dist-cjs/commands/ValidatePipelineDefinitionCommand.js +0 -175
- package/dist-cjs/commands/index.js +22 -0
- package/dist-cjs/endpoints.js +6 -1
- package/dist-cjs/index.js +4 -25
- package/dist-cjs/models/models_0.js +0 -168
- package/dist-cjs/pagination/DescribeObjectsPaginator.js +0 -10
- package/dist-cjs/pagination/ListPipelinesPaginator.js +0 -10
- package/dist-cjs/pagination/QueryObjectsPaginator.js +0 -10
- package/dist-cjs/pagination/index.js +7 -0
- package/dist-cjs/protocols/Aws_json1_1.js +0 -5
- package/dist-cjs/runtimeConfig.browser.js +1 -5
- package/dist-cjs/runtimeConfig.js +1 -5
- package/dist-cjs/runtimeConfig.native.js +0 -3
- package/dist-cjs/runtimeConfig.shared.js +0 -3
- package/dist-es/commands/index.js +19 -0
- package/dist-es/endpoints.js +6 -1
- package/dist-es/index.js +4 -25
- package/dist-es/pagination/index.js +4 -0
- package/dist-types/commands/index.d.ts +19 -0
- package/dist-types/index.d.ts +4 -25
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/DataPipeline.d.ts +20 -971
- package/dist-types/ts3.4/DataPipelineClient.d.ts +24 -105
- package/dist-types/ts3.4/commands/ActivatePipelineCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/AddTagsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/CreatePipelineCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/DeactivatePipelineCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/DeletePipelineCommand.d.ts +2 -51
- package/dist-types/ts3.4/commands/DescribeObjectsCommand.d.ts +2 -78
- package/dist-types/ts3.4/commands/DescribePipelinesCommand.d.ts +2 -81
- package/dist-types/ts3.4/commands/EvaluateExpressionCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/GetPipelineDefinitionCommand.d.ts +2 -84
- package/dist-types/ts3.4/commands/ListPipelinesCommand.d.ts +2 -51
- package/dist-types/ts3.4/commands/PollForTaskCommand.d.ts +2 -98
- package/dist-types/ts3.4/commands/PutPipelineDefinitionCommand.d.ts +2 -179
- package/dist-types/ts3.4/commands/QueryObjectsCommand.d.ts +2 -58
- package/dist-types/ts3.4/commands/RemoveTagsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/ReportTaskProgressCommand.d.ts +2 -57
- package/dist-types/ts3.4/commands/ReportTaskRunnerHeartbeatCommand.d.ts +2 -52
- package/dist-types/ts3.4/commands/SetStatusCommand.d.ts +2 -52
- package/dist-types/ts3.4/commands/SetTaskStatusCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/ValidatePipelineDefinitionCommand.d.ts +2 -171
- package/dist-types/ts3.4/commands/index.d.ts +19 -0
- package/dist-types/ts3.4/index.d.ts +4 -25
- package/dist-types/ts3.4/models/models_0.d.ts +231 -769
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
- package/package.json +32 -32
|
@@ -28,140 +28,59 @@ import { ValidatePipelineDefinitionCommandInput, ValidatePipelineDefinitionComma
|
|
|
28
28
|
export declare type ServiceInputTypes = ActivatePipelineCommandInput | AddTagsCommandInput | CreatePipelineCommandInput | DeactivatePipelineCommandInput | DeletePipelineCommandInput | DescribeObjectsCommandInput | DescribePipelinesCommandInput | EvaluateExpressionCommandInput | GetPipelineDefinitionCommandInput | ListPipelinesCommandInput | PollForTaskCommandInput | PutPipelineDefinitionCommandInput | QueryObjectsCommandInput | RemoveTagsCommandInput | ReportTaskProgressCommandInput | ReportTaskRunnerHeartbeatCommandInput | SetStatusCommandInput | SetTaskStatusCommandInput | ValidatePipelineDefinitionCommandInput;
|
|
29
29
|
export declare type ServiceOutputTypes = ActivatePipelineCommandOutput | AddTagsCommandOutput | CreatePipelineCommandOutput | DeactivatePipelineCommandOutput | DeletePipelineCommandOutput | DescribeObjectsCommandOutput | DescribePipelinesCommandOutput | EvaluateExpressionCommandOutput | GetPipelineDefinitionCommandOutput | ListPipelinesCommandOutput | PollForTaskCommandOutput | PutPipelineDefinitionCommandOutput | QueryObjectsCommandOutput | RemoveTagsCommandOutput | ReportTaskProgressCommandOutput | ReportTaskRunnerHeartbeatCommandOutput | SetStatusCommandOutput | SetTaskStatusCommandOutput | ValidatePipelineDefinitionCommandOutput;
|
|
30
30
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
31
|
-
|
|
32
|
-
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
33
|
-
*/
|
|
31
|
+
|
|
34
32
|
requestHandler?: __HttpHandler;
|
|
35
|
-
|
|
36
|
-
* A constructor for a class implementing the {@link __Hash} interface
|
|
37
|
-
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
38
|
-
* @internal
|
|
39
|
-
*/
|
|
33
|
+
|
|
40
34
|
sha256?: __HashConstructor;
|
|
41
|
-
|
|
42
|
-
* The function that will be used to convert strings into HTTP endpoints.
|
|
43
|
-
* @internal
|
|
44
|
-
*/
|
|
35
|
+
|
|
45
36
|
urlParser?: __UrlParser;
|
|
46
|
-
|
|
47
|
-
* A function that can calculate the length of a request body.
|
|
48
|
-
* @internal
|
|
49
|
-
*/
|
|
37
|
+
|
|
50
38
|
bodyLengthChecker?: (body: any) => number | undefined;
|
|
51
|
-
|
|
52
|
-
* A function that converts a stream into an array of bytes.
|
|
53
|
-
* @internal
|
|
54
|
-
*/
|
|
39
|
+
|
|
55
40
|
streamCollector?: __StreamCollector;
|
|
56
|
-
|
|
57
|
-
* The function that will be used to convert a base64-encoded string to a byte array.
|
|
58
|
-
* @internal
|
|
59
|
-
*/
|
|
41
|
+
|
|
60
42
|
base64Decoder?: __Decoder;
|
|
61
|
-
|
|
62
|
-
* The function that will be used to convert binary data to a base64-encoded string.
|
|
63
|
-
* @internal
|
|
64
|
-
*/
|
|
43
|
+
|
|
65
44
|
base64Encoder?: __Encoder;
|
|
66
|
-
|
|
67
|
-
* The function that will be used to convert a UTF8-encoded string to a byte array.
|
|
68
|
-
* @internal
|
|
69
|
-
*/
|
|
45
|
+
|
|
70
46
|
utf8Decoder?: __Decoder;
|
|
71
|
-
|
|
72
|
-
* The function that will be used to convert binary data to a UTF-8 encoded string.
|
|
73
|
-
* @internal
|
|
74
|
-
*/
|
|
47
|
+
|
|
75
48
|
utf8Encoder?: __Encoder;
|
|
76
|
-
|
|
77
|
-
* The runtime environment.
|
|
78
|
-
* @internal
|
|
79
|
-
*/
|
|
49
|
+
|
|
80
50
|
runtime?: string;
|
|
81
|
-
|
|
82
|
-
* Disable dyanamically changing the endpoint of the client based on the hostPrefix
|
|
83
|
-
* trait of an operation.
|
|
84
|
-
*/
|
|
51
|
+
|
|
85
52
|
disableHostPrefix?: boolean;
|
|
86
|
-
|
|
87
|
-
* Value for how many times a request will be made at most in case of retry.
|
|
88
|
-
*/
|
|
53
|
+
|
|
89
54
|
maxAttempts?: number | __Provider<number>;
|
|
90
|
-
|
|
91
|
-
* Specifies which retry algorithm to use.
|
|
92
|
-
*/
|
|
55
|
+
|
|
93
56
|
retryMode?: string | __Provider<string>;
|
|
94
|
-
|
|
95
|
-
* Optional logger for logging debug/info/warn/error.
|
|
96
|
-
*/
|
|
57
|
+
|
|
97
58
|
logger?: __Logger;
|
|
98
|
-
|
|
99
|
-
* Unique service identifier.
|
|
100
|
-
* @internal
|
|
101
|
-
*/
|
|
59
|
+
|
|
102
60
|
serviceId?: string;
|
|
103
|
-
|
|
104
|
-
* The AWS region to which this client will send requests
|
|
105
|
-
*/
|
|
61
|
+
|
|
106
62
|
region?: string | __Provider<string>;
|
|
107
|
-
|
|
108
|
-
* Default credentials provider; Not available in browser runtime.
|
|
109
|
-
* @internal
|
|
110
|
-
*/
|
|
63
|
+
|
|
111
64
|
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
|
|
112
|
-
|
|
113
|
-
* Fetch related hostname, signing name or signing region with given region.
|
|
114
|
-
* @internal
|
|
115
|
-
*/
|
|
65
|
+
|
|
116
66
|
regionInfoProvider?: RegionInfoProvider;
|
|
117
|
-
|
|
118
|
-
* The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
|
|
119
|
-
* @internal
|
|
120
|
-
*/
|
|
67
|
+
|
|
121
68
|
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
122
69
|
}
|
|
123
70
|
declare type DataPipelineClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
|
|
124
|
-
|
|
125
|
-
* The configuration interface of DataPipelineClient class constructor that set the region, credentials and other options.
|
|
126
|
-
*/
|
|
71
|
+
|
|
127
72
|
export interface DataPipelineClientConfig extends DataPipelineClientConfigType {
|
|
128
73
|
}
|
|
129
74
|
declare type DataPipelineClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
|
|
130
|
-
|
|
131
|
-
* The resolved configuration interface of DataPipelineClient class. This is resolved and normalized from the {@link DataPipelineClientConfig | constructor configuration interface}.
|
|
132
|
-
*/
|
|
75
|
+
|
|
133
76
|
export interface DataPipelineClientResolvedConfig extends DataPipelineClientResolvedConfigType {
|
|
134
77
|
}
|
|
135
|
-
|
|
136
|
-
* <p>AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline
|
|
137
|
-
* handles the details of scheduling and ensuring that data dependencies are met so that your application
|
|
138
|
-
* can focus on processing the data.</p>
|
|
139
|
-
*
|
|
140
|
-
* <p>AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner.
|
|
141
|
-
* AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing
|
|
142
|
-
* database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use
|
|
143
|
-
* AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide
|
|
144
|
-
* custom data management.</p>
|
|
145
|
-
*
|
|
146
|
-
* <p>AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline
|
|
147
|
-
* and define data sources, schedules, dependencies, and the transforms to be performed on the data.
|
|
148
|
-
* Use the second set in your task runner application to receive the next task ready for processing.
|
|
149
|
-
* The logic for performing the task, such as querying the data, running data analysis, or converting
|
|
150
|
-
* the data from one format to another, is contained within the task runner. The task runner performs
|
|
151
|
-
* the task assigned to it by the web service, reporting progress to the web service as it does so.
|
|
152
|
-
* When the task is done, the task runner reports the final success or failure of the task to the web service.</p>
|
|
153
|
-
*/
|
|
78
|
+
|
|
154
79
|
export declare class DataPipelineClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, DataPipelineClientResolvedConfig> {
|
|
155
|
-
|
|
156
|
-
* The resolved configuration of DataPipelineClient class. This is resolved and normalized from the {@link DataPipelineClientConfig | constructor configuration interface}.
|
|
157
|
-
*/
|
|
80
|
+
|
|
158
81
|
readonly config: DataPipelineClientResolvedConfig;
|
|
159
82
|
constructor(configuration: DataPipelineClientConfig);
|
|
160
|
-
|
|
161
|
-
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
|
|
162
|
-
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
|
|
163
|
-
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
|
|
164
|
-
*/
|
|
83
|
+
|
|
165
84
|
destroy(): void;
|
|
166
85
|
}
|
|
167
86
|
export {};
|
|
@@ -6,59 +6,11 @@ export interface ActivatePipelineCommandInput extends ActivatePipelineInput {
|
|
|
6
6
|
}
|
|
7
7
|
export interface ActivatePipelineCommandOutput extends ActivatePipelineOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation,
|
|
11
|
-
* activation fails.</p>
|
|
12
|
-
* <p>If you need to pause the pipeline to investigate an issue with a component, such as a data source or script,
|
|
13
|
-
* call <a>DeactivatePipeline</a>.</p>
|
|
14
|
-
* <p>To activate a finished pipeline, modify the end date for the pipeline and then activate it.</p>
|
|
15
|
-
* <examples>
|
|
16
|
-
* <request>
|
|
17
|
-
*
|
|
18
|
-
* POST / HTTP/1.1
|
|
19
|
-
* Content-Type: application/x-amz-json-1.1
|
|
20
|
-
* X-Amz-Target: DataPipeline.ActivatePipeline
|
|
21
|
-
* Content-Length: 39
|
|
22
|
-
* Host: datapipeline.us-east-1.amazonaws.com
|
|
23
|
-
* X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
|
|
24
|
-
* Authorization: AuthParams
|
|
25
|
-
*
|
|
26
|
-
* {"pipelineId": "df-06372391ZG65EXAMPLE"}
|
|
27
|
-
*
|
|
28
|
-
* </request>
|
|
29
|
-
* <response>
|
|
30
|
-
*
|
|
31
|
-
* HTTP/1.1 200
|
|
32
|
-
* x-amzn-RequestId: ee19d5bf-074e-11e2-af6f-6bc7a6be60d9
|
|
33
|
-
* Content-Type: application/x-amz-json-1.1
|
|
34
|
-
* Content-Length: 2
|
|
35
|
-
* Date: Mon, 12 Nov 2012 17:50:53 GMT
|
|
36
|
-
*
|
|
37
|
-
* {}
|
|
38
|
-
*
|
|
39
|
-
* </response>
|
|
40
|
-
* </examples>
|
|
41
|
-
* @example
|
|
42
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
43
|
-
* ```javascript
|
|
44
|
-
* import { DataPipelineClient, ActivatePipelineCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import
|
|
45
|
-
* // const { DataPipelineClient, ActivatePipelineCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import
|
|
46
|
-
* const client = new DataPipelineClient(config);
|
|
47
|
-
* const command = new ActivatePipelineCommand(input);
|
|
48
|
-
* const response = await client.send(command);
|
|
49
|
-
* ```
|
|
50
|
-
*
|
|
51
|
-
* @see {@link ActivatePipelineCommandInput} for command's `input` shape.
|
|
52
|
-
* @see {@link ActivatePipelineCommandOutput} for command's `response` shape.
|
|
53
|
-
* @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape.
|
|
54
|
-
*
|
|
55
|
-
*/
|
|
9
|
+
|
|
56
10
|
export declare class ActivatePipelineCommand extends $Command<ActivatePipelineCommandInput, ActivatePipelineCommandOutput, DataPipelineClientResolvedConfig> {
|
|
57
11
|
readonly input: ActivatePipelineCommandInput;
|
|
58
12
|
constructor(input: ActivatePipelineCommandInput);
|
|
59
|
-
|
|
60
|
-
* @internal
|
|
61
|
-
*/
|
|
13
|
+
|
|
62
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ActivatePipelineCommandInput, ActivatePipelineCommandOutput>;
|
|
63
15
|
private serialize;
|
|
64
16
|
private deserialize;
|
|
@@ -6,29 +6,11 @@ export interface AddTagsCommandInput extends AddTagsInput {
|
|
|
6
6
|
}
|
|
7
7
|
export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Adds or modifies tags for the specified pipeline.</p>
|
|
11
|
-
* @example
|
|
12
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
-
* ```javascript
|
|
14
|
-
* import { DataPipelineClient, AddTagsCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import
|
|
15
|
-
* // const { DataPipelineClient, AddTagsCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import
|
|
16
|
-
* const client = new DataPipelineClient(config);
|
|
17
|
-
* const command = new AddTagsCommand(input);
|
|
18
|
-
* const response = await client.send(command);
|
|
19
|
-
* ```
|
|
20
|
-
*
|
|
21
|
-
* @see {@link AddTagsCommandInput} for command's `input` shape.
|
|
22
|
-
* @see {@link AddTagsCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape.
|
|
24
|
-
*
|
|
25
|
-
*/
|
|
9
|
+
|
|
26
10
|
export declare class AddTagsCommand extends $Command<AddTagsCommandInput, AddTagsCommandOutput, DataPipelineClientResolvedConfig> {
|
|
27
11
|
readonly input: AddTagsCommandInput;
|
|
28
12
|
constructor(input: AddTagsCommandInput);
|
|
29
|
-
|
|
30
|
-
* @internal
|
|
31
|
-
*/
|
|
13
|
+
|
|
32
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AddTagsCommandInput, AddTagsCommandOutput>;
|
|
33
15
|
private serialize;
|
|
34
16
|
private deserialize;
|
|
@@ -6,59 +6,11 @@ export interface CreatePipelineCommandInput extends CreatePipelineInput {
|
|
|
6
6
|
}
|
|
7
7
|
export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Creates a new, empty pipeline. Use <a>PutPipelineDefinition</a> to populate the pipeline.</p>
|
|
11
|
-
*
|
|
12
|
-
* <examples>
|
|
13
|
-
* <request>
|
|
14
|
-
*
|
|
15
|
-
* POST / HTTP/1.1
|
|
16
|
-
* Content-Type: application/x-amz-json-1.1
|
|
17
|
-
* X-Amz-Target: DataPipeline.CreatePipeline
|
|
18
|
-
* Content-Length: 91
|
|
19
|
-
* Host: datapipeline.us-east-1.amazonaws.com
|
|
20
|
-
* X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
|
|
21
|
-
* Authorization: AuthParams
|
|
22
|
-
*
|
|
23
|
-
* {"name": "myPipeline",
|
|
24
|
-
* "uniqueId": "123456789",
|
|
25
|
-
* "description": "This is my first pipeline"}
|
|
26
|
-
*
|
|
27
|
-
* </request>
|
|
28
|
-
*
|
|
29
|
-
* <response>
|
|
30
|
-
*
|
|
31
|
-
* HTTP/1.1 200
|
|
32
|
-
* x-amzn-RequestId: b16911ce-0774-11e2-af6f-6bc7a6be60d9
|
|
33
|
-
* Content-Type: application/x-amz-json-1.1
|
|
34
|
-
* Content-Length: 40
|
|
35
|
-
* Date: Mon, 12 Nov 2012 17:50:53 GMT
|
|
36
|
-
*
|
|
37
|
-
* {"pipelineId": "df-06372391ZG65EXAMPLE"}
|
|
38
|
-
*
|
|
39
|
-
* </response>
|
|
40
|
-
* </examples>
|
|
41
|
-
* @example
|
|
42
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
43
|
-
* ```javascript
|
|
44
|
-
* import { DataPipelineClient, CreatePipelineCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import
|
|
45
|
-
* // const { DataPipelineClient, CreatePipelineCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import
|
|
46
|
-
* const client = new DataPipelineClient(config);
|
|
47
|
-
* const command = new CreatePipelineCommand(input);
|
|
48
|
-
* const response = await client.send(command);
|
|
49
|
-
* ```
|
|
50
|
-
*
|
|
51
|
-
* @see {@link CreatePipelineCommandInput} for command's `input` shape.
|
|
52
|
-
* @see {@link CreatePipelineCommandOutput} for command's `response` shape.
|
|
53
|
-
* @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape.
|
|
54
|
-
*
|
|
55
|
-
*/
|
|
9
|
+
|
|
56
10
|
export declare class CreatePipelineCommand extends $Command<CreatePipelineCommandInput, CreatePipelineCommandOutput, DataPipelineClientResolvedConfig> {
|
|
57
11
|
readonly input: CreatePipelineCommandInput;
|
|
58
12
|
constructor(input: CreatePipelineCommandInput);
|
|
59
|
-
|
|
60
|
-
* @internal
|
|
61
|
-
*/
|
|
13
|
+
|
|
62
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePipelineCommandInput, CreatePipelineCommandOutput>;
|
|
63
15
|
private serialize;
|
|
64
16
|
private deserialize;
|
|
@@ -6,32 +6,11 @@ export interface DeactivatePipelineCommandInput extends DeactivatePipelineInput
|
|
|
6
6
|
}
|
|
7
7
|
export interface DeactivatePipelineCommandOutput extends DeactivatePipelineOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Deactivates the specified running pipeline. The pipeline is set to the <code>DEACTIVATING</code>
|
|
11
|
-
* state until the deactivation process completes.</p>
|
|
12
|
-
* <p>To resume a deactivated pipeline, use <a>ActivatePipeline</a>. By default, the pipeline resumes from the last completed execution.
|
|
13
|
-
* Optionally, you can specify the date and time to resume the pipeline.</p>
|
|
14
|
-
* @example
|
|
15
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
16
|
-
* ```javascript
|
|
17
|
-
* import { DataPipelineClient, DeactivatePipelineCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import
|
|
18
|
-
* // const { DataPipelineClient, DeactivatePipelineCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import
|
|
19
|
-
* const client = new DataPipelineClient(config);
|
|
20
|
-
* const command = new DeactivatePipelineCommand(input);
|
|
21
|
-
* const response = await client.send(command);
|
|
22
|
-
* ```
|
|
23
|
-
*
|
|
24
|
-
* @see {@link DeactivatePipelineCommandInput} for command's `input` shape.
|
|
25
|
-
* @see {@link DeactivatePipelineCommandOutput} for command's `response` shape.
|
|
26
|
-
* @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape.
|
|
27
|
-
*
|
|
28
|
-
*/
|
|
9
|
+
|
|
29
10
|
export declare class DeactivatePipelineCommand extends $Command<DeactivatePipelineCommandInput, DeactivatePipelineCommandOutput, DataPipelineClientResolvedConfig> {
|
|
30
11
|
readonly input: DeactivatePipelineCommandInput;
|
|
31
12
|
constructor(input: DeactivatePipelineCommandInput);
|
|
32
|
-
|
|
33
|
-
* @internal
|
|
34
|
-
*/
|
|
13
|
+
|
|
35
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeactivatePipelineCommandInput, DeactivatePipelineCommandOutput>;
|
|
36
15
|
private serialize;
|
|
37
16
|
private deserialize;
|
|
@@ -6,60 +6,11 @@ export interface DeletePipelineCommandInput extends DeletePipelineInput {
|
|
|
6
6
|
}
|
|
7
7
|
export interface DeletePipelineCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Deletes a pipeline, its pipeline definition, and its run history.
|
|
11
|
-
* AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.</p>
|
|
12
|
-
* <p>Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline.
|
|
13
|
-
* To temporarily pause a pipeline instead of deleting it, call <a>SetStatus</a> with the status set to <code>PAUSE</code> on individual components.
|
|
14
|
-
* Components that are paused by <a>SetStatus</a> can be resumed.</p>
|
|
15
|
-
*
|
|
16
|
-
* <examples>
|
|
17
|
-
* <request>
|
|
18
|
-
*
|
|
19
|
-
* POST / HTTP/1.1
|
|
20
|
-
* Content-Type: application/x-amz-json-1.1
|
|
21
|
-
* X-Amz-Target: DataPipeline.DeletePipeline
|
|
22
|
-
* Content-Length: 50
|
|
23
|
-
* Host: datapipeline.us-east-1.amazonaws.com
|
|
24
|
-
* X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
|
|
25
|
-
* Authorization: AuthParams
|
|
26
|
-
*
|
|
27
|
-
* {"pipelineId": "df-06372391ZG65EXAMPLE"}
|
|
28
|
-
*
|
|
29
|
-
* </request>
|
|
30
|
-
*
|
|
31
|
-
* <response>
|
|
32
|
-
*
|
|
33
|
-
* x-amzn-RequestId: b7a88c81-0754-11e2-af6f-6bc7a6be60d9
|
|
34
|
-
* Content-Type: application/x-amz-json-1.1
|
|
35
|
-
* Content-Length: 0
|
|
36
|
-
* Date: Mon, 12 Nov 2012 17:50:53 GMT
|
|
37
|
-
*
|
|
38
|
-
* Unexpected response: 200, OK, undefined
|
|
39
|
-
*
|
|
40
|
-
* </response>
|
|
41
|
-
* </examples>
|
|
42
|
-
* @example
|
|
43
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
44
|
-
* ```javascript
|
|
45
|
-
* import { DataPipelineClient, DeletePipelineCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import
|
|
46
|
-
* // const { DataPipelineClient, DeletePipelineCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import
|
|
47
|
-
* const client = new DataPipelineClient(config);
|
|
48
|
-
* const command = new DeletePipelineCommand(input);
|
|
49
|
-
* const response = await client.send(command);
|
|
50
|
-
* ```
|
|
51
|
-
*
|
|
52
|
-
* @see {@link DeletePipelineCommandInput} for command's `input` shape.
|
|
53
|
-
* @see {@link DeletePipelineCommandOutput} for command's `response` shape.
|
|
54
|
-
* @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape.
|
|
55
|
-
*
|
|
56
|
-
*/
|
|
9
|
+
|
|
57
10
|
export declare class DeletePipelineCommand extends $Command<DeletePipelineCommandInput, DeletePipelineCommandOutput, DataPipelineClientResolvedConfig> {
|
|
58
11
|
readonly input: DeletePipelineCommandInput;
|
|
59
12
|
constructor(input: DeletePipelineCommandInput);
|
|
60
|
-
|
|
61
|
-
* @internal
|
|
62
|
-
*/
|
|
13
|
+
|
|
63
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePipelineCommandInput, DeletePipelineCommandOutput>;
|
|
64
15
|
private serialize;
|
|
65
16
|
private deserialize;
|
|
@@ -6,87 +6,11 @@ export interface DescribeObjectsCommandInput extends DescribeObjectsInput {
|
|
|
6
6
|
}
|
|
7
7
|
export interface DescribeObjectsCommandOutput extends DescribeObjectsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of
|
|
11
|
-
* a set of fields that define the properties of the object.</p>
|
|
12
|
-
*
|
|
13
|
-
* <examples>
|
|
14
|
-
* <request>
|
|
15
|
-
*
|
|
16
|
-
* POST / HTTP/1.1
|
|
17
|
-
* Content-Type: application/x-amz-json-1.1
|
|
18
|
-
* X-Amz-Target: DataPipeline.DescribeObjects
|
|
19
|
-
* Content-Length: 98
|
|
20
|
-
* Host: datapipeline.us-east-1.amazonaws.com
|
|
21
|
-
* X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
|
|
22
|
-
* Authorization: AuthParams
|
|
23
|
-
*
|
|
24
|
-
* {"pipelineId": "df-06372391ZG65EXAMPLE",
|
|
25
|
-
* "objectIds":
|
|
26
|
-
* ["Schedule"],
|
|
27
|
-
* "evaluateExpressions": true}
|
|
28
|
-
*
|
|
29
|
-
* </request>
|
|
30
|
-
*
|
|
31
|
-
* <response>
|
|
32
|
-
*
|
|
33
|
-
* x-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef
|
|
34
|
-
* Content-Type: application/x-amz-json-1.1
|
|
35
|
-
* Content-Length: 1488
|
|
36
|
-
* Date: Mon, 12 Nov 2012 17:50:53 GMT
|
|
37
|
-
*
|
|
38
|
-
* {"hasMoreResults": false,
|
|
39
|
-
* "pipelineObjects":
|
|
40
|
-
* [
|
|
41
|
-
* {"fields":
|
|
42
|
-
* [
|
|
43
|
-
* {"key": "startDateTime",
|
|
44
|
-
* "stringValue": "2012-12-12T00:00:00"},
|
|
45
|
-
* {"key": "parent",
|
|
46
|
-
* "refValue": "Default"},
|
|
47
|
-
* {"key": "@sphere",
|
|
48
|
-
* "stringValue": "COMPONENT"},
|
|
49
|
-
* {"key": "type",
|
|
50
|
-
* "stringValue": "Schedule"},
|
|
51
|
-
* {"key": "period",
|
|
52
|
-
* "stringValue": "1 hour"},
|
|
53
|
-
* {"key": "endDateTime",
|
|
54
|
-
* "stringValue": "2012-12-21T18:00:00"},
|
|
55
|
-
* {"key": "@version",
|
|
56
|
-
* "stringValue": "1"},
|
|
57
|
-
* {"key": "@status",
|
|
58
|
-
* "stringValue": "PENDING"},
|
|
59
|
-
* {"key": "@pipelineId",
|
|
60
|
-
* "stringValue": "df-06372391ZG65EXAMPLE"}
|
|
61
|
-
* ],
|
|
62
|
-
* "id": "Schedule",
|
|
63
|
-
* "name": "Schedule"}
|
|
64
|
-
* ]
|
|
65
|
-
* }
|
|
66
|
-
*
|
|
67
|
-
* </response>
|
|
68
|
-
* </examples>
|
|
69
|
-
* @example
|
|
70
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
71
|
-
* ```javascript
|
|
72
|
-
* import { DataPipelineClient, DescribeObjectsCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import
|
|
73
|
-
* // const { DataPipelineClient, DescribeObjectsCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import
|
|
74
|
-
* const client = new DataPipelineClient(config);
|
|
75
|
-
* const command = new DescribeObjectsCommand(input);
|
|
76
|
-
* const response = await client.send(command);
|
|
77
|
-
* ```
|
|
78
|
-
*
|
|
79
|
-
* @see {@link DescribeObjectsCommandInput} for command's `input` shape.
|
|
80
|
-
* @see {@link DescribeObjectsCommandOutput} for command's `response` shape.
|
|
81
|
-
* @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape.
|
|
82
|
-
*
|
|
83
|
-
*/
|
|
9
|
+
|
|
84
10
|
export declare class DescribeObjectsCommand extends $Command<DescribeObjectsCommandInput, DescribeObjectsCommandOutput, DataPipelineClientResolvedConfig> {
|
|
85
11
|
readonly input: DescribeObjectsCommandInput;
|
|
86
12
|
constructor(input: DescribeObjectsCommandInput);
|
|
87
|
-
|
|
88
|
-
* @internal
|
|
89
|
-
*/
|
|
13
|
+
|
|
90
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeObjectsCommandInput, DescribeObjectsCommandOutput>;
|
|
91
15
|
private serialize;
|
|
92
16
|
private deserialize;
|
|
@@ -6,90 +6,11 @@ export interface DescribePipelinesCommandInput extends DescribePipelinesInput {
|
|
|
6
6
|
}
|
|
7
7
|
export interface DescribePipelinesCommandOutput extends DescribePipelinesOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier,
|
|
11
|
-
* its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines
|
|
12
|
-
* that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines
|
|
13
|
-
* for which you have read permissions.</p>
|
|
14
|
-
* <p>To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>.</p>
|
|
15
|
-
*
|
|
16
|
-
* <examples>
|
|
17
|
-
* <request>
|
|
18
|
-
*
|
|
19
|
-
* POST / HTTP/1.1
|
|
20
|
-
* Content-Type: application/x-amz-json-1.1
|
|
21
|
-
* X-Amz-Target: DataPipeline.DescribePipelines
|
|
22
|
-
* Content-Length: 70
|
|
23
|
-
* Host: datapipeline.us-east-1.amazonaws.com
|
|
24
|
-
* X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
|
|
25
|
-
* Authorization: AuthParams
|
|
26
|
-
*
|
|
27
|
-
* {"pipelineIds":
|
|
28
|
-
* ["df-08785951KAKJEXAMPLE"]
|
|
29
|
-
* }
|
|
30
|
-
*
|
|
31
|
-
* </request>
|
|
32
|
-
*
|
|
33
|
-
* <response>
|
|
34
|
-
*
|
|
35
|
-
* x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9
|
|
36
|
-
* Content-Type: application/x-amz-json-1.1
|
|
37
|
-
* Content-Length: 767
|
|
38
|
-
* Date: Mon, 12 Nov 2012 17:50:53 GMT
|
|
39
|
-
*
|
|
40
|
-
* {"pipelineDescriptionList":
|
|
41
|
-
* [
|
|
42
|
-
* {"description": "This is my first pipeline",
|
|
43
|
-
* "fields":
|
|
44
|
-
* [
|
|
45
|
-
* {"key": "@pipelineState",
|
|
46
|
-
* "stringValue": "SCHEDULED"},
|
|
47
|
-
* {"key": "description",
|
|
48
|
-
* "stringValue": "This is my first pipeline"},
|
|
49
|
-
* {"key": "name",
|
|
50
|
-
* "stringValue": "myPipeline"},
|
|
51
|
-
* {"key": "@creationTime",
|
|
52
|
-
* "stringValue": "2012-12-13T01:24:06"},
|
|
53
|
-
* {"key": "@id",
|
|
54
|
-
* "stringValue": "df-0937003356ZJEXAMPLE"},
|
|
55
|
-
* {"key": "@sphere",
|
|
56
|
-
* "stringValue": "PIPELINE"},
|
|
57
|
-
* {"key": "@version",
|
|
58
|
-
* "stringValue": "1"},
|
|
59
|
-
* {"key": "@userId",
|
|
60
|
-
* "stringValue": "924374875933"},
|
|
61
|
-
* {"key": "@accountId",
|
|
62
|
-
* "stringValue": "924374875933"},
|
|
63
|
-
* {"key": "uniqueId",
|
|
64
|
-
* "stringValue": "1234567890"}
|
|
65
|
-
* ],
|
|
66
|
-
* "name": "myPipeline",
|
|
67
|
-
* "pipelineId": "df-0937003356ZJEXAMPLE"}
|
|
68
|
-
* ]
|
|
69
|
-
* }
|
|
70
|
-
* </response>
|
|
71
|
-
* </examples>
|
|
72
|
-
* @example
|
|
73
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
74
|
-
* ```javascript
|
|
75
|
-
* import { DataPipelineClient, DescribePipelinesCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import
|
|
76
|
-
* // const { DataPipelineClient, DescribePipelinesCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import
|
|
77
|
-
* const client = new DataPipelineClient(config);
|
|
78
|
-
* const command = new DescribePipelinesCommand(input);
|
|
79
|
-
* const response = await client.send(command);
|
|
80
|
-
* ```
|
|
81
|
-
*
|
|
82
|
-
* @see {@link DescribePipelinesCommandInput} for command's `input` shape.
|
|
83
|
-
* @see {@link DescribePipelinesCommandOutput} for command's `response` shape.
|
|
84
|
-
* @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape.
|
|
85
|
-
*
|
|
86
|
-
*/
|
|
9
|
+
|
|
87
10
|
export declare class DescribePipelinesCommand extends $Command<DescribePipelinesCommandInput, DescribePipelinesCommandOutput, DataPipelineClientResolvedConfig> {
|
|
88
11
|
readonly input: DescribePipelinesCommandInput;
|
|
89
12
|
constructor(input: DescribePipelinesCommandInput);
|
|
90
|
-
|
|
91
|
-
* @internal
|
|
92
|
-
*/
|
|
13
|
+
|
|
93
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribePipelinesCommandInput, DescribePipelinesCommandOutput>;
|
|
94
15
|
private serialize;
|
|
95
16
|
private deserialize;
|
|
@@ -6,59 +6,11 @@ export interface EvaluateExpressionCommandInput extends EvaluateExpressionInput
|
|
|
6
6
|
}
|
|
7
7
|
export interface EvaluateExpressionCommandOutput extends EvaluateExpressionOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Task runners call <code>EvaluateExpression</code> to evaluate a string in the context of the specified object.
|
|
11
|
-
* For example, a task runner can evaluate SQL queries stored in Amazon S3.</p>
|
|
12
|
-
*
|
|
13
|
-
* <examples>
|
|
14
|
-
* <request>
|
|
15
|
-
*
|
|
16
|
-
* POST / HTTP/1.1
|
|
17
|
-
* Content-Type: application/x-amz-json-1.1
|
|
18
|
-
* X-Amz-Target: DataPipeline.DescribePipelines
|
|
19
|
-
* Content-Length: 164
|
|
20
|
-
* Host: datapipeline.us-east-1.amazonaws.com
|
|
21
|
-
* X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
|
|
22
|
-
* Authorization: AuthParams
|
|
23
|
-
*
|
|
24
|
-
* {"pipelineId": "df-08785951KAKJEXAMPLE",
|
|
25
|
-
* "objectId": "Schedule",
|
|
26
|
-
* "expression": "Transform started at #{startDateTime} and finished at #{endDateTime}"}
|
|
27
|
-
*
|
|
28
|
-
* </request>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* <response>
|
|
32
|
-
*
|
|
33
|
-
* x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9
|
|
34
|
-
* Content-Type: application/x-amz-json-1.1
|
|
35
|
-
* Content-Length: 103
|
|
36
|
-
* Date: Mon, 12 Nov 2012 17:50:53 GMT
|
|
37
|
-
*
|
|
38
|
-
* {"evaluatedExpression": "Transform started at 2012-12-12T00:00:00 and finished at 2012-12-21T18:00:00"}
|
|
39
|
-
* </response>
|
|
40
|
-
* </examples>
|
|
41
|
-
* @example
|
|
42
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
43
|
-
* ```javascript
|
|
44
|
-
* import { DataPipelineClient, EvaluateExpressionCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import
|
|
45
|
-
* // const { DataPipelineClient, EvaluateExpressionCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import
|
|
46
|
-
* const client = new DataPipelineClient(config);
|
|
47
|
-
* const command = new EvaluateExpressionCommand(input);
|
|
48
|
-
* const response = await client.send(command);
|
|
49
|
-
* ```
|
|
50
|
-
*
|
|
51
|
-
* @see {@link EvaluateExpressionCommandInput} for command's `input` shape.
|
|
52
|
-
* @see {@link EvaluateExpressionCommandOutput} for command's `response` shape.
|
|
53
|
-
* @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape.
|
|
54
|
-
*
|
|
55
|
-
*/
|
|
9
|
+
|
|
56
10
|
export declare class EvaluateExpressionCommand extends $Command<EvaluateExpressionCommandInput, EvaluateExpressionCommandOutput, DataPipelineClientResolvedConfig> {
|
|
57
11
|
readonly input: EvaluateExpressionCommandInput;
|
|
58
12
|
constructor(input: EvaluateExpressionCommandInput);
|
|
59
|
-
|
|
60
|
-
* @internal
|
|
61
|
-
*/
|
|
13
|
+
|
|
62
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataPipelineClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EvaluateExpressionCommandInput, EvaluateExpressionCommandOutput>;
|
|
63
15
|
private serialize;
|
|
64
16
|
private deserialize;
|