Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListResourceInventory

Lists resources managed using Systems Manager inventory.

Request Syntax


{
   "Filters": [ 
      { 
         "Condition": "string",
         "Name": "string",
         "Value": "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.

Filters

Filters to scope the results. The following filters and logical operators are supported:

account_id - The ID of the AWS account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.
application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH.
license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS. Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.
platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH.
resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS.
tag:<key> - The key/value combination of a tag assigned to the resource. Logical operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).

Type: Array of InventoryFilter objects

Required: No

MaxResults

Maximum number of results to return in a single call.

Type: Integer

Required: No

NextToken

Token for the next set of results.

Type: String

Required: No

Response Syntax


{
   "NextToken": "string",
   "ResourceInventoryList": [ 
      { 
         "Platform": "string",
         "PlatformVersion": "string",
         "ResourceArn": "string",
         "ResourceId": "string",
         "ResourceOwningAccountId": "string",
         "ResourceType": "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.

NextToken

Token for the next set of results.

Type: String

ResourceInventoryList

Information about the resources.

Type: Array of ResourceInventory objects

Errors

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

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400

AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.

HTTP Status Code: 400

FailedDependencyException

A dependency required to run the API is missing.

HTTP Status Code: 400

FilterLimitExceededException

The request uses too many filters or too many filter values.

HTTP Status Code: 400

InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400

RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400

ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500