Skip to content

Get Associated Package Group

codeartifact_get_associated_package_group R Documentation

Returns the most closely associated package group to the specified package

Description

Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such, get_associated_package_group can be used to see which package group's origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them.

For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

Usage

codeartifact_get_associated_package_group(domain, domainOwner, format,
  namespace, package)

Arguments

domain

[required] The name of the domain that contains the package from which to get the associated package group.

domainOwner

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

format

[required] The format of the package from which to get the associated package group.

namespace

The namespace of the package from which to get the associated package group. The package component that specifies its namespace depends on its type. For example:

The namespace is required when getting associated package groups from 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 package from which to get the associated package group.

Value

A list with the following syntax: 

list(
  packageGroup = list(
    arn = "string",
    pattern = "string",
    domainName = "string",
    domainOwner = "string",
    createdTime = as.POSIXct(
      "2015-01-01"
    ),
    contactInfo = "string",
    description = "string",
    originConfiguration = list(
      restrictions = list(
        list(
          mode = "ALLOW"|"ALLOW_SPECIFIC_REPOSITORIES"|"BLOCK"|"INHERIT",
          effectiveMode = "ALLOW"|"ALLOW_SPECIFIC_REPOSITORIES"|"BLOCK"|"INHERIT",
          inheritedFrom = list(
            arn = "string",
            pattern = "string"
          ),
          repositoriesCount = 123
        )
      )
    ),
    parent = list(
      arn = "string",
      pattern = "string"
    )
  ),
  associationType = "STRONG"|"WEAK"
)

Request syntax

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