SSM / Client / delete_inventory

delete_inventory#

SSM.Client.delete_inventory(**kwargs)#

Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.

See also: AWS API Documentation

Request Syntax

response = client.delete_inventory(
    TypeName='string',
    SchemaDeleteOption='DisableSchema'|'DeleteSchema',
    DryRun=True|False,
    ClientToken='string'
)
Parameters:

  • TypeName (string) –

    [REQUIRED]

    The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

  • SchemaDeleteOption (string) –

    Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don’t choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

    DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory operation for a version greater than the disabled version.

    DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

  • DryRun (boolean) – Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

  • ClientToken (string) –

    User-provided idempotency token.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'DeletionId': 'string',
    'TypeName': 'string',
    'DeletionSummary': {
        'TotalCount': 123,
        'RemainingCount': 123,
        'SummaryItems': [
            {
                'Version': 'string',
                'Count': 123,
                'RemainingCount': 123
            },
        ]
    }
}

Response Structure

  • (dict) –

    • DeletionId (string) –

      Every DeleteInventory operation is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other operations.

    • TypeName (string) –

      The name of the inventory data type specified in the request.

    • DeletionSummary (dict) –

      A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the Amazon Web Services Systems Manager User Guide.

      • TotalCount (integer) –

        The total number of items to delete. This count doesn’t change during the delete operation.

      • RemainingCount (integer) –

        Remaining number of items to delete.

      • SummaryItems (list) –

        A list of counts and versions for deleted items.

        • (dict) –

          Either a count, remaining count, or a version number in a delete inventory summary.

          • Version (string) –

            The inventory type version.

          • Count (integer) –

            A count of the number of deleted items.

          • RemainingCount (integer) –

            The remaining number of items to delete.

Exceptions