| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.AppStream.DescribeDirectoryConfigs
Description
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.
This operation returns paginated results.
Synopsis
- data DescribeDirectoryConfigs = DescribeDirectoryConfigs' {
- directoryNames :: Maybe [Text]
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- newDescribeDirectoryConfigs :: DescribeDirectoryConfigs
- describeDirectoryConfigs_directoryNames :: Lens' DescribeDirectoryConfigs (Maybe [Text])
- describeDirectoryConfigs_maxResults :: Lens' DescribeDirectoryConfigs (Maybe Int)
- describeDirectoryConfigs_nextToken :: Lens' DescribeDirectoryConfigs (Maybe Text)
- data DescribeDirectoryConfigsResponse = DescribeDirectoryConfigsResponse' {}
- newDescribeDirectoryConfigsResponse :: Int -> DescribeDirectoryConfigsResponse
- describeDirectoryConfigsResponse_directoryConfigs :: Lens' DescribeDirectoryConfigsResponse (Maybe [DirectoryConfig])
- describeDirectoryConfigsResponse_nextToken :: Lens' DescribeDirectoryConfigsResponse (Maybe Text)
- describeDirectoryConfigsResponse_httpStatus :: Lens' DescribeDirectoryConfigsResponse Int
Creating a Request
data DescribeDirectoryConfigs Source #
See: newDescribeDirectoryConfigs smart constructor.
Constructors
| DescribeDirectoryConfigs' | |
Fields
| |
Instances
newDescribeDirectoryConfigs :: DescribeDirectoryConfigs Source #
Create a value of DescribeDirectoryConfigs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directoryNames:DescribeDirectoryConfigs', describeDirectoryConfigs_directoryNames - The directory names.
$sel:maxResults:DescribeDirectoryConfigs', describeDirectoryConfigs_maxResults - The maximum size of each page of results.
DescribeDirectoryConfigs, describeDirectoryConfigs_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.
Request Lenses
describeDirectoryConfigs_directoryNames :: Lens' DescribeDirectoryConfigs (Maybe [Text]) Source #
The directory names.
describeDirectoryConfigs_maxResults :: Lens' DescribeDirectoryConfigs (Maybe Int) Source #
The maximum size of each page of results.
describeDirectoryConfigs_nextToken :: Lens' DescribeDirectoryConfigs (Maybe Text) Source #
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.
Destructuring the Response
data DescribeDirectoryConfigsResponse Source #
See: newDescribeDirectoryConfigsResponse smart constructor.
Constructors
| DescribeDirectoryConfigsResponse' | |
Fields
| |
Instances
newDescribeDirectoryConfigsResponse Source #
Create a value of DescribeDirectoryConfigsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directoryConfigs:DescribeDirectoryConfigsResponse', describeDirectoryConfigsResponse_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.
DescribeDirectoryConfigs, describeDirectoryConfigsResponse_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.
$sel:httpStatus:DescribeDirectoryConfigsResponse', describeDirectoryConfigsResponse_httpStatus - The response's http status code.
Response Lenses
describeDirectoryConfigsResponse_directoryConfigs :: Lens' DescribeDirectoryConfigsResponse (Maybe [DirectoryConfig]) Source #
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.
describeDirectoryConfigsResponse_nextToken :: Lens' DescribeDirectoryConfigsResponse (Maybe Text) Source #
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.
describeDirectoryConfigsResponse_httpStatus :: Lens' DescribeDirectoryConfigsResponse Int Source #
The response's http status code.