aws_sdk_codeartifact/client/
describe_package_version.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 [`DescribePackageVersion`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain(impl Into<String>)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::set_domain):<br>required: **true**<br><p>The name of the domain that contains the repository that contains the package version.</p><br>
7    ///   - [`domain_owner(impl Into<String>)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::domain_owner) / [`set_domain_owner(Option<String>)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::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::describe_package_version::builders::DescribePackageVersionFluentBuilder::repository) / [`set_repository(Option<String>)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::set_repository):<br>required: **true**<br><p>The name of the repository that contains the package version.</p><br>
9    ///   - [`format(PackageFormat)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::format) / [`set_format(Option<PackageFormat>)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::set_format):<br>required: **true**<br><p>A format that specifies the type of the requested package version.</p><br>
10    ///   - [`namespace(impl Into<String>)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::set_namespace):<br>required: **false**<br><p>The namespace of the requested package version. The package component that specifies its namespace depends on its type. For example:</p><note>  <p>The namespace is required when requesting package versions 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>
11    ///   - [`package(impl Into<String>)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::package) / [`set_package(Option<String>)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::set_package):<br>required: **true**<br><p>The name of the requested package version.</p><br>
12    ///   - [`package_version(impl Into<String>)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::package_version) / [`set_package_version(Option<String>)`](crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::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    /// - On success, responds with [`DescribePackageVersionOutput`](crate::operation::describe_package_version::DescribePackageVersionOutput) with field(s):
14    ///   - [`package_version(Option<PackageVersionDescription>)`](crate::operation::describe_package_version::DescribePackageVersionOutput::package_version): <p>A <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html">PackageVersionDescription</a> object that contains information about the requested package version.</p>
15    /// - On failure, responds with [`SdkError<DescribePackageVersionError>`](crate::operation::describe_package_version::DescribePackageVersionError)
16    pub fn describe_package_version(&self) -> crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder {
17        crate::operation::describe_package_version::builders::DescribePackageVersionFluentBuilder::new(self.handle.clone())
18    }
19}