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 +4 -4
- data/lib/aws-sdk-importexport.rb +2 -2
- data/lib/aws-sdk-importexport/client.rb +473 -406
- data/lib/aws-sdk-importexport/client_api.rb +278 -390
- data/lib/aws-sdk-importexport/errors.rb +4 -13
- data/lib/aws-sdk-importexport/resource.rb +12 -14
- data/lib/aws-sdk-importexport/types.rb +493 -463
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8f97fde947d0a2eaca6401869244eac401c99955
|
|
4
|
+
data.tar.gz: bbe81e8e409b18be332084e70c5e1d756ed88c65
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a181d0b58d98f82c6f66befa2264dcca7450ea28c21a8f0cbb444b6c0045625b6c11f72ed35463340e6db0b5c60453cbf8ee39c936552038aa985b1778c03aaf
|
|
7
|
+
data.tar.gz: 4898361007fe3ed3d181f4686a22120fc64247c6680861b789bfa053fc6da0df488c523067150a6480b6172d8e5c354d2c8a61929e26bde09196579706e63f80
|
data/lib/aws-sdk-importexport.rb
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
|
2
2
|
#
|
|
3
|
-
# This file is generated. See the contributing for
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
5
|
#
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
|
@@ -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.
|
|
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
|
|
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
|
-
|
|
28
|
-
class Client < Seahorse::Client::Base
|
|
27
|
+
module Aws::ImportExport
|
|
28
|
+
class Client < Seahorse::Client::Base
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
include Aws::ClientStubs
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
@identifier = :importexport
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
set_api(ClientApi::API)
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
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
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
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
|
-
|
|
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
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
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
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
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<Types::Artifact>
|
|
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
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
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
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
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<Types::Artifact>
|
|
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
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
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 <IsTruncated>true</IsTruncated>. 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<Types::Job>
|
|
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
|
-
|
|
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<Types::Artifact>
|
|
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
|
-
|
|
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
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
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
|
-
|
|
501
|
+
# @api private
|
|
502
|
+
# @deprecated
|
|
503
|
+
def waiter_names
|
|
504
|
+
[]
|
|
505
|
+
end
|
|
440
506
|
|
|
441
|
-
|
|
442
|
-
attr_reader :identifier
|
|
507
|
+
class << self
|
|
443
508
|
|
|
444
|
-
|
|
445
|
-
|
|
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
|