GetPackageVersionReadmeRequest
import type { GetPackageVersionReadmeRequest } from "https://aws-api.deno.dev/v0.4/services/codeartifact.ts?docs=full";interface GetPackageVersionReadmeRequest {
domain: string;
domainOwner?: string | null;
format: PackageFormat;
namespace?: string | null;
package: string;
packageVersion: string;
repository: string;
}§Properties
§
domain: string
[src]The name of the domain that contains the repository that contains the package version with the requested readme file.
§
domainOwner?: string | null
[src]The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
§
format: PackageFormat
[src]A format that specifies the type of the package version with the requested readme file.
Note:
Although maven is listed as a valid value, CodeArtifact does not support displaying readme files for Maven packages.
§
namespace?: string | null
[src]The namespace of the package version with the requested readme file. The package version 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 package version is its
scope. - Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.