describe_workflow async ¶

async def describe_workflow(
    self,
    workflow_id: "capo_transfer.types.workflow_id.WorkflowId",
    *,
    config_overrides: Optional[AsyncTransferClientConfig] = None,
) -> "capo_transfer.types.describe_workflow_response.DescribeWorkflowResponse":
    """<p>Describes the specified workflow.</p>

    Args:
        workflow_id: <p>A unique identifier for the workflow.</p>

    Raises:
        capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
        capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
        capo_transfer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
        capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_transfer.types.describe_workflow_request.DescribeWorkflowRequest]",
    ) -> AsyncOperationResponse[
        "capo_transfer.types.describe_workflow_response.DescribeWorkflowResponse"
    ]:
        import capo_transfer._operations.transfer_service.describe_workflow

        (
            output,
            http_response,
        ) = await capo_transfer._operations.transfer_service.describe_workflow.async_describe_workflow(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeWorkflow")
    )
    input_: capo_transfer.types.describe_workflow_request.DescribeWorkflowRequest = {
        "workflow_id": workflow_id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output