Stop Instances

Operation Name

Stop Instances

Function Overview

Stop instances of Amazon EC2.

Properties

For details on use of variables, refer to “Variables”.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter the name to show on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a global resource. [Add]: Add a new global resource. [Edit list]: Global resource settings can be edited in “Edit resource list” screen.
Instance list	Required	Available	Specify instance IDs of instances to be stopped. Each instance can be operated with the following buttons. [Add]: Add an instance. [Up]: Move the selected instance upwards by one row. [Down]: Move the selected instance downwards by one row. [Delete]: Delete the instance.
Instance list/Instance ID (Name)	Required	Available	Specify an instance ID of instance to be stopped.	It is displayed as “Instance ID (Name tag value)” in the list. When there is no Name tag, it is displayed as “Instance ID”. You can enter just the instance ID directly.
Wait for stop completion	Required	Available	[Checked]: (default) Wait for completion of stopping the instance. [Not checked]: Proceed to the subsequent operation without waiting after a stop request is sent to the instance.	When [Checked], checking the instance status will be continued from the start of process till the value entered in [Timeout] of the global resource specified in [Destination]. After confirming that the instance has stopped, proceeds to the subsequent process. If completion of stopping the instance could not be confirmed within the milliseconds given in [Timeout], it will be an error.

Property actions

Item name	Description	Remarks
Get instance list	Get instance IDs created in [Destination] so that you can select it in [Instance list/Instance ID (Name)].	ID of the following instances will not be got. Spot instance Instance of which the root device type is ”instance-store” Instance of which the state is “shutting-down” or “terminated”

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input schema

None.

Output schema

<?xml version="1.0"?>
<instances>
  <instance currentInstanceState="" instanceId="" previousInstanceState="" />
</instances>

Element name	Attribute name	Description
instances
instance		Appears for each stopped instance.
	currentInstanceState	Outputs the current instance state. [running]: State in which the instance is running. [pending]: State in which the instance is starting up. [stopping]: State in which the instance is stopping. [stopped]: State in which the instance is stopped. [shutting-down]: State in which the instance is shutting down. [terminated]: State in which the instance is terminated.
	instanceId	Outputs the instance ID.
	previousInstanceState	Outputs the previous instance state. [running]: State in which the instance is running. [pending]: State in which the instance is starting up. [stopping]: State in which the instance is stopping. [stopped]: State in which the instance is stopped. [shutting-down]: State in which the instance is shutting down. [terminated]: State in which the instance is terminated.

Mass Data Processing

Mass data processing is not supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
error_code	When an error (AmazonServiceException) occurs, the corresponding error code of Amazon Web Services is stored.	Default value is null.
status_code	When an error (AmazonServiceException) occurs, the HTTP status code is stored.	Default value is null.
message_category	When an error occurs, category of the corresponding message code is stored.	Default value is null.
message_code	When an error occurs, code of the corresponding message code is stored.	Default value is null.
message_level	When an error occurs, severity of the corresponding message code is stored.	Default value is null.
error_type	When an error occurs, the error type is stored.	Default value is null. The error type would be in the following format. Example: “java.io.FileNotFoundException” The contents that will be stored may vary depending on DataSpider Servista versions.
error_message	When an error occurs, the error message is stored.	Default value is null. The contents that will be stored may vary depending on DataSpider Servista versions.
error_trace	When an error occurs, trace information of the error is stored.	Default value is null. The contents that will be stored may vary depending on DataSpider Servista versions and client applications.

Specification Limits

When stopping multiple instances, if failed to stop any single instance failed and an error occurred, stop requests will not be performed for other instances.

When “AmazonEC2OperationTimeoutException” occurred, the instance stop request has been completed. Although it is a runtime error, the instance stop operation will be performed.

Major Exceptions

Exception name	Cause	Solution
ResourceNotFoundException Resource definition is not found. Name: []	[Destination] is not specified.	Specify [Destination].
ResourceNotFoundException Resource definition is not found. Name: [<global resource name>]	The resource definition selected in [Destination] is not found.	Check the global resource specified in [Destination].
InvalidPropertyConfigurationException <property name> is not specified.	[<property name>] is not specified.	Specify [<property name>].
AmazonEC2OperationTimeoutException Instance status has not been changed within <timeout> milliseconds.	After sending a stop request, the stopping instance is not completed within [Timeout] of the global resource specified in [Destination].	Check [Timeout] of the global resource specified in [Destination].
Status Code: 400, AWS Request ID: XXXXXXXXXXXXXXXX, AWS Error Code: IncorrectInstanceState, AWS Error Message: The instance '<instance ID>' is not in a state from which it can be stopped.	The specified instance is not in a state from which it can be stopped.	Check the state of the specified instance.
Status Code: 400, AWS Request ID: XXXXXXXXXXXXXXXX, AWS Error Code: InvalidInstanceID.Malformed, AWS Error Message: Invalid id: “<instance ID>”	The instance ID specified in [Instance list/Instance ID (Name)] is invalid.	Check the instance ID specified in [Instance list/Instance ID (Name)].
Status Code: 400, AWS Request ID: XXXXXXXXXXXXXXXX, AWS Error Code: InvalidInstanceID.NotFound, AWS Error Message: The instance ID '<instance ID>' does not exist	The instance with the instance ID specified in [Instance list/Instance ID (Name)] does not exist.	Check the instance ID specified in [Instance list/Instance ID (Name)].
com.amazonaws.AmazonClientException Unable to execute HTTP request: Connect to ec2.amazonaws.com/ec2.amazonaws.com/xxx.xxx.xxx.xxx timed out	Could not send a request to Amazon EC2, as the millisecond specified in [Timeout] has been elapsed.	Increase the millisecond of [Timeout], or check the connection status of the destination Amazon EC2.
com.amazonaws.AmazonClientException Unable to execute HTTP request: <endpoint>	There is something wrong with [Endpoint] of the global resource specified in [Destination].	Check the settings of the global resource specified in [Destination].

Notes

HTTPS is used in communication between Amazon EC2 and this adapter.

Stops only instances of which state is “running” or “pending”.

Stops only instances of which the root device type is “ebs”.

Cannot stop spot instances.