Returns a PackageDescription object that contains information about the requested package¶

Description¶

Returns a PackageDescription object that contains information about the requested package.

Usage¶

codeartifact_describe_package(domain, domainOwner, repository, format,
  namespace, package)

Arguments¶

• domain

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

• 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 requested package.

• format

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

• namespace

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

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

Value¶

A list with the following syntax:

list(
  package = list(
    format = "npm"|"pypi"|"maven"|"nuget"|"generic"|"ruby"|"swift"|"cargo",
    namespace = "string",
    name = "string",
    originConfiguration = list(
      restrictions = list(
        publish = "ALLOW"|"BLOCK",
        upstream = "ALLOW"|"BLOCK"
      )
    )
  )
)

Request syntax¶

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