:doc:`PartnerCentralChannelAPI <../../partnercentral-channel>` / Paginator / ListRelationships

*****************
ListRelationships
*****************



.. py:class:: PartnerCentralChannelAPI.Paginator.ListRelationships

  ::

    
    paginator = client.get_paginator('list_relationships')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`PartnerCentralChannelAPI.Client.list_relationships`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/ListRelationships>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          catalog='string',
          associatedAccountIds=[
              'string',
          ],
          associationTypes=[
              'DOWNSTREAM_SELLER'|'END_CUSTOMER'|'INTERNAL',
          ],
          displayNames=[
              'string',
          ],
          programManagementAccountIdentifiers=[
              'string',
          ],
          sort={
              'sortOrder': 'Ascending'|'Descending',
              'sortBy': 'UpdatedAt'
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type catalog: string
    :param catalog: **[REQUIRED]** 

      The catalog identifier to filter relationships.

      

    
    :type associatedAccountIds: list
    :param associatedAccountIds: 

      Filter by associated AWS account IDs.

      

    
      - *(string) --* 

      
  
    :type associationTypes: list
    :param associationTypes: 

      Filter by association types.

      

    
      - *(string) --* 

      
  
    :type displayNames: list
    :param displayNames: 

      Filter by display names.

      

    
      - *(string) --* 

      
  
    :type programManagementAccountIdentifiers: list
    :param programManagementAccountIdentifiers: 

      Filter by program management account identifiers.

      

    
      - *(string) --* 

      
  
    :type sort: dict
    :param sort: 

      Sorting options for the results.

      

    
      - **sortOrder** *(string) --* **[REQUIRED]** 

        The sort order (ascending or descending).

        

      
      - **sortBy** *(string) --* **[REQUIRED]** 

        The field to sort by.

        

      
    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'items': [
                {
                    'arn': 'string',
                    'id': 'string',
                    'revision': 'string',
                    'catalog': 'string',
                    'associationType': 'DOWNSTREAM_SELLER'|'END_CUSTOMER'|'INTERNAL',
                    'programManagementAccountId': 'string',
                    'associatedAccountId': 'string',
                    'displayName': 'string',
                    'sector': 'COMMERCIAL'|'GOVERNMENT'|'GOVERNMENT_EXCEPTION',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1),
                    'startDate': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          List of relationships matching the criteria.

          
          

          - *(dict) --* 

            Summary information about a partner relationship.

            
            

            - **arn** *(string) --* 

              The Amazon Resource Name (ARN) of the relationship.

              
            

            - **id** *(string) --* 

              The unique identifier of the relationship.

              
            

            - **revision** *(string) --* 

              The current revision number of the relationship.

              
            

            - **catalog** *(string) --* 

              The catalog identifier associated with the relationship.

              
            

            - **associationType** *(string) --* 

              The type of association for the relationship.

              
            

            - **programManagementAccountId** *(string) --* 

              The identifier of the program management account.

              
            

            - **associatedAccountId** *(string) --* 

              The AWS account ID associated in this relationship.

              
            

            - **displayName** *(string) --* 

              The display name of the relationship.

              
            

            - **sector** *(string) --* 

              The business sector for the relationship.

              
            

            - **createdAt** *(datetime) --* 

              The timestamp when the relationship was created.

              
            

            - **updatedAt** *(datetime) --* 

              The timestamp when the relationship was last updated.

              
            

            - **startDate** *(datetime) --* 

              The start date of the relationship.

              
        
      
        

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

          A token to resume pagination.

          
    