DescribeImageAttribute

Amazon Elastic Compute Cloud: 2009-10-31

previous page next page

DescribeImageAttribute

Description

Returns information about an attribute of an AMI. Only one attribute can be specified per call.

Request Parameters

Name Description Required

Name	Description	Required
`DescribeImageAttributeType`	`DescribeImageAttributeType` element. Type:

DescribeImageAttributeType

DescribeImageAttributeType element.

Type:

DescribeImageAttributeType

Ancestor: None

Children: imageId, DescribeImageAttributesGroup

imageId

The ID of the AMI for which an attribute will be described.

Type: xsd:string

Default: None

Ancestor: DescribeImageAttributeType

Children: None

Yes

DescribeImageAttributesGroup

The image attributes group.

Type: DescribeImageAttributesGroup

Ancestor: DescribeImageAttributeType

Children: launchPermission, productCodes, kernel, ramdisk, blockDeviceMapping, and description

launchPermission

Describes the launch permissions associated with the AMI.

Type: EmptyElementType

Ancestor: DescribeImageAttributesGroup

Children: none

none

This element contains no options.

Type: xsd:string

Default: None

Ancestor: launchPermission

Children: None

productCodes

Describes the product code associated with the AMI.

Type: EmptyElementType

Ancestor: DescribeImageAttributesGroup

Children: none

none

This element contains no options.

Type: xsd:string

Default: None

Ancestor: productCodes

Children: None

kernel

Describes the ID of the kernel associated with the AMI.

Type: EmptyElementType

Ancestor: DescribeImageAttributesGroup

Children: none

none

This element contains no options.

Type: xsd:string

Default: None

Ancestor: kernel

Children: None

ramdisk

Describes the ID of the RAM disk associated with the AMI.

Type: EmptyElementType

Ancestor: DescribeImageAttributesGroup

Children: none

none

This element contains no options.

Type: xsd:string

Default: None

Ancestor: ramdisk

Children: None

blockDeviceMapping

Describes the mapping that defines native device names to use when exposing virtual devices.

Type: EmptyElementType

Ancestor: DescribeImageAttributesGroup

Children: none

none

This element contains no options.

Type: xsd:string

Default: None

Ancestor: blockDeviceMapping

Children: None

description

The description of the AMI that was provided during image creation.

Type: EmptyElementType

Ancestor: DescribeImageAttributesGroup

Children: none

none

This element contains no options.

Type: xsd:string

Default: None

Ancestor: description

Children: None

Response Elements

Name	Description
`DescribeImageAttributeResponseType`	`DescribeImageAttributeResponseType` element. Type: DescribeImageAttributeResponseType Ancestor: None Children: `requestId`, `imageId`, `launchPermission`, `productCodes`, `kernel`, `ramdisk`, `description`, and `blockDeviceMapping`
`requestId`	The ID of the request. Type: xsd:string Ancestor: `DescribeImageAttributeResponseType` Children: None
`imageId`	The ID of the AMI. Type: xsd:string Ancestor: `DescribeImageAttributeResponseType` Children: None
`launchPermission`	Launch permissions set. Type: LaunchPermissionListType Ancestor: `DescribeImageAttributeResponseType` Children: `item`
`item`	Information for launch permissions. Type: LaunchPermissionItemType Ancestor: `launchPermission` Children: `userId`, `group`
`userId`	AWS Access Key ID. Type: xsd:string Ancestor: `item` Children: None
`group`	Name of the group. Currently supports "all." Type: xsd:string Ancestor: `item` Children: None
`productCodes`	Product codes set. Type: ProductCodeListType Ancestor: `DescribeImageAttributeResponseType` Children: `item`
`item`	Information for one product code. Type: ProductCodeItemType Ancestor: `productCodes` Children: `productCode`
`productCode`	Product code. Type: xsd:string Ancestor: `item` Children: None
`kernel`	Kernel set. Type: NullableAttributeValueType Ancestor: `DescribeImageAttributeResponseType` Children: `value`
`value`	ID of the parent element. Type: xsd:string Ancestor: `kernel` Children: None
`ramdisk`	RAM disk set. Type: NullableAttributeValueType Ancestor: `DescribeImageAttributeResponseType` Children: `value`
`value`	ID of the parent element. Type: xsd:string Ancestor: `ramdisk` Children: None
`description`	User-created description of the AMI. Type: NullableAttributeValueType Ancestor: `DescribeImageAttributeResponseType` Children: `value`
`value`	ID of the parent element. Type: xsd:string Ancestor: `description` Children: None
`blockDeviceMapping`	Block device mapping set. Type: BlockDeviceMappingType Ancestor: `DescribeImageAttributeResponseType` Children: `item`
`item`	Information for one block device mapping. Type: BlockDeviceMappingItemType Ancestor: `blockDeviceMapping` Children: `deviceName`, `virtualName`, `ebs`, and `noDevice`
`deviceName`	The device name (e.g., /dev/sdh). Type: xsd:string Ancestor: `item` Children: None
`virtualName`	The virtual device name. Type: xsd:string Ancestor: `item` Children: None
`ebs`	Specifies parameters used to automatically setup Amazon EBS volumes when the instance is launched. Type: EbsBlockDeviceType Ancestor: `item` Children: `snapshotId`, `volumeSize`, and `deleteOnTermination`
`snapshotId`	The ID of the snapshot. Type: xsd:string Ancestor: `ebs` Children: None
`volumeSize`	The size of the volume. Type: xsd:string Ancestor: `ebs` Children: None
`deleteOnTermination`	Specifies whether the Amazon EBS volume is deleted on instance termination. Type: xsd:boolean Ancestor: `ebs` Children: None
`noDevice`	Specifies the device name to suppress during instance launch. Type: EmptyElementType Ancestor: `item` Children: `none`
`none`	This element contains no options. Type: xsd:string Ancestor: `noDevice` Children: None

Examples

Example Request

This example lists the launch permissions for the ami-61a54008 AMI

<DescribeImageAttribute xmlns="http://ec2.amazonaws.com/doc/2009-10-31/">
  <imageId><![CDATA[&exampleamiid;</imageId>
  <launchPermission/>
</DescribeImageAttribute>

Example Response

<DescribeImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2009-10-31/">
  <imageId>ami-61a54008</imageId>
  <launchPermission>
    <item>
      <group>all</group>
    </item>
    <item>
      <userId>495219933132</userId>
    </item>
  </launchPermission>
</DescribeImageAttributeResponse>

Example Request

This example lists the product code for the ami-2bb65342AMI.

<DescribeImageAttribute xmlns="http://ec2.amazonaws.com/doc/2009-10-31/">
  <imageId><![CDATA[&exampleamiid;</imageId>
  <productCodes/>
</DescribeImageAttribute>

Example Response

<DescribeImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2009-10-31/">
  <imageId>ami-61a54008</imageId>
  <productCodes>
    <item>
      <productCode>774F4FF8</productCode>
    </item>
  </productCodes>
						</DescribeImageAttributeResponse>

previous page start next page

DescribeImageAttribute

Amazon Elastic Compute Cloud: 2009-10-31

DescribeImageAttribute

Description

Request Parameters

Response Elements

Examples

Example Request

Example Response

Example Request

Example Response

Related Operations