aws_sdk_codeartifact/client/delete_package.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 [`DeletePackage`](crate::operation::delete_package::builders::DeletePackageFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`domain(impl Into<String>)`](crate::operation::delete_package::builders::DeletePackageFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::delete_package::builders::DeletePackageFluentBuilder::set_domain):<br>required: **true**<br><p>The name of the domain that contains the package to delete.</p><br>
7 /// - [`domain_owner(impl Into<String>)`](crate::operation::delete_package::builders::DeletePackageFluentBuilder::domain_owner) / [`set_domain_owner(Option<String>)`](crate::operation::delete_package::builders::DeletePackageFluentBuilder::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::delete_package::builders::DeletePackageFluentBuilder::repository) / [`set_repository(Option<String>)`](crate::operation::delete_package::builders::DeletePackageFluentBuilder::set_repository):<br>required: **true**<br><p>The name of the repository that contains the package to delete.</p><br>
9 /// - [`format(PackageFormat)`](crate::operation::delete_package::builders::DeletePackageFluentBuilder::format) / [`set_format(Option<PackageFormat>)`](crate::operation::delete_package::builders::DeletePackageFluentBuilder::set_format):<br>required: **true**<br><p>The format of the requested package to delete.</p><br>
10 /// - [`namespace(impl Into<String>)`](crate::operation::delete_package::builders::DeletePackageFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::delete_package::builders::DeletePackageFluentBuilder::set_namespace):<br>required: **false**<br><p>The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:</p><note> <p>The namespace is required when deleting 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>
11 /// - [`package(impl Into<String>)`](crate::operation::delete_package::builders::DeletePackageFluentBuilder::package) / [`set_package(Option<String>)`](crate::operation::delete_package::builders::DeletePackageFluentBuilder::set_package):<br>required: **true**<br><p>The name of the package to delete.</p><br>
12 /// - On success, responds with [`DeletePackageOutput`](crate::operation::delete_package::DeletePackageOutput) with field(s):
13 /// - [`deleted_package(Option<PackageSummary>)`](crate::operation::delete_package::DeletePackageOutput::deleted_package): <p>Details about a package, including its format, namespace, and name.</p>
14 /// - On failure, responds with [`SdkError<DeletePackageError>`](crate::operation::delete_package::DeletePackageError)
15 pub fn delete_package(&self) -> crate::operation::delete_package::builders::DeletePackageFluentBuilder {
16 crate::operation::delete_package::builders::DeletePackageFluentBuilder::new(self.handle.clone())
17 }
18}