- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListLimitsCommand
Gets a list of limits defined in the specified farm.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DeadlineClient, ListLimitsCommand } from "@aws-sdk/client-deadline"; // ES Modules import
// const { DeadlineClient, ListLimitsCommand } = require("@aws-sdk/client-deadline"); // CommonJS import
const client = new DeadlineClient(config);
const input = { // ListLimitsRequest
farmId: "STRING_VALUE", // required
nextToken: "STRING_VALUE",
maxResults: Number("int"),
};
const command = new ListLimitsCommand(input);
const response = await client.send(command);
// { // ListLimitsResponse
// limits: [ // LimitSummaries // required
// { // LimitSummary
// displayName: "STRING_VALUE", // required
// amountRequirementName: "STRING_VALUE", // required
// maxCount: Number("int"), // required
// createdAt: new Date("TIMESTAMP"), // required
// createdBy: "STRING_VALUE", // required
// updatedAt: new Date("TIMESTAMP"),
// updatedBy: "STRING_VALUE",
// farmId: "STRING_VALUE", // required
// limitId: "STRING_VALUE", // required
// currentCount: Number("int"), // required
// },
// ],
// nextToken: "STRING_VALUE",
// };
ListLimitsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
farmId Required | string | undefined | The unique identifier of the farm that contains the limits. |
maxResults | number | undefined | The maximum number of limits to return in each page of results. |
nextToken | string | undefined | The token for the next set of results, or |
ListLimitsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
limits Required | LimitSummary[] | undefined | A list of limits that the farm contains. |
nextToken | string | undefined | If Deadline Cloud returns |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You don't have permission to perform the action. |
InternalServerErrorException | server | Deadline Cloud can't process your request right now. Try again later. |
ResourceNotFoundException | client | The requested resource can't be found. |
ThrottlingException | client | Your request exceeded a request rate quota. |
ValidationException | client | The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. |
DeadlineServiceException | Base exception class for all service exceptions from Deadline service. |