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