ManagedintegrationsforIoTDeviceManagement / Paginator / ListSchemaVersions

ListSchemaVersions#

class ManagedintegrationsforIoTDeviceManagement.Paginator.ListSchemaVersions#
paginator = client.get_paginator('list_schema_versions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ManagedintegrationsforIoTDeviceManagement.Client.list_schema_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Type='capability'|'definition',
    SchemaId='string',
    Namespace='string',
    Visibility='PUBLIC'|'PRIVATE',
    SemanticVersion='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • Type (string) –

    [REQUIRED]

    Filter on the type of schema version.

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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

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.