update_schema

Schemas.Client.update_schema(**kwargs)

Updates the schema definition

Note

Inactive schemas will be deleted after two years.

See also: AWS API Documentation

Request Syntax

response = client.update_schema(
    ClientTokenId='string',
    Content='string',
    Description='string',
    RegistryName='string',
    SchemaName='string',
    Type='OpenApi3'|'JSONSchemaDraft4'
)

Parameters

• ClientTokenId (string) --

  The ID of the client token.

  This field is autopopulated if not provided.

• Content (string) -- The source of the schema definition.
• Description (string) -- The description of the schema.
• RegistryName (string) --

  [REQUIRED]

  The name of the registry.

• SchemaName (string) --

  [REQUIRED]

  The name of the schema.

• Type (string) -- The schema type for the events 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) --

  200 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

• Schemas.Client.exceptions.BadRequestException
• Schemas.Client.exceptions.InternalServerErrorException
• Schemas.Client.exceptions.ForbiddenException
• Schemas.Client.exceptions.NotFoundException
• Schemas.Client.exceptions.ServiceUnavailableException