Skip to content

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

Description

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

Usage

codeartifact_list_packages(domain, domainOwner, repository, format,
  namespace, packagePrefix, maxResults, nextToken, publish, upstream)

Arguments

  • domain

    [required] The name of the domain that contains the repository that contains the requested packages.

  • domainOwner

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

  • repository

    [required] The name of the repository that contains the requested packages.

  • format

    The format used to filter requested packages. Only packages from the provided format will be returned.

  • namespace

    The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.

    Each package format uses namespace as follows:

    • 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.
  • packagePrefix

    A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.

  • maxResults

    The maximum number of results to return per page.

  • nextToken

    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

    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

    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.

Value

A list with the following syntax:

list(
  packages = list(
    list(
      format = "npm"|"pypi"|"maven"|"nuget"|"generic"|"ruby"|"swift"|"cargo",
      namespace = "string",
      package = "string",
      originConfiguration = list(
        restrictions = list(
          publish = "ALLOW"|"BLOCK",
          upstream = "ALLOW"|"BLOCK"
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_packages(
  domain = "string",
  domainOwner = "string",
  repository = "string",
  format = "npm"|"pypi"|"maven"|"nuget"|"generic"|"ruby"|"swift"|"cargo",
  namespace = "string",
  packagePrefix = "string",
  maxResults = 123,
  nextToken = "string",
  publish = "ALLOW"|"BLOCK",
  upstream = "ALLOW"|"BLOCK"
)