{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.MechanicalTurk.ListWorkerBlocks -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- The @ListWorkersBlocks@ operation retrieves a list of Workers who are -- blocked from working on your HITs. -- -- This operation returns paginated results. module Amazonka.MechanicalTurk.ListWorkerBlocks ( -- * Creating a Request ListWorkerBlocks (..), newListWorkerBlocks, -- * Request Lenses listWorkerBlocks_maxResults, listWorkerBlocks_nextToken, -- * Destructuring the Response ListWorkerBlocksResponse (..), newListWorkerBlocksResponse, -- * Response Lenses listWorkerBlocksResponse_nextToken, listWorkerBlocksResponse_numResults, listWorkerBlocksResponse_workerBlocks, listWorkerBlocksResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.MechanicalTurk.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newListWorkerBlocks' smart constructor. data ListWorkerBlocks = ListWorkerBlocks' { maxResults :: Prelude.Maybe Prelude.Natural, -- | Pagination token nextToken :: Prelude.Maybe Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListWorkerBlocks' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'maxResults', 'listWorkerBlocks_maxResults' - Undocumented member. -- -- 'nextToken', 'listWorkerBlocks_nextToken' - Pagination token newListWorkerBlocks :: ListWorkerBlocks newListWorkerBlocks = ListWorkerBlocks' { maxResults = Prelude.Nothing, nextToken = Prelude.Nothing } -- | Undocumented member. listWorkerBlocks_maxResults :: Lens.Lens' ListWorkerBlocks (Prelude.Maybe Prelude.Natural) listWorkerBlocks_maxResults = Lens.lens (\ListWorkerBlocks' {maxResults} -> maxResults) (\s@ListWorkerBlocks' {} a -> s {maxResults = a} :: ListWorkerBlocks) -- | Pagination token listWorkerBlocks_nextToken :: Lens.Lens' ListWorkerBlocks (Prelude.Maybe Prelude.Text) listWorkerBlocks_nextToken = Lens.lens (\ListWorkerBlocks' {nextToken} -> nextToken) (\s@ListWorkerBlocks' {} a -> s {nextToken = a} :: ListWorkerBlocks) instance Core.AWSPager ListWorkerBlocks where page rq rs | Core.stop ( rs Lens.^? listWorkerBlocksResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listWorkerBlocksResponse_workerBlocks Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listWorkerBlocks_nextToken Lens..~ rs Lens.^? listWorkerBlocksResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListWorkerBlocks where type AWSResponse ListWorkerBlocks = ListWorkerBlocksResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListWorkerBlocksResponse' Prelude.<$> (x Data..?> "NextToken") Prelude.<*> (x Data..?> "NumResults") Prelude.<*> (x Data..?> "WorkerBlocks" Core..!@ Prelude.mempty) Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListWorkerBlocks where hashWithSalt _salt ListWorkerBlocks' {..} = _salt `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken instance Prelude.NFData ListWorkerBlocks where rnf ListWorkerBlocks' {..} = Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken instance Data.ToHeaders ListWorkerBlocks where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "MTurkRequesterServiceV20170117.ListWorkerBlocks" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListWorkerBlocks where toJSON ListWorkerBlocks' {..} = Data.object ( Prelude.catMaybes [ ("MaxResults" Data..=) Prelude.<$> maxResults, ("NextToken" Data..=) Prelude.<$> nextToken ] ) instance Data.ToPath ListWorkerBlocks where toPath = Prelude.const "/" instance Data.ToQuery ListWorkerBlocks where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newListWorkerBlocksResponse' smart constructor. data ListWorkerBlocksResponse = ListWorkerBlocksResponse' { nextToken :: Prelude.Maybe Prelude.Text, -- | The number of assignments on the page in the filtered results list, -- equivalent to the number of assignments returned by this call. numResults :: Prelude.Maybe Prelude.Int, -- | The list of WorkerBlocks, containing the collection of Worker IDs and -- reasons for blocking. workerBlocks :: Prelude.Maybe [WorkerBlock], -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListWorkerBlocksResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'nextToken', 'listWorkerBlocksResponse_nextToken' - Undocumented member. -- -- 'numResults', 'listWorkerBlocksResponse_numResults' - The number of assignments on the page in the filtered results list, -- equivalent to the number of assignments returned by this call. -- -- 'workerBlocks', 'listWorkerBlocksResponse_workerBlocks' - The list of WorkerBlocks, containing the collection of Worker IDs and -- reasons for blocking. -- -- 'httpStatus', 'listWorkerBlocksResponse_httpStatus' - The response's http status code. newListWorkerBlocksResponse :: -- | 'httpStatus' Prelude.Int -> ListWorkerBlocksResponse newListWorkerBlocksResponse pHttpStatus_ = ListWorkerBlocksResponse' { nextToken = Prelude.Nothing, numResults = Prelude.Nothing, workerBlocks = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | Undocumented member. listWorkerBlocksResponse_nextToken :: Lens.Lens' ListWorkerBlocksResponse (Prelude.Maybe Prelude.Text) listWorkerBlocksResponse_nextToken = Lens.lens (\ListWorkerBlocksResponse' {nextToken} -> nextToken) (\s@ListWorkerBlocksResponse' {} a -> s {nextToken = a} :: ListWorkerBlocksResponse) -- | The number of assignments on the page in the filtered results list, -- equivalent to the number of assignments returned by this call. listWorkerBlocksResponse_numResults :: Lens.Lens' ListWorkerBlocksResponse (Prelude.Maybe Prelude.Int) listWorkerBlocksResponse_numResults = Lens.lens (\ListWorkerBlocksResponse' {numResults} -> numResults) (\s@ListWorkerBlocksResponse' {} a -> s {numResults = a} :: ListWorkerBlocksResponse) -- | The list of WorkerBlocks, containing the collection of Worker IDs and -- reasons for blocking. listWorkerBlocksResponse_workerBlocks :: Lens.Lens' ListWorkerBlocksResponse (Prelude.Maybe [WorkerBlock]) listWorkerBlocksResponse_workerBlocks = Lens.lens (\ListWorkerBlocksResponse' {workerBlocks} -> workerBlocks) (\s@ListWorkerBlocksResponse' {} a -> s {workerBlocks = a} :: ListWorkerBlocksResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. listWorkerBlocksResponse_httpStatus :: Lens.Lens' ListWorkerBlocksResponse Prelude.Int listWorkerBlocksResponse_httpStatus = Lens.lens (\ListWorkerBlocksResponse' {httpStatus} -> httpStatus) (\s@ListWorkerBlocksResponse' {} a -> s {httpStatus = a} :: ListWorkerBlocksResponse) instance Prelude.NFData ListWorkerBlocksResponse where rnf ListWorkerBlocksResponse' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf numResults `Prelude.seq` Prelude.rnf workerBlocks `Prelude.seq` Prelude.rnf httpStatus