[ aws . marketplace-catalog ]

list-change-sets

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-change-sets
--catalog <value>
[--filter-list <value>]
[--sort <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--catalog (string)

The catalog related to the request. Fixed value: AWSMarketplace

--filter-list (list)

An array of filter objects.

(structure)

A filter object, used to optionally filter results from calls to the ListEntities and ListChangeSets actions.

Name -> (string)

For ListEntities , the supported value for this is an EntityId .

For ListChangeSets , the supported values are as follows:

ValueList -> (list)

ListEntities - This is a list of unique EntityId s.

ListChangeSets - The supported filter names and associated ValueList s is as follows:

• ChangeSetName - The supported ValueList is a list of non-unique ChangeSetName s. These are defined when you call the StartChangeSet action.

• Status - The supported ValueList is a list of statuses for all change set requests.

• EntityId - The supported ValueList is a list of unique EntityId s.

• BeforeStartTime - The supported ValueList is a list of all change sets that started before the filter value.

• AfterStartTime - The supported ValueList is a list of all change sets that started after the filter value.

• BeforeEndTime - The supported ValueList is a list of all change sets that ended before the filter value.

• AfterEndTime - The supported ValueList is a list of all change sets that ended after the filter value.

(string)

Shorthand Syntax:

Name=string,ValueList=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "ValueList": ["string", ...]
  }
  ...
]

--sort (structure)

An object that contains two attributes, SortBy and SortOrder .

SortBy -> (string)

For ListEntities , supported attributes include LastModifiedDate (default), Visibility , EntityId , and Name .

For ListChangeSets , supported attributes include StartTime and EndTime .

SortOrder -> (string)

The sorting order. Can be ASCENDING or DESCENDING . The default value is DESCENDING .

Shorthand Syntax:

SortBy=string,SortOrder=string

JSON Syntax:

{
  "SortBy": "string",
  "SortOrder": "ASCENDING"|"DESCENDING"
}

--max-results (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.

--next-token (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

ChangeSetSummaryList -> (list)

Array of ChangeSetSummaryListItem objects.

(structure)

A summary of a change set returned in a list of change sets when the ListChangeSets action is called.

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 -> (string)

The current status of the change set.

EntityIdList -> (list)

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.

(string)

NextToken -> (string)

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