SSM / Paginator / GetInventorySchema

GetInventorySchema

class SSM.Paginator.GetInventorySchema

paginator = client.get_paginator('get_inventory_schema')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSM.Client.get_inventory_schema().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TypeName='string',
    Aggregator=True|False,
    SubType=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• TypeName (string) – The type of inventory item to return.

• Aggregator (boolean) – Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType, and PlatformVersion attributes.

• SubType (boolean) – Returns the sub-type schema for a specified inventory type.

• 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

{
    'Schemas': [
        {
            'TypeName': 'string',
            'Version': 'string',
            'Attributes': [
                {
                    'Name': 'string',
                    'DataType': 'string'|'number'
                },
            ],
            'DisplayName': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Schemas (list) –

    Inventory schemas returned by the request.

    • (dict) –

      The inventory item schema definition. Users can use this to compose inventory query filters.

      • TypeName (string) –

        The name of the inventory type. Default inventory item type names start with Amazon Web Services. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.

      • Version (string) –

        The schema version for the inventory item.

      • Attributes (list) –

        The schema attributes for inventory. This contains data type and attribute name.

        • (dict) –

          Attributes are the entries within the inventory item content. It contains name and value.

          • Name (string) –

            Name of the inventory item attribute.

          • DataType (string) –

            The data type of the inventory item attribute.

      • DisplayName (string) –

        The alias name of the inventory type. The alias name is used for display purposes.