Skip to content

batch_get_on_premises_instances

batch_get_on_premises_instances(
    instance_names: InstanceNameList,
    *,
    config_overrides: Optional[CodeDeployClientConfig] = None,
) -> BatchGetOnPremisesInstancesOutput

Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.

Parameters:

  • instance_names (InstanceNameList) –

    The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.

Raises:

Source code in docs_src/capo_codedeploy/_services/code_deploy.py
def batch_get_on_premises_instances(
    self,
    instance_names: "capo_codedeploy.types.instance_name_list.InstanceNameList",
    *,
    config_overrides: Optional[CodeDeployClientConfig] = None,
) -> "capo_codedeploy.types.batch_get_on_premises_instances_output.BatchGetOnPremisesInstancesOutput":
    """<p>Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.</p>

    Args:
        instance_names: <p>The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.</p>

    Raises:
        capo_codedeploy.errors.batch_limit_exceeded_exception.BatchLimitExceededException: <p>The maximum number of names or IDs allowed for this request (100) was exceeded.</p>
        capo_codedeploy.errors.instance_name_required_exception.InstanceNameRequiredException: <p>An on-premises instance name was not specified.</p>
        capo_codedeploy.errors.invalid_instance_name_exception.InvalidInstanceNameException: <p>The on-premises instance name was specified in an invalid format.</p>
        capo_codedeploy.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codedeploy.types.batch_get_on_premises_instances_input.BatchGetOnPremisesInstancesInput]",
    ) -> OperationResponse[
        "capo_codedeploy.types.batch_get_on_premises_instances_output.BatchGetOnPremisesInstancesOutput"
    ]:
        import capo_codedeploy._operations.code_deploy_20141006.batch_get_on_premises_instances

        output, http_response = (
            capo_codedeploy._operations.code_deploy_20141006.batch_get_on_premises_instances.batch_get_on_premises_instances(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchGetOnPremisesInstances")
    )
    input_: capo_codedeploy.types.batch_get_on_premises_instances_input.BatchGetOnPremisesInstancesInput = {
        "instance_names": instance_names
    }

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