{-# 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.DeviceFarm.ListSamples -- 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 information about samples, given an AWS Device Farm job ARN. -- -- This operation returns paginated results. module Amazonka.DeviceFarm.ListSamples ( -- * Creating a Request ListSamples (..), newListSamples, -- * Request Lenses listSamples_nextToken, listSamples_arn, -- * Destructuring the Response ListSamplesResponse (..), newListSamplesResponse, -- * Response Lenses listSamplesResponse_nextToken, listSamplesResponse_samples, listSamplesResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.DeviceFarm.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | Represents a request to the list samples operation. -- -- /See:/ 'newListSamples' smart constructor. data ListSamples = ListSamples' { -- | An identifier that was returned from the previous call to this -- operation, which can be used to return the next set of items in the -- list. nextToken :: Prelude.Maybe Prelude.Text, -- | The Amazon Resource Name (ARN) of the job used to list samples. arn :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListSamples' 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', 'listSamples_nextToken' - An identifier that was returned from the previous call to this -- operation, which can be used to return the next set of items in the -- list. -- -- 'arn', 'listSamples_arn' - The Amazon Resource Name (ARN) of the job used to list samples. newListSamples :: -- | 'arn' Prelude.Text -> ListSamples newListSamples pArn_ = ListSamples' { nextToken = Prelude.Nothing, arn = pArn_ } -- | An identifier that was returned from the previous call to this -- operation, which can be used to return the next set of items in the -- list. listSamples_nextToken :: Lens.Lens' ListSamples (Prelude.Maybe Prelude.Text) listSamples_nextToken = Lens.lens (\ListSamples' {nextToken} -> nextToken) (\s@ListSamples' {} a -> s {nextToken = a} :: ListSamples) -- | The Amazon Resource Name (ARN) of the job used to list samples. listSamples_arn :: Lens.Lens' ListSamples Prelude.Text listSamples_arn = Lens.lens (\ListSamples' {arn} -> arn) (\s@ListSamples' {} a -> s {arn = a} :: ListSamples) instance Core.AWSPager ListSamples where page rq rs | Core.stop ( rs Lens.^? listSamplesResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? listSamplesResponse_samples Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& listSamples_nextToken Lens..~ rs Lens.^? listSamplesResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest ListSamples where type AWSResponse ListSamples = ListSamplesResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> ListSamplesResponse' Prelude.<$> (x Data..?> "nextToken") Prelude.<*> (x Data..?> "samples" Core..!@ Prelude.mempty) Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable ListSamples where hashWithSalt _salt ListSamples' {..} = _salt `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` arn instance Prelude.NFData ListSamples where rnf ListSamples' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf arn instance Data.ToHeaders ListSamples where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "DeviceFarm_20150623.ListSamples" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON ListSamples where toJSON ListSamples' {..} = Data.object ( Prelude.catMaybes [ ("nextToken" Data..=) Prelude.<$> nextToken, Prelude.Just ("arn" Data..= arn) ] ) instance Data.ToPath ListSamples where toPath = Prelude.const "/" instance Data.ToQuery ListSamples where toQuery = Prelude.const Prelude.mempty -- | Represents the result of a list samples request. -- -- /See:/ 'newListSamplesResponse' smart constructor. data ListSamplesResponse = ListSamplesResponse' { -- | If the number of items that are returned is significantly large, this is -- an identifier that is also returned. It can be used in a subsequent call -- to this operation to return the next set of items in the list. nextToken :: Prelude.Maybe Prelude.Text, -- | Information about the samples. samples :: Prelude.Maybe [Sample], -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'ListSamplesResponse' 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', 'listSamplesResponse_nextToken' - If the number of items that are returned is significantly large, this is -- an identifier that is also returned. It can be used in a subsequent call -- to this operation to return the next set of items in the list. -- -- 'samples', 'listSamplesResponse_samples' - Information about the samples. -- -- 'httpStatus', 'listSamplesResponse_httpStatus' - The response's http status code. newListSamplesResponse :: -- | 'httpStatus' Prelude.Int -> ListSamplesResponse newListSamplesResponse pHttpStatus_ = ListSamplesResponse' { nextToken = Prelude.Nothing, samples = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | If the number of items that are returned is significantly large, this is -- an identifier that is also returned. It can be used in a subsequent call -- to this operation to return the next set of items in the list. listSamplesResponse_nextToken :: Lens.Lens' ListSamplesResponse (Prelude.Maybe Prelude.Text) listSamplesResponse_nextToken = Lens.lens (\ListSamplesResponse' {nextToken} -> nextToken) (\s@ListSamplesResponse' {} a -> s {nextToken = a} :: ListSamplesResponse) -- | Information about the samples. listSamplesResponse_samples :: Lens.Lens' ListSamplesResponse (Prelude.Maybe [Sample]) listSamplesResponse_samples = Lens.lens (\ListSamplesResponse' {samples} -> samples) (\s@ListSamplesResponse' {} a -> s {samples = a} :: ListSamplesResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. listSamplesResponse_httpStatus :: Lens.Lens' ListSamplesResponse Prelude.Int listSamplesResponse_httpStatus = Lens.lens (\ListSamplesResponse' {httpStatus} -> httpStatus) (\s@ListSamplesResponse' {} a -> s {httpStatus = a} :: ListSamplesResponse) instance Prelude.NFData ListSamplesResponse where rnf ListSamplesResponse' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf samples `Prelude.seq` Prelude.rnf httpStatus