Skip to content

GetPackageVersionReadmeResult

Source code in docs_src/capo_codeartifact/types/get_package_version_readme_result.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class GetPackageVersionReadmeResult(TypedDict, closed=True):
    format: NotRequired["capo_codeartifact.types.package_format.PackageFormat"]
    """<p> The format of the package with the requested readme file. </p>"""
    namespace: NotRequired["capo_codeartifact.types.package_namespace.PackageNamespace"]
    """<p>The namespace of the package version with the requested readme file. 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: NotRequired["capo_codeartifact.types.package_name.PackageName"]
    """<p> The name of the package that contains the returned readme file. </p>"""
    version: NotRequired["capo_codeartifact.types.package_version.PackageVersion"]
    """<p> The version of the package with the requested readme file. </p>"""
    version_revision: NotRequired[
        "capo_codeartifact.types.package_version_revision.PackageVersionRevision"
    ]
    """<p> The current revision associated with the package version. </p>"""
    readme: NotRequired["capo_codeartifact.types.string.String"]
    """<p> The text of the returned readme file. </p>"""

format instance-attribute 

format: NotRequired[PackageFormat]

The format of the package with the requested readme file.

namespace instance-attribute 

namespace: NotRequired[PackageNamespace]

The namespace of the package version with the requested readme file. 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.

package instance-attribute 

package: NotRequired[PackageName]

The name of the package that contains the returned readme file.

readme instance-attribute 

readme: NotRequired[String]

The text of the returned readme file.

version instance-attribute 

version: NotRequired[PackageVersion]

The version of the package with the requested readme file.

version_revision instance-attribute 

version_revision: NotRequired[PackageVersionRevision]

The current revision associated with the package version.