Skip to content

PackageVersionDescription

Source code in docs_src/capo_codeartifact/types/package_version_description.py
class PackageVersionDescription(TypedDict, closed=True):
    format: NotRequired["capo_codeartifact.types.package_format.PackageFormat"]
    """<p> The format of the package version. </p>"""
    namespace: NotRequired["capo_codeartifact.types.package_namespace.PackageNamespace"]
    """<p>The namespace of the package version. 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>"""
    package_name: NotRequired["capo_codeartifact.types.package_name.PackageName"]
    """<p> The name of the requested package. </p>"""
    display_name: NotRequired["capo_codeartifact.types.string255.String255"]
    """<p> The name of the package that is displayed. The <code>displayName</code> varies depending on the package version's format. For example, if an npm package is named <code>ui</code>, is in the namespace <code>vue</code>, and has the format <code>npm</code>, then the <code>displayName</code> is <code>@vue/ui</code>. </p>"""
    version: NotRequired["capo_codeartifact.types.package_version.PackageVersion"]
    """<p> The version of the package. </p>"""
    summary: NotRequired["capo_codeartifact.types.string.String"]
    """<p> A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format. </p>"""
    home_page: NotRequired["capo_codeartifact.types.string.String"]
    """<p> The homepage associated with the package. </p>"""
    source_code_repository: NotRequired["capo_codeartifact.types.string.String"]
    """<p> The repository for the source code in the package version, or the source code used to build it. </p>"""
    published_time: NotRequired["capo_codeartifact.types.timestamp.Timestamp"]
    """<p> A timestamp that contains the date and time the package version was published. </p>"""
    licenses: NotRequired["capo_codeartifact.types.license_info_list.LicenseInfoList"]
    """<p> Information about licenses associated with the package version. </p>"""
    revision: NotRequired[
        "capo_codeartifact.types.package_version_revision.PackageVersionRevision"
    ]
    """<p> The revision of the package version. </p>"""
    status: NotRequired[
        "capo_codeartifact.types.package_version_status.PackageVersionStatus"
    ]
    """<p> A string that contains the status of the package version. </p>"""
    origin: NotRequired[
        "capo_codeartifact.types.package_version_origin.PackageVersionOrigin"
    ]
    """<p>A <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionOrigin.html">PackageVersionOrigin</a> object that contains information about how the package version was added to the repository.</p>"""

display_name instance-attribute

display_name: NotRequired[String255]

The name of the package that is displayed. The displayName varies depending on the package version's format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

format instance-attribute

format: NotRequired[PackageFormat]

The format of the package version.

home_page instance-attribute

home_page: NotRequired[String]

The homepage associated with the package.

licenses instance-attribute

licenses: NotRequired[LicenseInfoList]

Information about licenses associated with the package version.

namespace instance-attribute

namespace: NotRequired[PackageNamespace]

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

origin: NotRequired[PackageVersionOrigin]

A PackageVersionOrigin object that contains information about how the package version was added to the repository.

package_name instance-attribute

package_name: NotRequired[PackageName]

The name of the requested package.

published_time instance-attribute

published_time: NotRequired[Timestamp]

A timestamp that contains the date and time the package version was published.

revision instance-attribute

revision: NotRequired[PackageVersionRevision]

The revision of the package version.

source_code_repository instance-attribute

source_code_repository: NotRequired[String]

The repository for the source code in the package version, or the source code used to build it.

status instance-attribute

status: NotRequired[PackageVersionStatus]

A string that contains the status of the package version.

summary instance-attribute

summary: NotRequired[String]

A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.

version instance-attribute

version: NotRequired[PackageVersion]

The version of the package.