aws_sdk_licensemanager/client/
checkout_borrow_license.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 [`CheckoutBorrowLicense`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`license_arn(impl Into<String>)`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::license_arn) / [`set_license_arn(Option<String>)`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::set_license_arn):<br>required: **true**<br><p>Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.</p><br>
7    ///   - [`entitlements(EntitlementData)`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::entitlements) / [`set_entitlements(Option<Vec::<EntitlementData>>)`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::set_entitlements):<br>required: **true**<br><p>License entitlements. Partial checkouts are not supported.</p><br>
8    ///   - [`digital_signature_method(DigitalSignatureMethod)`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::digital_signature_method) / [`set_digital_signature_method(Option<DigitalSignatureMethod>)`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::set_digital_signature_method):<br>required: **true**<br><p>Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see <a href="https://tools.ietf.org/html/rfc7518#section-3.5">RFC 7518 Digital Signature with RSASSA-PSS</a>.</p><br>
9    ///   - [`node_id(impl Into<String>)`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::node_id) / [`set_node_id(Option<String>)`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::set_node_id):<br>required: **false**<br><p>Node ID.</p><br>
10    ///   - [`checkout_metadata(Metadata)`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::checkout_metadata) / [`set_checkout_metadata(Option<Vec::<Metadata>>)`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::set_checkout_metadata):<br>required: **false**<br><p>Information about constraints.</p><br>
11    ///   - [`client_token(impl Into<String>)`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::set_client_token):<br>required: **true**<br><p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p><br>
12    /// - On success, responds with [`CheckoutBorrowLicenseOutput`](crate::operation::checkout_borrow_license::CheckoutBorrowLicenseOutput) with field(s):
13    ///   - [`license_arn(Option<String>)`](crate::operation::checkout_borrow_license::CheckoutBorrowLicenseOutput::license_arn): <p>Amazon Resource Name (ARN) of the license.</p>
14    ///   - [`license_consumption_token(Option<String>)`](crate::operation::checkout_borrow_license::CheckoutBorrowLicenseOutput::license_consumption_token): <p>License consumption token.</p>
15    ///   - [`entitlements_allowed(Option<Vec::<EntitlementData>>)`](crate::operation::checkout_borrow_license::CheckoutBorrowLicenseOutput::entitlements_allowed): <p>Allowed license entitlements.</p>
16    ///   - [`node_id(Option<String>)`](crate::operation::checkout_borrow_license::CheckoutBorrowLicenseOutput::node_id): <p>Node ID.</p>
17    ///   - [`signed_token(Option<String>)`](crate::operation::checkout_borrow_license::CheckoutBorrowLicenseOutput::signed_token): <p>Signed token.</p>
18    ///   - [`issued_at(Option<String>)`](crate::operation::checkout_borrow_license::CheckoutBorrowLicenseOutput::issued_at): <p>Date and time at which the license checkout is issued.</p>
19    ///   - [`expiration(Option<String>)`](crate::operation::checkout_borrow_license::CheckoutBorrowLicenseOutput::expiration): <p>Date and time at which the license checkout expires.</p>
20    ///   - [`checkout_metadata(Option<Vec::<Metadata>>)`](crate::operation::checkout_borrow_license::CheckoutBorrowLicenseOutput::checkout_metadata): <p>Information about constraints.</p>
21    /// - On failure, responds with [`SdkError<CheckoutBorrowLicenseError>`](crate::operation::checkout_borrow_license::CheckoutBorrowLicenseError)
22    pub fn checkout_borrow_license(&self) -> crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder {
23        crate::operation::checkout_borrow_license::builders::CheckoutBorrowLicenseFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_licensemanager/client/checkout_borrow_license.rs

aws_sdk_licensemanager/client/
checkout_borrow_license.rs
