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

ListFarms

Lists farms.

Request Syntax


GET /2023-10-12/farms?maxResults=maxResults&nextToken=nextToken&principalId=principalId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

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

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

nextToken

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

principalId

The principal ID of the member to list on the farm.

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

Pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "farms": [ 
      { 
         "createdAt": "string",
         "createdBy": "string",
         "displayName": "string",
         "farmId": "string",
         "kmsKeyArn": "string",
         "updatedAt": "string",
         "updatedBy": "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.

farms

Farms on the list.

Type: Array of FarmSummary objects

nextToken

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken 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 nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Type: String

Errors

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

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

InternalServerErrorException

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

HTTP Status Code: 500

ThrottlingException

Your request exceeded a request rate quota.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400