{-# 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.SageMakerMetrics.BatchPutMetrics
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Used to ingest training metrics into SageMaker. These metrics can be
-- visualized in SageMaker Studio and retrieved with the @GetMetrics@ API.
module Amazonka.SageMakerMetrics.BatchPutMetrics
  ( -- * Creating a Request
    BatchPutMetrics (..),
    newBatchPutMetrics,

    -- * Request Lenses
    batchPutMetrics_trialComponentName,
    batchPutMetrics_metricData,

    -- * Destructuring the Response
    BatchPutMetricsResponse (..),
    newBatchPutMetricsResponse,

    -- * Response Lenses
    batchPutMetricsResponse_errors,
    batchPutMetricsResponse_httpStatus,
  )
where

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
import Amazonka.SageMakerMetrics.Types

-- | /See:/ 'newBatchPutMetrics' smart constructor.
data BatchPutMetrics = BatchPutMetrics'
  { -- | The name of the Trial Component to associate with the metrics.
    BatchPutMetrics -> Text
trialComponentName :: Prelude.Text,
    -- | A list of raw metric values to put.
    BatchPutMetrics -> NonEmpty RawMetricData
metricData :: Prelude.NonEmpty RawMetricData
  }
  deriving (BatchPutMetrics -> BatchPutMetrics -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BatchPutMetrics -> BatchPutMetrics -> Bool
$c/= :: BatchPutMetrics -> BatchPutMetrics -> Bool
== :: BatchPutMetrics -> BatchPutMetrics -> Bool
$c== :: BatchPutMetrics -> BatchPutMetrics -> Bool
Prelude.Eq, ReadPrec [BatchPutMetrics]
ReadPrec BatchPutMetrics
Int -> ReadS BatchPutMetrics
ReadS [BatchPutMetrics]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [BatchPutMetrics]
$creadListPrec :: ReadPrec [BatchPutMetrics]
readPrec :: ReadPrec BatchPutMetrics
$creadPrec :: ReadPrec BatchPutMetrics
readList :: ReadS [BatchPutMetrics]
$creadList :: ReadS [BatchPutMetrics]
readsPrec :: Int -> ReadS BatchPutMetrics
$creadsPrec :: Int -> ReadS BatchPutMetrics
Prelude.Read, Int -> BatchPutMetrics -> ShowS
[BatchPutMetrics] -> ShowS
BatchPutMetrics -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [BatchPutMetrics] -> ShowS
$cshowList :: [BatchPutMetrics] -> ShowS
show :: BatchPutMetrics -> String
$cshow :: BatchPutMetrics -> String
showsPrec :: Int -> BatchPutMetrics -> ShowS
$cshowsPrec :: Int -> BatchPutMetrics -> ShowS
Prelude.Show, forall x. Rep BatchPutMetrics x -> BatchPutMetrics
forall x. BatchPutMetrics -> Rep BatchPutMetrics x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep BatchPutMetrics x -> BatchPutMetrics
$cfrom :: forall x. BatchPutMetrics -> Rep BatchPutMetrics x
Prelude.Generic)

-- |
-- Create a value of 'BatchPutMetrics' 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:
--
-- 'trialComponentName', 'batchPutMetrics_trialComponentName' - The name of the Trial Component to associate with the metrics.
--
-- 'metricData', 'batchPutMetrics_metricData' - A list of raw metric values to put.
newBatchPutMetrics ::
  -- | 'trialComponentName'
  Prelude.Text ->
  -- | 'metricData'
  Prelude.NonEmpty RawMetricData ->
  BatchPutMetrics
newBatchPutMetrics :: Text -> NonEmpty RawMetricData -> BatchPutMetrics
newBatchPutMetrics Text
pTrialComponentName_ NonEmpty RawMetricData
pMetricData_ =
  BatchPutMetrics'
    { $sel:trialComponentName:BatchPutMetrics' :: Text
trialComponentName =
        Text
pTrialComponentName_,
      $sel:metricData:BatchPutMetrics' :: NonEmpty RawMetricData
metricData = forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced forall t b. AReview t b -> b -> t
Lens.# NonEmpty RawMetricData
pMetricData_
    }

-- | The name of the Trial Component to associate with the metrics.
batchPutMetrics_trialComponentName :: Lens.Lens' BatchPutMetrics Prelude.Text
batchPutMetrics_trialComponentName :: Lens' BatchPutMetrics Text
batchPutMetrics_trialComponentName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BatchPutMetrics' {Text
trialComponentName :: Text
$sel:trialComponentName:BatchPutMetrics' :: BatchPutMetrics -> Text
trialComponentName} -> Text
trialComponentName) (\s :: BatchPutMetrics
s@BatchPutMetrics' {} Text
a -> BatchPutMetrics
s {$sel:trialComponentName:BatchPutMetrics' :: Text
trialComponentName = Text
a} :: BatchPutMetrics)

-- | A list of raw metric values to put.
batchPutMetrics_metricData :: Lens.Lens' BatchPutMetrics (Prelude.NonEmpty RawMetricData)
batchPutMetrics_metricData :: Lens' BatchPutMetrics (NonEmpty RawMetricData)
batchPutMetrics_metricData = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BatchPutMetrics' {NonEmpty RawMetricData
metricData :: NonEmpty RawMetricData
$sel:metricData:BatchPutMetrics' :: BatchPutMetrics -> NonEmpty RawMetricData
metricData} -> NonEmpty RawMetricData
metricData) (\s :: BatchPutMetrics
s@BatchPutMetrics' {} NonEmpty RawMetricData
a -> BatchPutMetrics
s {$sel:metricData:BatchPutMetrics' :: NonEmpty RawMetricData
metricData = NonEmpty RawMetricData
a} :: BatchPutMetrics) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.AWSRequest BatchPutMetrics where
  type
    AWSResponse BatchPutMetrics =
      BatchPutMetricsResponse
  request :: (Service -> Service) -> BatchPutMetrics -> Request BatchPutMetrics
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.putJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy BatchPutMetrics
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse BatchPutMetrics)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe (NonEmpty BatchPutMetricsError)
-> Int -> BatchPutMetricsResponse
BatchPutMetricsResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Errors")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable BatchPutMetrics where
  hashWithSalt :: Int -> BatchPutMetrics -> Int
hashWithSalt Int
_salt BatchPutMetrics' {NonEmpty RawMetricData
Text
metricData :: NonEmpty RawMetricData
trialComponentName :: Text
$sel:metricData:BatchPutMetrics' :: BatchPutMetrics -> NonEmpty RawMetricData
$sel:trialComponentName:BatchPutMetrics' :: BatchPutMetrics -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
trialComponentName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` NonEmpty RawMetricData
metricData

instance Prelude.NFData BatchPutMetrics where
  rnf :: BatchPutMetrics -> ()
rnf BatchPutMetrics' {NonEmpty RawMetricData
Text
metricData :: NonEmpty RawMetricData
trialComponentName :: Text
$sel:metricData:BatchPutMetrics' :: BatchPutMetrics -> NonEmpty RawMetricData
$sel:trialComponentName:BatchPutMetrics' :: BatchPutMetrics -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
trialComponentName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf NonEmpty RawMetricData
metricData

instance Data.ToHeaders BatchPutMetrics where
  toHeaders :: BatchPutMetrics -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

instance Data.ToJSON BatchPutMetrics where
  toJSON :: BatchPutMetrics -> Value
toJSON BatchPutMetrics' {NonEmpty RawMetricData
Text
metricData :: NonEmpty RawMetricData
trialComponentName :: Text
$sel:metricData:BatchPutMetrics' :: BatchPutMetrics -> NonEmpty RawMetricData
$sel:trialComponentName:BatchPutMetrics' :: BatchPutMetrics -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just
              (Key
"TrialComponentName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
trialComponentName),
            forall a. a -> Maybe a
Prelude.Just (Key
"MetricData" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= NonEmpty RawMetricData
metricData)
          ]
      )

instance Data.ToPath BatchPutMetrics where
  toPath :: BatchPutMetrics -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/BatchPutMetrics"

instance Data.ToQuery BatchPutMetrics where
  toQuery :: BatchPutMetrics -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newBatchPutMetricsResponse' smart constructor.
data BatchPutMetricsResponse = BatchPutMetricsResponse'
  { -- | Lists any errors that occur when inserting metric data.
    BatchPutMetricsResponse -> Maybe (NonEmpty BatchPutMetricsError)
errors :: Prelude.Maybe (Prelude.NonEmpty BatchPutMetricsError),
    -- | The response's http status code.
    BatchPutMetricsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (BatchPutMetricsResponse -> BatchPutMetricsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BatchPutMetricsResponse -> BatchPutMetricsResponse -> Bool
$c/= :: BatchPutMetricsResponse -> BatchPutMetricsResponse -> Bool
== :: BatchPutMetricsResponse -> BatchPutMetricsResponse -> Bool
$c== :: BatchPutMetricsResponse -> BatchPutMetricsResponse -> Bool
Prelude.Eq, ReadPrec [BatchPutMetricsResponse]
ReadPrec BatchPutMetricsResponse
Int -> ReadS BatchPutMetricsResponse
ReadS [BatchPutMetricsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [BatchPutMetricsResponse]
$creadListPrec :: ReadPrec [BatchPutMetricsResponse]
readPrec :: ReadPrec BatchPutMetricsResponse
$creadPrec :: ReadPrec BatchPutMetricsResponse
readList :: ReadS [BatchPutMetricsResponse]
$creadList :: ReadS [BatchPutMetricsResponse]
readsPrec :: Int -> ReadS BatchPutMetricsResponse
$creadsPrec :: Int -> ReadS BatchPutMetricsResponse
Prelude.Read, Int -> BatchPutMetricsResponse -> ShowS
[BatchPutMetricsResponse] -> ShowS
BatchPutMetricsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [BatchPutMetricsResponse] -> ShowS
$cshowList :: [BatchPutMetricsResponse] -> ShowS
show :: BatchPutMetricsResponse -> String
$cshow :: BatchPutMetricsResponse -> String
showsPrec :: Int -> BatchPutMetricsResponse -> ShowS
$cshowsPrec :: Int -> BatchPutMetricsResponse -> ShowS
Prelude.Show, forall x. Rep BatchPutMetricsResponse x -> BatchPutMetricsResponse
forall x. BatchPutMetricsResponse -> Rep BatchPutMetricsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep BatchPutMetricsResponse x -> BatchPutMetricsResponse
$cfrom :: forall x. BatchPutMetricsResponse -> Rep BatchPutMetricsResponse x
Prelude.Generic)

-- |
-- Create a value of 'BatchPutMetricsResponse' 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:
--
-- 'errors', 'batchPutMetricsResponse_errors' - Lists any errors that occur when inserting metric data.
--
-- 'httpStatus', 'batchPutMetricsResponse_httpStatus' - The response's http status code.
newBatchPutMetricsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  BatchPutMetricsResponse
newBatchPutMetricsResponse :: Int -> BatchPutMetricsResponse
newBatchPutMetricsResponse Int
pHttpStatus_ =
  BatchPutMetricsResponse'
    { $sel:errors:BatchPutMetricsResponse' :: Maybe (NonEmpty BatchPutMetricsError)
errors = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:BatchPutMetricsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Lists any errors that occur when inserting metric data.
batchPutMetricsResponse_errors :: Lens.Lens' BatchPutMetricsResponse (Prelude.Maybe (Prelude.NonEmpty BatchPutMetricsError))
batchPutMetricsResponse_errors :: Lens'
  BatchPutMetricsResponse (Maybe (NonEmpty BatchPutMetricsError))
batchPutMetricsResponse_errors = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BatchPutMetricsResponse' {Maybe (NonEmpty BatchPutMetricsError)
errors :: Maybe (NonEmpty BatchPutMetricsError)
$sel:errors:BatchPutMetricsResponse' :: BatchPutMetricsResponse -> Maybe (NonEmpty BatchPutMetricsError)
errors} -> Maybe (NonEmpty BatchPutMetricsError)
errors) (\s :: BatchPutMetricsResponse
s@BatchPutMetricsResponse' {} Maybe (NonEmpty BatchPutMetricsError)
a -> BatchPutMetricsResponse
s {$sel:errors:BatchPutMetricsResponse' :: Maybe (NonEmpty BatchPutMetricsError)
errors = Maybe (NonEmpty BatchPutMetricsError)
a} :: BatchPutMetricsResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The response's http status code.
batchPutMetricsResponse_httpStatus :: Lens.Lens' BatchPutMetricsResponse Prelude.Int
batchPutMetricsResponse_httpStatus :: Lens' BatchPutMetricsResponse Int
batchPutMetricsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BatchPutMetricsResponse' {Int
httpStatus :: Int
$sel:httpStatus:BatchPutMetricsResponse' :: BatchPutMetricsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: BatchPutMetricsResponse
s@BatchPutMetricsResponse' {} Int
a -> BatchPutMetricsResponse
s {$sel:httpStatus:BatchPutMetricsResponse' :: Int
httpStatus = Int
a} :: BatchPutMetricsResponse)

instance Prelude.NFData BatchPutMetricsResponse where
  rnf :: BatchPutMetricsResponse -> ()
rnf BatchPutMetricsResponse' {Int
Maybe (NonEmpty BatchPutMetricsError)
httpStatus :: Int
errors :: Maybe (NonEmpty BatchPutMetricsError)
$sel:httpStatus:BatchPutMetricsResponse' :: BatchPutMetricsResponse -> Int
$sel:errors:BatchPutMetricsResponse' :: BatchPutMetricsResponse -> Maybe (NonEmpty BatchPutMetricsError)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty BatchPutMetricsError)
errors
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus