aws-sdk-sms 1.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-sms.rb +47 -0
- data/lib/aws-sdk-sms/client.rb +560 -0
- data/lib/aws-sdk-sms/client_api.rb +416 -0
- data/lib/aws-sdk-sms/customizations.rb +7 -0
- data/lib/aws-sdk-sms/errors.rb +23 -0
- data/lib/aws-sdk-sms/resource.rb +25 -0
- data/lib/aws-sdk-sms/types.rb +598 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 18789a31426dd217121627e9f14aa0b485d8b560
|
4
|
+
data.tar.gz: f3d7378b522e6a6ad4299934bc3a8218f8fd637c
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 7ca48ea7375edaf3e672fbdf58ee318e9f7759e60b4c7beeb83efab9722aa31d25fffefd34e393d2663e979a93a4375963640f4ce6d14c28ef19ebe000684cea
|
7
|
+
data.tar.gz: 4912b196a9f8cdccd31bbd5de24b65c20cee045a22f2d07c6346ef72293515cc89de01e6639dec6f1dbad820975389a47e735ca6f6373b37f5f549151b8c6530
|
data/lib/aws-sdk-sms.rb
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-sms/types'
|
12
|
+
require_relative 'aws-sdk-sms/client_api'
|
13
|
+
require_relative 'aws-sdk-sms/client'
|
14
|
+
require_relative 'aws-sdk-sms/errors'
|
15
|
+
require_relative 'aws-sdk-sms/resource'
|
16
|
+
require_relative 'aws-sdk-sms/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS Server Migration Service. This module is available in the
|
19
|
+
# `aws-sdk-sms` 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 Server Migration Service all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::SMS::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::SMS
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc1'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,560 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
23
|
+
|
24
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:sms)
|
25
|
+
|
26
|
+
module Aws
|
27
|
+
module SMS
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :sms
|
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::SignatureV4)
|
50
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
51
|
+
|
52
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
53
|
+
# Your AWS credentials. This can be an instance of any one of the
|
54
|
+
# following classes:
|
55
|
+
#
|
56
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
57
|
+
# credentials.
|
58
|
+
#
|
59
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
60
|
+
# from an EC2 IMDS on an EC2 instance.
|
61
|
+
#
|
62
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
63
|
+
# shared file, such as `~/.aws/config`.
|
64
|
+
#
|
65
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
66
|
+
#
|
67
|
+
# When `:credentials` are not configured directly, the following
|
68
|
+
# locations will be searched for credentials:
|
69
|
+
#
|
70
|
+
# * `Aws.config[:credentials]`
|
71
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
72
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
73
|
+
# * `~/.aws/credentials`
|
74
|
+
# * `~/.aws/config`
|
75
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
76
|
+
# very aggressive. Construct and pass an instance of
|
77
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
78
|
+
# timeouts.
|
79
|
+
# @option options [required, String] :region
|
80
|
+
# The AWS region to connect to. The configured `:region` is
|
81
|
+
# used to determine the service `:endpoint`. When not passed,
|
82
|
+
# a default `:region` is search for in the following locations:
|
83
|
+
#
|
84
|
+
# * `Aws.config[:region]`
|
85
|
+
# * `ENV['AWS_REGION']`
|
86
|
+
# * `ENV['AMAZON_REGION']`
|
87
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
88
|
+
# * `~/.aws/credentials`
|
89
|
+
# * `~/.aws/config`
|
90
|
+
# @option options [String] :access_key_id
|
91
|
+
# @option options [Boolean] :convert_params (true)
|
92
|
+
# When `true`, an attempt is made to coerce request parameters into
|
93
|
+
# the required types.
|
94
|
+
# @option options [String] :endpoint
|
95
|
+
# The client endpoint is normally constructed from the `:region`
|
96
|
+
# option. You should only configure an `:endpoint` when connecting
|
97
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
98
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
99
|
+
# The log formatter.
|
100
|
+
# @option options [Symbol] :log_level (:info)
|
101
|
+
# The log level to send messages to the `:logger` at.
|
102
|
+
# @option options [Logger] :logger
|
103
|
+
# The Logger instance to send log messages to. If this option
|
104
|
+
# is not set, logging will be disabled.
|
105
|
+
# @option options [String] :profile ("default")
|
106
|
+
# Used when loading credentials from the shared credentials file
|
107
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
108
|
+
# @option options [Integer] :retry_limit (3)
|
109
|
+
# The maximum number of times to retry failed requests. Only
|
110
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
111
|
+
# are retried. Generally, these are throttling errors, data
|
112
|
+
# checksum errors, networking errors, timeout errors and auth
|
113
|
+
# errors from expired credentials.
|
114
|
+
# @option options [String] :secret_access_key
|
115
|
+
# @option options [String] :session_token
|
116
|
+
# @option options [Boolean] :simple_json (false)
|
117
|
+
# Disables request parameter conversion, validation, and formatting.
|
118
|
+
# Also disable response data type conversions. This option is useful
|
119
|
+
# when you want to ensure the highest level of performance by
|
120
|
+
# avoiding overhead of walking request parameters and response data
|
121
|
+
# structures.
|
122
|
+
#
|
123
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
124
|
+
# be formatted exactly as the DynamoDB API expects.
|
125
|
+
# @option options [Boolean] :stub_responses (false)
|
126
|
+
# Causes the client to return stubbed responses. By default
|
127
|
+
# fake responses are generated and returned. You can specify
|
128
|
+
# the response data to return or errors to raise by calling
|
129
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
130
|
+
#
|
131
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
132
|
+
# requests are made, and retries are disabled.
|
133
|
+
# @option options [Boolean] :validate_params (true)
|
134
|
+
# When `true`, request parameters are validated before
|
135
|
+
# sending the request.
|
136
|
+
def initialize(*args)
|
137
|
+
super
|
138
|
+
end
|
139
|
+
|
140
|
+
# @!group API Operations
|
141
|
+
|
142
|
+
# The CreateReplicationJob API is used to create a ReplicationJob to
|
143
|
+
# replicate a server on AWS. Call this API to first create a
|
144
|
+
# ReplicationJob, which will then schedule periodic ReplicationRuns to
|
145
|
+
# replicate your server to AWS. Each ReplicationRun will result in the
|
146
|
+
# creation of an AWS AMI.
|
147
|
+
# @option params [required, String] :server_id
|
148
|
+
# Unique Identifier for a server
|
149
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :seed_replication_time
|
150
|
+
# Timestamp of an operation
|
151
|
+
# @option params [required, Integer] :frequency
|
152
|
+
# Interval between Replication Runs. This value is specified in hours,
|
153
|
+
# and represents the time between consecutive Replication Runs.
|
154
|
+
# @option params [String] :license_type
|
155
|
+
# The license type to be used for the Amazon Machine Image (AMI) created
|
156
|
+
# after a successful ReplicationRun.
|
157
|
+
# @option params [String] :role_name
|
158
|
+
# Name of service role in customer's account to be used by SMS service.
|
159
|
+
# @option params [String] :description
|
160
|
+
# The description for a Replication Job/Run.
|
161
|
+
# @return [Types::CreateReplicationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
162
|
+
#
|
163
|
+
# * {Types::CreateReplicationJobResponse#replication_job_id #replicationJobId} => String
|
164
|
+
#
|
165
|
+
# @example Request syntax with placeholder values
|
166
|
+
# resp = client.create_replication_job({
|
167
|
+
# server_id: "ServerId", # required
|
168
|
+
# seed_replication_time: Time.now, # required
|
169
|
+
# frequency: 1, # required
|
170
|
+
# license_type: "AWS", # accepts AWS, BYOL
|
171
|
+
# role_name: "RoleName",
|
172
|
+
# description: "Description",
|
173
|
+
# })
|
174
|
+
#
|
175
|
+
# @example Response structure
|
176
|
+
# resp.replication_job_id #=> String
|
177
|
+
# @overload create_replication_job(params = {})
|
178
|
+
# @param [Hash] params ({})
|
179
|
+
def create_replication_job(params = {}, options = {})
|
180
|
+
req = build_request(:create_replication_job, params)
|
181
|
+
req.send_request(options)
|
182
|
+
end
|
183
|
+
|
184
|
+
# The DeleteReplicationJob API is used to delete a ReplicationJob,
|
185
|
+
# resulting in no further ReplicationRuns. This will delete the contents
|
186
|
+
# of the S3 bucket used to store SMS artifacts, but will not delete any
|
187
|
+
# AMIs created by the SMS service.
|
188
|
+
# @option params [required, String] :replication_job_id
|
189
|
+
# The unique identifier for a Replication Job.
|
190
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
191
|
+
#
|
192
|
+
# @example Request syntax with placeholder values
|
193
|
+
# resp = client.delete_replication_job({
|
194
|
+
# replication_job_id: "ReplicationJobId", # required
|
195
|
+
# })
|
196
|
+
# @overload delete_replication_job(params = {})
|
197
|
+
# @param [Hash] params ({})
|
198
|
+
def delete_replication_job(params = {}, options = {})
|
199
|
+
req = build_request(:delete_replication_job, params)
|
200
|
+
req.send_request(options)
|
201
|
+
end
|
202
|
+
|
203
|
+
# The DeleteServerCatalog API clears all servers from your server
|
204
|
+
# catalog. This means that these servers will no longer be accessible to
|
205
|
+
# the Server Migration Service.
|
206
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
207
|
+
#
|
208
|
+
# @example Request syntax with placeholder values
|
209
|
+
# resp = client.delete_server_catalog()
|
210
|
+
# @overload delete_server_catalog(params = {})
|
211
|
+
# @param [Hash] params ({})
|
212
|
+
def delete_server_catalog(params = {}, options = {})
|
213
|
+
req = build_request(:delete_server_catalog, params)
|
214
|
+
req.send_request(options)
|
215
|
+
end
|
216
|
+
|
217
|
+
# The DisassociateConnector API will disassociate a connector from the
|
218
|
+
# Server Migration Service, rendering it unavailable to support
|
219
|
+
# replication jobs.
|
220
|
+
# @option params [required, String] :connector_id
|
221
|
+
# Unique Identifier for Connector
|
222
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
223
|
+
#
|
224
|
+
# @example Request syntax with placeholder values
|
225
|
+
# resp = client.disassociate_connector({
|
226
|
+
# connector_id: "ConnectorId", # required
|
227
|
+
# })
|
228
|
+
# @overload disassociate_connector(params = {})
|
229
|
+
# @param [Hash] params ({})
|
230
|
+
def disassociate_connector(params = {}, options = {})
|
231
|
+
req = build_request(:disassociate_connector, params)
|
232
|
+
req.send_request(options)
|
233
|
+
end
|
234
|
+
|
235
|
+
# The GetConnectors API returns a list of connectors that are registered
|
236
|
+
# with the Server Migration Service.
|
237
|
+
# @option params [String] :next_token
|
238
|
+
# Pagination token to pass as input to API call
|
239
|
+
# @option params [Integer] :max_results
|
240
|
+
# The maximum number of results to return in one API call. If left
|
241
|
+
# empty, this will default to 50.
|
242
|
+
# @return [Types::GetConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
243
|
+
#
|
244
|
+
# * {Types::GetConnectorsResponse#connector_list #connectorList} => Array<Types::Connector>
|
245
|
+
# * {Types::GetConnectorsResponse#next_token #nextToken} => String
|
246
|
+
#
|
247
|
+
# @example Request syntax with placeholder values
|
248
|
+
# resp = client.get_connectors({
|
249
|
+
# next_token: "NextToken",
|
250
|
+
# max_results: 1,
|
251
|
+
# })
|
252
|
+
#
|
253
|
+
# @example Response structure
|
254
|
+
# resp.connector_list #=> Array
|
255
|
+
# resp.connector_list[0].connector_id #=> String
|
256
|
+
# resp.connector_list[0].version #=> String
|
257
|
+
# resp.connector_list[0].status #=> String, one of "HEALTHY", "UNHEALTHY"
|
258
|
+
# resp.connector_list[0].capability_list #=> Array
|
259
|
+
# resp.connector_list[0].capability_list[0] #=> String, one of "VSPHERE"
|
260
|
+
# resp.connector_list[0].vm_manager_name #=> String
|
261
|
+
# resp.connector_list[0].vm_manager_type #=> String, one of "VSPHERE"
|
262
|
+
# resp.connector_list[0].vm_manager_id #=> String
|
263
|
+
# resp.connector_list[0].ip_address #=> String
|
264
|
+
# resp.connector_list[0].mac_address #=> String
|
265
|
+
# resp.connector_list[0].associated_on #=> Time
|
266
|
+
# resp.next_token #=> String
|
267
|
+
# @overload get_connectors(params = {})
|
268
|
+
# @param [Hash] params ({})
|
269
|
+
def get_connectors(params = {}, options = {})
|
270
|
+
req = build_request(:get_connectors, params)
|
271
|
+
req.send_request(options)
|
272
|
+
end
|
273
|
+
|
274
|
+
# The GetReplicationJobs API will return all of your ReplicationJobs and
|
275
|
+
# their details. This API returns a paginated list, that may be
|
276
|
+
# consecutively called with nextToken to retrieve all ReplicationJobs.
|
277
|
+
# @option params [String] :replication_job_id
|
278
|
+
# The unique identifier for a Replication Job.
|
279
|
+
# @option params [String] :next_token
|
280
|
+
# Pagination token to pass as input to API call
|
281
|
+
# @option params [Integer] :max_results
|
282
|
+
# The maximum number of results to return in one API call. If left
|
283
|
+
# empty, this will default to 50.
|
284
|
+
# @return [Types::GetReplicationJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
285
|
+
#
|
286
|
+
# * {Types::GetReplicationJobsResponse#replication_job_list #replicationJobList} => Array<Types::ReplicationJob>
|
287
|
+
# * {Types::GetReplicationJobsResponse#next_token #nextToken} => String
|
288
|
+
#
|
289
|
+
# @example Request syntax with placeholder values
|
290
|
+
# resp = client.get_replication_jobs({
|
291
|
+
# replication_job_id: "ReplicationJobId",
|
292
|
+
# next_token: "NextToken",
|
293
|
+
# max_results: 1,
|
294
|
+
# })
|
295
|
+
#
|
296
|
+
# @example Response structure
|
297
|
+
# resp.replication_job_list #=> Array
|
298
|
+
# resp.replication_job_list[0].replication_job_id #=> String
|
299
|
+
# resp.replication_job_list[0].server_id #=> String
|
300
|
+
# resp.replication_job_list[0].server_type #=> String, one of "VIRTUAL_MACHINE"
|
301
|
+
# resp.replication_job_list[0].vm_server.vm_server_address.vm_manager_id #=> String
|
302
|
+
# resp.replication_job_list[0].vm_server.vm_server_address.vm_id #=> String
|
303
|
+
# resp.replication_job_list[0].vm_server.vm_name #=> String
|
304
|
+
# resp.replication_job_list[0].vm_server.vm_manager_name #=> String
|
305
|
+
# resp.replication_job_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE"
|
306
|
+
# resp.replication_job_list[0].vm_server.vm_path #=> String
|
307
|
+
# resp.replication_job_list[0].seed_replication_time #=> Time
|
308
|
+
# resp.replication_job_list[0].frequency #=> Integer
|
309
|
+
# resp.replication_job_list[0].next_replication_run_start_time #=> Time
|
310
|
+
# resp.replication_job_list[0].license_type #=> String, one of "AWS", "BYOL"
|
311
|
+
# resp.replication_job_list[0].role_name #=> String
|
312
|
+
# resp.replication_job_list[0].latest_ami_id #=> String
|
313
|
+
# resp.replication_job_list[0].state #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED"
|
314
|
+
# resp.replication_job_list[0].status_message #=> String
|
315
|
+
# resp.replication_job_list[0].description #=> String
|
316
|
+
# resp.replication_job_list[0].replication_run_list #=> Array
|
317
|
+
# resp.replication_job_list[0].replication_run_list[0].replication_run_id #=> String
|
318
|
+
# resp.replication_job_list[0].replication_run_list[0].state #=> String, one of "PENDING", "MISSED", "ACTIVE", "FAILED", "COMPLETED", "DELETING", "DELETED"
|
319
|
+
# resp.replication_job_list[0].replication_run_list[0].type #=> String, one of "ON_DEMAND", "AUTOMATIC"
|
320
|
+
# resp.replication_job_list[0].replication_run_list[0].status_message #=> String
|
321
|
+
# resp.replication_job_list[0].replication_run_list[0].ami_id #=> String
|
322
|
+
# resp.replication_job_list[0].replication_run_list[0].scheduled_start_time #=> Time
|
323
|
+
# resp.replication_job_list[0].replication_run_list[0].completed_time #=> Time
|
324
|
+
# resp.replication_job_list[0].replication_run_list[0].description #=> String
|
325
|
+
# resp.next_token #=> String
|
326
|
+
# @overload get_replication_jobs(params = {})
|
327
|
+
# @param [Hash] params ({})
|
328
|
+
def get_replication_jobs(params = {}, options = {})
|
329
|
+
req = build_request(:get_replication_jobs, params)
|
330
|
+
req.send_request(options)
|
331
|
+
end
|
332
|
+
|
333
|
+
# The GetReplicationRuns API will return all ReplicationRuns for a given
|
334
|
+
# ReplicationJob. This API returns a paginated list, that may be
|
335
|
+
# consecutively called with nextToken to retrieve all ReplicationRuns
|
336
|
+
# for a ReplicationJob.
|
337
|
+
# @option params [required, String] :replication_job_id
|
338
|
+
# The unique identifier for a Replication Job.
|
339
|
+
# @option params [String] :next_token
|
340
|
+
# Pagination token to pass as input to API call
|
341
|
+
# @option params [Integer] :max_results
|
342
|
+
# The maximum number of results to return in one API call. If left
|
343
|
+
# empty, this will default to 50.
|
344
|
+
# @return [Types::GetReplicationRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
345
|
+
#
|
346
|
+
# * {Types::GetReplicationRunsResponse#replication_job #replicationJob} => Types::ReplicationJob
|
347
|
+
# * {Types::GetReplicationRunsResponse#replication_run_list #replicationRunList} => Array<Types::ReplicationRun>
|
348
|
+
# * {Types::GetReplicationRunsResponse#next_token #nextToken} => String
|
349
|
+
#
|
350
|
+
# @example Request syntax with placeholder values
|
351
|
+
# resp = client.get_replication_runs({
|
352
|
+
# replication_job_id: "ReplicationJobId", # required
|
353
|
+
# next_token: "NextToken",
|
354
|
+
# max_results: 1,
|
355
|
+
# })
|
356
|
+
#
|
357
|
+
# @example Response structure
|
358
|
+
# resp.replication_job.replication_job_id #=> String
|
359
|
+
# resp.replication_job.server_id #=> String
|
360
|
+
# resp.replication_job.server_type #=> String, one of "VIRTUAL_MACHINE"
|
361
|
+
# resp.replication_job.vm_server.vm_server_address.vm_manager_id #=> String
|
362
|
+
# resp.replication_job.vm_server.vm_server_address.vm_id #=> String
|
363
|
+
# resp.replication_job.vm_server.vm_name #=> String
|
364
|
+
# resp.replication_job.vm_server.vm_manager_name #=> String
|
365
|
+
# resp.replication_job.vm_server.vm_manager_type #=> String, one of "VSPHERE"
|
366
|
+
# resp.replication_job.vm_server.vm_path #=> String
|
367
|
+
# resp.replication_job.seed_replication_time #=> Time
|
368
|
+
# resp.replication_job.frequency #=> Integer
|
369
|
+
# resp.replication_job.next_replication_run_start_time #=> Time
|
370
|
+
# resp.replication_job.license_type #=> String, one of "AWS", "BYOL"
|
371
|
+
# resp.replication_job.role_name #=> String
|
372
|
+
# resp.replication_job.latest_ami_id #=> String
|
373
|
+
# resp.replication_job.state #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED"
|
374
|
+
# resp.replication_job.status_message #=> String
|
375
|
+
# resp.replication_job.description #=> String
|
376
|
+
# resp.replication_job.replication_run_list #=> Array
|
377
|
+
# resp.replication_job.replication_run_list[0].replication_run_id #=> String
|
378
|
+
# resp.replication_job.replication_run_list[0].state #=> String, one of "PENDING", "MISSED", "ACTIVE", "FAILED", "COMPLETED", "DELETING", "DELETED"
|
379
|
+
# resp.replication_job.replication_run_list[0].type #=> String, one of "ON_DEMAND", "AUTOMATIC"
|
380
|
+
# resp.replication_job.replication_run_list[0].status_message #=> String
|
381
|
+
# resp.replication_job.replication_run_list[0].ami_id #=> String
|
382
|
+
# resp.replication_job.replication_run_list[0].scheduled_start_time #=> Time
|
383
|
+
# resp.replication_job.replication_run_list[0].completed_time #=> Time
|
384
|
+
# resp.replication_job.replication_run_list[0].description #=> String
|
385
|
+
# resp.replication_run_list #=> Array
|
386
|
+
# resp.replication_run_list[0].replication_run_id #=> String
|
387
|
+
# resp.replication_run_list[0].state #=> String, one of "PENDING", "MISSED", "ACTIVE", "FAILED", "COMPLETED", "DELETING", "DELETED"
|
388
|
+
# resp.replication_run_list[0].type #=> String, one of "ON_DEMAND", "AUTOMATIC"
|
389
|
+
# resp.replication_run_list[0].status_message #=> String
|
390
|
+
# resp.replication_run_list[0].ami_id #=> String
|
391
|
+
# resp.replication_run_list[0].scheduled_start_time #=> Time
|
392
|
+
# resp.replication_run_list[0].completed_time #=> Time
|
393
|
+
# resp.replication_run_list[0].description #=> String
|
394
|
+
# resp.next_token #=> String
|
395
|
+
# @overload get_replication_runs(params = {})
|
396
|
+
# @param [Hash] params ({})
|
397
|
+
def get_replication_runs(params = {}, options = {})
|
398
|
+
req = build_request(:get_replication_runs, params)
|
399
|
+
req.send_request(options)
|
400
|
+
end
|
401
|
+
|
402
|
+
# The GetServers API returns a list of all servers in your server
|
403
|
+
# catalog. For this call to succeed, you must previously have called
|
404
|
+
# ImportServerCatalog.
|
405
|
+
# @option params [String] :next_token
|
406
|
+
# Pagination token to pass as input to API call
|
407
|
+
# @option params [Integer] :max_results
|
408
|
+
# The maximum number of results to return in one API call. If left
|
409
|
+
# empty, this will default to 50.
|
410
|
+
# @return [Types::GetServersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
411
|
+
#
|
412
|
+
# * {Types::GetServersResponse#last_modified_on #lastModifiedOn} => Time
|
413
|
+
# * {Types::GetServersResponse#server_catalog_status #serverCatalogStatus} => String
|
414
|
+
# * {Types::GetServersResponse#server_list #serverList} => Array<Types::Server>
|
415
|
+
# * {Types::GetServersResponse#next_token #nextToken} => String
|
416
|
+
#
|
417
|
+
# @example Request syntax with placeholder values
|
418
|
+
# resp = client.get_servers({
|
419
|
+
# next_token: "NextToken",
|
420
|
+
# max_results: 1,
|
421
|
+
# })
|
422
|
+
#
|
423
|
+
# @example Response structure
|
424
|
+
# resp.last_modified_on #=> Time
|
425
|
+
# resp.server_catalog_status #=> String, one of "NOT_IMPORTED", "IMPORTING", "AVAILABLE", "DELETED", "EXPIRED"
|
426
|
+
# resp.server_list #=> Array
|
427
|
+
# resp.server_list[0].server_id #=> String
|
428
|
+
# resp.server_list[0].server_type #=> String, one of "VIRTUAL_MACHINE"
|
429
|
+
# resp.server_list[0].vm_server.vm_server_address.vm_manager_id #=> String
|
430
|
+
# resp.server_list[0].vm_server.vm_server_address.vm_id #=> String
|
431
|
+
# resp.server_list[0].vm_server.vm_name #=> String
|
432
|
+
# resp.server_list[0].vm_server.vm_manager_name #=> String
|
433
|
+
# resp.server_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE"
|
434
|
+
# resp.server_list[0].vm_server.vm_path #=> String
|
435
|
+
# resp.server_list[0].replication_job_id #=> String
|
436
|
+
# resp.server_list[0].replication_job_terminated #=> Boolean
|
437
|
+
# resp.next_token #=> String
|
438
|
+
# @overload get_servers(params = {})
|
439
|
+
# @param [Hash] params ({})
|
440
|
+
def get_servers(params = {}, options = {})
|
441
|
+
req = build_request(:get_servers, params)
|
442
|
+
req.send_request(options)
|
443
|
+
end
|
444
|
+
|
445
|
+
# The ImportServerCatalog API is used to gather the complete list of
|
446
|
+
# on-premises servers on your premises. This API call requires
|
447
|
+
# connectors to be installed and monitoring all servers you would like
|
448
|
+
# imported. This API call returns immediately, but may take some time to
|
449
|
+
# retrieve all of the servers.
|
450
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
451
|
+
#
|
452
|
+
# @example Request syntax with placeholder values
|
453
|
+
# resp = client.import_server_catalog()
|
454
|
+
# @overload import_server_catalog(params = {})
|
455
|
+
# @param [Hash] params ({})
|
456
|
+
def import_server_catalog(params = {}, options = {})
|
457
|
+
req = build_request(:import_server_catalog, params)
|
458
|
+
req.send_request(options)
|
459
|
+
end
|
460
|
+
|
461
|
+
# The StartOnDemandReplicationRun API is used to start a ReplicationRun
|
462
|
+
# on demand (in addition to those that are scheduled based on your
|
463
|
+
# frequency). This ReplicationRun will start immediately.
|
464
|
+
# StartOnDemandReplicationRun is subject to limits on how many on demand
|
465
|
+
# ReplicationRuns you may call per 24-hour period.
|
466
|
+
# @option params [required, String] :replication_job_id
|
467
|
+
# The unique identifier for a Replication Job.
|
468
|
+
# @option params [String] :description
|
469
|
+
# The description for a Replication Job/Run.
|
470
|
+
# @return [Types::StartOnDemandReplicationRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
471
|
+
#
|
472
|
+
# * {Types::StartOnDemandReplicationRunResponse#replication_run_id #replicationRunId} => String
|
473
|
+
#
|
474
|
+
# @example Request syntax with placeholder values
|
475
|
+
# resp = client.start_on_demand_replication_run({
|
476
|
+
# replication_job_id: "ReplicationJobId", # required
|
477
|
+
# description: "Description",
|
478
|
+
# })
|
479
|
+
#
|
480
|
+
# @example Response structure
|
481
|
+
# resp.replication_run_id #=> String
|
482
|
+
# @overload start_on_demand_replication_run(params = {})
|
483
|
+
# @param [Hash] params ({})
|
484
|
+
def start_on_demand_replication_run(params = {}, options = {})
|
485
|
+
req = build_request(:start_on_demand_replication_run, params)
|
486
|
+
req.send_request(options)
|
487
|
+
end
|
488
|
+
|
489
|
+
# The UpdateReplicationJob API is used to change the settings of your
|
490
|
+
# existing ReplicationJob created using CreateReplicationJob. Calling
|
491
|
+
# this API will affect the next scheduled ReplicationRun.
|
492
|
+
# @option params [required, String] :replication_job_id
|
493
|
+
# The unique identifier for a Replication Job.
|
494
|
+
# @option params [Integer] :frequency
|
495
|
+
# Interval between Replication Runs. This value is specified in hours,
|
496
|
+
# and represents the time between consecutive Replication Runs.
|
497
|
+
# @option params [Time,DateTime,Date,Integer,String] :next_replication_run_start_time
|
498
|
+
# Timestamp of an operation
|
499
|
+
# @option params [String] :license_type
|
500
|
+
# The license type to be used for the Amazon Machine Image (AMI) created
|
501
|
+
# after a successful ReplicationRun.
|
502
|
+
# @option params [String] :role_name
|
503
|
+
# Name of service role in customer's account to be used by SMS service.
|
504
|
+
# @option params [String] :description
|
505
|
+
# The description for a Replication Job/Run.
|
506
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
507
|
+
#
|
508
|
+
# @example Request syntax with placeholder values
|
509
|
+
# resp = client.update_replication_job({
|
510
|
+
# replication_job_id: "ReplicationJobId", # required
|
511
|
+
# frequency: 1,
|
512
|
+
# next_replication_run_start_time: Time.now,
|
513
|
+
# license_type: "AWS", # accepts AWS, BYOL
|
514
|
+
# role_name: "RoleName",
|
515
|
+
# description: "Description",
|
516
|
+
# })
|
517
|
+
# @overload update_replication_job(params = {})
|
518
|
+
# @param [Hash] params ({})
|
519
|
+
def update_replication_job(params = {}, options = {})
|
520
|
+
req = build_request(:update_replication_job, params)
|
521
|
+
req.send_request(options)
|
522
|
+
end
|
523
|
+
|
524
|
+
# @!endgroup
|
525
|
+
|
526
|
+
# @param params ({})
|
527
|
+
# @api private
|
528
|
+
def build_request(operation_name, params = {})
|
529
|
+
handlers = @handlers.for(operation_name)
|
530
|
+
context = Seahorse::Client::RequestContext.new(
|
531
|
+
operation_name: operation_name,
|
532
|
+
operation: config.api.operation(operation_name),
|
533
|
+
client: self,
|
534
|
+
params: params,
|
535
|
+
config: config)
|
536
|
+
context[:gem_name] = 'aws-sdk-sms'
|
537
|
+
context[:gem_version] = '1.0.0.rc1'
|
538
|
+
Seahorse::Client::Request.new(handlers, context)
|
539
|
+
end
|
540
|
+
|
541
|
+
# @api private
|
542
|
+
# @deprecated
|
543
|
+
def waiter_names
|
544
|
+
[]
|
545
|
+
end
|
546
|
+
|
547
|
+
class << self
|
548
|
+
|
549
|
+
# @api private
|
550
|
+
attr_reader :identifier
|
551
|
+
|
552
|
+
# @api private
|
553
|
+
def errors_module
|
554
|
+
Errors
|
555
|
+
end
|
556
|
+
|
557
|
+
end
|
558
|
+
end
|
559
|
+
end
|
560
|
+
end
|