aws-sdk-lightsail 1.74.0 → 1.75.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -369,13 +369,28 @@ module Aws::Lightsail
369
369
  # to 45 minutes after.
370
370
  # @return [String]
371
371
  #
372
+ # @!attribute [rw] threshold
373
+ # The trigger threshold of the action.
374
+ #
375
+ # This add-on only applies to Lightsail for Research resources.
376
+ # @return [String]
377
+ #
378
+ # @!attribute [rw] duration
379
+ # The amount of idle time in minutes after which your virtual computer
380
+ # will automatically stop.
381
+ #
382
+ # This add-on only applies to Lightsail for Research resources.
383
+ # @return [String]
384
+ #
372
385
  # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AddOn AWS API Documentation
373
386
  #
374
387
  class AddOn < Struct.new(
375
388
  :name,
376
389
  :status,
377
390
  :snapshot_time_of_day,
378
- :next_snapshot_time_of_day)
391
+ :next_snapshot_time_of_day,
392
+ :threshold,
393
+ :duration)
379
394
  SENSITIVE = []
380
395
  include Aws::Structure
381
396
  end
@@ -401,11 +416,19 @@ module Aws::Lightsail
401
416
  # modifying the automatic snapshot add-on.
402
417
  # @return [Types::AutoSnapshotAddOnRequest]
403
418
  #
419
+ # @!attribute [rw] stop_instance_on_idle_request
420
+ # An object that represents additional parameters when enabling or
421
+ # modifying the `StopInstanceOnIdle` add-on.
422
+ #
423
+ # This object only applies to Lightsail for Research resources.
424
+ # @return [Types::StopInstanceOnIdleRequest]
425
+ #
404
426
  # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AddOnRequest AWS API Documentation
405
427
  #
406
428
  class AddOnRequest < Struct.new(
407
429
  :add_on_type,
408
- :auto_snapshot_add_on_request)
430
+ :auto_snapshot_add_on_request,
431
+ :stop_instance_on_idle_request)
409
432
  SENSITIVE = []
410
433
  include Aws::Structure
411
434
  end
@@ -670,12 +693,20 @@ module Aws::Lightsail
670
693
  # The disk path to expose to the instance (e.g., `/dev/xvdf`).
671
694
  # @return [String]
672
695
  #
696
+ # @!attribute [rw] auto_mounting
697
+ # A Boolean value used to determine the automatic mounting of a
698
+ # storage volume to a virtual computer. The default value is `False`.
699
+ #
700
+ # This value only applies to Lightsail for Research resources.
701
+ # @return [Boolean]
702
+ #
673
703
  # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachDiskRequest AWS API Documentation
674
704
  #
675
705
  class AttachDiskRequest < Struct.new(
676
706
  :disk_name,
677
707
  :instance_name,
678
- :disk_path)
708
+ :disk_path,
709
+ :auto_mounting)
679
710
  SENSITIVE = []
680
711
  include Aws::Structure
681
712
  end
@@ -987,6 +1018,13 @@ module Aws::Lightsail
987
1018
  # Server-based) of the blueprint.
988
1019
  # @return [String]
989
1020
  #
1021
+ # @!attribute [rw] app_category
1022
+ # Virtual computer blueprints that are supported by Lightsail for
1023
+ # Research.
1024
+ #
1025
+ # This parameter only applies to Lightsail for Research resources.
1026
+ # @return [String]
1027
+ #
990
1028
  # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Blueprint AWS API Documentation
991
1029
  #
992
1030
  class Blueprint < Struct.new(
@@ -1001,7 +1039,8 @@ module Aws::Lightsail
1001
1039
  :version_code,
1002
1040
  :product_url,
1003
1041
  :license_url,
1004
- :platform)
1042
+ :platform,
1043
+ :app_category)
1005
1044
  SENSITIVE = []
1006
1045
  include Aws::Structure
1007
1046
  end
@@ -1322,6 +1361,13 @@ module Aws::Lightsail
1322
1361
  # platform. `LINUX_UNIX` blueprints require a `LINUX_UNIX` bundle.
1323
1362
  # @return [Array<String>]
1324
1363
  #
1364
+ # @!attribute [rw] supported_app_categories
1365
+ # Virtual computer blueprints that are supported by a Lightsail for
1366
+ # Research bundle.
1367
+ #
1368
+ # This parameter only applies to Lightsail for Research resources.
1369
+ # @return [Array<String>]
1370
+ #
1325
1371
  # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Bundle AWS API Documentation
1326
1372
  #
1327
1373
  class Bundle < Struct.new(
@@ -1335,7 +1381,8 @@ module Aws::Lightsail
1335
1381
  :power,
1336
1382
  :ram_size_in_gb,
1337
1383
  :transfer_per_month_in_gb,
1338
- :supported_platforms)
1384
+ :supported_platforms,
1385
+ :supported_app_categories)
1339
1386
  SENSITIVE = []
1340
1387
  include Aws::Structure
1341
1388
  end
@@ -2765,6 +2812,27 @@ module Aws::Lightsail
2765
2812
  include Aws::Structure
2766
2813
  end
2767
2814
 
2815
+ # Describes the estimated cost for resources in your Lightsail for
2816
+ # Research account.
2817
+ #
2818
+ # @!attribute [rw] usage_type
2819
+ # The types of usage that are included in the estimate, such as costs,
2820
+ # usage, or data transfer.
2821
+ # @return [String]
2822
+ #
2823
+ # @!attribute [rw] results_by_time
2824
+ # The cost estimate result that's associated with a time period.
2825
+ # @return [Array<Types::EstimateByTime>]
2826
+ #
2827
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CostEstimate AWS API Documentation
2828
+ #
2829
+ class CostEstimate < Struct.new(
2830
+ :usage_type,
2831
+ :results_by_time)
2832
+ SENSITIVE = []
2833
+ include Aws::Structure
2834
+ end
2835
+
2768
2836
  # @!attribute [rw] bucket_name
2769
2837
  # The name of the bucket that the new access key will belong to, and
2770
2838
  # grant access to.
@@ -3633,6 +3701,50 @@ module Aws::Lightsail
3633
3701
  include Aws::Structure
3634
3702
  end
3635
3703
 
3704
+ # @!attribute [rw] resource_name
3705
+ # The resource name.
3706
+ # @return [String]
3707
+ #
3708
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateGUISessionAccessDetailsRequest AWS API Documentation
3709
+ #
3710
+ class CreateGUISessionAccessDetailsRequest < Struct.new(
3711
+ :resource_name)
3712
+ SENSITIVE = []
3713
+ include Aws::Structure
3714
+ end
3715
+
3716
+ # @!attribute [rw] resource_name
3717
+ # The resource name.
3718
+ # @return [String]
3719
+ #
3720
+ # @!attribute [rw] status
3721
+ # The status of the operation.
3722
+ # @return [String]
3723
+ #
3724
+ # @!attribute [rw] percentage_complete
3725
+ # The percentage of completion for the operation.
3726
+ # @return [Integer]
3727
+ #
3728
+ # @!attribute [rw] failure_reason
3729
+ # The reason the operation failed.
3730
+ # @return [String]
3731
+ #
3732
+ # @!attribute [rw] sessions
3733
+ # Returns information about the specified NICE DCV GUI session.
3734
+ # @return [Array<Types::Session>]
3735
+ #
3736
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateGUISessionAccessDetailsResult AWS API Documentation
3737
+ #
3738
+ class CreateGUISessionAccessDetailsResult < Struct.new(
3739
+ :resource_name,
3740
+ :status,
3741
+ :percentage_complete,
3742
+ :failure_reason,
3743
+ :sessions)
3744
+ SENSITIVE = []
3745
+ include Aws::Structure
3746
+ end
3747
+
3636
3748
  # @!attribute [rw] instance_snapshot_name
3637
3749
  # The name for your new snapshot.
3638
3750
  # @return [String]
@@ -5523,6 +5635,13 @@ module Aws::Lightsail
5523
5635
  # </note>
5524
5636
  # @return [Integer]
5525
5637
  #
5638
+ # @!attribute [rw] auto_mount_status
5639
+ # The status of automatically mounting a storage disk to a virtual
5640
+ # computer.
5641
+ #
5642
+ # This parameter only applies to Lightsail for Research resources.
5643
+ # @return [String]
5644
+ #
5526
5645
  # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Disk AWS API Documentation
5527
5646
  #
5528
5647
  class Disk < Struct.new(
@@ -5542,7 +5661,8 @@ module Aws::Lightsail
5542
5661
  :attached_to,
5543
5662
  :is_attached,
5544
5663
  :attachment_state,
5545
- :gb_in_use)
5664
+ :gb_in_use,
5665
+ :auto_mount_status)
5546
5666
  SENSITIVE = []
5547
5667
  include Aws::Structure
5548
5668
  end
@@ -6060,6 +6180,43 @@ module Aws::Lightsail
6060
6180
  include Aws::Structure
6061
6181
  end
6062
6182
 
6183
+ # An estimate that's associated with a time period.
6184
+ #
6185
+ # @!attribute [rw] usage_cost
6186
+ # The amount of cost or usage that's measured for the cost estimate.
6187
+ # @return [Float]
6188
+ #
6189
+ # @!attribute [rw] pricing_unit
6190
+ # The unit of measurement that's used for the cost estimate.
6191
+ # @return [String]
6192
+ #
6193
+ # @!attribute [rw] unit
6194
+ # The number of pricing units used to calculate the total number of
6195
+ # hours. For example, 1 unit equals 1 hour.
6196
+ # @return [Float]
6197
+ #
6198
+ # @!attribute [rw] currency
6199
+ # The currency of the estimate in USD.
6200
+ # @return [String]
6201
+ #
6202
+ # @!attribute [rw] time_period
6203
+ # The period of time, in days, that an estimate covers. The period has
6204
+ # a start date and an end date. The start date must come before the
6205
+ # end date.
6206
+ # @return [Types::TimePeriod]
6207
+ #
6208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/EstimateByTime AWS API Documentation
6209
+ #
6210
+ class EstimateByTime < Struct.new(
6211
+ :usage_cost,
6212
+ :pricing_unit,
6213
+ :unit,
6214
+ :currency,
6215
+ :time_period)
6216
+ SENSITIVE = []
6217
+ include Aws::Structure
6218
+ end
6219
+
6063
6220
  # Describes an export snapshot record.
6064
6221
  #
6065
6222
  # @!attribute [rw] name
@@ -6336,11 +6493,20 @@ module Aws::Lightsail
6336
6493
  # request.
6337
6494
  # @return [String]
6338
6495
  #
6496
+ # @!attribute [rw] app_category
6497
+ # Returns a list of blueprints that are specific to Lightsail for
6498
+ # Research.
6499
+ #
6500
+ # You must use this parameter to view Lightsail for Research
6501
+ # blueprints.
6502
+ # @return [String]
6503
+ #
6339
6504
  # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBlueprintsRequest AWS API Documentation
6340
6505
  #
6341
6506
  class GetBlueprintsRequest < Struct.new(
6342
6507
  :include_inactive,
6343
- :page_token)
6508
+ :page_token,
6509
+ :app_category)
6344
6510
  SENSITIVE = []
6345
6511
  include Aws::Structure
6346
6512
  end
@@ -6628,11 +6794,19 @@ module Aws::Lightsail
6628
6794
  # request.
6629
6795
  # @return [String]
6630
6796
  #
6797
+ # @!attribute [rw] app_category
6798
+ # Returns a list of bundles that are specific to Lightsail for
6799
+ # Research.
6800
+ #
6801
+ # You must use this parameter to view Lightsail for Research bundles.
6802
+ # @return [String]
6803
+ #
6631
6804
  # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBundlesRequest AWS API Documentation
6632
6805
  #
6633
6806
  class GetBundlesRequest < Struct.new(
6634
6807
  :include_inactive,
6635
- :page_token)
6808
+ :page_token,
6809
+ :app_category)
6636
6810
  SENSITIVE = []
6637
6811
  include Aws::Structure
6638
6812
  end
@@ -7105,6 +7279,72 @@ module Aws::Lightsail
7105
7279
  include Aws::Structure
7106
7280
  end
7107
7281
 
7282
+ # @!attribute [rw] resource_name
7283
+ # The resource name.
7284
+ # @return [String]
7285
+ #
7286
+ # @!attribute [rw] start_time
7287
+ # The cost estimate start time.
7288
+ #
7289
+ # Constraints:
7290
+ #
7291
+ # * Specified in Coordinated Universal Time (UTC).
7292
+ #
7293
+ # * Specified in the Unix time format.
7294
+ #
7295
+ # For example, if you wish to use a start time of October 1, 2018,
7296
+ # at 8 PM UTC, specify `1538424000` as the start time.
7297
+ #
7298
+ # You can convert a human-friendly time to Unix time format using a
7299
+ # converter like [Epoch converter][1].
7300
+ #
7301
+ #
7302
+ #
7303
+ # [1]: https://www.epochconverter.com/
7304
+ # @return [Time]
7305
+ #
7306
+ # @!attribute [rw] end_time
7307
+ # The cost estimate end time.
7308
+ #
7309
+ # Constraints:
7310
+ #
7311
+ # * Specified in Coordinated Universal Time (UTC).
7312
+ #
7313
+ # * Specified in the Unix time format.
7314
+ #
7315
+ # For example, if you wish to use an end time of October 1, 2018, at
7316
+ # 9 PM UTC, specify `1538427600` as the end time.
7317
+ #
7318
+ # You can convert a human-friendly time to Unix time format using a
7319
+ # converter like [Epoch converter][1].
7320
+ #
7321
+ #
7322
+ #
7323
+ # [1]: https://www.epochconverter.com/
7324
+ # @return [Time]
7325
+ #
7326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCostEstimateRequest AWS API Documentation
7327
+ #
7328
+ class GetCostEstimateRequest < Struct.new(
7329
+ :resource_name,
7330
+ :start_time,
7331
+ :end_time)
7332
+ SENSITIVE = []
7333
+ include Aws::Structure
7334
+ end
7335
+
7336
+ # @!attribute [rw] resources_budget_estimate
7337
+ # Returns the estimate's forecasted cost or usage.
7338
+ # @return [Array<Types::ResourceBudgetEstimate>]
7339
+ #
7340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCostEstimateResult AWS API Documentation
7341
+ #
7342
+ class GetCostEstimateResult < Struct.new(
7343
+ :resources_budget_estimate)
7344
+ SENSITIVE = []
7345
+ include Aws::Structure
7346
+ end
7347
+
7108
7348
  # @!attribute [rw] disk_name
7109
7349
  # The name of the disk (e.g., `my-disk`).
7110
7350
  # @return [String]
@@ -13090,6 +13330,40 @@ module Aws::Lightsail
13090
13330
  include Aws::Structure
13091
13331
  end
13092
13332
 
13333
+ # Describes the estimated cost or usage that a budget tracks.
13334
+ #
13335
+ # @!attribute [rw] resource_name
13336
+ # The resource name.
13337
+ # @return [String]
13338
+ #
13339
+ # @!attribute [rw] resource_type
13340
+ # The type of resource the budget will track.
13341
+ # @return [String]
13342
+ #
13343
+ # @!attribute [rw] cost_estimates
13344
+ # The cost estimate for the specified budget.
13345
+ # @return [Array<Types::CostEstimate>]
13346
+ #
13347
+ # @!attribute [rw] start_time
13348
+ # The estimate start time.
13349
+ # @return [Time]
13350
+ #
13351
+ # @!attribute [rw] end_time
13352
+ # The estimate end time.
13353
+ # @return [Time]
13354
+ #
13355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ResourceBudgetEstimate AWS API Documentation
13356
+ #
13357
+ class ResourceBudgetEstimate < Struct.new(
13358
+ :resource_name,
13359
+ :resource_type,
13360
+ :cost_estimates,
13361
+ :start_time,
13362
+ :end_time)
13363
+ SENSITIVE = []
13364
+ include Aws::Structure
13365
+ end
13366
+
13093
13367
  # Describes the resource location.
13094
13368
  #
13095
13369
  # @!attribute [rw] availability_zone
@@ -13206,6 +13480,33 @@ module Aws::Lightsail
13206
13480
  include Aws::Structure
13207
13481
  end
13208
13482
 
13483
+ # Describes a web-based, remote graphical user interface (GUI), NICE DCV
13484
+ # session. The session is used to access a virtual computer’s operating
13485
+ # system or application.
13486
+ #
13487
+ # @!attribute [rw] name
13488
+ # The session name.
13489
+ # @return [String]
13490
+ #
13491
+ # @!attribute [rw] url
13492
+ # The session URL.
13493
+ # @return [String]
13494
+ #
13495
+ # @!attribute [rw] is_primary
13496
+ # When true, this Boolean value indicates the primary session for the
13497
+ # specified resource.
13498
+ # @return [Boolean]
13499
+ #
13500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Session AWS API Documentation
13501
+ #
13502
+ class Session < Struct.new(
13503
+ :name,
13504
+ :url,
13505
+ :is_primary)
13506
+ SENSITIVE = [:url]
13507
+ include Aws::Structure
13508
+ end
13509
+
13209
13510
  # @!attribute [rw] resource_type
13210
13511
  # The resource type.
13211
13512
  #
@@ -13300,6 +13601,30 @@ module Aws::Lightsail
13300
13601
  include Aws::Structure
13301
13602
  end
13302
13603
 
13604
+ # @!attribute [rw] resource_name
13605
+ # The resource name.
13606
+ # @return [String]
13607
+ #
13608
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartGUISessionRequest AWS API Documentation
13609
+ #
13610
+ class StartGUISessionRequest < Struct.new(
13611
+ :resource_name)
13612
+ SENSITIVE = []
13613
+ include Aws::Structure
13614
+ end
13615
+
13616
+ # @!attribute [rw] operations
13617
+ # The available API operations.
13618
+ # @return [Array<Types::Operation>]
13619
+ #
13620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartGUISessionResult AWS API Documentation
13621
+ #
13622
+ class StartGUISessionResult < Struct.new(
13623
+ :operations)
13624
+ SENSITIVE = []
13625
+ include Aws::Structure
13626
+ end
13627
+
13303
13628
  # @!attribute [rw] instance_name
13304
13629
  # The name of the instance (a virtual private server) to start.
13305
13630
  # @return [String]
@@ -13412,6 +13737,52 @@ module Aws::Lightsail
13412
13737
  include Aws::Structure
13413
13738
  end
13414
13739
 
13740
+ # @!attribute [rw] resource_name
13741
+ # The resource name.
13742
+ # @return [String]
13743
+ #
13744
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopGUISessionRequest AWS API Documentation
13745
+ #
13746
+ class StopGUISessionRequest < Struct.new(
13747
+ :resource_name)
13748
+ SENSITIVE = []
13749
+ include Aws::Structure
13750
+ end
13751
+
13752
+ # @!attribute [rw] operations
13753
+ # The available API operations.
13754
+ # @return [Array<Types::Operation>]
13755
+ #
13756
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopGUISessionResult AWS API Documentation
13757
+ #
13758
+ class StopGUISessionResult < Struct.new(
13759
+ :operations)
13760
+ SENSITIVE = []
13761
+ include Aws::Structure
13762
+ end
13763
+
13764
+ # Describes a request to create or edit the `StopInstanceOnIdle` add-on.
13765
+ #
13766
+ # This add-on only applies to Lightsail for Research resources.
13767
+ #
13768
+ # @!attribute [rw] threshold
13769
+ # The value to compare with the duration.
13770
+ # @return [String]
13771
+ #
13772
+ # @!attribute [rw] duration
13773
+ # The amount of idle time in minutes after which your virtual computer
13774
+ # will automatically stop.
13775
+ # @return [String]
13776
+ #
13777
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopInstanceOnIdleRequest AWS API Documentation
13778
+ #
13779
+ class StopInstanceOnIdleRequest < Struct.new(
13780
+ :threshold,
13781
+ :duration)
13782
+ SENSITIVE = []
13783
+ include Aws::Structure
13784
+ end
13785
+
13415
13786
  # @!attribute [rw] instance_name
13416
13787
  # The name of the instance (a virtual private server) to stop.
13417
13788
  # @return [String]
@@ -13591,6 +13962,36 @@ module Aws::Lightsail
13591
13962
  include Aws::Structure
13592
13963
  end
13593
13964
 
13965
+ # Sets the start date and end date for retrieving a cost estimate. The
13966
+ # start date is inclusive, but the end date is exclusive. For example,
13967
+ # if `start` is `2017-01-01` and `end` is `2017-05-01`, then the cost
13968
+ # and usage data is retrieved from `2017-01-01` up to and including
13969
+ # `2017-04-30` but not including `2017-05-01`.
13970
+ #
13971
+ # @!attribute [rw] start
13972
+ # The beginning of the time period. The start date is inclusive. For
13973
+ # example, if `start` is `2017-01-01`, Lightsail for Research
13974
+ # retrieves cost and usage data starting at `2017-01-01` up to the end
13975
+ # date. The start date must be equal to or no later than the current
13976
+ # date to avoid a validation error.
13977
+ # @return [Time]
13978
+ #
13979
+ # @!attribute [rw] end
13980
+ # The end of the time period. The end date is exclusive. For example,
13981
+ # if `end` is `2017-05-01`, Lightsail for Research retrieves cost and
13982
+ # usage data from the start date up to, but not including,
13983
+ # `2017-05-01`.
13984
+ # @return [Time]
13985
+ #
13986
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/TimePeriod AWS API Documentation
13987
+ #
13988
+ class TimePeriod < Struct.new(
13989
+ :start,
13990
+ :end)
13991
+ SENSITIVE = []
13992
+ include Aws::Structure
13993
+ end
13994
+
13594
13995
  # Lightsail throws this exception when the user has not been
13595
13996
  # authenticated.
13596
13997
  #
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-lightsail/customizations'
52
52
  # @!group service
53
53
  module Aws::Lightsail
54
54
 
55
- GEM_VERSION = '1.74.0'
55
+ GEM_VERSION = '1.75.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-lightsail
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.74.0
4
+ version: 1.75.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-02-09 00:00:00.000000000 Z
11
+ date: 2023-02-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core