Skip to content

Returns a PackageVersionDescription object that contains information about the requested package version

Description

Returns a PackageVersionDescription object that contains information about the requested package version.

Usage

codeartifact_describe_package_version(domain, domainOwner, repository,
  format, namespace, package, packageVersion)

Arguments

  • domain

    [required] The name of the domain that contains the repository that contains the package version.

  • domainOwner

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

  • repository

    [required] The name of the repository that contains the package version.

  • format

    [required] A format that specifies the type of the requested package version.

  • namespace

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

    The namespace is required when requesting 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.
  • package

    [required] The name of the requested package version.

  • packageVersion

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

Value

A list with the following syntax:

list(
  packageVersion = list(
    format = "npm"|"pypi"|"maven"|"nuget"|"generic"|"ruby"|"swift"|"cargo",
    namespace = "string",
    packageName = "string",
    displayName = "string",
    version = "string",
    summary = "string",
    homePage = "string",
    sourceCodeRepository = "string",
    publishedTime = as.POSIXct(
      "2015-01-01"
    ),
    licenses = list(
      list(
        name = "string",
        url = "string"
      )
    ),
    revision = "string",
    status = "Published"|"Unfinished"|"Unlisted"|"Archived"|"Disposed"|"Deleted",
    origin = list(
      domainEntryPoint = list(
        repositoryName = "string",
        externalConnectionName = "string"
      ),
      originType = "INTERNAL"|"EXTERNAL"|"UNKNOWN"
    )
  )
)

Request syntax

svc$describe_package_version(
  domain = "string",
  domainOwner = "string",
  repository = "string",
  format = "npm"|"pypi"|"maven"|"nuget"|"generic"|"ruby"|"swift"|"cargo",
  namespace = "string",
  package = "string",
  packageVersion = "string"
)