CodeArtifact / Client / get_package_version_readme

get_package_version_readme#

CodeArtifact.Client.get_package_version_readme(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_package_version_readme(
    domain='string',
    domainOwner='string',
    repository='string',
    format='npm'|'pypi'|'maven'|'nuget'|'generic'|'swift',
    namespace='string',
    package='string',
    packageVersion='string'
)
Parameters:

  • domain (string) –

    [REQUIRED]

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

  • domainOwner (string) – The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • repository (string) –

    [REQUIRED]

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

  • format (string) –

    [REQUIRED]

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

  • 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:

    Note

    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 and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

  • package (string) –

    [REQUIRED]

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

  • packageVersion (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'format': 'npm'|'pypi'|'maven'|'nuget'|'generic'|'swift',
    'namespace': 'string',
    'package': 'string',
    'version': 'string',
    'versionRevision': 'string',
    'readme': 'string'
}

Response Structure

  • (dict) –

    • format (string) –

      The format of the package with the requested readme file.

    • 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 and NuGet package versions do not contain a corresponding component, package versions of those formats 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.

Exceptions

  • CodeArtifact.Client.exceptions.AccessDeniedException

  • CodeArtifact.Client.exceptions.InternalServerException

  • CodeArtifact.Client.exceptions.ResourceNotFoundException

  • CodeArtifact.Client.exceptions.ThrottlingException

  • CodeArtifact.Client.exceptions.ValidationException