Skip to content

UpgradeAppliedSchemaRequest

Source code in docs_src/capo_clouddirectory/types/upgrade_applied_schema_request.py
class UpgradeAppliedSchemaRequest(TypedDict, closed=True):
    published_schema_arn: "capo_clouddirectory.types.arn.Arn"
    """<p>The revision of the published schema to upgrade the directory to.</p>"""
    directory_arn: "capo_clouddirectory.types.arn.Arn"
    """<p>The ARN for the directory to which the upgraded schema will be applied.</p>"""
    dry_run: "capo_clouddirectory.types.bool.Bool"
    """<p>Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.</p>"""

directory_arn instance-attribute

directory_arn: Arn

The ARN for the directory to which the upgraded schema will be applied.

dry_run instance-attribute

dry_run: Bool

Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.

published_schema_arn instance-attribute

published_schema_arn: Arn

The revision of the published schema to upgrade the directory to.