Schemas / Client / create_schema

create_schema#

Schemas.Client.create_schema(**kwargs)#

Creates a schema definition.

Note

Inactive schemas will be deleted after two years.

See also: AWS API Documentation

Request Syntax

response = client.create_schema(
    Content='string',
    Description='string',
    RegistryName='string',
    SchemaName='string',
    Tags={
        'string': 'string'
    },
    Type='OpenApi3'|'JSONSchemaDraft4'
)
Parameters:

  • Content (string) –

    [REQUIRED]

    The source of the schema definition.

  • Description (string) – A description of the schema.

  • RegistryName (string) –

    [REQUIRED]

    The name of the registry.

  • SchemaName (string) –

    [REQUIRED]

    The name of the schema.

  • Tags (dict) –

    Tags associated with the schema.

    • (string) –

      • (string) –

  • Type (string) –

    [REQUIRED]

    The type of schema.

Return type:

dict

Returns:

Response Syntax

{
    'Description': 'string',
    'LastModified': datetime(2015, 1, 1),
    'SchemaArn': 'string',
    'SchemaName': 'string',
    'SchemaVersion': 'string',
    'Tags': {
        'string': 'string'
    },
    'Type': 'string',
    'VersionCreatedDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    201 response

    • Description (string) –

      The description of the schema.

    • LastModified (datetime) –

      The date and time that schema was modified.

    • SchemaArn (string) –

      The ARN of the schema.

    • SchemaName (string) –

      The name of the schema.

    • SchemaVersion (string) –

      The version number of the schema

    • Tags (dict) –

      Key-value pairs associated with a resource.

      • (string) –

        • (string) –

    • Type (string) –

      The type of the schema.

    • VersionCreatedDate (datetime) –

      The date the schema version was created.

Exceptions