Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . codeartifact ]

get-package-version-readme

Description

Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact extracts a description from a metadata file. For example, from the description element in the pom.xml file of a Maven package.

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-package-version-readme
--domain <value>
[--domain-owner <value>]
--repository <value>
--format <value>
[--namespace <value>]
--package <value>
--package-version <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--domain (string)

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

--domain-owner (string)

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

--repository (string)

The repository that contains the package with the requested readme file.

--format (string)

A format that specifies the type of the package version with the requested readme file. The valid values are:

  • npm
  • pypi
  • maven

Possible values:

  • npm
  • pypi
  • maven

--namespace (string)

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

  • The namespace of a Maven package is its groupId .
  • The namespace of an npm package is its scope .
  • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

--package (string)

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

--package-version (string)

A string that contains the package version (for example, 3.5.2 ).

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

format -> (string)

The format of the package with the requested readme file. Valid format types are:

  • npm
  • pypi
  • maven

namespace -> (string)

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

  • The namespace of a Maven package is its groupId .
  • The namespace of an npm package is its scope .
  • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

package -> (string)

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

version -> (string)

The version of the package with the requested readme file.

versionRevision -> (string)

The current revision associated with the package version.

readme -> (string)

The text of the returned readme file.