aws_sdk_codeartifact/client/get_associated_package_group.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 [`GetAssociatedPackageGroup`](crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`domain(impl Into<String>)`](crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder::set_domain):<br>required: **true**<br><p>The name of the domain that contains the package from which to get the associated package group.</p><br>
7 /// - [`domain_owner(impl Into<String>)`](crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder::domain_owner) / [`set_domain_owner(Option<String>)`](crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder::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 /// - [`format(PackageFormat)`](crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder::format) / [`set_format(Option<PackageFormat>)`](crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder::set_format):<br>required: **true**<br><p>The format of the package from which to get the associated package group.</p><br>
9 /// - [`namespace(impl Into<String>)`](crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder::set_namespace):<br>required: **false**<br><p>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:</p><note> <p>The namespace is required when getting associated package groups from packages of the following formats:</p> <ul> <li> <p>Maven</p></li> <li> <p>Swift</p></li> <li> <p>generic</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 or Swift package version is its <code>scope</code>.</p></li> <li> <p>The namespace of a generic package is its <code>namespace</code>.</p></li> <li> <p>Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.</p></li> </ul><br>
10 /// - [`package(impl Into<String>)`](crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder::package) / [`set_package(Option<String>)`](crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder::set_package):<br>required: **true**<br><p>The package from which to get the associated package group.</p><br>
11 /// - On success, responds with [`GetAssociatedPackageGroupOutput`](crate::operation::get_associated_package_group::GetAssociatedPackageGroupOutput) with field(s):
12 /// - [`package_group(Option<PackageGroupDescription>)`](crate::operation::get_associated_package_group::GetAssociatedPackageGroupOutput::package_group): <p>The package group that is associated with the requested package.</p>
13 /// - [`association_type(Option<PackageGroupAssociationType>)`](crate::operation::get_associated_package_group::GetAssociatedPackageGroupOutput::association_type): <p>Describes the strength of the association between the package and package group. A strong match is also known as an exact match, and a weak match is known as a relative match.</p>
14 /// - On failure, responds with [`SdkError<GetAssociatedPackageGroupError>`](crate::operation::get_associated_package_group::GetAssociatedPackageGroupError)
15 pub fn get_associated_package_group(&self) -> crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder {
16 crate::operation::get_associated_package_group::builders::GetAssociatedPackageGroupFluentBuilder::new(self.handle.clone())
17 }
18}