aws-sdk-lightsail 1.0.0.rc2
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-lightsail.rb +47 -0
- data/lib/aws-sdk-lightsail/client.rb +1963 -0
- data/lib/aws-sdk-lightsail/client_api.rb +1459 -0
- data/lib/aws-sdk-lightsail/customizations.rb +0 -0
- data/lib/aws-sdk-lightsail/errors.rb +23 -0
- data/lib/aws-sdk-lightsail/resource.rb +25 -0
- data/lib/aws-sdk-lightsail/types.rb +2307 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 1e36e776518dbb2e8554d53faec4f65bac6fb72d
|
4
|
+
data.tar.gz: fe8c9ca379ec964ec79ae08b0a51b44fff24d645
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: f1a330a4c53d6eac6954a71cf071d51b2a98c370018bd57abff78dc5d2721a73b5490a10932bd1125839b5bc3d1a3faf979ec62b8b66b32fd7281406ed83dbc5
|
7
|
+
data.tar.gz: 1f375452a4b08d5c358d8327e49edd4ff67b3d17b866e6cb9ada03091992e42c5681b589da877c45d0f68250c57ffe7ce776e4aecda81750adc0a26ba4bca3a9
|
@@ -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-lightsail/types'
|
12
|
+
require_relative 'aws-sdk-lightsail/client_api'
|
13
|
+
require_relative 'aws-sdk-lightsail/client'
|
14
|
+
require_relative 'aws-sdk-lightsail/errors'
|
15
|
+
require_relative 'aws-sdk-lightsail/resource'
|
16
|
+
require_relative 'aws-sdk-lightsail/customizations'
|
17
|
+
|
18
|
+
# This module provides support for Amazon Lightsail. This module is available in the
|
19
|
+
# `aws-sdk-lightsail` 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 Amazon Lightsail all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::Lightsail::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::Lightsail
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc2'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,1963 @@
|
|
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(:lightsail)
|
25
|
+
|
26
|
+
module Aws
|
27
|
+
module Lightsail
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :lightsail
|
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
|
+
# Allocates a static IP address.
|
143
|
+
# @option params [required, String] :static_ip_name
|
144
|
+
# The name of the static IP address.
|
145
|
+
# @return [Types::AllocateStaticIpResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
146
|
+
#
|
147
|
+
# * {Types::AllocateStaticIpResult#operations #operations} => Array<Types::Operation>
|
148
|
+
#
|
149
|
+
# @example Request syntax with placeholder values
|
150
|
+
# resp = client.allocate_static_ip({
|
151
|
+
# static_ip_name: "ResourceName", # required
|
152
|
+
# })
|
153
|
+
#
|
154
|
+
# @example Response structure
|
155
|
+
# resp.operations #=> Array
|
156
|
+
# resp.operations[0].id #=> String
|
157
|
+
# resp.operations[0].resource_name #=> String
|
158
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
159
|
+
# resp.operations[0].created_at #=> Time
|
160
|
+
# resp.operations[0].location.availability_zone #=> String
|
161
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
162
|
+
# resp.operations[0].is_terminal #=> Boolean
|
163
|
+
# resp.operations[0].operation_details #=> String
|
164
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
165
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
166
|
+
# resp.operations[0].status_changed_at #=> Time
|
167
|
+
# resp.operations[0].error_code #=> String
|
168
|
+
# resp.operations[0].error_details #=> String
|
169
|
+
# @overload allocate_static_ip(params = {})
|
170
|
+
# @param [Hash] params ({})
|
171
|
+
def allocate_static_ip(params = {}, options = {})
|
172
|
+
req = build_request(:allocate_static_ip, params)
|
173
|
+
req.send_request(options)
|
174
|
+
end
|
175
|
+
|
176
|
+
# Attaches a static IP address to a specific Amazon Lightsail instance.
|
177
|
+
# @option params [required, String] :static_ip_name
|
178
|
+
# The name of the static IP.
|
179
|
+
# @option params [required, String] :instance_name
|
180
|
+
# The instance name to which you want to attach the static IP address.
|
181
|
+
# @return [Types::AttachStaticIpResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
182
|
+
#
|
183
|
+
# * {Types::AttachStaticIpResult#operations #operations} => Array<Types::Operation>
|
184
|
+
#
|
185
|
+
# @example Request syntax with placeholder values
|
186
|
+
# resp = client.attach_static_ip({
|
187
|
+
# static_ip_name: "ResourceName", # required
|
188
|
+
# instance_name: "ResourceName", # required
|
189
|
+
# })
|
190
|
+
#
|
191
|
+
# @example Response structure
|
192
|
+
# resp.operations #=> Array
|
193
|
+
# resp.operations[0].id #=> String
|
194
|
+
# resp.operations[0].resource_name #=> String
|
195
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
196
|
+
# resp.operations[0].created_at #=> Time
|
197
|
+
# resp.operations[0].location.availability_zone #=> String
|
198
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
199
|
+
# resp.operations[0].is_terminal #=> Boolean
|
200
|
+
# resp.operations[0].operation_details #=> String
|
201
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
202
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
203
|
+
# resp.operations[0].status_changed_at #=> Time
|
204
|
+
# resp.operations[0].error_code #=> String
|
205
|
+
# resp.operations[0].error_details #=> String
|
206
|
+
# @overload attach_static_ip(params = {})
|
207
|
+
# @param [Hash] params ({})
|
208
|
+
def attach_static_ip(params = {}, options = {})
|
209
|
+
req = build_request(:attach_static_ip, params)
|
210
|
+
req.send_request(options)
|
211
|
+
end
|
212
|
+
|
213
|
+
# Closes the public ports on a specific Amazon Lightsail instance.
|
214
|
+
# @option params [required, Types::PortInfo] :port_info
|
215
|
+
# Information about the public port you are trying to close.
|
216
|
+
# @option params [required, String] :instance_name
|
217
|
+
# The name of the instance on which you're attempting to close the
|
218
|
+
# public ports.
|
219
|
+
# @return [Types::CloseInstancePublicPortsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
220
|
+
#
|
221
|
+
# * {Types::CloseInstancePublicPortsResult#operation #operation} => Types::Operation
|
222
|
+
#
|
223
|
+
# @example Request syntax with placeholder values
|
224
|
+
# resp = client.close_instance_public_ports({
|
225
|
+
# port_info: { # required
|
226
|
+
# from_port: 1,
|
227
|
+
# to_port: 1,
|
228
|
+
# protocol: "tcp", # accepts tcp, all, udp
|
229
|
+
# },
|
230
|
+
# instance_name: "ResourceName", # required
|
231
|
+
# })
|
232
|
+
#
|
233
|
+
# @example Response structure
|
234
|
+
# resp.operation.id #=> String
|
235
|
+
# resp.operation.resource_name #=> String
|
236
|
+
# resp.operation.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
237
|
+
# resp.operation.created_at #=> Time
|
238
|
+
# resp.operation.location.availability_zone #=> String
|
239
|
+
# resp.operation.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
240
|
+
# resp.operation.is_terminal #=> Boolean
|
241
|
+
# resp.operation.operation_details #=> String
|
242
|
+
# resp.operation.operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
243
|
+
# resp.operation.status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
244
|
+
# resp.operation.status_changed_at #=> Time
|
245
|
+
# resp.operation.error_code #=> String
|
246
|
+
# resp.operation.error_details #=> String
|
247
|
+
# @overload close_instance_public_ports(params = {})
|
248
|
+
# @param [Hash] params ({})
|
249
|
+
def close_instance_public_ports(params = {}, options = {})
|
250
|
+
req = build_request(:close_instance_public_ports, params)
|
251
|
+
req.send_request(options)
|
252
|
+
end
|
253
|
+
|
254
|
+
# Creates a domain resource for the specified domain (e.g.,
|
255
|
+
# example.com).
|
256
|
+
# @option params [required, String] :domain_name
|
257
|
+
# The domain name to manage (e.g., `example.com`).
|
258
|
+
#
|
259
|
+
# <note markdown="1"> You cannot register a new domain name using Lightsail. You must
|
260
|
+
# register a domain name using Amazon Route 53 or another domain name
|
261
|
+
# registrar. If you have already registered your domain, you can enter
|
262
|
+
# its name in this parameter to manage the DNS records for that domain.
|
263
|
+
#
|
264
|
+
# </note>
|
265
|
+
# @return [Types::CreateDomainResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
266
|
+
#
|
267
|
+
# * {Types::CreateDomainResult#operation #operation} => Types::Operation
|
268
|
+
#
|
269
|
+
# @example Request syntax with placeholder values
|
270
|
+
# resp = client.create_domain({
|
271
|
+
# domain_name: "DomainName", # required
|
272
|
+
# })
|
273
|
+
#
|
274
|
+
# @example Response structure
|
275
|
+
# resp.operation.id #=> String
|
276
|
+
# resp.operation.resource_name #=> String
|
277
|
+
# resp.operation.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
278
|
+
# resp.operation.created_at #=> Time
|
279
|
+
# resp.operation.location.availability_zone #=> String
|
280
|
+
# resp.operation.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
281
|
+
# resp.operation.is_terminal #=> Boolean
|
282
|
+
# resp.operation.operation_details #=> String
|
283
|
+
# resp.operation.operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
284
|
+
# resp.operation.status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
285
|
+
# resp.operation.status_changed_at #=> Time
|
286
|
+
# resp.operation.error_code #=> String
|
287
|
+
# resp.operation.error_details #=> String
|
288
|
+
# @overload create_domain(params = {})
|
289
|
+
# @param [Hash] params ({})
|
290
|
+
def create_domain(params = {}, options = {})
|
291
|
+
req = build_request(:create_domain, params)
|
292
|
+
req.send_request(options)
|
293
|
+
end
|
294
|
+
|
295
|
+
# Creates one of the following entry records associated with the domain:
|
296
|
+
# A record, CNAME record, TXT record, or MX record.
|
297
|
+
# @option params [required, String] :domain_name
|
298
|
+
# The domain name (e.g., `example.com`) for which you want to create the
|
299
|
+
# domain entry.
|
300
|
+
# @option params [required, Types::DomainEntry] :domain_entry
|
301
|
+
# An array of key-value pairs containing information about the domain
|
302
|
+
# entry request.
|
303
|
+
# @return [Types::CreateDomainEntryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
304
|
+
#
|
305
|
+
# * {Types::CreateDomainEntryResult#operation #operation} => Types::Operation
|
306
|
+
#
|
307
|
+
# @example Request syntax with placeholder values
|
308
|
+
# resp = client.create_domain_entry({
|
309
|
+
# domain_name: "DomainName", # required
|
310
|
+
# domain_entry: { # required
|
311
|
+
# id: "NonEmptyString",
|
312
|
+
# name: "DomainName",
|
313
|
+
# target: "string",
|
314
|
+
# type: "DomainEntryType",
|
315
|
+
# options: {
|
316
|
+
# "DomainEntryOptionsKeys" => "string",
|
317
|
+
# },
|
318
|
+
# },
|
319
|
+
# })
|
320
|
+
#
|
321
|
+
# @example Response structure
|
322
|
+
# resp.operation.id #=> String
|
323
|
+
# resp.operation.resource_name #=> String
|
324
|
+
# resp.operation.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
325
|
+
# resp.operation.created_at #=> Time
|
326
|
+
# resp.operation.location.availability_zone #=> String
|
327
|
+
# resp.operation.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
328
|
+
# resp.operation.is_terminal #=> Boolean
|
329
|
+
# resp.operation.operation_details #=> String
|
330
|
+
# resp.operation.operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
331
|
+
# resp.operation.status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
332
|
+
# resp.operation.status_changed_at #=> Time
|
333
|
+
# resp.operation.error_code #=> String
|
334
|
+
# resp.operation.error_details #=> String
|
335
|
+
# @overload create_domain_entry(params = {})
|
336
|
+
# @param [Hash] params ({})
|
337
|
+
def create_domain_entry(params = {}, options = {})
|
338
|
+
req = build_request(:create_domain_entry, params)
|
339
|
+
req.send_request(options)
|
340
|
+
end
|
341
|
+
|
342
|
+
# Creates a snapshot of a specific virtual private server, or
|
343
|
+
# *instance*. You can use a snapshot to create a new instance that is
|
344
|
+
# based on that snapshot.
|
345
|
+
# @option params [required, String] :instance_snapshot_name
|
346
|
+
# The name for your new snapshot.
|
347
|
+
# @option params [required, String] :instance_name
|
348
|
+
# The Lightsail instance on which to base your snapshot.
|
349
|
+
# @return [Types::CreateInstanceSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
350
|
+
#
|
351
|
+
# * {Types::CreateInstanceSnapshotResult#operations #operations} => Array<Types::Operation>
|
352
|
+
#
|
353
|
+
# @example Request syntax with placeholder values
|
354
|
+
# resp = client.create_instance_snapshot({
|
355
|
+
# instance_snapshot_name: "ResourceName", # required
|
356
|
+
# instance_name: "ResourceName", # required
|
357
|
+
# })
|
358
|
+
#
|
359
|
+
# @example Response structure
|
360
|
+
# resp.operations #=> Array
|
361
|
+
# resp.operations[0].id #=> String
|
362
|
+
# resp.operations[0].resource_name #=> String
|
363
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
364
|
+
# resp.operations[0].created_at #=> Time
|
365
|
+
# resp.operations[0].location.availability_zone #=> String
|
366
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
367
|
+
# resp.operations[0].is_terminal #=> Boolean
|
368
|
+
# resp.operations[0].operation_details #=> String
|
369
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
370
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
371
|
+
# resp.operations[0].status_changed_at #=> Time
|
372
|
+
# resp.operations[0].error_code #=> String
|
373
|
+
# resp.operations[0].error_details #=> String
|
374
|
+
# @overload create_instance_snapshot(params = {})
|
375
|
+
# @param [Hash] params ({})
|
376
|
+
def create_instance_snapshot(params = {}, options = {})
|
377
|
+
req = build_request(:create_instance_snapshot, params)
|
378
|
+
req.send_request(options)
|
379
|
+
end
|
380
|
+
|
381
|
+
# Creates one or more Amazon Lightsail virtual private servers, or
|
382
|
+
# *instances*.
|
383
|
+
# @option params [required, Array<String>] :instance_names
|
384
|
+
# The names to use for your new Lightsail instances. Separate multiple
|
385
|
+
# values using quotation marks and commas, for example:
|
386
|
+
# `["MyFirstInstance","MySecondInstance"]`
|
387
|
+
# @option params [required, String] :availability_zone
|
388
|
+
# The Availability Zone in which to create your instance. Use the
|
389
|
+
# following format: `us-east-1a` (case sensitive).
|
390
|
+
# @option params [String] :custom_image_name
|
391
|
+
# The name for your custom image.
|
392
|
+
# @option params [required, String] :blueprint_id
|
393
|
+
# The ID for a virtual private server image (e.g., `app_wordpress_4_4`
|
394
|
+
# or `app_lamp_7_0`). Use the get blueprints operation to return a list
|
395
|
+
# of available images (or *blueprints*).
|
396
|
+
# @option params [required, String] :bundle_id
|
397
|
+
# The bundle of specification information for your virtual private
|
398
|
+
# server (or *instance*), including the pricing plan (e.g.,
|
399
|
+
# `micro_1_0`).
|
400
|
+
# @option params [String] :user_data
|
401
|
+
# A launch script you can create that configures a server with
|
402
|
+
# additional user data. For example, you might want to run `apt-get –y
|
403
|
+
# update`.
|
404
|
+
#
|
405
|
+
# <note markdown="1"> Depending on the machine image you choose, the command to get software
|
406
|
+
# on your instance varies. Amazon Linux and CentOS use `yum`, Debian and
|
407
|
+
# Ubuntu use `apt-get`, and FreeBSD uses `pkg`. For a complete list, see
|
408
|
+
# the [Dev Guide][1].
|
409
|
+
#
|
410
|
+
# </note>
|
411
|
+
#
|
412
|
+
#
|
413
|
+
#
|
414
|
+
# [1]: http://lightsail.aws.amazon.com/ls/docs/getting-started/articles/pre-installed-apps
|
415
|
+
# @option params [String] :key_pair_name
|
416
|
+
# The name of your key pair.
|
417
|
+
# @return [Types::CreateInstancesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
418
|
+
#
|
419
|
+
# * {Types::CreateInstancesResult#operations #operations} => Array<Types::Operation>
|
420
|
+
#
|
421
|
+
# @example Request syntax with placeholder values
|
422
|
+
# resp = client.create_instances({
|
423
|
+
# instance_names: ["string"], # required
|
424
|
+
# availability_zone: "string", # required
|
425
|
+
# custom_image_name: "ResourceName",
|
426
|
+
# blueprint_id: "NonEmptyString", # required
|
427
|
+
# bundle_id: "NonEmptyString", # required
|
428
|
+
# user_data: "string",
|
429
|
+
# key_pair_name: "ResourceName",
|
430
|
+
# })
|
431
|
+
#
|
432
|
+
# @example Response structure
|
433
|
+
# resp.operations #=> Array
|
434
|
+
# resp.operations[0].id #=> String
|
435
|
+
# resp.operations[0].resource_name #=> String
|
436
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
437
|
+
# resp.operations[0].created_at #=> Time
|
438
|
+
# resp.operations[0].location.availability_zone #=> String
|
439
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
440
|
+
# resp.operations[0].is_terminal #=> Boolean
|
441
|
+
# resp.operations[0].operation_details #=> String
|
442
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
443
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
444
|
+
# resp.operations[0].status_changed_at #=> Time
|
445
|
+
# resp.operations[0].error_code #=> String
|
446
|
+
# resp.operations[0].error_details #=> String
|
447
|
+
# @overload create_instances(params = {})
|
448
|
+
# @param [Hash] params ({})
|
449
|
+
def create_instances(params = {}, options = {})
|
450
|
+
req = build_request(:create_instances, params)
|
451
|
+
req.send_request(options)
|
452
|
+
end
|
453
|
+
|
454
|
+
# Uses a specific snapshot as a blueprint for creating one or more new
|
455
|
+
# instances that are based on that identical configuration.
|
456
|
+
# @option params [required, Array<String>] :instance_names
|
457
|
+
# The names for your new instances.
|
458
|
+
# @option params [required, String] :availability_zone
|
459
|
+
# The Availability Zone where you want to create your instances. Use the
|
460
|
+
# following formatting: `us-east-1a` (case sensitive).
|
461
|
+
# @option params [required, String] :instance_snapshot_name
|
462
|
+
# The name of the instance snapshot on which you are basing your new
|
463
|
+
# instances. Use the get instance snapshots operation to return
|
464
|
+
# information about your existing snapshots.
|
465
|
+
# @option params [required, String] :bundle_id
|
466
|
+
# The bundle of specification information for your virtual private
|
467
|
+
# server (or *instance*), including the pricing plan (e.g.,
|
468
|
+
# `micro_1_0`).
|
469
|
+
# @option params [String] :user_data
|
470
|
+
# You can create a launch script that configures a server with
|
471
|
+
# additional user data. For example, `apt-get –y update`.
|
472
|
+
#
|
473
|
+
# <note markdown="1"> Depending on the machine image you choose, the command to get software
|
474
|
+
# on your instance varies. Amazon Linux and CentOS use `yum`, Debian and
|
475
|
+
# Ubuntu use `apt-get`, and FreeBSD uses `pkg`. For a complete list, see
|
476
|
+
# the [Dev Guide][1].
|
477
|
+
#
|
478
|
+
# </note>
|
479
|
+
#
|
480
|
+
#
|
481
|
+
#
|
482
|
+
# [1]: http://lightsail.aws.amazon.com/ls/docs/getting-started/articles/pre-installed-apps
|
483
|
+
# @option params [String] :key_pair_name
|
484
|
+
# The name for your key pair.
|
485
|
+
# @return [Types::CreateInstancesFromSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
486
|
+
#
|
487
|
+
# * {Types::CreateInstancesFromSnapshotResult#operations #operations} => Array<Types::Operation>
|
488
|
+
#
|
489
|
+
# @example Request syntax with placeholder values
|
490
|
+
# resp = client.create_instances_from_snapshot({
|
491
|
+
# instance_names: ["string"], # required
|
492
|
+
# availability_zone: "string", # required
|
493
|
+
# instance_snapshot_name: "ResourceName", # required
|
494
|
+
# bundle_id: "NonEmptyString", # required
|
495
|
+
# user_data: "string",
|
496
|
+
# key_pair_name: "ResourceName",
|
497
|
+
# })
|
498
|
+
#
|
499
|
+
# @example Response structure
|
500
|
+
# resp.operations #=> Array
|
501
|
+
# resp.operations[0].id #=> String
|
502
|
+
# resp.operations[0].resource_name #=> String
|
503
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
504
|
+
# resp.operations[0].created_at #=> Time
|
505
|
+
# resp.operations[0].location.availability_zone #=> String
|
506
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
507
|
+
# resp.operations[0].is_terminal #=> Boolean
|
508
|
+
# resp.operations[0].operation_details #=> String
|
509
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
510
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
511
|
+
# resp.operations[0].status_changed_at #=> Time
|
512
|
+
# resp.operations[0].error_code #=> String
|
513
|
+
# resp.operations[0].error_details #=> String
|
514
|
+
# @overload create_instances_from_snapshot(params = {})
|
515
|
+
# @param [Hash] params ({})
|
516
|
+
def create_instances_from_snapshot(params = {}, options = {})
|
517
|
+
req = build_request(:create_instances_from_snapshot, params)
|
518
|
+
req.send_request(options)
|
519
|
+
end
|
520
|
+
|
521
|
+
# Creates sn SSH key pair.
|
522
|
+
# @option params [required, String] :key_pair_name
|
523
|
+
# The name for your new key pair.
|
524
|
+
# @return [Types::CreateKeyPairResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
525
|
+
#
|
526
|
+
# * {Types::CreateKeyPairResult#key_pair #keyPair} => Types::KeyPair
|
527
|
+
# * {Types::CreateKeyPairResult#public_key_base_64 #publicKeyBase64} => String
|
528
|
+
# * {Types::CreateKeyPairResult#private_key_base_64 #privateKeyBase64} => String
|
529
|
+
# * {Types::CreateKeyPairResult#operation #operation} => Types::Operation
|
530
|
+
#
|
531
|
+
# @example Request syntax with placeholder values
|
532
|
+
# resp = client.create_key_pair({
|
533
|
+
# key_pair_name: "ResourceName", # required
|
534
|
+
# })
|
535
|
+
#
|
536
|
+
# @example Response structure
|
537
|
+
# resp.key_pair.name #=> String
|
538
|
+
# resp.key_pair.arn #=> String
|
539
|
+
# resp.key_pair.support_code #=> String
|
540
|
+
# resp.key_pair.created_at #=> Time
|
541
|
+
# resp.key_pair.location.availability_zone #=> String
|
542
|
+
# resp.key_pair.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
543
|
+
# resp.key_pair.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
544
|
+
# resp.key_pair.fingerprint #=> String
|
545
|
+
# resp.public_key_base_64 #=> String
|
546
|
+
# resp.private_key_base_64 #=> String
|
547
|
+
# resp.operation.id #=> String
|
548
|
+
# resp.operation.resource_name #=> String
|
549
|
+
# resp.operation.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
550
|
+
# resp.operation.created_at #=> Time
|
551
|
+
# resp.operation.location.availability_zone #=> String
|
552
|
+
# resp.operation.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
553
|
+
# resp.operation.is_terminal #=> Boolean
|
554
|
+
# resp.operation.operation_details #=> String
|
555
|
+
# resp.operation.operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
556
|
+
# resp.operation.status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
557
|
+
# resp.operation.status_changed_at #=> Time
|
558
|
+
# resp.operation.error_code #=> String
|
559
|
+
# resp.operation.error_details #=> String
|
560
|
+
# @overload create_key_pair(params = {})
|
561
|
+
# @param [Hash] params ({})
|
562
|
+
def create_key_pair(params = {}, options = {})
|
563
|
+
req = build_request(:create_key_pair, params)
|
564
|
+
req.send_request(options)
|
565
|
+
end
|
566
|
+
|
567
|
+
# Deletes the specified domain recordset and all of its domain records.
|
568
|
+
# @option params [required, String] :domain_name
|
569
|
+
# The specific domain name to delete.
|
570
|
+
# @return [Types::DeleteDomainResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
571
|
+
#
|
572
|
+
# * {Types::DeleteDomainResult#operation #operation} => Types::Operation
|
573
|
+
#
|
574
|
+
# @example Request syntax with placeholder values
|
575
|
+
# resp = client.delete_domain({
|
576
|
+
# domain_name: "DomainName", # required
|
577
|
+
# })
|
578
|
+
#
|
579
|
+
# @example Response structure
|
580
|
+
# resp.operation.id #=> String
|
581
|
+
# resp.operation.resource_name #=> String
|
582
|
+
# resp.operation.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
583
|
+
# resp.operation.created_at #=> Time
|
584
|
+
# resp.operation.location.availability_zone #=> String
|
585
|
+
# resp.operation.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
586
|
+
# resp.operation.is_terminal #=> Boolean
|
587
|
+
# resp.operation.operation_details #=> String
|
588
|
+
# resp.operation.operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
589
|
+
# resp.operation.status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
590
|
+
# resp.operation.status_changed_at #=> Time
|
591
|
+
# resp.operation.error_code #=> String
|
592
|
+
# resp.operation.error_details #=> String
|
593
|
+
# @overload delete_domain(params = {})
|
594
|
+
# @param [Hash] params ({})
|
595
|
+
def delete_domain(params = {}, options = {})
|
596
|
+
req = build_request(:delete_domain, params)
|
597
|
+
req.send_request(options)
|
598
|
+
end
|
599
|
+
|
600
|
+
# Deletes a specific domain entry.
|
601
|
+
# @option params [required, String] :domain_name
|
602
|
+
# The name of the domain entry to delete.
|
603
|
+
# @option params [required, Types::DomainEntry] :domain_entry
|
604
|
+
# An array of key-value pairs containing information about your domain
|
605
|
+
# entries.
|
606
|
+
# @return [Types::DeleteDomainEntryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
607
|
+
#
|
608
|
+
# * {Types::DeleteDomainEntryResult#operation #operation} => Types::Operation
|
609
|
+
#
|
610
|
+
# @example Request syntax with placeholder values
|
611
|
+
# resp = client.delete_domain_entry({
|
612
|
+
# domain_name: "DomainName", # required
|
613
|
+
# domain_entry: { # required
|
614
|
+
# id: "NonEmptyString",
|
615
|
+
# name: "DomainName",
|
616
|
+
# target: "string",
|
617
|
+
# type: "DomainEntryType",
|
618
|
+
# options: {
|
619
|
+
# "DomainEntryOptionsKeys" => "string",
|
620
|
+
# },
|
621
|
+
# },
|
622
|
+
# })
|
623
|
+
#
|
624
|
+
# @example Response structure
|
625
|
+
# resp.operation.id #=> String
|
626
|
+
# resp.operation.resource_name #=> String
|
627
|
+
# resp.operation.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
628
|
+
# resp.operation.created_at #=> Time
|
629
|
+
# resp.operation.location.availability_zone #=> String
|
630
|
+
# resp.operation.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
631
|
+
# resp.operation.is_terminal #=> Boolean
|
632
|
+
# resp.operation.operation_details #=> String
|
633
|
+
# resp.operation.operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
634
|
+
# resp.operation.status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
635
|
+
# resp.operation.status_changed_at #=> Time
|
636
|
+
# resp.operation.error_code #=> String
|
637
|
+
# resp.operation.error_details #=> String
|
638
|
+
# @overload delete_domain_entry(params = {})
|
639
|
+
# @param [Hash] params ({})
|
640
|
+
def delete_domain_entry(params = {}, options = {})
|
641
|
+
req = build_request(:delete_domain_entry, params)
|
642
|
+
req.send_request(options)
|
643
|
+
end
|
644
|
+
|
645
|
+
# Deletes a specific Amazon Lightsail virtual private server, or
|
646
|
+
# *instance*.
|
647
|
+
# @option params [required, String] :instance_name
|
648
|
+
# The name of the instance to delete.
|
649
|
+
# @return [Types::DeleteInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
650
|
+
#
|
651
|
+
# * {Types::DeleteInstanceResult#operations #operations} => Array<Types::Operation>
|
652
|
+
#
|
653
|
+
# @example Request syntax with placeholder values
|
654
|
+
# resp = client.delete_instance({
|
655
|
+
# instance_name: "ResourceName", # required
|
656
|
+
# })
|
657
|
+
#
|
658
|
+
# @example Response structure
|
659
|
+
# resp.operations #=> Array
|
660
|
+
# resp.operations[0].id #=> String
|
661
|
+
# resp.operations[0].resource_name #=> String
|
662
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
663
|
+
# resp.operations[0].created_at #=> Time
|
664
|
+
# resp.operations[0].location.availability_zone #=> String
|
665
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
666
|
+
# resp.operations[0].is_terminal #=> Boolean
|
667
|
+
# resp.operations[0].operation_details #=> String
|
668
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
669
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
670
|
+
# resp.operations[0].status_changed_at #=> Time
|
671
|
+
# resp.operations[0].error_code #=> String
|
672
|
+
# resp.operations[0].error_details #=> String
|
673
|
+
# @overload delete_instance(params = {})
|
674
|
+
# @param [Hash] params ({})
|
675
|
+
def delete_instance(params = {}, options = {})
|
676
|
+
req = build_request(:delete_instance, params)
|
677
|
+
req.send_request(options)
|
678
|
+
end
|
679
|
+
|
680
|
+
# Deletes a specific snapshot of a virtual private server (or
|
681
|
+
# *instance*).
|
682
|
+
# @option params [required, String] :instance_snapshot_name
|
683
|
+
# The name of the snapshot to delete.
|
684
|
+
# @return [Types::DeleteInstanceSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
685
|
+
#
|
686
|
+
# * {Types::DeleteInstanceSnapshotResult#operations #operations} => Array<Types::Operation>
|
687
|
+
#
|
688
|
+
# @example Request syntax with placeholder values
|
689
|
+
# resp = client.delete_instance_snapshot({
|
690
|
+
# instance_snapshot_name: "ResourceName", # required
|
691
|
+
# })
|
692
|
+
#
|
693
|
+
# @example Response structure
|
694
|
+
# resp.operations #=> Array
|
695
|
+
# resp.operations[0].id #=> String
|
696
|
+
# resp.operations[0].resource_name #=> String
|
697
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
698
|
+
# resp.operations[0].created_at #=> Time
|
699
|
+
# resp.operations[0].location.availability_zone #=> String
|
700
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
701
|
+
# resp.operations[0].is_terminal #=> Boolean
|
702
|
+
# resp.operations[0].operation_details #=> String
|
703
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
704
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
705
|
+
# resp.operations[0].status_changed_at #=> Time
|
706
|
+
# resp.operations[0].error_code #=> String
|
707
|
+
# resp.operations[0].error_details #=> String
|
708
|
+
# @overload delete_instance_snapshot(params = {})
|
709
|
+
# @param [Hash] params ({})
|
710
|
+
def delete_instance_snapshot(params = {}, options = {})
|
711
|
+
req = build_request(:delete_instance_snapshot, params)
|
712
|
+
req.send_request(options)
|
713
|
+
end
|
714
|
+
|
715
|
+
# Deletes a specific SSH key pair.
|
716
|
+
# @option params [required, String] :key_pair_name
|
717
|
+
# The name of the key pair to delete.
|
718
|
+
# @return [Types::DeleteKeyPairResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
719
|
+
#
|
720
|
+
# * {Types::DeleteKeyPairResult#operation #operation} => Types::Operation
|
721
|
+
#
|
722
|
+
# @example Request syntax with placeholder values
|
723
|
+
# resp = client.delete_key_pair({
|
724
|
+
# key_pair_name: "ResourceName", # required
|
725
|
+
# })
|
726
|
+
#
|
727
|
+
# @example Response structure
|
728
|
+
# resp.operation.id #=> String
|
729
|
+
# resp.operation.resource_name #=> String
|
730
|
+
# resp.operation.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
731
|
+
# resp.operation.created_at #=> Time
|
732
|
+
# resp.operation.location.availability_zone #=> String
|
733
|
+
# resp.operation.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
734
|
+
# resp.operation.is_terminal #=> Boolean
|
735
|
+
# resp.operation.operation_details #=> String
|
736
|
+
# resp.operation.operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
737
|
+
# resp.operation.status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
738
|
+
# resp.operation.status_changed_at #=> Time
|
739
|
+
# resp.operation.error_code #=> String
|
740
|
+
# resp.operation.error_details #=> String
|
741
|
+
# @overload delete_key_pair(params = {})
|
742
|
+
# @param [Hash] params ({})
|
743
|
+
def delete_key_pair(params = {}, options = {})
|
744
|
+
req = build_request(:delete_key_pair, params)
|
745
|
+
req.send_request(options)
|
746
|
+
end
|
747
|
+
|
748
|
+
# Detaches a static IP from the Amazon Lightsail instance to which it is
|
749
|
+
# attached.
|
750
|
+
# @option params [required, String] :static_ip_name
|
751
|
+
# The name of the static IP to detach from the instance.
|
752
|
+
# @return [Types::DetachStaticIpResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
753
|
+
#
|
754
|
+
# * {Types::DetachStaticIpResult#operations #operations} => Array<Types::Operation>
|
755
|
+
#
|
756
|
+
# @example Request syntax with placeholder values
|
757
|
+
# resp = client.detach_static_ip({
|
758
|
+
# static_ip_name: "ResourceName", # required
|
759
|
+
# })
|
760
|
+
#
|
761
|
+
# @example Response structure
|
762
|
+
# resp.operations #=> Array
|
763
|
+
# resp.operations[0].id #=> String
|
764
|
+
# resp.operations[0].resource_name #=> String
|
765
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
766
|
+
# resp.operations[0].created_at #=> Time
|
767
|
+
# resp.operations[0].location.availability_zone #=> String
|
768
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
769
|
+
# resp.operations[0].is_terminal #=> Boolean
|
770
|
+
# resp.operations[0].operation_details #=> String
|
771
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
772
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
773
|
+
# resp.operations[0].status_changed_at #=> Time
|
774
|
+
# resp.operations[0].error_code #=> String
|
775
|
+
# resp.operations[0].error_details #=> String
|
776
|
+
# @overload detach_static_ip(params = {})
|
777
|
+
# @param [Hash] params ({})
|
778
|
+
def detach_static_ip(params = {}, options = {})
|
779
|
+
req = build_request(:detach_static_ip, params)
|
780
|
+
req.send_request(options)
|
781
|
+
end
|
782
|
+
|
783
|
+
# Downloads the default SSH key pair from the user's account.
|
784
|
+
# @return [Types::DownloadDefaultKeyPairResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
785
|
+
#
|
786
|
+
# * {Types::DownloadDefaultKeyPairResult#public_key_base_64 #publicKeyBase64} => String
|
787
|
+
# * {Types::DownloadDefaultKeyPairResult#private_key_base_64 #privateKeyBase64} => String
|
788
|
+
#
|
789
|
+
# @example Request syntax with placeholder values
|
790
|
+
# resp = client.download_default_key_pair()
|
791
|
+
#
|
792
|
+
# @example Response structure
|
793
|
+
# resp.public_key_base_64 #=> String
|
794
|
+
# resp.private_key_base_64 #=> String
|
795
|
+
# @overload download_default_key_pair(params = {})
|
796
|
+
# @param [Hash] params ({})
|
797
|
+
def download_default_key_pair(params = {}, options = {})
|
798
|
+
req = build_request(:download_default_key_pair, params)
|
799
|
+
req.send_request(options)
|
800
|
+
end
|
801
|
+
|
802
|
+
# Returns the names of all active (not deleted) resources.
|
803
|
+
# @option params [String] :page_token
|
804
|
+
# A token used for paginating results from your get active names
|
805
|
+
# request.
|
806
|
+
# @return [Types::GetActiveNamesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
807
|
+
#
|
808
|
+
# * {Types::GetActiveNamesResult#active_names #activeNames} => Array<String>
|
809
|
+
# * {Types::GetActiveNamesResult#next_page_token #nextPageToken} => String
|
810
|
+
#
|
811
|
+
# @example Request syntax with placeholder values
|
812
|
+
# resp = client.get_active_names({
|
813
|
+
# page_token: "string",
|
814
|
+
# })
|
815
|
+
#
|
816
|
+
# @example Response structure
|
817
|
+
# resp.active_names #=> Array
|
818
|
+
# resp.active_names[0] #=> String
|
819
|
+
# resp.next_page_token #=> String
|
820
|
+
# @overload get_active_names(params = {})
|
821
|
+
# @param [Hash] params ({})
|
822
|
+
def get_active_names(params = {}, options = {})
|
823
|
+
req = build_request(:get_active_names, params)
|
824
|
+
req.send_request(options)
|
825
|
+
end
|
826
|
+
|
827
|
+
# Returns the list of available instance images, or *blueprints*. You
|
828
|
+
# can use a blueprint to create a new virtual private server already
|
829
|
+
# running a specific operating system, as well as a preinstalled app or
|
830
|
+
# development stack. The software each instance is running depends on
|
831
|
+
# the blueprint image you choose.
|
832
|
+
# @option params [Boolean] :include_inactive
|
833
|
+
# A Boolean value indicating whether to include inactive results in your
|
834
|
+
# request.
|
835
|
+
# @option params [String] :page_token
|
836
|
+
# A token used for advancing to the next page of results from your get
|
837
|
+
# blueprints request.
|
838
|
+
# @return [Types::GetBlueprintsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
839
|
+
#
|
840
|
+
# * {Types::GetBlueprintsResult#blueprints #blueprints} => Array<Types::Blueprint>
|
841
|
+
# * {Types::GetBlueprintsResult#next_page_token #nextPageToken} => String
|
842
|
+
#
|
843
|
+
# @example Request syntax with placeholder values
|
844
|
+
# resp = client.get_blueprints({
|
845
|
+
# include_inactive: false,
|
846
|
+
# page_token: "string",
|
847
|
+
# })
|
848
|
+
#
|
849
|
+
# @example Response structure
|
850
|
+
# resp.blueprints #=> Array
|
851
|
+
# resp.blueprints[0].blueprint_id #=> String
|
852
|
+
# resp.blueprints[0].name #=> String
|
853
|
+
# resp.blueprints[0].group #=> String
|
854
|
+
# resp.blueprints[0].type #=> String, one of "os", "app"
|
855
|
+
# resp.blueprints[0].description #=> String
|
856
|
+
# resp.blueprints[0].is_active #=> Boolean
|
857
|
+
# resp.blueprints[0].min_power #=> Integer
|
858
|
+
# resp.blueprints[0].version #=> String
|
859
|
+
# resp.blueprints[0].version_code #=> String
|
860
|
+
# resp.blueprints[0].product_url #=> String
|
861
|
+
# resp.blueprints[0].license_url #=> String
|
862
|
+
# resp.next_page_token #=> String
|
863
|
+
# @overload get_blueprints(params = {})
|
864
|
+
# @param [Hash] params ({})
|
865
|
+
def get_blueprints(params = {}, options = {})
|
866
|
+
req = build_request(:get_blueprints, params)
|
867
|
+
req.send_request(options)
|
868
|
+
end
|
869
|
+
|
870
|
+
# Returns the list of bundles that are available for purchase. A bundle
|
871
|
+
# describes the specs for your virtual private server (or *instance*).
|
872
|
+
# @option params [Boolean] :include_inactive
|
873
|
+
# A Boolean value that indicates whether to include inactive bundle
|
874
|
+
# results in your request.
|
875
|
+
# @option params [String] :page_token
|
876
|
+
# A token used for advancing to the next page of results from your get
|
877
|
+
# bundles request.
|
878
|
+
# @return [Types::GetBundlesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
879
|
+
#
|
880
|
+
# * {Types::GetBundlesResult#bundles #bundles} => Array<Types::Bundle>
|
881
|
+
# * {Types::GetBundlesResult#next_page_token #nextPageToken} => String
|
882
|
+
#
|
883
|
+
# @example Request syntax with placeholder values
|
884
|
+
# resp = client.get_bundles({
|
885
|
+
# include_inactive: false,
|
886
|
+
# page_token: "string",
|
887
|
+
# })
|
888
|
+
#
|
889
|
+
# @example Response structure
|
890
|
+
# resp.bundles #=> Array
|
891
|
+
# resp.bundles[0].price #=> Float
|
892
|
+
# resp.bundles[0].cpu_count #=> Integer
|
893
|
+
# resp.bundles[0].disk_size_in_gb #=> Integer
|
894
|
+
# resp.bundles[0].bundle_id #=> String
|
895
|
+
# resp.bundles[0].instance_type #=> String
|
896
|
+
# resp.bundles[0].is_active #=> Boolean
|
897
|
+
# resp.bundles[0].name #=> String
|
898
|
+
# resp.bundles[0].power #=> Integer
|
899
|
+
# resp.bundles[0].ram_size_in_gb #=> Float
|
900
|
+
# resp.bundles[0].transfer_per_month_in_gb #=> Integer
|
901
|
+
# resp.next_page_token #=> String
|
902
|
+
# @overload get_bundles(params = {})
|
903
|
+
# @param [Hash] params ({})
|
904
|
+
def get_bundles(params = {}, options = {})
|
905
|
+
req = build_request(:get_bundles, params)
|
906
|
+
req.send_request(options)
|
907
|
+
end
|
908
|
+
|
909
|
+
# Returns information about a specific domain recordset.
|
910
|
+
# @option params [required, String] :domain_name
|
911
|
+
# The domain name for which your want to return information about.
|
912
|
+
# @return [Types::GetDomainResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
913
|
+
#
|
914
|
+
# * {Types::GetDomainResult#domain #domain} => Types::Domain
|
915
|
+
#
|
916
|
+
# @example Request syntax with placeholder values
|
917
|
+
# resp = client.get_domain({
|
918
|
+
# domain_name: "DomainName", # required
|
919
|
+
# })
|
920
|
+
#
|
921
|
+
# @example Response structure
|
922
|
+
# resp.domain.name #=> String
|
923
|
+
# resp.domain.arn #=> String
|
924
|
+
# resp.domain.support_code #=> String
|
925
|
+
# resp.domain.created_at #=> Time
|
926
|
+
# resp.domain.location.availability_zone #=> String
|
927
|
+
# resp.domain.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
928
|
+
# resp.domain.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
929
|
+
# resp.domain.domain_entries #=> Array
|
930
|
+
# resp.domain.domain_entries[0].id #=> String
|
931
|
+
# resp.domain.domain_entries[0].name #=> String
|
932
|
+
# resp.domain.domain_entries[0].target #=> String
|
933
|
+
# resp.domain.domain_entries[0].type #=> String
|
934
|
+
# resp.domain.domain_entries[0].options #=> Hash
|
935
|
+
# resp.domain.domain_entries[0].options["DomainEntryOptionsKeys"] #=> String
|
936
|
+
# @overload get_domain(params = {})
|
937
|
+
# @param [Hash] params ({})
|
938
|
+
def get_domain(params = {}, options = {})
|
939
|
+
req = build_request(:get_domain, params)
|
940
|
+
req.send_request(options)
|
941
|
+
end
|
942
|
+
|
943
|
+
# Returns a list of all domains in the user's account.
|
944
|
+
# @option params [String] :page_token
|
945
|
+
# A token used for advancing to the next page of results from your get
|
946
|
+
# domains request.
|
947
|
+
# @return [Types::GetDomainsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
948
|
+
#
|
949
|
+
# * {Types::GetDomainsResult#domains #domains} => Array<Types::Domain>
|
950
|
+
# * {Types::GetDomainsResult#next_page_token #nextPageToken} => String
|
951
|
+
#
|
952
|
+
# @example Request syntax with placeholder values
|
953
|
+
# resp = client.get_domains({
|
954
|
+
# page_token: "string",
|
955
|
+
# })
|
956
|
+
#
|
957
|
+
# @example Response structure
|
958
|
+
# resp.domains #=> Array
|
959
|
+
# resp.domains[0].name #=> String
|
960
|
+
# resp.domains[0].arn #=> String
|
961
|
+
# resp.domains[0].support_code #=> String
|
962
|
+
# resp.domains[0].created_at #=> Time
|
963
|
+
# resp.domains[0].location.availability_zone #=> String
|
964
|
+
# resp.domains[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
965
|
+
# resp.domains[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
966
|
+
# resp.domains[0].domain_entries #=> Array
|
967
|
+
# resp.domains[0].domain_entries[0].id #=> String
|
968
|
+
# resp.domains[0].domain_entries[0].name #=> String
|
969
|
+
# resp.domains[0].domain_entries[0].target #=> String
|
970
|
+
# resp.domains[0].domain_entries[0].type #=> String
|
971
|
+
# resp.domains[0].domain_entries[0].options #=> Hash
|
972
|
+
# resp.domains[0].domain_entries[0].options["DomainEntryOptionsKeys"] #=> String
|
973
|
+
# resp.next_page_token #=> String
|
974
|
+
# @overload get_domains(params = {})
|
975
|
+
# @param [Hash] params ({})
|
976
|
+
def get_domains(params = {}, options = {})
|
977
|
+
req = build_request(:get_domains, params)
|
978
|
+
req.send_request(options)
|
979
|
+
end
|
980
|
+
|
981
|
+
# Returns information about a specific Amazon Lightsail instance, which
|
982
|
+
# is a virtual private server.
|
983
|
+
# @option params [required, String] :instance_name
|
984
|
+
# The name of the instance.
|
985
|
+
# @return [Types::GetInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
986
|
+
#
|
987
|
+
# * {Types::GetInstanceResult#instance #instance} => Types::Instance
|
988
|
+
#
|
989
|
+
# @example Request syntax with placeholder values
|
990
|
+
# resp = client.get_instance({
|
991
|
+
# instance_name: "ResourceName", # required
|
992
|
+
# })
|
993
|
+
#
|
994
|
+
# @example Response structure
|
995
|
+
# resp.instance.name #=> String
|
996
|
+
# resp.instance.arn #=> String
|
997
|
+
# resp.instance.support_code #=> String
|
998
|
+
# resp.instance.created_at #=> Time
|
999
|
+
# resp.instance.location.availability_zone #=> String
|
1000
|
+
# resp.instance.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1001
|
+
# resp.instance.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1002
|
+
# resp.instance.blueprint_id #=> String
|
1003
|
+
# resp.instance.blueprint_name #=> String
|
1004
|
+
# resp.instance.bundle_id #=> String
|
1005
|
+
# resp.instance.is_static_ip #=> Boolean
|
1006
|
+
# resp.instance.private_ip_address #=> String
|
1007
|
+
# resp.instance.public_ip_address #=> String
|
1008
|
+
# resp.instance.ipv6_address #=> String
|
1009
|
+
# resp.instance.hardware.cpu_count #=> Integer
|
1010
|
+
# resp.instance.hardware.disks #=> Array
|
1011
|
+
# resp.instance.hardware.disks[0].name #=> String
|
1012
|
+
# resp.instance.hardware.disks[0].arn #=> String
|
1013
|
+
# resp.instance.hardware.disks[0].support_code #=> String
|
1014
|
+
# resp.instance.hardware.disks[0].created_at #=> Time
|
1015
|
+
# resp.instance.hardware.disks[0].location.availability_zone #=> String
|
1016
|
+
# resp.instance.hardware.disks[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1017
|
+
# resp.instance.hardware.disks[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1018
|
+
# resp.instance.hardware.disks[0].size_in_gb #=> Integer
|
1019
|
+
# resp.instance.hardware.disks[0].gb_in_use #=> Integer
|
1020
|
+
# resp.instance.hardware.disks[0].is_system_disk #=> Boolean
|
1021
|
+
# resp.instance.hardware.disks[0].iops #=> Integer
|
1022
|
+
# resp.instance.hardware.disks[0].path #=> String
|
1023
|
+
# resp.instance.hardware.disks[0].attached_to #=> String
|
1024
|
+
# resp.instance.hardware.disks[0].is_attached #=> Boolean
|
1025
|
+
# resp.instance.hardware.disks[0].attachment_state #=> String
|
1026
|
+
# resp.instance.hardware.ram_size_in_gb #=> Float
|
1027
|
+
# resp.instance.networking.monthly_transfer.gb_per_month_allocated #=> Integer
|
1028
|
+
# resp.instance.networking.ports #=> Array
|
1029
|
+
# resp.instance.networking.ports[0].from_port #=> Integer
|
1030
|
+
# resp.instance.networking.ports[0].to_port #=> Integer
|
1031
|
+
# resp.instance.networking.ports[0].protocol #=> String, one of "tcp", "all", "udp"
|
1032
|
+
# resp.instance.networking.ports[0].access_from #=> String
|
1033
|
+
# resp.instance.networking.ports[0].access_type #=> String, one of "Public", "Private"
|
1034
|
+
# resp.instance.networking.ports[0].common_name #=> String
|
1035
|
+
# resp.instance.networking.ports[0].access_direction #=> String, one of "inbound", "outbound"
|
1036
|
+
# resp.instance.state.code #=> Integer
|
1037
|
+
# resp.instance.state.name #=> String
|
1038
|
+
# resp.instance.username #=> String
|
1039
|
+
# resp.instance.ssh_key_name #=> String
|
1040
|
+
# @overload get_instance(params = {})
|
1041
|
+
# @param [Hash] params ({})
|
1042
|
+
def get_instance(params = {}, options = {})
|
1043
|
+
req = build_request(:get_instance, params)
|
1044
|
+
req.send_request(options)
|
1045
|
+
end
|
1046
|
+
|
1047
|
+
# Returns temporary SSH keys you can use to connect to a specific
|
1048
|
+
# virtual private server, or *instance*.
|
1049
|
+
# @option params [required, String] :instance_name
|
1050
|
+
# The name of the instance to access.
|
1051
|
+
# @option params [String] :protocol
|
1052
|
+
# The protocol to use to connect to your instance. Defaults to `ssh`.
|
1053
|
+
# @return [Types::GetInstanceAccessDetailsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1054
|
+
#
|
1055
|
+
# * {Types::GetInstanceAccessDetailsResult#access_details #accessDetails} => Types::InstanceAccessDetails
|
1056
|
+
#
|
1057
|
+
# @example Request syntax with placeholder values
|
1058
|
+
# resp = client.get_instance_access_details({
|
1059
|
+
# instance_name: "ResourceName", # required
|
1060
|
+
# protocol: "ssh", # accepts ssh, rdp
|
1061
|
+
# })
|
1062
|
+
#
|
1063
|
+
# @example Response structure
|
1064
|
+
# resp.access_details.cert_key #=> String
|
1065
|
+
# resp.access_details.expires_at #=> Time
|
1066
|
+
# resp.access_details.ip_address #=> String
|
1067
|
+
# resp.access_details.password #=> String
|
1068
|
+
# resp.access_details.private_key #=> String
|
1069
|
+
# resp.access_details.protocol #=> String, one of "ssh", "rdp"
|
1070
|
+
# resp.access_details.instance_name #=> String
|
1071
|
+
# resp.access_details.username #=> String
|
1072
|
+
# @overload get_instance_access_details(params = {})
|
1073
|
+
# @param [Hash] params ({})
|
1074
|
+
def get_instance_access_details(params = {}, options = {})
|
1075
|
+
req = build_request(:get_instance_access_details, params)
|
1076
|
+
req.send_request(options)
|
1077
|
+
end
|
1078
|
+
|
1079
|
+
# Returns the data points for the specified Amazon Lightsail instance
|
1080
|
+
# metric, given an instance name.
|
1081
|
+
# @option params [required, String] :instance_name
|
1082
|
+
# The name of the instance for which you want to get metrics data.
|
1083
|
+
# @option params [required, String] :metric_name
|
1084
|
+
# The metric name to get data about.
|
1085
|
+
# @option params [required, Integer] :period
|
1086
|
+
# The time period for which you are requesting data.
|
1087
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
1088
|
+
# The start time of the time period.
|
1089
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
1090
|
+
# The end time of the time period.
|
1091
|
+
# @option params [required, String] :unit
|
1092
|
+
# The unit. The list of valid values is below.
|
1093
|
+
# @option params [required, Array<String>] :statistics
|
1094
|
+
# The instance statistics.
|
1095
|
+
# @return [Types::GetInstanceMetricDataResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1096
|
+
#
|
1097
|
+
# * {Types::GetInstanceMetricDataResult#metric_name #metricName} => String
|
1098
|
+
# * {Types::GetInstanceMetricDataResult#metric_data #metricData} => Array<Types::MetricDatapoint>
|
1099
|
+
#
|
1100
|
+
# @example Request syntax with placeholder values
|
1101
|
+
# resp = client.get_instance_metric_data({
|
1102
|
+
# instance_name: "ResourceName", # required
|
1103
|
+
# metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System
|
1104
|
+
# period: 1, # required
|
1105
|
+
# start_time: Time.now, # required
|
1106
|
+
# end_time: Time.now, # required
|
1107
|
+
# unit: "Seconds", # required, accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
1108
|
+
# statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount
|
1109
|
+
# })
|
1110
|
+
#
|
1111
|
+
# @example Response structure
|
1112
|
+
# resp.metric_name #=> String, one of "CPUUtilization", "NetworkIn", "NetworkOut", "StatusCheckFailed", "StatusCheckFailed_Instance", "StatusCheckFailed_System"
|
1113
|
+
# resp.metric_data #=> Array
|
1114
|
+
# resp.metric_data[0].average #=> Float
|
1115
|
+
# resp.metric_data[0].maximum #=> Float
|
1116
|
+
# resp.metric_data[0].minimum #=> Float
|
1117
|
+
# resp.metric_data[0].sample_count #=> Float
|
1118
|
+
# resp.metric_data[0].sum #=> Float
|
1119
|
+
# resp.metric_data[0].timestamp #=> Time
|
1120
|
+
# resp.metric_data[0].unit #=> String, one of "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
|
1121
|
+
# @overload get_instance_metric_data(params = {})
|
1122
|
+
# @param [Hash] params ({})
|
1123
|
+
def get_instance_metric_data(params = {}, options = {})
|
1124
|
+
req = build_request(:get_instance_metric_data, params)
|
1125
|
+
req.send_request(options)
|
1126
|
+
end
|
1127
|
+
|
1128
|
+
# Returns the port states for a specific virtual private server, or
|
1129
|
+
# *instance*.
|
1130
|
+
# @option params [required, String] :instance_name
|
1131
|
+
# The name of the instance.
|
1132
|
+
# @return [Types::GetInstancePortStatesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1133
|
+
#
|
1134
|
+
# * {Types::GetInstancePortStatesResult#port_states #portStates} => Array<String>
|
1135
|
+
#
|
1136
|
+
# @example Request syntax with placeholder values
|
1137
|
+
# resp = client.get_instance_port_states({
|
1138
|
+
# instance_name: "ResourceName", # required
|
1139
|
+
# })
|
1140
|
+
#
|
1141
|
+
# @example Response structure
|
1142
|
+
# resp.port_states #=> Array
|
1143
|
+
# resp.port_states[0] #=> String, one of "open", "closed"
|
1144
|
+
# @overload get_instance_port_states(params = {})
|
1145
|
+
# @param [Hash] params ({})
|
1146
|
+
def get_instance_port_states(params = {}, options = {})
|
1147
|
+
req = build_request(:get_instance_port_states, params)
|
1148
|
+
req.send_request(options)
|
1149
|
+
end
|
1150
|
+
|
1151
|
+
# Returns information about a specific instance snapshot.
|
1152
|
+
# @option params [required, String] :instance_snapshot_name
|
1153
|
+
# The name of the snapshot for which you are requesting information.
|
1154
|
+
# @return [Types::GetInstanceSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1155
|
+
#
|
1156
|
+
# * {Types::GetInstanceSnapshotResult#instance_snapshot #instanceSnapshot} => Types::InstanceSnapshot
|
1157
|
+
#
|
1158
|
+
# @example Request syntax with placeholder values
|
1159
|
+
# resp = client.get_instance_snapshot({
|
1160
|
+
# instance_snapshot_name: "ResourceName", # required
|
1161
|
+
# })
|
1162
|
+
#
|
1163
|
+
# @example Response structure
|
1164
|
+
# resp.instance_snapshot.name #=> String
|
1165
|
+
# resp.instance_snapshot.arn #=> String
|
1166
|
+
# resp.instance_snapshot.support_code #=> String
|
1167
|
+
# resp.instance_snapshot.created_at #=> Time
|
1168
|
+
# resp.instance_snapshot.location.availability_zone #=> String
|
1169
|
+
# resp.instance_snapshot.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1170
|
+
# resp.instance_snapshot.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1171
|
+
# resp.instance_snapshot.state #=> String, one of "pending", "error", "available"
|
1172
|
+
# resp.instance_snapshot.progress #=> String
|
1173
|
+
# resp.instance_snapshot.from_instance_name #=> String
|
1174
|
+
# resp.instance_snapshot.from_instance_arn #=> String
|
1175
|
+
# resp.instance_snapshot.from_blueprint_id #=> String
|
1176
|
+
# resp.instance_snapshot.from_bundle_id #=> String
|
1177
|
+
# resp.instance_snapshot.size_in_gb #=> Integer
|
1178
|
+
# @overload get_instance_snapshot(params = {})
|
1179
|
+
# @param [Hash] params ({})
|
1180
|
+
def get_instance_snapshot(params = {}, options = {})
|
1181
|
+
req = build_request(:get_instance_snapshot, params)
|
1182
|
+
req.send_request(options)
|
1183
|
+
end
|
1184
|
+
|
1185
|
+
# Returns all instance snapshots for the user's account.
|
1186
|
+
# @option params [String] :page_token
|
1187
|
+
# A token used for advancing to the next page of results from your get
|
1188
|
+
# instance snapshots request.
|
1189
|
+
# @return [Types::GetInstanceSnapshotsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1190
|
+
#
|
1191
|
+
# * {Types::GetInstanceSnapshotsResult#instance_snapshots #instanceSnapshots} => Array<Types::InstanceSnapshot>
|
1192
|
+
# * {Types::GetInstanceSnapshotsResult#next_page_token #nextPageToken} => String
|
1193
|
+
#
|
1194
|
+
# @example Request syntax with placeholder values
|
1195
|
+
# resp = client.get_instance_snapshots({
|
1196
|
+
# page_token: "string",
|
1197
|
+
# })
|
1198
|
+
#
|
1199
|
+
# @example Response structure
|
1200
|
+
# resp.instance_snapshots #=> Array
|
1201
|
+
# resp.instance_snapshots[0].name #=> String
|
1202
|
+
# resp.instance_snapshots[0].arn #=> String
|
1203
|
+
# resp.instance_snapshots[0].support_code #=> String
|
1204
|
+
# resp.instance_snapshots[0].created_at #=> Time
|
1205
|
+
# resp.instance_snapshots[0].location.availability_zone #=> String
|
1206
|
+
# resp.instance_snapshots[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1207
|
+
# resp.instance_snapshots[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1208
|
+
# resp.instance_snapshots[0].state #=> String, one of "pending", "error", "available"
|
1209
|
+
# resp.instance_snapshots[0].progress #=> String
|
1210
|
+
# resp.instance_snapshots[0].from_instance_name #=> String
|
1211
|
+
# resp.instance_snapshots[0].from_instance_arn #=> String
|
1212
|
+
# resp.instance_snapshots[0].from_blueprint_id #=> String
|
1213
|
+
# resp.instance_snapshots[0].from_bundle_id #=> String
|
1214
|
+
# resp.instance_snapshots[0].size_in_gb #=> Integer
|
1215
|
+
# resp.next_page_token #=> String
|
1216
|
+
# @overload get_instance_snapshots(params = {})
|
1217
|
+
# @param [Hash] params ({})
|
1218
|
+
def get_instance_snapshots(params = {}, options = {})
|
1219
|
+
req = build_request(:get_instance_snapshots, params)
|
1220
|
+
req.send_request(options)
|
1221
|
+
end
|
1222
|
+
|
1223
|
+
# Returns the state of a specific instance. Works on one instance at a
|
1224
|
+
# time.
|
1225
|
+
# @option params [required, String] :instance_name
|
1226
|
+
# The name of the instance to get state information about.
|
1227
|
+
# @return [Types::GetInstanceStateResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1228
|
+
#
|
1229
|
+
# * {Types::GetInstanceStateResult#state #state} => Types::InstanceState
|
1230
|
+
#
|
1231
|
+
# @example Request syntax with placeholder values
|
1232
|
+
# resp = client.get_instance_state({
|
1233
|
+
# instance_name: "ResourceName", # required
|
1234
|
+
# })
|
1235
|
+
#
|
1236
|
+
# @example Response structure
|
1237
|
+
# resp.state.code #=> Integer
|
1238
|
+
# resp.state.name #=> String
|
1239
|
+
# @overload get_instance_state(params = {})
|
1240
|
+
# @param [Hash] params ({})
|
1241
|
+
def get_instance_state(params = {}, options = {})
|
1242
|
+
req = build_request(:get_instance_state, params)
|
1243
|
+
req.send_request(options)
|
1244
|
+
end
|
1245
|
+
|
1246
|
+
# Returns information about all Amazon Lightsail virtual private
|
1247
|
+
# servers, or *instances*.
|
1248
|
+
# @option params [String] :page_token
|
1249
|
+
# A token used for advancing to the next page of results from your get
|
1250
|
+
# instances request.
|
1251
|
+
# @return [Types::GetInstancesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1252
|
+
#
|
1253
|
+
# * {Types::GetInstancesResult#instances #instances} => Array<Types::Instance>
|
1254
|
+
# * {Types::GetInstancesResult#next_page_token #nextPageToken} => String
|
1255
|
+
#
|
1256
|
+
# @example Request syntax with placeholder values
|
1257
|
+
# resp = client.get_instances({
|
1258
|
+
# page_token: "string",
|
1259
|
+
# })
|
1260
|
+
#
|
1261
|
+
# @example Response structure
|
1262
|
+
# resp.instances #=> Array
|
1263
|
+
# resp.instances[0].name #=> String
|
1264
|
+
# resp.instances[0].arn #=> String
|
1265
|
+
# resp.instances[0].support_code #=> String
|
1266
|
+
# resp.instances[0].created_at #=> Time
|
1267
|
+
# resp.instances[0].location.availability_zone #=> String
|
1268
|
+
# resp.instances[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1269
|
+
# resp.instances[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1270
|
+
# resp.instances[0].blueprint_id #=> String
|
1271
|
+
# resp.instances[0].blueprint_name #=> String
|
1272
|
+
# resp.instances[0].bundle_id #=> String
|
1273
|
+
# resp.instances[0].is_static_ip #=> Boolean
|
1274
|
+
# resp.instances[0].private_ip_address #=> String
|
1275
|
+
# resp.instances[0].public_ip_address #=> String
|
1276
|
+
# resp.instances[0].ipv6_address #=> String
|
1277
|
+
# resp.instances[0].hardware.cpu_count #=> Integer
|
1278
|
+
# resp.instances[0].hardware.disks #=> Array
|
1279
|
+
# resp.instances[0].hardware.disks[0].name #=> String
|
1280
|
+
# resp.instances[0].hardware.disks[0].arn #=> String
|
1281
|
+
# resp.instances[0].hardware.disks[0].support_code #=> String
|
1282
|
+
# resp.instances[0].hardware.disks[0].created_at #=> Time
|
1283
|
+
# resp.instances[0].hardware.disks[0].location.availability_zone #=> String
|
1284
|
+
# resp.instances[0].hardware.disks[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1285
|
+
# resp.instances[0].hardware.disks[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1286
|
+
# resp.instances[0].hardware.disks[0].size_in_gb #=> Integer
|
1287
|
+
# resp.instances[0].hardware.disks[0].gb_in_use #=> Integer
|
1288
|
+
# resp.instances[0].hardware.disks[0].is_system_disk #=> Boolean
|
1289
|
+
# resp.instances[0].hardware.disks[0].iops #=> Integer
|
1290
|
+
# resp.instances[0].hardware.disks[0].path #=> String
|
1291
|
+
# resp.instances[0].hardware.disks[0].attached_to #=> String
|
1292
|
+
# resp.instances[0].hardware.disks[0].is_attached #=> Boolean
|
1293
|
+
# resp.instances[0].hardware.disks[0].attachment_state #=> String
|
1294
|
+
# resp.instances[0].hardware.ram_size_in_gb #=> Float
|
1295
|
+
# resp.instances[0].networking.monthly_transfer.gb_per_month_allocated #=> Integer
|
1296
|
+
# resp.instances[0].networking.ports #=> Array
|
1297
|
+
# resp.instances[0].networking.ports[0].from_port #=> Integer
|
1298
|
+
# resp.instances[0].networking.ports[0].to_port #=> Integer
|
1299
|
+
# resp.instances[0].networking.ports[0].protocol #=> String, one of "tcp", "all", "udp"
|
1300
|
+
# resp.instances[0].networking.ports[0].access_from #=> String
|
1301
|
+
# resp.instances[0].networking.ports[0].access_type #=> String, one of "Public", "Private"
|
1302
|
+
# resp.instances[0].networking.ports[0].common_name #=> String
|
1303
|
+
# resp.instances[0].networking.ports[0].access_direction #=> String, one of "inbound", "outbound"
|
1304
|
+
# resp.instances[0].state.code #=> Integer
|
1305
|
+
# resp.instances[0].state.name #=> String
|
1306
|
+
# resp.instances[0].username #=> String
|
1307
|
+
# resp.instances[0].ssh_key_name #=> String
|
1308
|
+
# resp.next_page_token #=> String
|
1309
|
+
# @overload get_instances(params = {})
|
1310
|
+
# @param [Hash] params ({})
|
1311
|
+
def get_instances(params = {}, options = {})
|
1312
|
+
req = build_request(:get_instances, params)
|
1313
|
+
req.send_request(options)
|
1314
|
+
end
|
1315
|
+
|
1316
|
+
# Returns information about a specific key pair.
|
1317
|
+
# @option params [required, String] :key_pair_name
|
1318
|
+
# The name of the key pair for which you are requesting information.
|
1319
|
+
# @return [Types::GetKeyPairResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1320
|
+
#
|
1321
|
+
# * {Types::GetKeyPairResult#key_pair #keyPair} => Types::KeyPair
|
1322
|
+
#
|
1323
|
+
# @example Request syntax with placeholder values
|
1324
|
+
# resp = client.get_key_pair({
|
1325
|
+
# key_pair_name: "ResourceName", # required
|
1326
|
+
# })
|
1327
|
+
#
|
1328
|
+
# @example Response structure
|
1329
|
+
# resp.key_pair.name #=> String
|
1330
|
+
# resp.key_pair.arn #=> String
|
1331
|
+
# resp.key_pair.support_code #=> String
|
1332
|
+
# resp.key_pair.created_at #=> Time
|
1333
|
+
# resp.key_pair.location.availability_zone #=> String
|
1334
|
+
# resp.key_pair.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1335
|
+
# resp.key_pair.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1336
|
+
# resp.key_pair.fingerprint #=> String
|
1337
|
+
# @overload get_key_pair(params = {})
|
1338
|
+
# @param [Hash] params ({})
|
1339
|
+
def get_key_pair(params = {}, options = {})
|
1340
|
+
req = build_request(:get_key_pair, params)
|
1341
|
+
req.send_request(options)
|
1342
|
+
end
|
1343
|
+
|
1344
|
+
# Returns information about all key pairs in the user's account.
|
1345
|
+
# @option params [String] :page_token
|
1346
|
+
# A token used for advancing to the next page of results from your get
|
1347
|
+
# key pairs request.
|
1348
|
+
# @return [Types::GetKeyPairsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1349
|
+
#
|
1350
|
+
# * {Types::GetKeyPairsResult#key_pairs #keyPairs} => Array<Types::KeyPair>
|
1351
|
+
# * {Types::GetKeyPairsResult#next_page_token #nextPageToken} => String
|
1352
|
+
#
|
1353
|
+
# @example Request syntax with placeholder values
|
1354
|
+
# resp = client.get_key_pairs({
|
1355
|
+
# page_token: "string",
|
1356
|
+
# })
|
1357
|
+
#
|
1358
|
+
# @example Response structure
|
1359
|
+
# resp.key_pairs #=> Array
|
1360
|
+
# resp.key_pairs[0].name #=> String
|
1361
|
+
# resp.key_pairs[0].arn #=> String
|
1362
|
+
# resp.key_pairs[0].support_code #=> String
|
1363
|
+
# resp.key_pairs[0].created_at #=> Time
|
1364
|
+
# resp.key_pairs[0].location.availability_zone #=> String
|
1365
|
+
# resp.key_pairs[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1366
|
+
# resp.key_pairs[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1367
|
+
# resp.key_pairs[0].fingerprint #=> String
|
1368
|
+
# resp.next_page_token #=> String
|
1369
|
+
# @overload get_key_pairs(params = {})
|
1370
|
+
# @param [Hash] params ({})
|
1371
|
+
def get_key_pairs(params = {}, options = {})
|
1372
|
+
req = build_request(:get_key_pairs, params)
|
1373
|
+
req.send_request(options)
|
1374
|
+
end
|
1375
|
+
|
1376
|
+
# Returns information about a specific operation. Operations include
|
1377
|
+
# events such as when you create an instance, allocate a static IP,
|
1378
|
+
# attach a static IP, and so on.
|
1379
|
+
# @option params [required, String] :operation_id
|
1380
|
+
# A GUID used to identify the operation.
|
1381
|
+
# @return [Types::GetOperationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1382
|
+
#
|
1383
|
+
# * {Types::GetOperationResult#operation #operation} => Types::Operation
|
1384
|
+
#
|
1385
|
+
# @example Request syntax with placeholder values
|
1386
|
+
# resp = client.get_operation({
|
1387
|
+
# operation_id: "NonEmptyString", # required
|
1388
|
+
# })
|
1389
|
+
#
|
1390
|
+
# @example Response structure
|
1391
|
+
# resp.operation.id #=> String
|
1392
|
+
# resp.operation.resource_name #=> String
|
1393
|
+
# resp.operation.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1394
|
+
# resp.operation.created_at #=> Time
|
1395
|
+
# resp.operation.location.availability_zone #=> String
|
1396
|
+
# resp.operation.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1397
|
+
# resp.operation.is_terminal #=> Boolean
|
1398
|
+
# resp.operation.operation_details #=> String
|
1399
|
+
# resp.operation.operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
1400
|
+
# resp.operation.status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
1401
|
+
# resp.operation.status_changed_at #=> Time
|
1402
|
+
# resp.operation.error_code #=> String
|
1403
|
+
# resp.operation.error_details #=> String
|
1404
|
+
# @overload get_operation(params = {})
|
1405
|
+
# @param [Hash] params ({})
|
1406
|
+
def get_operation(params = {}, options = {})
|
1407
|
+
req = build_request(:get_operation, params)
|
1408
|
+
req.send_request(options)
|
1409
|
+
end
|
1410
|
+
|
1411
|
+
# Returns information about all operations.
|
1412
|
+
#
|
1413
|
+
# Results are returned from oldest to newest, up to a maximum of 200.
|
1414
|
+
# Results can be paged by making each subsequent call to `GetOperations`
|
1415
|
+
# use the maximum (last) `statusChangedAt` value from the previous
|
1416
|
+
# request.
|
1417
|
+
# @option params [String] :page_token
|
1418
|
+
# A token used for advancing to the next page of results from your get
|
1419
|
+
# operations request.
|
1420
|
+
# @return [Types::GetOperationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1421
|
+
#
|
1422
|
+
# * {Types::GetOperationsResult#operations #operations} => Array<Types::Operation>
|
1423
|
+
# * {Types::GetOperationsResult#next_page_token #nextPageToken} => String
|
1424
|
+
#
|
1425
|
+
# @example Request syntax with placeholder values
|
1426
|
+
# resp = client.get_operations({
|
1427
|
+
# page_token: "string",
|
1428
|
+
# })
|
1429
|
+
#
|
1430
|
+
# @example Response structure
|
1431
|
+
# resp.operations #=> Array
|
1432
|
+
# resp.operations[0].id #=> String
|
1433
|
+
# resp.operations[0].resource_name #=> String
|
1434
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1435
|
+
# resp.operations[0].created_at #=> Time
|
1436
|
+
# resp.operations[0].location.availability_zone #=> String
|
1437
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1438
|
+
# resp.operations[0].is_terminal #=> Boolean
|
1439
|
+
# resp.operations[0].operation_details #=> String
|
1440
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
1441
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
1442
|
+
# resp.operations[0].status_changed_at #=> Time
|
1443
|
+
# resp.operations[0].error_code #=> String
|
1444
|
+
# resp.operations[0].error_details #=> String
|
1445
|
+
# resp.next_page_token #=> String
|
1446
|
+
# @overload get_operations(params = {})
|
1447
|
+
# @param [Hash] params ({})
|
1448
|
+
def get_operations(params = {}, options = {})
|
1449
|
+
req = build_request(:get_operations, params)
|
1450
|
+
req.send_request(options)
|
1451
|
+
end
|
1452
|
+
|
1453
|
+
# Gets operations for a specific resource (e.g., an instance or a static
|
1454
|
+
# IP).
|
1455
|
+
# @option params [required, String] :resource_name
|
1456
|
+
# The name of the resource for which you are requesting information.
|
1457
|
+
# @option params [String] :page_token
|
1458
|
+
# A token used for advancing to the next page of results from your get
|
1459
|
+
# operations for resource request.
|
1460
|
+
# @return [Types::GetOperationsForResourceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1461
|
+
#
|
1462
|
+
# * {Types::GetOperationsForResourceResult#operations #operations} => Array<Types::Operation>
|
1463
|
+
# * {Types::GetOperationsForResourceResult#next_page_count #nextPageCount} => String
|
1464
|
+
#
|
1465
|
+
# @example Request syntax with placeholder values
|
1466
|
+
# resp = client.get_operations_for_resource({
|
1467
|
+
# resource_name: "ResourceName", # required
|
1468
|
+
# page_token: "string",
|
1469
|
+
# })
|
1470
|
+
#
|
1471
|
+
# @example Response structure
|
1472
|
+
# resp.operations #=> Array
|
1473
|
+
# resp.operations[0].id #=> String
|
1474
|
+
# resp.operations[0].resource_name #=> String
|
1475
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1476
|
+
# resp.operations[0].created_at #=> Time
|
1477
|
+
# resp.operations[0].location.availability_zone #=> String
|
1478
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1479
|
+
# resp.operations[0].is_terminal #=> Boolean
|
1480
|
+
# resp.operations[0].operation_details #=> String
|
1481
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
1482
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
1483
|
+
# resp.operations[0].status_changed_at #=> Time
|
1484
|
+
# resp.operations[0].error_code #=> String
|
1485
|
+
# resp.operations[0].error_details #=> String
|
1486
|
+
# resp.next_page_count #=> String
|
1487
|
+
# @overload get_operations_for_resource(params = {})
|
1488
|
+
# @param [Hash] params ({})
|
1489
|
+
def get_operations_for_resource(params = {}, options = {})
|
1490
|
+
req = build_request(:get_operations_for_resource, params)
|
1491
|
+
req.send_request(options)
|
1492
|
+
end
|
1493
|
+
|
1494
|
+
# Returns a list of all valid regions for Amazon Lightsail.
|
1495
|
+
# @option params [Boolean] :include_availability_zones
|
1496
|
+
# A Boolean value indicating whether to also include Availability Zones
|
1497
|
+
# in your get regions request. Availability Zones are indicated with a
|
1498
|
+
# letter: e.g., `us-east-1a`.
|
1499
|
+
# @return [Types::GetRegionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1500
|
+
#
|
1501
|
+
# * {Types::GetRegionsResult#regions #regions} => Array<Types::Region>
|
1502
|
+
#
|
1503
|
+
# @example Request syntax with placeholder values
|
1504
|
+
# resp = client.get_regions({
|
1505
|
+
# include_availability_zones: false,
|
1506
|
+
# })
|
1507
|
+
#
|
1508
|
+
# @example Response structure
|
1509
|
+
# resp.regions #=> Array
|
1510
|
+
# resp.regions[0].continent_code #=> String
|
1511
|
+
# resp.regions[0].description #=> String
|
1512
|
+
# resp.regions[0].display_name #=> String
|
1513
|
+
# resp.regions[0].name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1514
|
+
# resp.regions[0].availability_zones #=> Array
|
1515
|
+
# resp.regions[0].availability_zones[0].zone_name #=> String
|
1516
|
+
# resp.regions[0].availability_zones[0].state #=> String
|
1517
|
+
# @overload get_regions(params = {})
|
1518
|
+
# @param [Hash] params ({})
|
1519
|
+
def get_regions(params = {}, options = {})
|
1520
|
+
req = build_request(:get_regions, params)
|
1521
|
+
req.send_request(options)
|
1522
|
+
end
|
1523
|
+
|
1524
|
+
# Returns information about a specific static IP.
|
1525
|
+
# @option params [required, String] :static_ip_name
|
1526
|
+
# The name of the static IP in Lightsail.
|
1527
|
+
# @return [Types::GetStaticIpResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1528
|
+
#
|
1529
|
+
# * {Types::GetStaticIpResult#static_ip #staticIp} => Types::StaticIp
|
1530
|
+
#
|
1531
|
+
# @example Request syntax with placeholder values
|
1532
|
+
# resp = client.get_static_ip({
|
1533
|
+
# static_ip_name: "ResourceName", # required
|
1534
|
+
# })
|
1535
|
+
#
|
1536
|
+
# @example Response structure
|
1537
|
+
# resp.static_ip.name #=> String
|
1538
|
+
# resp.static_ip.arn #=> String
|
1539
|
+
# resp.static_ip.support_code #=> String
|
1540
|
+
# resp.static_ip.created_at #=> Time
|
1541
|
+
# resp.static_ip.location.availability_zone #=> String
|
1542
|
+
# resp.static_ip.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1543
|
+
# resp.static_ip.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1544
|
+
# resp.static_ip.ip_address #=> String
|
1545
|
+
# resp.static_ip.attached_to #=> String
|
1546
|
+
# resp.static_ip.is_attached #=> Boolean
|
1547
|
+
# @overload get_static_ip(params = {})
|
1548
|
+
# @param [Hash] params ({})
|
1549
|
+
def get_static_ip(params = {}, options = {})
|
1550
|
+
req = build_request(:get_static_ip, params)
|
1551
|
+
req.send_request(options)
|
1552
|
+
end
|
1553
|
+
|
1554
|
+
# Returns information about all static IPs in the user's account.
|
1555
|
+
# @option params [String] :page_token
|
1556
|
+
# A token used for advancing to the next page of results from your get
|
1557
|
+
# static IPs request.
|
1558
|
+
# @return [Types::GetStaticIpsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1559
|
+
#
|
1560
|
+
# * {Types::GetStaticIpsResult#static_ips #staticIps} => Array<Types::StaticIp>
|
1561
|
+
# * {Types::GetStaticIpsResult#next_page_token #nextPageToken} => String
|
1562
|
+
#
|
1563
|
+
# @example Request syntax with placeholder values
|
1564
|
+
# resp = client.get_static_ips({
|
1565
|
+
# page_token: "string",
|
1566
|
+
# })
|
1567
|
+
#
|
1568
|
+
# @example Response structure
|
1569
|
+
# resp.static_ips #=> Array
|
1570
|
+
# resp.static_ips[0].name #=> String
|
1571
|
+
# resp.static_ips[0].arn #=> String
|
1572
|
+
# resp.static_ips[0].support_code #=> String
|
1573
|
+
# resp.static_ips[0].created_at #=> Time
|
1574
|
+
# resp.static_ips[0].location.availability_zone #=> String
|
1575
|
+
# resp.static_ips[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1576
|
+
# resp.static_ips[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1577
|
+
# resp.static_ips[0].ip_address #=> String
|
1578
|
+
# resp.static_ips[0].attached_to #=> String
|
1579
|
+
# resp.static_ips[0].is_attached #=> Boolean
|
1580
|
+
# resp.next_page_token #=> String
|
1581
|
+
# @overload get_static_ips(params = {})
|
1582
|
+
# @param [Hash] params ({})
|
1583
|
+
def get_static_ips(params = {}, options = {})
|
1584
|
+
req = build_request(:get_static_ips, params)
|
1585
|
+
req.send_request(options)
|
1586
|
+
end
|
1587
|
+
|
1588
|
+
# Imports a public SSH key from a specific key pair.
|
1589
|
+
# @option params [required, String] :key_pair_name
|
1590
|
+
# The name of the key pair for which you want to import the public key.
|
1591
|
+
# @option params [required, String] :public_key_base_64
|
1592
|
+
# A base64-encoded public key of the `ssh-rsa` type.
|
1593
|
+
# @return [Types::ImportKeyPairResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1594
|
+
#
|
1595
|
+
# * {Types::ImportKeyPairResult#operation #operation} => Types::Operation
|
1596
|
+
#
|
1597
|
+
# @example Request syntax with placeholder values
|
1598
|
+
# resp = client.import_key_pair({
|
1599
|
+
# key_pair_name: "ResourceName", # required
|
1600
|
+
# public_key_base_64: "Base64", # required
|
1601
|
+
# })
|
1602
|
+
#
|
1603
|
+
# @example Response structure
|
1604
|
+
# resp.operation.id #=> String
|
1605
|
+
# resp.operation.resource_name #=> String
|
1606
|
+
# resp.operation.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1607
|
+
# resp.operation.created_at #=> Time
|
1608
|
+
# resp.operation.location.availability_zone #=> String
|
1609
|
+
# resp.operation.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1610
|
+
# resp.operation.is_terminal #=> Boolean
|
1611
|
+
# resp.operation.operation_details #=> String
|
1612
|
+
# resp.operation.operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
1613
|
+
# resp.operation.status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
1614
|
+
# resp.operation.status_changed_at #=> Time
|
1615
|
+
# resp.operation.error_code #=> String
|
1616
|
+
# resp.operation.error_details #=> String
|
1617
|
+
# @overload import_key_pair(params = {})
|
1618
|
+
# @param [Hash] params ({})
|
1619
|
+
def import_key_pair(params = {}, options = {})
|
1620
|
+
req = build_request(:import_key_pair, params)
|
1621
|
+
req.send_request(options)
|
1622
|
+
end
|
1623
|
+
|
1624
|
+
# Returns a Boolean value indicating whether your Lightsail VPC is
|
1625
|
+
# peered.
|
1626
|
+
# @return [Types::IsVpcPeeredResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1627
|
+
#
|
1628
|
+
# * {Types::IsVpcPeeredResult#is_peered #isPeered} => Boolean
|
1629
|
+
#
|
1630
|
+
# @example Request syntax with placeholder values
|
1631
|
+
# resp = client.is_vpc_peered()
|
1632
|
+
#
|
1633
|
+
# @example Response structure
|
1634
|
+
# resp.is_peered #=> Boolean
|
1635
|
+
# @overload is_vpc_peered(params = {})
|
1636
|
+
# @param [Hash] params ({})
|
1637
|
+
def is_vpc_peered(params = {}, options = {})
|
1638
|
+
req = build_request(:is_vpc_peered, params)
|
1639
|
+
req.send_request(options)
|
1640
|
+
end
|
1641
|
+
|
1642
|
+
# Adds public ports to an Amazon Lightsail instance.
|
1643
|
+
# @option params [required, Types::PortInfo] :port_info
|
1644
|
+
# An array of key-value pairs containing information about the port
|
1645
|
+
# mappings.
|
1646
|
+
# @option params [required, String] :instance_name
|
1647
|
+
# The name of the instance for which you want to open the public ports.
|
1648
|
+
# @return [Types::OpenInstancePublicPortsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1649
|
+
#
|
1650
|
+
# * {Types::OpenInstancePublicPortsResult#operation #operation} => Types::Operation
|
1651
|
+
#
|
1652
|
+
# @example Request syntax with placeholder values
|
1653
|
+
# resp = client.open_instance_public_ports({
|
1654
|
+
# port_info: { # required
|
1655
|
+
# from_port: 1,
|
1656
|
+
# to_port: 1,
|
1657
|
+
# protocol: "tcp", # accepts tcp, all, udp
|
1658
|
+
# },
|
1659
|
+
# instance_name: "ResourceName", # required
|
1660
|
+
# })
|
1661
|
+
#
|
1662
|
+
# @example Response structure
|
1663
|
+
# resp.operation.id #=> String
|
1664
|
+
# resp.operation.resource_name #=> String
|
1665
|
+
# resp.operation.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1666
|
+
# resp.operation.created_at #=> Time
|
1667
|
+
# resp.operation.location.availability_zone #=> String
|
1668
|
+
# resp.operation.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1669
|
+
# resp.operation.is_terminal #=> Boolean
|
1670
|
+
# resp.operation.operation_details #=> String
|
1671
|
+
# resp.operation.operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
1672
|
+
# resp.operation.status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
1673
|
+
# resp.operation.status_changed_at #=> Time
|
1674
|
+
# resp.operation.error_code #=> String
|
1675
|
+
# resp.operation.error_details #=> String
|
1676
|
+
# @overload open_instance_public_ports(params = {})
|
1677
|
+
# @param [Hash] params ({})
|
1678
|
+
def open_instance_public_ports(params = {}, options = {})
|
1679
|
+
req = build_request(:open_instance_public_ports, params)
|
1680
|
+
req.send_request(options)
|
1681
|
+
end
|
1682
|
+
|
1683
|
+
# Tries to peer the Lightsail VPC with the user's default VPC.
|
1684
|
+
# @return [Types::PeerVpcResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1685
|
+
#
|
1686
|
+
# * {Types::PeerVpcResult#operation #operation} => Types::Operation
|
1687
|
+
#
|
1688
|
+
# @example Request syntax with placeholder values
|
1689
|
+
# resp = client.peer_vpc()
|
1690
|
+
#
|
1691
|
+
# @example Response structure
|
1692
|
+
# resp.operation.id #=> String
|
1693
|
+
# resp.operation.resource_name #=> String
|
1694
|
+
# resp.operation.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1695
|
+
# resp.operation.created_at #=> Time
|
1696
|
+
# resp.operation.location.availability_zone #=> String
|
1697
|
+
# resp.operation.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1698
|
+
# resp.operation.is_terminal #=> Boolean
|
1699
|
+
# resp.operation.operation_details #=> String
|
1700
|
+
# resp.operation.operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
1701
|
+
# resp.operation.status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
1702
|
+
# resp.operation.status_changed_at #=> Time
|
1703
|
+
# resp.operation.error_code #=> String
|
1704
|
+
# resp.operation.error_details #=> String
|
1705
|
+
# @overload peer_vpc(params = {})
|
1706
|
+
# @param [Hash] params ({})
|
1707
|
+
def peer_vpc(params = {}, options = {})
|
1708
|
+
req = build_request(:peer_vpc, params)
|
1709
|
+
req.send_request(options)
|
1710
|
+
end
|
1711
|
+
|
1712
|
+
# Restarts a specific instance. When your Amazon Lightsail instance is
|
1713
|
+
# finished rebooting, Lightsail assigns a new public IP address. To use
|
1714
|
+
# the same IP address after restarting, create a static IP address and
|
1715
|
+
# attach it to the instance.
|
1716
|
+
# @option params [required, String] :instance_name
|
1717
|
+
# The name of the instance to reboot.
|
1718
|
+
# @return [Types::RebootInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1719
|
+
#
|
1720
|
+
# * {Types::RebootInstanceResult#operations #operations} => Array<Types::Operation>
|
1721
|
+
#
|
1722
|
+
# @example Request syntax with placeholder values
|
1723
|
+
# resp = client.reboot_instance({
|
1724
|
+
# instance_name: "ResourceName", # required
|
1725
|
+
# })
|
1726
|
+
#
|
1727
|
+
# @example Response structure
|
1728
|
+
# resp.operations #=> Array
|
1729
|
+
# resp.operations[0].id #=> String
|
1730
|
+
# resp.operations[0].resource_name #=> String
|
1731
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1732
|
+
# resp.operations[0].created_at #=> Time
|
1733
|
+
# resp.operations[0].location.availability_zone #=> String
|
1734
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1735
|
+
# resp.operations[0].is_terminal #=> Boolean
|
1736
|
+
# resp.operations[0].operation_details #=> String
|
1737
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
1738
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
1739
|
+
# resp.operations[0].status_changed_at #=> Time
|
1740
|
+
# resp.operations[0].error_code #=> String
|
1741
|
+
# resp.operations[0].error_details #=> String
|
1742
|
+
# @overload reboot_instance(params = {})
|
1743
|
+
# @param [Hash] params ({})
|
1744
|
+
def reboot_instance(params = {}, options = {})
|
1745
|
+
req = build_request(:reboot_instance, params)
|
1746
|
+
req.send_request(options)
|
1747
|
+
end
|
1748
|
+
|
1749
|
+
# Deletes a specific static IP from your account.
|
1750
|
+
# @option params [required, String] :static_ip_name
|
1751
|
+
# The name of the static IP to delete.
|
1752
|
+
# @return [Types::ReleaseStaticIpResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1753
|
+
#
|
1754
|
+
# * {Types::ReleaseStaticIpResult#operations #operations} => Array<Types::Operation>
|
1755
|
+
#
|
1756
|
+
# @example Request syntax with placeholder values
|
1757
|
+
# resp = client.release_static_ip({
|
1758
|
+
# static_ip_name: "ResourceName", # required
|
1759
|
+
# })
|
1760
|
+
#
|
1761
|
+
# @example Response structure
|
1762
|
+
# resp.operations #=> Array
|
1763
|
+
# resp.operations[0].id #=> String
|
1764
|
+
# resp.operations[0].resource_name #=> String
|
1765
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1766
|
+
# resp.operations[0].created_at #=> Time
|
1767
|
+
# resp.operations[0].location.availability_zone #=> String
|
1768
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1769
|
+
# resp.operations[0].is_terminal #=> Boolean
|
1770
|
+
# resp.operations[0].operation_details #=> String
|
1771
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
1772
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
1773
|
+
# resp.operations[0].status_changed_at #=> Time
|
1774
|
+
# resp.operations[0].error_code #=> String
|
1775
|
+
# resp.operations[0].error_details #=> String
|
1776
|
+
# @overload release_static_ip(params = {})
|
1777
|
+
# @param [Hash] params ({})
|
1778
|
+
def release_static_ip(params = {}, options = {})
|
1779
|
+
req = build_request(:release_static_ip, params)
|
1780
|
+
req.send_request(options)
|
1781
|
+
end
|
1782
|
+
|
1783
|
+
# Starts a specific Amazon Lightsail instance from a stopped state. To
|
1784
|
+
# restart an instance, use the reboot instance operation.
|
1785
|
+
# @option params [required, String] :instance_name
|
1786
|
+
# The name of the instance (a virtual private server) to start.
|
1787
|
+
# @return [Types::StartInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1788
|
+
#
|
1789
|
+
# * {Types::StartInstanceResult#operations #operations} => Array<Types::Operation>
|
1790
|
+
#
|
1791
|
+
# @example Request syntax with placeholder values
|
1792
|
+
# resp = client.start_instance({
|
1793
|
+
# instance_name: "ResourceName", # required
|
1794
|
+
# })
|
1795
|
+
#
|
1796
|
+
# @example Response structure
|
1797
|
+
# resp.operations #=> Array
|
1798
|
+
# resp.operations[0].id #=> String
|
1799
|
+
# resp.operations[0].resource_name #=> String
|
1800
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1801
|
+
# resp.operations[0].created_at #=> Time
|
1802
|
+
# resp.operations[0].location.availability_zone #=> String
|
1803
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1804
|
+
# resp.operations[0].is_terminal #=> Boolean
|
1805
|
+
# resp.operations[0].operation_details #=> String
|
1806
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
1807
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
1808
|
+
# resp.operations[0].status_changed_at #=> Time
|
1809
|
+
# resp.operations[0].error_code #=> String
|
1810
|
+
# resp.operations[0].error_details #=> String
|
1811
|
+
# @overload start_instance(params = {})
|
1812
|
+
# @param [Hash] params ({})
|
1813
|
+
def start_instance(params = {}, options = {})
|
1814
|
+
req = build_request(:start_instance, params)
|
1815
|
+
req.send_request(options)
|
1816
|
+
end
|
1817
|
+
|
1818
|
+
# Stops a specific Amazon Lightsail instance that is currently running.
|
1819
|
+
# @option params [required, String] :instance_name
|
1820
|
+
# The name of the instance (a virtual private server) to stop.
|
1821
|
+
# @return [Types::StopInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1822
|
+
#
|
1823
|
+
# * {Types::StopInstanceResult#operations #operations} => Array<Types::Operation>
|
1824
|
+
#
|
1825
|
+
# @example Request syntax with placeholder values
|
1826
|
+
# resp = client.stop_instance({
|
1827
|
+
# instance_name: "ResourceName", # required
|
1828
|
+
# })
|
1829
|
+
#
|
1830
|
+
# @example Response structure
|
1831
|
+
# resp.operations #=> Array
|
1832
|
+
# resp.operations[0].id #=> String
|
1833
|
+
# resp.operations[0].resource_name #=> String
|
1834
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1835
|
+
# resp.operations[0].created_at #=> Time
|
1836
|
+
# resp.operations[0].location.availability_zone #=> String
|
1837
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1838
|
+
# resp.operations[0].is_terminal #=> Boolean
|
1839
|
+
# resp.operations[0].operation_details #=> String
|
1840
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
1841
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
1842
|
+
# resp.operations[0].status_changed_at #=> Time
|
1843
|
+
# resp.operations[0].error_code #=> String
|
1844
|
+
# resp.operations[0].error_details #=> String
|
1845
|
+
# @overload stop_instance(params = {})
|
1846
|
+
# @param [Hash] params ({})
|
1847
|
+
def stop_instance(params = {}, options = {})
|
1848
|
+
req = build_request(:stop_instance, params)
|
1849
|
+
req.send_request(options)
|
1850
|
+
end
|
1851
|
+
|
1852
|
+
# Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
1853
|
+
# @return [Types::UnpeerVpcResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1854
|
+
#
|
1855
|
+
# * {Types::UnpeerVpcResult#operation #operation} => Types::Operation
|
1856
|
+
#
|
1857
|
+
# @example Request syntax with placeholder values
|
1858
|
+
# resp = client.unpeer_vpc()
|
1859
|
+
#
|
1860
|
+
# @example Response structure
|
1861
|
+
# resp.operation.id #=> String
|
1862
|
+
# resp.operation.resource_name #=> String
|
1863
|
+
# resp.operation.resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1864
|
+
# resp.operation.created_at #=> Time
|
1865
|
+
# resp.operation.location.availability_zone #=> String
|
1866
|
+
# resp.operation.location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1867
|
+
# resp.operation.is_terminal #=> Boolean
|
1868
|
+
# resp.operation.operation_details #=> String
|
1869
|
+
# resp.operation.operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
1870
|
+
# resp.operation.status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
1871
|
+
# resp.operation.status_changed_at #=> Time
|
1872
|
+
# resp.operation.error_code #=> String
|
1873
|
+
# resp.operation.error_details #=> String
|
1874
|
+
# @overload unpeer_vpc(params = {})
|
1875
|
+
# @param [Hash] params ({})
|
1876
|
+
def unpeer_vpc(params = {}, options = {})
|
1877
|
+
req = build_request(:unpeer_vpc, params)
|
1878
|
+
req.send_request(options)
|
1879
|
+
end
|
1880
|
+
|
1881
|
+
# Updates a domain recordset after it is created.
|
1882
|
+
# @option params [required, String] :domain_name
|
1883
|
+
# The name of the domain recordset to update.
|
1884
|
+
# @option params [required, Types::DomainEntry] :domain_entry
|
1885
|
+
# An array of key-value pairs containing information about the domain
|
1886
|
+
# entry.
|
1887
|
+
# @return [Types::UpdateDomainEntryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1888
|
+
#
|
1889
|
+
# * {Types::UpdateDomainEntryResult#operations #operations} => Array<Types::Operation>
|
1890
|
+
#
|
1891
|
+
# @example Request syntax with placeholder values
|
1892
|
+
# resp = client.update_domain_entry({
|
1893
|
+
# domain_name: "DomainName", # required
|
1894
|
+
# domain_entry: { # required
|
1895
|
+
# id: "NonEmptyString",
|
1896
|
+
# name: "DomainName",
|
1897
|
+
# target: "string",
|
1898
|
+
# type: "DomainEntryType",
|
1899
|
+
# options: {
|
1900
|
+
# "DomainEntryOptionsKeys" => "string",
|
1901
|
+
# },
|
1902
|
+
# },
|
1903
|
+
# })
|
1904
|
+
#
|
1905
|
+
# @example Response structure
|
1906
|
+
# resp.operations #=> Array
|
1907
|
+
# resp.operations[0].id #=> String
|
1908
|
+
# resp.operations[0].resource_name #=> String
|
1909
|
+
# resp.operations[0].resource_type #=> String, one of "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc"
|
1910
|
+
# resp.operations[0].created_at #=> Time
|
1911
|
+
# resp.operations[0].location.availability_zone #=> String
|
1912
|
+
# resp.operations[0].location.region_name #=> String, one of "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2"
|
1913
|
+
# resp.operations[0].is_terminal #=> Boolean
|
1914
|
+
# resp.operations[0].operation_details #=> String
|
1915
|
+
# resp.operations[0].operation_type #=> String, one of "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot"
|
1916
|
+
# resp.operations[0].status #=> String, one of "NotStarted", "Started", "Failed", "Completed"
|
1917
|
+
# resp.operations[0].status_changed_at #=> Time
|
1918
|
+
# resp.operations[0].error_code #=> String
|
1919
|
+
# resp.operations[0].error_details #=> String
|
1920
|
+
# @overload update_domain_entry(params = {})
|
1921
|
+
# @param [Hash] params ({})
|
1922
|
+
def update_domain_entry(params = {}, options = {})
|
1923
|
+
req = build_request(:update_domain_entry, params)
|
1924
|
+
req.send_request(options)
|
1925
|
+
end
|
1926
|
+
|
1927
|
+
# @!endgroup
|
1928
|
+
|
1929
|
+
# @param params ({})
|
1930
|
+
# @api private
|
1931
|
+
def build_request(operation_name, params = {})
|
1932
|
+
handlers = @handlers.for(operation_name)
|
1933
|
+
context = Seahorse::Client::RequestContext.new(
|
1934
|
+
operation_name: operation_name,
|
1935
|
+
operation: config.api.operation(operation_name),
|
1936
|
+
client: self,
|
1937
|
+
params: params,
|
1938
|
+
config: config)
|
1939
|
+
context[:gem_name] = 'aws-sdk-lightsail'
|
1940
|
+
context[:gem_version] = '1.0.0.rc2'
|
1941
|
+
Seahorse::Client::Request.new(handlers, context)
|
1942
|
+
end
|
1943
|
+
|
1944
|
+
# @api private
|
1945
|
+
# @deprecated
|
1946
|
+
def waiter_names
|
1947
|
+
[]
|
1948
|
+
end
|
1949
|
+
|
1950
|
+
class << self
|
1951
|
+
|
1952
|
+
# @api private
|
1953
|
+
attr_reader :identifier
|
1954
|
+
|
1955
|
+
# @api private
|
1956
|
+
def errors_module
|
1957
|
+
Errors
|
1958
|
+
end
|
1959
|
+
|
1960
|
+
end
|
1961
|
+
end
|
1962
|
+
end
|
1963
|
+
end
|