aws_sdk_codeartifact/client/list_package_version_dependencies.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ListPackageVersionDependencies`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`domain(impl Into<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::set_domain):<br>required: **true**<br><p>The name of the domain that contains the repository that contains the requested package version dependencies.</p><br>
7 /// - [`domain_owner(impl Into<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::domain_owner) / [`set_domain_owner(Option<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::set_domain_owner):<br>required: **false**<br><p>The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.</p><br>
8 /// - [`repository(impl Into<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::repository) / [`set_repository(Option<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::set_repository):<br>required: **true**<br><p>The name of the repository that contains the requested package version.</p><br>
9 /// - [`format(PackageFormat)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::format) / [`set_format(Option<PackageFormat>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::set_format):<br>required: **true**<br><p>The format of the package with the requested dependencies.</p><br>
10 /// - [`namespace(impl Into<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::set_namespace):<br>required: **false**<br><p>The namespace of the package version with the requested dependencies. The package component that specifies its namespace depends on its type. For example:</p><note> <p>The namespace is required when listing dependencies from package versions of the following formats:</p> <ul> <li> <p>Maven</p></li> </ul> </note> <ul> <li> <p>The namespace of a Maven package version is its <code>groupId</code>.</p></li> <li> <p>The namespace of an npm package version is its <code>scope</code>.</p></li> <li> <p>Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.</p></li> </ul><br>
11 /// - [`package(impl Into<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::package) / [`set_package(Option<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::set_package):<br>required: **true**<br><p>The name of the package versions' package.</p><br>
12 /// - [`package_version(impl Into<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::package_version) / [`set_package_version(Option<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::set_package_version):<br>required: **true**<br><p>A string that contains the package version (for example, <code>3.5.2</code>).</p><br>
13 /// - [`next_token(impl Into<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::set_next_token):<br>required: **false**<br><p>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.</p><br>
14 /// - On success, responds with [`ListPackageVersionDependenciesOutput`](crate::operation::list_package_version_dependencies::ListPackageVersionDependenciesOutput) with field(s):
15 /// - [`format(Option<PackageFormat>)`](crate::operation::list_package_version_dependencies::ListPackageVersionDependenciesOutput::format): <p>A format that specifies the type of the package that contains the returned dependencies.</p>
16 /// - [`namespace(Option<String>)`](crate::operation::list_package_version_dependencies::ListPackageVersionDependenciesOutput::namespace): <p>The namespace of the package version that contains the returned dependencies. The package component that specifies its namespace depends on its type. For example:</p><note> <p>The namespace is required when listing dependencies from package versions of the following formats:</p> <ul> <li> <p>Maven</p></li> </ul> </note> <ul> <li> <p>The namespace of a Maven package version is its <code>groupId</code>.</p></li> <li> <p>The namespace of an npm package version is its <code>scope</code>.</p></li> <li> <p>Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.</p></li> </ul>
17 /// - [`package(Option<String>)`](crate::operation::list_package_version_dependencies::ListPackageVersionDependenciesOutput::package): <p>The name of the package that contains the returned package versions dependencies.</p>
18 /// - [`version(Option<String>)`](crate::operation::list_package_version_dependencies::ListPackageVersionDependenciesOutput::version): <p>The version of the package that is specified in the request.</p>
19 /// - [`version_revision(Option<String>)`](crate::operation::list_package_version_dependencies::ListPackageVersionDependenciesOutput::version_revision): <p>The current revision associated with the package version.</p>
20 /// - [`next_token(Option<String>)`](crate::operation::list_package_version_dependencies::ListPackageVersionDependenciesOutput::next_token): <p>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.</p>
21 /// - [`dependencies(Option<Vec::<PackageDependency>>)`](crate::operation::list_package_version_dependencies::ListPackageVersionDependenciesOutput::dependencies): <p>The returned list of <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html">PackageDependency</a> objects.</p>
22 /// - On failure, responds with [`SdkError<ListPackageVersionDependenciesError>`](crate::operation::list_package_version_dependencies::ListPackageVersionDependenciesError)
23 pub fn list_package_version_dependencies(
24 &self,
25 ) -> crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder {
26 crate::operation::list_package_version_dependencies::builders::ListPackageVersionDependenciesFluentBuilder::new(self.handle.clone())
27 }
28}