get_deployment ¶

def get_deployment(
    self,
    id: "capo_proton.types.deployment_id.DeploymentId",
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
    environment_name: Optional[
        "capo_proton.types.resource_name.ResourceName"
    ] = None,
    service_name: Optional["capo_proton.types.resource_name.ResourceName"] = None,
    service_instance_name: Optional[
        "capo_proton.types.resource_name.ResourceName"
    ] = None,
    component_name: Optional["capo_proton.types.resource_name.ResourceName"] = None,
) -> "capo_proton.types.get_deployment_output.GetDeploymentOutput":
    """<p>Get detailed data for a deployment.</p>

    Args:
        id: <p>The ID of the deployment that you want to get the detailed data for.</p>
        environment_name: <p>The name of a environment that you want to get the detailed data for.</p>
        service_name: <p>The name of the service associated with the given deployment ID.</p>
        service_instance_name: <p>The name of the service instance associated with the given deployment ID. <code>serviceName</code> must be specified to identify the service instance.</p>
        component_name: <p>The name of a component that you want to get the detailed data for.</p>

    Raises:
        capo_proton.errors.access_denied_exception.AccessDeniedException: <p>There <i>isn't</i> sufficient access for performing this action.</p>
        capo_proton.errors.internal_server_exception.InternalServerException: <p>The request failed to register with the service.</p>
        capo_proton.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource <i>wasn't</i> found.</p>
        capo_proton.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_proton.errors.validation_exception.ValidationException: <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
        capo_proton.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_proton.types.get_deployment_input.GetDeploymentInput]",
    ) -> OperationResponse[
        "capo_proton.types.get_deployment_output.GetDeploymentOutput"
    ]:
        import capo_proton._operations.aws_proton20200720.get_deployment

        output, http_response = (
            capo_proton._operations.aws_proton20200720.get_deployment.get_deployment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_proton.types.get_deployment_output.GetDeploymentOutput",
    ) -> dict[str, Any]:
        import capo_proton.types.get_deployment_output

        return capo_proton.types.get_deployment_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetDeployment", redact_output=_redact_output),
    )
    input_: capo_proton.types.get_deployment_input.GetDeploymentInput = {"id": id}
    if environment_name is not None:
        input_["environment_name"] = environment_name
    if service_name is not None:
        input_["service_name"] = service_name
    if service_instance_name is not None:
        input_["service_instance_name"] = service_instance_name
    if component_name is not None:
        input_["component_name"] = component_name

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