:doc:`SSOAdmin <../../sso-admin>` / Paginator / ListInstances

*************
ListInstances
*************



.. py:class:: SSOAdmin.Paginator.ListInstances

  ::

    
    paginator = client.get_paginator('list_instances')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SSOAdmin.Client.list_instances`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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'
                },
            ],
            
        }
        
      **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.

              
        
      
    