Skip to content

exit_standby

exit_standby(
    *,
    config_overrides: Optional[AutoScalingClientConfig] = None,
    instance_ids: Optional[InstanceIds] = None,
    auto_scaling_group_name: Optional[XmlStringMaxLen255] = None,
) -> ExitStandbyAnswer

Moves the specified instances out of the standby state.

After you put the instances back in service, the desired capacity is incremented.

For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Parameters:

  • instance_ids (Optional[InstanceIds], default: None ) –

    The IDs of the instances. You can specify up to 20 instances.

  • auto_scaling_group_name (Optional[XmlStringMaxLen255], default: None ) –

    The name of the Auto Scaling group.

Raises:

  • ResourceContentionFault –

    You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

  • UnknownServiceError –

    The service returned an error code this client does not model.

Examples:

To move instances out of standby mode This example moves the specified instance out of standby mode.

>>> client.exit_standby(instance_ids=['i-93633f9b'], auto_scaling_group_name='my-auto-scaling-group')
Source code in docs_src/capo_auto_scaling/_services/auto_scaling.py
def exit_standby(
    self,
    *,
    config_overrides: Optional[AutoScalingClientConfig] = None,
    instance_ids: Optional[
        "capo_auto_scaling.types.instance_ids.InstanceIds"
    ] = None,
    auto_scaling_group_name: Optional[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ] = None,
) -> "capo_auto_scaling.types.exit_standby_answer.ExitStandbyAnswer":
    """<p>Moves the specified instances out of the standby state.</p> <p>After you put the instances back in service, the desired capacity is incremented.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html">Temporarily removing instances from your Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>

    Args:
        instance_ids: <p>The IDs of the instances. You can specify up to 20 instances.</p>
        auto_scaling_group_name: <p>The name of the Auto Scaling group.</p>

    Raises:
        capo_auto_scaling.errors.resource_contention_fault.ResourceContentionFault: <p>You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).</p>
        capo_auto_scaling.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To move instances out of standby mode
        This example moves the specified instance out of standby mode.

        >>> client.exit_standby(instance_ids=['i-93633f9b'], auto_scaling_group_name='my-auto-scaling-group')
    """

    def _handler(
        req: "OperationRequest[capo_auto_scaling.types.exit_standby_query.ExitStandbyQuery]",
    ) -> OperationResponse[
        "capo_auto_scaling.types.exit_standby_answer.ExitStandbyAnswer"
    ]:
        import capo_auto_scaling._operations.auto_scaling_2011_01_01.exit_standby

        output, http_response = (
            capo_auto_scaling._operations.auto_scaling_2011_01_01.exit_standby.exit_standby(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ExitStandby")
    )
    input_: capo_auto_scaling.types.exit_standby_query.ExitStandbyQuery = {}
    if instance_ids is not None:
        input_["instance_ids"] = instance_ids
    if auto_scaling_group_name is not None:
        input_["auto_scaling_group_name"] = auto_scaling_group_name

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output