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