Skip to content

describe_flow_execution_records 

describe_flow_execution_records(
    flow_name: FlowName,
    *,
    config_overrides: Optional[AppflowClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeFlowExecutionRecordsResponse

Fetches the execution history of the flow.

Parameters:

  • flow_name (FlowName) –

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

  • max_results (Optional[MaxResults], default: None ) –

    Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).

  • next_token (Optional[NextToken], default: None ) –

    The pagination token for the next page of data.

Raises:

Source code in docs_src/capo_appflow/_services/appflow.py 
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
def describe_flow_execution_records(
    self,
    flow_name: "capo_appflow.types.flow_name.FlowName",
    *,
    config_overrides: Optional[AppflowClientConfig] = None,
    max_results: Optional["capo_appflow.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_appflow.types.next_token.NextToken"] = None,
) -> "capo_appflow.types.describe_flow_execution_records_response.DescribeFlowExecutionRecordsResponse":
    """<p> Fetches the execution history of the flow. </p>

    Args:
        flow_name: <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>
        max_results: <p> Specifies the maximum number of items that should be returned in the result set. The default for <code>maxResults</code> is 20 (for all paginated API operations). </p>
        next_token: <p> The pagination token for the next page of data. </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.validation_exception.ValidationException: <p> The request has invalid or missing parameters. </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_execution_records_request.DescribeFlowExecutionRecordsRequest]",
    ) -> OperationResponse[
        "capo_appflow.types.describe_flow_execution_records_response.DescribeFlowExecutionRecordsResponse"
    ]:
        import capo_appflow._operations.sandstone_configuration_service_lambda.describe_flow_execution_records

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFlowExecutionRecords")
    )
    input_: capo_appflow.types.describe_flow_execution_records_request.DescribeFlowExecutionRecordsRequest = {
        "flow_name": flow_name
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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