{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Rekognition.Types.StartShotDetectionFilter
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Rekognition.Types.StartShotDetectionFilter 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

-- | Filters for the shot detection segments returned by
-- @GetSegmentDetection@. For more information, see
-- StartSegmentDetectionFilters.
--
-- /See:/ 'newStartShotDetectionFilter' smart constructor.
data StartShotDetectionFilter = StartShotDetectionFilter'
  { -- | Specifies the minimum confidence that Amazon Rekognition Video must have
    -- in order to return a detected segment. Confidence represents how certain
    -- Amazon Rekognition is that a segment is correctly identified. 0 is the
    -- lowest confidence. 100 is the highest confidence. Amazon Rekognition
    -- Video doesn\'t return any segments with a confidence level lower than
    -- this specified value.
    --
    -- If you don\'t specify @MinSegmentConfidence@, the @GetSegmentDetection@
    -- returns segments with confidence values greater than or equal to 50
    -- percent.
    minSegmentConfidence :: Prelude.Maybe Prelude.Double
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'StartShotDetectionFilter' 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:
--
-- 'minSegmentConfidence', 'startShotDetectionFilter_minSegmentConfidence' - Specifies the minimum confidence that Amazon Rekognition Video must have
-- in order to return a detected segment. Confidence represents how certain
-- Amazon Rekognition is that a segment is correctly identified. 0 is the
-- lowest confidence. 100 is the highest confidence. Amazon Rekognition
-- Video doesn\'t return any segments with a confidence level lower than
-- this specified value.
--
-- If you don\'t specify @MinSegmentConfidence@, the @GetSegmentDetection@
-- returns segments with confidence values greater than or equal to 50
-- percent.
newStartShotDetectionFilter ::
  StartShotDetectionFilter
newStartShotDetectionFilter =
  StartShotDetectionFilter'
    { minSegmentConfidence =
        Prelude.Nothing
    }

-- | Specifies the minimum confidence that Amazon Rekognition Video must have
-- in order to return a detected segment. Confidence represents how certain
-- Amazon Rekognition is that a segment is correctly identified. 0 is the
-- lowest confidence. 100 is the highest confidence. Amazon Rekognition
-- Video doesn\'t return any segments with a confidence level lower than
-- this specified value.
--
-- If you don\'t specify @MinSegmentConfidence@, the @GetSegmentDetection@
-- returns segments with confidence values greater than or equal to 50
-- percent.
startShotDetectionFilter_minSegmentConfidence :: Lens.Lens' StartShotDetectionFilter (Prelude.Maybe Prelude.Double)
startShotDetectionFilter_minSegmentConfidence = Lens.lens (\StartShotDetectionFilter' {minSegmentConfidence} -> minSegmentConfidence) (\s@StartShotDetectionFilter' {} a -> s {minSegmentConfidence = a} :: StartShotDetectionFilter)

instance Prelude.Hashable StartShotDetectionFilter where
  hashWithSalt _salt StartShotDetectionFilter' {..} =
    _salt `Prelude.hashWithSalt` minSegmentConfidence

instance Prelude.NFData StartShotDetectionFilter where
  rnf StartShotDetectionFilter' {..} =
    Prelude.rnf minSegmentConfidence

instance Data.ToJSON StartShotDetectionFilter where
  toJSON StartShotDetectionFilter' {..} =
    Data.object
      ( Prelude.catMaybes
          [ ("MinSegmentConfidence" Data..=)
              Prelude.<$> minSegmentConfidence
          ]
      )