Skip to content

UpgradePublishedSchemaRequest

Source code in docs_src/capo_clouddirectory/types/upgrade_published_schema_request.py
class UpgradePublishedSchemaRequest(TypedDict, closed=True):
    development_schema_arn: "capo_clouddirectory.types.arn.Arn"
    """<p>The ARN of the development schema with the changes used for the upgrade.</p>"""
    published_schema_arn: "capo_clouddirectory.types.arn.Arn"
    """<p>The ARN of the published schema to be upgraded.</p>"""
    minor_version: "capo_clouddirectory.types.version.Version"
    """<p>Identifies the minor version of the published schema that will be created. This parameter is NOT optional.</p>"""
    dry_run: "capo_clouddirectory.types.bool.Bool"
    """<p>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.</p>"""

development_schema_arn instance-attribute

development_schema_arn: Arn

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

dry_run instance-attribute

dry_run: Bool

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.

minor_version instance-attribute

minor_version: Version

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

published_schema_arn instance-attribute

published_schema_arn: Arn

The ARN of the published schema to be upgraded.