SSM / Client / get_inventory_schema

get_inventory_schema#

SSM.Client.get_inventory_schema(**kwargs)#

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

See also: AWS API Documentation

Request Syntax

response = client.get_inventory_schema(
    TypeName='string',
    NextToken='string',
    MaxResults=123,
    Aggregator=True|False,
    SubType=True|False
)
Parameters:

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

  • NextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)

  • MaxResults (integer) – The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

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

Return type:

dict

Returns:

Response Syntax

{
    'Schemas': [
        {
            'TypeName': 'string',
            'Version': 'string',
            'Attributes': [
                {
                    'Name': 'string',
                    'DataType': 'string'|'number'
                },
            ],
            'DisplayName': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Exceptions

  • SSM.Client.exceptions.InternalServerError

  • SSM.Client.exceptions.InvalidTypeNameException

  • SSM.Client.exceptions.InvalidNextToken