@aws-sdk/client-data-pipeline 3.35.0 → 3.36.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.
Files changed (176) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist-cjs/DataPipeline.js +0 -1
  3. package/dist-cjs/DataPipelineClient.js +0 -1
  4. package/dist-cjs/commands/ActivatePipelineCommand.js +0 -1
  5. package/dist-cjs/commands/AddTagsCommand.js +0 -1
  6. package/dist-cjs/commands/CreatePipelineCommand.js +0 -1
  7. package/dist-cjs/commands/DeactivatePipelineCommand.js +0 -1
  8. package/dist-cjs/commands/DeletePipelineCommand.js +0 -1
  9. package/dist-cjs/commands/DescribeObjectsCommand.js +0 -1
  10. package/dist-cjs/commands/DescribePipelinesCommand.js +0 -1
  11. package/dist-cjs/commands/EvaluateExpressionCommand.js +0 -1
  12. package/dist-cjs/commands/GetPipelineDefinitionCommand.js +0 -1
  13. package/dist-cjs/commands/ListPipelinesCommand.js +0 -1
  14. package/dist-cjs/commands/PollForTaskCommand.js +0 -1
  15. package/dist-cjs/commands/PutPipelineDefinitionCommand.js +0 -1
  16. package/dist-cjs/commands/QueryObjectsCommand.js +0 -1
  17. package/dist-cjs/commands/RemoveTagsCommand.js +0 -1
  18. package/dist-cjs/commands/ReportTaskProgressCommand.js +0 -1
  19. package/dist-cjs/commands/ReportTaskRunnerHeartbeatCommand.js +0 -1
  20. package/dist-cjs/commands/SetStatusCommand.js +0 -1
  21. package/dist-cjs/commands/SetTaskStatusCommand.js +0 -1
  22. package/dist-cjs/commands/ValidatePipelineDefinitionCommand.js +0 -1
  23. package/dist-cjs/endpoints.js +0 -1
  24. package/dist-cjs/index.js +0 -1
  25. package/dist-cjs/models/index.js +0 -1
  26. package/dist-cjs/models/models_0.js +0 -1
  27. package/dist-cjs/pagination/DescribeObjectsPaginator.js +0 -1
  28. package/dist-cjs/pagination/Interfaces.js +0 -1
  29. package/dist-cjs/pagination/ListPipelinesPaginator.js +0 -1
  30. package/dist-cjs/pagination/QueryObjectsPaginator.js +0 -1
  31. package/dist-cjs/protocols/Aws_json1_1.js +0 -1
  32. package/dist-cjs/runtimeConfig.browser.js +2 -3
  33. package/dist-cjs/runtimeConfig.js +3 -4
  34. package/dist-cjs/runtimeConfig.native.js +0 -1
  35. package/dist-cjs/runtimeConfig.shared.js +0 -1
  36. package/dist-es/DataPipeline.js +0 -1
  37. package/dist-es/DataPipelineClient.js +0 -1
  38. package/dist-es/commands/ActivatePipelineCommand.js +0 -1
  39. package/dist-es/commands/AddTagsCommand.js +0 -1
  40. package/dist-es/commands/CreatePipelineCommand.js +0 -1
  41. package/dist-es/commands/DeactivatePipelineCommand.js +0 -1
  42. package/dist-es/commands/DeletePipelineCommand.js +0 -1
  43. package/dist-es/commands/DescribeObjectsCommand.js +0 -1
  44. package/dist-es/commands/DescribePipelinesCommand.js +0 -1
  45. package/dist-es/commands/EvaluateExpressionCommand.js +0 -1
  46. package/dist-es/commands/GetPipelineDefinitionCommand.js +0 -1
  47. package/dist-es/commands/ListPipelinesCommand.js +0 -1
  48. package/dist-es/commands/PollForTaskCommand.js +0 -1
  49. package/dist-es/commands/PutPipelineDefinitionCommand.js +0 -1
  50. package/dist-es/commands/QueryObjectsCommand.js +0 -1
  51. package/dist-es/commands/RemoveTagsCommand.js +0 -1
  52. package/dist-es/commands/ReportTaskProgressCommand.js +0 -1
  53. package/dist-es/commands/ReportTaskRunnerHeartbeatCommand.js +0 -1
  54. package/dist-es/commands/SetStatusCommand.js +0 -1
  55. package/dist-es/commands/SetTaskStatusCommand.js +0 -1
  56. package/dist-es/commands/ValidatePipelineDefinitionCommand.js +0 -1
  57. package/dist-es/endpoints.js +0 -1
  58. package/dist-es/index.js +0 -1
  59. package/dist-es/models/index.js +0 -1
  60. package/dist-es/models/models_0.js +0 -1
  61. package/dist-es/pagination/DescribeObjectsPaginator.js +0 -1
  62. package/dist-es/pagination/Interfaces.js +0 -1
  63. package/dist-es/pagination/ListPipelinesPaginator.js +0 -1
  64. package/dist-es/pagination/QueryObjectsPaginator.js +0 -1
  65. package/dist-es/protocols/Aws_json1_1.js +0 -1
  66. package/dist-es/runtimeConfig.browser.js +1 -2
  67. package/dist-es/runtimeConfig.js +2 -3
  68. package/dist-es/runtimeConfig.native.js +0 -1
  69. package/dist-es/runtimeConfig.shared.js +0 -1
  70. package/package.json +33 -30
  71. package/dist-cjs/DataPipeline.js.map +0 -1
  72. package/dist-cjs/DataPipelineClient.js.map +0 -1
  73. package/dist-cjs/commands/ActivatePipelineCommand.js.map +0 -1
  74. package/dist-cjs/commands/AddTagsCommand.js.map +0 -1
  75. package/dist-cjs/commands/CreatePipelineCommand.js.map +0 -1
  76. package/dist-cjs/commands/DeactivatePipelineCommand.js.map +0 -1
  77. package/dist-cjs/commands/DeletePipelineCommand.js.map +0 -1
  78. package/dist-cjs/commands/DescribeObjectsCommand.js.map +0 -1
  79. package/dist-cjs/commands/DescribePipelinesCommand.js.map +0 -1
  80. package/dist-cjs/commands/EvaluateExpressionCommand.js.map +0 -1
  81. package/dist-cjs/commands/GetPipelineDefinitionCommand.js.map +0 -1
  82. package/dist-cjs/commands/ListPipelinesCommand.js.map +0 -1
  83. package/dist-cjs/commands/PollForTaskCommand.js.map +0 -1
  84. package/dist-cjs/commands/PutPipelineDefinitionCommand.js.map +0 -1
  85. package/dist-cjs/commands/QueryObjectsCommand.js.map +0 -1
  86. package/dist-cjs/commands/RemoveTagsCommand.js.map +0 -1
  87. package/dist-cjs/commands/ReportTaskProgressCommand.js.map +0 -1
  88. package/dist-cjs/commands/ReportTaskRunnerHeartbeatCommand.js.map +0 -1
  89. package/dist-cjs/commands/SetStatusCommand.js.map +0 -1
  90. package/dist-cjs/commands/SetTaskStatusCommand.js.map +0 -1
  91. package/dist-cjs/commands/ValidatePipelineDefinitionCommand.js.map +0 -1
  92. package/dist-cjs/endpoints.js.map +0 -1
  93. package/dist-cjs/index.js.map +0 -1
  94. package/dist-cjs/models/index.js.map +0 -1
  95. package/dist-cjs/models/models_0.js.map +0 -1
  96. package/dist-cjs/pagination/DescribeObjectsPaginator.js.map +0 -1
  97. package/dist-cjs/pagination/Interfaces.js.map +0 -1
  98. package/dist-cjs/pagination/ListPipelinesPaginator.js.map +0 -1
  99. package/dist-cjs/pagination/QueryObjectsPaginator.js.map +0 -1
  100. package/dist-cjs/protocols/Aws_json1_1.js.map +0 -1
  101. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  102. package/dist-cjs/runtimeConfig.js.map +0 -1
  103. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  104. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  105. package/dist-es/DataPipeline.js.map +0 -1
  106. package/dist-es/DataPipelineClient.js.map +0 -1
  107. package/dist-es/commands/ActivatePipelineCommand.js.map +0 -1
  108. package/dist-es/commands/AddTagsCommand.js.map +0 -1
  109. package/dist-es/commands/CreatePipelineCommand.js.map +0 -1
  110. package/dist-es/commands/DeactivatePipelineCommand.js.map +0 -1
  111. package/dist-es/commands/DeletePipelineCommand.js.map +0 -1
  112. package/dist-es/commands/DescribeObjectsCommand.js.map +0 -1
  113. package/dist-es/commands/DescribePipelinesCommand.js.map +0 -1
  114. package/dist-es/commands/EvaluateExpressionCommand.js.map +0 -1
  115. package/dist-es/commands/GetPipelineDefinitionCommand.js.map +0 -1
  116. package/dist-es/commands/ListPipelinesCommand.js.map +0 -1
  117. package/dist-es/commands/PollForTaskCommand.js.map +0 -1
  118. package/dist-es/commands/PutPipelineDefinitionCommand.js.map +0 -1
  119. package/dist-es/commands/QueryObjectsCommand.js.map +0 -1
  120. package/dist-es/commands/RemoveTagsCommand.js.map +0 -1
  121. package/dist-es/commands/ReportTaskProgressCommand.js.map +0 -1
  122. package/dist-es/commands/ReportTaskRunnerHeartbeatCommand.js.map +0 -1
  123. package/dist-es/commands/SetStatusCommand.js.map +0 -1
  124. package/dist-es/commands/SetTaskStatusCommand.js.map +0 -1
  125. package/dist-es/commands/ValidatePipelineDefinitionCommand.js.map +0 -1
  126. package/dist-es/endpoints.js.map +0 -1
  127. package/dist-es/index.js.map +0 -1
  128. package/dist-es/models/index.js.map +0 -1
  129. package/dist-es/models/models_0.js.map +0 -1
  130. package/dist-es/pagination/DescribeObjectsPaginator.js.map +0 -1
  131. package/dist-es/pagination/Interfaces.js.map +0 -1
  132. package/dist-es/pagination/ListPipelinesPaginator.js.map +0 -1
  133. package/dist-es/pagination/QueryObjectsPaginator.js.map +0 -1
  134. package/dist-es/protocols/Aws_json1_1.js.map +0 -1
  135. package/dist-es/runtimeConfig.browser.js.map +0 -1
  136. package/dist-es/runtimeConfig.js.map +0 -1
  137. package/dist-es/runtimeConfig.native.js.map +0 -1
  138. package/dist-es/runtimeConfig.shared.js.map +0 -1
  139. package/jest.config.js +0 -4
  140. package/src/DataPipeline.ts +0 -1579
  141. package/src/DataPipelineClient.ts +0 -321
  142. package/src/commands/ActivatePipelineCommand.ts +0 -125
  143. package/src/commands/AddTagsCommand.ts +0 -92
  144. package/src/commands/CreatePipelineCommand.ts +0 -125
  145. package/src/commands/DeactivatePipelineCommand.ts +0 -98
  146. package/src/commands/DeletePipelineCommand.ts +0 -126
  147. package/src/commands/DescribeObjectsCommand.ts +0 -153
  148. package/src/commands/DescribePipelinesCommand.ts +0 -156
  149. package/src/commands/EvaluateExpressionCommand.ts +0 -125
  150. package/src/commands/GetPipelineDefinitionCommand.ts +0 -159
  151. package/src/commands/ListPipelinesCommand.ts +0 -126
  152. package/src/commands/PollForTaskCommand.ts +0 -173
  153. package/src/commands/PutPipelineDefinitionCommand.ts +0 -254
  154. package/src/commands/QueryObjectsCommand.ts +0 -133
  155. package/src/commands/RemoveTagsCommand.ts +0 -95
  156. package/src/commands/ReportTaskProgressCommand.ts +0 -132
  157. package/src/commands/ReportTaskRunnerHeartbeatCommand.ts +0 -130
  158. package/src/commands/SetStatusCommand.ts +0 -124
  159. package/src/commands/SetTaskStatusCommand.ts +0 -125
  160. package/src/commands/ValidatePipelineDefinitionCommand.ts +0 -249
  161. package/src/endpoints.ts +0 -57
  162. package/src/index.ts +0 -26
  163. package/src/models/index.ts +0 -1
  164. package/src/models/models_0.ts +0 -1480
  165. package/src/pagination/DescribeObjectsPaginator.ts +0 -58
  166. package/src/pagination/Interfaces.ts +0 -8
  167. package/src/pagination/ListPipelinesPaginator.ts +0 -58
  168. package/src/pagination/QueryObjectsPaginator.ts +0 -59
  169. package/src/protocols/Aws_json1_1.ts +0 -2767
  170. package/src/runtimeConfig.browser.ts +0 -41
  171. package/src/runtimeConfig.native.ts +0 -17
  172. package/src/runtimeConfig.shared.ts +0 -17
  173. package/src/runtimeConfig.ts +0 -46
  174. package/tsconfig.es.json +0 -10
  175. package/tsconfig.json +0 -33
  176. package/tsconfig.types.json +0 -9
@@ -1,1480 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
-
3
- /**
4
- * <p>A value or list of parameter values. </p>
5
- */
6
- export interface ParameterValue {
7
- /**
8
- * <p>The ID of the parameter value.</p>
9
- */
10
- id: string | undefined;
11
-
12
- /**
13
- * <p>The field value, expressed as a String.</p>
14
- */
15
- stringValue: string | undefined;
16
- }
17
-
18
- export namespace ParameterValue {
19
- /**
20
- * @internal
21
- */
22
- export const filterSensitiveLog = (obj: ParameterValue): any => ({
23
- ...obj,
24
- });
25
- }
26
-
27
- /**
28
- * <p>Contains the parameters for ActivatePipeline.</p>
29
- */
30
- export interface ActivatePipelineInput {
31
- /**
32
- * <p>The ID of the pipeline.</p>
33
- */
34
- pipelineId: string | undefined;
35
-
36
- /**
37
- * <p>A list of parameter values to pass to the pipeline at activation.</p>
38
- */
39
- parameterValues?: ParameterValue[];
40
-
41
- /**
42
- * <p>The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.</p>
43
- */
44
- startTimestamp?: Date;
45
- }
46
-
47
- export namespace ActivatePipelineInput {
48
- /**
49
- * @internal
50
- */
51
- export const filterSensitiveLog = (obj: ActivatePipelineInput): any => ({
52
- ...obj,
53
- });
54
- }
55
-
56
- /**
57
- * <p>Contains the output of ActivatePipeline.</p>
58
- */
59
- export interface ActivatePipelineOutput {}
60
-
61
- export namespace ActivatePipelineOutput {
62
- /**
63
- * @internal
64
- */
65
- export const filterSensitiveLog = (obj: ActivatePipelineOutput): any => ({
66
- ...obj,
67
- });
68
- }
69
-
70
- /**
71
- * <p>An internal service error occurred.</p>
72
- */
73
- export interface InternalServiceError extends __SmithyException, $MetadataBearer {
74
- name: "InternalServiceError";
75
- $fault: "server";
76
- /**
77
- * <p>Description of the error message.</p>
78
- */
79
- message?: string;
80
- }
81
-
82
- export namespace InternalServiceError {
83
- /**
84
- * @internal
85
- */
86
- export const filterSensitiveLog = (obj: InternalServiceError): any => ({
87
- ...obj,
88
- });
89
- }
90
-
91
- /**
92
- * <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>
93
- */
94
- export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
95
- name: "InvalidRequestException";
96
- $fault: "client";
97
- /**
98
- * <p>Description of the error message.</p>
99
- */
100
- message?: string;
101
- }
102
-
103
- export namespace InvalidRequestException {
104
- /**
105
- * @internal
106
- */
107
- export const filterSensitiveLog = (obj: InvalidRequestException): any => ({
108
- ...obj,
109
- });
110
- }
111
-
112
- /**
113
- * <p>The specified pipeline has been deleted.</p>
114
- */
115
- export interface PipelineDeletedException extends __SmithyException, $MetadataBearer {
116
- name: "PipelineDeletedException";
117
- $fault: "client";
118
- /**
119
- * <p>Description of the error message.</p>
120
- */
121
- message?: string;
122
- }
123
-
124
- export namespace PipelineDeletedException {
125
- /**
126
- * @internal
127
- */
128
- export const filterSensitiveLog = (obj: PipelineDeletedException): any => ({
129
- ...obj,
130
- });
131
- }
132
-
133
- /**
134
- * <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>
135
- */
136
- export interface PipelineNotFoundException extends __SmithyException, $MetadataBearer {
137
- name: "PipelineNotFoundException";
138
- $fault: "client";
139
- /**
140
- * <p>Description of the error message.</p>
141
- */
142
- message?: string;
143
- }
144
-
145
- export namespace PipelineNotFoundException {
146
- /**
147
- * @internal
148
- */
149
- export const filterSensitiveLog = (obj: PipelineNotFoundException): any => ({
150
- ...obj,
151
- });
152
- }
153
-
154
- /**
155
- * <p>Tags are key/value pairs defined by a user and associated with a pipeline to control access. AWS Data Pipeline allows you to associate ten tags per pipeline.
156
- * For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>
157
- */
158
- export interface Tag {
159
- /**
160
- * <p>The key name of a tag defined by a user.
161
- * For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>
162
- */
163
- key: string | undefined;
164
-
165
- /**
166
- * <p>The optional value portion of a tag defined by a user.
167
- * For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>
168
- */
169
- value: string | undefined;
170
- }
171
-
172
- export namespace Tag {
173
- /**
174
- * @internal
175
- */
176
- export const filterSensitiveLog = (obj: Tag): any => ({
177
- ...obj,
178
- });
179
- }
180
-
181
- /**
182
- * <p>Contains the parameters for AddTags.</p>
183
- */
184
- export interface AddTagsInput {
185
- /**
186
- * <p>The ID of the pipeline.</p>
187
- */
188
- pipelineId: string | undefined;
189
-
190
- /**
191
- * <p>The tags to add, as key/value pairs.</p>
192
- */
193
- tags: Tag[] | undefined;
194
- }
195
-
196
- export namespace AddTagsInput {
197
- /**
198
- * @internal
199
- */
200
- export const filterSensitiveLog = (obj: AddTagsInput): any => ({
201
- ...obj,
202
- });
203
- }
204
-
205
- /**
206
- * <p>Contains the output of AddTags.</p>
207
- */
208
- export interface AddTagsOutput {}
209
-
210
- export namespace AddTagsOutput {
211
- /**
212
- * @internal
213
- */
214
- export const filterSensitiveLog = (obj: AddTagsOutput): any => ({
215
- ...obj,
216
- });
217
- }
218
-
219
- /**
220
- * <p>Contains the parameters for CreatePipeline.</p>
221
- */
222
- export interface CreatePipelineInput {
223
- /**
224
- * <p>The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account,
225
- * because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.</p>
226
- */
227
- name: string | undefined;
228
-
229
- /**
230
- * <p>A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline.
231
- * You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this
232
- * parameter to ensure idempotency during repeated calls to <code>CreatePipeline</code>. For example, if the
233
- * first call to <code>CreatePipeline</code> does not succeed, you can pass in the same unique identifier and
234
- * pipeline name combination on a subsequent call to <code>CreatePipeline</code>. <code>CreatePipeline</code>
235
- * ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not
236
- * created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the
237
- * name and unique identifier combination is scoped to the AWS account or IAM user credentials.</p>
238
- */
239
- uniqueId: string | undefined;
240
-
241
- /**
242
- * <p>The description for the pipeline.</p>
243
- */
244
- description?: string;
245
-
246
- /**
247
- * <p>A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines.
248
- * For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a>
249
- * in the <i>AWS Data Pipeline Developer Guide</i>.</p>
250
- */
251
- tags?: Tag[];
252
- }
253
-
254
- export namespace CreatePipelineInput {
255
- /**
256
- * @internal
257
- */
258
- export const filterSensitiveLog = (obj: CreatePipelineInput): any => ({
259
- ...obj,
260
- });
261
- }
262
-
263
- /**
264
- * <p>Contains the output of CreatePipeline.</p>
265
- */
266
- export interface CreatePipelineOutput {
267
- /**
268
- * <p>The ID that AWS Data Pipeline assigns the newly created pipeline. For example, <code>df-06372391ZG65EXAMPLE</code>.</p>
269
- */
270
- pipelineId: string | undefined;
271
- }
272
-
273
- export namespace CreatePipelineOutput {
274
- /**
275
- * @internal
276
- */
277
- export const filterSensitiveLog = (obj: CreatePipelineOutput): any => ({
278
- ...obj,
279
- });
280
- }
281
-
282
- /**
283
- * <p>Contains the parameters for DeactivatePipeline.</p>
284
- */
285
- export interface DeactivatePipelineInput {
286
- /**
287
- * <p>The ID of the pipeline.</p>
288
- */
289
- pipelineId: string | undefined;
290
-
291
- /**
292
- * <p>Indicates whether to cancel any running objects. The default is true,
293
- * which sets the state of any running objects to <code>CANCELED</code>.
294
- * If this value is false, the pipeline is deactivated after all
295
- * running objects finish.</p>
296
- */
297
- cancelActive?: boolean;
298
- }
299
-
300
- export namespace DeactivatePipelineInput {
301
- /**
302
- * @internal
303
- */
304
- export const filterSensitiveLog = (obj: DeactivatePipelineInput): any => ({
305
- ...obj,
306
- });
307
- }
308
-
309
- /**
310
- * <p>Contains the output of DeactivatePipeline.</p>
311
- */
312
- export interface DeactivatePipelineOutput {}
313
-
314
- export namespace DeactivatePipelineOutput {
315
- /**
316
- * @internal
317
- */
318
- export const filterSensitiveLog = (obj: DeactivatePipelineOutput): any => ({
319
- ...obj,
320
- });
321
- }
322
-
323
- /**
324
- * <p>Contains the parameters for DeletePipeline.</p>
325
- */
326
- export interface DeletePipelineInput {
327
- /**
328
- * <p>The ID of the pipeline.</p>
329
- */
330
- pipelineId: string | undefined;
331
- }
332
-
333
- export namespace DeletePipelineInput {
334
- /**
335
- * @internal
336
- */
337
- export const filterSensitiveLog = (obj: DeletePipelineInput): any => ({
338
- ...obj,
339
- });
340
- }
341
-
342
- /**
343
- * <p>Contains the parameters for DescribeObjects.</p>
344
- */
345
- export interface DescribeObjectsInput {
346
- /**
347
- * <p>The ID of the pipeline that contains the object definitions.</p>
348
- */
349
- pipelineId: string | undefined;
350
-
351
- /**
352
- * <p>The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to <code>DescribeObjects</code>.</p>
353
- */
354
- objectIds: string[] | undefined;
355
-
356
- /**
357
- * <p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>
358
- */
359
- evaluateExpressions?: boolean;
360
-
361
- /**
362
- * <p>The starting point for the results to be returned. For the first call, this value should be empty.
363
- * As long as there are more results, continue to call <code>DescribeObjects</code> with
364
- * the marker value from the previous call to retrieve the next set of results.</p>
365
- */
366
- marker?: string;
367
- }
368
-
369
- export namespace DescribeObjectsInput {
370
- /**
371
- * @internal
372
- */
373
- export const filterSensitiveLog = (obj: DescribeObjectsInput): any => ({
374
- ...obj,
375
- });
376
- }
377
-
378
- /**
379
- * <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>
380
- */
381
- export interface Field {
382
- /**
383
- * <p>The field identifier.</p>
384
- */
385
- key: string | undefined;
386
-
387
- /**
388
- * <p>The field value, expressed as a String.</p>
389
- */
390
- stringValue?: string;
391
-
392
- /**
393
- * <p>The field value, expressed as the identifier of another object.</p>
394
- */
395
- refValue?: string;
396
- }
397
-
398
- export namespace Field {
399
- /**
400
- * @internal
401
- */
402
- export const filterSensitiveLog = (obj: Field): any => ({
403
- ...obj,
404
- });
405
- }
406
-
407
- /**
408
- * <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>
409
- */
410
- export interface PipelineObject {
411
- /**
412
- * <p>The ID of the object.</p>
413
- */
414
- id: string | undefined;
415
-
416
- /**
417
- * <p>The name of the object.</p>
418
- */
419
- name: string | undefined;
420
-
421
- /**
422
- * <p>Key-value pairs that define the properties of the object.</p>
423
- */
424
- fields: Field[] | undefined;
425
- }
426
-
427
- export namespace PipelineObject {
428
- /**
429
- * @internal
430
- */
431
- export const filterSensitiveLog = (obj: PipelineObject): any => ({
432
- ...obj,
433
- });
434
- }
435
-
436
- /**
437
- * <p>Contains the output of DescribeObjects.</p>
438
- */
439
- export interface DescribeObjectsOutput {
440
- /**
441
- * <p>An array of object definitions.</p>
442
- */
443
- pipelineObjects: PipelineObject[] | undefined;
444
-
445
- /**
446
- * <p>The starting point for the next page of results. To view the next page of results, call <code>DescribeObjects</code>
447
- * again with this marker value. If the value is null, there are no more results.</p>
448
- */
449
- marker?: string;
450
-
451
- /**
452
- * <p>Indicates whether there are more results to return.</p>
453
- */
454
- hasMoreResults?: boolean;
455
- }
456
-
457
- export namespace DescribeObjectsOutput {
458
- /**
459
- * @internal
460
- */
461
- export const filterSensitiveLog = (obj: DescribeObjectsOutput): any => ({
462
- ...obj,
463
- });
464
- }
465
-
466
- /**
467
- * <p>Contains the parameters for DescribePipelines.</p>
468
- */
469
- export interface DescribePipelinesInput {
470
- /**
471
- * <p>The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call.
472
- * To obtain pipeline IDs, call <a>ListPipelines</a>.</p>
473
- */
474
- pipelineIds: string[] | undefined;
475
- }
476
-
477
- export namespace DescribePipelinesInput {
478
- /**
479
- * @internal
480
- */
481
- export const filterSensitiveLog = (obj: DescribePipelinesInput): any => ({
482
- ...obj,
483
- });
484
- }
485
-
486
- /**
487
- * <p>Contains pipeline metadata.</p>
488
- */
489
- export interface PipelineDescription {
490
- /**
491
- * <p>The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>.</p>
492
- */
493
- pipelineId: string | undefined;
494
-
495
- /**
496
- * <p>The name of the pipeline.</p>
497
- */
498
- name: string | undefined;
499
-
500
- /**
501
- * <p>A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.</p>
502
- */
503
- fields: Field[] | undefined;
504
-
505
- /**
506
- * <p>Description of the pipeline.</p>
507
- */
508
- description?: string;
509
-
510
- /**
511
- * <p>A list of tags to associated with a pipeline. Tags let you control access to pipelines.
512
- * For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>
513
- */
514
- tags?: Tag[];
515
- }
516
-
517
- export namespace PipelineDescription {
518
- /**
519
- * @internal
520
- */
521
- export const filterSensitiveLog = (obj: PipelineDescription): any => ({
522
- ...obj,
523
- });
524
- }
525
-
526
- /**
527
- * <p>Contains the output of DescribePipelines.</p>
528
- */
529
- export interface DescribePipelinesOutput {
530
- /**
531
- * <p>An array of descriptions for the specified pipelines.</p>
532
- */
533
- pipelineDescriptionList: PipelineDescription[] | undefined;
534
- }
535
-
536
- export namespace DescribePipelinesOutput {
537
- /**
538
- * @internal
539
- */
540
- export const filterSensitiveLog = (obj: DescribePipelinesOutput): any => ({
541
- ...obj,
542
- });
543
- }
544
-
545
- /**
546
- * <p>Contains the parameters for EvaluateExpression.</p>
547
- */
548
- export interface EvaluateExpressionInput {
549
- /**
550
- * <p>The ID of the pipeline.</p>
551
- */
552
- pipelineId: string | undefined;
553
-
554
- /**
555
- * <p>The ID of the object.</p>
556
- */
557
- objectId: string | undefined;
558
-
559
- /**
560
- * <p>The expression to evaluate.</p>
561
- */
562
- expression: string | undefined;
563
- }
564
-
565
- export namespace EvaluateExpressionInput {
566
- /**
567
- * @internal
568
- */
569
- export const filterSensitiveLog = (obj: EvaluateExpressionInput): any => ({
570
- ...obj,
571
- });
572
- }
573
-
574
- /**
575
- * <p>Contains the output of EvaluateExpression.</p>
576
- */
577
- export interface EvaluateExpressionOutput {
578
- /**
579
- * <p>The evaluated expression.</p>
580
- */
581
- evaluatedExpression: string | undefined;
582
- }
583
-
584
- export namespace EvaluateExpressionOutput {
585
- /**
586
- * @internal
587
- */
588
- export const filterSensitiveLog = (obj: EvaluateExpressionOutput): any => ({
589
- ...obj,
590
- });
591
- }
592
-
593
- /**
594
- * <p>The specified task was not found. </p>
595
- */
596
- export interface TaskNotFoundException extends __SmithyException, $MetadataBearer {
597
- name: "TaskNotFoundException";
598
- $fault: "client";
599
- /**
600
- * <p>Description of the error message.</p>
601
- */
602
- message?: string;
603
- }
604
-
605
- export namespace TaskNotFoundException {
606
- /**
607
- * @internal
608
- */
609
- export const filterSensitiveLog = (obj: TaskNotFoundException): any => ({
610
- ...obj,
611
- });
612
- }
613
-
614
- /**
615
- * <p>Contains the parameters for GetPipelineDefinition.</p>
616
- */
617
- export interface GetPipelineDefinitionInput {
618
- /**
619
- * <p>The ID of the pipeline.</p>
620
- */
621
- pipelineId: string | undefined;
622
-
623
- /**
624
- * <p>The version of the pipeline definition to retrieve. Set this parameter to <code>latest</code> (default)
625
- * to use the last definition saved to the pipeline or <code>active</code> to use the last definition
626
- * that was activated.</p>
627
- */
628
- version?: string;
629
- }
630
-
631
- export namespace GetPipelineDefinitionInput {
632
- /**
633
- * @internal
634
- */
635
- export const filterSensitiveLog = (obj: GetPipelineDefinitionInput): any => ({
636
- ...obj,
637
- });
638
- }
639
-
640
- /**
641
- * <p>The attributes allowed or specified with a parameter object.</p>
642
- */
643
- export interface ParameterAttribute {
644
- /**
645
- * <p>The field identifier.</p>
646
- */
647
- key: string | undefined;
648
-
649
- /**
650
- * <p>The field value, expressed as a String.</p>
651
- */
652
- stringValue: string | undefined;
653
- }
654
-
655
- export namespace ParameterAttribute {
656
- /**
657
- * @internal
658
- */
659
- export const filterSensitiveLog = (obj: ParameterAttribute): any => ({
660
- ...obj,
661
- });
662
- }
663
-
664
- /**
665
- * <p>Contains information about a parameter object.</p>
666
- */
667
- export interface ParameterObject {
668
- /**
669
- * <p>The ID of the parameter object. </p>
670
- */
671
- id: string | undefined;
672
-
673
- /**
674
- * <p>The attributes of the parameter object.</p>
675
- */
676
- attributes: ParameterAttribute[] | undefined;
677
- }
678
-
679
- export namespace ParameterObject {
680
- /**
681
- * @internal
682
- */
683
- export const filterSensitiveLog = (obj: ParameterObject): any => ({
684
- ...obj,
685
- });
686
- }
687
-
688
- /**
689
- * <p>Contains the output of GetPipelineDefinition.</p>
690
- */
691
- export interface GetPipelineDefinitionOutput {
692
- /**
693
- * <p>The objects defined in the pipeline.</p>
694
- */
695
- pipelineObjects?: PipelineObject[];
696
-
697
- /**
698
- * <p>The parameter objects used in the pipeline definition.</p>
699
- */
700
- parameterObjects?: ParameterObject[];
701
-
702
- /**
703
- * <p>The parameter values used in the pipeline definition.</p>
704
- */
705
- parameterValues?: ParameterValue[];
706
- }
707
-
708
- export namespace GetPipelineDefinitionOutput {
709
- /**
710
- * @internal
711
- */
712
- export const filterSensitiveLog = (obj: GetPipelineDefinitionOutput): any => ({
713
- ...obj,
714
- });
715
- }
716
-
717
- /**
718
- * <p>Contains the parameters for ListPipelines.</p>
719
- */
720
- export interface ListPipelinesInput {
721
- /**
722
- * <p>The starting point for the results to be returned. For the first call, this value should be empty.
723
- * As long as there are more results, continue to call <code>ListPipelines</code> with
724
- * the marker value from the previous call to retrieve the next set of results.</p>
725
- */
726
- marker?: string;
727
- }
728
-
729
- export namespace ListPipelinesInput {
730
- /**
731
- * @internal
732
- */
733
- export const filterSensitiveLog = (obj: ListPipelinesInput): any => ({
734
- ...obj,
735
- });
736
- }
737
-
738
- /**
739
- * <p>Contains the name and identifier of a pipeline.</p>
740
- */
741
- export interface PipelineIdName {
742
- /**
743
- * <p>The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>.</p>
744
- */
745
- id?: string;
746
-
747
- /**
748
- * <p>The name of the pipeline.</p>
749
- */
750
- name?: string;
751
- }
752
-
753
- export namespace PipelineIdName {
754
- /**
755
- * @internal
756
- */
757
- export const filterSensitiveLog = (obj: PipelineIdName): any => ({
758
- ...obj,
759
- });
760
- }
761
-
762
- /**
763
- * <p>Contains the output of ListPipelines.</p>
764
- */
765
- export interface ListPipelinesOutput {
766
- /**
767
- * <p>The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call
768
- * <a>DescribePipelines</a> and <a>GetPipelineDefinition</a>.</p>
769
- */
770
- pipelineIdList: PipelineIdName[] | undefined;
771
-
772
- /**
773
- * <p>The starting point for the next page of results. To view the next page of results, call <code>ListPipelinesOutput</code>
774
- * again with this marker value. If the value is null, there are no more results.</p>
775
- */
776
- marker?: string;
777
-
778
- /**
779
- * <p>Indicates whether there are more results that can be obtained by a subsequent call.</p>
780
- */
781
- hasMoreResults?: boolean;
782
- }
783
-
784
- export namespace ListPipelinesOutput {
785
- /**
786
- * @internal
787
- */
788
- export const filterSensitiveLog = (obj: ListPipelinesOutput): any => ({
789
- ...obj,
790
- });
791
- }
792
-
793
- /**
794
- * <p><p>Identity information for the EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance.
795
- * For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i>
796
- * Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.</p></p>
797
- */
798
- export interface InstanceIdentity {
799
- /**
800
- * <p>A description of an EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.</p>
801
- */
802
- document?: string;
803
-
804
- /**
805
- * <p>A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.</p>
806
- */
807
- signature?: string;
808
- }
809
-
810
- export namespace InstanceIdentity {
811
- /**
812
- * @internal
813
- */
814
- export const filterSensitiveLog = (obj: InstanceIdentity): any => ({
815
- ...obj,
816
- });
817
- }
818
-
819
- /**
820
- * <p>Contains the parameters for PollForTask.</p>
821
- */
822
- export interface PollForTaskInput {
823
- /**
824
- * <p>The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created.
825
- * You can only specify a single value for <code>workerGroup</code> in the call to <code>PollForTask</code>. There are no wildcard values permitted in
826
- * <code>workerGroup</code>; the string must be an exact, case-sensitive, match.</p>
827
- */
828
- workerGroup: string | undefined;
829
-
830
- /**
831
- * <p>The public DNS name of the calling task runner.</p>
832
- */
833
- hostname?: string;
834
-
835
- /**
836
- * <p>Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using <code>http://169.254.169.254/latest/meta-data/instance-id</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.</p>
837
- */
838
- instanceIdentity?: InstanceIdentity;
839
- }
840
-
841
- export namespace PollForTaskInput {
842
- /**
843
- * @internal
844
- */
845
- export const filterSensitiveLog = (obj: PollForTaskInput): any => ({
846
- ...obj,
847
- });
848
- }
849
-
850
- /**
851
- * <p>Contains information about a pipeline task that is assigned to a task runner.</p>
852
- */
853
- export interface TaskObject {
854
- /**
855
- * <p>An internal identifier for the task. This ID is passed to the <a>SetTaskStatus</a> and <a>ReportTaskProgress</a> actions.</p>
856
- */
857
- taskId?: string;
858
-
859
- /**
860
- * <p>The ID of the pipeline that provided the task.</p>
861
- */
862
- pipelineId?: string;
863
-
864
- /**
865
- * <p>The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.</p>
866
- */
867
- attemptId?: string;
868
-
869
- /**
870
- * <p>Connection information for the location where the task runner will publish the output of the task.</p>
871
- */
872
- objects?: { [key: string]: PipelineObject };
873
- }
874
-
875
- export namespace TaskObject {
876
- /**
877
- * @internal
878
- */
879
- export const filterSensitiveLog = (obj: TaskObject): any => ({
880
- ...obj,
881
- });
882
- }
883
-
884
- /**
885
- * <p>Contains the output of PollForTask.</p>
886
- */
887
- export interface PollForTaskOutput {
888
- /**
889
- * <p>The information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is <code>taskId</code>,
890
- * which contains an identifier for the task being assigned. The calling task runner uses <code>taskId</code> in subsequent calls to <a>ReportTaskProgress</a>
891
- * and <a>SetTaskStatus</a>.</p>
892
- */
893
- taskObject?: TaskObject;
894
- }
895
-
896
- export namespace PollForTaskOutput {
897
- /**
898
- * @internal
899
- */
900
- export const filterSensitiveLog = (obj: PollForTaskOutput): any => ({
901
- ...obj,
902
- });
903
- }
904
-
905
- /**
906
- * <p>Contains the parameters for PutPipelineDefinition.</p>
907
- */
908
- export interface PutPipelineDefinitionInput {
909
- /**
910
- * <p>The ID of the pipeline.</p>
911
- */
912
- pipelineId: string | undefined;
913
-
914
- /**
915
- * <p>The objects that define the pipeline. These objects overwrite the existing pipeline definition.</p>
916
- */
917
- pipelineObjects: PipelineObject[] | undefined;
918
-
919
- /**
920
- * <p>The parameter objects used with the pipeline.</p>
921
- */
922
- parameterObjects?: ParameterObject[];
923
-
924
- /**
925
- * <p>The parameter values used with the pipeline.</p>
926
- */
927
- parameterValues?: ParameterValue[];
928
- }
929
-
930
- export namespace PutPipelineDefinitionInput {
931
- /**
932
- * @internal
933
- */
934
- export const filterSensitiveLog = (obj: PutPipelineDefinitionInput): any => ({
935
- ...obj,
936
- });
937
- }
938
-
939
- /**
940
- * <p>Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.</p>
941
- */
942
- export interface ValidationError {
943
- /**
944
- * <p>The identifier of the object that contains the validation error.</p>
945
- */
946
- id?: string;
947
-
948
- /**
949
- * <p>A description of the validation error.</p>
950
- */
951
- errors?: string[];
952
- }
953
-
954
- export namespace ValidationError {
955
- /**
956
- * @internal
957
- */
958
- export const filterSensitiveLog = (obj: ValidationError): any => ({
959
- ...obj,
960
- });
961
- }
962
-
963
- /**
964
- * <p>Defines a validation warning. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.</p>
965
- */
966
- export interface ValidationWarning {
967
- /**
968
- * <p>The identifier of the object that contains the validation warning.</p>
969
- */
970
- id?: string;
971
-
972
- /**
973
- * <p>A description of the validation warning.</p>
974
- */
975
- warnings?: string[];
976
- }
977
-
978
- export namespace ValidationWarning {
979
- /**
980
- * @internal
981
- */
982
- export const filterSensitiveLog = (obj: ValidationWarning): any => ({
983
- ...obj,
984
- });
985
- }
986
-
987
- /**
988
- * <p>Contains the output of PutPipelineDefinition.</p>
989
- */
990
- export interface PutPipelineDefinitionOutput {
991
- /**
992
- * <p>The validation errors that are associated with the objects defined in <code>pipelineObjects</code>.</p>
993
- */
994
- validationErrors?: ValidationError[];
995
-
996
- /**
997
- * <p>The validation warnings that are associated with the objects defined in <code>pipelineObjects</code>.</p>
998
- */
999
- validationWarnings?: ValidationWarning[];
1000
-
1001
- /**
1002
- * <p>Indicates whether there were validation errors, and the pipeline definition is stored but cannot be
1003
- * activated until you correct the pipeline and call <code>PutPipelineDefinition</code> to commit the corrected pipeline.</p>
1004
- */
1005
- errored: boolean | undefined;
1006
- }
1007
-
1008
- export namespace PutPipelineDefinitionOutput {
1009
- /**
1010
- * @internal
1011
- */
1012
- export const filterSensitiveLog = (obj: PutPipelineDefinitionOutput): any => ({
1013
- ...obj,
1014
- });
1015
- }
1016
-
1017
- export enum OperatorType {
1018
- Between = "BETWEEN",
1019
- Equal = "EQ",
1020
- GreaterThanOrEqual = "GE",
1021
- LessThanOrEqual = "LE",
1022
- ReferenceEqual = "REF_EQ",
1023
- }
1024
-
1025
- /**
1026
- * <p>Contains a logical operation for comparing the value of a field with a specified value.</p>
1027
- */
1028
- export interface Operator {
1029
- /**
1030
- * <p>
1031
- * The logical operation to be performed: equal (<code>EQ</code>), equal reference (<code>REF_EQ</code>), less than or equal (<code>LE</code>), greater than or equal (<code>GE</code>), or between (<code>BETWEEN</code>). Equal reference (<code>REF_EQ</code>) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below.
1032
- * </p>
1033
- * <p>
1034
- * The comparison operators EQ and REF_EQ act on the following fields:
1035
- * </p>
1036
- * <ul>
1037
- * <li>name</li>
1038
- * <li>@sphere</li>
1039
- * <li>parent</li>
1040
- * <li>@componentParent</li>
1041
- * <li>@instanceParent</li>
1042
- * <li>@status</li>
1043
- * <li>@scheduledStartTime</li>
1044
- * <li>@scheduledEndTime</li>
1045
- * <li>@actualStartTime</li>
1046
- * <li>@actualEndTime</li>
1047
- * </ul>
1048
- *
1049
- * <p>
1050
- * The comparison operators <code>GE</code>, <code>LE</code>, and <code>BETWEEN</code> act on the following fields:
1051
- * </p>
1052
- * <ul>
1053
- * <li>@scheduledStartTime</li>
1054
- * <li>@scheduledEndTime</li>
1055
- * <li>@actualStartTime</li>
1056
- * <li>@actualEndTime</li>
1057
- * </ul>
1058
- * <p>Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my".</p>
1059
- */
1060
- type?: OperatorType | string;
1061
-
1062
- /**
1063
- * <p>The value that the actual field value will be compared with.</p>
1064
- */
1065
- values?: string[];
1066
- }
1067
-
1068
- export namespace Operator {
1069
- /**
1070
- * @internal
1071
- */
1072
- export const filterSensitiveLog = (obj: Operator): any => ({
1073
- ...obj,
1074
- });
1075
- }
1076
-
1077
- /**
1078
- * <p>A comparision that is used to determine whether a query should return this object.</p>
1079
- */
1080
- export interface Selector {
1081
- /**
1082
- * <p>The name of the field that the operator will be applied to. The field name is the "key" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.</p>
1083
- */
1084
- fieldName?: string;
1085
-
1086
- /**
1087
- * <p>Contains a logical operation for comparing the value of a field with a specified value.</p>
1088
- */
1089
- operator?: Operator;
1090
- }
1091
-
1092
- export namespace Selector {
1093
- /**
1094
- * @internal
1095
- */
1096
- export const filterSensitiveLog = (obj: Selector): any => ({
1097
- ...obj,
1098
- });
1099
- }
1100
-
1101
- /**
1102
- * <p>Defines the query to run against an object.</p>
1103
- */
1104
- export interface Query {
1105
- /**
1106
- * <p>List of selectors that define the query. An object must satisfy all of the selectors to match the query.</p>
1107
- */
1108
- selectors?: Selector[];
1109
- }
1110
-
1111
- export namespace Query {
1112
- /**
1113
- * @internal
1114
- */
1115
- export const filterSensitiveLog = (obj: Query): any => ({
1116
- ...obj,
1117
- });
1118
- }
1119
-
1120
- /**
1121
- * <p>Contains the parameters for QueryObjects.</p>
1122
- */
1123
- export interface QueryObjectsInput {
1124
- /**
1125
- * <p>The ID of the pipeline.</p>
1126
- */
1127
- pipelineId: string | undefined;
1128
-
1129
- /**
1130
- * <p>The query that defines the objects to be returned. The <code>Query</code> object can contain a maximum of ten selectors.
1131
- * The conditions in the query are limited to top-level String fields in the object.
1132
- * These filters can be applied to components, instances, and attempts.</p>
1133
- */
1134
- query?: Query;
1135
-
1136
- /**
1137
- * <p>Indicates whether the query applies to components or instances. The possible values are:
1138
- * <code>COMPONENT</code>, <code>INSTANCE</code>, and <code>ATTEMPT</code>.</p>
1139
- */
1140
- sphere: string | undefined;
1141
-
1142
- /**
1143
- * <p>The starting point for the results to be returned. For the first call, this value should be empty.
1144
- * As long as there are more results, continue to call <code>QueryObjects</code> with
1145
- * the marker value from the previous call to retrieve the next set of results.</p>
1146
- */
1147
- marker?: string;
1148
-
1149
- /**
1150
- * <p>The maximum number of object names that <code>QueryObjects</code> will return in a single call. The default value is 100. </p>
1151
- */
1152
- limit?: number;
1153
- }
1154
-
1155
- export namespace QueryObjectsInput {
1156
- /**
1157
- * @internal
1158
- */
1159
- export const filterSensitiveLog = (obj: QueryObjectsInput): any => ({
1160
- ...obj,
1161
- });
1162
- }
1163
-
1164
- /**
1165
- * <p>Contains the output of QueryObjects.</p>
1166
- */
1167
- export interface QueryObjectsOutput {
1168
- /**
1169
- * <p>The identifiers that match the query selectors.</p>
1170
- */
1171
- ids?: string[];
1172
-
1173
- /**
1174
- * <p>The starting point for the next page of results. To view the next page of results, call <code>QueryObjects</code>
1175
- * again with this marker value. If the value is null, there are no more results.</p>
1176
- */
1177
- marker?: string;
1178
-
1179
- /**
1180
- * <p>Indicates whether there are more results that can be obtained by a subsequent call.</p>
1181
- */
1182
- hasMoreResults?: boolean;
1183
- }
1184
-
1185
- export namespace QueryObjectsOutput {
1186
- /**
1187
- * @internal
1188
- */
1189
- export const filterSensitiveLog = (obj: QueryObjectsOutput): any => ({
1190
- ...obj,
1191
- });
1192
- }
1193
-
1194
- /**
1195
- * <p>Contains the parameters for RemoveTags.</p>
1196
- */
1197
- export interface RemoveTagsInput {
1198
- /**
1199
- * <p>The ID of the pipeline.</p>
1200
- */
1201
- pipelineId: string | undefined;
1202
-
1203
- /**
1204
- * <p>The keys of the tags to remove.</p>
1205
- */
1206
- tagKeys: string[] | undefined;
1207
- }
1208
-
1209
- export namespace RemoveTagsInput {
1210
- /**
1211
- * @internal
1212
- */
1213
- export const filterSensitiveLog = (obj: RemoveTagsInput): any => ({
1214
- ...obj,
1215
- });
1216
- }
1217
-
1218
- /**
1219
- * <p>Contains the output of RemoveTags.</p>
1220
- */
1221
- export interface RemoveTagsOutput {}
1222
-
1223
- export namespace RemoveTagsOutput {
1224
- /**
1225
- * @internal
1226
- */
1227
- export const filterSensitiveLog = (obj: RemoveTagsOutput): any => ({
1228
- ...obj,
1229
- });
1230
- }
1231
-
1232
- /**
1233
- * <p>Contains the parameters for ReportTaskProgress.</p>
1234
- */
1235
- export interface ReportTaskProgressInput {
1236
- /**
1237
- * <p>The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>.</p>
1238
- */
1239
- taskId: string | undefined;
1240
-
1241
- /**
1242
- * <p>Key-value pairs that define the properties of the ReportTaskProgressInput object.</p>
1243
- */
1244
- fields?: Field[];
1245
- }
1246
-
1247
- export namespace ReportTaskProgressInput {
1248
- /**
1249
- * @internal
1250
- */
1251
- export const filterSensitiveLog = (obj: ReportTaskProgressInput): any => ({
1252
- ...obj,
1253
- });
1254
- }
1255
-
1256
- /**
1257
- * <p>Contains the output of ReportTaskProgress.</p>
1258
- */
1259
- export interface ReportTaskProgressOutput {
1260
- /**
1261
- * <p>If true, the calling task runner should cancel processing of the task. The task runner does not need to call <a>SetTaskStatus</a> for canceled tasks.</p>
1262
- */
1263
- canceled: boolean | undefined;
1264
- }
1265
-
1266
- export namespace ReportTaskProgressOutput {
1267
- /**
1268
- * @internal
1269
- */
1270
- export const filterSensitiveLog = (obj: ReportTaskProgressOutput): any => ({
1271
- ...obj,
1272
- });
1273
- }
1274
-
1275
- /**
1276
- * <p>Contains the parameters for ReportTaskRunnerHeartbeat.</p>
1277
- */
1278
- export interface ReportTaskRunnerHeartbeatInput {
1279
- /**
1280
- * <p>The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner
1281
- * launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application.
1282
- * If you have written a custom task runner, you should assign a unique identifier for the task runner.</p>
1283
- */
1284
- taskrunnerId: string | undefined;
1285
-
1286
- /**
1287
- * <p>The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created.
1288
- * You can only specify a single value for <code>workerGroup</code>. There are no wildcard values permitted in <code>workerGroup</code>; the string
1289
- * must be an exact, case-sensitive, match.</p>
1290
- */
1291
- workerGroup?: string;
1292
-
1293
- /**
1294
- * <p>The public DNS name of the task runner.</p>
1295
- */
1296
- hostname?: string;
1297
- }
1298
-
1299
- export namespace ReportTaskRunnerHeartbeatInput {
1300
- /**
1301
- * @internal
1302
- */
1303
- export const filterSensitiveLog = (obj: ReportTaskRunnerHeartbeatInput): any => ({
1304
- ...obj,
1305
- });
1306
- }
1307
-
1308
- /**
1309
- * <p>Contains the output of ReportTaskRunnerHeartbeat.</p>
1310
- */
1311
- export interface ReportTaskRunnerHeartbeatOutput {
1312
- /**
1313
- * <p>Indicates whether the calling task runner should terminate.</p>
1314
- */
1315
- terminate: boolean | undefined;
1316
- }
1317
-
1318
- export namespace ReportTaskRunnerHeartbeatOutput {
1319
- /**
1320
- * @internal
1321
- */
1322
- export const filterSensitiveLog = (obj: ReportTaskRunnerHeartbeatOutput): any => ({
1323
- ...obj,
1324
- });
1325
- }
1326
-
1327
- /**
1328
- * <p>Contains the parameters for SetStatus.</p>
1329
- */
1330
- export interface SetStatusInput {
1331
- /**
1332
- * <p>The ID of the pipeline that contains the objects.</p>
1333
- */
1334
- pipelineId: string | undefined;
1335
-
1336
- /**
1337
- * <p>The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.</p>
1338
- */
1339
- objectIds: string[] | undefined;
1340
-
1341
- /**
1342
- * <p>The status to be set on all the objects specified in <code>objectIds</code>. For components, use <code>PAUSE</code> or <code>RESUME</code>.
1343
- * For instances, use <code>TRY_CANCEL</code>, <code>RERUN</code>, or <code>MARK_FINISHED</code>.</p>
1344
- */
1345
- status: string | undefined;
1346
- }
1347
-
1348
- export namespace SetStatusInput {
1349
- /**
1350
- * @internal
1351
- */
1352
- export const filterSensitiveLog = (obj: SetStatusInput): any => ({
1353
- ...obj,
1354
- });
1355
- }
1356
-
1357
- export enum TaskStatus {
1358
- FAILED = "FAILED",
1359
- FALSE = "FALSE",
1360
- FINISHED = "FINISHED",
1361
- }
1362
-
1363
- /**
1364
- * <p>Contains the parameters for SetTaskStatus.</p>
1365
- */
1366
- export interface SetTaskStatusInput {
1367
- /**
1368
- * <p>The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>.</p>
1369
- */
1370
- taskId: string | undefined;
1371
-
1372
- /**
1373
- * <p>If <code>FINISHED</code>, the task successfully completed. If <code>FAILED</code>, the task ended unsuccessfully. Preconditions use false.</p>
1374
- */
1375
- taskStatus: TaskStatus | string | undefined;
1376
-
1377
- /**
1378
- * <p>If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object.
1379
- * It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.</p>
1380
- */
1381
- errorId?: string;
1382
-
1383
- /**
1384
- * <p>If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object.
1385
- * It is used to display error information to the user. The web service does not parse this value.</p>
1386
- */
1387
- errorMessage?: string;
1388
-
1389
- /**
1390
- * <p>If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object.
1391
- * It is used to display error information to the user. The web service does not parse this value.</p>
1392
- */
1393
- errorStackTrace?: string;
1394
- }
1395
-
1396
- export namespace SetTaskStatusInput {
1397
- /**
1398
- * @internal
1399
- */
1400
- export const filterSensitiveLog = (obj: SetTaskStatusInput): any => ({
1401
- ...obj,
1402
- });
1403
- }
1404
-
1405
- /**
1406
- * <p>Contains the output of SetTaskStatus.</p>
1407
- */
1408
- export interface SetTaskStatusOutput {}
1409
-
1410
- export namespace SetTaskStatusOutput {
1411
- /**
1412
- * @internal
1413
- */
1414
- export const filterSensitiveLog = (obj: SetTaskStatusOutput): any => ({
1415
- ...obj,
1416
- });
1417
- }
1418
-
1419
- /**
1420
- * <p>Contains the parameters for ValidatePipelineDefinition.</p>
1421
- */
1422
- export interface ValidatePipelineDefinitionInput {
1423
- /**
1424
- * <p>The ID of the pipeline.</p>
1425
- */
1426
- pipelineId: string | undefined;
1427
-
1428
- /**
1429
- * <p>The objects that define the pipeline changes to validate against the pipeline.</p>
1430
- */
1431
- pipelineObjects: PipelineObject[] | undefined;
1432
-
1433
- /**
1434
- * <p>The parameter objects used with the pipeline.</p>
1435
- */
1436
- parameterObjects?: ParameterObject[];
1437
-
1438
- /**
1439
- * <p>The parameter values used with the pipeline.</p>
1440
- */
1441
- parameterValues?: ParameterValue[];
1442
- }
1443
-
1444
- export namespace ValidatePipelineDefinitionInput {
1445
- /**
1446
- * @internal
1447
- */
1448
- export const filterSensitiveLog = (obj: ValidatePipelineDefinitionInput): any => ({
1449
- ...obj,
1450
- });
1451
- }
1452
-
1453
- /**
1454
- * <p>Contains the output of ValidatePipelineDefinition.</p>
1455
- */
1456
- export interface ValidatePipelineDefinitionOutput {
1457
- /**
1458
- * <p>Any validation errors that were found.</p>
1459
- */
1460
- validationErrors?: ValidationError[];
1461
-
1462
- /**
1463
- * <p>Any validation warnings that were found.</p>
1464
- */
1465
- validationWarnings?: ValidationWarning[];
1466
-
1467
- /**
1468
- * <p>Indicates whether there were validation errors.</p>
1469
- */
1470
- errored: boolean | undefined;
1471
- }
1472
-
1473
- export namespace ValidatePipelineDefinitionOutput {
1474
- /**
1475
- * @internal
1476
- */
1477
- export const filterSensitiveLog = (obj: ValidatePipelineDefinitionOutput): any => ({
1478
- ...obj,
1479
- });
1480
- }