Skip to content

InventoryItemSchema

Source code in docs_src/capo_ssm/types/inventory_item_schema.py
class InventoryItemSchema(TypedDict, closed=True):
    type_name: "capo_ssm.types.inventory_item_type_name.InventoryItemTypeName"
    """<p>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: <code>AWS:AWSComponent</code>, <code>AWS:Application</code>, <code>AWS:InstanceInformation</code>, <code>AWS:Network</code>, and <code>AWS:WindowsUpdate</code>.</p>"""
    version: NotRequired[
        "capo_ssm.types.inventory_item_schema_version.InventoryItemSchemaVersion"
    ]
    """<p>The schema version for the inventory item.</p>"""
    attributes: (
        "capo_ssm.types.inventory_item_attribute_list.InventoryItemAttributeList"
    )
    """<p>The schema attributes for inventory. This contains data type and attribute name.</p>"""
    display_name: NotRequired[
        "capo_ssm.types.inventory_type_display_name.InventoryTypeDisplayName"
    ]
    """<p>The alias name of the inventory type. The alias name is used for display purposes.</p>"""

attributes instance-attribute

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

display_name instance-attribute

display_name: NotRequired[InventoryTypeDisplayName]

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

type_name instance-attribute

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 instance-attribute

version: NotRequired[InventoryItemSchemaVersion]

The schema version for the inventory item.