aws_sdk_codeartifact/client/

describe_package.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribePackage`](crate::operation::describe_package::builders::DescribePackageFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain(impl Into<String>)`](crate::operation::describe_package::builders::DescribePackageFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::describe_package::builders::DescribePackageFluentBuilder::set_domain):<br>required: **true**<br><p>The name of the domain that contains the repository that contains the package.</p><br>
    ///   - [`domain_owner(impl Into<String>)`](crate::operation::describe_package::builders::DescribePackageFluentBuilder::domain_owner) / [`set_domain_owner(Option<String>)`](crate::operation::describe_package::builders::DescribePackageFluentBuilder::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>
    ///   - [`repository(impl Into<String>)`](crate::operation::describe_package::builders::DescribePackageFluentBuilder::repository) / [`set_repository(Option<String>)`](crate::operation::describe_package::builders::DescribePackageFluentBuilder::set_repository):<br>required: **true**<br><p>The name of the repository that contains the requested package.</p><br>
    ///   - [`format(PackageFormat)`](crate::operation::describe_package::builders::DescribePackageFluentBuilder::format) / [`set_format(Option<PackageFormat>)`](crate::operation::describe_package::builders::DescribePackageFluentBuilder::set_format):<br>required: **true**<br><p>A format that specifies the type of the requested package.</p><br>
    ///   - [`namespace(impl Into<String>)`](crate::operation::describe_package::builders::DescribePackageFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::describe_package::builders::DescribePackageFluentBuilder::set_namespace):<br>required: **false**<br><p>The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:</p><note>  <p>The namespace is required when requesting 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>
    ///   - [`package(impl Into<String>)`](crate::operation::describe_package::builders::DescribePackageFluentBuilder::package) / [`set_package(Option<String>)`](crate::operation::describe_package::builders::DescribePackageFluentBuilder::set_package):<br>required: **true**<br><p>The name of the requested package.</p><br>
    /// - On success, responds with [`DescribePackageOutput`](crate::operation::describe_package::DescribePackageOutput) with field(s):
    ///   - [`package(Option<PackageDescription>)`](crate::operation::describe_package::DescribePackageOutput::package): <p>A <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html">PackageDescription</a> object that contains information about the requested package.</p>
    /// - On failure, responds with [`SdkError<DescribePackageError>`](crate::operation::describe_package::DescribePackageError)
    pub fn describe_package(&self) -> crate::operation::describe_package::builders::DescribePackageFluentBuilder {
        crate::operation::describe_package::builders::DescribePackageFluentBuilder::new(self.handle.clone())
    }
}