SSM / Client / describe_inventory_deletions

describe_inventory_deletions#

SSM.Client.describe_inventory_deletions(**kwargs)#

Describes a specific delete inventory operation.

See also: AWS API Documentation

Request Syntax

response = client.describe_inventory_deletions(
    DeletionId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • DeletionId (string) – Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory operation.

  • NextToken (string) – A token to start the list. Use this token to get the next set of results.

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

Return type:

dict

Returns:

Response Syntax

{
    'InventoryDeletions': [
        {
            'DeletionId': 'string',
            'TypeName': 'string',
            'DeletionStartTime': datetime(2015, 1, 1),
            'LastStatus': 'InProgress'|'Complete',
            'LastStatusMessage': 'string',
            'DeletionSummary': {
                'TotalCount': 123,
                'RemainingCount': 123,
                'SummaryItems': [
                    {
                        'Version': 'string',
                        'Count': 123,
                        'RemainingCount': 123
                    },
                ]
            },
            'LastStatusUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • InventoryDeletions (list) –

      A list of status items for deleted inventory.

      • (dict) –

        Status information returned by the DeleteInventory operation.

        • DeletionId (string) –

          The deletion ID returned by the DeleteInventory operation.

        • TypeName (string) –

          The name of the inventory data type.

        • DeletionStartTime (datetime) –

          The UTC timestamp when the delete operation started.

        • LastStatus (string) –

          The status of the operation. Possible values are InProgress and Complete.

        • LastStatusMessage (string) –

          Information about the status.

        • DeletionSummary (dict) –

          Information about the delete operation. For more information about this summary, see Understanding the delete inventory summary 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.

        • LastStatusUpdateTime (datetime) –

          The UTC timestamp of when the last status report.

    • NextToken (string) –

      The token for the next set of items to return. Use this token to get the next set of results.

Exceptions