Skip to content

PackageDescription

Source code in docs_src/capo_codeartifact/types/package_description.py
class PackageDescription(TypedDict, closed=True):
    format: NotRequired["capo_codeartifact.types.package_format.PackageFormat"]
    """<p>A format that specifies the type of the package.</p>"""
    namespace: NotRequired["capo_codeartifact.types.package_namespace.PackageNamespace"]
    """<p>The namespace of the package. The package component that specifies its namespace depends on its type. For example:</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>"""
    name: NotRequired["capo_codeartifact.types.package_name.PackageName"]
    """<p>The name of the package.</p>"""
    origin_configuration: NotRequired[
        "capo_codeartifact.types.package_origin_configuration.PackageOriginConfiguration"
    ]
    """<p>The package origin configuration for the package.</p>"""

format instance-attribute

format: NotRequired[PackageFormat]

A format that specifies the type of the package.

name instance-attribute

name: NotRequired[PackageName]

The name of the package.

namespace instance-attribute

namespace: NotRequired[PackageNamespace]

The namespace of the package. 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.

origin_configuration instance-attribute

origin_configuration: NotRequired[PackageOriginConfiguration]

The package origin configuration for the package.