Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeDirectoryConfigs

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.

Request Syntax


{
   "DirectoryNames": [ "string" ],
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DirectoryNames

The directory names.

Type: Array of strings

Required: No

MaxResults

The maximum size of each page of results.

Type: Integer

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax


{
   "DirectoryConfigs": [ 
      { 
         "CertificateBasedAuthProperties": { 
            "CertificateAuthorityArn": "string",
            "Status": "string"
         },
         "CreatedTime": number,
         "DirectoryName": "string",
         "OrganizationalUnitDistinguishedNames": [ "string" ],
         "ServiceAccountCredentials": { 
            "AccountName": "string",
            "AccountPassword": "string"
         }
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DirectoryConfigs

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.

Type: Array of DirectoryConfig objects

NextToken

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.

Type: String

Length Constraints: Minimum length of 1.

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400