:doc:`SSM <../../ssm>` / Client / update_document_default_version

*******************************
update_document_default_version
*******************************



.. py:method:: SSM.Client.update_document_default_version(**kwargs)

  

  Set the default version of a document.

   

  .. note::

    

    If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the ``apply-only-at-cron-interval`` parameter.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocumentDefaultVersion>`_  


  **Request Syntax**
  ::

    response = client.update_document_default_version(
        Name='string',
        DocumentVersion='string'
    )
    
  :type Name: string
  :param Name: **[REQUIRED]** 

    The name of a custom document that you want to set as the default version.

    

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

    The version of a custom document that you want to set as the default version.

    

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

    
    ::

      {
          'Description': {
              'Name': 'string',
              'DefaultVersion': 'string',
              'DefaultVersionName': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Description** *(dict) --* 

        The description of a custom document that you want to set as the default version.

        
        

        - **Name** *(string) --* 

          The name of the document.

          
        

        - **DefaultVersion** *(string) --* 

          The default version of the document.

          
        

        - **DefaultVersionName** *(string) --* 

          The default version of the artifact associated with the document.

          
    
  
  **Exceptions**
  
  *   :py:class:`SSM.Client.exceptions.InternalServerError`

  
  *   :py:class:`SSM.Client.exceptions.InvalidDocument`

  
  *   :py:class:`SSM.Client.exceptions.InvalidDocumentVersion`

  
  *   :py:class:`SSM.Client.exceptions.InvalidDocumentSchemaVersion`

  