aws-sdk-lightsail 1.28.1 → 1.33.1

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 86bde6872a39aed6dba62da6946cfc10a9250b72
4
- data.tar.gz: 86848ccdcfc09893ab4ab33be57e3105d9efc6b2
2
+ SHA256:
3
+ metadata.gz: a7051cd3c0e9ffba29ccab95dfac95554e9d2f5e4eb23ac30810404a5dfc3907
4
+ data.tar.gz: 4eb43357e5bd3b1fc638850c0de5bd34462d8addbc0c178a1e2b65435b6ea801
5
5
  SHA512:
6
- metadata.gz: 72233e8fe218341ca3679a6a7dc92f422c8f628e16689450907e4cfb3cf9936b33890ac4d0ee50c9f15e41c4d2ffd1ff5109964fe6e7afec19827ae130b61708
7
- data.tar.gz: 649b04d46e602e92514e8c31db6b8ba8033bcfe44fe2e97061b990c228ed10bd2db12251b5335d935689e3c9a2fdb2e4ea35e4e119ce4a4190c8fd3b7206ab73
6
+ metadata.gz: cb57da16775d8e80cfaf8b34bb274c320471223fe39d4e0d587dbf3d8ba0e7332c56de6c15d75729791d3e0e3c63fc67cbfb54609e05bc3673a0240713b35d1f
7
+ data.tar.gz: 308cd17d5563f836233ba717b658c05ccd90d2ad6e50fa0ad2d79bf831fd49bc61c7e81a235ae4ef55b9640e1ac9053202207869142cd2bcf708db4bdd1891b0
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-lightsail/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # lightsail = Aws::Lightsail::Client.new
28
+ # resp = lightsail.allocate_static_ip(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Lightsail all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Lightsail are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::Lightsail::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Lightsail API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-lightsail/customizations'
42
45
  # @service
43
46
  module Aws::Lightsail
44
47
 
45
- GEM_VERSION = '1.28.1'
48
+ GEM_VERSION = '1.33.1'
46
49
 
47
50
  end
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
24
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
25
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
26
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
28
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
29
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
30
 
30
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:lightsail)
31
32
 
32
33
  module Aws::Lightsail
34
+ # An API client for Lightsail. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::Lightsail::Client.new(
37
+ # region: region_name,
38
+ # credentials: credentials,
39
+ # # ...
40
+ # )
41
+ #
42
+ # For details on configuring region and credentials see
43
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
44
+ #
45
+ # See {#initialize} for a full list of supported configuration options.
33
46
  class Client < Seahorse::Client::Base
34
47
 
35
48
  include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::Lightsail
57
70
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
71
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
72
  add_plugin(Aws::Plugins::TransferEncoding)
73
+ add_plugin(Aws::Plugins::HttpChecksum)
60
74
  add_plugin(Aws::Plugins::SignatureV4)
61
75
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
76
 
@@ -93,7 +107,7 @@ module Aws::Lightsail
93
107
  # @option options [required, String] :region
94
108
  # The AWS region to connect to. The configured `:region` is
95
109
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
97
111
  #
98
112
  # * `Aws.config[:region]`
99
113
  # * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::Lightsail
108
122
  # When set to `true`, a thread polling for endpoints will be running in
109
123
  # the background every 60 secs (default). Defaults to `false`.
110
124
  #
125
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
126
+ # Used only in `adaptive` retry mode. When true, the request will sleep
127
+ # until there is sufficent client side capacity to retry the request.
128
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
129
+ # not retry instead of sleeping.
130
+ #
111
131
  # @option options [Boolean] :client_side_monitoring (false)
112
132
  # When `true`, client-side metrics will be collected for all API requests from
113
133
  # this client.
@@ -132,6 +152,10 @@ module Aws::Lightsail
132
152
  # When `true`, an attempt is made to coerce request parameters into
133
153
  # the required types.
134
154
  #
155
+ # @option options [Boolean] :correct_clock_skew (true)
156
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
157
+ # a clock skew correction and retry requests with skewed client clocks.
158
+ #
135
159
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
160
  # Set to true to disable SDK automatically adding host prefix
137
161
  # to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::Lightsail
139
163
  # @option options [String] :endpoint
140
164
  # The client endpoint is normally constructed from the `:region`
141
165
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
167
  #
144
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::Lightsail
154
178
  # requests fetching endpoints information. Defaults to 60 sec.
155
179
  #
156
180
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
182
  #
159
183
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
184
  # The log formatter.
@@ -166,15 +190,29 @@ module Aws::Lightsail
166
190
  # The Logger instance to send log messages to. If this option
167
191
  # is not set, logging will be disabled.
168
192
  #
193
+ # @option options [Integer] :max_attempts (3)
194
+ # An integer representing the maximum number attempts that will be made for
195
+ # a single request, including the initial attempt. For example,
196
+ # setting this value to 5 will result in a request being retried up to
197
+ # 4 times. Used in `standard` and `adaptive` retry modes.
198
+ #
169
199
  # @option options [String] :profile ("default")
170
200
  # Used when loading credentials from the shared credentials file
171
201
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
202
  #
203
+ # @option options [Proc] :retry_backoff
204
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
205
+ # This option is only used in the `legacy` retry mode.
206
+ #
173
207
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
208
+ # The base delay in seconds used by the default backoff function. This option
209
+ # is only used in the `legacy` retry mode.
175
210
  #
176
211
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
212
+ # A delay randomiser function used by the default backoff function.
213
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
214
+ # otherwise a Proc that takes and returns a number. This option is only used
215
+ # in the `legacy` retry mode.
178
216
  #
179
217
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
218
  #
@@ -182,11 +220,30 @@ module Aws::Lightsail
182
220
  # The maximum number of times to retry failed requests. Only
183
221
  # ~ 500 level server errors and certain ~ 400 level client errors
184
222
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
223
+ # checksum errors, networking errors, timeout errors, auth errors,
224
+ # endpoint discovery, and errors from expired credentials.
225
+ # This option is only used in the `legacy` retry mode.
187
226
  #
188
227
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
228
+ # The maximum number of seconds to delay between retries (0 for no limit)
229
+ # used by the default backoff function. This option is only used in the
230
+ # `legacy` retry mode.
231
+ #
232
+ # @option options [String] :retry_mode ("legacy")
233
+ # Specifies which retry algorithm to use. Values are:
234
+ #
235
+ # * `legacy` - The pre-existing retry behavior. This is default value if
236
+ # no retry mode is provided.
237
+ #
238
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
239
+ # This includes support for retry quotas, which limit the number of
240
+ # unsuccessful retries a client can make.
241
+ #
242
+ # * `adaptive` - An experimental retry mode that includes all the
243
+ # functionality of `standard` mode along with automatic client side
244
+ # throttling. This is a provisional mode that may change behavior
245
+ # in the future.
246
+ #
190
247
  #
191
248
  # @option options [String] :secret_access_key
192
249
  #
@@ -219,16 +276,15 @@ module Aws::Lightsail
219
276
  # requests through. Formatted like 'http://proxy.com:123'.
220
277
  #
221
278
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
279
+ # seconds to wait when opening a HTTP session before raising a
223
280
  # `Timeout::Error`.
224
281
  #
225
282
  # @option options [Integer] :http_read_timeout (60) The default
226
283
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
284
+ # safely be set per-request on the session.
229
285
  #
230
286
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
287
+ # seconds a connection is allowed to sit idle before it is
232
288
  # considered stale. Stale connections are closed and removed
233
289
  # from the pool before making a request.
234
290
  #
@@ -237,7 +293,7 @@ module Aws::Lightsail
237
293
  # request body. This option has no effect unless the request has
238
294
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
295
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
296
+ # request on the session.
241
297
  #
242
298
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
299
  # HTTP debug output will be sent to the `:logger`.
@@ -538,11 +594,11 @@ module Aws::Lightsail
538
594
  req.send_request(options)
539
595
  end
540
596
 
541
- # Closes the public ports on a specific Amazon Lightsail instance.
597
+ # Closes ports for a specific Amazon Lightsail instance.
542
598
  #
543
- # The `close instance public ports` operation supports tag-based access
599
+ # The `CloseInstancePublicPorts` action supports tag-based access
544
600
  # control via resource tags applied to the resource identified by
545
- # `instance name`. For more information, see the [Lightsail Dev
601
+ # `instanceName`. For more information, see the [Lightsail Dev
546
602
  # Guide][1].
547
603
  #
548
604
  #
@@ -550,11 +606,10 @@ module Aws::Lightsail
550
606
  # [1]: https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags
551
607
  #
552
608
  # @option params [required, Types::PortInfo] :port_info
553
- # Information about the public port you are trying to close.
609
+ # An object to describe the ports to close for the specified instance.
554
610
  #
555
611
  # @option params [required, String] :instance_name
556
- # The name of the instance on which you're attempting to close the
557
- # public ports.
612
+ # The name of the instance for which to close ports.
558
613
  #
559
614
  # @return [Types::CloseInstancePublicPortsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
560
615
  #
@@ -566,7 +621,9 @@ module Aws::Lightsail
566
621
  # port_info: { # required
567
622
  # from_port: 1,
568
623
  # to_port: 1,
569
- # protocol: "tcp", # accepts tcp, all, udp
624
+ # protocol: "tcp", # accepts tcp, all, udp, icmp
625
+ # cidrs: ["string"],
626
+ # cidr_list_aliases: ["string"],
570
627
  # },
571
628
  # instance_name: "ResourceName", # required
572
629
  # })
@@ -838,7 +895,7 @@ module Aws::Lightsail
838
895
  # maximum of 15 digits, and they are prefixed with the plus character
839
896
  # (+) and the country code. For example, a U.S. phone number in E.164
840
897
  # format would be specified as +1XXX5550100. For more information, see
841
- # [E.164][1] in Wikipedia.
898
+ # [E.164][1] on *Wikipedia*.
842
899
  #
843
900
  #
844
901
  #
@@ -3727,7 +3784,7 @@ module Aws::Lightsail
3727
3784
  # resp.alarms[0].datapoints_to_alarm #=> Integer
3728
3785
  # resp.alarms[0].treat_missing_data #=> String, one of "breaching", "notBreaching", "ignore", "missing"
3729
3786
  # resp.alarms[0].statistic #=> String, one of "Minimum", "Maximum", "Sum", "Average", "SampleCount"
3730
- # resp.alarms[0].metric_name #=> String, one of "CPUUtilization", "NetworkIn", "NetworkOut", "StatusCheckFailed", "StatusCheckFailed_Instance", "StatusCheckFailed_System", "ClientTLSNegotiationErrorCount", "HealthyHostCount", "UnhealthyHostCount", "HTTPCode_LB_4XX_Count", "HTTPCode_LB_5XX_Count", "HTTPCode_Instance_2XX_Count", "HTTPCode_Instance_3XX_Count", "HTTPCode_Instance_4XX_Count", "HTTPCode_Instance_5XX_Count", "InstanceResponseTime", "RejectedConnectionCount", "RequestCount", "DatabaseConnections", "DiskQueueDepth", "FreeStorageSpace", "NetworkReceiveThroughput", "NetworkTransmitThroughput"
3787
+ # resp.alarms[0].metric_name #=> String, one of "CPUUtilization", "NetworkIn", "NetworkOut", "StatusCheckFailed", "StatusCheckFailed_Instance", "StatusCheckFailed_System", "ClientTLSNegotiationErrorCount", "HealthyHostCount", "UnhealthyHostCount", "HTTPCode_LB_4XX_Count", "HTTPCode_LB_5XX_Count", "HTTPCode_Instance_2XX_Count", "HTTPCode_Instance_3XX_Count", "HTTPCode_Instance_4XX_Count", "HTTPCode_Instance_5XX_Count", "InstanceResponseTime", "RejectedConnectionCount", "RequestCount", "DatabaseConnections", "DiskQueueDepth", "FreeStorageSpace", "NetworkReceiveThroughput", "NetworkTransmitThroughput", "BurstCapacityTime", "BurstCapacityPercentage"
3731
3788
  # resp.alarms[0].state #=> String, one of "OK", "ALARM", "INSUFFICIENT_DATA"
3732
3789
  # resp.alarms[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"
3733
3790
  # resp.alarms[0].contact_protocols #=> Array
@@ -4451,11 +4508,15 @@ module Aws::Lightsail
4451
4508
  # resp.instance.networking.ports #=> Array
4452
4509
  # resp.instance.networking.ports[0].from_port #=> Integer
4453
4510
  # resp.instance.networking.ports[0].to_port #=> Integer
4454
- # resp.instance.networking.ports[0].protocol #=> String, one of "tcp", "all", "udp"
4511
+ # resp.instance.networking.ports[0].protocol #=> String, one of "tcp", "all", "udp", "icmp"
4455
4512
  # resp.instance.networking.ports[0].access_from #=> String
4456
4513
  # resp.instance.networking.ports[0].access_type #=> String, one of "Public", "Private"
4457
4514
  # resp.instance.networking.ports[0].common_name #=> String
4458
4515
  # resp.instance.networking.ports[0].access_direction #=> String, one of "inbound", "outbound"
4516
+ # resp.instance.networking.ports[0].cidrs #=> Array
4517
+ # resp.instance.networking.ports[0].cidrs[0] #=> String
4518
+ # resp.instance.networking.ports[0].cidr_list_aliases #=> Array
4519
+ # resp.instance.networking.ports[0].cidr_list_aliases[0] #=> String
4459
4520
  # resp.instance.state.code #=> Integer
4460
4521
  # resp.instance.state.name #=> String
4461
4522
  # resp.instance.username #=> String
@@ -4532,6 +4593,11 @@ module Aws::Lightsail
4532
4593
  # Returns the data points for the specified Amazon Lightsail instance
4533
4594
  # metric, given an instance name.
4534
4595
  #
4596
+ # Metrics report the utilization of your resources, and the error counts
4597
+ # generated by them. Monitor and collect metric data regularly to
4598
+ # maintain the reliability, availability, and performance of your
4599
+ # resources.
4600
+ #
4535
4601
  # @option params [required, String] :instance_name
4536
4602
  # The name of the instance for which you want to get metrics data.
4537
4603
  #
@@ -4542,7 +4608,39 @@ module Aws::Lightsail
4542
4608
  # useful `statistics` to include in your request, and the published
4543
4609
  # `unit` value.
4544
4610
  #
4545
- # * <b> <code>CPUUtilization</code> </b> The percentage of allocated
4611
+ # * <b> <code>BurstCapacityPercentage</code> </b> - The percentage of
4612
+ # CPU performance available for your instance to burst above its
4613
+ # baseline. Your instance continuously accrues and consumes burst
4614
+ # capacity. Burst capacity stops accruing when your instance's
4615
+ # `BurstCapacityPercentage` reaches 100%. For more information, see
4616
+ # [Viewing instance burst capacity in Amazon Lightsail][1].
4617
+ #
4618
+ # `Statistics`\: The most useful statistics are `Maximum` and
4619
+ # `Average`.
4620
+ #
4621
+ # `Unit`\: The published unit is `Percent`.
4622
+ #
4623
+ # * <b> <code>BurstCapacityTime</code> </b> - The available amount of
4624
+ # time for your instance to burst at 100% CPU utilization. Your
4625
+ # instance continuously accrues and consumes burst capacity. Burst
4626
+ # capacity time stops accruing when your instance's
4627
+ # `BurstCapacityPercentage` metric reaches 100%.
4628
+ #
4629
+ # Burst capacity time is consumed at the full rate only when your
4630
+ # instance operates at 100% CPU utilization. For example, if your
4631
+ # instance operates at 50% CPU utilization in the burstable zone for a
4632
+ # 5-minute period, then it consumes CPU burst capacity minutes at a
4633
+ # 50% rate in that period. Your instance consumed 2 minutes and 30
4634
+ # seconds of CPU burst capacity minutes in the 5-minute period. For
4635
+ # more information, see [Viewing instance burst capacity in Amazon
4636
+ # Lightsail][1].
4637
+ #
4638
+ # `Statistics`\: The most useful statistics are `Maximum` and
4639
+ # `Average`.
4640
+ #
4641
+ # `Unit`\: The published unit is `Seconds`.
4642
+ #
4643
+ # * <b> <code>CPUUtilization</code> </b> - The percentage of allocated
4546
4644
  # compute units that are currently in use on the instance. This metric
4547
4645
  # identifies the processing power to run the applications on the
4548
4646
  # instance. Tools in your operating system can show a lower percentage
@@ -4554,7 +4652,7 @@ module Aws::Lightsail
4554
4652
  #
4555
4653
  # `Unit`\: The published unit is `Percent`.
4556
4654
  #
4557
- # * <b> <code>NetworkIn</code> </b> The number of bytes received on
4655
+ # * <b> <code>NetworkIn</code> </b> - The number of bytes received on
4558
4656
  # all network interfaces by the instance. This metric identifies the
4559
4657
  # volume of incoming network traffic to the instance. The number
4560
4658
  # reported is the number of bytes received during the period. Because
@@ -4565,7 +4663,7 @@ module Aws::Lightsail
4565
4663
  #
4566
4664
  # `Unit`\: The published unit is `Bytes`.
4567
4665
  #
4568
- # * <b> <code>NetworkOut</code> </b> The number of bytes sent out on
4666
+ # * <b> <code>NetworkOut</code> </b> - The number of bytes sent out on
4569
4667
  # all network interfaces by the instance. This metric identifies the
4570
4668
  # volume of outgoing network traffic from the instance. The number
4571
4669
  # reported is the number of bytes sent during the period. Because this
@@ -4576,7 +4674,7 @@ module Aws::Lightsail
4576
4674
  #
4577
4675
  # `Unit`\: The published unit is `Bytes`.
4578
4676
  #
4579
- # * <b> <code>StatusCheckFailed</code> </b> Reports whether the
4677
+ # * <b> <code>StatusCheckFailed</code> </b> - Reports whether the
4580
4678
  # instance passed or failed both the instance status check and the
4581
4679
  # system status check. This metric can be either 0 (passed) or 1
4582
4680
  # (failed). This metric data is available in 1-minute (60 seconds)
@@ -4586,7 +4684,7 @@ module Aws::Lightsail
4586
4684
  #
4587
4685
  # `Unit`\: The published unit is `Count`.
4588
4686
  #
4589
- # * <b> <code>StatusCheckFailed_Instance</code> </b> Reports whether
4687
+ # * <b> <code>StatusCheckFailed_Instance</code> </b> - Reports whether
4590
4688
  # the instance passed or failed the instance status check. This metric
4591
4689
  # can be either 0 (passed) or 1 (failed). This metric data is
4592
4690
  # available in 1-minute (60 seconds) granularity.
@@ -4595,7 +4693,7 @@ module Aws::Lightsail
4595
4693
  #
4596
4694
  # `Unit`\: The published unit is `Count`.
4597
4695
  #
4598
- # * <b> <code>StatusCheckFailed_System</code> </b> Reports whether the
4696
+ # * <b> <code>StatusCheckFailed_System</code> </b> - Reports whether the
4599
4697
  # instance passed or failed the system status check. This metric can
4600
4698
  # be either 0 (passed) or 1 (failed). This metric data is available in
4601
4699
  # 1-minute (60 seconds) granularity.
@@ -4604,6 +4702,10 @@ module Aws::Lightsail
4604
4702
  #
4605
4703
  # `Unit`\: The published unit is `Count`.
4606
4704
  #
4705
+ #
4706
+ #
4707
+ # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity
4708
+ #
4607
4709
  # @option params [required, Integer] :period
4608
4710
  # The granularity, in seconds, of the returned data points.
4609
4711
  #
@@ -4620,34 +4722,34 @@ module Aws::Lightsail
4620
4722
  #
4621
4723
  # @option params [required, String] :unit
4622
4724
  # The unit for the metric data request. Valid units depend on the metric
4623
- # data being required. For the valid units with each available metric,
4624
- # see the `metricName` parameter.
4725
+ # data being requested. For the valid units to specify with each
4726
+ # available metric, see the `metricName` parameter.
4625
4727
  #
4626
4728
  # @option params [required, Array<String>] :statistics
4627
4729
  # The statistic for the metric.
4628
4730
  #
4629
4731
  # The following statistics are available:
4630
4732
  #
4631
- # * `Minimum` The lowest value observed during the specified period.
4733
+ # * `Minimum` - The lowest value observed during the specified period.
4632
4734
  # Use this value to determine low volumes of activity for your
4633
4735
  # application.
4634
4736
  #
4635
- # * `Maximum` The highest value observed during the specified period.
4737
+ # * `Maximum` - The highest value observed during the specified period.
4636
4738
  # Use this value to determine high volumes of activity for your
4637
4739
  # application.
4638
4740
  #
4639
- # * `Sum` All values submitted for the matching metric added together.
4741
+ # * `Sum` - All values submitted for the matching metric added together.
4640
4742
  # You can use this statistic to determine the total volume of a
4641
4743
  # metric.
4642
4744
  #
4643
- # * `Average` The value of Sum / SampleCount during the specified
4745
+ # * `Average` - The value of Sum / SampleCount during the specified
4644
4746
  # period. By comparing this statistic with the Minimum and Maximum
4645
4747
  # values, you can determine the full scope of a metric and how close
4646
4748
  # the average use is to the Minimum and Maximum values. This
4647
4749
  # comparison helps you to know when to increase or decrease your
4648
4750
  # resources.
4649
4751
  #
4650
- # * `SampleCount` The count, or number, of data points used for the
4752
+ # * `SampleCount` - The count, or number, of data points used for the
4651
4753
  # statistical calculation.
4652
4754
  #
4653
4755
  # @return [Types::GetInstanceMetricDataResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -4659,7 +4761,7 @@ module Aws::Lightsail
4659
4761
  #
4660
4762
  # resp = client.get_instance_metric_data({
4661
4763
  # instance_name: "ResourceName", # required
4662
- # metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System
4764
+ # metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System, BurstCapacityTime, BurstCapacityPercentage
4663
4765
  # period: 1, # required
4664
4766
  # start_time: Time.now, # required
4665
4767
  # end_time: Time.now, # required
@@ -4669,7 +4771,7 @@ module Aws::Lightsail
4669
4771
  #
4670
4772
  # @example Response structure
4671
4773
  #
4672
- # resp.metric_name #=> String, one of "CPUUtilization", "NetworkIn", "NetworkOut", "StatusCheckFailed", "StatusCheckFailed_Instance", "StatusCheckFailed_System"
4774
+ # resp.metric_name #=> String, one of "CPUUtilization", "NetworkIn", "NetworkOut", "StatusCheckFailed", "StatusCheckFailed_Instance", "StatusCheckFailed_System", "BurstCapacityTime", "BurstCapacityPercentage"
4673
4775
  # resp.metric_data #=> Array
4674
4776
  # resp.metric_data[0].average #=> Float
4675
4777
  # resp.metric_data[0].maximum #=> Float
@@ -4688,11 +4790,12 @@ module Aws::Lightsail
4688
4790
  req.send_request(options)
4689
4791
  end
4690
4792
 
4691
- # Returns the port states for a specific virtual private server, or
4692
- # *instance*.
4793
+ # Returns the firewall port states for a specific Amazon Lightsail
4794
+ # instance, the IP addresses allowed to connect to the instance through
4795
+ # the ports, and the protocol.
4693
4796
  #
4694
4797
  # @option params [required, String] :instance_name
4695
- # The name of the instance.
4798
+ # The name of the instance for which to return firewall port states.
4696
4799
  #
4697
4800
  # @return [Types::GetInstancePortStatesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4698
4801
  #
@@ -4709,8 +4812,12 @@ module Aws::Lightsail
4709
4812
  # resp.port_states #=> Array
4710
4813
  # resp.port_states[0].from_port #=> Integer
4711
4814
  # resp.port_states[0].to_port #=> Integer
4712
- # resp.port_states[0].protocol #=> String, one of "tcp", "all", "udp"
4815
+ # resp.port_states[0].protocol #=> String, one of "tcp", "all", "udp", "icmp"
4713
4816
  # resp.port_states[0].state #=> String, one of "open", "closed"
4817
+ # resp.port_states[0].cidrs #=> Array
4818
+ # resp.port_states[0].cidrs[0] #=> String
4819
+ # resp.port_states[0].cidr_list_aliases #=> Array
4820
+ # resp.port_states[0].cidr_list_aliases[0] #=> String
4714
4821
  #
4715
4822
  # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancePortStates AWS API Documentation
4716
4823
  #
@@ -4976,11 +5083,15 @@ module Aws::Lightsail
4976
5083
  # resp.instances[0].networking.ports #=> Array
4977
5084
  # resp.instances[0].networking.ports[0].from_port #=> Integer
4978
5085
  # resp.instances[0].networking.ports[0].to_port #=> Integer
4979
- # resp.instances[0].networking.ports[0].protocol #=> String, one of "tcp", "all", "udp"
5086
+ # resp.instances[0].networking.ports[0].protocol #=> String, one of "tcp", "all", "udp", "icmp"
4980
5087
  # resp.instances[0].networking.ports[0].access_from #=> String
4981
5088
  # resp.instances[0].networking.ports[0].access_type #=> String, one of "Public", "Private"
4982
5089
  # resp.instances[0].networking.ports[0].common_name #=> String
4983
5090
  # resp.instances[0].networking.ports[0].access_direction #=> String, one of "inbound", "outbound"
5091
+ # resp.instances[0].networking.ports[0].cidrs #=> Array
5092
+ # resp.instances[0].networking.ports[0].cidrs[0] #=> String
5093
+ # resp.instances[0].networking.ports[0].cidr_list_aliases #=> Array
5094
+ # resp.instances[0].networking.ports[0].cidr_list_aliases[0] #=> String
4984
5095
  # resp.instances[0].state.code #=> Integer
4985
5096
  # resp.instances[0].state.name #=> String
4986
5097
  # resp.instances[0].username #=> String
@@ -5135,6 +5246,11 @@ module Aws::Lightsail
5135
5246
  # Returns information about health metrics for your Lightsail load
5136
5247
  # balancer.
5137
5248
  #
5249
+ # Metrics report the utilization of your resources, and the error counts
5250
+ # generated by them. Monitor and collect metric data regularly to
5251
+ # maintain the reliability, availability, and performance of your
5252
+ # resources.
5253
+ #
5138
5254
  # @option params [required, String] :load_balancer_name
5139
5255
  # The name of the load balancer.
5140
5256
  #
@@ -5145,7 +5261,7 @@ module Aws::Lightsail
5145
5261
  # useful `statistics` to include in your request, and the published
5146
5262
  # `unit` value.
5147
5263
  #
5148
- # * <b> <code>ClientTLSNegotiationErrorCount</code> </b> The number of
5264
+ # * <b> <code>ClientTLSNegotiationErrorCount</code> </b> - The number of
5149
5265
  # TLS connections initiated by the client that did not establish a
5150
5266
  # session with the load balancer due to a TLS error generated by the
5151
5267
  # load balancer. Possible causes include a mismatch of ciphers or
@@ -5155,7 +5271,7 @@ module Aws::Lightsail
5155
5271
  #
5156
5272
  # `Unit`\: The published unit is `Count`.
5157
5273
  #
5158
- # * <b> <code>HealthyHostCount</code> </b> The number of target
5274
+ # * <b> <code>HealthyHostCount</code> </b> - The number of target
5159
5275
  # instances that are considered healthy.
5160
5276
  #
5161
5277
  # `Statistics`\: The most useful statistic are `Average`, `Minimum`,
@@ -5163,7 +5279,7 @@ module Aws::Lightsail
5163
5279
  #
5164
5280
  # `Unit`\: The published unit is `Count`.
5165
5281
  #
5166
- # * <b> <code>HTTPCode_Instance_2XX_Count</code> </b> The number of
5282
+ # * <b> <code>HTTPCode_Instance_2XX_Count</code> </b> - The number of
5167
5283
  # HTTP 2XX response codes generated by the target instances. This does
5168
5284
  # not include any response codes generated by the load balancer.
5169
5285
  #
@@ -5172,7 +5288,7 @@ module Aws::Lightsail
5172
5288
  #
5173
5289
  # `Unit`\: The published unit is `Count`.
5174
5290
  #
5175
- # * <b> <code>HTTPCode_Instance_3XX_Count</code> </b> The number of
5291
+ # * <b> <code>HTTPCode_Instance_3XX_Count</code> </b> - The number of
5176
5292
  # HTTP 3XX response codes generated by the target instances. This does
5177
5293
  # not include any response codes generated by the load balancer.
5178
5294
  #
@@ -5181,7 +5297,7 @@ module Aws::Lightsail
5181
5297
  #
5182
5298
  # `Unit`\: The published unit is `Count`.
5183
5299
  #
5184
- # * <b> <code>HTTPCode_Instance_4XX_Count</code> </b> The number of
5300
+ # * <b> <code>HTTPCode_Instance_4XX_Count</code> </b> - The number of
5185
5301
  # HTTP 4XX response codes generated by the target instances. This does
5186
5302
  # not include any response codes generated by the load balancer.
5187
5303
  #
@@ -5190,7 +5306,7 @@ module Aws::Lightsail
5190
5306
  #
5191
5307
  # `Unit`\: The published unit is `Count`.
5192
5308
  #
5193
- # * <b> <code>HTTPCode_Instance_5XX_Count</code> </b> The number of
5309
+ # * <b> <code>HTTPCode_Instance_5XX_Count</code> </b> - The number of
5194
5310
  # HTTP 5XX response codes generated by the target instances. This does
5195
5311
  # not include any response codes generated by the load balancer.
5196
5312
  #
@@ -5199,7 +5315,7 @@ module Aws::Lightsail
5199
5315
  #
5200
5316
  # `Unit`\: The published unit is `Count`.
5201
5317
  #
5202
- # * <b> <code>HTTPCode_LB_4XX_Count</code> </b> The number of HTTP 4XX
5318
+ # * <b> <code>HTTPCode_LB_4XX_Count</code> </b> - The number of HTTP 4XX
5203
5319
  # client error codes that originated from the load balancer. Client
5204
5320
  # errors are generated when requests are malformed or incomplete.
5205
5321
  # These requests were not received by the target instance. This count
@@ -5210,7 +5326,7 @@ module Aws::Lightsail
5210
5326
  #
5211
5327
  # `Unit`\: The published unit is `Count`.
5212
5328
  #
5213
- # * <b> <code>HTTPCode_LB_5XX_Count</code> </b> The number of HTTP 5XX
5329
+ # * <b> <code>HTTPCode_LB_5XX_Count</code> </b> - The number of HTTP 5XX
5214
5330
  # server error codes that originated from the load balancer. This does
5215
5331
  # not include any response codes generated by the target instance.
5216
5332
  # This metric is reported if there are no healthy instances attached
@@ -5222,7 +5338,7 @@ module Aws::Lightsail
5222
5338
  #
5223
5339
  # `Unit`\: The published unit is `Count`.
5224
5340
  #
5225
- # * <b> <code>InstanceResponseTime</code> </b> The time elapsed, in
5341
+ # * <b> <code>InstanceResponseTime</code> </b> - The time elapsed, in
5226
5342
  # seconds, after the request leaves the load balancer until a response
5227
5343
  # from the target instance is received.
5228
5344
  #
@@ -5230,7 +5346,7 @@ module Aws::Lightsail
5230
5346
  #
5231
5347
  # `Unit`\: The published unit is `Seconds`.
5232
5348
  #
5233
- # * <b> <code>RejectedConnectionCount</code> </b> The number of
5349
+ # * <b> <code>RejectedConnectionCount</code> </b> - The number of
5234
5350
  # connections that were rejected because the load balancer had reached
5235
5351
  # its maximum number of connections.
5236
5352
  #
@@ -5238,7 +5354,7 @@ module Aws::Lightsail
5238
5354
  #
5239
5355
  # `Unit`\: The published unit is `Count`.
5240
5356
  #
5241
- # * <b> <code>RequestCount</code> </b> The number of requests
5357
+ # * <b> <code>RequestCount</code> </b> - The number of requests
5242
5358
  # processed over IPv4. This count includes only the requests with a
5243
5359
  # response generated by a target instance of the load balancer.
5244
5360
  #
@@ -5247,7 +5363,7 @@ module Aws::Lightsail
5247
5363
  #
5248
5364
  # `Unit`\: The published unit is `Count`.
5249
5365
  #
5250
- # * <b> <code>UnhealthyHostCount</code> </b> The number of target
5366
+ # * <b> <code>UnhealthyHostCount</code> </b> - The number of target
5251
5367
  # instances that are considered unhealthy.
5252
5368
  #
5253
5369
  # `Statistics`\: The most useful statistic are `Average`, `Minimum`,
@@ -5266,7 +5382,7 @@ module Aws::Lightsail
5266
5382
  #
5267
5383
  # @option params [required, String] :unit
5268
5384
  # The unit for the metric data request. Valid units depend on the metric
5269
- # data being required. For the valid units with each available metric,
5385
+ # data being requested. For the valid units with each available metric,
5270
5386
  # see the `metricName` parameter.
5271
5387
  #
5272
5388
  # @option params [required, Array<String>] :statistics
@@ -5274,26 +5390,26 @@ module Aws::Lightsail
5274
5390
  #
5275
5391
  # The following statistics are available:
5276
5392
  #
5277
- # * `Minimum` The lowest value observed during the specified period.
5393
+ # * `Minimum` - The lowest value observed during the specified period.
5278
5394
  # Use this value to determine low volumes of activity for your
5279
5395
  # application.
5280
5396
  #
5281
- # * `Maximum` The highest value observed during the specified period.
5397
+ # * `Maximum` - The highest value observed during the specified period.
5282
5398
  # Use this value to determine high volumes of activity for your
5283
5399
  # application.
5284
5400
  #
5285
- # * `Sum` All values submitted for the matching metric added together.
5401
+ # * `Sum` - All values submitted for the matching metric added together.
5286
5402
  # You can use this statistic to determine the total volume of a
5287
5403
  # metric.
5288
5404
  #
5289
- # * `Average` The value of Sum / SampleCount during the specified
5405
+ # * `Average` - The value of Sum / SampleCount during the specified
5290
5406
  # period. By comparing this statistic with the Minimum and Maximum
5291
5407
  # values, you can determine the full scope of a metric and how close
5292
5408
  # the average use is to the Minimum and Maximum values. This
5293
5409
  # comparison helps you to know when to increase or decrease your
5294
5410
  # resources.
5295
5411
  #
5296
- # * `SampleCount` The count, or number, of data points used for the
5412
+ # * `SampleCount` - The count, or number, of data points used for the
5297
5413
  # statistical calculation.
5298
5414
  #
5299
5415
  # @return [Types::GetLoadBalancerMetricDataResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -6043,6 +6159,11 @@ module Aws::Lightsail
6043
6159
  # Returns the data points of the specified metric for a database in
6044
6160
  # Amazon Lightsail.
6045
6161
  #
6162
+ # Metrics report the utilization of your resources, and the error counts
6163
+ # generated by them. Monitor and collect metric data regularly to
6164
+ # maintain the reliability, availability, and performance of your
6165
+ # resources.
6166
+ #
6046
6167
  # @option params [required, String] :relational_database_name
6047
6168
  # The name of your database from which to get metric data.
6048
6169
  #
@@ -6054,7 +6175,7 @@ module Aws::Lightsail
6054
6175
  # published `unit` value. All relational database metric data is
6055
6176
  # available in 1-minute (60 seconds) granularity.
6056
6177
  #
6057
- # * <b> <code>CPUUtilization</code> </b> The percentage of CPU
6178
+ # * <b> <code>CPUUtilization</code> </b> - The percentage of CPU
6058
6179
  # utilization currently in use on the database.
6059
6180
  #
6060
6181
  # `Statistics`\: The most useful statistics are `Maximum` and
@@ -6062,28 +6183,28 @@ module Aws::Lightsail
6062
6183
  #
6063
6184
  # `Unit`\: The published unit is `Percent`.
6064
6185
  #
6065
- # * <b> <code>DatabaseConnections</code> </b> The number of database
6186
+ # * <b> <code>DatabaseConnections</code> </b> - The number of database
6066
6187
  # connections in use.
6067
6188
  #
6068
6189
  # `Statistics`\: The most useful statistics are `Maximum` and `Sum`.
6069
6190
  #
6070
6191
  # `Unit`\: The published unit is `Count`.
6071
6192
  #
6072
- # * <b> <code>DiskQueueDepth</code> </b> The number of outstanding IOs
6193
+ # * <b> <code>DiskQueueDepth</code> </b> - The number of outstanding IOs
6073
6194
  # (read/write requests) that are waiting to access the disk.
6074
6195
  #
6075
6196
  # `Statistics`\: The most useful statistic is `Sum`.
6076
6197
  #
6077
6198
  # `Unit`\: The published unit is `Count`.
6078
6199
  #
6079
- # * <b> <code>FreeStorageSpace</code> </b> The amount of available
6200
+ # * <b> <code>FreeStorageSpace</code> </b> - The amount of available
6080
6201
  # storage space.
6081
6202
  #
6082
6203
  # `Statistics`\: The most useful statistic is `Sum`.
6083
6204
  #
6084
6205
  # `Unit`\: The published unit is `Bytes`.
6085
6206
  #
6086
- # * <b> <code>NetworkReceiveThroughput</code> </b> The incoming
6207
+ # * <b> <code>NetworkReceiveThroughput</code> </b> - The incoming
6087
6208
  # (Receive) network traffic on the database, including both customer
6088
6209
  # database traffic and AWS traffic used for monitoring and
6089
6210
  # replication.
@@ -6092,7 +6213,7 @@ module Aws::Lightsail
6092
6213
  #
6093
6214
  # `Unit`\: The published unit is `Bytes/Second`.
6094
6215
  #
6095
- # * <b> <code>NetworkTransmitThroughput</code> </b> The outgoing
6216
+ # * <b> <code>NetworkTransmitThroughput</code> </b> - The outgoing
6096
6217
  # (Transmit) network traffic on the database, including both customer
6097
6218
  # database traffic and AWS traffic used for monitoring and
6098
6219
  # replication.
@@ -6133,7 +6254,7 @@ module Aws::Lightsail
6133
6254
  #
6134
6255
  # @option params [required, String] :unit
6135
6256
  # The unit for the metric data request. Valid units depend on the metric
6136
- # data being required. For the valid units with each available metric,
6257
+ # data being requested. For the valid units with each available metric,
6137
6258
  # see the `metricName` parameter.
6138
6259
  #
6139
6260
  # @option params [required, Array<String>] :statistics
@@ -6141,26 +6262,26 @@ module Aws::Lightsail
6141
6262
  #
6142
6263
  # The following statistics are available:
6143
6264
  #
6144
- # * `Minimum` The lowest value observed during the specified period.
6265
+ # * `Minimum` - The lowest value observed during the specified period.
6145
6266
  # Use this value to determine low volumes of activity for your
6146
6267
  # application.
6147
6268
  #
6148
- # * `Maximum` The highest value observed during the specified period.
6269
+ # * `Maximum` - The highest value observed during the specified period.
6149
6270
  # Use this value to determine high volumes of activity for your
6150
6271
  # application.
6151
6272
  #
6152
- # * `Sum` All values submitted for the matching metric added together.
6273
+ # * `Sum` - All values submitted for the matching metric added together.
6153
6274
  # You can use this statistic to determine the total volume of a
6154
6275
  # metric.
6155
6276
  #
6156
- # * `Average` The value of Sum / SampleCount during the specified
6277
+ # * `Average` - The value of Sum / SampleCount during the specified
6157
6278
  # period. By comparing this statistic with the Minimum and Maximum
6158
6279
  # values, you can determine the full scope of a metric and how close
6159
6280
  # the average use is to the Minimum and Maximum values. This
6160
6281
  # comparison helps you to know when to increase or decrease your
6161
6282
  # resources.
6162
6283
  #
6163
- # * `SampleCount` The count, or number, of data points used for the
6284
+ # * `SampleCount` - The count, or number, of data points used for the
6164
6285
  # statistical calculation.
6165
6286
  #
6166
6287
  # @return [Types::GetRelationalDatabaseMetricDataResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -6572,11 +6693,13 @@ module Aws::Lightsail
6572
6693
  req.send_request(options)
6573
6694
  end
6574
6695
 
6575
- # Adds public ports to an Amazon Lightsail instance.
6696
+ # Opens ports for a specific Amazon Lightsail instance, and specifies
6697
+ # the IP addresses allowed to connect to the instance through the ports,
6698
+ # and the protocol.
6576
6699
  #
6577
- # The `open instance public ports` operation supports tag-based access
6578
- # control via resource tags applied to the resource identified by
6579
- # `instance name`. For more information, see the [Lightsail Dev
6700
+ # The `OpenInstancePublicPorts` action supports tag-based access control
6701
+ # via resource tags applied to the resource identified by
6702
+ # `instanceName`. For more information, see the [Lightsail Dev
6580
6703
  # Guide][1].
6581
6704
  #
6582
6705
  #
@@ -6584,11 +6707,10 @@ module Aws::Lightsail
6584
6707
  # [1]: https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags
6585
6708
  #
6586
6709
  # @option params [required, Types::PortInfo] :port_info
6587
- # An array of key-value pairs containing information about the port
6588
- # mappings.
6710
+ # An object to describe the ports to open for the specified instance.
6589
6711
  #
6590
6712
  # @option params [required, String] :instance_name
6591
- # The name of the instance for which you want to open the public ports.
6713
+ # The name of the instance for which to open ports.
6592
6714
  #
6593
6715
  # @return [Types::OpenInstancePublicPortsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6594
6716
  #
@@ -6600,7 +6722,9 @@ module Aws::Lightsail
6600
6722
  # port_info: { # required
6601
6723
  # from_port: 1,
6602
6724
  # to_port: 1,
6603
- # protocol: "tcp", # accepts tcp, all, udp
6725
+ # protocol: "tcp", # accepts tcp, all, udp, icmp
6726
+ # cidrs: ["string"],
6727
+ # cidr_list_aliases: ["string"],
6604
6728
  # },
6605
6729
  # instance_name: "ResourceName", # required
6606
6730
  # })
@@ -6693,9 +6817,9 @@ module Aws::Lightsail
6693
6817
  #
6694
6818
  # The following metrics are available for each resource type:
6695
6819
  #
6696
- # * **Instances**\: `CPUUtilization`, `NetworkIn`, `NetworkOut`,
6697
- # `StatusCheckFailed`, `StatusCheckFailed_Instance`, and
6698
- # `StatusCheckFailed_System`.
6820
+ # * **Instances**\: `BurstCapacityPercentage`, `BurstCapacityTime`,
6821
+ # `CPUUtilization`, `NetworkIn`, `NetworkOut`, `StatusCheckFailed`,
6822
+ # `StatusCheckFailed_Instance`, and `StatusCheckFailed_System`.
6699
6823
  #
6700
6824
  # * **Load balancers**\: `ClientTLSNegotiationErrorCount`,
6701
6825
  # `HealthyHostCount`, `UnhealthyHostCount`, `HTTPCode_LB_4XX_Count`,
@@ -6708,6 +6832,13 @@ module Aws::Lightsail
6708
6832
  # `DiskQueueDepth`, `FreeStorageSpace`, `NetworkReceiveThroughput`,
6709
6833
  # and `NetworkTransmitThroughput`.
6710
6834
  #
6835
+ # For more information about these metrics, see [Metrics available in
6836
+ # Lightsail][1].
6837
+ #
6838
+ #
6839
+ #
6840
+ # [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-resource-health-metrics#available-metrics
6841
+ #
6711
6842
  # @option params [required, String] :monitored_resource_name
6712
6843
  # The name of the Lightsail resource that will be monitored.
6713
6844
  #
@@ -6748,18 +6879,18 @@ module Aws::Lightsail
6748
6879
  #
6749
6880
  # An alarm can treat missing data in the following ways:
6750
6881
  #
6751
- # * `breaching` Assume the missing data is not within the threshold.
6882
+ # * `breaching` - Assume the missing data is not within the threshold.
6752
6883
  # Missing data counts towards the number of times the metric is not
6753
6884
  # within the threshold.
6754
6885
  #
6755
- # * `notBreaching` Assume the missing data is within the threshold.
6886
+ # * `notBreaching` - Assume the missing data is within the threshold.
6756
6887
  # Missing data does not count towards the number of times the metric
6757
6888
  # is not within the threshold.
6758
6889
  #
6759
- # * `ignore` Ignore the missing data. Maintains the current alarm
6890
+ # * `ignore` - Ignore the missing data. Maintains the current alarm
6760
6891
  # state.
6761
6892
  #
6762
- # * `missing` Missing data is treated as missing.
6893
+ # * `missing` - Missing data is treated as missing.
6763
6894
  #
6764
6895
  # If `treatMissingData` is not specified, the default behavior of
6765
6896
  # `missing` is used.
@@ -6785,13 +6916,13 @@ module Aws::Lightsail
6785
6916
  #
6786
6917
  # An alarm has the following possible states:
6787
6918
  #
6788
- # * `ALARM` The metric is outside of the defined threshold.
6919
+ # * `ALARM` - The metric is outside of the defined threshold.
6789
6920
  #
6790
- # * `INSUFFICIENT_DATA` The alarm has just started, the metric is not
6921
+ # * `INSUFFICIENT_DATA` - The alarm has just started, the metric is not
6791
6922
  # available, or not enough data is available for the metric to
6792
6923
  # determine the alarm state.
6793
6924
  #
6794
- # * `OK` The metric is within the defined threshold.
6925
+ # * `OK` - The metric is within the defined threshold.
6795
6926
  #
6796
6927
  # When you specify a notification trigger, the `ALARM` state must be
6797
6928
  # specified. The `INSUFFICIENT_DATA` and `OK` states can be specified in
@@ -6823,7 +6954,7 @@ module Aws::Lightsail
6823
6954
  #
6824
6955
  # resp = client.put_alarm({
6825
6956
  # alarm_name: "ResourceName", # required
6826
- # metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System, ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, RequestCount, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, NetworkTransmitThroughput
6957
+ # metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System, ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, RequestCount, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, NetworkTransmitThroughput, BurstCapacityTime, BurstCapacityPercentage
6827
6958
  # monitored_resource_name: "ResourceName", # required
6828
6959
  # comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
6829
6960
  # threshold: 1.0, # required
@@ -6861,13 +6992,17 @@ module Aws::Lightsail
6861
6992
  req.send_request(options)
6862
6993
  end
6863
6994
 
6864
- # Sets the specified open ports for an Amazon Lightsail instance, and
6865
- # closes all ports for every protocol not included in the current
6866
- # request.
6867
- #
6868
- # The `put instance public ports` operation supports tag-based access
6869
- # control via resource tags applied to the resource identified by
6870
- # `instance name`. For more information, see the [Lightsail Dev
6995
+ # Opens ports for a specific Amazon Lightsail instance, and specifies
6996
+ # the IP addresses allowed to connect to the instance through the ports,
6997
+ # and the protocol. This action also closes all currently open ports
6998
+ # that are not included in the request. Include all of the ports and the
6999
+ # protocols you want to open in your `PutInstancePublicPorts`request. Or
7000
+ # use the `OpenInstancePublicPorts` action to open ports without closing
7001
+ # currently open ports.
7002
+ #
7003
+ # The `PutInstancePublicPorts` action supports tag-based access control
7004
+ # via resource tags applied to the resource identified by
7005
+ # `instanceName`. For more information, see the [Lightsail Dev
6871
7006
  # Guide][1].
6872
7007
  #
6873
7008
  #
@@ -6875,10 +7010,11 @@ module Aws::Lightsail
6875
7010
  # [1]: https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags
6876
7011
  #
6877
7012
  # @option params [required, Array<Types::PortInfo>] :port_infos
6878
- # Specifies information about the public port(s).
7013
+ # An array of objects to describe the ports to open for the specified
7014
+ # instance.
6879
7015
  #
6880
7016
  # @option params [required, String] :instance_name
6881
- # The Lightsail instance name of the public port(s) you are setting.
7017
+ # The name of the instance for which to open ports.
6882
7018
  #
6883
7019
  # @return [Types::PutInstancePublicPortsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6884
7020
  #
@@ -6891,7 +7027,9 @@ module Aws::Lightsail
6891
7027
  # {
6892
7028
  # from_port: 1,
6893
7029
  # to_port: 1,
6894
- # protocol: "tcp", # accepts tcp, all, udp
7030
+ # protocol: "tcp", # accepts tcp, all, udp, icmp
7031
+ # cidrs: ["string"],
7032
+ # cidr_list_aliases: ["string"],
6895
7033
  # },
6896
7034
  # ],
6897
7035
  # instance_name: "ResourceName", # required
@@ -7062,8 +7200,9 @@ module Aws::Lightsail
7062
7200
  req.send_request(options)
7063
7201
  end
7064
7202
 
7065
- # Sends a verification request to an email contact method to ensure it’s
7066
- # owned by the requester. SMS contact methods dont need to be verified.
7203
+ # Sends a verification request to an email contact method to ensure
7204
+ # it's owned by the requester. SMS contact methods don't need to be
7205
+ # verified.
7067
7206
  #
7068
7207
  # A contact method is used to send you notifications about your Amazon
7069
7208
  # Lightsail resources. You can add one email address and one mobile
@@ -7444,13 +7583,13 @@ module Aws::Lightsail
7444
7583
  #
7445
7584
  # An alarm has the following possible states that can be tested:
7446
7585
  #
7447
- # * `ALARM` The metric is outside of the defined threshold.
7586
+ # * `ALARM` - The metric is outside of the defined threshold.
7448
7587
  #
7449
- # * `INSUFFICIENT_DATA` The alarm has just started, the metric is not
7588
+ # * `INSUFFICIENT_DATA` - The alarm has just started, the metric is not
7450
7589
  # available, or not enough data is available for the metric to
7451
7590
  # determine the alarm state.
7452
7591
  #
7453
- # * `OK` The metric is within the defined threshold.
7592
+ # * `OK` - The metric is within the defined threshold.
7454
7593
  #
7455
7594
  # @return [Types::TestAlarmResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7456
7595
  #
@@ -7937,7 +8076,7 @@ module Aws::Lightsail
7937
8076
  params: params,
7938
8077
  config: config)
7939
8078
  context[:gem_name] = 'aws-sdk-lightsail'
7940
- context[:gem_version] = '1.28.1'
8079
+ context[:gem_version] = '1.33.1'
7941
8080
  Seahorse::Client::Request.new(handlers, context)
7942
8081
  end
7943
8082