SearchSteps - AWS Deadline Cloud


Searches for steps.

Request Syntax

POST /2023-10-12/farms/farmId/search/steps HTTP/1.1 Content-type: application/json { "filterExpressions": { "filters": [ { ... } ], "operator": "string" }, "itemOffset": number, "jobId": "string", "pageSize": number, "queueIds": [ "string" ], "sortExpressions": [ { ... } ] }

URI Request Parameters

The request uses the following URI parameters.


The farm ID to use for the step search.

Pattern: ^farm-[0-9a-f]{32}$

Required: Yes

Request Body

The request accepts the following data in JSON format.


The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().

Type: SearchGroupedFilterExpressions object

Required: No


Defines how far into the scrollable list to start the return of results.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10000.

Required: Yes


The job ID to use in the step search.

Type: String

Pattern: ^job-[0-9a-f]{32}$

Required: No


Specifies the number of items per page for the resource.

Type: Integer

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

Required: No


The queue IDs in the step search.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: ^queue-[0-9a-f]{32}$

Required: Yes


The search terms for a resource.

Type: Array of SearchSortExpression objects

Array Members: Fixed number of 1 item.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextItemOffset": number, "steps": [ { "createdAt": "string", "endedAt": "string", "jobId": "string", "lifecycleStatus": "string", "lifecycleStatusMessage": "string", "name": "string", "parameterSpace": { "combination": "string", "parameters": [ { "name": "string", "type": "string" } ] }, "queueId": "string", "startedAt": "string", "stepId": "string", "targetTaskRunStatus": "string", "taskRunStatus": "string", "taskRunStatusCounts": { "string" : number } } ], "totalResults": 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.


The next incremental starting point after the defined itemOffset.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10000.


The steps in the search.

Type: Array of StepSearchSummary objects


The total number of results in the search.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10000.


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


You don't have permission to perform the action.

HTTP Status Code: 403


Deadline Cloud can't process your request right now. Try again later.

HTTP Status Code: 500


The requested resource can't be found.

HTTP Status Code: 404


Your request exceeded a request rate quota.

HTTP Status Code: 429


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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: