Skip to content

describe_flow

describe_flow(
    flow_name: FlowName, *, config_overrides: Optional[AppflowClientConfig] = None
) -> DescribeFlowResponse

Provides a description of the specified flow.

Parameters:

  • flow_name (FlowName) –

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Raises:

  • InternalServerException –

    An internal service error occurred during the processing of your request. Try again later.

  • ResourceNotFoundException –

    The resource specified in the request (such as the source or destination connector profile) is not found.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_appflow/_services/appflow.py
def describe_flow(
    self,
    flow_name: "capo_appflow.types.flow_name.FlowName",
    *,
    config_overrides: Optional[AppflowClientConfig] = None,
) -> "capo_appflow.types.describe_flow_response.DescribeFlowResponse":
    """<p> Provides a description of the specified flow. </p>

    Args:
        flow_name: <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>

    Raises:
        capo_appflow.errors.internal_server_exception.InternalServerException: <p> An internal service error occurred during the processing of your request. Try again later. </p>
        capo_appflow.errors.resource_not_found_exception.ResourceNotFoundException: <p> The resource specified in the request (such as the source or destination connector profile) is not found. </p>
        capo_appflow.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_appflow.types.describe_flow_request.DescribeFlowRequest]",
    ) -> OperationResponse[
        "capo_appflow.types.describe_flow_response.DescribeFlowResponse"
    ]:
        import capo_appflow._operations.sandstone_configuration_service_lambda.describe_flow

        output, http_response = (
            capo_appflow._operations.sandstone_configuration_service_lambda.describe_flow.describe_flow(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFlow")
    )
    input_: capo_appflow.types.describe_flow_request.DescribeFlowRequest = {
        "flow_name": flow_name
    }

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