Skip to content

ListPackagesRequest

Source code in docs_src/capo_codeartifact/types/list_packages_request.py
class ListPackagesRequest(TypedDict, closed=True):
    domain: "capo_codeartifact.types.domain_name.DomainName"
    """<p> The name of the domain that contains the repository that contains the requested packages. </p>"""
    domain_owner: NotRequired["capo_codeartifact.types.account_id.AccountId"]
    """<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>"""
    repository: "capo_codeartifact.types.repository_name.RepositoryName"
    """<p> The name of the repository that contains the requested packages. </p>"""
    format: NotRequired["capo_codeartifact.types.package_format.PackageFormat"]
    """<p>The format used to filter requested packages. Only packages from the provided format will be returned.</p>"""
    namespace: NotRequired["capo_codeartifact.types.package_namespace.PackageNamespace"]
    """<p>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 <code>--namespace</code> and not <code>--namespace-prefix</code>, it has prefix-matching behavior.</p> <p>Each package format uses namespace as follows:</p> <ul> <li> <p> The namespace of a Maven package version is its <code>groupId</code>. </p> </li> <li> <p> The namespace of an npm or Swift package version is its <code>scope</code>. </p> </li> <li> <p>The namespace of a generic package is its <code>namespace</code>.</p> </li> <li> <p> Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace. </p> </li> </ul>"""
    package_prefix: NotRequired["capo_codeartifact.types.package_name.PackageName"]
    """<p> A prefix used to filter requested packages. Only packages with names that start with <code>packagePrefix</code> are returned. </p>"""
    max_results: NotRequired[
        "capo_codeartifact.types.list_packages_max_results.ListPackagesMaxResults"
    ]
    """<p> The maximum number of results to return per page. </p>"""
    next_token: NotRequired["capo_codeartifact.types.pagination_token.PaginationToken"]
    """<p> 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. </p>"""
    publish: NotRequired["capo_codeartifact.types.allow_publish.AllowPublish"]
    """<p>The value of the <code>Publish</code> package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html">PackageOriginRestrictions</a>.</p>"""
    upstream: NotRequired["capo_codeartifact.types.allow_upstream.AllowUpstream"]
    """<p>The value of the <code>Upstream</code> package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html">PackageOriginRestrictions</a>.</p>"""

domain instance-attribute

domain: DomainName

The name of the domain that contains the repository that contains the requested packages.

domain_owner instance-attribute

domain_owner: NotRequired[AccountId]

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

format instance-attribute

format: NotRequired[PackageFormat]

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

max_results instance-attribute

max_results: NotRequired[ListPackagesMaxResults]

The maximum number of results to return per page.

namespace instance-attribute

namespace: NotRequired[PackageNamespace]

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.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

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.

package_prefix instance-attribute

package_prefix: NotRequired[PackageName]

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

publish instance-attribute

publish: NotRequired[AllowPublish]

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.

repository instance-attribute

repository: RepositoryName

The name of the repository that contains the requested packages.

upstream instance-attribute

upstream: NotRequired[AllowUpstream]

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.