CodeArtifact / Paginator / ListAssociatedPackages

ListAssociatedPackages#

class CodeArtifact.Paginator.ListAssociatedPackages#
paginator = client.get_paginator('list_associated_packages')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from CodeArtifact.Client.list_associated_packages().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domain='string',
    domainOwner='string',
    packageGroup='string',
    preview=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • domain (string) –

    [REQUIRED]

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

  • domainOwner (string) – The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • packageGroup (string) –

    [REQUIRED]

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

  • preview (boolean) – 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.

  • 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

{
    'packages': [
        {
            'format': 'npm'|'pypi'|'maven'|'nuget'|'generic'|'swift',
            '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 and NuGet 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 in the CodeArtifact User Guide.

    • NextToken (string) –

      A token to resume pagination.