:doc:`CloudDirectory <../../clouddirectory>` / Client / upgrade_published_schema

************************
upgrade_published_schema
************************



.. py:method:: CloudDirectory.Client.upgrade_published_schema(**kwargs)

  

  Upgrades a published schema under a new minor version revision using the current contents of ``DevelopmentSchemaArn``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpgradePublishedSchema>`_  


  **Request Syntax**
  ::

    response = client.upgrade_published_schema(
        DevelopmentSchemaArn='string',
        PublishedSchemaArn='string',
        MinorVersion='string',
        DryRun=True|False
    )
    
  :type DevelopmentSchemaArn: string
  :param DevelopmentSchemaArn: **[REQUIRED]** 

    The ARN of the development schema with the changes used for the upgrade.

    

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

    The ARN of the published schema to be upgraded.

    

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

    Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

    

  
  :type DryRun: boolean
  :param DryRun: 

    Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **UpgradedSchemaArn** *(string) --* 

        The ARN of the upgraded schema that is returned as part of the response.

        
  
  **Exceptions**
  
  *   :py:class:`CloudDirectory.Client.exceptions.InternalServiceException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.InvalidArnException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.RetryableConflictException`

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

  
  *   :py:class:`CloudDirectory.Client.exceptions.IncompatibleSchemaException`

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

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

  
  *   :py:class:`CloudDirectory.Client.exceptions.InvalidAttachmentException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.LimitExceededException`

  