ParallelComputingService / Client / get_queue

get_queue¶

ParallelComputingService.Client.get_queue(**kwargs)¶

Returns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.

Request Syntax

response = client.get_queue(
    clusterIdentifier='string',
    queueIdentifier='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.

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'|'SUSPENDING'|'SUSPENDED',
        'computeNodeGroupConfigurations': [
            {
                'computeNodeGroupId': 'string'
            },
        ],
        'slurmConfiguration': {
            'slurmCustomSettings': [
                {
                    'parameterName': 'string',
                    'parameterValue': '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.
    
    Warning
    The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can’t use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
  - 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.
  - slurmConfiguration (dict) –
    
    Additional options related to the Slurm scheduler.
    - slurmCustomSettings (list) –
      
      Additional Slurm-specific configuration that directly maps to Slurm settings.
      - (dict) –
        
        Additional settings that directly map to Slurm settings.
        
        Warning
        PCS supports a subset of Slurm settings. For more information, see Configuring custom Slurm settings in PCS in the PCS User Guide.
        
        parameterName (string) –
        
        PCS supports custom Slurm settings for clusters, compute node groups, and queues. For more information, see Configuring custom Slurm settings in PCS in the PCS User Guide.
        
        parameterValue (string) –
        
        The values for the configured Slurm settings.
  - 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.ThrottlingException
ParallelComputingService.Client.exceptions.ValidationException
ParallelComputingService.Client.exceptions.ConflictException
ParallelComputingService.Client.exceptions.ResourceNotFoundException
ParallelComputingService.Client.exceptions.InternalServerException
ParallelComputingService.Client.exceptions.AccessDeniedException