Skip to content

GetInventorySchemaRequest

Source code in docs_src/capo_ssm/types/get_inventory_schema_request.py
class GetInventorySchemaRequest(TypedDict, closed=True):
    type_name: NotRequired[
        "capo_ssm.types.inventory_item_type_name_filter.InventoryItemTypeNameFilter"
    ]
    """<p>The type of inventory item to return.</p>"""
    next_token: NotRequired["capo_ssm.types.next_token.NextToken"]
    """<p>The token for the next set of items to return. (You received this token from a previous call.)</p>"""
    max_results: NotRequired[
        "capo_ssm.types.get_inventory_schema_max_results.GetInventorySchemaMaxResults"
    ]
    """<p>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.</p>"""
    aggregator: "capo_ssm.types.aggregator_schema_only.AggregatorSchemaOnly"
    """<p>Returns inventory schemas that support aggregation. For example, this call returns the <code>AWS:InstanceInformation</code> type, because it supports aggregation based on the <code>PlatformName</code>, <code>PlatformType</code>, and <code>PlatformVersion</code> attributes.</p>"""
    sub_type: NotRequired["capo_ssm.types.is_sub_type_schema.IsSubTypeSchema"]
    """<p>Returns the sub-type schema for a specified inventory type.</p>"""

aggregator instance-attribute

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.

max_results instance-attribute

max_results: NotRequired[GetInventorySchemaMaxResults]

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.

next_token instance-attribute

next_token: NotRequired[NextToken]

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

sub_type instance-attribute

sub_type: NotRequired[IsSubTypeSchema]

Returns the sub-type schema for a specified inventory type.

type_name instance-attribute

type_name: NotRequired[InventoryItemTypeNameFilter]

The type of inventory item to return.