package_version_readmes

Creates, updates, deletes, gets or lists a package_version_readmes resource.

Overview

Name	package_version_readmes
Type	Resource
Id	aws.codeartifact.package_version_readmes

Fields

The following fields are returned by SELECT queries:

get_package_version_readme

Name	Datatype	Description
format_	string	The format of the package with the requested readme file. (npm, pypi, maven, nuget, generic, ruby, swift, cargo)
namespace	string	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 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. (pattern: <code>[^#/\s]+</code>)
package	string	The name of the package that contains the returned readme file. (pattern: <code>[^#/\s]+</code>)
readme	string	The text of the returned readme file.
version	string	The version of the package with the requested readme file. (pattern: <code>[^#/\s]+</code>)
version_revision	string	The current revision associated with the package version. (pattern: <code>\S+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_package_version_readme	select	domain, repository, format, package, version, region	domain-owner, namespace	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain	string	The name of the domain that contains the repository that contains the package version with the requested readme file.
format	string	A format that specifies the type of the package version with the requested readme file.
package	string	The name of the package version that contains the requested readme file.
region	string	AWS region (default: us-east-1)
repository	string	The repository that contains the package with the requested readme file.
version	string	A string that contains the package version (for example, 3.5.2).
domain-owner	string	The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
namespace	string	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.

SELECT examples

get_package_version_readme

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.

SELECT
format_,
namespace,
package,
readme,
version,
version_revision
FROM aws.codeartifact.package_version_readmes
WHERE domain = '{{ domain }}' -- required
AND repository = '{{ repository }}' -- required
AND format = '{{ format }}' -- required
AND package = '{{ package }}' -- required
AND version = '{{ version }}' -- required
AND region = '{{ region }}' -- required
AND `domain-owner` = '{{ domain-owner }}'
AND namespace = '{{ namespace }}'
;