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

# POST /ListChangeSets

`POST /ListChangeSets`

Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of `entityId`, `ChangeSetName`, and status. If you provide more than one filter, the API operation applies a logical AND between the filters.

You can describe a change during the 60-day request history retention period for API calls.

## Query parameters

- `MaxResults` string
- `NextToken` string

## Request body

- object
  - `Catalog` string, required — The catalog related to the request. Fixed value: <code>AWSMarketplace</code>
  - `FilterList` Filter[] — An array of filter objects.
    - `Name` string — <p>For <code>ListEntities</code>, the supported value for this is an <code>EntityId</code>.</p> <p>For <code>ListChangeSets</code>, the supported values are as follows:</p>
    - `ValueList` FilterValueContent[] — <p> <code>ListEntities</code> - This is a list of unique <code>EntityId</code>s.</p> <p> <code>ListChangeSets</code> - The supported filter names and associated <code>ValueList</code>s is as follows:</p> <ul> <li> <p> <code>ChangeSetName</code> - The supported <code>ValueList</code> is a list of non-unique <code>ChangeSetName</code>s. These are defined when you call the <code>StartChangeSet</code> action.</p> </li> <li> <p> <code>Status</code> - The supported <code>ValueList</code> is a list of statuses for all change set requests.</p> </li> <li> <p> <code>EntityId</code> - The supported <code>ValueList</code> is a list of unique <code>EntityId</code>s.</p> </li> <li> <p> <code>BeforeStartTime</code> - The supported <code>ValueList</code> is a list of all change sets that started before the filter value.</p> </li> <li> <p> <code>AfterStartTime</code> - The supported <code>ValueList</code> is a list of all change sets that started after the filter value.</p> </li> <li> <p> <code>BeforeEndTime</code> - The supported <code>ValueList</code> is a list of all change sets that ended before the filter value.</p> </li> <li> <p> <code>AfterEndTime</code> - The supported <code>ValueList</code> is a list of all change sets that ended after the filter value.</p> </li> </ul>
  - `Sort` object — An object that contains two attributes, <code>SortBy</code> and <code>SortOrder</code>.
    - `SortBy` string — <p>For <code>ListEntities</code>, supported attributes include <code>LastModifiedDate</code> (default), <code>Visibility</code>, <code>EntityId</code>, and <code>Name</code>.</p> <p>For <code>ListChangeSets</code>, supported attributes include <code>StartTime</code> and <code>EndTime</code>.</p>
    - `SortOrder` 'ASCENDING' | 'DESCENDING' — The sorting order. Can be <code>ASCENDING</code> or <code>DESCENDING</code>. The default value is <code>DESCENDING</code>.
  - `MaxResults` integer — The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results. By default, this value is 20.
  - `NextToken` string — The token value retrieved from a previous call to access the next page of results.

## Response `200`

Success

- ListChangeSetsResponse
  - `ChangeSetSummaryList` ChangeSetSummaryListItem[] — Array of <code>ChangeSetSummaryListItem</code> objects.
    - `ChangeSetId` string — The unique identifier for a change set.
    - `ChangeSetArn` string — The ARN associated with the unique identifier for the change set referenced in this request.
    - `ChangeSetName` string — The non-unique name for the change set.
    - `StartTime` string — The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.
    - `EndTime` string — The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.
    - `Status` 'PREPARING' | 'APPLYING' | 'SUCCEEDED' | 'CANCELLED' | 'FAILED' — The current status of the change set.
    - `EntityIdList` ResourceId[] — This object is a list of entity IDs (string) that are a part of a change set. The entity ID list is a maximum of 20 entities. It must contain at least one entity.
    - `FailureCode` 'CLIENT_ERROR' | 'SERVER_FAULT' — Returned if the change set is in <code>FAILED</code> status. Can be either <code>CLIENT_ERROR</code>, which means that there are issues with the request (see the <code>ErrorDetailList</code> of <code>DescribeChangeSet</code>), or <code>SERVER_FAULT</code>, which means that there is a problem in the system, and you should retry your request.
  - `NextToken` string — The value of the next token, if it exists. Null if there are no more results.

## Other responses

- `480` — InternalServiceException
- `481` — AccessDeniedException
- `482` — ValidationException
- `483` — ThrottlingException

---

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