Skip to content

/AWS1/IF_ART=>LISTPACKAGEVRSDEPENDENCIES()

About ListPackageVersionDependencies

Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the package.json file for npm packages and the pom.xml file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.

Method Signature

METHODS /AWS1/IF_ART~LISTPACKAGEVRSDEPENDENCIES
  IMPORTING
    !IV_DOMAIN TYPE /AWS1/ARTDOMAINNAME OPTIONAL
    !IV_DOMAINOWNER TYPE /AWS1/ARTACCOUNTID OPTIONAL
    !IV_REPOSITORY TYPE /AWS1/ARTREPOSITORYNAME OPTIONAL
    !IV_FORMAT TYPE /AWS1/ARTPACKAGEFORMAT OPTIONAL
    !IV_NAMESPACE TYPE /AWS1/ARTPACKAGENAMESPACE OPTIONAL
    !IV_PACKAGE TYPE /AWS1/ARTPACKAGENAME OPTIONAL
    !IV_PACKAGEVERSION TYPE /AWS1/ARTPACKAGEVERSION OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ARTPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_artlstpackagevrsdep01
  RAISING
    /AWS1/CX_ARTACCESSDENIEDEX
    /AWS1/CX_ARTINTERNALSERVEREX
    /AWS1/CX_ARTRESOURCENOTFOUNDEX
    /AWS1/CX_ARTTHROTTLINGEX
    /AWS1/CX_ARTVALIDATIONEX
    /AWS1/CX_ARTCLIENTEXC
    /AWS1/CX_ARTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domain TYPE /AWS1/ARTDOMAINNAME /AWS1/ARTDOMAINNAME

The name of the domain that contains the repository that contains the requested package version dependencies.

iv_repository TYPE /AWS1/ARTREPOSITORYNAME /AWS1/ARTREPOSITORYNAME

The name of the repository that contains the requested package version.

iv_format TYPE /AWS1/ARTPACKAGEFORMAT /AWS1/ARTPACKAGEFORMAT

The format of the package with the requested dependencies.

iv_package TYPE /AWS1/ARTPACKAGENAME /AWS1/ARTPACKAGENAME

The name of the package versions' package.

iv_packageversion TYPE /AWS1/ARTPACKAGEVERSION /AWS1/ARTPACKAGEVERSION

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

Optional arguments:

iv_domainowner TYPE /AWS1/ARTACCOUNTID /AWS1/ARTACCOUNTID

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

iv_namespace TYPE /AWS1/ARTPACKAGENAMESPACE /AWS1/ARTPACKAGENAMESPACE

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

The namespace is required when listing dependencies from package versions of the following formats:

  • Maven

  • The namespace of a Maven package version is its groupId.

  • The namespace of an npm package version is its scope.

  • Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

iv_nexttoken TYPE /AWS1/ARTPAGINATIONTOKEN /AWS1/ARTPAGINATIONTOKEN

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_artlstpackagevrsdep01 /AWS1/CL_ARTLSTPACKAGEVRSDEP01

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listpackagevrsdependencies(
  iv_domain = |string|
  iv_domainowner = |string|
  iv_format = |string|
  iv_namespace = |string|
  iv_nexttoken = |string|
  iv_package = |string|
  iv_packageversion = |string|
  iv_repository = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_packageformat = lo_result->get_format( ).
  lv_packagenamespace = lo_result->get_namespace( ).
  lv_packagename = lo_result->get_package( ).
  lv_packageversion = lo_result->get_version( ).
  lv_packageversionrevision = lo_result->get_versionrevision( ).
  lv_paginationtoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_dependencies( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_packagenamespace = lo_row_1->get_namespace( ).
      lv_packagename = lo_row_1->get_package( ).
      lv_string = lo_row_1->get_dependencytype( ).
      lv_string = lo_row_1->get_versionrequirement( ).
    ENDIF.
  ENDLOOP.
ENDIF.