aws-sdk-migrationhub 1.0.0.rc1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-migrationhub.rb +47 -0
- data/lib/aws-sdk-migrationhub/client.rb +908 -0
- data/lib/aws-sdk-migrationhub/client_api.rb +511 -0
- data/lib/aws-sdk-migrationhub/customizations.rb +0 -0
- data/lib/aws-sdk-migrationhub/errors.rb +14 -0
- data/lib/aws-sdk-migrationhub/resource.rb +23 -0
- data/lib/aws-sdk-migrationhub/types.rb +905 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 615612132e0c525e2fdd3b0a22b89590512747f5
|
4
|
+
data.tar.gz: 7e47963880c84d854e25677798cbb2f1599ad600
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5d1c2f238d3791d1fef218369927affed0335f57c0df5a97230734d2e0cb6f2c224ada9b26b229c435636a6f1909ee0374380402b7905cebb1428dc6c756072f
|
7
|
+
data.tar.gz: 35faefc1183542f48a66aa5c5dd18104022a282dc3baa4734a4c2799b18c47021db2841ad948946ec028252450947f8388d3e6ff55220a15ab26e9df492dbeb7
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
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-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-migrationhub/types'
|
12
|
+
require_relative 'aws-sdk-migrationhub/client_api'
|
13
|
+
require_relative 'aws-sdk-migrationhub/client'
|
14
|
+
require_relative 'aws-sdk-migrationhub/errors'
|
15
|
+
require_relative 'aws-sdk-migrationhub/resource'
|
16
|
+
require_relative 'aws-sdk-migrationhub/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS Migration Hub. This module is available in the
|
19
|
+
# `aws-sdk-migrationhub` 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 Migration Hub all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::MigrationHub::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::MigrationHub
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc1'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,908 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
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/jsonvalue_converter.rb'
|
22
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
23
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
24
|
+
|
25
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:migrationhub)
|
26
|
+
|
27
|
+
module Aws::MigrationHub
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :migrationhub
|
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::JsonvalueConverter)
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
51
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
52
|
+
|
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] :simple_json (false)
|
130
|
+
# Disables request parameter conversion, validation, and formatting.
|
131
|
+
# Also disable response data type conversions. This option is useful
|
132
|
+
# when you want to ensure the highest level of performance by
|
133
|
+
# avoiding overhead of walking request parameters and response data
|
134
|
+
# structures.
|
135
|
+
#
|
136
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
137
|
+
# be formatted exactly as the DynamoDB API expects.
|
138
|
+
#
|
139
|
+
# @option options [Boolean] :stub_responses (false)
|
140
|
+
# Causes the client to return stubbed responses. By default
|
141
|
+
# fake responses are generated and returned. You can specify
|
142
|
+
# the response data to return or errors to raise by calling
|
143
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
144
|
+
#
|
145
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
146
|
+
# requests are made, and retries are disabled.
|
147
|
+
#
|
148
|
+
# @option options [Boolean] :validate_params (true)
|
149
|
+
# When `true`, request parameters are validated before
|
150
|
+
# sending the request.
|
151
|
+
#
|
152
|
+
def initialize(*args)
|
153
|
+
super
|
154
|
+
end
|
155
|
+
|
156
|
+
# @!group API Operations
|
157
|
+
|
158
|
+
# Associates a created artifact of an AWS cloud resource, the target
|
159
|
+
# receiving the migration, with the migration task performed by a
|
160
|
+
# migration tool. This API has the following traits:
|
161
|
+
#
|
162
|
+
# * Migration tools can call the `AssociateCreatedArtifact` operation to
|
163
|
+
# indicate which AWS artifact is associated with a migration task.
|
164
|
+
#
|
165
|
+
# * The created artifact name must be provided in ARN (Amazon Resource
|
166
|
+
# Name) format which will contain information about type and region;
|
167
|
+
# for example:
|
168
|
+
# `arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b`.
|
169
|
+
#
|
170
|
+
# * Examples of the AWS resource behind the created artifact are,
|
171
|
+
# AMI's, EC2 instance, or DMS endpoint, etc.
|
172
|
+
#
|
173
|
+
# @option params [required, String] :progress_update_stream
|
174
|
+
# The name of the ProgressUpdateStream.
|
175
|
+
#
|
176
|
+
# @option params [required, String] :migration_task_name
|
177
|
+
# Unique identifier that references the migration task.
|
178
|
+
#
|
179
|
+
# @option params [required, Types::CreatedArtifact] :created_artifact
|
180
|
+
# An ARN of the AWS resource related to the migration (e.g., AMI, EC2
|
181
|
+
# instance, RDS instance, etc.)
|
182
|
+
#
|
183
|
+
# @option params [Boolean] :dry_run
|
184
|
+
# Optional boolean flag to indicate whether any effect should take
|
185
|
+
# place. Used to test if the caller has permission to make the call.
|
186
|
+
#
|
187
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
188
|
+
#
|
189
|
+
# @example Request syntax with placeholder values
|
190
|
+
#
|
191
|
+
# resp = client.associate_created_artifact({
|
192
|
+
# progress_update_stream: "ProgressUpdateStream", # required
|
193
|
+
# migration_task_name: "MigrationTaskName", # required
|
194
|
+
# created_artifact: { # required
|
195
|
+
# name: "CreatedArtifactName", # required
|
196
|
+
# description: "CreatedArtifactDescription",
|
197
|
+
# },
|
198
|
+
# dry_run: false,
|
199
|
+
# })
|
200
|
+
#
|
201
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/AssociateCreatedArtifact AWS API Documentation
|
202
|
+
#
|
203
|
+
# @overload associate_created_artifact(params = {})
|
204
|
+
# @param [Hash] params ({})
|
205
|
+
def associate_created_artifact(params = {}, options = {})
|
206
|
+
req = build_request(:associate_created_artifact, params)
|
207
|
+
req.send_request(options)
|
208
|
+
end
|
209
|
+
|
210
|
+
# Associates a discovered resource ID from Application Discovery Service
|
211
|
+
# (ADS) with a migration task.
|
212
|
+
#
|
213
|
+
# @option params [required, String] :progress_update_stream
|
214
|
+
# The name of the ProgressUpdateStream.
|
215
|
+
#
|
216
|
+
# @option params [required, String] :migration_task_name
|
217
|
+
# The identifier given to the MigrationTask.
|
218
|
+
#
|
219
|
+
# @option params [required, Types::DiscoveredResource] :discovered_resource
|
220
|
+
# Object representing a Resource.
|
221
|
+
#
|
222
|
+
# @option params [Boolean] :dry_run
|
223
|
+
# Optional boolean flag to indicate whether any effect should take
|
224
|
+
# place. Used to test if the caller has permission to make the call.
|
225
|
+
#
|
226
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
227
|
+
#
|
228
|
+
# @example Request syntax with placeholder values
|
229
|
+
#
|
230
|
+
# resp = client.associate_discovered_resource({
|
231
|
+
# progress_update_stream: "ProgressUpdateStream", # required
|
232
|
+
# migration_task_name: "MigrationTaskName", # required
|
233
|
+
# discovered_resource: { # required
|
234
|
+
# configuration_id: "ConfigurationId", # required
|
235
|
+
# description: "DiscoveredResourceDescription",
|
236
|
+
# },
|
237
|
+
# dry_run: false,
|
238
|
+
# })
|
239
|
+
#
|
240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/AssociateDiscoveredResource AWS API Documentation
|
241
|
+
#
|
242
|
+
# @overload associate_discovered_resource(params = {})
|
243
|
+
# @param [Hash] params ({})
|
244
|
+
def associate_discovered_resource(params = {}, options = {})
|
245
|
+
req = build_request(:associate_discovered_resource, params)
|
246
|
+
req.send_request(options)
|
247
|
+
end
|
248
|
+
|
249
|
+
# Creates a progress update stream which is an AWS resource used for
|
250
|
+
# access control as well as a namespace for migration task names that is
|
251
|
+
# implicitly linked to your AWS account. It must uniquely identify the
|
252
|
+
# migration tool as it is used for all updates made by the tool;
|
253
|
+
# however, it does not need to be unique for each AWS account because it
|
254
|
+
# is scoped to the AWS account.
|
255
|
+
#
|
256
|
+
# @option params [required, String] :progress_update_stream_name
|
257
|
+
# The name of the ProgressUpdateStream.
|
258
|
+
#
|
259
|
+
# @option params [Boolean] :dry_run
|
260
|
+
# Optional boolean flag to indicate whether any effect should take
|
261
|
+
# place. Used to test if the caller has permission to make the call.
|
262
|
+
#
|
263
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
264
|
+
#
|
265
|
+
# @example Request syntax with placeholder values
|
266
|
+
#
|
267
|
+
# resp = client.create_progress_update_stream({
|
268
|
+
# progress_update_stream_name: "ProgressUpdateStream", # required
|
269
|
+
# dry_run: false,
|
270
|
+
# })
|
271
|
+
#
|
272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/CreateProgressUpdateStream AWS API Documentation
|
273
|
+
#
|
274
|
+
# @overload create_progress_update_stream(params = {})
|
275
|
+
# @param [Hash] params ({})
|
276
|
+
def create_progress_update_stream(params = {}, options = {})
|
277
|
+
req = build_request(:create_progress_update_stream, params)
|
278
|
+
req.send_request(options)
|
279
|
+
end
|
280
|
+
|
281
|
+
# Deletes a progress update stream, including all of its tasks, which
|
282
|
+
# was previously created as an AWS resource used for access control.
|
283
|
+
# This API has the following traits:
|
284
|
+
#
|
285
|
+
# * The only parameter needed for `DeleteProgressUpdateStream` is the
|
286
|
+
# stream name (same as a `CreateProgressUpdateStream` call).
|
287
|
+
#
|
288
|
+
# * The call will return, and a background process will asynchronously
|
289
|
+
# be doing the actual delete of the stream and all of its resources
|
290
|
+
# (tasks, associated resources, resource attributes, created
|
291
|
+
# artifacts).
|
292
|
+
#
|
293
|
+
# * If the stream takes time to be deleted, it might still show up on a
|
294
|
+
# `ListProgressUpdateStreams` call.
|
295
|
+
#
|
296
|
+
# * `CreateProgressUpdateStream`, `ImportMigrationTask`,
|
297
|
+
# `NotifyMigrationTaskState`, and all Associate\[*\] APIs realted to
|
298
|
+
# the tasks belonging to the stream will throw
|
299
|
+
# "InvalidInputException" if the stream of the same name is in the
|
300
|
+
# process of being deleted.
|
301
|
+
#
|
302
|
+
# * Once the stream and all of its resources are deleted,
|
303
|
+
# `CreateProgressUpdateStream` for a stream of the same name will
|
304
|
+
# succeed, and that stream will be an entirely new logical resource
|
305
|
+
# (without any resources associated with the old stream).
|
306
|
+
#
|
307
|
+
# @option params [required, String] :progress_update_stream_name
|
308
|
+
# The name of the ProgressUpdateStream.
|
309
|
+
#
|
310
|
+
# @option params [Boolean] :dry_run
|
311
|
+
# Optional boolean flag to indicate whether any effect should take
|
312
|
+
# place. Used to test if the caller has permission to make the call.
|
313
|
+
#
|
314
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
315
|
+
#
|
316
|
+
# @example Request syntax with placeholder values
|
317
|
+
#
|
318
|
+
# resp = client.delete_progress_update_stream({
|
319
|
+
# progress_update_stream_name: "ProgressUpdateStream", # required
|
320
|
+
# dry_run: false,
|
321
|
+
# })
|
322
|
+
#
|
323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/DeleteProgressUpdateStream AWS API Documentation
|
324
|
+
#
|
325
|
+
# @overload delete_progress_update_stream(params = {})
|
326
|
+
# @param [Hash] params ({})
|
327
|
+
def delete_progress_update_stream(params = {}, options = {})
|
328
|
+
req = build_request(:delete_progress_update_stream, params)
|
329
|
+
req.send_request(options)
|
330
|
+
end
|
331
|
+
|
332
|
+
# Gets the migration status of an application.
|
333
|
+
#
|
334
|
+
# @option params [required, String] :application_id
|
335
|
+
# The configurationId in ADS that uniquely identifies the grouped
|
336
|
+
# application.
|
337
|
+
#
|
338
|
+
# @return [Types::DescribeApplicationStateResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
339
|
+
#
|
340
|
+
# * {Types::DescribeApplicationStateResult#application_status #application_status} => String
|
341
|
+
# * {Types::DescribeApplicationStateResult#last_updated_time #last_updated_time} => Time
|
342
|
+
#
|
343
|
+
# @example Request syntax with placeholder values
|
344
|
+
#
|
345
|
+
# resp = client.describe_application_state({
|
346
|
+
# application_id: "ApplicationId", # required
|
347
|
+
# })
|
348
|
+
#
|
349
|
+
# @example Response structure
|
350
|
+
#
|
351
|
+
# resp.application_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
|
352
|
+
# resp.last_updated_time #=> Time
|
353
|
+
#
|
354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/DescribeApplicationState AWS API Documentation
|
355
|
+
#
|
356
|
+
# @overload describe_application_state(params = {})
|
357
|
+
# @param [Hash] params ({})
|
358
|
+
def describe_application_state(params = {}, options = {})
|
359
|
+
req = build_request(:describe_application_state, params)
|
360
|
+
req.send_request(options)
|
361
|
+
end
|
362
|
+
|
363
|
+
# Retrieves a list of all attributes associated with a specific
|
364
|
+
# migration task.
|
365
|
+
#
|
366
|
+
# @option params [required, String] :progress_update_stream
|
367
|
+
# The name of the ProgressUpdateStream.
|
368
|
+
#
|
369
|
+
# @option params [required, String] :migration_task_name
|
370
|
+
# The identifier given to the MigrationTask.
|
371
|
+
#
|
372
|
+
# @return [Types::DescribeMigrationTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
373
|
+
#
|
374
|
+
# * {Types::DescribeMigrationTaskResult#migration_task #migration_task} => Types::MigrationTask
|
375
|
+
#
|
376
|
+
# @example Request syntax with placeholder values
|
377
|
+
#
|
378
|
+
# resp = client.describe_migration_task({
|
379
|
+
# progress_update_stream: "ProgressUpdateStream", # required
|
380
|
+
# migration_task_name: "MigrationTaskName", # required
|
381
|
+
# })
|
382
|
+
#
|
383
|
+
# @example Response structure
|
384
|
+
#
|
385
|
+
# resp.migration_task.progress_update_stream #=> String
|
386
|
+
# resp.migration_task.migration_task_name #=> String
|
387
|
+
# resp.migration_task.task.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FAILED", "COMPLETED"
|
388
|
+
# resp.migration_task.task.status_detail #=> String
|
389
|
+
# resp.migration_task.task.progress_percent #=> Integer
|
390
|
+
# resp.migration_task.update_date_time #=> Time
|
391
|
+
# resp.migration_task.resource_attribute_list #=> Array
|
392
|
+
# resp.migration_task.resource_attribute_list[0].type #=> String, one of "IPV4_ADDRESS", "IPV6_ADDRESS", "MAC_ADDRESS", "FQDN", "VM_MANAGER_ID", "VM_MANAGED_OBJECT_REFERENCE", "VM_NAME", "VM_PATH", "BIOS_ID", "MOTHERBOARD_SERIAL_NUMBER", "LABEL"
|
393
|
+
# resp.migration_task.resource_attribute_list[0].value #=> String
|
394
|
+
#
|
395
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/DescribeMigrationTask AWS API Documentation
|
396
|
+
#
|
397
|
+
# @overload describe_migration_task(params = {})
|
398
|
+
# @param [Hash] params ({})
|
399
|
+
def describe_migration_task(params = {}, options = {})
|
400
|
+
req = build_request(:describe_migration_task, params)
|
401
|
+
req.send_request(options)
|
402
|
+
end
|
403
|
+
|
404
|
+
# Disassociates a created artifact of an AWS resource with a migration
|
405
|
+
# task performed by a migration tool that was previously associated.
|
406
|
+
# This API has the following traits:
|
407
|
+
#
|
408
|
+
# * A migration user can call the `DisassociateCreatedArtifacts`
|
409
|
+
# operation to disassociate a created AWS Artifact from a migration
|
410
|
+
# task.
|
411
|
+
#
|
412
|
+
# * The created artifact name must be provided in ARN (Amazon Resource
|
413
|
+
# Name) format which will contain information about type and region;
|
414
|
+
# for example:
|
415
|
+
# `arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b`.
|
416
|
+
#
|
417
|
+
# * Examples of the AWS resource behind the created artifact are,
|
418
|
+
# AMI's, EC2 instance, or RDS instance, etc.
|
419
|
+
#
|
420
|
+
# @option params [required, String] :progress_update_stream
|
421
|
+
# The name of the ProgressUpdateStream.
|
422
|
+
#
|
423
|
+
# @option params [required, String] :migration_task_name
|
424
|
+
# Unique identifier that references the migration task to be
|
425
|
+
# disassociated with the artifact.
|
426
|
+
#
|
427
|
+
# @option params [required, String] :created_artifact_name
|
428
|
+
# An ARN of the AWS resource related to the migration (e.g., AMI, EC2
|
429
|
+
# instance, RDS instance, etc.)
|
430
|
+
#
|
431
|
+
# @option params [Boolean] :dry_run
|
432
|
+
# Optional boolean flag to indicate whether any effect should take
|
433
|
+
# place. Used to test if the caller has permission to make the call.
|
434
|
+
#
|
435
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
436
|
+
#
|
437
|
+
# @example Request syntax with placeholder values
|
438
|
+
#
|
439
|
+
# resp = client.disassociate_created_artifact({
|
440
|
+
# progress_update_stream: "ProgressUpdateStream", # required
|
441
|
+
# migration_task_name: "MigrationTaskName", # required
|
442
|
+
# created_artifact_name: "CreatedArtifactName", # required
|
443
|
+
# dry_run: false,
|
444
|
+
# })
|
445
|
+
#
|
446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/DisassociateCreatedArtifact AWS API Documentation
|
447
|
+
#
|
448
|
+
# @overload disassociate_created_artifact(params = {})
|
449
|
+
# @param [Hash] params ({})
|
450
|
+
def disassociate_created_artifact(params = {}, options = {})
|
451
|
+
req = build_request(:disassociate_created_artifact, params)
|
452
|
+
req.send_request(options)
|
453
|
+
end
|
454
|
+
|
455
|
+
# Disassociate an Application Discovery Service (ADS) discovered
|
456
|
+
# resource from a migration task.
|
457
|
+
#
|
458
|
+
# @option params [required, String] :progress_update_stream
|
459
|
+
# The name of the ProgressUpdateStream.
|
460
|
+
#
|
461
|
+
# @option params [required, String] :migration_task_name
|
462
|
+
# The identifier given to the MigrationTask.
|
463
|
+
#
|
464
|
+
# @option params [required, String] :configuration_id
|
465
|
+
# ConfigurationId of the ADS resource to be disassociated.
|
466
|
+
#
|
467
|
+
# @option params [Boolean] :dry_run
|
468
|
+
# Optional boolean flag to indicate whether any effect should take
|
469
|
+
# place. Used to test if the caller has permission to make the call.
|
470
|
+
#
|
471
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
472
|
+
#
|
473
|
+
# @example Request syntax with placeholder values
|
474
|
+
#
|
475
|
+
# resp = client.disassociate_discovered_resource({
|
476
|
+
# progress_update_stream: "ProgressUpdateStream", # required
|
477
|
+
# migration_task_name: "MigrationTaskName", # required
|
478
|
+
# configuration_id: "ConfigurationId", # required
|
479
|
+
# dry_run: false,
|
480
|
+
# })
|
481
|
+
#
|
482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/DisassociateDiscoveredResource AWS API Documentation
|
483
|
+
#
|
484
|
+
# @overload disassociate_discovered_resource(params = {})
|
485
|
+
# @param [Hash] params ({})
|
486
|
+
def disassociate_discovered_resource(params = {}, options = {})
|
487
|
+
req = build_request(:disassociate_discovered_resource, params)
|
488
|
+
req.send_request(options)
|
489
|
+
end
|
490
|
+
|
491
|
+
# Registers a new migration task which represents a server, database,
|
492
|
+
# etc., being migrated to AWS by a migration tool.
|
493
|
+
#
|
494
|
+
# This API is a prerequisite to calling the `NotifyMigrationTaskState`
|
495
|
+
# API as the migration tool must first register the migration task with
|
496
|
+
# Migration Hub.
|
497
|
+
#
|
498
|
+
# @option params [required, String] :progress_update_stream
|
499
|
+
# The name of the ProgressUpdateStream.
|
500
|
+
#
|
501
|
+
# @option params [required, String] :migration_task_name
|
502
|
+
# Unique identifier that references the migration task.
|
503
|
+
#
|
504
|
+
# @option params [Boolean] :dry_run
|
505
|
+
# Optional boolean flag to indicate whether any effect should take
|
506
|
+
# place. Used to test if the caller has permission to make the call.
|
507
|
+
#
|
508
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
509
|
+
#
|
510
|
+
# @example Request syntax with placeholder values
|
511
|
+
#
|
512
|
+
# resp = client.import_migration_task({
|
513
|
+
# progress_update_stream: "ProgressUpdateStream", # required
|
514
|
+
# migration_task_name: "MigrationTaskName", # required
|
515
|
+
# dry_run: false,
|
516
|
+
# })
|
517
|
+
#
|
518
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/ImportMigrationTask AWS API Documentation
|
519
|
+
#
|
520
|
+
# @overload import_migration_task(params = {})
|
521
|
+
# @param [Hash] params ({})
|
522
|
+
def import_migration_task(params = {}, options = {})
|
523
|
+
req = build_request(:import_migration_task, params)
|
524
|
+
req.send_request(options)
|
525
|
+
end
|
526
|
+
|
527
|
+
# Lists the created artifacts attached to a given migration task in an
|
528
|
+
# update stream. This API has the following traits:
|
529
|
+
#
|
530
|
+
# * Gets the list of the created artifacts while migration is taking
|
531
|
+
# place.
|
532
|
+
#
|
533
|
+
# * Shows the artifacts created by the migration tool that was
|
534
|
+
# associated by the `AssociateCreatedArtifact` API.
|
535
|
+
#
|
536
|
+
# * Lists created artifacts in a paginated interface.
|
537
|
+
#
|
538
|
+
# @option params [required, String] :progress_update_stream
|
539
|
+
# The name of the ProgressUpdateStream.
|
540
|
+
#
|
541
|
+
# @option params [required, String] :migration_task_name
|
542
|
+
# Unique identifier that references the migration task.
|
543
|
+
#
|
544
|
+
# @option params [String] :next_token
|
545
|
+
# If a `NextToken` was returned by a previous call, there are more
|
546
|
+
# results available. To retrieve the next page of results, make the call
|
547
|
+
# again using the returned token in `NextToken`.
|
548
|
+
#
|
549
|
+
# @option params [Integer] :max_results
|
550
|
+
# Maximum number of results to be returned per page.
|
551
|
+
#
|
552
|
+
# @return [Types::ListCreatedArtifactsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
553
|
+
#
|
554
|
+
# * {Types::ListCreatedArtifactsResult#next_token #next_token} => String
|
555
|
+
# * {Types::ListCreatedArtifactsResult#created_artifact_list #created_artifact_list} => Array<Types::CreatedArtifact>
|
556
|
+
#
|
557
|
+
# @example Request syntax with placeholder values
|
558
|
+
#
|
559
|
+
# resp = client.list_created_artifacts({
|
560
|
+
# progress_update_stream: "ProgressUpdateStream", # required
|
561
|
+
# migration_task_name: "MigrationTaskName", # required
|
562
|
+
# next_token: "Token",
|
563
|
+
# max_results: 1,
|
564
|
+
# })
|
565
|
+
#
|
566
|
+
# @example Response structure
|
567
|
+
#
|
568
|
+
# resp.next_token #=> String
|
569
|
+
# resp.created_artifact_list #=> Array
|
570
|
+
# resp.created_artifact_list[0].name #=> String
|
571
|
+
# resp.created_artifact_list[0].description #=> String
|
572
|
+
#
|
573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/ListCreatedArtifacts AWS API Documentation
|
574
|
+
#
|
575
|
+
# @overload list_created_artifacts(params = {})
|
576
|
+
# @param [Hash] params ({})
|
577
|
+
def list_created_artifacts(params = {}, options = {})
|
578
|
+
req = build_request(:list_created_artifacts, params)
|
579
|
+
req.send_request(options)
|
580
|
+
end
|
581
|
+
|
582
|
+
# Lists discovered resources associated with the given `MigrationTask`.
|
583
|
+
#
|
584
|
+
# @option params [required, String] :progress_update_stream
|
585
|
+
# The name of the ProgressUpdateStream.
|
586
|
+
#
|
587
|
+
# @option params [required, String] :migration_task_name
|
588
|
+
# The name of the MigrationTask.
|
589
|
+
#
|
590
|
+
# @option params [String] :next_token
|
591
|
+
# If a `NextToken` was returned by a previous call, there are more
|
592
|
+
# results available. To retrieve the next page of results, make the call
|
593
|
+
# again using the returned token in `NextToken`.
|
594
|
+
#
|
595
|
+
# @option params [Integer] :max_results
|
596
|
+
# The maximum number of results returned per page.
|
597
|
+
#
|
598
|
+
# @return [Types::ListDiscoveredResourcesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
599
|
+
#
|
600
|
+
# * {Types::ListDiscoveredResourcesResult#next_token #next_token} => String
|
601
|
+
# * {Types::ListDiscoveredResourcesResult#discovered_resource_list #discovered_resource_list} => Array<Types::DiscoveredResource>
|
602
|
+
#
|
603
|
+
# @example Request syntax with placeholder values
|
604
|
+
#
|
605
|
+
# resp = client.list_discovered_resources({
|
606
|
+
# progress_update_stream: "ProgressUpdateStream", # required
|
607
|
+
# migration_task_name: "MigrationTaskName", # required
|
608
|
+
# next_token: "Token",
|
609
|
+
# max_results: 1,
|
610
|
+
# })
|
611
|
+
#
|
612
|
+
# @example Response structure
|
613
|
+
#
|
614
|
+
# resp.next_token #=> String
|
615
|
+
# resp.discovered_resource_list #=> Array
|
616
|
+
# resp.discovered_resource_list[0].configuration_id #=> String
|
617
|
+
# resp.discovered_resource_list[0].description #=> String
|
618
|
+
#
|
619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/ListDiscoveredResources AWS API Documentation
|
620
|
+
#
|
621
|
+
# @overload list_discovered_resources(params = {})
|
622
|
+
# @param [Hash] params ({})
|
623
|
+
def list_discovered_resources(params = {}, options = {})
|
624
|
+
req = build_request(:list_discovered_resources, params)
|
625
|
+
req.send_request(options)
|
626
|
+
end
|
627
|
+
|
628
|
+
# Lists all, or filtered by resource name, migration tasks associated
|
629
|
+
# with the user account making this call. This API has the following
|
630
|
+
# traits:
|
631
|
+
#
|
632
|
+
# * Can show a summary list of the most recent migration tasks.
|
633
|
+
#
|
634
|
+
# * Can show a summary list of migration tasks associated with a given
|
635
|
+
# discovered resource.
|
636
|
+
#
|
637
|
+
# * Lists migration tasks in a paginated interface.
|
638
|
+
#
|
639
|
+
# @option params [String] :next_token
|
640
|
+
# If a `NextToken` was returned by a previous call, there are more
|
641
|
+
# results available. To retrieve the next page of results, make the call
|
642
|
+
# again using the returned token in `NextToken`.
|
643
|
+
#
|
644
|
+
# @option params [Integer] :max_results
|
645
|
+
# Value to specify how many results are returned per page.
|
646
|
+
#
|
647
|
+
# @option params [String] :resource_name
|
648
|
+
# Filter migration tasks by discovered resource name.
|
649
|
+
#
|
650
|
+
# @return [Types::ListMigrationTasksResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
651
|
+
#
|
652
|
+
# * {Types::ListMigrationTasksResult#next_token #next_token} => String
|
653
|
+
# * {Types::ListMigrationTasksResult#migration_task_summary_list #migration_task_summary_list} => Array<Types::MigrationTaskSummary>
|
654
|
+
#
|
655
|
+
# @example Request syntax with placeholder values
|
656
|
+
#
|
657
|
+
# resp = client.list_migration_tasks({
|
658
|
+
# next_token: "Token",
|
659
|
+
# max_results: 1,
|
660
|
+
# resource_name: "ResourceName",
|
661
|
+
# })
|
662
|
+
#
|
663
|
+
# @example Response structure
|
664
|
+
#
|
665
|
+
# resp.next_token #=> String
|
666
|
+
# resp.migration_task_summary_list #=> Array
|
667
|
+
# resp.migration_task_summary_list[0].progress_update_stream #=> String
|
668
|
+
# resp.migration_task_summary_list[0].migration_task_name #=> String
|
669
|
+
# resp.migration_task_summary_list[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FAILED", "COMPLETED"
|
670
|
+
# resp.migration_task_summary_list[0].progress_percent #=> Integer
|
671
|
+
# resp.migration_task_summary_list[0].status_detail #=> String
|
672
|
+
# resp.migration_task_summary_list[0].update_date_time #=> Time
|
673
|
+
#
|
674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/ListMigrationTasks AWS API Documentation
|
675
|
+
#
|
676
|
+
# @overload list_migration_tasks(params = {})
|
677
|
+
# @param [Hash] params ({})
|
678
|
+
def list_migration_tasks(params = {}, options = {})
|
679
|
+
req = build_request(:list_migration_tasks, params)
|
680
|
+
req.send_request(options)
|
681
|
+
end
|
682
|
+
|
683
|
+
# Lists progress update streams associated with the user account making
|
684
|
+
# this call.
|
685
|
+
#
|
686
|
+
# @option params [String] :next_token
|
687
|
+
# If a `NextToken` was returned by a previous call, there are more
|
688
|
+
# results available. To retrieve the next page of results, make the call
|
689
|
+
# again using the returned token in `NextToken`.
|
690
|
+
#
|
691
|
+
# @option params [Integer] :max_results
|
692
|
+
# Filter to limit the maximum number of results to list per page.
|
693
|
+
#
|
694
|
+
# @return [Types::ListProgressUpdateStreamsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
695
|
+
#
|
696
|
+
# * {Types::ListProgressUpdateStreamsResult#progress_update_stream_summary_list #progress_update_stream_summary_list} => Array<Types::ProgressUpdateStreamSummary>
|
697
|
+
# * {Types::ListProgressUpdateStreamsResult#next_token #next_token} => String
|
698
|
+
#
|
699
|
+
# @example Request syntax with placeholder values
|
700
|
+
#
|
701
|
+
# resp = client.list_progress_update_streams({
|
702
|
+
# next_token: "Token",
|
703
|
+
# max_results: 1,
|
704
|
+
# })
|
705
|
+
#
|
706
|
+
# @example Response structure
|
707
|
+
#
|
708
|
+
# resp.progress_update_stream_summary_list #=> Array
|
709
|
+
# resp.progress_update_stream_summary_list[0].progress_update_stream_name #=> String
|
710
|
+
# resp.next_token #=> String
|
711
|
+
#
|
712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/ListProgressUpdateStreams AWS API Documentation
|
713
|
+
#
|
714
|
+
# @overload list_progress_update_streams(params = {})
|
715
|
+
# @param [Hash] params ({})
|
716
|
+
def list_progress_update_streams(params = {}, options = {})
|
717
|
+
req = build_request(:list_progress_update_streams, params)
|
718
|
+
req.send_request(options)
|
719
|
+
end
|
720
|
+
|
721
|
+
# Sets the migration state of an application. For a given application
|
722
|
+
# identified by the value passed to `ApplicationId`, its status is set
|
723
|
+
# or updated by passing one of three values to `Status`\: `NOT_STARTED |
|
724
|
+
# IN_PROGRESS | COMPLETED`.
|
725
|
+
#
|
726
|
+
# @option params [required, String] :application_id
|
727
|
+
# The configurationId in ADS that uniquely identifies the grouped
|
728
|
+
# application.
|
729
|
+
#
|
730
|
+
# @option params [required, String] :status
|
731
|
+
# Status of the application - Not Started, In-Progress, Complete.
|
732
|
+
#
|
733
|
+
# @option params [Boolean] :dry_run
|
734
|
+
# Optional boolean flag to indicate whether any effect should take
|
735
|
+
# place. Used to test if the caller has permission to make the call.
|
736
|
+
#
|
737
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
738
|
+
#
|
739
|
+
# @example Request syntax with placeholder values
|
740
|
+
#
|
741
|
+
# resp = client.notify_application_state({
|
742
|
+
# application_id: "ApplicationId", # required
|
743
|
+
# status: "NOT_STARTED", # required, accepts NOT_STARTED, IN_PROGRESS, COMPLETED
|
744
|
+
# dry_run: false,
|
745
|
+
# })
|
746
|
+
#
|
747
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/NotifyApplicationState AWS API Documentation
|
748
|
+
#
|
749
|
+
# @overload notify_application_state(params = {})
|
750
|
+
# @param [Hash] params ({})
|
751
|
+
def notify_application_state(params = {}, options = {})
|
752
|
+
req = build_request(:notify_application_state, params)
|
753
|
+
req.send_request(options)
|
754
|
+
end
|
755
|
+
|
756
|
+
# Notifies Migration Hub of the current status, progress, or other
|
757
|
+
# detail regarding a migration task. This API has the following traits:
|
758
|
+
#
|
759
|
+
# * Migration tools will call the `NotifyMigrationTaskState` API to
|
760
|
+
# share the latest progress and status.
|
761
|
+
#
|
762
|
+
# * `MigrationTaskName` is used for addressing updates to the correct
|
763
|
+
# target.
|
764
|
+
#
|
765
|
+
# * `ProgressUpdateStream` is used for access control and to provide a
|
766
|
+
# namespace for each migration tool.
|
767
|
+
#
|
768
|
+
# @option params [required, String] :progress_update_stream
|
769
|
+
# The name of the ProgressUpdateStream.
|
770
|
+
#
|
771
|
+
# @option params [required, String] :migration_task_name
|
772
|
+
# Unique identifier that references the migration task.
|
773
|
+
#
|
774
|
+
# @option params [required, Types::Task] :task
|
775
|
+
# Information about the task's progress and status.
|
776
|
+
#
|
777
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :update_date_time
|
778
|
+
# The timestamp when the task was gathered.
|
779
|
+
#
|
780
|
+
# @option params [required, Integer] :next_update_seconds
|
781
|
+
# Number of seconds after the UpdateDateTime within which the Migration
|
782
|
+
# Hub can expect an update. If Migration Hub does not receive an update
|
783
|
+
# within the specified interval, then the migration task will be
|
784
|
+
# considered stale.
|
785
|
+
#
|
786
|
+
# @option params [Boolean] :dry_run
|
787
|
+
# Optional boolean flag to indicate whether any effect should take
|
788
|
+
# place. Used to test if the caller has permission to make the call.
|
789
|
+
#
|
790
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
791
|
+
#
|
792
|
+
# @example Request syntax with placeholder values
|
793
|
+
#
|
794
|
+
# resp = client.notify_migration_task_state({
|
795
|
+
# progress_update_stream: "ProgressUpdateStream", # required
|
796
|
+
# migration_task_name: "MigrationTaskName", # required
|
797
|
+
# task: { # required
|
798
|
+
# status: "NOT_STARTED", # required, accepts NOT_STARTED, IN_PROGRESS, FAILED, COMPLETED
|
799
|
+
# status_detail: "StatusDetail",
|
800
|
+
# progress_percent: 1,
|
801
|
+
# },
|
802
|
+
# update_date_time: Time.now, # required
|
803
|
+
# next_update_seconds: 1, # required
|
804
|
+
# dry_run: false,
|
805
|
+
# })
|
806
|
+
#
|
807
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/NotifyMigrationTaskState AWS API Documentation
|
808
|
+
#
|
809
|
+
# @overload notify_migration_task_state(params = {})
|
810
|
+
# @param [Hash] params ({})
|
811
|
+
def notify_migration_task_state(params = {}, options = {})
|
812
|
+
req = build_request(:notify_migration_task_state, params)
|
813
|
+
req.send_request(options)
|
814
|
+
end
|
815
|
+
|
816
|
+
# Provides identifying details of the resource being migrated so that it
|
817
|
+
# can be associated in the Application Discovery Service (ADS)'s
|
818
|
+
# repository. This association occurs asynchronously after
|
819
|
+
# `PutResourceAttributes` returns.
|
820
|
+
#
|
821
|
+
# Keep in mind that subsequent calls to PutResourceAttributes will
|
822
|
+
# override previously stored attributes. For example, if it is first
|
823
|
+
# called with a MAC address, but later, it is desired to *add* an IP
|
824
|
+
# address, it will then be required to call it with *both* the IP and
|
825
|
+
# MAC addresses to prevent overiding the MAC address.
|
826
|
+
#
|
827
|
+
# <note markdown="1"> Because this is an asynchronous call, it will always return 200,
|
828
|
+
# whether an association occurs or not. To confirm if an association was
|
829
|
+
# found based on the provided details, call `ListAssociatedResource`.
|
830
|
+
#
|
831
|
+
# </note>
|
832
|
+
#
|
833
|
+
# @option params [required, String] :progress_update_stream
|
834
|
+
# The name of the ProgressUpdateStream.
|
835
|
+
#
|
836
|
+
# @option params [required, String] :migration_task_name
|
837
|
+
# Unique identifier that references the migration task.
|
838
|
+
#
|
839
|
+
# @option params [required, Array<Types::ResourceAttribute>] :resource_attribute_list
|
840
|
+
# Information about the resource that is being migrated. This data will
|
841
|
+
# be used to map the task to a resource in the Application Discovery
|
842
|
+
# Service (ADS)'s repository.
|
843
|
+
#
|
844
|
+
# @option params [Boolean] :dry_run
|
845
|
+
# Optional boolean flag to indicate whether any effect should take
|
846
|
+
# place. Used to test if the caller has permission to make the call.
|
847
|
+
#
|
848
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
849
|
+
#
|
850
|
+
# @example Request syntax with placeholder values
|
851
|
+
#
|
852
|
+
# resp = client.put_resource_attributes({
|
853
|
+
# progress_update_stream: "ProgressUpdateStream", # required
|
854
|
+
# migration_task_name: "MigrationTaskName", # required
|
855
|
+
# resource_attribute_list: [ # required
|
856
|
+
# {
|
857
|
+
# type: "IPV4_ADDRESS", # required, accepts IPV4_ADDRESS, IPV6_ADDRESS, MAC_ADDRESS, FQDN, VM_MANAGER_ID, VM_MANAGED_OBJECT_REFERENCE, VM_NAME, VM_PATH, BIOS_ID, MOTHERBOARD_SERIAL_NUMBER, LABEL
|
858
|
+
# value: "ResourceAttributeValue", # required
|
859
|
+
# },
|
860
|
+
# ],
|
861
|
+
# dry_run: false,
|
862
|
+
# })
|
863
|
+
#
|
864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/PutResourceAttributes AWS API Documentation
|
865
|
+
#
|
866
|
+
# @overload put_resource_attributes(params = {})
|
867
|
+
# @param [Hash] params ({})
|
868
|
+
def put_resource_attributes(params = {}, options = {})
|
869
|
+
req = build_request(:put_resource_attributes, params)
|
870
|
+
req.send_request(options)
|
871
|
+
end
|
872
|
+
|
873
|
+
# @!endgroup
|
874
|
+
|
875
|
+
# @param params ({})
|
876
|
+
# @api private
|
877
|
+
def build_request(operation_name, params = {})
|
878
|
+
handlers = @handlers.for(operation_name)
|
879
|
+
context = Seahorse::Client::RequestContext.new(
|
880
|
+
operation_name: operation_name,
|
881
|
+
operation: config.api.operation(operation_name),
|
882
|
+
client: self,
|
883
|
+
params: params,
|
884
|
+
config: config)
|
885
|
+
context[:gem_name] = 'aws-sdk-migrationhub'
|
886
|
+
context[:gem_version] = '1.0.0.rc1'
|
887
|
+
Seahorse::Client::Request.new(handlers, context)
|
888
|
+
end
|
889
|
+
|
890
|
+
# @api private
|
891
|
+
# @deprecated
|
892
|
+
def waiter_names
|
893
|
+
[]
|
894
|
+
end
|
895
|
+
|
896
|
+
class << self
|
897
|
+
|
898
|
+
# @api private
|
899
|
+
attr_reader :identifier
|
900
|
+
|
901
|
+
# @api private
|
902
|
+
def errors_module
|
903
|
+
Errors
|
904
|
+
end
|
905
|
+
|
906
|
+
end
|
907
|
+
end
|
908
|
+
end
|