aws_sdk_codeartifact/client/put_package_origin_configuration.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 [`PutPackageOriginConfiguration`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`domain(impl Into<String>)`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::set_domain):<br>required: **true**<br><p>The name of the domain that contains the repository that contains the package.</p><br>
7 /// - [`domain_owner(impl Into<String>)`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::domain_owner) / [`set_domain_owner(Option<String>)`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::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::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::repository) / [`set_repository(Option<String>)`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::set_repository):<br>required: **true**<br><p>The name of the repository that contains the package.</p><br>
9 /// - [`format(PackageFormat)`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::format) / [`set_format(Option<PackageFormat>)`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::set_format):<br>required: **true**<br><p>A format that specifies the type of the package to be updated.</p><br>
10 /// - [`namespace(impl Into<String>)`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::set_namespace):<br>required: **false**<br><p>The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example:</p> <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::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::package) / [`set_package(Option<String>)`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::set_package):<br>required: **true**<br><p>The name of the package to be updated.</p><br>
12 /// - [`restrictions(PackageOriginRestrictions)`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::restrictions) / [`set_restrictions(Option<PackageOriginRestrictions>)`](crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::set_restrictions):<br>required: **true**<br><p>A <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html">PackageOriginRestrictions</a> object that contains information about the <code>upstream</code> and <code>publish</code> package origin restrictions. The <code>upstream</code> restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. The <code>publish</code> restriction determines if new package versions can be published directly to the repository.</p> <p>You must include both the desired <code>upstream</code> and <code>publish</code> restrictions.</p><br>
13 /// - On success, responds with [`PutPackageOriginConfigurationOutput`](crate::operation::put_package_origin_configuration::PutPackageOriginConfigurationOutput) with field(s):
14 /// - [`origin_configuration(Option<PackageOriginConfiguration>)`](crate::operation::put_package_origin_configuration::PutPackageOriginConfigurationOutput::origin_configuration): <p>A <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html">PackageOriginConfiguration</a> object that describes the origin configuration set for the package. It contains a <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html">PackageOriginRestrictions</a> object that describes how new versions of the package can be introduced to the repository.</p>
15 /// - On failure, responds with [`SdkError<PutPackageOriginConfigurationError>`](crate::operation::put_package_origin_configuration::PutPackageOriginConfigurationError)
16 pub fn put_package_origin_configuration(
17 &self,
18 ) -> crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder {
19 crate::operation::put_package_origin_configuration::builders::PutPackageOriginConfigurationFluentBuilder::new(self.handle.clone())
20 }
21}