aws_sdk_codeartifact/client/
delete_package_versions.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 [`DeletePackageVersions`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain(impl Into<String>)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::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_versions::builders::DeletePackageVersionsFluentBuilder::domain_owner) / [`set_domain_owner(Option<String>)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::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_versions::builders::DeletePackageVersionsFluentBuilder::repository) / [`set_repository(Option<String>)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::set_repository):<br>required: **true**<br><p>The name of the repository that contains the package versions to delete.</p><br>
9    ///   - [`format(PackageFormat)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::format) / [`set_format(Option<PackageFormat>)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::set_format):<br>required: **true**<br><p>The format of the package versions to delete.</p><br>
10    ///   - [`namespace(impl Into<String>)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::set_namespace):<br>required: **false**<br><p>The namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example:</p><note>  <p>The namespace is required when deleting 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::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::package) / [`set_package(Option<String>)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::set_package):<br>required: **true**<br><p>The name of the package with the versions to delete.</p><br>
12    ///   - [`versions(impl Into<String>)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::versions) / [`set_versions(Option<Vec::<String>>)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::set_versions):<br>required: **true**<br><p>An array of strings that specify the versions of the package to delete.</p><br>
13    ///   - [`expected_status(PackageVersionStatus)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::expected_status) / [`set_expected_status(Option<PackageVersionStatus>)`](crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::set_expected_status):<br>required: **false**<br><p>The expected status of the package version to delete.</p><br>
14    /// - On success, responds with [`DeletePackageVersionsOutput`](crate::operation::delete_package_versions::DeletePackageVersionsOutput) with field(s):
15    ///   - [`successful_versions(Option<HashMap::<String, SuccessfulPackageVersionInfo>>)`](crate::operation::delete_package_versions::DeletePackageVersionsOutput::successful_versions): <p>A list of the package versions that were successfully deleted. The status of every successful version will be <code>Deleted</code>.</p>
16    ///   - [`failed_versions(Option<HashMap::<String, PackageVersionError>>)`](crate::operation::delete_package_versions::DeletePackageVersionsOutput::failed_versions): <p>A <code>PackageVersionError</code> object that contains a map of errors codes for the deleted package that failed. The possible error codes are:</p> <ul>  <li>   <p><code>ALREADY_EXISTS</code></p></li>  <li>   <p><code>MISMATCHED_REVISION</code></p></li>  <li>   <p><code>MISMATCHED_STATUS</code></p></li>  <li>   <p><code>NOT_ALLOWED</code></p></li>  <li>   <p><code>NOT_FOUND</code></p></li>  <li>   <p><code>SKIPPED</code></p></li> </ul>
17    /// - On failure, responds with [`SdkError<DeletePackageVersionsError>`](crate::operation::delete_package_versions::DeletePackageVersionsError)
18    pub fn delete_package_versions(&self) -> crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder {
19        crate::operation::delete_package_versions::builders::DeletePackageVersionsFluentBuilder::new(self.handle.clone())
20    }
21}