PackageDependency - AWS CodeArtifact

PackageDependency

Details about a package dependency.

Contents

dependencyType

The type of a package dependency. The possible values depend on the package type.

  • npm: regular, dev, peer, optional

  • maven: optional, parent, compile, runtime, test, system, provided.

    Note

    Note that parent is not a regular Maven dependency type; instead this is extracted from the <parent> element if one is defined in the package version's POM file.

  • nuget: The dependencyType field is never set for NuGet packages.

  • pypi: Requires-Dist

Type: String

Required: No

namespace

The namespace of the package that this package depends on. 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

Required: No

package

The name of the package that this package depends on.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

Required: No

versionRequirement

The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: