{-# 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.CodeBuild.ListBuilds -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Gets a list of build IDs, with each build ID representing a single -- build. -- -- This operation returns paginated results. module Amazonka.CodeBuild.ListBuilds ( -- * Creating a Request ListBuilds (..), newListBuilds, -- * Request Lenses listBuilds_nextToken, listBuilds_sortOrder, -- * Destructuring the Response ListBuildsResponse (..), newListBuildsResponse, -- * Response Lenses listBuildsResponse_ids, listBuildsResponse_nextToken, listBuildsResponse_httpStatus, ) where import Amazonka.CodeBuild.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newListBuilds' smart constructor. data ListBuilds = ListBuilds' { -- | During a previous call, if there are more than 100 items in the list, -- only the first 100 items are returned, along with a unique string called -- a /nextToken/. To get the next batch of items in the list, call this -- operation again, adding the next token to the call. To get all of the -- items in the list, keep calling this operation with each subsequent next -- token that is returned, until no more next tokens are returned. nextToken :: Prelude.Maybe Prelude.Text, -- | The order to list build IDs. Valid values include: -- -- - @ASCENDING@: List the build IDs in ascending order by build ID. -- -- - @DESCENDING@: List the build IDs in descending order by build ID. sortOrder :: Prelude.Maybe SortOrderType } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListBuilds' 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', 'listBuilds_nextToken' - During a previous call, if there are more than 100 items in the list, -- only the first 100 items are returned, along with a unique string called -- a /nextToken/. To get the next batch of items in the list, call this -- operation again, adding the next token to the call. To get all of the -- items in the list, keep calling this operation with each subsequent next -- token that is returned, until no more next tokens are returned. -- -- 'sortOrder', 'listBuilds_sortOrder' - The order to list build IDs. Valid values include: -- -- - @ASCENDING@: List the build IDs in ascending order by build ID. -- -- - @DESCENDING@: List the build IDs in descending order by build ID. newListBuilds :: ListBuilds newListBuilds = ListBuilds' { nextToken = Prelude.Nothing, sortOrder = Prelude.Nothing } -- | During a previous call, if there are more than 100 items in the list, -- only the first 100 items are returned, along with a unique string called -- a /nextToken/. To get the next batch of items in the list, call this -- operation again, adding the next token to the call. To get all of the -- items in the list, keep calling this operation with each subsequent next -- token that is returned, until no more next tokens are returned. listBuilds_nextToken :: Lens.Lens' ListBuilds (Prelude.Maybe Prelude.Text) listBuilds_nextToken = Lens.lens (\ListBuilds' {nextToken} -> nextToken) (\s@ListBuilds' {} a -> s {nextToken = a} :: ListBuilds) -- | The order to list build IDs. Valid values include: -- -- - @ASCENDING@: List the build IDs in ascending order by build ID. -- -- - @DESCENDING@: List the build IDs in descending order by build ID. listBuilds_sortOrder :: Lens.Lens' ListBuilds (Prelude.Maybe SortOrderType) listBuilds_sortOrder = Lens.lens (\ListBuilds' {sortOrder} -> sortOrder) (\s@ListBuilds' {} a -> s {sortOrder = a} :: ListBuilds) instance Core.AWSPager ListBuilds where page rq rs | Core.stop ( rs Lens.^? listBuildsResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listBuildsResponse_ids Prelude.. Lens._Just Prelude.. Lens.to Prelude.toList ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listBuilds_nextToken Lens..~ rs Lens.^? listBuildsResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListBuilds where type AWSResponse ListBuilds = ListBuildsResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListBuildsResponse' Prelude.<$> (x Data..?> "ids") Prelude.<*> (x Data..?> "nextToken") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListBuilds where hashWithSalt _salt ListBuilds' {..} = _salt `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` sortOrder instance Prelude.NFData ListBuilds where rnf ListBuilds' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf sortOrder instance Data.ToHeaders ListBuilds where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "CodeBuild_20161006.ListBuilds" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListBuilds where toJSON ListBuilds' {..} = Data.object ( Prelude.catMaybes [ ("nextToken" Data..=) Prelude.<$> nextToken, ("sortOrder" Data..=) Prelude.<$> sortOrder ] ) instance Data.ToPath ListBuilds where toPath = Prelude.const "/" instance Data.ToQuery ListBuilds where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newListBuildsResponse' smart constructor. data ListBuildsResponse = ListBuildsResponse' { -- | A list of build IDs, with each build ID representing a single build. ids :: Prelude.Maybe (Prelude.NonEmpty Prelude.Text), -- | If there are more than 100 items in the list, only the first 100 items -- are returned, along with a unique string called a /nextToken/. To get -- the next batch of items in the list, call this operation again, adding -- the next token to the call. nextToken :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListBuildsResponse' 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: -- -- 'ids', 'listBuildsResponse_ids' - A list of build IDs, with each build ID representing a single build. -- -- 'nextToken', 'listBuildsResponse_nextToken' - If there are more than 100 items in the list, only the first 100 items -- are returned, along with a unique string called a /nextToken/. To get -- the next batch of items in the list, call this operation again, adding -- the next token to the call. -- -- 'httpStatus', 'listBuildsResponse_httpStatus' - The response's http status code. newListBuildsResponse :: -- | 'httpStatus' Prelude.Int -> ListBuildsResponse newListBuildsResponse pHttpStatus_ = ListBuildsResponse' { ids = Prelude.Nothing, nextToken = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | A list of build IDs, with each build ID representing a single build. listBuildsResponse_ids :: Lens.Lens' ListBuildsResponse (Prelude.Maybe (Prelude.NonEmpty Prelude.Text)) listBuildsResponse_ids = Lens.lens (\ListBuildsResponse' {ids} -> ids) (\s@ListBuildsResponse' {} a -> s {ids = a} :: ListBuildsResponse) Prelude.. Lens.mapping Lens.coerced -- | If there are more than 100 items in the list, only the first 100 items -- are returned, along with a unique string called a /nextToken/. To get -- the next batch of items in the list, call this operation again, adding -- the next token to the call. listBuildsResponse_nextToken :: Lens.Lens' ListBuildsResponse (Prelude.Maybe Prelude.Text) listBuildsResponse_nextToken = Lens.lens (\ListBuildsResponse' {nextToken} -> nextToken) (\s@ListBuildsResponse' {} a -> s {nextToken = a} :: ListBuildsResponse) -- | The response's http status code. listBuildsResponse_httpStatus :: Lens.Lens' ListBuildsResponse Prelude.Int listBuildsResponse_httpStatus = Lens.lens (\ListBuildsResponse' {httpStatus} -> httpStatus) (\s@ListBuildsResponse' {} a -> s {httpStatus = a} :: ListBuildsResponse) instance Prelude.NFData ListBuildsResponse where rnf ListBuildsResponse' {..} = Prelude.rnf ids `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf httpStatus