:doc:`AppStream <../../appstream>` / Paginator / DescribeDirectoryConfigs

************************
DescribeDirectoryConfigs
************************



.. py:class:: AppStream.Paginator.DescribeDirectoryConfigs

  ::

    
    paginator = client.get_paginator('describe_directory_configs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`AppStream.Client.describe_directory_configs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeDirectoryConfigs>`_    


    **Request Syntax**
    ::

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

      The directory names.

      

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

      
      ::

        {
            'DirectoryConfigs': [
                {
                    'DirectoryName': 'string',
                    'OrganizationalUnitDistinguishedNames': [
                        'string',
                    ],
                    'ServiceAccountCredentials': {
                        'AccountName': 'string',
                        'AccountPassword': 'string'
                    },
                    'CreatedTime': datetime(2015, 1, 1),
                    'CertificateBasedAuthProperties': {
                        'Status': 'DISABLED'|'ENABLED'|'ENABLED_NO_DIRECTORY_LOGIN_FALLBACK',
                        'CertificateAuthorityArn': 'string'
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **DirectoryConfigs** *(list) --* 

          Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.

          
          

          - *(dict) --* 

            Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

            
            

            - **DirectoryName** *(string) --* 

              The fully qualified name of the directory (for example, corp.example.com).

              
            

            - **OrganizationalUnitDistinguishedNames** *(list) --* 

              The distinguished names of the organizational units for computer accounts.

              
              

              - *(string) --* 
          
            

            - **ServiceAccountCredentials** *(dict) --* 

              The credentials for the service account used by the fleet or image builder to connect to the directory.

              
              

              - **AccountName** *(string) --* 

                The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.

                
              

              - **AccountPassword** *(string) --* 

                The password for the account.

                
          
            

            - **CreatedTime** *(datetime) --* 

              The time the directory configuration was created.

              
            

            - **CertificateBasedAuthProperties** *(dict) --* 

              The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is **Enabled** . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. **Enabled_no_directory_login_fallback** enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

              
              

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

                The status of the certificate-based authentication properties.

                
              

              - **CertificateAuthorityArn** *(string) --* 

                The ARN of the AWS Certificate Manager Private CA resource.

                
          
        
      
    