Make SigningInstructions public

CHANGELOG.next.toml

@@ -50,3 +50,9 @@ See the changes in https://github.com/awslabs/smithy-rs/pull/2671 for an example
 references = ["smithy-rs#2671"]
 meta = { "breaking" = true, "tada" = false, "bug" = false, "target" = "client" }
 author = "jdisanti"
+
+[[aws-sdk-rust]]
+message = "The `SigningInstructions` in the `aws-sigv4` module are now public. This allows them to be named in a function signature."
+references = ["smithy-rs#2730"]
+author = "cholcombe973"
+meta = { "breaking" = false, "tada" = false, "bug" = true }

aws/rust-runtime/aws-sigv4/src/http_request/mod.rs

@@ -56,4 +56,4 @@ pub use settings::{
     PayloadChecksumKind, PercentEncodingMode, SessionTokenMode, SignatureLocation, SigningParams,
     SigningSettings, UriPathNormalizationMode,
 };
-pub use sign::{sign, SignableBody, SignableRequest};
+pub use sign::{sign, SignableBody, SignableRequest, SigningInstructions};

aws/rust-runtime/aws-sigv4/src/http_request/sign.rs

@@ -103,6 +103,7 @@ pub enum SignableBody<'a> {
     StreamingUnsignedPayloadTrailer,
 }
 
+/// Instructions for applying a signature to an HTTP request.
 #[derive(Debug)]
 pub struct SigningInstructions {
     headers: Option<HeaderMap<HeaderValue>>,
@@ -117,20 +118,27 @@ impl SigningInstructions {
         Self { headers, params }
     }
 
+    /// Returns a reference to the headers that should be added to the request.
     pub fn headers(&self) -> Option<&HeaderMap<HeaderValue>> {
         self.headers.as_ref()
     }
+
+    /// Returns the headers and sets the internal value to `None`.
     pub fn take_headers(&mut self) -> Option<HeaderMap<HeaderValue>> {
         self.headers.take()
     }
 
+    /// Returns a reference to the query parameters that should be added to the request.
     pub fn params(&self) -> Option<&Vec<(&'static str, Cow<'static, str>)>> {
         self.params.as_ref()
     }
+
+    /// Returns the query parameters and sets the internal value to `None`.
     pub fn take_params(&mut self) -> Option<Vec<(&'static str, Cow<'static, str>)>> {
         self.params.take()
     }
 
+    /// Applies the instructions to the given `request`.
     pub fn apply_to_request<B>(mut self, request: &mut http::Request<B>) {
         if let Some(new_headers) = self.take_headers() {
             for (name, value) in new_headers.into_iter() {