:doc:`MarketplaceCatalog <../../marketplace-catalog>` / Client / list_change_sets

****************
list_change_sets
****************



.. py:method:: MarketplaceCatalog.Client.list_change_sets(**kwargs)

  

  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 <https://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ListChangeSets>`_  


  **Request Syntax**
  ::

    response = client.list_change_sets(
        Catalog='string',
        FilterList=[
            {
                'Name': 'string',
                'ValueList': [
                    'string',
                ]
            },
        ],
        Sort={
            'SortBy': 'string',
            'SortOrder': 'ASCENDING'|'DESCENDING'
        },
        MaxResults=123,
        NextToken='string'
    )
    
  :type Catalog: string
  :param Catalog: **[REQUIRED]** 

    The catalog related to the request. Fixed value: ``AWSMarketplace``

    

  
  :type FilterList: list
  :param FilterList: 

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

        
    
    

  :type Sort: dict
  :param Sort: 

    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``.

      

    
  
  :type MaxResults: integer
  :param 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 NextToken: string
  :param NextToken: 

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

    

  
  
  :rtype: 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'
              },
          ],
          'NextToken': 'string'
      }
      
    **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.

            
      
    
      

      - **NextToken** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`MarketplaceCatalog.Client.exceptions.InternalServiceException`

  
  *   :py:class:`MarketplaceCatalog.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`MarketplaceCatalog.Client.exceptions.ValidationException`

  
  *   :py:class:`MarketplaceCatalog.Client.exceptions.ThrottlingException`

  