aws_sdk_s3control/client/

get_access_grant.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetAccessGrant`](crate::operation::get_access_grant::builders::GetAccessGrantFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`account_id(impl Into<String>)`](crate::operation::get_access_grant::builders::GetAccessGrantFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::get_access_grant::builders::GetAccessGrantFluentBuilder::set_account_id):<br>required: **true**<br><p>The Amazon Web Services account ID of the S3 Access Grants instance.</p><br>
    ///   - [`access_grant_id(impl Into<String>)`](crate::operation::get_access_grant::builders::GetAccessGrantFluentBuilder::access_grant_id) / [`set_access_grant_id(Option<String>)`](crate::operation::get_access_grant::builders::GetAccessGrantFluentBuilder::set_access_grant_id):<br>required: **true**<br><p>The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.</p><br>
    /// - On success, responds with [`GetAccessGrantOutput`](crate::operation::get_access_grant::GetAccessGrantOutput) with field(s):
    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_access_grant::GetAccessGrantOutput::created_at): <p>The date and time when you created the access grant.</p>
    ///   - [`access_grant_id(Option<String>)`](crate::operation::get_access_grant::GetAccessGrantOutput::access_grant_id): <p>The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.</p>
    ///   - [`access_grant_arn(Option<String>)`](crate::operation::get_access_grant::GetAccessGrantOutput::access_grant_arn): <p>The Amazon Resource Name (ARN) of the access grant.</p>
    ///   - [`grantee(Option<Grantee>)`](crate::operation::get_access_grant::GetAccessGrantOutput::grantee): <p>The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added a corporate directory to Amazon Web Services IAM Identity Center and associated this Identity Center instance with the S3 Access Grants instance, the grantee can also be a corporate directory user or group.</p>
    ///   - [`permission(Option<Permission>)`](crate::operation::get_access_grant::GetAccessGrantOutput::permission): <p>The type of permission that was granted in the access grant. Can be one of the following values:</p> <ul>  <li>   <p><code>READ</code> – Grant read-only access to the S3 data.</p></li>  <li>   <p><code>WRITE</code> – Grant write-only access to the S3 data.</p></li>  <li>   <p><code>READWRITE</code> – Grant both read and write access to the S3 data.</p></li> </ul>
    ///   - [`access_grants_location_id(Option<String>)`](crate::operation::get_access_grant::GetAccessGrantOutput::access_grants_location_id): <p>The ID of the registered location to which you are granting access. 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>
    ///   - [`access_grants_location_configuration(Option<AccessGrantsLocationConfiguration>)`](crate::operation::get_access_grant::GetAccessGrantOutput::access_grants_location_configuration): <p>The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.</p>
    ///   - [`grant_scope(Option<String>)`](crate::operation::get_access_grant::GetAccessGrantOutput::grant_scope): <p>The S3 path of the data to which you are granting access. It is the result of appending the <code>Subprefix</code> to the location scope.</p>
    ///   - [`application_arn(Option<String>)`](crate::operation::get_access_grant::GetAccessGrantOutput::application_arn): <p>The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.</p>
    /// - On failure, responds with [`SdkError<GetAccessGrantError>`](crate::operation::get_access_grant::GetAccessGrantError)
    pub fn get_access_grant(&self) -> crate::operation::get_access_grant::builders::GetAccessGrantFluentBuilder {
        crate::operation::get_access_grant::builders::GetAccessGrantFluentBuilder::new(self.handle.clone())
    }
}