:doc:`S3Control <../../s3control>` / Client / list_access_grants_instances

****************************
list_access_grants_instances
****************************



.. py:method:: S3Control.Client.list_access_grants_instances(**kwargs)

  

  Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for your individual access grants. You can only have one S3 Access Grants instance per Region per account.

    Permissions  

  You must have the ``s3:ListAccessGrantsInstances`` permission to use this operation.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListAccessGrantsInstances>`_  


  **Request Syntax**
  ::

    response = client.list_access_grants_instances(
        AccountId='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type AccountId: string
  :param AccountId: **[REQUIRED]** 

    The Amazon Web Services account ID of the S3 Access Grants instance.

    

  
  :type NextToken: string
  :param NextToken: 

    A pagination token to request the next page of results. Pass this value into a subsequent ``List Access Grants Instances`` request in order to retrieve the next page of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of access grants that you would like returned in the ``List Access Grants`` response. If the results include the pagination token ``NextToken``, make another call using the ``NextToken`` to determine if there are more results.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'NextToken': 'string',
          'AccessGrantsInstancesList': [
              {
                  'AccessGrantsInstanceId': 'string',
                  'AccessGrantsInstanceArn': 'string',
                  'CreatedAt': datetime(2015, 1, 1),
                  'IdentityCenterArn': 'string',
                  'IdentityCenterInstanceArn': 'string',
                  'IdentityCenterApplicationArn': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **NextToken** *(string) --* 

        A pagination token to request the next page of results. Pass this value into a subsequent ``List Access Grants Instances`` request in order to retrieve the next page of results.

        
      

      - **AccessGrantsInstancesList** *(list) --* 

        A container for a list of S3 Access Grants instances.

        
        

        - *(dict) --* 

          Information about the S3 Access Grants instance.

          
          

          - **AccessGrantsInstanceId** *(string) --* 

            The ID of the S3 Access Grants instance. The ID is ``default``. You can have one S3 Access Grants instance per Region per account.

            
          

          - **AccessGrantsInstanceArn** *(string) --* 

            The Amazon Resource Name (ARN) of the S3 Access Grants instance.

            
          

          - **CreatedAt** *(datetime) --* 

            The date and time when you created the S3 Access Grants instance.

            
          

          - **IdentityCenterArn** *(string) --* 

            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.

            
          

          - **IdentityCenterInstanceArn** *(string) --* 

            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 `ListInstances <https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListInstances.html>`__ API operation to retrieve a list of your Identity Center instances and their ARNs.

            
          

          - **IdentityCenterApplicationArn** *(string) --* 

            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.

            
      
    
  