:doc:`SSOAdmin <../../sso-admin>` / Client / list_instances

**************
list_instances
**************



.. py:method:: SSOAdmin.Client.list_instances(**kwargs)

  

  Lists the details of the organization and account instances of IAM Identity Center that were created in or visible to the account calling this API.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sso-admin-2020-07-20/ListInstances>`_  


  **Request Syntax**
  ::

    response = client.list_instances(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to display for the instance.

    

  
  :type NextToken: string
  :param NextToken: 

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    

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

    
    ::

      {
          'Instances': [
              {
                  'InstanceArn': 'string',
                  'IdentityStoreId': 'string',
                  'OwnerAccountId': 'string',
                  'Name': 'string',
                  'CreatedDate': datetime(2015, 1, 1),
                  'Status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'ACTIVE',
                  'StatusReason': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Instances** *(list) --* 

        Lists the IAM Identity Center instances that the caller has access to.

        
        

        - *(dict) --* 

          Provides information about the IAM Identity Center instance.

          
          

          - **InstanceArn** *(string) --* 

            The ARN of the Identity Center instance under which the operation will be executed. For more information about ARNs, see `Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces </general/latest/gr/aws-arns-and-namespaces.html>`__ in the *Amazon Web Services General Reference*.

            
          

          - **IdentityStoreId** *(string) --* 

            The identifier of the identity store that is connected to the Identity Center instance.

            
          

          - **OwnerAccountId** *(string) --* 

            The Amazon Web Services account ID number of the owner of the Identity Center instance.

            
          

          - **Name** *(string) --* 

            The name of the Identity Center instance.

            
          

          - **CreatedDate** *(datetime) --* 

            The date and time that the Identity Center instance was created.

            
          

          - **Status** *(string) --* 

            The current status of this Identity Center instance.

            
          

          - **StatusReason** *(string) --* 

            Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance creation fails, this field contains information about the cause, which may include issues with KMS key configuration or insufficient permissions.

            
      
    
      

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

        The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

        
  
  **Exceptions**
  
  *   :py:class:`SSOAdmin.Client.exceptions.ThrottlingException`

  
  *   :py:class:`SSOAdmin.Client.exceptions.InternalServerException`

  
  *   :py:class:`SSOAdmin.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SSOAdmin.Client.exceptions.ValidationException`

  