Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeInventoryDeletions

Describes a specific delete inventory operation.

Request Syntax


{
   "DeletionId": "string",
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DeletionId

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

Type: String

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: No

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

A token to start the list. Use this token to get the next set of results.

Type: String

Required: No

Response Syntax


{
   "InventoryDeletions": [ 
      { 
         "DeletionId": "string",
         "DeletionStartTime": number,
         "DeletionSummary": { 
            "RemainingCount": number,
            "SummaryItems": [ 
               { 
                  "Count": number,
                  "RemainingCount": number,
                  "Version": "string"
               }
            ],
            "TotalCount": number
         },
         "LastStatus": "string",
         "LastStatusMessage": "string",
         "LastStatusUpdateTime": number,
         "TypeName": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

InventoryDeletions

A list of status items for deleted inventory.

Type: Array of InventoryDeletionStatusItem objects

NextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

InvalidDeletionIdException

The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.

HTTP Status Code: 400

InvalidNextToken

The specified token isn't valid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeInventoryDeletions.

Sample Request


POST / HTTP/1.1
Host: ssm.us-west-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeInventoryDeletions
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.25 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ssm.describe-inventory-deletions
X-Amz-Date: 20240810T211220Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240810/us-west-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2

{}

Sample Response


{
  "InventoryDeletions": [
    {
      "DeletionId": "5bc2ba3b-ee6a-40fa-8d09-5eExample",
      "DeletionStartTime": 1628550146,
      "DeletionSummary": {
        "RemainingCount": 0,
        "SummaryItems": [
          {
            "Count": 1,
            "RemainingCount": 0,
            "Version": "1.0"
          }
        ],
        "TotalCount": 1
      },
      "LastStatus": "Complete",
      "LastStatusMessage": "Deletion is successful",
      "LastStatusUpdateTime": 1628550238,
      "TypeName": "Custom:RackInfo"
    }
  ]
}