Skip to Content

Start Instances operation

The Start Instances operation enables you to start an instance that uses an Amazon EBS volume as the root device.

You can quickly start and stop instances using Amazon EBS volumes as root devices. When an instance is stopped, the resources used by the instance are released and you are not billed for hourly instance usage. Amazon EC2 also allows you to restart a stopped instance.

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

Sample <items> XML element for the Start Instances operations

<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 this adapter request. 

Adapter request elements for the Start 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: start-instances

Yes

<instance-set>

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

Yes

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

Sample adapter request for the Start 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>start-instances</operation-name>
   <parameters>
       <instances-set>
           <item>
               <instance-id>i-bd90bfd5</instance-id>
           </item>
       </instances-set>
   </parameters>
</amazon-ec2-request>

The following figure shows the response for the sample Start Instances operation. 

Sample adapter response for the Start Instances operation

<amazon-ec2-response>
   <metadata>
       <status>success</status>
   </metadata>
   <StartInstancesResponse>
       <requestId>c0368c77-e7f5-43d2-8d4f-c3122fd19788</requestId>
       <instancesSet>
           <item>
               <instanceId>i-bd90bfd5</instanceId>
               <currentState>
                   <code>0</code>
                   <name>pending</name>
               </currentState>
               <previousState>
                   <code>80</code>
                   <name>stopped</name>
               </previousState>
           </item>
       </instancesSet>
   </StartInstancesResponse>
</amazon-ec2-response>

 

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

TrueSight Orchestration Content 23.1