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.
-
domainOwnerThe 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.
-
formatThe format used to filter requested packages. Only packages from the provided format will be returned.
-
namespaceThe 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
--namespaceand 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.
- The namespace of a Maven package version is its
-
packagePrefixA prefix used to filter requested packages. Only packages with names that start with
packagePrefixare returned. -
maxResultsThe maximum number of results to return per page.
-
nextTokenThe 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.
-
publishThe value of the
Publishpackage origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions. -
upstreamThe value of the
Upstreampackage 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"
)