Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateQueue

Updates the compute node group configuration of a queue. Use this API to change the compute node groups that the queue can send jobs to.

Request Syntax


{
   "clientToken": "string",
   "clusterIdentifier": "string",
   "computeNodeGroupConfigurations": [ 
      { 
         "computeNodeGroupId": "string"
      }
   ],
   "queueIdentifier": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the AWS CLI and SDK automatically generate 1 for you.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 100.

Required: No

clusterIdentifier

The name or ID of the cluster of the queue.

Type: String

Pattern: (pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{1,40})

Required: Yes

computeNodeGroupConfigurations

The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.

Type: Array of ComputeNodeGroupConfiguration objects

Required: No

queueIdentifier

The name or ID of the queue.

Type: String

Pattern: (pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{1,25})

Required: Yes

Response Syntax


{
   "queue": { 
      "arn": "string",
      "clusterId": "string",
      "computeNodeGroupConfigurations": [ 
         { 
            "computeNodeGroupId": "string"
         }
      ],
      "createdAt": "string",
      "errorInfo": [ 
         { 
            "code": "string",
            "message": "string"
         }
      ],
      "id": "string",
      "modifiedAt": "string",
      "name": "string",
      "status": "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.

queue

A queue resource.

Type: Queue 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.

Examples

The launch template instance profile doesn't pass iam:PassRole verification.
There is a mismatch between the account ID and cluster ID.
The cluster ID doesn't exist.
The EC2 instance isn't present.

HTTP Status Code: 400

ConflictException

Your request has conflicting operations. This can occur if you're trying to perform more than 1 operation on the same resource at the same time.

Examples

A cluster with the same name already exists.
A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has ACTIVE node groups or queues.
A queue already exists in a cluster.

HTTP Status Code: 400

InternalServerException

AWS PCS can't process your request right now. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found. The cluster, node group, or queue you're attempting to get, update, list, or delete doesn't exist.

Examples

HTTP Status Code: 400

ServiceQuotaExceededException

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account. To learn how to increase your service quota, see Requesting a quota increase in the Service Quotas User Guide

Examples

The max number of clusters or queues has been reached for the account.
The max number of compute node groups has been reached for the associated cluster.
The total of maxInstances across all compute node groups has been reached for associated cluster.

HTTP Status Code: 400

ThrottlingException

Your request exceeded a request rate quota. Check the resource's request rate quota and try again.

HTTP Status Code: 400

ValidationException

The request isn't valid.

Examples

Your request contains malformed JSON or unsupported characters.
The scheduler version isn't supported.
There are networking related errors, such as network validation failure.
AMI type is CUSTOM and the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.

HTTP Status Code: 400