list_packages

list_packages(**kwargs)

Returns a list of PackageSummary objects for packages in a repository that match the request parameters.

See also: AWS API Documentation

Request Syntax

response = client.list_packages(
    domain='string',
    domainOwner='string',
    repository='string',
    format='npm'|'pypi'|'maven'|'nuget',
    namespace='string',
    packagePrefix='string',
    maxResults=123,
    nextToken='string',
    publish='ALLOW'|'BLOCK',
    upstream='ALLOW'|'BLOCK'
)

Parameters

• domain (string) --

  [REQUIRED]

  The name of the domain that contains the repository that contains the requested 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.
• repository (string) --

  [REQUIRED]

  The name of the repository that contains the requested packages.

• format (string) -- The format used to filter requested packages. Only packages from the provided format will be returned.
• namespace (string) --

  The namespace used to filter requested packages. Only packages with the provided namespace will be returned. The package component that specifies its namespace depends on its type. For example:

  • The namespace of a Maven package is its groupId .
  • The namespace of an npm package is its scope .
  • Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
• packagePrefix (string) -- A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.
• maxResults (integer) -- The maximum number of results to return per page.
• nextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
• publish (string) -- The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
• upstream (string) -- The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

Return type

dict

Returns

Response Syntax

{
    'packages': [
        {
            'format': 'npm'|'pypi'|'maven'|'nuget',
            'namespace': 'string',
            'package': 'string',
            'originConfiguration': {
                'restrictions': {
                    'publish': 'ALLOW'|'BLOCK',
                    'upstream': 'ALLOW'|'BLOCK'
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • packages (list) --

    The list of returned PackageSummary objects.

    • (dict) --

      Details about a package, including its format, namespace, and name.

      • format (string) --

        The format of the package.

      • namespace (string) --

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

        • The namespace of a Maven package is its groupId .
        • The namespace of an npm package is its scope .
        • Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

      • package (string) --

        The name of the package.

      • originConfiguration (dict) --

        A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.

        • restrictions (dict) --

          A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.

          • publish (string) --

            The package origin configuration that determines if new versions of the package can be published directly to the repository.

          • upstream (string) --

            The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.

  • nextToken (string) --

    If there are additional results, this is the token for the next set of results.

Exceptions

• CodeArtifact.Client.exceptions.AccessDeniedException
• CodeArtifact.Client.exceptions.InternalServerException
• CodeArtifact.Client.exceptions.ResourceNotFoundException
• CodeArtifact.Client.exceptions.ThrottlingException
• CodeArtifact.Client.exceptions.ValidationException