ListQueueLimitAssociations
Gets a list of the associations between queues and limits defined in a farm.
Request Syntax
GET /2023-10-12/farms/farmId/queue-limit-associations?limitId=limitId&maxResults=maxResults&nextToken=nextToken&queueId=queueId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- farmId
-
The unique identifier of the farm that contains the limits and associations.
Pattern:
farm-[0-9a-f]{32}Required: Yes
- limitId
-
Specifies that the operation should return only the queue limit associations for the specified limit. If you specify both the
queueIdand thelimitId, only the specified limit is returned if it exists.Pattern:
limit-[0-9a-f]{32} - maxResults
-
The maximum number of associations to return in each page of results.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The token for the next set of results, or
nullto start from the beginning. - queueId
-
Specifies that the operation should return only the queue limit associations for the specified queue. If you specify both the
queueIdand thelimitId, only the specified limit is returned if it exists.Pattern:
queue-[0-9a-f]{32}
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"queueLimitAssociations": [
{
"createdAt": "string",
"createdBy": "string",
"limitId": "string",
"queueId": "string",
"status": "string",
"updatedAt": "string",
"updatedBy": "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.
- nextToken
-
If Deadline Cloud returns
nextToken, then there are more results available. The value ofnextTokenis 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, thennextTokenis set tonull. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationExceptionerror.Type: String
- queueLimitAssociations
-
A list of associations between limits and queues in the farm specified in the request.
Type: Array of QueueLimitAssociationSummary objects
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
- ResourceNotFoundException
-
The requested resource can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Your request exceeded a request rate quota.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
