Unverified Commit ccb7b080 authored by John DiSanti's avatar John DiSanti Committed by GitHub
Browse files

Improve presigning module docs (#2903) 

_By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice._
parent 61b675c0

aws/rust-runtime/aws-inlineable/src/presigning.rs

+7 −0
Original line number Diff line number Diff line
@@ -3,7 +3,14 @@ 
 * SPDX-License-Identifier: Apache-2.0

 */



// TODO(https://github.com/awslabs/smithy-rs/issues/2902): Code generate this documentation so that service-specific examples can be added.

//! Presigned request types and configuration.

//!

//! The [`Client`](crate::Client) is used to create presigned requests. They are made

//! by calling `.presigned()` instead of `.send()` on an operation, and require a

//! [`PresigningConfig`](crate::presigning::PresigningConfig) to provide an expiration time.

//!

//! Only operations that support presigning have the `presigned()` method on them.



use std::fmt;

use std::time::{Duration, SystemTime};

aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/AwsPresigningDecorator.kt

+3 −0
Original line number Diff line number Diff line
@@ -500,6 +500,9 @@ private fun RustWriter.documentPresignedMethod(hasConfigArg: Boolean) { 


        Presigned requests can be given to other users or applications to access a resource or perform

        an operation without having access to the AWS security credentials.



        _Important:_ If you're using credentials that can expire, such as those from STS AssumeRole or SSO, then

        the presigned request can only be valid for as long as the credentials used to create it are.

        """,

    )

}