:doc:`QBusiness <../../qbusiness>` / Paginator / ListDataAccessors

*****************
ListDataAccessors
*****************



.. py:class:: QBusiness.Paginator.ListDataAccessors

  ::

    
    paginator = client.get_paginator('list_data_accessors')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`QBusiness.Client.list_data_accessors`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataAccessors>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          applicationId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type applicationId: string
    :param applicationId: **[REQUIRED]** 

      The unique identifier of the Amazon Q Business application.

      

    
    :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**

      
      ::

        {
            'dataAccessors': [
                {
                    'displayName': 'string',
                    'dataAccessorId': 'string',
                    'dataAccessorArn': 'string',
                    'idcApplicationArn': 'string',
                    'principal': 'string',
                    'authenticationDetail': {
                        'authenticationType': 'AWS_IAM_IDC_TTI'|'AWS_IAM_IDC_AUTH_CODE',
                        'authenticationConfiguration': {
                            'idcTrustedTokenIssuerConfiguration': {
                                'idcTrustedTokenIssuerArn': 'string'
                            }
                        },
                        'externalIds': [
                            'string',
                        ]
                    },
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **dataAccessors** *(list) --* 

          The list of data accessors.

          
          

          - *(dict) --* 

            Provides summary information about a data accessor.

            
            

            - **displayName** *(string) --* 

              The friendly name of the data accessor.

              
            

            - **dataAccessorId** *(string) --* 

              The unique identifier of the data accessor.

              
            

            - **dataAccessorArn** *(string) --* 

              The Amazon Resource Name (ARN) of the data accessor.

              
            

            - **idcApplicationArn** *(string) --* 

              The Amazon Resource Name (ARN) of the associated IAM Identity Center application.

              
            

            - **principal** *(string) --* 

              The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.

              
            

            - **authenticationDetail** *(dict) --* 

              The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor.

              
              

              - **authenticationType** *(string) --* 

                The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:

                 

                
                * ``AWS_IAM_IDC_TTI`` - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.
                 
                * ``AWS_IAM_IDC_AUTH_CODE`` - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.
                

                
              

              - **authenticationConfiguration** *(dict) --* 

                The specific authentication configuration based on the authentication type.

                .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``idcTrustedTokenIssuerConfiguration``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


              
                

                - **idcTrustedTokenIssuerConfiguration** *(dict) --* 

                  Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is ``AWS_IAM_IDC_TTI``.

                  
                  

                  - **idcTrustedTokenIssuerArn** *(string) --* 

                    The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication.

                    
              
            
              

              - **externalIds** *(list) --* 

                A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems.

                
                

                - *(string) --* 
            
          
            

            - **createdAt** *(datetime) --* 

              The timestamp when the data accessor was created.

              
            

            - **updatedAt** *(datetime) --* 

              The timestamp when the data accessor was last updated.

              
        
      
        

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

          A token to resume pagination.

          
    