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

************
update_queue
************



.. py:method:: DeadlineCloud.Client.update_queue(**kwargs)

  

  Updates a queue.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/UpdateQueue>`_  


  **Request Syntax**
  ::

    response = client.update_queue(
        clientToken='string',
        farmId='string',
        queueId='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'
        },
        requiredFileSystemLocationNamesToAdd=[
            'string',
        ],
        requiredFileSystemLocationNamesToRemove=[
            'string',
        ],
        allowedStorageProfileIdsToAdd=[
            'string',
        ],
        allowedStorageProfileIdsToRemove=[
            'string',
        ]
    )
    
  :type clientToken: string
  :param clientToken: 

    The idempotency token to update in the queue.

    This field is autopopulated if not provided.

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

    The farm ID to update in the queue.

    

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

    The queue ID to update.

    

  
  :type displayName: string
  :param displayName: 

    The display name of the queue to update.

     

    .. 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 to update.

     

    .. 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 for a queue update if a budget isn't configured.

    

  
  :type jobAttachmentSettings: dict
  :param jobAttachmentSettings: 

    The job attachment settings to update for the queue.

    

  
    - **s3BucketName** *(string) --* **[REQUIRED]** 

      The Amazon S3 bucket name.

      

    
    - **rootPrefix** *(string) --* **[REQUIRED]** 

      The root prefix.

      

    
  
  :type roleArn: string
  :param roleArn: 

    The IAM role ARN that's used to run jobs from this queue.

    

  
  :type jobRunAsUser: dict
  :param jobRunAsUser: 

    Update the jobs in the queue to run as a 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 requiredFileSystemLocationNamesToAdd: list
  :param requiredFileSystemLocationNamesToAdd: 

    The required file system location names to add to the queue.

    

  
    - *(string) --* 

    

  :type requiredFileSystemLocationNamesToRemove: list
  :param requiredFileSystemLocationNamesToRemove: 

    The required file system location names to remove from the queue.

    

  
    - *(string) --* 

    

  :type allowedStorageProfileIdsToAdd: list
  :param allowedStorageProfileIdsToAdd: 

    The storage profile IDs to add.

    

  
    - *(string) --* 

    

  :type allowedStorageProfileIdsToRemove: list
  :param allowedStorageProfileIdsToRemove: 

    The storage profile ID to remove.

    

  
    - *(string) --* 

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **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`

  