CloudDirectory / Client / create_schema

create_schema#

CloudDirectory.Client.create_schema(**kwargs)#

Creates a new schema in a development state. A schema can exist in three phases:

Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.
Published: Published schemas are immutable and have a version associated with them.
Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.

Request Syntax

response = client.create_schema(
    Name='string'
)

Parameters:

Name (string) –

[REQUIRED]

The name that is associated with the schema. This is unique to each account and in each region.

Return type:

dict

Returns:

Response Syntax

{
    'SchemaArn': 'string'
}

Response Structure

(dict) –
- SchemaArn (string) –
  
  The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

Exceptions