Reboot Instances operation

The Reboot Instances operation enables you to request a reboot of one or more instances.

The Reboot Instances operation is asynchronous and this operation queues a request in Amazon EC2 to reboot the specified instance or instances.

Note

The Reboot Instances operation succeeds only if the instances are valid and if the instances belong to you. Amazon EC2 ignores requests to reboot terminated instances.

The following figure shows a sample <items> XML element for the Reboot Instances operation. 

Sample <items> XML element for the Reboot Instances operation

<items>
   <item>
       <parameters>
           <instances-set>
               <!--Zero or more repetitions:-->
               <item>
                   <instance-id></instance-id>
               </item>
           </instances-set>
       </parameters>
   </item>
</items>

The following table describes the elements for the adapter request. 

Adapter request elements for the Reboot Instances operation

Element

Definition

Required

<wsdl-location>

Specifies the target Web Service Description Language (WSDL) URL for Amazon EC2

Examples:

Conditional:

  • Required if not specified in the request
  • If specified in the configuration and request, the value in the request overrides the value in the configuration
<endpoint-address>

Specifies the web service endpoint for the adapter to use while performing operations on Amazon EC2 instances across different regions
Default value: US East region: http://us-east-1.ec2.amazonaws.com/

No

<signature-properties>

Specifies the mode for signing the adapter request

Conditional:

  • Required if not specified in the configuration
  • If <signature-properties mode = "key-files">, requires <private-key-file>
     and <certificate-file>
  • If <signature-properties mode = "key-data">, requires <private-key-data> and <certificate-data>
<operation-name>

Contains the name of the operation: reboot-instances

Yes

<instances-set>

Contains one or more instance IDs corresponding to the instances that you want to reboot

Yes

The following figure shows a sample adapter request for the Reboot Instances operation. 

Sample adapter request for the Reboot Instances operation

<amazon-ec2-request>
   <wsdl-location>http://ec2.amazonaws.com/doc/2009-11-30/</wsdl-location>
   <endpoint-address>http://us-east-1.ec2.amazonaws.com/</endpoint-address>
   <signature-properties mode = "key-files">
       <private-key-file>C:\Security\
pk-MJ5GIUNLM2XJ3VRJSYTKOFDWILELDQHB.PEM</private-key-file>
       <certificate-file>C:\Security\
cert-MJ5GIUNLM2XJ3VRJSYTKOFDWILELDQHB.PEM</certificate-file>
   </signature-properties>    
   <operation-name>reboot-instances</operation-name>
   <parameters>
       <instances-set>
           <item>
               <instance-id>i-f307589b</instance-id>
           </item>
       </instances-set>
   </parameters>
</amazon-ec2-request>

The following figure shows the response for the sample adapter request for the Reboot Instances operation. 

Sample adapter response for the Reboot Instances operation

<amazon-ec2-response>
   <metadata>
       <status>success</status>
   </metadata>
   <RebootInstancesResponse>
       <requestId>e0e0b0fb-b182-4fdb-b3a6-9a2752418fb2</requestId>
       <return>true</return>
   </RebootInstancesResponse>
</amazon-ec2-response>

 

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