ListChangeSets - AWS Marketplace Catalog API

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.

Request Syntax

POST /ListChangeSets HTTP/1.1 Content-type: application/json { "Catalog": "string", "FilterList": [ { "Name": "string", "ValueList": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "Sort": { "SortBy": "string", "SortOrder": "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Catalog

The catalog related to the request. Fixed value: AWSMarketplace

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z]+$

Required: Yes

FilterList

An array of filter objects.

Type: Array of Filter objects

Array Members: Minimum number of 1 item. Maximum number of 8 items.

Required: No

MaxResults

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.

Type: Integer

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

Required: No

NextToken

The token value retrieved from a previous call to access the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[\w+=.:@\-\/]$

Required: No

Sort

An object that contains two attributes, sortBy and sortOrder.

Type: Sort object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ChangeSetSummaryList": [ { "ChangeSetArn": "string", "ChangeSetId": "string", "ChangeSetName": "string", "EndTime": "string", "EntityIdList": [ "string" ], "StartTime": "string", "Status": "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.

ChangeSetSummaryList

Array of ChangeSetSummaryListItem objects.

Type: Array of ChangeSetSummaryListItem objects

NextToken

The value of the next token, if it exists. Null if there are no more results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[\w+=.:@\-\/]$

Errors

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

AccessDeniedException

Access is denied.

HTTP Status Code: 403

InternalServiceException

There was an internal service exception.

HTTP Status Code: 500

ThrottlingException

Too many requests.

HTTP Status Code: 429

ValidationException

An error occurred during validation.

HTTP Status Code: 422

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: