aws_sdk_iot/client/create_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 [`CreatePackageVersion`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`package_name(impl Into<String>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::package_name) / [`set_package_name(Option<String>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::set_package_name):<br>required: **true**<br><p>The name of the associated software package.</p><br>
7 /// - [`version_name(impl Into<String>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::version_name) / [`set_version_name(Option<String>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::set_version_name):<br>required: **true**<br><p>The name of the new package version.</p><br>
8 /// - [`description(impl Into<String>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::set_description):<br>required: **false**<br><p>A summary of the package version being created. This can be used to outline the package's contents or purpose.</p><br>
9 /// - [`attributes(impl Into<String>, impl Into<String>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::attributes) / [`set_attributes(Option<HashMap::<String, String>>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::set_attributes):<br>required: **false**<br><p>Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.</p> <p>The combined size of all the attributes on a package version is limited to 3KB.</p><br>
10 /// - [`artifact(PackageVersionArtifact)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::artifact) / [`set_artifact(Option<PackageVersionArtifact>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::set_artifact):<br>required: **false**<br><p>The various build components created during the build process such as libraries and configuration files that make up a software package version.</p><br>
11 /// - [`recipe(impl Into<String>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::recipe) / [`set_recipe(Option<String>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::set_recipe):<br>required: **false**<br><p>The inline job document associated with a software package version used for a quick job deployment.</p><br>
12 /// - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::set_tags):<br>required: **false**<br><p>Metadata that can be used to manage the package version.</p><br>
13 /// - [`client_token(impl Into<String>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p><br>
14 /// - On success, responds with [`CreatePackageVersionOutput`](crate::operation::create_package_version::CreatePackageVersionOutput) with field(s):
15 /// - [`package_version_arn(Option<String>)`](crate::operation::create_package_version::CreatePackageVersionOutput::package_version_arn): <p>The Amazon Resource Name (ARN) for the package.</p>
16 /// - [`package_name(Option<String>)`](crate::operation::create_package_version::CreatePackageVersionOutput::package_name): <p>The name of the associated software package.</p>
17 /// - [`version_name(Option<String>)`](crate::operation::create_package_version::CreatePackageVersionOutput::version_name): <p>The name of the new package version.</p>
18 /// - [`description(Option<String>)`](crate::operation::create_package_version::CreatePackageVersionOutput::description): <p>The package version description.</p>
19 /// - [`attributes(Option<HashMap::<String, String>>)`](crate::operation::create_package_version::CreatePackageVersionOutput::attributes): <p>Metadata that were added to the package version that can be used to define a package version’s configuration.</p>
20 /// - [`status(Option<PackageVersionStatus>)`](crate::operation::create_package_version::CreatePackageVersionOutput::status): <p>The status of the package version. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p>
21 /// - [`error_reason(Option<String>)`](crate::operation::create_package_version::CreatePackageVersionOutput::error_reason): <p>Error reason for a package version failure during creation or update.</p>
22 /// - On failure, responds with [`SdkError<CreatePackageVersionError>`](crate::operation::create_package_version::CreatePackageVersionError)
23 pub fn create_package_version(&self) -> crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder {
24 crate::operation::create_package_version::builders::CreatePackageVersionFluentBuilder::new(self.handle.clone())
25 }
26}