aws_sdk_s3control/client/get_access_grants_instance.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 [`GetAccessGrantsInstance`](crate::operation::get_access_grants_instance::builders::GetAccessGrantsInstanceFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`account_id(impl Into<String>)`](crate::operation::get_access_grants_instance::builders::GetAccessGrantsInstanceFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::get_access_grants_instance::builders::GetAccessGrantsInstanceFluentBuilder::set_account_id):<br>required: **true**<br><p>The Amazon Web Services account ID of the S3 Access Grants instance.</p><br>
7 /// - On success, responds with [`GetAccessGrantsInstanceOutput`](crate::operation::get_access_grants_instance::GetAccessGrantsInstanceOutput) with field(s):
8 /// - [`access_grants_instance_arn(Option<String>)`](crate::operation::get_access_grants_instance::GetAccessGrantsInstanceOutput::access_grants_instance_arn): <p>The Amazon Resource Name (ARN) of the S3 Access Grants instance.</p>
9 /// - [`access_grants_instance_id(Option<String>)`](crate::operation::get_access_grants_instance::GetAccessGrantsInstanceOutput::access_grants_instance_id): <p>The ID of the S3 Access Grants instance. The ID is <code>default</code>. You can have one S3 Access Grants instance per Region per account.</p>
10 /// - [`identity_center_arn(Option<String>)`](crate::operation::get_access_grants_instance::GetAccessGrantsInstanceOutput::identity_center_arn): <p>If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.</p>
11 /// - [`identity_center_instance_arn(Option<String>)`](crate::operation::get_access_grants_instance::GetAccessGrantsInstanceOutput::identity_center_instance_arn): <p>The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the <a href="https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListInstances.html">ListInstances</a> API operation to retrieve a list of your Identity Center instances and their ARNs.</p>
12 /// - [`identity_center_application_arn(Option<String>)`](crate::operation::get_access_grants_instance::GetAccessGrantsInstanceOutput::identity_center_application_arn): <p>If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.</p>
13 /// - [`created_at(Option<DateTime>)`](crate::operation::get_access_grants_instance::GetAccessGrantsInstanceOutput::created_at): <p>The date and time when you created the S3 Access Grants instance.</p>
14 /// - On failure, responds with [`SdkError<GetAccessGrantsInstanceError>`](crate::operation::get_access_grants_instance::GetAccessGrantsInstanceError)
15 pub fn get_access_grants_instance(&self) -> crate::operation::get_access_grants_instance::builders::GetAccessGrantsInstanceFluentBuilder {
16 crate::operation::get_access_grants_instance::builders::GetAccessGrantsInstanceFluentBuilder::new(self.handle.clone())
17 }
18}