aws-sdk-importexport 1.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: ee66b3af1e904643a7d746fa444144368ef458f6
4
+ data.tar.gz: 3c4b106ebaeb7ceb1b5feae755265e47ac9a7cf7
5
+ SHA512:
6
+ metadata.gz: 114949aa5dd387fd11b679c85d2023aab56d60196e1cc2ad7c79e15bad13774476906a68dae6011f22939e41d2d520190007e96c76360ae7462dea365db65f00
7
+ data.tar.gz: 108f3960649e1d18968d5a55e84f7c45fc18d24daa44a3430507a5ae2c86cf800c98d8614662cbd2371f37724bc09a7c8cc6f35ed9fb7449e72f8da4b321babe
@@ -0,0 +1,47 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'aws-sdk-core'
9
+ require 'aws-sigv2'
10
+
11
+ require_relative 'aws-sdk-importexport/types'
12
+ require_relative 'aws-sdk-importexport/client_api'
13
+ require_relative 'aws-sdk-importexport/client'
14
+ require_relative 'aws-sdk-importexport/errors'
15
+ require_relative 'aws-sdk-importexport/resource'
16
+ require_relative 'aws-sdk-importexport/customizations'
17
+
18
+ # This module provides support for AWS Import/Export. This module is available in the
19
+ # `aws-sdk-importexport` gem.
20
+ #
21
+ # # Client
22
+ #
23
+ # The {Client} class provides one method for each API operation. Operation
24
+ # methods each accept a hash of request parameters and return a response
25
+ # structure.
26
+ #
27
+ # See {Client} for more information.
28
+ #
29
+ # # Errors
30
+ #
31
+ # Errors returned from AWS Import/Export all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::ImportExport::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::ImportExport
44
+
45
+ GEM_VERSION = '1.0.0.rc1'
46
+
47
+ end
@@ -0,0 +1,452 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/response_paging.rb'
19
+ require 'aws-sdk-core/plugins/stub_responses.rb'
20
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/signature_v2.rb'
22
+ require 'aws-sdk-core/plugins/protocols/query.rb'
23
+
24
+ Aws::Plugins::GlobalConfiguration.add_identifier(:importexport)
25
+
26
+ module Aws
27
+ module ImportExport
28
+ class Client < Seahorse::Client::Base
29
+
30
+ include Aws::ClientStubs
31
+
32
+ @identifier = :importexport
33
+
34
+ set_api(ClientApi::API)
35
+
36
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
37
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
38
+ add_plugin(Aws::Plugins::Logging)
39
+ add_plugin(Aws::Plugins::ParamConverter)
40
+ add_plugin(Aws::Plugins::ParamValidator)
41
+ add_plugin(Aws::Plugins::UserAgent)
42
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
+ add_plugin(Aws::Plugins::RetryErrors)
44
+ add_plugin(Aws::Plugins::GlobalConfiguration)
45
+ add_plugin(Aws::Plugins::RegionalEndpoint)
46
+ add_plugin(Aws::Plugins::ResponsePaging)
47
+ add_plugin(Aws::Plugins::StubResponses)
48
+ add_plugin(Aws::Plugins::IdempotencyToken)
49
+ add_plugin(Aws::Plugins::SignatureV2)
50
+ add_plugin(Aws::Plugins::Protocols::Query)
51
+
52
+ # @option options [required, Aws::CredentialProvider] :credentials
53
+ # Your AWS credentials. This can be an instance of any one of the
54
+ # following classes:
55
+ #
56
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
57
+ # credentials.
58
+ #
59
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
60
+ # from an EC2 IMDS on an EC2 instance.
61
+ #
62
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
63
+ # shared file, such as `~/.aws/config`.
64
+ #
65
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
66
+ #
67
+ # When `:credentials` are not configured directly, the following
68
+ # locations will be searched for credentials:
69
+ #
70
+ # * `Aws.config[:credentials]`
71
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
72
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
73
+ # * `~/.aws/credentials`
74
+ # * `~/.aws/config`
75
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
76
+ # very aggressive. Construct and pass an instance of
77
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
78
+ # timeouts.
79
+ # @option options [required, String] :region
80
+ # The AWS region to connect to. The configured `:region` is
81
+ # used to determine the service `:endpoint`. When not passed,
82
+ # a default `:region` is search for in the following locations:
83
+ #
84
+ # * `Aws.config[:region]`
85
+ # * `ENV['AWS_REGION']`
86
+ # * `ENV['AMAZON_REGION']`
87
+ # * `ENV['AWS_DEFAULT_REGION']`
88
+ # * `~/.aws/credentials`
89
+ # * `~/.aws/config`
90
+ # @option options [String] :access_key_id
91
+ # @option options [Boolean] :convert_params (true)
92
+ # When `true`, an attempt is made to coerce request parameters into
93
+ # the required types.
94
+ # @option options [String] :endpoint
95
+ # The client endpoint is normally constructed from the `:region`
96
+ # option. You should only configure an `:endpoint` when connecting
97
+ # to test endpoints. This should be avalid HTTP(S) URI.
98
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
99
+ # The log formatter.
100
+ # @option options [Symbol] :log_level (:info)
101
+ # The log level to send messages to the `:logger` at.
102
+ # @option options [Logger] :logger
103
+ # The Logger instance to send log messages to. If this option
104
+ # is not set, logging will be disabled.
105
+ # @option options [String] :profile ("default")
106
+ # Used when loading credentials from the shared credentials file
107
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
108
+ # @option options [Integer] :retry_limit (3)
109
+ # The maximum number of times to retry failed requests. Only
110
+ # ~ 500 level server errors and certain ~ 400 level client errors
111
+ # are retried. Generally, these are throttling errors, data
112
+ # checksum errors, networking errors, timeout errors and auth
113
+ # errors from expired credentials.
114
+ # @option options [String] :secret_access_key
115
+ # @option options [String] :session_token
116
+ # @option options [Boolean] :stub_responses (false)
117
+ # Causes the client to return stubbed responses. By default
118
+ # fake responses are generated and returned. You can specify
119
+ # the response data to return or errors to raise by calling
120
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
121
+ #
122
+ # ** Please note ** When response stubbing is enabled, no HTTP
123
+ # requests are made, and retries are disabled.
124
+ # @option options [Boolean] :validate_params (true)
125
+ # When `true`, request parameters are validated before
126
+ # sending the request.
127
+ def initialize(*args)
128
+ super
129
+ end
130
+
131
+ # @!group API Operations
132
+
133
+ # This operation cancels a specified job. Only the job owner can cancel
134
+ # it. The operation fails if the job has already started or is complete.
135
+ # @option params [required, String] :job_id
136
+ # A unique identifier which refers to a particular job.
137
+ # @option params [String] :api_version
138
+ # Specifies the version of the client tool.
139
+ # @return [Types::CancelJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
140
+ #
141
+ # * {Types::CancelJobOutput#success #Success} => Boolean
142
+ #
143
+ # @example Request syntax with placeholder values
144
+ # resp = client.cancel_job({
145
+ # job_id: "JobId", # required
146
+ # api_version: "APIVersion",
147
+ # })
148
+ #
149
+ # @example Response structure
150
+ # resp.success #=> Boolean
151
+ # @overload cancel_job(params = {})
152
+ # @param [Hash] params ({})
153
+ def cancel_job(params = {}, options = {})
154
+ req = build_request(:cancel_job, params)
155
+ req.send_request(options)
156
+ end
157
+
158
+ # This operation initiates the process of scheduling an upload or
159
+ # download of your data. You include in the request a manifest that
160
+ # describes the data transfer specifics. The response to the request
161
+ # includes a job ID, which you can use in other operations, a signature
162
+ # that you use to identify your storage device, and the address where
163
+ # you should ship your storage device.
164
+ # @option params [required, String] :job_type
165
+ # Specifies whether the job to initiate is an import or export job.
166
+ # @option params [required, String] :manifest
167
+ # The UTF-8 encoded text of the manifest file.
168
+ # @option params [String] :manifest_addendum
169
+ # For internal use only.
170
+ # @option params [required, Boolean] :validate_only
171
+ # Validate the manifest and parameter values in the request but do not
172
+ # actually create a job.
173
+ # @option params [String] :api_version
174
+ # Specifies the version of the client tool.
175
+ # @return [Types::CreateJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
176
+ #
177
+ # * {Types::CreateJobOutput#job_id #JobId} => String
178
+ # * {Types::CreateJobOutput#job_type #JobType} => String
179
+ # * {Types::CreateJobOutput#signature #Signature} => String
180
+ # * {Types::CreateJobOutput#signature_file_contents #SignatureFileContents} => String
181
+ # * {Types::CreateJobOutput#warning_message #WarningMessage} => String
182
+ # * {Types::CreateJobOutput#artifact_list #ArtifactList} => Array&lt;Types::Artifact&gt;
183
+ #
184
+ # @example Request syntax with placeholder values
185
+ # resp = client.create_job({
186
+ # job_type: "Import", # required, accepts Import, Export
187
+ # manifest: "Manifest", # required
188
+ # manifest_addendum: "ManifestAddendum",
189
+ # validate_only: false, # required
190
+ # api_version: "APIVersion",
191
+ # })
192
+ #
193
+ # @example Response structure
194
+ # resp.job_id #=> String
195
+ # resp.job_type #=> String, one of "Import", "Export"
196
+ # resp.signature #=> String
197
+ # resp.signature_file_contents #=> String
198
+ # resp.warning_message #=> String
199
+ # resp.artifact_list #=> Array
200
+ # resp.artifact_list[0].description #=> String
201
+ # resp.artifact_list[0].url #=> String
202
+ # @overload create_job(params = {})
203
+ # @param [Hash] params ({})
204
+ def create_job(params = {}, options = {})
205
+ req = build_request(:create_job, params)
206
+ req.send_request(options)
207
+ end
208
+
209
+ # This operation generates a pre-paid UPS shipping label that you will
210
+ # use to ship your device to AWS for processing.
211
+ # @option params [required, Array<String>] :job_ids
212
+ # @option params [String] :name
213
+ # Specifies the name of the person responsible for shipping this
214
+ # package.
215
+ # @option params [String] :company
216
+ # Specifies the name of the company that will ship this package.
217
+ # @option params [String] :phone_number
218
+ # Specifies the phone number of the person responsible for shipping this
219
+ # package.
220
+ # @option params [String] :country
221
+ # Specifies the name of your country for the return address.
222
+ # @option params [String] :state_or_province
223
+ # Specifies the name of your state or your province for the return
224
+ # address.
225
+ # @option params [String] :city
226
+ # Specifies the name of your city for the return address.
227
+ # @option params [String] :postal_code
228
+ # Specifies the postal code for the return address.
229
+ # @option params [String] :street1
230
+ # Specifies the first part of the street address for the return address,
231
+ # for example 1234 Main Street.
232
+ # @option params [String] :street2
233
+ # Specifies the optional second part of the street address for the
234
+ # return address, for example Suite 100.
235
+ # @option params [String] :street3
236
+ # Specifies the optional third part of the street address for the return
237
+ # address, for example c/o Jane Doe.
238
+ # @option params [String] :api_version
239
+ # Specifies the version of the client tool.
240
+ # @return [Types::GetShippingLabelOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
241
+ #
242
+ # * {Types::GetShippingLabelOutput#shipping_label_url #ShippingLabelURL} => String
243
+ # * {Types::GetShippingLabelOutput#warning #Warning} => String
244
+ #
245
+ # @example Request syntax with placeholder values
246
+ # resp = client.get_shipping_label({
247
+ # job_ids: ["GenericString"], # required
248
+ # name: "name",
249
+ # company: "company",
250
+ # phone_number: "phoneNumber",
251
+ # country: "country",
252
+ # state_or_province: "stateOrProvince",
253
+ # city: "city",
254
+ # postal_code: "postalCode",
255
+ # street1: "street1",
256
+ # street2: "street2",
257
+ # street3: "street3",
258
+ # api_version: "APIVersion",
259
+ # })
260
+ #
261
+ # @example Response structure
262
+ # resp.shipping_label_url #=> String
263
+ # resp.warning #=> String
264
+ # @overload get_shipping_label(params = {})
265
+ # @param [Hash] params ({})
266
+ def get_shipping_label(params = {}, options = {})
267
+ req = build_request(:get_shipping_label, params)
268
+ req.send_request(options)
269
+ end
270
+
271
+ # This operation returns information about a job, including where the
272
+ # job is in the processing pipeline, the status of the results, and the
273
+ # signature value associated with the job. You can only return
274
+ # information about jobs you own.
275
+ # @option params [required, String] :job_id
276
+ # A unique identifier which refers to a particular job.
277
+ # @option params [String] :api_version
278
+ # Specifies the version of the client tool.
279
+ # @return [Types::GetStatusOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
280
+ #
281
+ # * {Types::GetStatusOutput#job_id #JobId} => String
282
+ # * {Types::GetStatusOutput#job_type #JobType} => String
283
+ # * {Types::GetStatusOutput#location_code #LocationCode} => String
284
+ # * {Types::GetStatusOutput#location_message #LocationMessage} => String
285
+ # * {Types::GetStatusOutput#progress_code #ProgressCode} => String
286
+ # * {Types::GetStatusOutput#progress_message #ProgressMessage} => String
287
+ # * {Types::GetStatusOutput#carrier #Carrier} => String
288
+ # * {Types::GetStatusOutput#tracking_number #TrackingNumber} => String
289
+ # * {Types::GetStatusOutput#log_bucket #LogBucket} => String
290
+ # * {Types::GetStatusOutput#log_key #LogKey} => String
291
+ # * {Types::GetStatusOutput#error_count #ErrorCount} => Integer
292
+ # * {Types::GetStatusOutput#signature #Signature} => String
293
+ # * {Types::GetStatusOutput#signature_file_contents #SignatureFileContents} => String
294
+ # * {Types::GetStatusOutput#current_manifest #CurrentManifest} => String
295
+ # * {Types::GetStatusOutput#creation_date #CreationDate} => Time
296
+ # * {Types::GetStatusOutput#artifact_list #ArtifactList} => Array&lt;Types::Artifact&gt;
297
+ #
298
+ # @example Request syntax with placeholder values
299
+ # resp = client.get_status({
300
+ # job_id: "JobId", # required
301
+ # api_version: "APIVersion",
302
+ # })
303
+ #
304
+ # @example Response structure
305
+ # resp.job_id #=> String
306
+ # resp.job_type #=> String, one of "Import", "Export"
307
+ # resp.location_code #=> String
308
+ # resp.location_message #=> String
309
+ # resp.progress_code #=> String
310
+ # resp.progress_message #=> String
311
+ # resp.carrier #=> String
312
+ # resp.tracking_number #=> String
313
+ # resp.log_bucket #=> String
314
+ # resp.log_key #=> String
315
+ # resp.error_count #=> Integer
316
+ # resp.signature #=> String
317
+ # resp.signature_file_contents #=> String
318
+ # resp.current_manifest #=> String
319
+ # resp.creation_date #=> Time
320
+ # resp.artifact_list #=> Array
321
+ # resp.artifact_list[0].description #=> String
322
+ # resp.artifact_list[0].url #=> String
323
+ # @overload get_status(params = {})
324
+ # @param [Hash] params ({})
325
+ def get_status(params = {}, options = {})
326
+ req = build_request(:get_status, params)
327
+ req.send_request(options)
328
+ end
329
+
330
+ # This operation returns the jobs associated with the requester. AWS
331
+ # Import/Export lists the jobs in reverse chronological order based on
332
+ # the date of creation. For example if Job Test1 was created 2009Dec30
333
+ # and Test2 was created 2010Feb05, the ListJobs operation would return
334
+ # Test2 followed by Test1.
335
+ # @option params [Integer] :max_jobs
336
+ # Sets the maximum number of jobs returned in the response. If there are
337
+ # additional jobs that were not returned because MaxJobs was exceeded,
338
+ # the response contains &lt;IsTruncated&gt;true&lt;/IsTruncated&gt;. To
339
+ # return the additional jobs, see Marker.
340
+ # @option params [String] :marker
341
+ # Specifies the JOBID to start after when listing the jobs created with
342
+ # your account. AWS Import/Export lists your jobs in reverse
343
+ # chronological order. See MaxJobs.
344
+ # @option params [String] :api_version
345
+ # Specifies the version of the client tool.
346
+ # @return [Types::ListJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
347
+ #
348
+ # * {Types::ListJobsOutput#jobs #Jobs} => Array&lt;Types::Job&gt;
349
+ # * {Types::ListJobsOutput#is_truncated #IsTruncated} => Boolean
350
+ #
351
+ # @example Request syntax with placeholder values
352
+ # resp = client.list_jobs({
353
+ # max_jobs: 1,
354
+ # marker: "Marker",
355
+ # api_version: "APIVersion",
356
+ # })
357
+ #
358
+ # @example Response structure
359
+ # resp.jobs #=> Array
360
+ # resp.jobs[0].job_id #=> String
361
+ # resp.jobs[0].creation_date #=> Time
362
+ # resp.jobs[0].is_canceled #=> Boolean
363
+ # resp.jobs[0].job_type #=> String, one of "Import", "Export"
364
+ # resp.is_truncated #=> Boolean
365
+ # @overload list_jobs(params = {})
366
+ # @param [Hash] params ({})
367
+ def list_jobs(params = {}, options = {})
368
+ req = build_request(:list_jobs, params)
369
+ req.send_request(options)
370
+ end
371
+
372
+ # You use this operation to change the parameters specified in the
373
+ # original manifest file by supplying a new manifest file. The manifest
374
+ # file attached to this request replaces the original manifest file. You
375
+ # can only use the operation after a CreateJob request but before the
376
+ # data transfer starts and you can only use it on jobs you own.
377
+ # @option params [required, String] :job_id
378
+ # A unique identifier which refers to a particular job.
379
+ # @option params [required, String] :manifest
380
+ # The UTF-8 encoded text of the manifest file.
381
+ # @option params [required, String] :job_type
382
+ # Specifies whether the job to initiate is an import or export job.
383
+ # @option params [required, Boolean] :validate_only
384
+ # Validate the manifest and parameter values in the request but do not
385
+ # actually create a job.
386
+ # @option params [String] :api_version
387
+ # Specifies the version of the client tool.
388
+ # @return [Types::UpdateJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
389
+ #
390
+ # * {Types::UpdateJobOutput#success #Success} => Boolean
391
+ # * {Types::UpdateJobOutput#warning_message #WarningMessage} => String
392
+ # * {Types::UpdateJobOutput#artifact_list #ArtifactList} => Array&lt;Types::Artifact&gt;
393
+ #
394
+ # @example Request syntax with placeholder values
395
+ # resp = client.update_job({
396
+ # job_id: "JobId", # required
397
+ # manifest: "Manifest", # required
398
+ # job_type: "Import", # required, accepts Import, Export
399
+ # validate_only: false, # required
400
+ # api_version: "APIVersion",
401
+ # })
402
+ #
403
+ # @example Response structure
404
+ # resp.success #=> Boolean
405
+ # resp.warning_message #=> String
406
+ # resp.artifact_list #=> Array
407
+ # resp.artifact_list[0].description #=> String
408
+ # resp.artifact_list[0].url #=> String
409
+ # @overload update_job(params = {})
410
+ # @param [Hash] params ({})
411
+ def update_job(params = {}, options = {})
412
+ req = build_request(:update_job, params)
413
+ req.send_request(options)
414
+ end
415
+
416
+ # @!endgroup
417
+
418
+ # @param params ({})
419
+ # @api private
420
+ def build_request(operation_name, params = {})
421
+ handlers = @handlers.for(operation_name)
422
+ context = Seahorse::Client::RequestContext.new(
423
+ operation_name: operation_name,
424
+ operation: config.api.operation(operation_name),
425
+ client: self,
426
+ params: params,
427
+ config: config)
428
+ context[:gem_name] = 'aws-sdk-importexport'
429
+ context[:gem_version] = '1.0.0.rc1'
430
+ Seahorse::Client::Request.new(handlers, context)
431
+ end
432
+
433
+ # @api private
434
+ # @deprecated
435
+ def waiter_names
436
+ []
437
+ end
438
+
439
+ class << self
440
+
441
+ # @api private
442
+ attr_reader :identifier
443
+
444
+ # @api private
445
+ def errors_module
446
+ Errors
447
+ end
448
+
449
+ end
450
+ end
451
+ end
452
+ end