AppStream / Client / describe_directory_configs

describe_directory_configs#

AppStream.Client.describe_directory_configs(**kwargs)#

Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Although the response syntax in this topic includes the account password, this password is not returned in the actual response.

See also: AWS API Documentation

Request Syntax

response = client.describe_directory_configs(
    DirectoryNames=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • DirectoryNames (list) –

    The directory names.

    • (string) –

  • MaxResults (integer) – The maximum size of each page of results.

  • NextToken (string) – The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Return type:

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

    • NextToken (string) –

      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Exceptions

  • AppStream.Client.exceptions.ResourceNotFoundException