{-# 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.Transfer.Types.ListedAgreement
-- 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.Transfer.Types.ListedAgreement 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 Amazonka.Transfer.Types.AgreementStatusType

-- | Describes the properties of an agreement.
--
-- /See:/ 'newListedAgreement' smart constructor.
data ListedAgreement = ListedAgreement'
  { -- | A unique identifier for the agreement. This identifier is returned when
    -- you create an agreement.
    ListedAgreement -> Maybe Text
agreementId :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) of the specified agreement.
    ListedAgreement -> Maybe Text
arn :: Prelude.Maybe Prelude.Text,
    -- | The current description for the agreement. You can change it by calling
    -- the @UpdateAgreement@ operation and providing a new description.
    ListedAgreement -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | A unique identifier for the AS2 local profile.
    ListedAgreement -> Maybe Text
localProfileId :: Prelude.Maybe Prelude.Text,
    -- | A unique identifier for the partner profile.
    ListedAgreement -> Maybe Text
partnerProfileId :: Prelude.Maybe Prelude.Text,
    -- | The unique identifier for the agreement.
    ListedAgreement -> Maybe Text
serverId :: Prelude.Maybe Prelude.Text,
    -- | The agreement can be either @ACTIVE@ or @INACTIVE@.
    ListedAgreement -> Maybe AgreementStatusType
status :: Prelude.Maybe AgreementStatusType
  }
  deriving (ListedAgreement -> ListedAgreement -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListedAgreement -> ListedAgreement -> Bool
$c/= :: ListedAgreement -> ListedAgreement -> Bool
== :: ListedAgreement -> ListedAgreement -> Bool
$c== :: ListedAgreement -> ListedAgreement -> Bool
Prelude.Eq, ReadPrec [ListedAgreement]
ReadPrec ListedAgreement
Int -> ReadS ListedAgreement
ReadS [ListedAgreement]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListedAgreement]
$creadListPrec :: ReadPrec [ListedAgreement]
readPrec :: ReadPrec ListedAgreement
$creadPrec :: ReadPrec ListedAgreement
readList :: ReadS [ListedAgreement]
$creadList :: ReadS [ListedAgreement]
readsPrec :: Int -> ReadS ListedAgreement
$creadsPrec :: Int -> ReadS ListedAgreement
Prelude.Read, Int -> ListedAgreement -> ShowS
[ListedAgreement] -> ShowS
ListedAgreement -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListedAgreement] -> ShowS
$cshowList :: [ListedAgreement] -> ShowS
show :: ListedAgreement -> String
$cshow :: ListedAgreement -> String
showsPrec :: Int -> ListedAgreement -> ShowS
$cshowsPrec :: Int -> ListedAgreement -> ShowS
Prelude.Show, forall x. Rep ListedAgreement x -> ListedAgreement
forall x. ListedAgreement -> Rep ListedAgreement x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListedAgreement x -> ListedAgreement
$cfrom :: forall x. ListedAgreement -> Rep ListedAgreement x
Prelude.Generic)

-- |
-- Create a value of 'ListedAgreement' 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:
--
-- 'agreementId', 'listedAgreement_agreementId' - A unique identifier for the agreement. This identifier is returned when
-- you create an agreement.
--
-- 'arn', 'listedAgreement_arn' - The Amazon Resource Name (ARN) of the specified agreement.
--
-- 'description', 'listedAgreement_description' - The current description for the agreement. You can change it by calling
-- the @UpdateAgreement@ operation and providing a new description.
--
-- 'localProfileId', 'listedAgreement_localProfileId' - A unique identifier for the AS2 local profile.
--
-- 'partnerProfileId', 'listedAgreement_partnerProfileId' - A unique identifier for the partner profile.
--
-- 'serverId', 'listedAgreement_serverId' - The unique identifier for the agreement.
--
-- 'status', 'listedAgreement_status' - The agreement can be either @ACTIVE@ or @INACTIVE@.
newListedAgreement ::
  ListedAgreement
newListedAgreement :: ListedAgreement
newListedAgreement =
  ListedAgreement'
    { $sel:agreementId:ListedAgreement' :: Maybe Text
agreementId = forall a. Maybe a
Prelude.Nothing,
      $sel:arn:ListedAgreement' :: Maybe Text
arn = forall a. Maybe a
Prelude.Nothing,
      $sel:description:ListedAgreement' :: Maybe Text
description = forall a. Maybe a
Prelude.Nothing,
      $sel:localProfileId:ListedAgreement' :: Maybe Text
localProfileId = forall a. Maybe a
Prelude.Nothing,
      $sel:partnerProfileId:ListedAgreement' :: Maybe Text
partnerProfileId = forall a. Maybe a
Prelude.Nothing,
      $sel:serverId:ListedAgreement' :: Maybe Text
serverId = forall a. Maybe a
Prelude.Nothing,
      $sel:status:ListedAgreement' :: Maybe AgreementStatusType
status = forall a. Maybe a
Prelude.Nothing
    }

-- | A unique identifier for the agreement. This identifier is returned when
-- you create an agreement.
listedAgreement_agreementId :: Lens.Lens' ListedAgreement (Prelude.Maybe Prelude.Text)
listedAgreement_agreementId :: Lens' ListedAgreement (Maybe Text)
listedAgreement_agreementId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListedAgreement' {Maybe Text
agreementId :: Maybe Text
$sel:agreementId:ListedAgreement' :: ListedAgreement -> Maybe Text
agreementId} -> Maybe Text
agreementId) (\s :: ListedAgreement
s@ListedAgreement' {} Maybe Text
a -> ListedAgreement
s {$sel:agreementId:ListedAgreement' :: Maybe Text
agreementId = Maybe Text
a} :: ListedAgreement)

-- | The Amazon Resource Name (ARN) of the specified agreement.
listedAgreement_arn :: Lens.Lens' ListedAgreement (Prelude.Maybe Prelude.Text)
listedAgreement_arn :: Lens' ListedAgreement (Maybe Text)
listedAgreement_arn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListedAgreement' {Maybe Text
arn :: Maybe Text
$sel:arn:ListedAgreement' :: ListedAgreement -> Maybe Text
arn} -> Maybe Text
arn) (\s :: ListedAgreement
s@ListedAgreement' {} Maybe Text
a -> ListedAgreement
s {$sel:arn:ListedAgreement' :: Maybe Text
arn = Maybe Text
a} :: ListedAgreement)

-- | The current description for the agreement. You can change it by calling
-- the @UpdateAgreement@ operation and providing a new description.
listedAgreement_description :: Lens.Lens' ListedAgreement (Prelude.Maybe Prelude.Text)
listedAgreement_description :: Lens' ListedAgreement (Maybe Text)
listedAgreement_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListedAgreement' {Maybe Text
description :: Maybe Text
$sel:description:ListedAgreement' :: ListedAgreement -> Maybe Text
description} -> Maybe Text
description) (\s :: ListedAgreement
s@ListedAgreement' {} Maybe Text
a -> ListedAgreement
s {$sel:description:ListedAgreement' :: Maybe Text
description = Maybe Text
a} :: ListedAgreement)

-- | A unique identifier for the AS2 local profile.
listedAgreement_localProfileId :: Lens.Lens' ListedAgreement (Prelude.Maybe Prelude.Text)
listedAgreement_localProfileId :: Lens' ListedAgreement (Maybe Text)
listedAgreement_localProfileId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListedAgreement' {Maybe Text
localProfileId :: Maybe Text
$sel:localProfileId:ListedAgreement' :: ListedAgreement -> Maybe Text
localProfileId} -> Maybe Text
localProfileId) (\s :: ListedAgreement
s@ListedAgreement' {} Maybe Text
a -> ListedAgreement
s {$sel:localProfileId:ListedAgreement' :: Maybe Text
localProfileId = Maybe Text
a} :: ListedAgreement)

-- | A unique identifier for the partner profile.
listedAgreement_partnerProfileId :: Lens.Lens' ListedAgreement (Prelude.Maybe Prelude.Text)
listedAgreement_partnerProfileId :: Lens' ListedAgreement (Maybe Text)
listedAgreement_partnerProfileId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListedAgreement' {Maybe Text
partnerProfileId :: Maybe Text
$sel:partnerProfileId:ListedAgreement' :: ListedAgreement -> Maybe Text
partnerProfileId} -> Maybe Text
partnerProfileId) (\s :: ListedAgreement
s@ListedAgreement' {} Maybe Text
a -> ListedAgreement
s {$sel:partnerProfileId:ListedAgreement' :: Maybe Text
partnerProfileId = Maybe Text
a} :: ListedAgreement)

-- | The unique identifier for the agreement.
listedAgreement_serverId :: Lens.Lens' ListedAgreement (Prelude.Maybe Prelude.Text)
listedAgreement_serverId :: Lens' ListedAgreement (Maybe Text)
listedAgreement_serverId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListedAgreement' {Maybe Text
serverId :: Maybe Text
$sel:serverId:ListedAgreement' :: ListedAgreement -> Maybe Text
serverId} -> Maybe Text
serverId) (\s :: ListedAgreement
s@ListedAgreement' {} Maybe Text
a -> ListedAgreement
s {$sel:serverId:ListedAgreement' :: Maybe Text
serverId = Maybe Text
a} :: ListedAgreement)

-- | The agreement can be either @ACTIVE@ or @INACTIVE@.
listedAgreement_status :: Lens.Lens' ListedAgreement (Prelude.Maybe AgreementStatusType)
listedAgreement_status :: Lens' ListedAgreement (Maybe AgreementStatusType)
listedAgreement_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListedAgreement' {Maybe AgreementStatusType
status :: Maybe AgreementStatusType
$sel:status:ListedAgreement' :: ListedAgreement -> Maybe AgreementStatusType
status} -> Maybe AgreementStatusType
status) (\s :: ListedAgreement
s@ListedAgreement' {} Maybe AgreementStatusType
a -> ListedAgreement
s {$sel:status:ListedAgreement' :: Maybe AgreementStatusType
status = Maybe AgreementStatusType
a} :: ListedAgreement)

instance Data.FromJSON ListedAgreement where
  parseJSON :: Value -> Parser ListedAgreement
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ListedAgreement"
      ( \Object
x ->
          Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe AgreementStatusType
-> ListedAgreement
ListedAgreement'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"AgreementId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Arn")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Description")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"LocalProfileId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"PartnerProfileId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ServerId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Status")
      )

instance Prelude.Hashable ListedAgreement where
  hashWithSalt :: Int -> ListedAgreement -> Int
hashWithSalt Int
_salt ListedAgreement' {Maybe Text
Maybe AgreementStatusType
status :: Maybe AgreementStatusType
serverId :: Maybe Text
partnerProfileId :: Maybe Text
localProfileId :: Maybe Text
description :: Maybe Text
arn :: Maybe Text
agreementId :: Maybe Text
$sel:status:ListedAgreement' :: ListedAgreement -> Maybe AgreementStatusType
$sel:serverId:ListedAgreement' :: ListedAgreement -> Maybe Text
$sel:partnerProfileId:ListedAgreement' :: ListedAgreement -> Maybe Text
$sel:localProfileId:ListedAgreement' :: ListedAgreement -> Maybe Text
$sel:description:ListedAgreement' :: ListedAgreement -> Maybe Text
$sel:arn:ListedAgreement' :: ListedAgreement -> Maybe Text
$sel:agreementId:ListedAgreement' :: ListedAgreement -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
agreementId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
arn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
description
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
localProfileId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
partnerProfileId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
serverId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe AgreementStatusType
status

instance Prelude.NFData ListedAgreement where
  rnf :: ListedAgreement -> ()
rnf ListedAgreement' {Maybe Text
Maybe AgreementStatusType
status :: Maybe AgreementStatusType
serverId :: Maybe Text
partnerProfileId :: Maybe Text
localProfileId :: Maybe Text
description :: Maybe Text
arn :: Maybe Text
agreementId :: Maybe Text
$sel:status:ListedAgreement' :: ListedAgreement -> Maybe AgreementStatusType
$sel:serverId:ListedAgreement' :: ListedAgreement -> Maybe Text
$sel:partnerProfileId:ListedAgreement' :: ListedAgreement -> Maybe Text
$sel:localProfileId:ListedAgreement' :: ListedAgreement -> Maybe Text
$sel:description:ListedAgreement' :: ListedAgreement -> Maybe Text
$sel:arn:ListedAgreement' :: ListedAgreement -> Maybe Text
$sel:agreementId:ListedAgreement' :: ListedAgreement -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
agreementId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
arn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
description
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
localProfileId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
partnerProfileId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
serverId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe AgreementStatusType
status