describe_workspace_directories async ¶

async def describe_workspace_directories(
    self,
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    directory_ids: Optional[
        "capo_workspaces.types.directory_id_list.DirectoryIdList"
    ] = None,
    workspace_directory_names: Optional[
        "capo_workspaces.types.workspace_directory_name_list.WorkspaceDirectoryNameList"
    ] = None,
    limit: Optional["capo_workspaces.types.limit.Limit"] = None,
    next_token: Optional[
        "capo_workspaces.types.pagination_token.PaginationToken"
    ] = None,
    filters: Optional[
        "capo_workspaces.types.describe_workspace_directories_filter_list.DescribeWorkspaceDirectoriesFilterList"
    ] = None,
) -> "capo_workspaces.types.describe_workspace_directories_result.DescribeWorkspaceDirectoriesResult":
    """<p>Describes the available directories that are registered with Amazon WorkSpaces.</p>

    Args:
        directory_ids: <p>The identifiers of the directories. If the value is null, all directories are retrieved.</p>
        workspace_directory_names: <p>The names of the WorkSpace directories.</p>
        limit: <p>The maximum number of directories to return.</p>
        next_token: <p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>
        filters: <p>The filter condition for the WorkSpaces.</p>

    Raises:
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workspaces.types.describe_workspace_directories_request.DescribeWorkspaceDirectoriesRequest]",
    ) -> AsyncOperationResponse[
        "capo_workspaces.types.describe_workspace_directories_result.DescribeWorkspaceDirectoriesResult"
    ]:
        import capo_workspaces._operations.workspaces_service.describe_workspace_directories

        (
            output,
            http_response,
        ) = await capo_workspaces._operations.workspaces_service.describe_workspace_directories.async_describe_workspace_directories(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeWorkspaceDirectories")
    )
    input_: capo_workspaces.types.describe_workspace_directories_request.DescribeWorkspaceDirectoriesRequest = {}
    if directory_ids is not None:
        input_["directory_ids"] = directory_ids
    if workspace_directory_names is not None:
        input_["workspace_directory_names"] = workspace_directory_names
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token
    if filters is not None:
        input_["filters"] = filters

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