Scalr\Service\Aws\Ec2\V20140615\Ec2Api::stopInstances PHP Method

stopInstances() public method

Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, we charge a full instance hour, even if transitions happen multiple times within a single hour. Important! Although Spot Instances can use Amazon EBS-backed AMIs, they don't support Stop/Start. In other words, you can't stop and start Spot Instances launched from an AMI with an Amazon EBS root device. Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started.When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage.You can restart your instance at any time. Note! Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. Performing this operation on an instance that uses an instance store as its root device returns an error. You can stop, start, and terminate EBS-backed instances.You can only terminate S3-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted
public stopInstances ( ListDataType $instanceIdList, boolean $force = null ) : Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeList
$instanceIdList Scalr\Service\Aws\DataType\ListDataType One or more instance IDs.
$force boolean optional Forces the instance to stop. The instance will not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
return Scalr\Service\Aws\Ec2\DataType\InstanceStateChangeList Return the InstanceStateChangeList
    public function stopInstances(ListDataType $instanceIdList, $force = null)
    {
        $result = false;
        $options = $instanceIdList->getQueryArrayBare('InstanceId');
        if ($force !== null) {
            $options['Force'] = is_string($force) && ($force == 'true' || $force == 'false') ? $force : ($force ? 'true' : 'false');
        }
        $action = ucfirst(__FUNCTION__);
        $response = $this->client->call($action, $options);
        if ($response->getError() === false) {
            $sxml = simplexml_load_string($response->getRawContent());
            $result = $this->_loadListByName('InstanceStateChange', $sxml->instancesSet);
        }
        return $result;
    }
Ec2Api