[smithy-rs] Fix Inaccurate documentation on ProfileFileCredentialsPro…

…vider (#2421) This commit addresses #746. Co-authored-by: Yuki Saito <awsaito@amazon.com>
awslabs · Mar 28, 2023 · f0fd144 · f0fd144
1 parent 76df390
commit f0fd144
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 15 deletions.
diff --git a/sdk/aws-config/src/profile/credentials.rs b/sdk/aws-config/src/profile/credentials.rs
@@ -61,9 +61,8 @@ impl ProvideCredentials for ProfileFileCredentialsProvider {
 /// let provider = ProfileFileCredentialsProvider::builder().build();
 /// ```
 ///
-/// _Note: Profile providers to not implement any caching. They will reload and reparse the profile
-/// from the file system when called. See [CredentialsCache](aws_credential_types::cache::CredentialsCache) for
-/// more information about caching._
+/// _Note: Profile providers, when called, will load and parse the profile from the file system
+/// only once. Parsed file contents will be cached indefinitely._
 ///
 /// This provider supports several different credentials formats:
 /// ### Credentials defined explicitly within the file

diff --git a/sdk/kinesis/src/input.rs b/sdk/kinesis/src/input.rs
@@ -923,8 +923,8 @@ impl DescribeStreamConsumerInput {
             .set_use_fips(_config.use_fips)
             .set_endpoint(_config.endpoint_url.clone())
             .set_operation_type(Some("control".to_string()))
-            .set_consumer_arn(self.consumer_arn.clone())
             .set_stream_arn(self.stream_arn.clone())
+            .set_consumer_arn(self.consumer_arn.clone())
             .build()
             .map_err(|err| {
                 aws_smithy_http::endpoint::ResolveEndpointError::from_source(

diff --git a/sdk/s3control/src/input.rs b/sdk/s3control/src/input.rs
@@ -324,8 +324,8 @@ impl CreateBucketInput {
             .set_use_dual_stack(_config.use_dual_stack)
             .set_endpoint(_config.endpoint_url.clone())
             .set_use_arn_region(_config.use_arn_region)
-            .set_bucket(self.bucket.clone())
             .set_outpost_id(self.outpost_id.clone())
+            .set_bucket(self.bucket.clone())
             .build()
             .map_err(|err| {
                 aws_smithy_http::endpoint::ResolveEndpointError::from_source(
@@ -2836,8 +2836,8 @@ impl GetAccessPointInput {
             .set_endpoint(_config.endpoint_url.clone())
             .set_use_arn_region(_config.use_arn_region)
             .set_requires_account_id(Some(true))
-            .set_access_point_name(self.name.clone())
             .set_account_id(self.account_id.clone())
+            .set_access_point_name(self.name.clone())
             .build()
             .map_err(|err| {
                 aws_smithy_http::endpoint::ResolveEndpointError::from_source(
@@ -3249,8 +3249,8 @@ impl GetAccessPointPolicyInput {
             .set_endpoint(_config.endpoint_url.clone())
             .set_use_arn_region(_config.use_arn_region)
             .set_requires_account_id(Some(true))
-            .set_access_point_name(self.name.clone())
             .set_account_id(self.account_id.clone())
+            .set_access_point_name(self.name.clone())
             .build()
             .map_err(|err| {
                 aws_smithy_http::endpoint::ResolveEndpointError::from_source(
@@ -3526,8 +3526,8 @@ impl GetAccessPointPolicyStatusInput {
             .set_endpoint(_config.endpoint_url.clone())
             .set_use_arn_region(_config.use_arn_region)
             .set_requires_account_id(Some(true))
-            .set_account_id(self.account_id.clone())
             .set_access_point_name(self.name.clone())
+            .set_account_id(self.account_id.clone())
             .build()
             .map_err(|err| {
                 aws_smithy_http::endpoint::ResolveEndpointError::from_source(
@@ -3937,8 +3937,8 @@ impl GetBucketLifecycleConfigurationInput {
             .set_endpoint(_config.endpoint_url.clone())
             .set_use_arn_region(_config.use_arn_region)
             .set_requires_account_id(Some(true))
-            .set_bucket(self.bucket.clone())
             .set_account_id(self.account_id.clone())
+            .set_bucket(self.bucket.clone())
             .build()
             .map_err(|err| {
                 aws_smithy_http::endpoint::ResolveEndpointError::from_source(
@@ -4213,8 +4213,8 @@ impl GetBucketTaggingInput {
             .set_endpoint(_config.endpoint_url.clone())
             .set_use_arn_region(_config.use_arn_region)
             .set_requires_account_id(Some(true))
-            .set_bucket(self.bucket.clone())
             .set_account_id(self.account_id.clone())
+            .set_bucket(self.bucket.clone())
             .build()
             .map_err(|err| {
                 aws_smithy_http::endpoint::ResolveEndpointError::from_source(
@@ -6196,8 +6196,8 @@ impl ListRegionalBucketsInput {
             .set_endpoint(_config.endpoint_url.clone())
             .set_use_arn_region(_config.use_arn_region)
             .set_requires_account_id(Some(true))
-            .set_outpost_id(self.outpost_id.clone())
             .set_account_id(self.account_id.clone())
+            .set_outpost_id(self.outpost_id.clone())
             .build()
             .map_err(|err| {
                 aws_smithy_http::endpoint::ResolveEndpointError::from_source(

diff --git a/versions.toml b/versions.toml
@@ -1,12 +1,12 @@
-smithy_rs_revision = 'c3ae6f7eaf20e77014d6054d18cd0f03f754599f'
+smithy_rs_revision = '049287db3c9b12510f42e7dd16cd08f69ab91b9d'
 aws_doc_sdk_examples_revision = '97a177aab8c3d2fef97416cb66e4b4d0da840138'
 
 [manual_interventions]
 crates_to_remove = []
 [crates.aws-config]
 category = 'AwsRuntime'
 version = '0.0.0-smithy-rs-head'
-source_hash = '559b9fda0060a9f6ad7db6d7b7acb4b0d1465c816fee7144974dbe4e2e459e81'
+source_hash = 'baac20d2ff3e8db99d93d022ed1534cf65438ed2588a3b260e7c25322da73360'
 
 [crates.aws-credential-types]
 category = 'AwsRuntime'
@@ -1057,7 +1057,7 @@ model_hash = '9ec8a92782fbef7e2cf07fc9b5e656aa37b59668baff33acae10f270cfff4193'
 [crates.aws-sdk-kinesis]
 category = 'AwsSdk'
 version = '0.55.0'
-source_hash = '4975a23a51f1ce3a508f4ec3ee23ebd3e61b90afde88734909de092f34cd10ab'
+source_hash = '193f0029f710e5ebf182184bcb8531cf8f9a9ac073b03d0dbd63d97d7485382a'
 model_hash = '5eaef8321cea414140d87258e714988d88f3e41d9cdf4b83a1417027cb702cb9'
 
 [crates.aws-sdk-kinesisanalytics]
@@ -1669,7 +1669,7 @@ model_hash = 'fb47cfd49cf2d9250063914599f703ed365b51be373988dc3f2cd64321c9583b'
 [crates.aws-sdk-s3control]
 category = 'AwsSdk'
 version = '0.55.0'
-source_hash = 'e85a22fb56fd9fa22b930da8c868aeb1c1e28039021fa9e443e00682110bcd39'
+source_hash = '2f4f28a776bbb19b147d8fbefa35ddd7b9f67dc3a312adc045bab2bbac827fb3'
 model_hash = '930bd33c05c393293591ae01cbdb6637fb5062ed3a3ad5e2dadddd8108cc8478'
 
 [crates.aws-sdk-s3outposts]