Skip to content

describe_flow_definition async

describe_flow_definition(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    flow_definition_name: Optional[FlowDefinitionName] = None,
) -> DescribeFlowDefinitionResponse

Returns information about the specified flow definition.

Parameters:

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def describe_flow_definition(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    flow_definition_name: Optional[
        "capo_sagemaker.types.flow_definition_name.FlowDefinitionName"
    ] = None,
) -> "capo_sagemaker.types.describe_flow_definition_response.DescribeFlowDefinitionResponse":
    """<p>Returns information about the specified flow definition.</p>

    Args:
        flow_definition_name: <p>The name of the flow definition.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.describe_flow_definition_request.DescribeFlowDefinitionRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.describe_flow_definition_response.DescribeFlowDefinitionResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_flow_definition

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.describe_flow_definition.async_describe_flow_definition(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFlowDefinition")
    )
    input_: capo_sagemaker.types.describe_flow_definition_request.DescribeFlowDefinitionRequest = {}
    if flow_definition_name is not None:
        input_["flow_definition_name"] = flow_definition_name

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