Describe Image Attribute operation for the Amazon EC2 REST adapter

The Describe Image Attribute operation returns information about an attribute of an Amazon Machine Image (AMI). You can specify only one attribute per call.

The following figure shows a sample <items> XML element for the Describe Image Attribute operation:

Sample <items> XML element for the Describe Image Attribute operation

<items>
    <item>
        <parameters>
            <image-id></image-id>
            <!-You have a CHOICE of the next 5 items at this level ->
            <launch-permission/>
            <product-codes/>
            <kernel/>
            <ramdisk/>
            <block-device-mapping/>
        </parameters>
    </item>
</items>

The following table describes the elements for this adapter request:

Adapter request elements for the Describe Image Attribute operation

Element	Definition	Required
`<access-key>`	Specifies the Amazon Web Services (AWS) access key You need to generate the AWS access key by going to the Security Credentials tab in the AWS console.	Conditional; You must specify the Access Key and theSecret Key together in the configuration or the adapter request. If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration. If only the Access Key is specified, the adapter ignores the value.
`<secret-key>`	Specifies the AWS secret access key You need to generate the AWS secret access key by going to the Security Credentials tab in the AWS console.	Conditional; You must specify the Access Key and theSecret Key together in the configuration or the adapter request. If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration. If only the Secret Access Key is specified, the adapter ignores the value.
`<region>`	Specifies the region with which you want the adapter to communicate Amazon EC2 is hosted in multiple locations world-wide. You must specify the region in which you want the adapter to perform the actions. Valid values: us-east-1 us-west-2 (default) us-west-1 eu-west-1 ap-southeast-1 ap-northeast-1 ap-southeast-2 sa-east-1	No
`<operation-name>`	Contains the name of the operation: describe-image-attribute	Yes
`<image-id>`	Specifies the ID of the AMI for which an attribute is described	Yes
`<query>`	Contains the following elements that you can use to query for a specified instance: `<launch-permission>` `<product-codes>` `<kernel>` `<ramdisk>` `<block-device-mapping>`	Yes
`<launch-permission>`	Specifies the launch permissions associated with the AMI	No
`<product-codes>`	Specifies the product code associated with the AMI	No
`<kernel>`	Specifies the ID of the kernel associated with the AMI	No
`<ramdisk>`	Specifies the ID of the RAM disk associated with the AMI	No
`<block-device-mapping>`	Specifies the mapping that defines native device names that must be used when exposing virtual devices	No

The following figure shows a sample adapter request for the Describe Image Attribute operation:

Sample adapter request for the Describe Image Attribute operation

<amazon-ec2-rest-request>
    <operation-name>describe-image-attribute</operation-name>
    <parameters>
      <image-id>ami-98ec84a8</image-id>
      <kernel />
    </parameters>
</amazon-ec2-rest-request>

The following figure shows a sample adapter response for the Describe Image Attribute operation:

Sample adapter response for the Describe Image Attribute operation

 <amazon-ec2-rest-response>
  <metadata>
    <status>success</status>
  </metadata>
  <DescribeImageAttributeResponse>
    <imageId>ami-98ec84a8</imageId>
    <ImageAttributeInfo>
      <kernel>
        <value>aki-fc8f11cc</value>
      </kernel>
    </ImageAttributeInfo>
  </DescribeImageAttributeResponse>
</amazon-ec2-rest-response>

Describe Image Attribute operation for the Amazon EC2 REST adapter

Comments