MarketplaceCatalog / Paginator / ListChangeSets

ListChangeSets

class MarketplaceCatalog.Paginator.ListChangeSets

paginator = client.get_paginator('list_change_sets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MarketplaceCatalog.Client.list_change_sets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Catalog='string',
    FilterList=[
        {
            'Name': 'string',
            'ValueList': [
                'string',
            ]
        },
    ],
    Sort={
        'SortBy': 'string',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog related to the request. Fixed value: AWSMarketplace

• FilterList (list) –

  An array of filter objects.

  • (dict) –

    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) –

• Sort (dict) –

  An object that contains two attributes, SortBy and SortOrder.

  • SortBy (string) –

    For ListEntities, supported attributes include LastModifiedDate (default) and EntityId. In addition to LastModifiedDate and EntityId, each EntityType might support additional fields.

    For ListChangeSets, supported attributes include StartTime and EndTime.

  • SortOrder (string) –

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'ChangeSetSummaryList': [
        {
            'ChangeSetId': 'string',
            'ChangeSetArn': 'string',
            'ChangeSetName': 'string',
            'StartTime': 'string',
            'EndTime': 'string',
            'Status': 'PREPARING'|'APPLYING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
            'EntityIdList': [
                'string',
            ],
            'FailureCode': 'CLIENT_ERROR'|'SERVER_FAULT'
        },
    ],

}

Response Structure

• (dict) –

  • ChangeSetSummaryList (list) –

    Array of ChangeSetSummaryListItem objects.

    • (dict) –

      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) –

      • FailureCode (string) –

        Returned if the change set is in FAILED status. Can be either CLIENT_ERROR, which means that there are issues with the request (see the ErrorDetailList of DescribeChangeSet), or SERVER_FAULT, which means that there is a problem in the system, and you should retry your request.