describe_directory_configs `async` ¶

describe_directory_configs(
    *,
    config_overrides: Optional[AsyncAppStreamClientConfig] = None,
    directory_names: Optional[DirectoryNameList] = None,
    max_results: Optional[Integer] = None,
    next_token: Optional[String] = None,
) -> DescribeDirectoryConfigsResult

Retrieves a list that describes one or more specified Directory Config objects for WorkSpaces Applications, 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.

Parameters:

directory_names (Optional[DirectoryNameList], default: None ) –

The directory names.
max_results (Optional[Integer], default: None ) –

The maximum size of each page of results.
next_token (Optional[String], default: None ) –

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.

Raises:

ResourceNotFoundException –

The specified resource was not found.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_appstream/_services/async_app_stream.py

async def describe_directory_configs(
    self,
    *,
    config_overrides: Optional[AsyncAppStreamClientConfig] = None,
    directory_names: Optional[
        "capo_appstream.types.directory_name_list.DirectoryNameList"
    ] = None,
    max_results: Optional["capo_appstream.types.integer.Integer"] = None,
    next_token: Optional["capo_appstream.types.string.String"] = None,
) -> "capo_appstream.types.describe_directory_configs_result.DescribeDirectoryConfigsResult":
    """<p>Retrieves a list that describes one or more specified Directory Config objects for WorkSpaces Applications, 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. </p> <p>Although the response syntax in this topic includes the account password, this password is not returned in the actual response.</p>

    Args:
        directory_names: <p>The directory names.</p>
        max_results: <p>The maximum size of each page of results.</p>
        next_token: <p>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.</p>

    Raises:
        capo_appstream.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_appstream.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_appstream.types.describe_directory_configs_request.DescribeDirectoryConfigsRequest]",
    ) -> AsyncOperationResponse[
        "capo_appstream.types.describe_directory_configs_result.DescribeDirectoryConfigsResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.describe_directory_configs

        (
            output,
            http_response,
        ) = await capo_appstream._operations.photon_admin_proxy_service.describe_directory_configs.async_describe_directory_configs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_appstream.types.describe_directory_configs_result.DescribeDirectoryConfigsResult",
    ) -> dict[str, Any]:
        import capo_appstream.types.describe_directory_configs_result

        return (
            capo_appstream.types.describe_directory_configs_result.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeDirectoryConfigs", redact_output=_redact_output),
    )
    input_: capo_appstream.types.describe_directory_configs_request.DescribeDirectoryConfigsRequest = {}
    if directory_names is not None:
        input_["directory_names"] = directory_names
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_directory_configs async ¶

describe_directory_configs `async` ¶