Skip to content

list_flow_execution_messages

list_flow_execution_messages(
    flow_execution_id: FlowExecutionId,
    *,
    config_overrides: Optional[IoTThingsGraphClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListFlowExecutionMessagesResponse

Returns a list of objects that contain information about events in a flow execution.

Parameters:

  • flow_execution_id (FlowExecutionId) –

    The ID of the flow execution.

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

    The string that specifies the next page of results. Use this when you're paginating results.

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

    The maximum number of results to return in the response.

Raises:

Source code in docs_src/capo_iotthingsgraph/_services/io_t_things_graph.py
def list_flow_execution_messages(
    self,
    flow_execution_id: "capo_iotthingsgraph.types.flow_execution_id.FlowExecutionId",
    *,
    config_overrides: Optional[IoTThingsGraphClientConfig] = None,
    next_token: Optional["capo_iotthingsgraph.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_iotthingsgraph.types.max_results.MaxResults"
    ] = None,
) -> "capo_iotthingsgraph.types.list_flow_execution_messages_response.ListFlowExecutionMessagesResponse":
    """<p>Returns a list of objects that contain information about events in a flow execution.</p>

    Args:
        flow_execution_id: <p>The ID of the flow execution.</p>
        next_token: <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
        max_results: <p>The maximum number of results to return in the response.</p>

    Raises:
        capo_iotthingsgraph.errors.internal_failure_exception.InternalFailureException: <p></p>
        capo_iotthingsgraph.errors.invalid_request_exception.InvalidRequestException: <p></p>
        capo_iotthingsgraph.errors.resource_not_found_exception.ResourceNotFoundException: <p></p>
        capo_iotthingsgraph.errors.throttling_exception.ThrottlingException: <p></p>
        capo_iotthingsgraph.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotthingsgraph.types.list_flow_execution_messages_request.ListFlowExecutionMessagesRequest]",
    ) -> OperationResponse[
        "capo_iotthingsgraph.types.list_flow_execution_messages_response.ListFlowExecutionMessagesResponse"
    ]:
        import capo_iotthingsgraph._operations.iot_things_graph_front_end_service.list_flow_execution_messages

        output, http_response = (
            capo_iotthingsgraph._operations.iot_things_graph_front_end_service.list_flow_execution_messages.list_flow_execution_messages(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFlowExecutionMessages")
    )
    input_: capo_iotthingsgraph.types.list_flow_execution_messages_request.ListFlowExecutionMessagesRequest = {
        "flow_execution_id": flow_execution_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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