DescribeImageAttribute

Amazon Elastic Compute Cloud: 2009-03-01

previous page next page

DescribeImageAttribute

The DescribeImageAttribute operation returns information about an attribute of an AMI. Only one attribute can be specified per call.

Request Parameters

The following table describes the request parameters for DescribeImageAttribute. Parameter names are case-sensitive.

Name Description Required

Name	Description	Required
`ImageId`	ID of the AMI for which an attribute will be described. Type: String	Yes
`Attribute`	Specifies the attribute to describe. Type: String Valid Value: `launchPermission`	Yes

ImageId

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

Type: String

Yes

Attribute

Specifies the attribute to describe.

Type: String

Valid Value: launchPermission

Yes

Attributes

Attribute Name	Description	Required
`launchPermission`	The AMIs launch permissions.
`ImageId`	ID of the AMI for which an attribute will be described. Type: String	Yes
`productCodes`	The product code attached to the AMI.	No
`kernel`	Describes the ID of the kernel associated with the AMI. Type: String	No
`ramdisk`	Describes the ID of RAM disk associated with the AMI. Type: String	No
`blockDeviceMapping`	Defines native device names to use when exposing virtual devices. Type: String	No

Response Elements

The following table describes the default response tags included in DescribeImageAttribute responses.

Name	Description
`imageId`	ID of the AMI described. Type: xsd:string
`launchPermission`	Launch permissions of the AMI. Returned if `launchPermission` is specified. Type: LaunchPermissionItemType[]
`productCodes`	Product codes of the AMI. Returned if `productCodes` is specified. Type: ProductCodeItemType[]
`kernel`	ID of the kernel associated with the AMI. Returned if `kernel` is specified. Type: xsd:string
`ramdisk`	ID of the RAM disk associated with the AMI. Returned if `ramdisk` is specified. Type: xsd:string
`blockDeviceMapping`	Mapping that defines native device names to use when exposing virtual devices. Returned if `BlockDeviceMapping` is specified. Type: BlockDeviceMappingItemType[]
`platform`	The operating platform of the instance. Type: xsd:string

Sample Request - Launch Permission

https://ec2.amazonaws.com/
?Action=DescribeImageAttribute
&ImageId=ami-61a54008
&Attribute=launchPermission
&...auth parameters...

Sample Response - Launch Permission

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

Sample Request - Product Codes

https://ec2.amazonaws.com/
?Action=DescribeImageAttribute
&ImageId=ami-61a54008
&Attribute=productCodes
&...auth parameters...

Sample Response - Product Codes

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

Related Operations

previous page start next page