DeadlineCloud / Client / get_queue

get_queue

DeadlineCloud.Client.get_queue(**kwargs)

Gets a queue.

See also: AWS API Documentation

Request Syntax

response = client.get_queue(
    farmId='string',
    queueId='string'
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID of the farm in the queue.

• queueId (string) –

  [REQUIRED]

  The queue ID for the queue to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'queueId': 'string',
    'displayName': 'string',
    'description': 'string',
    'farmId': 'string',
    'status': 'IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED',
    'defaultBudgetAction': 'NONE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS',
    'blockedReason': 'NO_BUDGET_CONFIGURED'|'BUDGET_THRESHOLD_REACHED',
    'jobAttachmentSettings': {
        's3BucketName': 'string',
        'rootPrefix': 'string'
    },
    'roleArn': 'string',
    'requiredFileSystemLocationNames': [
        'string',
    ],
    'allowedStorageProfileIds': [
        'string',
    ],
    'jobRunAsUser': {
        'posix': {
            'user': 'string',
            'group': 'string'
        },
        'windows': {
            'user': 'string',
            'passwordArn': 'string'
        },
        'runAs': 'QUEUE_CONFIGURED_USER'|'WORKER_AGENT_USER'
    },
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

• (dict) –

  • queueId (string) –

    The queue ID.

  • displayName (string) –

    The display name of the queue.

    Warning

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • description (string) –

    The description of the queue.

    Warning

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • farmId (string) –

    The farm ID for the queue.

  • status (string) –

    The status of the queue.

    • ACTIVE–The queue is active.

    • SCHEDULING–The queue is scheduling.

    • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

  • defaultBudgetAction (string) –

    The default action taken on a queue if a budget wasn’t configured.

  • blockedReason (string) –

    The reason the queue was blocked.

  • jobAttachmentSettings (dict) –

    The job attachment settings for the queue.

    • s3BucketName (string) –

      The Amazon S3 bucket name.

    • rootPrefix (string) –

      The root prefix.

  • roleArn (string) –

    The IAM role ARN.

  • requiredFileSystemLocationNames (list) –

    A list of the required file system location names in the queue.

    • (string) –

  • allowedStorageProfileIds (list) –

    The storage profile IDs for the queue.

    • (string) –

  • jobRunAsUser (dict) –

    The jobs in the queue ran as this specified POSIX user.

    • posix (dict) –

      The user and group that the jobs in the queue run as.

      • user (string) –

        The name of the POSIX user.

      • group (string) –

        The name of the POSIX user’s group.

    • windows (dict) –

      Identifies a Microsoft Windows user.

      • user (string) –

        The user.

      • passwordArn (string) –

        The password ARN for the Windows user.

    • runAs (string) –

      Specifies whether the job should run using the queue’s system user or if the job should run using the worker agent system user.

  • createdAt (datetime) –

    The date and time the resource was created.

  • createdBy (string) –

    The user or system that created this resource.

  • updatedAt (datetime) –

    The date and time the resource was updated.

  • updatedBy (string) –

    The user or system that updated this resource.

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException