aws_sdk_s3control/client/update_access_grants_location.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 [`UpdateAccessGrantsLocation`](crate::operation::update_access_grants_location::builders::UpdateAccessGrantsLocationFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`account_id(impl Into<String>)`](crate::operation::update_access_grants_location::builders::UpdateAccessGrantsLocationFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::update_access_grants_location::builders::UpdateAccessGrantsLocationFluentBuilder::set_account_id):<br>required: **true**<br><p>The Amazon Web Services account ID of the S3 Access Grants instance.</p><br>
7 /// - [`access_grants_location_id(impl Into<String>)`](crate::operation::update_access_grants_location::builders::UpdateAccessGrantsLocationFluentBuilder::access_grants_location_id) / [`set_access_grants_location_id(Option<String>)`](crate::operation::update_access_grants_location::builders::UpdateAccessGrantsLocationFluentBuilder::set_access_grants_location_id):<br>required: **true**<br><p>The ID of the registered location that you are updating. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID <code>default</code> to the default location <code>s3://</code> and assigns an auto-generated ID to other locations that you register.</p> <p>The ID of the registered location to which you are granting access. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID <code>default</code> to the default location <code>s3://</code> and assigns an auto-generated ID to other locations that you register.</p> <p>If you are passing the <code>default</code> location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the <code>Subprefix</code> field.</p><br>
8 /// - [`iam_role_arn(impl Into<String>)`](crate::operation::update_access_grants_location::builders::UpdateAccessGrantsLocationFluentBuilder::iam_role_arn) / [`set_iam_role_arn(Option<String>)`](crate::operation::update_access_grants_location::builders::UpdateAccessGrantsLocationFluentBuilder::set_iam_role_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.</p><br>
9 /// - On success, responds with [`UpdateAccessGrantsLocationOutput`](crate::operation::update_access_grants_location::UpdateAccessGrantsLocationOutput) with field(s):
10 /// - [`created_at(Option<DateTime>)`](crate::operation::update_access_grants_location::UpdateAccessGrantsLocationOutput::created_at): <p>The date and time when you registered the location.</p>
11 /// - [`access_grants_location_id(Option<String>)`](crate::operation::update_access_grants_location::UpdateAccessGrantsLocationOutput::access_grants_location_id): <p>The ID of the registered location to which you are granting access. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID <code>default</code> to the default location <code>s3://</code> and assigns an auto-generated ID to other locations that you register.</p>
12 /// - [`access_grants_location_arn(Option<String>)`](crate::operation::update_access_grants_location::UpdateAccessGrantsLocationOutput::access_grants_location_arn): <p>The Amazon Resource Name (ARN) of the registered location that you are updating.</p>
13 /// - [`location_scope(Option<String>)`](crate::operation::update_access_grants_location::UpdateAccessGrantsLocationOutput::location_scope): <p>The S3 URI path of the location that you are updating. You cannot update the scope of the registered location. The location scope can be the default S3 location <code>s3://</code>, the S3 path to a bucket <code>s3://<bucket></bucket></code>, or the S3 path to a bucket and prefix <code>s3://<bucket> / <prefix></prefix> </bucket></code>.</p>
14 /// - [`iam_role_arn(Option<String>)`](crate::operation::update_access_grants_location::UpdateAccessGrantsLocationOutput::iam_role_arn): <p>The Amazon Resource Name (ARN) of the IAM role of the registered location. S3 Access Grants assumes this role to manage access to the registered location.</p>
15 /// - On failure, responds with [`SdkError<UpdateAccessGrantsLocationError>`](crate::operation::update_access_grants_location::UpdateAccessGrantsLocationError)
16 pub fn update_access_grants_location(
17 &self,
18 ) -> crate::operation::update_access_grants_location::builders::UpdateAccessGrantsLocationFluentBuilder {
19 crate::operation::update_access_grants_location::builders::UpdateAccessGrantsLocationFluentBuilder::new(self.handle.clone())
20 }
21}