GetPackageVersionReadme - CodeArtifact

GetPackageVersionReadme

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.

Request Syntax

GET /v1/package/version/readme?domain=domain&domain-owner=domainOwner&format=format&namespace=namespace&package=package&repository=repository&version=packageVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domain

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

Length Constraints: Minimum length of 2. Maximum length of 50.

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Required: Yes

domainOwner

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

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

format

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

  • npm

  • pypi

  • maven

Valid Values: npm | pypi | maven

Required: Yes

namespace

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.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^!#/\s]+

package

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

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^!#/\s]+

Required: Yes

packageVersion

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

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^!#/\s]+

Required: Yes

repository

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

Length Constraints: Minimum length of 2. Maximum length of 100.

Pattern: [A-Za-z0-9][A-Za-z0-9._\-]{1,99}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "format": "string", "namespace": "string", "package": "string", "readme": "string", "version": "string", "versionRevision": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

format

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

  • npm

  • pypi

  • maven

Type: String

Valid Values: npm | pypi | maven

namespace

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^!#/\s]+

package

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^!#/\s]+

readme

The text of the returned readme file.

Type: String

version

The version of the package with the requested readme file.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^!#/\s]+

versionRevision

The current revision associated with the package version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: \S+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The operation did not succeed because of an unauthorized access attempt.

HTTP Status Code: 403

InternalServerException

The operation did not succeed because of an error that occurred inside AWS CodeArtifact.

HTTP Status Code: 500

ResourceNotFoundException

The operation did not succeed because the resource requested is not found in the service.

HTTP Status Code: 404

ThrottlingException

The operation did not succeed because too many requests are sent to the service.

HTTP Status Code: 429

ValidationException

The operation did not succeed because a parameter in the request was sent with an invalid value.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: