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