You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribeImageAttributeRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeImageAttributeRequest data as a hash:

{
  attribute: "description", # required, accepts description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport
  image_id: "String", # required
  dry_run: false,
}

Contains the parameters for DescribeImageAttribute.

Instance Attribute Summary collapse

Instance Attribute Details

#attributeString

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

Returns:

  • (String)


6612
6613
6614
6615
6616
6617
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6612

class DescribeImageAttributeRequest < Struct.new(
  :attribute,
  :image_id,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

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.

Returns:

  • (Boolean)


6612
6613
6614
6615
6616
6617
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6612

class DescribeImageAttributeRequest < Struct.new(
  :attribute,
  :image_id,
  :dry_run)
  include Aws::Structure
end

#image_idString

The ID of the AMI.

Returns:

  • (String)


6612
6613
6614
6615
6616
6617
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6612

class DescribeImageAttributeRequest < Struct.new(
  :attribute,
  :image_id,
  :dry_run)
  include Aws::Structure
end