Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Lists fleets.

get/2023-10-12/farms/{farmId}/fleets

Path parameters

farmIdstring required

The farm ID of the fleets.

Query parameters

nextTokenstring

The token for the next set of results, or <code>null</code> to start from the beginning.

maxResultsinteger

The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.

principalIdstring

The principal ID of the members to include in the fleet.

displayNamestring
<p>The display names of a list of fleets.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
status'ACTIVE' | 'CREATE_IN_PROGRESS' | 'UPDATE_IN_PROGRESS' | 'CREATE_FAILED' | 'UPDATE_FAILED' | 'SUSPENDED'

The status of the fleet.

Response

Success

nextTokenstring

If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.