Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ssm ]

describe-inventory-deletions

Description

Describes a specific delete inventory operation.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-inventory-deletions is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: InventoryDeletions

Synopsis

  describe-inventory-deletions
[--deletion-id <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--deletion-id (string)

Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory action.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

InventoryDeletions -> (list)

A list of status items for deleted inventory.

(structure)

Status information returned by the DeleteInventory action.

DeletionId -> (string)

The deletion ID returned by the DeleteInventory action.

TypeName -> (string)

The name of the inventory data type.

DeletionStartTime -> (timestamp)

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 -> (structure)

Information about the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide .

TotalCount -> (integer)

The total number of items to delete. This count does not change during the delete operation.

RemainingCount -> (integer)

Remaining number of items to delete.

SummaryItems -> (list)

A list of counts and versions for deleted items.

(structure)

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 -> (timestamp)

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.