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.

See also: AWS API Documentation

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',
        '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