Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

SearchFlowExecutions

Searches for AWS IoT Things Graph workflow execution instances.

Request Syntax


{
   "endTime": number,
   "flowExecutionId": "string",
   "maxResults": number,
   "nextToken": "string",
   "startTime": number,
   "systemInstanceId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

endTime

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

Type: Timestamp

Required: No

flowExecutionId

The ID of a flow execution.

Type: String

Required: No

maxResults

The maximum number of results to return in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 250.

Required: No

nextToken

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

Type: String

Required: No

startTime

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

Type: Timestamp

Required: No

systemInstanceId

The ID of the system instance that contains the flow.

Type: String

Length Constraints: Maximum length of 160.

Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/[\p{Alnum}_]+)*)$

Required: Yes

Response Syntax


{
   "nextToken": "string",
   "summaries": [ 
      { 
         "createdAt": number,
         "flowExecutionId": "string",
         "flowTemplateId": "string",
         "status": "string",
         "systemInstanceId": "string",
         "updatedAt": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The string to specify as nextToken when you request the next page of results.

Type: String

summaries

An array of objects that contain summary information about each workflow execution in the result set.

Type: Array of FlowExecutionSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

HTTP Status Code: 500

InvalidRequestException

HTTP Status Code: 400

ResourceNotFoundException

HTTP Status Code: 400

ThrottlingException

HTTP Status Code: 400