Skip to content

get_deployment_instance 

get_deployment_instance(
    deployment_id: DeploymentId,
    instance_id: InstanceId,
    *,
    config_overrides: Optional[CodeDeployClientConfig] = None,
) -> GetDeploymentInstanceOutput

Gets information about an instance as part of a deployment.

Parameters:

  • deployment_id (DeploymentId) –

    The unique ID of a deployment.

  • instance_id (InstanceId) –

    The unique ID of an instance in the deployment group.

Raises:

Source code in docs_src/capo_codedeploy/_services/code_deploy.py 
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
def get_deployment_instance(
    self,
    deployment_id: "capo_codedeploy.types.deployment_id.DeploymentId",
    instance_id: "capo_codedeploy.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[CodeDeployClientConfig] = None,
) -> "capo_codedeploy.types.get_deployment_instance_output.GetDeploymentInstanceOutput":
    """<p>Gets information about an instance as part of a deployment.</p>

    Args:
        deployment_id: <p> The unique ID of a deployment. </p>
        instance_id: <p> The unique ID of an instance in the deployment group. </p>

    Raises:
        capo_codedeploy.errors.deployment_does_not_exist_exception.DeploymentDoesNotExistException: <p>The deployment with the user or Amazon Web Services account does not exist.</p>
        capo_codedeploy.errors.deployment_id_required_exception.DeploymentIdRequiredException: <p>At least one deployment ID must be specified.</p>
        capo_codedeploy.errors.instance_does_not_exist_exception.InstanceDoesNotExistException: <p>The specified instance does not exist in the deployment group.</p>
        capo_codedeploy.errors.instance_id_required_exception.InstanceIdRequiredException: <p>The instance ID was not specified.</p>
        capo_codedeploy.errors.invalid_compute_platform_exception.InvalidComputePlatformException: <p>The computePlatform is invalid. The computePlatform should be <code>Lambda</code>, <code>Server</code>, or <code>ECS</code>.</p>
        capo_codedeploy.errors.invalid_deployment_id_exception.InvalidDeploymentIdException: <p>At least one of the deployment IDs was specified in an invalid format.</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_deployment_instance_input.GetDeploymentInstanceInput]",
    ) -> OperationResponse[
        "capo_codedeploy.types.get_deployment_instance_output.GetDeploymentInstanceOutput"
    ]:
        import capo_codedeploy._operations.code_deploy_20141006.get_deployment_instance

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDeploymentInstance")
    )
    input_: capo_codedeploy.types.get_deployment_instance_input.GetDeploymentInstanceInput = {
        "deployment_id": deployment_id,
        "instance_id": instance_id,
    }

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