Skip to content

Upgrade Published Schema

clouddirectory_upgrade_published_schema R Documentation

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

Description

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

Usage

clouddirectory_upgrade_published_schema(DevelopmentSchemaArn,
  PublishedSchemaArn, MinorVersion, DryRun)

Arguments

DevelopmentSchemaArn

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

PublishedSchemaArn

[required] The ARN of the published schema to be upgraded.

MinorVersion

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

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.

Value

A list with the following syntax:

list(
  UpgradedSchemaArn = "string"
)

Request syntax

svc$upgrade_published_schema(
  DevelopmentSchemaArn = "string",
  PublishedSchemaArn = "string",
  MinorVersion = "string",
  DryRun = TRUE|FALSE
)