Skip to content

get_on_premises_instance

get_on_premises_instance(
    instance_name: InstanceName,
    *,
    config_overrides: Optional[CodeDeployClientConfig] = None,
) -> GetOnPremisesInstanceOutput

Gets information about an on-premises instance.

Parameters:

  • instance_name (InstanceName) –

    The name of the on-premises instance about which to get information.

Raises:

Source code in docs_src/capo_codedeploy/_services/code_deploy.py
def get_on_premises_instance(
    self,
    instance_name: "capo_codedeploy.types.instance_name.InstanceName",
    *,
    config_overrides: Optional[CodeDeployClientConfig] = None,
) -> "capo_codedeploy.types.get_on_premises_instance_output.GetOnPremisesInstanceOutput":
    """<p> Gets information about an on-premises instance. </p>

    Args:
        instance_name: <p> The name of the on-premises instance about which to get information. </p>

    Raises:
        capo_codedeploy.errors.instance_name_required_exception.InstanceNameRequiredException: <p>An on-premises instance name was not specified.</p>
        capo_codedeploy.errors.instance_not_registered_exception.InstanceNotRegisteredException: <p>The specified on-premises instance is not registered.</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.get_on_premises_instance_input.GetOnPremisesInstanceInput]",
    ) -> OperationResponse[
        "capo_codedeploy.types.get_on_premises_instance_output.GetOnPremisesInstanceOutput"
    ]:
        import capo_codedeploy._operations.code_deploy_20141006.get_on_premises_instance

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetOnPremisesInstance")
    )
    input_: capo_codedeploy.types.get_on_premises_instance_input.GetOnPremisesInstanceInput = {
        "instance_name": instance_name
    }

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