aws-sdk-importexport 1.0.0.rc1 → 1.0.0.rc2

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,23 +1,14 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
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 ImportExport
10
- module Errors
8
+ module Aws::ImportExport
9
+ module Errors
11
10
 
12
- extend Aws::Errors::DynamicErrors
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 info on making contributions:
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 ImportExport
10
- class Resource
8
+ module Aws::ImportExport
9
+ class Resource
11
10
 
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
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,486 +1,516 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
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 ImportExport
10
- module Types
8
+ module Aws::ImportExport
9
+ module Types
11
10
 
12
- # A discrete item that contains the description and URL of an artifact
13
- # (such as a PDF).
14
- # @!attribute [rw] description
15
- # The associated description for this object.
16
- # @return [String]
17
- #
18
- # @!attribute [rw] url
19
- # The URL for a given Artifact.
20
- # @return [String]
21
- class Artifact < Struct.new(
22
- :description,
23
- :url)
24
- include Aws::Structure
25
- end
26
-
27
- # Input structure for the CancelJob operation.
28
- # @note When making an API call, pass CancelJobInput
29
- # data as a hash:
30
- #
31
- # {
32
- # job_id: "JobId", # required
33
- # api_version: "APIVersion",
34
- # }
35
- # @!attribute [rw] job_id
36
- # A unique identifier which refers to a particular job.
37
- # @return [String]
38
- #
39
- # @!attribute [rw] api_version
40
- # Specifies the version of the client tool.
41
- # @return [String]
42
- class CancelJobInput < Struct.new(
43
- :job_id,
44
- :api_version)
45
- include Aws::Structure
46
- end
11
+ # A discrete item that contains the description and URL of an artifact
12
+ # (such as a PDF).
13
+ #
14
+ # @!attribute [rw] description
15
+ # The associated description for this object.
16
+ # @return [String]
17
+ #
18
+ # @!attribute [rw] url
19
+ # The URL for a given Artifact.
20
+ # @return [String]
21
+ #
22
+ class Artifact < Struct.new(
23
+ :description,
24
+ :url)
25
+ include Aws::Structure
26
+ end
47
27
 
48
- # Output structure for the CancelJob operation.
49
- # @!attribute [rw] success
50
- # Specifies whether (true) or not (false) AWS Import/Export updated
51
- # your job.
52
- # @return [Boolean]
53
- class CancelJobOutput < Struct.new(
54
- :success)
55
- include Aws::Structure
56
- end
28
+ # Input structure for the CancelJob operation.
29
+ #
30
+ # @note When making an API call, you may pass CancelJobInput
31
+ # data as a hash:
32
+ #
33
+ # {
34
+ # job_id: "JobId", # required
35
+ # api_version: "APIVersion",
36
+ # }
37
+ #
38
+ # @!attribute [rw] job_id
39
+ # A unique identifier which refers to a particular job.
40
+ # @return [String]
41
+ #
42
+ # @!attribute [rw] api_version
43
+ # Specifies the version of the client tool.
44
+ # @return [String]
45
+ #
46
+ class CancelJobInput < Struct.new(
47
+ :job_id,
48
+ :api_version)
49
+ include Aws::Structure
50
+ end
57
51
 
58
- # Input structure for the CreateJob operation.
59
- # @note When making an API call, pass CreateJobInput
60
- # data as a hash:
61
- #
62
- # {
63
- # job_type: "Import", # required, accepts Import, Export
64
- # manifest: "Manifest", # required
65
- # manifest_addendum: "ManifestAddendum",
66
- # validate_only: false, # required
67
- # api_version: "APIVersion",
68
- # }
69
- # @!attribute [rw] job_type
70
- # Specifies whether the job to initiate is an import or export job.
71
- # @return [String]
72
- #
73
- # @!attribute [rw] manifest
74
- # The UTF-8 encoded text of the manifest file.
75
- # @return [String]
76
- #
77
- # @!attribute [rw] manifest_addendum
78
- # For internal use only.
79
- # @return [String]
80
- #
81
- # @!attribute [rw] validate_only
82
- # Validate the manifest and parameter values in the request but do not
83
- # actually create a job.
84
- # @return [Boolean]
85
- #
86
- # @!attribute [rw] api_version
87
- # Specifies the version of the client tool.
88
- # @return [String]
89
- class CreateJobInput < Struct.new(
90
- :job_type,
91
- :manifest,
92
- :manifest_addendum,
93
- :validate_only,
94
- :api_version)
95
- include Aws::Structure
96
- end
52
+ # Output structure for the CancelJob operation.
53
+ #
54
+ # @!attribute [rw] success
55
+ # Specifies whether (true) or not (false) AWS Import/Export updated
56
+ # your job.
57
+ # @return [Boolean]
58
+ #
59
+ class CancelJobOutput < Struct.new(
60
+ :success)
61
+ include Aws::Structure
62
+ end
97
63
 
98
- # Output structure for the CreateJob operation.
99
- # @!attribute [rw] job_id
100
- # A unique identifier which refers to a particular job.
101
- # @return [String]
102
- #
103
- # @!attribute [rw] job_type
104
- # Specifies whether the job to initiate is an import or export job.
105
- # @return [String]
106
- #
107
- # @!attribute [rw] signature
108
- # An encrypted code used to authenticate the request and response, for
109
- # example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is
110
- # you want to create the signature file yourself. Generally you should
111
- # use the SignatureFileContents value.
112
- # @return [String]
113
- #
114
- # @!attribute [rw] signature_file_contents
115
- # The actual text of the SIGNATURE file to be written to disk.
116
- # @return [String]
117
- #
118
- # @!attribute [rw] warning_message
119
- # An optional message notifying you of non-fatal issues with the job,
120
- # such as use of an incompatible Amazon S3 bucket name.
121
- # @return [String]
122
- #
123
- # @!attribute [rw] artifact_list
124
- # A collection of artifacts.
125
- # @return [Array<Types::Artifact>]
126
- class CreateJobOutput < Struct.new(
127
- :job_id,
128
- :job_type,
129
- :signature,
130
- :signature_file_contents,
131
- :warning_message,
132
- :artifact_list)
133
- include Aws::Structure
134
- end
64
+ # Input structure for the CreateJob operation.
65
+ #
66
+ # @note When making an API call, you may pass CreateJobInput
67
+ # data as a hash:
68
+ #
69
+ # {
70
+ # job_type: "Import", # required, accepts Import, Export
71
+ # manifest: "Manifest", # required
72
+ # manifest_addendum: "ManifestAddendum",
73
+ # validate_only: false, # required
74
+ # api_version: "APIVersion",
75
+ # }
76
+ #
77
+ # @!attribute [rw] job_type
78
+ # Specifies whether the job to initiate is an import or export job.
79
+ # @return [String]
80
+ #
81
+ # @!attribute [rw] manifest
82
+ # The UTF-8 encoded text of the manifest file.
83
+ # @return [String]
84
+ #
85
+ # @!attribute [rw] manifest_addendum
86
+ # For internal use only.
87
+ # @return [String]
88
+ #
89
+ # @!attribute [rw] validate_only
90
+ # Validate the manifest and parameter values in the request but do not
91
+ # actually create a job.
92
+ # @return [Boolean]
93
+ #
94
+ # @!attribute [rw] api_version
95
+ # Specifies the version of the client tool.
96
+ # @return [String]
97
+ #
98
+ class CreateJobInput < Struct.new(
99
+ :job_type,
100
+ :manifest,
101
+ :manifest_addendum,
102
+ :validate_only,
103
+ :api_version)
104
+ include Aws::Structure
105
+ end
135
106
 
136
- # @note When making an API call, pass GetShippingLabelInput
137
- # data as a hash:
138
- #
139
- # {
140
- # job_ids: ["GenericString"], # required
141
- # name: "name",
142
- # company: "company",
143
- # phone_number: "phoneNumber",
144
- # country: "country",
145
- # state_or_province: "stateOrProvince",
146
- # city: "city",
147
- # postal_code: "postalCode",
148
- # street1: "street1",
149
- # street2: "street2",
150
- # street3: "street3",
151
- # api_version: "APIVersion",
152
- # }
153
- # @!attribute [rw] job_ids
154
- # @return [Array<String>]
155
- #
156
- # @!attribute [rw] name
157
- # Specifies the name of the person responsible for shipping this
158
- # package.
159
- # @return [String]
160
- #
161
- # @!attribute [rw] company
162
- # Specifies the name of the company that will ship this package.
163
- # @return [String]
164
- #
165
- # @!attribute [rw] phone_number
166
- # Specifies the phone number of the person responsible for shipping
167
- # this package.
168
- # @return [String]
169
- #
170
- # @!attribute [rw] country
171
- # Specifies the name of your country for the return address.
172
- # @return [String]
173
- #
174
- # @!attribute [rw] state_or_province
175
- # Specifies the name of your state or your province for the return
176
- # address.
177
- # @return [String]
178
- #
179
- # @!attribute [rw] city
180
- # Specifies the name of your city for the return address.
181
- # @return [String]
182
- #
183
- # @!attribute [rw] postal_code
184
- # Specifies the postal code for the return address.
185
- # @return [String]
186
- #
187
- # @!attribute [rw] street1
188
- # Specifies the first part of the street address for the return
189
- # address, for example 1234 Main Street.
190
- # @return [String]
191
- #
192
- # @!attribute [rw] street2
193
- # Specifies the optional second part of the street address for the
194
- # return address, for example Suite 100.
195
- # @return [String]
196
- #
197
- # @!attribute [rw] street3
198
- # Specifies the optional third part of the street address for the
199
- # return address, for example c/o Jane Doe.
200
- # @return [String]
201
- #
202
- # @!attribute [rw] api_version
203
- # Specifies the version of the client tool.
204
- # @return [String]
205
- class GetShippingLabelInput < Struct.new(
206
- :job_ids,
207
- :name,
208
- :company,
209
- :phone_number,
210
- :country,
211
- :state_or_province,
212
- :city,
213
- :postal_code,
214
- :street1,
215
- :street2,
216
- :street3,
217
- :api_version)
218
- include Aws::Structure
219
- end
107
+ # Output structure for the CreateJob operation.
108
+ #
109
+ # @!attribute [rw] job_id
110
+ # A unique identifier which refers to a particular job.
111
+ # @return [String]
112
+ #
113
+ # @!attribute [rw] job_type
114
+ # Specifies whether the job to initiate is an import or export job.
115
+ # @return [String]
116
+ #
117
+ # @!attribute [rw] signature
118
+ # An encrypted code used to authenticate the request and response, for
119
+ # example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is
120
+ # you want to create the signature file yourself. Generally you should
121
+ # use the SignatureFileContents value.
122
+ # @return [String]
123
+ #
124
+ # @!attribute [rw] signature_file_contents
125
+ # The actual text of the SIGNATURE file to be written to disk.
126
+ # @return [String]
127
+ #
128
+ # @!attribute [rw] warning_message
129
+ # An optional message notifying you of non-fatal issues with the job,
130
+ # such as use of an incompatible Amazon S3 bucket name.
131
+ # @return [String]
132
+ #
133
+ # @!attribute [rw] artifact_list
134
+ # A collection of artifacts.
135
+ # @return [Array<Types::Artifact>]
136
+ #
137
+ class CreateJobOutput < Struct.new(
138
+ :job_id,
139
+ :job_type,
140
+ :signature,
141
+ :signature_file_contents,
142
+ :warning_message,
143
+ :artifact_list)
144
+ include Aws::Structure
145
+ end
220
146
 
221
- # @!attribute [rw] shipping_label_url
222
- # @return [String]
223
- #
224
- # @!attribute [rw] warning
225
- # @return [String]
226
- class GetShippingLabelOutput < Struct.new(
227
- :shipping_label_url,
228
- :warning)
229
- include Aws::Structure
230
- end
147
+ # @note When making an API call, you may pass GetShippingLabelInput
148
+ # data as a hash:
149
+ #
150
+ # {
151
+ # job_ids: ["GenericString"], # required
152
+ # name: "name",
153
+ # company: "company",
154
+ # phone_number: "phoneNumber",
155
+ # country: "country",
156
+ # state_or_province: "stateOrProvince",
157
+ # city: "city",
158
+ # postal_code: "postalCode",
159
+ # street1: "street1",
160
+ # street2: "street2",
161
+ # street3: "street3",
162
+ # api_version: "APIVersion",
163
+ # }
164
+ #
165
+ # @!attribute [rw] job_ids
166
+ # @return [Array<String>]
167
+ #
168
+ # @!attribute [rw] name
169
+ # Specifies the name of the person responsible for shipping this
170
+ # package.
171
+ # @return [String]
172
+ #
173
+ # @!attribute [rw] company
174
+ # Specifies the name of the company that will ship this package.
175
+ # @return [String]
176
+ #
177
+ # @!attribute [rw] phone_number
178
+ # Specifies the phone number of the person responsible for shipping
179
+ # this package.
180
+ # @return [String]
181
+ #
182
+ # @!attribute [rw] country
183
+ # Specifies the name of your country for the return address.
184
+ # @return [String]
185
+ #
186
+ # @!attribute [rw] state_or_province
187
+ # Specifies the name of your state or your province for the return
188
+ # address.
189
+ # @return [String]
190
+ #
191
+ # @!attribute [rw] city
192
+ # Specifies the name of your city for the return address.
193
+ # @return [String]
194
+ #
195
+ # @!attribute [rw] postal_code
196
+ # Specifies the postal code for the return address.
197
+ # @return [String]
198
+ #
199
+ # @!attribute [rw] street1
200
+ # Specifies the first part of the street address for the return
201
+ # address, for example 1234 Main Street.
202
+ # @return [String]
203
+ #
204
+ # @!attribute [rw] street2
205
+ # Specifies the optional second part of the street address for the
206
+ # return address, for example Suite 100.
207
+ # @return [String]
208
+ #
209
+ # @!attribute [rw] street3
210
+ # Specifies the optional third part of the street address for the
211
+ # return address, for example c/o Jane Doe.
212
+ # @return [String]
213
+ #
214
+ # @!attribute [rw] api_version
215
+ # Specifies the version of the client tool.
216
+ # @return [String]
217
+ #
218
+ class GetShippingLabelInput < Struct.new(
219
+ :job_ids,
220
+ :name,
221
+ :company,
222
+ :phone_number,
223
+ :country,
224
+ :state_or_province,
225
+ :city,
226
+ :postal_code,
227
+ :street1,
228
+ :street2,
229
+ :street3,
230
+ :api_version)
231
+ include Aws::Structure
232
+ end
231
233
 
232
- # Input structure for the GetStatus operation.
233
- # @note When making an API call, pass GetStatusInput
234
- # data as a hash:
235
- #
236
- # {
237
- # job_id: "JobId", # required
238
- # api_version: "APIVersion",
239
- # }
240
- # @!attribute [rw] job_id
241
- # A unique identifier which refers to a particular job.
242
- # @return [String]
243
- #
244
- # @!attribute [rw] api_version
245
- # Specifies the version of the client tool.
246
- # @return [String]
247
- class GetStatusInput < Struct.new(
248
- :job_id,
249
- :api_version)
250
- include Aws::Structure
251
- end
234
+ # @!attribute [rw] shipping_label_url
235
+ # @return [String]
236
+ #
237
+ # @!attribute [rw] warning
238
+ # @return [String]
239
+ #
240
+ class GetShippingLabelOutput < Struct.new(
241
+ :shipping_label_url,
242
+ :warning)
243
+ include Aws::Structure
244
+ end
252
245
 
253
- # Output structure for the GetStatus operation.
254
- # @!attribute [rw] job_id
255
- # A unique identifier which refers to a particular job.
256
- # @return [String]
257
- #
258
- # @!attribute [rw] job_type
259
- # Specifies whether the job to initiate is an import or export job.
260
- # @return [String]
261
- #
262
- # @!attribute [rw] location_code
263
- # A token representing the location of the storage device, such as
264
- # "AtAWS".
265
- # @return [String]
266
- #
267
- # @!attribute [rw] location_message
268
- # A more human readable form of the physical location of the storage
269
- # device.
270
- # @return [String]
271
- #
272
- # @!attribute [rw] progress_code
273
- # A token representing the state of the job, such as "Started".
274
- # @return [String]
275
- #
276
- # @!attribute [rw] progress_message
277
- # A more human readable form of the job status.
278
- # @return [String]
279
- #
280
- # @!attribute [rw] carrier
281
- # Name of the shipping company. This value is included when the
282
- # LocationCode is "Returned".
283
- # @return [String]
284
- #
285
- # @!attribute [rw] tracking_number
286
- # The shipping tracking number assigned by AWS Import/Export to the
287
- # storage device when it's returned to you. We return this value when
288
- # the LocationCode is "Returned".
289
- # @return [String]
290
- #
291
- # @!attribute [rw] log_bucket
292
- # Amazon S3 bucket for user logs.
293
- # @return [String]
294
- #
295
- # @!attribute [rw] log_key
296
- # The key where the user logs were stored.
297
- # @return [String]
298
- #
299
- # @!attribute [rw] error_count
300
- # Number of errors. We return this value when the ProgressCode is
301
- # Success or SuccessWithErrors.
302
- # @return [Integer]
303
- #
304
- # @!attribute [rw] signature
305
- # An encrypted code used to authenticate the request and response, for
306
- # example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is
307
- # you want to create the signature file yourself. Generally you should
308
- # use the SignatureFileContents value.
309
- # @return [String]
310
- #
311
- # @!attribute [rw] signature_file_contents
312
- # An encrypted code used to authenticate the request and response, for
313
- # example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is
314
- # you want to create the signature file yourself. Generally you should
315
- # use the SignatureFileContents value.
316
- # @return [String]
317
- #
318
- # @!attribute [rw] current_manifest
319
- # The last manifest submitted, which will be used to process the job.
320
- # @return [String]
321
- #
322
- # @!attribute [rw] creation_date
323
- # Timestamp of the CreateJob request in ISO8601 date format. For
324
- # example "2010-03-28T20:27:35Z".
325
- # @return [Time]
326
- #
327
- # @!attribute [rw] artifact_list
328
- # A collection of artifacts.
329
- # @return [Array<Types::Artifact>]
330
- class GetStatusOutput < Struct.new(
331
- :job_id,
332
- :job_type,
333
- :location_code,
334
- :location_message,
335
- :progress_code,
336
- :progress_message,
337
- :carrier,
338
- :tracking_number,
339
- :log_bucket,
340
- :log_key,
341
- :error_count,
342
- :signature,
343
- :signature_file_contents,
344
- :current_manifest,
345
- :creation_date,
346
- :artifact_list)
347
- include Aws::Structure
348
- end
246
+ # Input structure for the GetStatus operation.
247
+ #
248
+ # @note When making an API call, you may pass GetStatusInput
249
+ # data as a hash:
250
+ #
251
+ # {
252
+ # job_id: "JobId", # required
253
+ # api_version: "APIVersion",
254
+ # }
255
+ #
256
+ # @!attribute [rw] job_id
257
+ # A unique identifier which refers to a particular job.
258
+ # @return [String]
259
+ #
260
+ # @!attribute [rw] api_version
261
+ # Specifies the version of the client tool.
262
+ # @return [String]
263
+ #
264
+ class GetStatusInput < Struct.new(
265
+ :job_id,
266
+ :api_version)
267
+ include Aws::Structure
268
+ end
349
269
 
350
- # Representation of a job returned by the ListJobs operation.
351
- # @!attribute [rw] job_id
352
- # A unique identifier which refers to a particular job.
353
- # @return [String]
354
- #
355
- # @!attribute [rw] creation_date
356
- # Timestamp of the CreateJob request in ISO8601 date format. For
357
- # example "2010-03-28T20:27:35Z".
358
- # @return [Time]
359
- #
360
- # @!attribute [rw] is_canceled
361
- # Indicates whether the job was canceled.
362
- # @return [Boolean]
363
- #
364
- # @!attribute [rw] job_type
365
- # Specifies whether the job to initiate is an import or export job.
366
- # @return [String]
367
- class Job < Struct.new(
368
- :job_id,
369
- :creation_date,
370
- :is_canceled,
371
- :job_type)
372
- include Aws::Structure
373
- end
270
+ # Output structure for the GetStatus operation.
271
+ #
272
+ # @!attribute [rw] job_id
273
+ # A unique identifier which refers to a particular job.
274
+ # @return [String]
275
+ #
276
+ # @!attribute [rw] job_type
277
+ # Specifies whether the job to initiate is an import or export job.
278
+ # @return [String]
279
+ #
280
+ # @!attribute [rw] location_code
281
+ # A token representing the location of the storage device, such as
282
+ # "AtAWS".
283
+ # @return [String]
284
+ #
285
+ # @!attribute [rw] location_message
286
+ # A more human readable form of the physical location of the storage
287
+ # device.
288
+ # @return [String]
289
+ #
290
+ # @!attribute [rw] progress_code
291
+ # A token representing the state of the job, such as "Started".
292
+ # @return [String]
293
+ #
294
+ # @!attribute [rw] progress_message
295
+ # A more human readable form of the job status.
296
+ # @return [String]
297
+ #
298
+ # @!attribute [rw] carrier
299
+ # Name of the shipping company. This value is included when the
300
+ # LocationCode is "Returned".
301
+ # @return [String]
302
+ #
303
+ # @!attribute [rw] tracking_number
304
+ # The shipping tracking number assigned by AWS Import/Export to the
305
+ # storage device when it's returned to you. We return this value when
306
+ # the LocationCode is "Returned".
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] log_bucket
310
+ # Amazon S3 bucket for user logs.
311
+ # @return [String]
312
+ #
313
+ # @!attribute [rw] log_key
314
+ # The key where the user logs were stored.
315
+ # @return [String]
316
+ #
317
+ # @!attribute [rw] error_count
318
+ # Number of errors. We return this value when the ProgressCode is
319
+ # Success or SuccessWithErrors.
320
+ # @return [Integer]
321
+ #
322
+ # @!attribute [rw] signature
323
+ # An encrypted code used to authenticate the request and response, for
324
+ # example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is
325
+ # you want to create the signature file yourself. Generally you should
326
+ # use the SignatureFileContents value.
327
+ # @return [String]
328
+ #
329
+ # @!attribute [rw] signature_file_contents
330
+ # An encrypted code used to authenticate the request and response, for
331
+ # example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is
332
+ # you want to create the signature file yourself. Generally you should
333
+ # use the SignatureFileContents value.
334
+ # @return [String]
335
+ #
336
+ # @!attribute [rw] current_manifest
337
+ # The last manifest submitted, which will be used to process the job.
338
+ # @return [String]
339
+ #
340
+ # @!attribute [rw] creation_date
341
+ # Timestamp of the CreateJob request in ISO8601 date format. For
342
+ # example "2010-03-28T20:27:35Z".
343
+ # @return [Time]
344
+ #
345
+ # @!attribute [rw] artifact_list
346
+ # A collection of artifacts.
347
+ # @return [Array<Types::Artifact>]
348
+ #
349
+ class GetStatusOutput < Struct.new(
350
+ :job_id,
351
+ :job_type,
352
+ :location_code,
353
+ :location_message,
354
+ :progress_code,
355
+ :progress_message,
356
+ :carrier,
357
+ :tracking_number,
358
+ :log_bucket,
359
+ :log_key,
360
+ :error_count,
361
+ :signature,
362
+ :signature_file_contents,
363
+ :current_manifest,
364
+ :creation_date,
365
+ :artifact_list)
366
+ include Aws::Structure
367
+ end
374
368
 
375
- # Input structure for the ListJobs operation.
376
- # @note When making an API call, pass ListJobsInput
377
- # data as a hash:
378
- #
379
- # {
380
- # max_jobs: 1,
381
- # marker: "Marker",
382
- # api_version: "APIVersion",
383
- # }
384
- # @!attribute [rw] max_jobs
385
- # Sets the maximum number of jobs returned in the response. If there
386
- # are additional jobs that were not returned because MaxJobs was
387
- # exceeded, the response contains
388
- # &lt;IsTruncated&gt;true&lt;/IsTruncated&gt;. To return the
389
- # additional jobs, see Marker.
390
- # @return [Integer]
391
- #
392
- # @!attribute [rw] marker
393
- # Specifies the JOBID to start after when listing the jobs created
394
- # with your account. AWS Import/Export lists your jobs in reverse
395
- # chronological order. See MaxJobs.
396
- # @return [String]
397
- #
398
- # @!attribute [rw] api_version
399
- # Specifies the version of the client tool.
400
- # @return [String]
401
- class ListJobsInput < Struct.new(
402
- :max_jobs,
403
- :marker,
404
- :api_version)
405
- include Aws::Structure
406
- end
369
+ # Representation of a job returned by the ListJobs operation.
370
+ #
371
+ # @!attribute [rw] job_id
372
+ # A unique identifier which refers to a particular job.
373
+ # @return [String]
374
+ #
375
+ # @!attribute [rw] creation_date
376
+ # Timestamp of the CreateJob request in ISO8601 date format. For
377
+ # example "2010-03-28T20:27:35Z".
378
+ # @return [Time]
379
+ #
380
+ # @!attribute [rw] is_canceled
381
+ # Indicates whether the job was canceled.
382
+ # @return [Boolean]
383
+ #
384
+ # @!attribute [rw] job_type
385
+ # Specifies whether the job to initiate is an import or export job.
386
+ # @return [String]
387
+ #
388
+ class Job < Struct.new(
389
+ :job_id,
390
+ :creation_date,
391
+ :is_canceled,
392
+ :job_type)
393
+ include Aws::Structure
394
+ end
407
395
 
408
- # Output structure for the ListJobs operation.
409
- # @!attribute [rw] jobs
410
- # A list container for Jobs returned by the ListJobs operation.
411
- # @return [Array<Types::Job>]
412
- #
413
- # @!attribute [rw] is_truncated
414
- # Indicates whether the list of jobs was truncated. If true, then call
415
- # ListJobs again using the last JobId element as the marker.
416
- # @return [Boolean]
417
- class ListJobsOutput < Struct.new(
418
- :jobs,
419
- :is_truncated)
420
- include Aws::Structure
421
- end
396
+ # Input structure for the ListJobs operation.
397
+ #
398
+ # @note When making an API call, you may pass ListJobsInput
399
+ # data as a hash:
400
+ #
401
+ # {
402
+ # max_jobs: 1,
403
+ # marker: "Marker",
404
+ # api_version: "APIVersion",
405
+ # }
406
+ #
407
+ # @!attribute [rw] max_jobs
408
+ # Sets the maximum number of jobs returned in the response. If there
409
+ # are additional jobs that were not returned because MaxJobs was
410
+ # exceeded, the response contains
411
+ # &lt;IsTruncated&gt;true&lt;/IsTruncated&gt;. To return the
412
+ # additional jobs, see Marker.
413
+ # @return [Integer]
414
+ #
415
+ # @!attribute [rw] marker
416
+ # Specifies the JOBID to start after when listing the jobs created
417
+ # with your account. AWS Import/Export lists your jobs in reverse
418
+ # chronological order. See MaxJobs.
419
+ # @return [String]
420
+ #
421
+ # @!attribute [rw] api_version
422
+ # Specifies the version of the client tool.
423
+ # @return [String]
424
+ #
425
+ class ListJobsInput < Struct.new(
426
+ :max_jobs,
427
+ :marker,
428
+ :api_version)
429
+ include Aws::Structure
430
+ end
422
431
 
423
- # Input structure for the UpateJob operation.
424
- # @note When making an API call, pass UpdateJobInput
425
- # data as a hash:
426
- #
427
- # {
428
- # job_id: "JobId", # required
429
- # manifest: "Manifest", # required
430
- # job_type: "Import", # required, accepts Import, Export
431
- # validate_only: false, # required
432
- # api_version: "APIVersion",
433
- # }
434
- # @!attribute [rw] job_id
435
- # A unique identifier which refers to a particular job.
436
- # @return [String]
437
- #
438
- # @!attribute [rw] manifest
439
- # The UTF-8 encoded text of the manifest file.
440
- # @return [String]
441
- #
442
- # @!attribute [rw] job_type
443
- # Specifies whether the job to initiate is an import or export job.
444
- # @return [String]
445
- #
446
- # @!attribute [rw] validate_only
447
- # Validate the manifest and parameter values in the request but do not
448
- # actually create a job.
449
- # @return [Boolean]
450
- #
451
- # @!attribute [rw] api_version
452
- # Specifies the version of the client tool.
453
- # @return [String]
454
- class UpdateJobInput < Struct.new(
455
- :job_id,
456
- :manifest,
457
- :job_type,
458
- :validate_only,
459
- :api_version)
460
- include Aws::Structure
461
- end
432
+ # Output structure for the ListJobs operation.
433
+ #
434
+ # @!attribute [rw] jobs
435
+ # A list container for Jobs returned by the ListJobs operation.
436
+ # @return [Array<Types::Job>]
437
+ #
438
+ # @!attribute [rw] is_truncated
439
+ # Indicates whether the list of jobs was truncated. If true, then call
440
+ # ListJobs again using the last JobId element as the marker.
441
+ # @return [Boolean]
442
+ #
443
+ class ListJobsOutput < Struct.new(
444
+ :jobs,
445
+ :is_truncated)
446
+ include Aws::Structure
447
+ end
462
448
 
463
- # Output structure for the UpateJob operation.
464
- # @!attribute [rw] success
465
- # Specifies whether (true) or not (false) AWS Import/Export updated
466
- # your job.
467
- # @return [Boolean]
468
- #
469
- # @!attribute [rw] warning_message
470
- # An optional message notifying you of non-fatal issues with the job,
471
- # such as use of an incompatible Amazon S3 bucket name.
472
- # @return [String]
473
- #
474
- # @!attribute [rw] artifact_list
475
- # A collection of artifacts.
476
- # @return [Array<Types::Artifact>]
477
- class UpdateJobOutput < Struct.new(
478
- :success,
479
- :warning_message,
480
- :artifact_list)
481
- include Aws::Structure
482
- end
449
+ # Input structure for the UpateJob operation.
450
+ #
451
+ # @note When making an API call, you may pass UpdateJobInput
452
+ # data as a hash:
453
+ #
454
+ # {
455
+ # job_id: "JobId", # required
456
+ # manifest: "Manifest", # required
457
+ # job_type: "Import", # required, accepts Import, Export
458
+ # validate_only: false, # required
459
+ # api_version: "APIVersion",
460
+ # }
461
+ #
462
+ # @!attribute [rw] job_id
463
+ # A unique identifier which refers to a particular job.
464
+ # @return [String]
465
+ #
466
+ # @!attribute [rw] manifest
467
+ # The UTF-8 encoded text of the manifest file.
468
+ # @return [String]
469
+ #
470
+ # @!attribute [rw] job_type
471
+ # Specifies whether the job to initiate is an import or export job.
472
+ # @return [String]
473
+ #
474
+ # @!attribute [rw] validate_only
475
+ # Validate the manifest and parameter values in the request but do not
476
+ # actually create a job.
477
+ # @return [Boolean]
478
+ #
479
+ # @!attribute [rw] api_version
480
+ # Specifies the version of the client tool.
481
+ # @return [String]
482
+ #
483
+ class UpdateJobInput < Struct.new(
484
+ :job_id,
485
+ :manifest,
486
+ :job_type,
487
+ :validate_only,
488
+ :api_version)
489
+ include Aws::Structure
490
+ end
483
491
 
492
+ # Output structure for the UpateJob operation.
493
+ #
494
+ # @!attribute [rw] success
495
+ # Specifies whether (true) or not (false) AWS Import/Export updated
496
+ # your job.
497
+ # @return [Boolean]
498
+ #
499
+ # @!attribute [rw] warning_message
500
+ # An optional message notifying you of non-fatal issues with the job,
501
+ # such as use of an incompatible Amazon S3 bucket name.
502
+ # @return [String]
503
+ #
504
+ # @!attribute [rw] artifact_list
505
+ # A collection of artifacts.
506
+ # @return [Array<Types::Artifact>]
507
+ #
508
+ class UpdateJobOutput < Struct.new(
509
+ :success,
510
+ :warning_message,
511
+ :artifact_list)
512
+ include Aws::Structure
484
513
  end
514
+
485
515
  end
486
516
  end