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

AssumeQueueRoleForRead

Gets AWS credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.

Request Syntax


GET /2023-10-12/farms/farmId/queues/queueId/read-roles HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

farmId

The farm ID of the farm containing the queue.

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

Required: Yes

queueId

The queue ID.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "credentials": { 
      "accessKeyId": "string",
      "expiration": "string",
      "secretAccessKey": "string",
      "sessionToken": "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.

credentials

The credentials for the queue role.

Type: AwsCredentials object

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

ValidationException

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

HTTP Status Code: 400