Reboot Instances operation for the Amazon EC2 REST adapter

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
`<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: 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-rest-request>
    <operation-name>reboot-instances</operation-name>
    <parameters>
      <instances-set>
        <item>
          <instance-id>i-65be346c</instance-id>
        </item>
      </instances-set>
    </parameters>
  </amazon-ec2-rest-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-rest-response>
  <metadata>
    <status>success</status>
  </metadata>
  <RebootInstancesResponse>
    <return>true</return>
  </RebootInstancesResponse>
</amazon-ec2-rest-response>

Reboot Instances operation for the Amazon EC2 REST adapter

Comments