DescribeImageAttribute
Description
Returns information about an attribute of an AMI. Only one attribute can be specified per call.
Request Parameters
| Name | Description | Required |
|---|---|---|
|
Type: |
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, and blockDeviceMapping
launchPermission
Describes the launch permissions associated with the AMI.
Type: EmptyElementType
Ancestor: DescribeImageAttributesGroup
Children: none
No
none
These element contains no options.
Type: xsd:string
Default: None
Ancestor: launchPermission
Children: None
No
productCodes
Describes the product code associated with the AMI.
Type: EmptyElementType
Ancestor: DescribeImageAttributesGroup
Children: none
No
none
These element contains no options.
Type: xsd:string
Default: None
Ancestor: productCodes
Children: None
No
kernel
Describes the ID of the kernel associated with the AMI.
Type: EmptyElementType
Ancestor: DescribeImageAttributesGroup
Children: none
No
none
These element contains no options.
Type: xsd:string
Default: None
Ancestor: kernel
Children: None
No
ramdisk
Describes the ID of the RAM disk associated with the AMI.
Type: EmptyElementType
Ancestor: DescribeImageAttributesGroup
Children: none
No
none
These element contains no options.
Type: xsd:string
Default: None
Ancestor: ramdisk
Children: None
No
blockDeviceMapping
Describes the mapping that defines native device names to use when exposing virtual devices.
Type: EmptyElementType
Ancestor: DescribeImageAttributesGroup
Children: none
No
none
These element contains no options.
Type: xsd:string
Default: None
Ancestor: blockDeviceMapping
Children: None
No
Response Elements
| Name | Description |
|---|---|
|
|
Type: DescribeImageAttributeResponseType Ancestor: None Children: |
|
The ID of the request. Type: xsd:string Ancestor: Children: None |
|
The ID of the AMI. Type: xsd:string Ancestor: Children: None |
|
Launch permissions set. Type: LaunchPermissionListType Ancestor: Children: |
|
Information for launch permissions. Type: LaunchPermissionItemType Ancestor: Children: |
|
User IDs associated with the launchPermission attribute. Type: xsd:string Ancestor: Children: None |
|
Security groups associated with the launchPermission attribute. You can specify the "all" group, which will make it a public AMI. Type: xsd:string Ancestor: Children: None |
|
Product codes set. Type: ProductCodeListType Ancestor: Children: |
|
Information for one product code. Type: ProductCodeItemType Ancestor: Children: |
|
Amazon DevPay product code. Currently only one product code can be associated with an AMI. Once set, the product code cannot be changed or reset. Type: xsd:string Ancestor: Children: None |
|
Kernel set. Type: NullableAttributeValueType Ancestor: Children: |
|
ID of the kernel or RAM disk. Type: xsd:string Ancestor: Children: None |
|
RAM disk set. Type: NullableAttributeValueType Ancestor: Children: |
|
ID of the kernel or RAM disk. Type: xsd:string Ancestor: Children: None |
|
Block device mapping set. Type: BlockDeviceMappingType Ancestor: Children: |
|
Information for one block device mapping. Type: BlockDeviceMappingItemType Ancestor: Children: |
|
The virtual name. Type: xsd:string Ancestor: Children: None |
|
The device name (e.g., /dev/sdh). Type: xsd:string Ancestor: Children: None |
Examples
Example Request
This example lists the launch permissions for the ami-61a54008 AMI
<DescribeImageAttribute xmlns="http://ec2.amazonaws.com/doc/2009-07-15/"> <imageId>&exampleamiid;</imageId> <launchPermission/> </DescribeImageAttribute>
Example Response
<DescribeImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2009-07-15/">
<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-07-15/"> <imageId>&exampleamiid;</imageId> <productCodes/> </DescribeImageAttribute>
Example Response
<DescribeImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2009-07-15/">
<imageId>ami-61a54008</imageId>
<productCodes>
<item>
<productCode>774F4FF8</productCode>
</item>
</productCodes>
</DescribeImageAttributeResponse>