---
title: "POST /ListResources"
method: POST
path: "/ListResources"
---

# POST /ListResources

`POST /ListResources`

Returns a list of resources and their details that match the specified criteria. This query must use a view. If you don’t explicitly specify a view, then Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.

## Request body

- object
  - `Filters` object — A search filter defines which resources can be part of a search query result set.
    - `FilterString` string — The string that contains the search keywords, prefixes, and operators to control the results that can be returned by a <a>Search</a> operation. For more details, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html">Search query syntax</a>.
  - `MaxResults` integer — <p>The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results.</p> <note> <p>An API operation can return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p> </note>
  - `ViewArn` string — Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a 401 Unauthorized exception.
  - `NextToken` string — <p>The parameter for receiving additional results if you receive a <code>NextToken</code> response in a previous request. A <code>NextToken</code> response indicates that more output is available. Set this parameter to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. The pagination tokens expire after 24 hours.</p> <note> <p>The <code>ListResources</code> operation does not generate a <code>NextToken</code> if you set <code>MaxResults</code> to 1000. </p> </note>

## Response `200`

Success

- ListResourcesOutput
  - `Resources` Resource[] — The list of structures that describe the resources that match the query.
    - `Arn` string — The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the resource.
    - `OwningAccountId` string — The Amazon Web Services account that owns the resource.
    - `Region` string — The Amazon Web Services Region in which the resource was created and exists.
    - `ResourceType` string — The type of the resource.
    - `Service` string — The Amazon Web Services service that owns the resource and is responsible for creating and updating it.
    - `CfnResourceType` string — The CloudFormation resource type identifier for the resource, such as <code>AWS::EC2::Instance</code> or <code>AWS::S3::Bucket</code>.
    - `LastReportedAt` string, date-time — The date and time that Resource Explorer last queried this resource and updated the index with the latest information about the resource.
    - `Properties` ResourceProperty[] — A structure with additional type-specific details about the resource. These properties can be added by turning on integration between Resource Explorer and other Amazon Web Services services.
      - `Name` string — The name of this property of the resource.
      - `LastReportedAt` string, date-time — The date and time that the information about this resource property was last updated.
      - `Data` object — Details about this property. The content of this field is a JSON object that varies based on the resource type.
  - `NextToken` string — If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. The pagination tokens expire after 24 hours.
  - `ViewArn` string — The Amazon resource name (ARN) of the view that this operation used to perform the search.

## Other responses

- `480` — ResourceNotFoundException
- `481` — InternalServerException
- `482` — ValidationException
- `483` — UnauthorizedException
- `484` — ThrottlingException
- `485` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/resource-explorer-2.md) · [All operations](https://skmtc.net/aws/apis/resource-explorer-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/resource-explorer-2/versions/d0cbc402825f/schema)
