ManagedintegrationsforIoTDeviceManagement / Client / get_schema_version

get_schema_version#

ManagedintegrationsforIoTDeviceManagement.Client.get_schema_version(**kwargs)#

Gets a schema version with the provided information.

See also: AWS API Documentation

Request Syntax

response = client.get_schema_version(
    Type='capability'|'definition',
    SchemaVersionedId='string',
    Format='AWS'|'ZCL'|'CONNECTOR'
)
Parameters:

  • Type (string) –

    [REQUIRED]

    The type of schema version.

  • SchemaVersionedId (string) –

    [REQUIRED]

    Schema id with a version specified. If the version is missing, it defaults to latest version.

  • Format (string) – The format of the schema version.

Return type:

dict

Returns:

Response Syntax

{
    'SchemaId': 'string',
    'Type': 'capability'|'definition',
    'Description': 'string',
    'Namespace': 'string',
    'SemanticVersion': 'string',
    'Visibility': 'PUBLIC'|'PRIVATE',
    'Schema': {...}|[...]|123|123.4|'string'|True|None
}

Response Structure

  • (dict) –

    • SchemaId (string) –

      The id of the schema version.

    • Type (string) –

      The type of schema version.

    • Description (string) –

      The description of the schema version.

    • Namespace (string) –

      The name of the schema version.

    • SemanticVersion (string) –

      The schema version. If this is left blank, it defaults to the latest version.

    • Visibility (string) –

      The visibility of the schema version.

    • Schema (document) –

      The schema of the schema version.

Exceptions