:doc:`CodeArtifact <../../codeartifact>` / Paginator / ListAssociatedPackages

**********************
ListAssociatedPackages
**********************



.. py:class:: CodeArtifact.Paginator.ListAssociatedPackages

  ::

    
    paginator = client.get_paginator('list_associated_packages')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CodeArtifact.Client.list_associated_packages`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/ListAssociatedPackages>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          domain='string',
          domainOwner='string',
          packageGroup='string',
          preview=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type domain: string
    :param domain: **[REQUIRED]** 

      The name of the domain that contains the package group from which to list associated packages.

      

    
    :type domainOwner: string
    :param domainOwner: 

      The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

      

    
    :type packageGroup: string
    :param packageGroup: **[REQUIRED]** 

      The pattern of the package group from which to list associated packages.

      

    
    :type preview: boolean
    :param preview: 

      When this flag is included, ``ListAssociatedPackages`` will return a list of packages that would be associated with a package group, even if it does not exist.

      

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

      
      ::

        {
            'packages': [
                {
                    'format': 'npm'|'pypi'|'maven'|'nuget'|'generic'|'ruby'|'swift'|'cargo',
                    'namespace': 'string',
                    'package': 'string',
                    'associationType': 'STRONG'|'WEAK'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **packages** *(list) --* 

          The list of packages associated with the requested package group.

          
          

          - *(dict) --* 

            A package associated with a package group.

            
            

            - **format** *(string) --* 

              A format that specifies the type of the associated package.

              
            

            - **namespace** *(string) --* 

              The namespace of the associated package. The package component that specifies its namespace depends on its type. For example:

               

              
              * The namespace of a Maven package version is its ``groupId``.
               
              * The namespace of an npm or Swift package version is its ``scope``.
               
              * The namespace of a generic package is its ``namespace``.
               
              * Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
              

              
            

            - **package** *(string) --* 

              The name of the associated package.

              
            

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

              Describes the strength of the association between the package and package group. A strong match can be thought of as an exact match, and a weak match can be thought of as a variation match, for example, the package name matches a variation of the package group pattern. For more information about package group pattern matching, including strong and weak matches, see `Package group definition syntax and matching behavior <https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html>`__ in the *CodeArtifact User Guide*.

              
        
      
        

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

          A token to resume pagination.

          
    