:doc:`Omics <../../omics>` / Client / update_workflow

***************
update_workflow
***************



.. py:method:: Omics.Client.update_workflow(**kwargs)

  

  Updates information about a workflow.

   

  You can update the following workflow information:

   

  
  * Name
   
  * Description
   
  * Default storage type
   
  * Default storage capacity (with workflow ID)
  

   

  This operation returns a response with no body if the operation is successful. You can check the workflow updates by calling the ``GetWorkflow`` API operation.

   

  For more information, see `Update a private workflow <https://docs.aws.amazon.com/omics/latest/dev/update-private-workflow.html>`__ in the *Amazon Web Services HealthOmics User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateWorkflow>`_  


  **Request Syntax**
  ::

    response = client.update_workflow(
        id='string',
        name='string',
        description='string',
        storageType='STATIC'|'DYNAMIC',
        storageCapacity=123,
        readmeMarkdown='string'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The workflow's ID.

    

  
  :type name: string
  :param name: 

    A name for the workflow.

    

  
  :type description: string
  :param description: 

    A description for the workflow.

    

  
  :type storageType: string
  :param storageType: 

    The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see `Running workflows <https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html>`__ in the *Amazon Web Services HealthOmics User Guide*.

    

  
  :type storageCapacity: integer
  :param storageCapacity: 

    The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

    

  
  :type readmeMarkdown: string
  :param readmeMarkdown: 

    The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.

    

  
  
  :returns: None
  **Exceptions**
  
  *   :py:class:`Omics.Client.exceptions.InternalServerException`

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

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

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

  
  *   :py:class:`Omics.Client.exceptions.ConflictException`

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

  
  *   :py:class:`Omics.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Omics.Client.exceptions.RequestTimeoutException`

  