Stop Servers

Operation Name

Stop Servers

Function overview

Terminates Amazon EC2 instance.

Properties

For information about using variables, refer to "variables".

Basic settings

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

Required settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Connect To	Required	Not available	Select Global Resources. [Add]: Adds new global resource. [Edit list]: Global resource settings can be edited with "Edit Resource list".
Instance List	Required	Available	Specify the IDs of the instances to be terminated. Each column can be operated with the following buttons. [Add]: Add an instance [Up]: Move the order of the selected instance upwards by one. [Down]: Move the order of the selected instance downwards by one. [Delete]: Delete the instance.
Instance List / Instance ID (Name)	Required	Available	Specify ID of the instance to be terminated.	It will be displayed as 'Instance ID (Name tag value)' in the list. If the Name tag is absent, it will be displayed as 'Instance ID'. Instance ID can be entered directly.
Wait Until Instance Stops	Required	Available	[Checked]: (default) process is put on hold until the instance is terminated. [Not Checked]: Proceeds with its subsequent operation without waiting for the termination of the instance.	If it is [Checked], the state of the instance in the process of being launched is monitored until it times out, determined by the value specified in the [Timeout] defined for the [Connect To] of the Global Resource specified. Proceeds with its subsequent operation when the termination of the instance is confirmed. Error will be raised, if the termination of the instance could not be confirmed within the millisecond value allotted in the [Timeout].

Property Action

Item name	Description	Supplement
Retrieving Instance List	Retrieves the Instance ID associated with the entry in the [Connect To] and make it available in the [Instance List / Instance ID (Name)] so that the ID becomes available to be selected.	Instance IDs of any of the followings are not obtained. Spot Instance Instance whose root device type is 'instance-store' instance with it status being '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		Element occurs for every instance that has been stopped.
	currentInstanceState	Returns current instance status. [running]:Instance is launched. [pending]:Instance is in the process of being launched. [stopping]:Instance is in the process of being stopped. [stopped]:Instance is stopped. [shutting-down]:Instance started shutting down. [terminated]:Instance is terminated.
	instanceId	Returns the instance ID.
	previousInstanceState	Returns previous state of the instance. [running]:Instance is launched. [pending]:Instance is in the process of being launched. [stopping]:Instance is in the process of being stopped. [stopped]:Instance is stopped. [shutting-down]:Instance started shutting down. [terminated]: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 AmazonServiceException is thrown, Amazon Web Services error code to which it corresponds is stored.	The value defaults to null.
status_code	When AmazonService Exception is thrown, HTTP status code is stored.	The value defaults to null.
message_category	Stroes the category to which corresponding message code belongs to, when an error occurs.	The value defaults to null.
message_code	Stores its corresponding message code of occured error.	The value defaults to null.
message_level	Stores the severity of the corresponding message code of the occured error.	The value defaults to null.
error_type	Stores the type of the occured error.	The value defaults to null. Error is represented in the format depicted below. Example:java.io.FileNotFoundException The message may vary depending on DataSpider Servista version.
error_message	Stores the error message for the occured error.	The value defaults to null. The message may vary depending on DataSpider Servista version.
error_trace	Stores stack trace of the occurred error.	The value defaults to null. The message may vary depending on DataSpider Servista version or the client application used.

Specification Limits

If one of the instance has failed to stop and triggered an error, then none of the other running instances will be requested to stop.

Requests made to stop the instance completes regardless of the AmazonEC2OperationTimeoutException thrown. Instance is stopped regardless of the error thrown.

Main exceptions

Exception name	Cause	REMEDY
ResourceNotFoundException Resource definition could not be found.Name: []	[Connect To] is not specified.	Please specify [Connect To].
ResourceNotFoundException Resource definition could not be found.Name: [<name of Global Resources>]	Resource definition selected in [Connect To] is not found.	Please check the global resource specified in [Connect To].
InvalidPropertyConfigurationException <Property Name> is not specified.	[<Property Name>] is not specified.	Please specify [<Property Name>].
AmazonEC2OperationTimeoutException The status of the instance was not updated within the allotted millisecond in <Timeout>	Instance has failed to terminate within the timeout period allotted by the [Connect To] [Timeout].	Please confirm the specified timeout value in the [Timeout] within the [Connect To].
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 instance is not in a state from which it can be stopped.	Please check the status of the instance.
Status Code: 400, AWS Request ID: XXXXXXXXXXXXXXXX, AWS Error Code: InvalidInstanceID.Malformed, AWS Error Message: Invalid id: "<Instance ID>"	Instance ID specified in [Instance List / Instance ID (Name)] is invalid.	Please 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 of the ID that is specified in the [Instance List / Instance ID (Name)] does not exists.	Please 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	Failed to send request to Amazon EC2. Request has exceeded the allotted millisecond value in [Timeout].	Try increasing the millisecond value in the [Timeout] or verify the network connectivity with Amazon EC2 service.
com.amazonaws.AmazonClientException Unable to execute HTTP request: <Endpoint>	[Endpoint] specified by [Connect To] is not available.	Make sure that all properties specified within the [Connect To] for the specified Global Resource are provided with correct information.

Notes

Data transfer between Amazon EC2 and this adapter is performed over HTTPS.

Only the Instances that are either in "running" or "pending" status will be stopped.

Instance with its root device type "ebs" is stopped.

Spot instance cannot be stopped.