ParallelComputingService / Client / update_queue

update_queue#

ParallelComputingService.Client.update_queue(**kwargs)#

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

response = client.update_queue(
    clusterIdentifier='string',
    queueIdentifier='string',
    computeNodeGroupConfigurations=[
        {
            'computeNodeGroupId': 'string'
        },
    ],
    clientToken='string'
)

Parameters:

clusterIdentifier (string) –
[REQUIRED]

The name or ID of the cluster of the queue.
queueIdentifier (string) –
[REQUIRED]

The name or ID of the queue.
computeNodeGroupConfigurations (list) –
The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.
- (dict) –
  
  The compute node group configuration for a queue.
  - computeNodeGroupId (string) –
    
    The compute node group ID for the compute node group configuration.
clientToken (string) –
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 CLI and SDK automatically generate 1 for you.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'queue': {
        'name': 'string',
        'id': 'string',
        'arn': 'string',
        'clusterId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'modifiedAt': datetime(2015, 1, 1),
        'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'|'UPDATE_FAILED',
        'computeNodeGroupConfigurations': [
            {
                'computeNodeGroupId': 'string'
            },
        ],
        'errorInfo': [
            {
                'code': 'string',
                'message': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- queue (dict) –
  
  A queue resource.
  - name (string) –
    
    The name that identifies the queue.
  - id (string) –
    
    The generated unique ID of the queue.
  - arn (string) –
    
    The unique Amazon Resource Name (ARN) of the queue.
  - clusterId (string) –
    
    The ID of the cluster of the queue.
  - createdAt (datetime) –
    
    The date and time the resource was created.
  - modifiedAt (datetime) –
    
    The date and time the resource was modified.
  - status (string) –
    
    The provisioning status of the queue.
    
    Note
    The provisioning status doesn’t indicate the overall health of the queue.
  - computeNodeGroupConfigurations (list) –
    
    The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.
    - (dict) –
      
      The compute node group configuration for a queue.
      - computeNodeGroupId (string) –
        
        The compute node group ID for the compute node group configuration.
  - errorInfo (list) –
    
    The list of errors that occurred during queue provisioning.
    - (dict) –
      
      An error that occurred during resource creation.
      - code (string) –
        
        The short-form error code.
      - message (string) –
        
        The detailed error information.

Exceptions

ParallelComputingService.Client.exceptions.ServiceQuotaExceededException
ParallelComputingService.Client.exceptions.ThrottlingException
ParallelComputingService.Client.exceptions.ValidationException
ParallelComputingService.Client.exceptions.ConflictException
ParallelComputingService.Client.exceptions.ResourceNotFoundException
ParallelComputingService.Client.exceptions.InternalServerException
ParallelComputingService.Client.exceptions.AccessDeniedException