listPackageVersionDependencies method

Future<ListPackageVersionDependenciesResult> listPackageVersionDependencies({ required String domain, required PackageFormat format, required String package, required String packageVersion, required String repository, String? domainOwner, String? namespace, String? nextToken, })

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.

May throw AccessDeniedException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

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

Parameter format : The format of the package with the requested dependencies.

Parameter package : The name of the package versions' package.

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

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

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

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

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

Parameter nextToken : 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.

Implementation

Future<ListPackageVersionDependenciesResult> listPackageVersionDependencies({
  required String domain,
  required PackageFormat format,
  required String package,
  required String packageVersion,
  required String repository,
  String? domainOwner,
  String? namespace,
  String? nextToken,
}) async {
  final $query = <String, List<String>>{
    'domain': [domain],
    'format': [format.value],
    'package': [package],
    'version': [packageVersion],
    'repository': [repository],
    if (domainOwner != null) 'domain-owner': [domainOwner],
    if (namespace != null) 'namespace': [namespace],
    if (nextToken != null) 'next-token': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'POST',
    requestUri: '/v1/package/version/dependencies',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListPackageVersionDependenciesResult.fromJson(response);
}