Skip to content

search_flow_executions async

search_flow_executions(
    system_instance_id: Urn,
    *,
    config_overrides: Optional[AsyncIoTThingsGraphClientConfig] = None,
    flow_execution_id: Optional[FlowExecutionId] = None,
    start_time: Optional[Timestamp] = None,
    end_time: Optional[Timestamp] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> SearchFlowExecutionsResponse

Searches for AWS IoT Things Graph workflow execution instances.

Parameters:

  • system_instance_id (Urn) –

    The ID of the system instance that contains the flow.

  • flow_execution_id (Optional[FlowExecutionId], default: None ) –

    The ID of a flow execution.

  • start_time (Optional[Timestamp], default: None ) –

    The date and time of the earliest flow execution to return.

  • end_time (Optional[Timestamp], default: None ) –

    The date and time of the latest flow execution to return.

  • 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/async_io_t_things_graph.py
async def search_flow_executions(
    self,
    system_instance_id: "capo_iotthingsgraph.types.urn.Urn",
    *,
    config_overrides: Optional[AsyncIoTThingsGraphClientConfig] = None,
    flow_execution_id: Optional[
        "capo_iotthingsgraph.types.flow_execution_id.FlowExecutionId"
    ] = None,
    start_time: Optional["capo_iotthingsgraph.types.timestamp.Timestamp"] = None,
    end_time: Optional["capo_iotthingsgraph.types.timestamp.Timestamp"] = None,
    next_token: Optional["capo_iotthingsgraph.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_iotthingsgraph.types.max_results.MaxResults"
    ] = None,
) -> "capo_iotthingsgraph.types.search_flow_executions_response.SearchFlowExecutionsResponse":
    """<p>Searches for AWS IoT Things Graph workflow execution instances.</p>

    Args:
        system_instance_id: <p>The ID of the system instance that contains the flow.</p>
        flow_execution_id: <p>The ID of a flow execution.</p>
        start_time: <p>The date and time of the earliest flow execution to return.</p>
        end_time: <p>The date and time of the latest flow execution to return.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotthingsgraph.types.search_flow_executions_request.SearchFlowExecutionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotthingsgraph.types.search_flow_executions_response.SearchFlowExecutionsResponse"
    ]:
        import capo_iotthingsgraph._operations.iot_things_graph_front_end_service.search_flow_executions

        (
            output,
            http_response,
        ) = await capo_iotthingsgraph._operations.iot_things_graph_front_end_service.search_flow_executions.async_search_flow_executions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchFlowExecutions")
    )
    input_: capo_iotthingsgraph.types.search_flow_executions_request.SearchFlowExecutionsRequest = {
        "system_instance_id": system_instance_id
    }
    if flow_execution_id is not None:
        input_["flow_execution_id"] = flow_execution_id
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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