/v1/package/version/readme#domain&repository&format&package&version
http://codeartifact.{region}.amazonaws.com/v1/package/version/readme#domain&repository&format&package&version<p> Gets the readme file or descriptive text for a package version. </p> <p> The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText. </p>
Query Params
The name of the domain that contains the repository that contains the package version with the requested readme file.
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
The repository that contains the package with the requested readme file.
A format that specifies the type of the package version with the requested readme file.
<p>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:</p> <ul> <li> <p> The namespace of an npm package version is its <code>scope</code>. </p> </li> <li> <p> Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace. </p> </li> </ul>
The name of the package version that contains the requested readme file.
A string that contains the package version (for example, <code>3.5.2</code>).
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}1curl --request GET \2 --url 'http://codeartifact.{region}.amazonaws.com/v1/package/version/readme#domain&repository&format&package&version' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}