You can use DescribeExecution to check the details of the execution of the specified workflow.
This API call only returns details for in-progress workflows.
If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.
Parameters:
-
execution_id
(ExecutionId)
–
A unique identifier for the execution of a workflow.
-
workflow_id
(WorkflowId)
–
A unique identifier for the workflow.
Raises:
Source code in docs_src/capo_transfer/_services/async_transfer.py
| async def describe_execution(
self,
execution_id: "capo_transfer.types.execution_id.ExecutionId",
workflow_id: "capo_transfer.types.workflow_id.WorkflowId",
*,
config_overrides: Optional[AsyncTransferClientConfig] = None,
) -> "capo_transfer.types.describe_execution_response.DescribeExecutionResponse":
"""<p>You can use <code>DescribeExecution</code> to check the details of the execution of the specified workflow.</p> <note> <p>This API call only returns details for in-progress workflows.</p> <p> If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a <code>ResourceNotFound</code> exception.</p> </note>
Args:
execution_id: <p>A unique identifier for the execution of a workflow.</p>
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_execution_request.DescribeExecutionRequest]",
) -> AsyncOperationResponse[
"capo_transfer.types.describe_execution_response.DescribeExecutionResponse"
]:
import capo_transfer._operations.transfer_service.describe_execution
(
output,
http_response,
) = await capo_transfer._operations.transfer_service.describe_execution.async_describe_execution(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeExecution")
)
input_: capo_transfer.types.describe_execution_request.DescribeExecutionRequest = {
"execution_id": execution_id,
"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
|