CodeArtifact / Paginator / ListPackageVersionAssets

ListPackageVersionAssets

class CodeArtifact.Paginator.ListPackageVersionAssets

paginator = client.get_paginator('list_package_version_assets')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domain='string',
    domainOwner='string',
    repository='string',
    format='npm'|'pypi'|'maven'|'nuget'|'generic'|'ruby'|'swift'|'cargo',
    namespace='string',
    package='string',
    packageVersion='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domain (string) –

  [REQUIRED]

  The name of the domain that contains the repository associated with the package version assets.

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

• repository (string) –

  [REQUIRED]

  The name of the repository that contains the package that contains the requested package version assets.

• format (string) –

  [REQUIRED]

  The format of the package that contains the requested package version assets.

• namespace (string) –

  The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:

  Note

  The namespace is required requesting assets from package versions of the following formats:

  • Maven

  • Swift

  • generic

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

  [REQUIRED]

  The name of the package that contains the requested package version assets.

• packageVersion (string) –

  [REQUIRED]

  A string that contains the package version (for example, 3.5.2).

• 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

{
    'format': 'npm'|'pypi'|'maven'|'nuget'|'generic'|'ruby'|'swift'|'cargo',
    'namespace': 'string',
    'package': 'string',
    'version': 'string',
    'versionRevision': 'string',
    'assets': [
        {
            'name': 'string',
            'size': 123,
            'hashes': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • format (string) –

    The format of the package that contains the requested package version assets.

  • namespace (string) –

    The namespace of the package version that contains the requested package version assets. 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 package that contains the requested package version assets.

  • version (string) –

    The version of the package associated with the requested assets.

  • versionRevision (string) –

    The current revision associated with the package version.

  • assets (list) –

    The returned list of AssetSummary objects.

    • (dict) –

      Contains details about a package version asset.

      • name (string) –

        The name of the asset.

      • size (integer) –

        The size of the asset.

      • hashes (dict) –

        The hashes of the asset.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.