describe_workspaces_pools ¶

def describe_workspaces_pools(
    self,
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
    pool_ids: Optional[
        "capo_workspaces.types.workspaces_pool_ids.WorkspacesPoolIds"
    ] = None,
    filters: Optional[
        "capo_workspaces.types.describe_workspaces_pools_filters.DescribeWorkspacesPoolsFilters"
    ] = None,
    limit: Optional["capo_workspaces.types.limit.Limit"] = None,
    next_token: Optional[
        "capo_workspaces.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_workspaces.types.describe_workspaces_pools_result.DescribeWorkspacesPoolsResult":
    """<note> <p>End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/wsp-pools-end-of-support.html">Amazon WorkSpaces Pools end of support</a>. </p> </note> <p>Describes the specified WorkSpaces Pools.</p>

    Args:
        pool_ids: <p>The identifier of the WorkSpaces Pools.</p>
        filters: <p>The filter conditions for the WorkSpaces Pool to return.</p>
        limit: <p>The maximum number of items 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>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces.types.describe_workspaces_pools_request.DescribeWorkspacesPoolsRequest]",
    ) -> OperationResponse[
        "capo_workspaces.types.describe_workspaces_pools_result.DescribeWorkspacesPoolsResult"
    ]:
        import capo_workspaces._operations.workspaces_service.describe_workspaces_pools

        output, http_response = (
            capo_workspaces._operations.workspaces_service.describe_workspaces_pools.describe_workspaces_pools(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeWorkspacesPools")
    )
    input_: capo_workspaces.types.describe_workspaces_pools_request.DescribeWorkspacesPoolsRequest = {}
    if pool_ids is not None:
        input_["pool_ids"] = pool_ids
    if filters is not None:
        input_["filters"] = filters
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output