aws-sdk-ec2 1.402.0 → 1.547.0

data/lib/aws-sdk-ec2/image.rb

@@ -35,58 +35,6 @@ module Aws::EC2
     end
     alias :image_id :id
 
-    # The architecture of the image.
-    # @return [String]
-    def architecture
-      data[:architecture]
-    end
-
-    # The date and time the image was created.
-    # @return [String]
-    def creation_date
-      data[:creation_date]
-    end
-
-    # The location of the AMI.
-    # @return [String]
-    def image_location
-      data[:image_location]
-    end
-
-    # The type of image.
-    # @return [String]
-    def image_type
-      data[:image_type]
-    end
-
-    # Indicates whether the image has public launch permissions. The value
-    # is `true` if this image has public launch permissions or `false` if it
-    # has only implicit and explicit launch permissions.
-    # @return [Boolean]
-    def public
-      data[:public]
-    end
-
-    # The kernel associated with the image, if any. Only applicable for
-    # machine images.
-    # @return [String]
-    def kernel_id
-      data[:kernel_id]
-    end
-
-    # The ID of the Amazon Web Services account that owns the image.
-    # @return [String]
-    def owner_id
-      data[:owner_id]
-    end
-
-    # This value is set to `windows` for Windows AMIs; otherwise, it is
-    # blank.
-    # @return [String]
-    def platform
-      data[:platform]
-    end
-
     # The platform details associated with the billing code of the AMI. For
     # more information, see [Understand AMI billing information][1] in the
     # *Amazon EC2 User Guide*.
@@ -119,26 +67,6 @@ module Aws::EC2
       data[:usage_operation]
     end
 
-    # Any product codes associated with the AMI.
-    # @return [Array<Types::ProductCode>]
-    def product_codes
-      data[:product_codes]
-    end
-
-    # The RAM disk associated with the image, if any. Only applicable for
-    # machine images.
-    # @return [String]
-    def ramdisk_id
-      data[:ramdisk_id]
-    end
-
-    # The current state of the AMI. If the state is `available`, the image
-    # is successfully registered and can be used to launch an instance.
-    # @return [String]
-    def state
-      data[:state]
-    end
-
     # Any block device mapping entries.
     # @return [Array<Types::BlockDeviceMapping>]
     def block_device_mappings
@@ -157,14 +85,14 @@ module Aws::EC2
       data[:ena_support]
     end
 
-    # The hypervisor type of the image.
+    # The hypervisor type of the image. Only `xen` is supported. `ovm` is
+    # not supported.
     # @return [String]
     def hypervisor
       data[:hypervisor]
     end
 
-    # The Amazon Web Services account alias (for example, `amazon`, `self`)
-    # or the Amazon Web Services account ID of the AMI owner.
+    # The owner alias (`amazon` \| `aws-backup-vault` \| `aws-marketplace`).
     # @return [String]
     def image_owner_alias
       data[:image_owner_alias]
@@ -214,8 +142,9 @@ module Aws::EC2
       data[:virtualization_type]
     end
 
-    # The boot mode of the image. For more information, see [Boot modes][1]
-    # in the *Amazon EC2 User Guide*.
+    # The boot mode of the image. For more information, see [Instance launch
+    # behavior with Amazon EC2 boot modes][1] in the *Amazon EC2 User
+    # Guide*.
     #
     #
     #
@@ -260,6 +189,175 @@ module Aws::EC2
       data[:imds_support]
     end
 
+    # The ID of the instance that the AMI was created from if the AMI was
+    # created using [CreateImage][1]. This field only appears if the AMI was
+    # created using CreateImage.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html
+    # @return [String]
+    def source_instance_id
+      data[:source_instance_id]
+    end
+
+    # Indicates whether deregistration protection is enabled for the AMI.
+    # @return [String]
+    def deregistration_protection
+      data[:deregistration_protection]
+    end
+
+    # The date and time, in [ISO 8601 date-time format][1], when the AMI was
+    # last used to launch an EC2 instance. When the AMI is used to launch an
+    # instance, there is a 24-hour delay before that usage is reported.
+    #
+    # <note markdown="1"> `lastLaunchedTime` data is available starting April 2017.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: http://www.iso.org/iso/iso8601
+    # @return [String]
+    def last_launched_time
+      data[:last_launched_time]
+    end
+
+    # If `true`, the AMI satisfies the criteria for Allowed AMIs and can be
+    # discovered and used in the account. If `false` and Allowed AMIs is set
+    # to `enabled`, the AMI can't be discovered or used in the account. If
+    # `false` and Allowed AMIs is set to `audit-mode`, the AMI can be
+    # discovered and used in the account.
+    #
+    # For more information, see [Control the discovery and use of AMIs in
+    # Amazon EC2 with Allowed AMIs][1] in *Amazon EC2 User Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-allowed-amis.html
+    # @return [Boolean]
+    def image_allowed
+      data[:image_allowed]
+    end
+
+    # The ID of the source AMI from which the AMI was created.
+    #
+    # The ID only appears if the AMI was created using CreateImage,
+    # CopyImage, or CreateRestoreImageTask. The ID does not appear if the
+    # AMI was created using any other API. For some older AMIs, the ID might
+    # not be available. For more information, see [Identify the source AMI
+    # used to create a new Amazon EC2 AMI][1] in the *Amazon EC2 User
+    # Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/identify-source-ami-used-to-create-new-ami.html
+    # @return [String]
+    def source_image_id
+      data[:source_image_id]
+    end
+
+    # The Region of the source AMI.
+    #
+    # The Region only appears if the AMI was created using CreateImage,
+    # CopyImage, or CreateRestoreImageTask. The Region does not appear if
+    # the AMI was created using any other API. For some older AMIs, the
+    # Region might not be available. For more information, see [Identify the
+    # source AMI used to create a new Amazon EC2 AMI][1] in the *Amazon EC2
+    # User Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/identify-source-ami-used-to-create-new-ami.html
+    # @return [String]
+    def source_image_region
+      data[:source_image_region]
+    end
+
+    # Indicates whether the image is eligible for Amazon Web Services Free
+    # Tier.
+    #
+    # * If `true`, the AMI is eligible for Free Tier and can be used to
+    #   launch instances under the Free Tier limits.
+    #
+    # * If `false`, the AMI is not eligible for Free Tier.
+    # @return [Boolean]
+    def free_tier_eligible
+      data[:free_tier_eligible]
+    end
+
+    # The location of the AMI.
+    # @return [String]
+    def image_location
+      data[:image_location]
+    end
+
+    # The current state of the AMI. If the state is `available`, the image
+    # is successfully registered and can be used to launch an instance.
+    # @return [String]
+    def state
+      data[:state]
+    end
+
+    # The ID of the Amazon Web Services account that owns the image.
+    # @return [String]
+    def owner_id
+      data[:owner_id]
+    end
+
+    # The date and time the image was created.
+    # @return [String]
+    def creation_date
+      data[:creation_date]
+    end
+
+    # Indicates whether the image has public launch permissions. The value
+    # is `true` if this image has public launch permissions or `false` if it
+    # has only implicit and explicit launch permissions.
+    # @return [Boolean]
+    def public
+      data[:public]
+    end
+
+    # Any product codes associated with the AMI.
+    # @return [Array<Types::ProductCode>]
+    def product_codes
+      data[:product_codes]
+    end
+
+    # The architecture of the image.
+    # @return [String]
+    def architecture
+      data[:architecture]
+    end
+
+    # The type of image.
+    # @return [String]
+    def image_type
+      data[:image_type]
+    end
+
+    # The kernel associated with the image, if any. Only applicable for
+    # machine images.
+    # @return [String]
+    def kernel_id
+      data[:kernel_id]
+    end
+
+    # The RAM disk associated with the image, if any. Only applicable for
+    # machine images.
+    # @return [String]
+    def ramdisk_id
+      data[:ramdisk_id]
+    end
+
+    # This value is set to `windows` for Windows AMIs; otherwise, it is
+    # blank.
+    # @return [String]
+    def platform
+      data[:platform]
+    end
+
     # @!endgroup
 
     # @return [Client]
@@ -274,7 +372,7 @@ module Aws::EC2
     #
     # @return [self]
     def load
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.describe_images(image_ids: [@id])
       end
       @data = resp.images[0]
@@ -321,7 +419,7 @@ module Aws::EC2
       options, params = separate_params_and_options(options)
       waiter = Waiters::ImageExists.new(options)
       yield_waiter_and_warn(waiter, &block) if block_given?
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         waiter.wait(params.merge(image_ids: [@id]))
       end
       Image.new({
@@ -425,7 +523,7 @@ module Aws::EC2
           :retry
         end
       end
-      Aws::Plugins::UserAgent.feature('resource') do
+      Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         Aws::Waiters::Waiter.new(options).wait({})
       end
     end
@@ -457,7 +555,7 @@ module Aws::EC2
     def create_tags(options = {})
       batch = []
       options = Aws::Util.deep_merge(options, resources: [@id])
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.create_tags(options)
       end
       options[:tags].each do |t|
@@ -504,7 +602,7 @@ module Aws::EC2
     def delete_tags(options = {})
       batch = []
       options = Aws::Util.deep_merge(options, resources: [@id])
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.delete_tags(options)
       end
       options[:tags].each do |t|
@@ -521,18 +619,29 @@ module Aws::EC2
     # @example Request syntax with placeholder values
     #
     #   image.deregister({
+    #     delete_associated_snapshots: false,
     #     dry_run: false,
     #   })
     # @param [Hash] options ({})
+    # @option options [Boolean] :delete_associated_snapshots
+    #   Specifies whether to delete the snapshots associated with the AMI
+    #   during deregistration.
+    #
+    #   <note markdown="1"> If a snapshot is associated with multiple AMIs, it is not deleted,
+    #   regardless of this setting.
+    #
+    #    </note>
+    #
+    #   Default: The snapshots are not deleted.
     # @option options [Boolean] :dry_run
     #   Checks whether you have the required permissions for the action,
     #   without actually making the request, and provides an error response.
     #   If you have the required permissions, the error response is
     #   `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.
-    # @return [EmptyStructure]
+    # @return [Types::DeregisterImageResult]
     def deregister(options = {})
       options = options.merge(image_id: @id)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.deregister_image(options)
       end
       resp.data
@@ -541,7 +650,7 @@ module Aws::EC2
     # @example Request syntax with placeholder values
     #
     #   image.describe_attribute({
-    #     attribute: "description", # required, accepts description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport, bootMode, tpmSupport, uefiData, lastLaunchedTime, imdsSupport
+    #     attribute: "description", # required, accepts description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport, bootMode, tpmSupport, uefiData, lastLaunchedTime, imdsSupport, deregistrationProtection
     #     dry_run: false,
     #   })
     # @param [Hash] options ({})
@@ -560,7 +669,7 @@ module Aws::EC2
     # @return [Types::ImageAttribute]
     def describe_attribute(options = {})
       options = options.merge(image_id: @id)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.describe_image_attribute(options)
       end
       resp.data
@@ -574,18 +683,18 @@ module Aws::EC2
     #     launch_permission: {
     #       add: [
     #         {
-    #           group: "all", # accepts all
-    #           user_id: "String",
     #           organization_arn: "String",
     #           organizational_unit_arn: "String",
+    #           user_id: "String",
+    #           group: "all", # accepts all
     #         },
     #       ],
     #       remove: [
     #         {
-    #           group: "all", # accepts all
-    #           user_id: "String",
     #           organization_arn: "String",
     #           organizational_unit_arn: "String",
+    #           user_id: "String",
+    #           group: "all", # accepts all
     #         },
     #       ],
     #     },
@@ -594,10 +703,10 @@ module Aws::EC2
     #     user_groups: ["String"],
     #     user_ids: ["String"],
     #     value: "String",
-    #     dry_run: false,
     #     organization_arns: ["String"],
     #     organizational_unit_arns: ["String"],
     #     imds_support: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
+    #     dry_run: false,
     #   })
     # @param [Hash] options ({})
     # @option options [String] :attribute
@@ -622,11 +731,6 @@ module Aws::EC2
     # @option options [String] :value
     #   The value of the attribute being modified. This parameter can be used
     #   only when the `Attribute` parameter is `description` or `imdsSupport`.
-    # @option options [Boolean] :dry_run
-    #   Checks whether you have the required permissions for the action,
-    #   without actually making the request, and provides an error response.
-    #   If you have the required permissions, the error response is
-    #   `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.
     # @option options [Array<String>] :organization_arns
     #   The Amazon Resource Name (ARN) of an organization. This parameter can
     #   be used only when the `Attribute` parameter is `launchPermission`.
@@ -649,10 +753,15 @@ module Aws::EC2
     #
     #
     #   [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration
+    # @option options [Boolean] :dry_run
+    #   Checks whether you have the required permissions for the action,
+    #   without actually making the request, and provides an error response.
+    #   If you have the required permissions, the error response is
+    #   `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.
     # @return [EmptyStructure]
     def modify_attribute(options = {})
       options = options.merge(image_id: @id)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.modify_image_attribute(options)
       end
       resp.data
@@ -676,7 +785,7 @@ module Aws::EC2
     # @return [EmptyStructure]
     def reset_attribute(options = {})
       options = options.merge(image_id: @id)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.reset_image_attribute(options)
       end
       resp.data