:doc:`DeadlineCloud <../../deadline>` / Client / create_queue

************
create_queue
************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/CreateQueue>`_  


  **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'
        }
    )
    
  :type clientToken: string
  :param clientToken: 

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

    This field is autopopulated if not provided.

  
  :type farmId: string
  :param farmId: **[REQUIRED]** 

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

    

  
  :type displayName: string
  :param displayName: **[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.

      

    

  
  :type description: string
  :param description: 

    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.

      

    

  
  :type defaultBudgetAction: string
  :param defaultBudgetAction: 

    The default action to take on a queue if a budget isn't configured.

    

  
  :type jobAttachmentSettings: dict
  :param jobAttachmentSettings: 

    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.

      

    
  
  :type roleArn: string
  :param roleArn: 

    The IAM role ARN that workers will use while running jobs for this queue.

    

  
  :type jobRunAsUser: dict
  :param jobRunAsUser: 

    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.

      

    
  
  :type requiredFileSystemLocationNames: list
  :param requiredFileSystemLocationNames: 

    The file system location name to include in the queue.

    

  
    - *(string) --* 

    

  :type allowedStorageProfileIds: list
  :param allowedStorageProfileIds: 

    The storage profile IDs to include in the queue.

    

  
    - *(string) --* 

    

  :type tags: dict
  :param tags: 

    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) --* 

      


  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'queueId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **queueId** *(string) --* 

        The queue ID.

        
  
  **Exceptions**
  
  *   :py:class:`DeadlineCloud.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.ValidationException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.ServiceQuotaExceededException`

  