ManagedintegrationsforIoTDeviceManagement / Client / list_schema_versions

list_schema_versions

ManagedintegrationsforIoTDeviceManagement.Client.list_schema_versions(**kwargs)

Lists schema versions with the provided information.

See also: AWS API Documentation

Request Syntax

response = client.list_schema_versions(
    Type='capability'|'definition',
    MaxResults=123,
    NextToken='string',
    SchemaId='string',
    Namespace='string',
    Visibility='PUBLIC'|'PRIVATE',
    SemanticVersion='string'
)
Parameters:

  • Type (string) –

    [REQUIRED]

    Filter on the type of schema version.

  • MaxResults (integer) – The maximum number of results to return at one time.

  • NextToken (string) – A token that can be used to retrieve the next set of results.

  • SchemaId (string) – Filter on the id of the schema version.

  • Namespace (string) – Filter on the name of the schema version.

  • Visibility (string) – The visibility of the schema version.

  • SemanticVersion (string) – The schema version. If this is left blank, it defaults to the latest version.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'SchemaId': 'string',
            'Type': 'capability'|'definition',
            'Description': 'string',
            'Namespace': 'string',
            'SemanticVersion': 'string',
            'Visibility': 'PUBLIC'|'PRIVATE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      The list of schema versions.

      • (dict) –

        List item describing a schema version.

        • SchemaId (string) –

          The identifier of the schema version.

        • Type (string) –

          The type of schema version.

        • Description (string) –

          A 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.

    • NextToken (string) –

      A token that can be used to retrieve the next set of results.

Exceptions