2017/12/06 - Amazon CloudDirectory - 3 new 3 updated api methods
Changes Amazon Cloud Directory makes it easier for you to apply schema changes across your directories with in-place schema upgrades. Your directories now remain available while backward-compatible schema changes are being applied, such as the addition of new fields. You also can view the history of your schema changes in Cloud Directory by using both major and minor version identifiers, which can help you track and audit schema versions across directories.
Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion . Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.
See also: AWS API Documentation
Request Syntax
client.upgrade_applied_schema(
PublishedSchemaArn='string',
DirectoryArn='string',
DryRun=True|False
)
string
[REQUIRED]
The revision of the published schema to upgrade the directory to.
string
[REQUIRED]
The ARN for the directory to which the upgraded schema will be applied.
boolean
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.
dict
Response Syntax
{
'UpgradedSchemaArn': 'string',
'DirectoryArn': 'string'
}
Response Structure
(dict) --
UpgradedSchemaArn (string) --
The ARN of the upgraded schema that is returned as part of the response.
DirectoryArn (string) --
The ARN of the directory that is returned as part of the response.
Returns current applied schema version ARN, including the minor version in use.
See also: AWS API Documentation
Request Syntax
client.get_applied_schema_version(
SchemaArn='string'
)
string
[REQUIRED]
The ARN of the applied schema.
dict
Response Syntax
{
'AppliedSchemaArn': 'string'
}
Response Structure
(dict) --
AppliedSchemaArn (string) --
Current applied schema ARN, including the minor version in use if one was provided.
Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn .
See also: AWS API Documentation
Request Syntax
client.upgrade_published_schema(
DevelopmentSchemaArn='string',
PublishedSchemaArn='string',
MinorVersion='string',
DryRun=True|False
)
string
[REQUIRED]
The ARN of the development schema with the changes used for the upgrade.
string
[REQUIRED]
The ARN of the published schema to be upgraded.
string
[REQUIRED]
Identifies the minor version of the published schema that will be created. This parameter is NOT optional.
boolean
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.
dict
Response Syntax
{
'UpgradedSchemaArn': 'string'
}
Response Structure
(dict) --
UpgradedSchemaArn (string) --
The ARN of the upgraded schema that is returned as part of the response.
{'SchemaArn': 'string'}
Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.
See also: AWS API Documentation
Request Syntax
client.list_applied_schema_arns(
DirectoryArn='string',
SchemaArn='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ARN of the directory you are listing.
string
The response for ListAppliedSchemaArns when this parameter is used will list all minor version ARNs for a major version.
string
The pagination token.
integer
The maximum number of results to retrieve.
dict
Response Syntax
{
'SchemaArns': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
SchemaArns (list) --
The ARNs of schemas that are applied to the directory.
(string) --
NextToken (string) --
The pagination token.
{'SchemaArn': 'string'}
Lists schema major versions for a published schema. If SchemaArn is provided, lists the minor version.
See also: AWS API Documentation
Request Syntax
client.list_published_schema_arns(
SchemaArn='string',
NextToken='string',
MaxResults=123
)
string
The response for ListPublishedSchemaArns when this parameter is used will list all minor version ARNs for a major version.
string
The pagination token.
integer
The maximum number of results to retrieve.
dict
Response Syntax
{
'SchemaArns': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
SchemaArns (list) --
The ARNs of published schemas.
(string) --
NextToken (string) --
The pagination token.
{'MinorVersion': 'string'}
Publishes a development schema with a major version and a recommended minor version.
See also: AWS API Documentation
Request Syntax
client.publish_schema(
DevelopmentSchemaArn='string',
Version='string',
MinorVersion='string',
Name='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see arns.
string
[REQUIRED]
The major version under which the schema will be published. Schemas have both a major and minor version associated with them.
string
The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.
string
The new name under which the schema will be published. If this is not provided, the development schema is considered.
dict
Response Syntax
{
'PublishedSchemaArn': 'string'
}
Response Structure
(dict) --
PublishedSchemaArn (string) --
The ARN that is associated with the published schema. For more information, see arns.