Get Package Version Readme

codeartifact_get_package_version_readme

R Documentation

Gets the readme file or descriptive text for a package version

Description

Gets the readme file or descriptive text for a package version.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

Usage

codeartifact_get_package_version_readme(domain, domainOwner, repository,
  format, namespace, package, packageVersion)

Arguments

domain

[required] The name of the domain that contains the repository that contains the package version with the requested readme file.

domainOwner

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

repository

[required] The repository that contains the package with the requested readme file.

format

[required] A format that specifies the type of the package version with the requested readme file.

namespace

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 is required when requesting the readme from package versions of the following formats:

• Maven

• Swift

• generic

• 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

[required] The name of the package version that contains the requested readme file.

packageVersion

[required] A string that contains the package version (for example, ⁠3.5.2⁠).

Value

A list with the following syntax:

list(
  format = "npm"|"pypi"|"maven"|"nuget"|"generic"|"ruby"|"swift"|"cargo",
  namespace = "string",
  package = "string",
  version = "string",
  versionRevision = "string",
  readme = "string"
)

Request syntax

svc$get_package_version_readme(
  domain = "string",
  domainOwner = "string",
  repository = "string",
  format = "npm"|"pypi"|"maven"|"nuget"|"generic"|"ruby"|"swift"|"cargo",
  namespace = "string",
  package = "string",
  packageVersion = "string"
)