Reset Instance Attribute operation for the Amazon EC2 REST adapter

The Reset Instance Attribute operations resets the specified attribute of an instance to its default value.

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

Sample <items> XML element for the Reset Instance Attribute operation

<items>
   <item>
       <parameters>
           <instance-id></instance-id>
           <!--You have a CHOICE of the next 2 items at this level-->
           <kernel/>
           <ramdisk/>
       </parameters>
   </item>
</items>

The following table describes the elements for this adapter request. 

Adapter request elements for the Reset Instance 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.
<session-token>

Specifies the temporary session token generated using the AWS APIs.

Conditional;

You must specify the Access Key and Secret Key as well in the configuration or the adapter request, else the <session-token> value is ignored.

<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-instance-attribute

Yes

<instance-id>

Specifies the instance ID for the instance whose attribute value is to be reset

Yes

<kernel>

Specifies the kernel ID for the instance

No

<ramdisk>

Specifies the RAM disk ID for the instance

No

The following figure shows a sample adapter request for the Reset Instance Attribute operation. 

Sample adapter request for the Reset Instance Attribute operation

<amazon-ec2-rest-request>
   <operation-name>reset-instance-attribute</operation-name>
   <parameters>
     <instance-id>i-65be346c</instance-id>
     <kernel />
   </parameters>
</amazon-ec2-rest-request>

The following figure shows the response for the sample Reset Instance Attribute operation. 

Sample adapter response for the Reset Instance Attribute operation

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

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*