Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListExecutions

Retrieves a paginated list of summaries of all executions.

Request Syntax


GET /executions?actionType=actionType&maxResults=maxResults&nextToken=nextToken&resolveToResourceId=resolveToResourceId&resolveToResourceType=resolveToResourceType&targetResourceId=targetResourceId&targetResourceType=targetResourceType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

actionType

The type of action exectued.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

maxResults

The maximum number of results returned for each paginated request.

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

nextToken

The token used for the next set of paginated results.

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [A-Za-z0-9+/=]+

resolveToResourceId

The ID of the resolved resource.

Length Constraints: Fixed length of 36.

Pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

resolveToResourceType

The type of the resolved resource.

Valid Values: ASSET

targetResourceId

The ID of the target resource.

Length Constraints: Fixed length of 36.

Pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

targetResourceType

The type of the target resource.

Valid Values: ASSET | COMPUTATION_MODEL

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "executionSummaries": [ 
      { 
         "actionType": "string",
         "executionEndTime": number,
         "executionEntityVersion": "string",
         "executionId": "string",
         "executionStartTime": number,
         "executionStatus": { 
            "state": "string"
         },
         "resolveTo": { 
            "assetId": "string"
         },
         "targetResource": { 
            "assetId": "string",
            "computationModelId": "string"
         },
         "targetResourceVersion": "string"
      }
   ],
   "nextToken": "string"
}

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.

executionSummaries

Contains the list of execution summaries of the computation models.

Type: Array of ExecutionSummary objects

nextToken

The token for the next set of results, or null if there are no additional results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [A-Za-z0-9+/=]+

Errors

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

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429