DeadlineCloud / Client / create_queue

create_queue#

DeadlineCloud.Client.create_queue(**kwargs)#

Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.

See also: AWS API Documentation

Request Syntax

response = client.create_queue(
    clientToken='string',
    farmId='string',
    displayName='string',
    description='string',
    defaultBudgetAction='NONE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS',
    jobAttachmentSettings={
        's3BucketName': 'string',
        'rootPrefix': 'string'
    },
    roleArn='string',
    jobRunAsUser={
        'posix': {
            'user': 'string',
            'group': 'string'
        },
        'windows': {
            'user': 'string',
            'passwordArn': 'string'
        },
        'runAs': 'QUEUE_CONFIGURED_USER'|'WORKER_AGENT_USER'
    },
    requiredFileSystemLocationNames=[
        'string',
    ],
    allowedStorageProfileIds=[
        'string',
    ],
    tags={
        'string': 'string'
    }
)
Parameters:

  • clientToken (string) –

    The unique token which the server uses to recognize retries of the same request.

    This field is autopopulated if not provided.

  • farmId (string) –

    [REQUIRED]

    The farm ID of the farm to connect to the queue.

  • displayName (string) –

    [REQUIRED]

    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.

  • defaultBudgetAction (string) – The default action to take on a queue if a budget isn’t configured.

  • jobAttachmentSettings (dict) –

    The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

    • s3BucketName (string) – [REQUIRED]

      The Amazon S3 bucket name.

    • rootPrefix (string) – [REQUIRED]

      The root prefix.

  • roleArn (string) – The IAM role ARN that workers will use while running jobs for this queue.

  • jobRunAsUser (dict) –

    The jobs in the queue run as the specified POSIX user.

    • posix (dict) –

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

      • user (string) – [REQUIRED]

        The name of the POSIX user.

      • group (string) – [REQUIRED]

        The name of the POSIX user’s group.

    • windows (dict) –

      Identifies a Microsoft Windows user.

      • user (string) – [REQUIRED]

        The user.

      • passwordArn (string) – [REQUIRED]

        The password ARN for the Windows user.

    • runAs (string) – [REQUIRED]

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

  • requiredFileSystemLocationNames (list) –

    The file system location name to include in the queue.

    • (string) –

  • allowedStorageProfileIds (list) –

    The storage profile IDs to include in the queue.

    • (string) –

  • tags (dict) –

    Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'queueId': 'string'
}

Response Structure

  • (dict) –

    • queueId (string) –

      The queue ID.

Exceptions