GetDatasetContent.hs

{-# 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.IoTAnalytics.GetDatasetContent
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Retrieves the contents of a dataset as presigned URIs.
module Amazonka.IoTAnalytics.GetDatasetContent
  ( -- * Creating a Request
    GetDatasetContent (..),
    newGetDatasetContent,

    -- * Request Lenses
    getDatasetContent_versionId,
    getDatasetContent_datasetName,

    -- * Destructuring the Response
    GetDatasetContentResponse (..),
    newGetDatasetContentResponse,

    -- * Response Lenses
    getDatasetContentResponse_entries,
    getDatasetContentResponse_status,
    getDatasetContentResponse_timestamp,
    getDatasetContentResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.IoTAnalytics.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newGetDatasetContent' smart constructor.
data GetDatasetContent = GetDatasetContent'
  { -- | The version of the dataset whose contents are retrieved. You can also
    -- use the strings \"$LATEST\" or \"$LATEST_SUCCEEDED\" to retrieve the
    -- contents of the latest or latest successfully completed dataset. If not
    -- specified, \"$LATEST_SUCCEEDED\" is the default.
    versionId :: Prelude.Maybe Prelude.Text,
    -- | The name of the dataset whose contents are retrieved.
    datasetName :: Prelude.Text
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'GetDatasetContent' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'versionId', 'getDatasetContent_versionId' - The version of the dataset whose contents are retrieved. You can also
-- use the strings \"$LATEST\" or \"$LATEST_SUCCEEDED\" to retrieve the
-- contents of the latest or latest successfully completed dataset. If not
-- specified, \"$LATEST_SUCCEEDED\" is the default.
--
-- 'datasetName', 'getDatasetContent_datasetName' - The name of the dataset whose contents are retrieved.
newGetDatasetContent ::
  -- | 'datasetName'
  Prelude.Text ->
  GetDatasetContent
newGetDatasetContent pDatasetName_ =
  GetDatasetContent'
    { versionId = Prelude.Nothing,
      datasetName = pDatasetName_
    }

-- | The version of the dataset whose contents are retrieved. You can also
-- use the strings \"$LATEST\" or \"$LATEST_SUCCEEDED\" to retrieve the
-- contents of the latest or latest successfully completed dataset. If not
-- specified, \"$LATEST_SUCCEEDED\" is the default.
getDatasetContent_versionId :: Lens.Lens' GetDatasetContent (Prelude.Maybe Prelude.Text)
getDatasetContent_versionId = Lens.lens (\GetDatasetContent' {versionId} -> versionId) (\s@GetDatasetContent' {} a -> s {versionId = a} :: GetDatasetContent)

-- | The name of the dataset whose contents are retrieved.
getDatasetContent_datasetName :: Lens.Lens' GetDatasetContent Prelude.Text
getDatasetContent_datasetName = Lens.lens (\GetDatasetContent' {datasetName} -> datasetName) (\s@GetDatasetContent' {} a -> s {datasetName = a} :: GetDatasetContent)

instance Core.AWSRequest GetDatasetContent where
  type
    AWSResponse GetDatasetContent =
      GetDatasetContentResponse
  request overrides =
    Request.get (overrides defaultService)
  response =
    Response.receiveJSON
      ( \s h x ->
          GetDatasetContentResponse'
            Prelude.<$> (x Data..?> "entries" Core..!@ Prelude.mempty)
            Prelude.<*> (x Data..?> "status")
            Prelude.<*> (x Data..?> "timestamp")
            Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
      )

instance Prelude.Hashable GetDatasetContent where
  hashWithSalt _salt GetDatasetContent' {..} =
    _salt
      `Prelude.hashWithSalt` versionId
      `Prelude.hashWithSalt` datasetName

instance Prelude.NFData GetDatasetContent where
  rnf GetDatasetContent' {..} =
    Prelude.rnf versionId
      `Prelude.seq` Prelude.rnf datasetName

instance Data.ToHeaders GetDatasetContent where
  toHeaders = Prelude.const Prelude.mempty

instance Data.ToPath GetDatasetContent where
  toPath GetDatasetContent' {..} =
    Prelude.mconcat
      ["/datasets/", Data.toBS datasetName, "/content"]

instance Data.ToQuery GetDatasetContent where
  toQuery GetDatasetContent' {..} =
    Prelude.mconcat ["versionId" Data.=: versionId]

-- | /See:/ 'newGetDatasetContentResponse' smart constructor.
data GetDatasetContentResponse = GetDatasetContentResponse'
  { -- | A list of @DatasetEntry@ objects.
    entries :: Prelude.Maybe [DatasetEntry],
    -- | The status of the dataset content.
    status :: Prelude.Maybe DatasetContentStatus,
    -- | The time when the request was made.
    timestamp :: Prelude.Maybe Data.POSIX,
    -- | The response's http status code.
    httpStatus :: Prelude.Int
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'GetDatasetContentResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'entries', 'getDatasetContentResponse_entries' - A list of @DatasetEntry@ objects.
--
-- 'status', 'getDatasetContentResponse_status' - The status of the dataset content.
--
-- 'timestamp', 'getDatasetContentResponse_timestamp' - The time when the request was made.
--
-- 'httpStatus', 'getDatasetContentResponse_httpStatus' - The response's http status code.
newGetDatasetContentResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetDatasetContentResponse
newGetDatasetContentResponse pHttpStatus_ =
  GetDatasetContentResponse'
    { entries =
        Prelude.Nothing,
      status = Prelude.Nothing,
      timestamp = Prelude.Nothing,
      httpStatus = pHttpStatus_
    }

-- | A list of @DatasetEntry@ objects.
getDatasetContentResponse_entries :: Lens.Lens' GetDatasetContentResponse (Prelude.Maybe [DatasetEntry])
getDatasetContentResponse_entries = Lens.lens (\GetDatasetContentResponse' {entries} -> entries) (\s@GetDatasetContentResponse' {} a -> s {entries = a} :: GetDatasetContentResponse) Prelude.. Lens.mapping Lens.coerced

-- | The status of the dataset content.
getDatasetContentResponse_status :: Lens.Lens' GetDatasetContentResponse (Prelude.Maybe DatasetContentStatus)
getDatasetContentResponse_status = Lens.lens (\GetDatasetContentResponse' {status} -> status) (\s@GetDatasetContentResponse' {} a -> s {status = a} :: GetDatasetContentResponse)

-- | The time when the request was made.
getDatasetContentResponse_timestamp :: Lens.Lens' GetDatasetContentResponse (Prelude.Maybe Prelude.UTCTime)
getDatasetContentResponse_timestamp = Lens.lens (\GetDatasetContentResponse' {timestamp} -> timestamp) (\s@GetDatasetContentResponse' {} a -> s {timestamp = a} :: GetDatasetContentResponse) Prelude.. Lens.mapping Data._Time

-- | The response's http status code.
getDatasetContentResponse_httpStatus :: Lens.Lens' GetDatasetContentResponse Prelude.Int
getDatasetContentResponse_httpStatus = Lens.lens (\GetDatasetContentResponse' {httpStatus} -> httpStatus) (\s@GetDatasetContentResponse' {} a -> s {httpStatus = a} :: GetDatasetContentResponse)

instance Prelude.NFData GetDatasetContentResponse where
  rnf GetDatasetContentResponse' {..} =
    Prelude.rnf entries
      `Prelude.seq` Prelude.rnf status
      `Prelude.seq` Prelude.rnf timestamp
      `Prelude.seq` Prelude.rnf httpStatus