aws_sdk_s3control/client/create_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 [`CreateAccessGrantsInstance`](crate::operation::create_access_grants_instance::builders::CreateAccessGrantsInstanceFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`account_id(impl Into<String>)`](crate::operation::create_access_grants_instance::builders::CreateAccessGrantsInstanceFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::create_access_grants_instance::builders::CreateAccessGrantsInstanceFluentBuilder::set_account_id):<br>required: **true**<br><p>The Amazon Web Services account ID of the S3 Access Grants instance.</p><br>
7 /// - [`identity_center_arn(impl Into<String>)`](crate::operation::create_access_grants_instance::builders::CreateAccessGrantsInstanceFluentBuilder::identity_center_arn) / [`set_identity_center_arn(Option<String>)`](crate::operation::create_access_grants_instance::builders::CreateAccessGrantsInstanceFluentBuilder::set_identity_center_arn):<br>required: **false**<br><p>If you would like to associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, use this field to pass 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><br>
8 /// - [`tags(Tag)`](crate::operation::create_access_grants_instance::builders::CreateAccessGrantsInstanceFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_access_grants_instance::builders::CreateAccessGrantsInstanceFluentBuilder::set_tags):<br>required: **false**<br><p>The Amazon Web Services resource tags that you are adding to the S3 Access Grants instance. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.</p><br>
9 /// - On success, responds with [`CreateAccessGrantsInstanceOutput`](crate::operation::create_access_grants_instance::CreateAccessGrantsInstanceOutput) with field(s):
10 /// - [`created_at(Option<DateTime>)`](crate::operation::create_access_grants_instance::CreateAccessGrantsInstanceOutput::created_at): <p>The date and time when you created the S3 Access Grants instance.</p>
11 /// - [`access_grants_instance_id(Option<String>)`](crate::operation::create_access_grants_instance::CreateAccessGrantsInstanceOutput::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>
12 /// - [`access_grants_instance_arn(Option<String>)`](crate::operation::create_access_grants_instance::CreateAccessGrantsInstanceOutput::access_grants_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>
13 /// - [`identity_center_arn(Option<String>)`](crate::operation::create_access_grants_instance::CreateAccessGrantsInstanceOutput::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>
14 /// - [`identity_center_instance_arn(Option<String>)`](crate::operation::create_access_grants_instance::CreateAccessGrantsInstanceOutput::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>
15 /// - [`identity_center_application_arn(Option<String>)`](crate::operation::create_access_grants_instance::CreateAccessGrantsInstanceOutput::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>
16 /// - On failure, responds with [`SdkError<CreateAccessGrantsInstanceError>`](crate::operation::create_access_grants_instance::CreateAccessGrantsInstanceError)
17 pub fn create_access_grants_instance(
18 &self,
19 ) -> crate::operation::create_access_grants_instance::builders::CreateAccessGrantsInstanceFluentBuilder {
20 crate::operation::create_access_grants_instance::builders::CreateAccessGrantsInstanceFluentBuilder::new(self.handle.clone())
21 }
22}