Reset Image Attribute operation for the Amazon EC2 REST adapter

The Reset Image Attribute operation resets an attribute of an Amazon Machine Image (AMI) to its default value. You cannot reset the <product-codes> element.

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

Sample <items> XML element for the Reset Image Attribute operation
<items>
   <item>
       <parameters>
           <image-id></image-id>
           <launch-permission/>
       </parameters>
   </item>
</items>

The following table describes the elements for this adapter request:

Adapter request elements for the Reset 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: reset-image-attribute

Yes

<image-id>

Specifies the ID of the AMI on which the attribute is to be reset

Yes

<reset-parameter>

Contains the <launch-permission> element, which you can reset

Yes

<launch-permission>

Specifies the launch permissions set for the AMI

This attribute is reset for the specified instance.

No

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

Sample adapter request for the Reset Image Attribute operation

 <amazon-ec2-rest-request>
   <operation-name>reset-image-attribute</operation-name>
   <parameters>
     <image-id>ami-b8cea688</image-id>
     <launch-permission />
   </parameters>
</amazon-ec2-rest-request>

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

Sample adapter response for the Reset Image Attribute operation

 <amazon-ec2-rest-response>
 <metadata>
   <status>success</status>
 </metadata>
 <ResetImageAttributeResponse>
   <return>true</return>
 </ResetImageAttributeResponse>
</amazon-ec2-rest-response>