Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Transfer.Types.ListedAgreement

Description

Documentation

data ListedAgreement Source #

Describes the properties of an agreement.

See: newListedAgreement smart constructor.

Constructors

ListedAgreement'

Fields

agreementId :: Maybe Text
A unique identifier for the agreement. This identifier is returned when you create an agreement.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the specified agreement.
description :: Maybe Text
The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.
localProfileId :: Maybe Text
A unique identifier for the AS2 local profile.
partnerProfileId :: Maybe Text
A unique identifier for the partner profile.
serverId :: Maybe Text
The unique identifier for the agreement.
status :: Maybe AgreementStatusType
The agreement can be either ACTIVE or INACTIVE.

Instances

Instances details

FromJSON ListedAgreement Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAgreement Methods parseJSON :: Value -> Parser ListedAgreement # parseJSONList :: Value -> Parser [ListedAgreement] #
Generic ListedAgreement Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAgreement Associated Types type Rep ListedAgreement :: Type -> Type # Methods from :: ListedAgreement -> Rep ListedAgreement x # to :: Rep ListedAgreement x -> ListedAgreement #
Read ListedAgreement Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAgreement Methods readsPrec :: Int -> ReadS ListedAgreement # readList :: ReadS [ListedAgreement] # readPrec :: ReadPrec ListedAgreement # readListPrec :: ReadPrec [ListedAgreement] #
Show ListedAgreement Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAgreement Methods showsPrec :: Int -> ListedAgreement -> ShowS # show :: ListedAgreement -> String # showList :: [ListedAgreement] -> ShowS #
NFData ListedAgreement Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAgreement Methods rnf :: ListedAgreement -> () #
Eq ListedAgreement Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAgreement Methods (==) :: ListedAgreement -> ListedAgreement -> Bool # (/=) :: ListedAgreement -> ListedAgreement -> Bool #
Hashable ListedAgreement Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAgreement Methods hashWithSalt :: Int -> ListedAgreement -> Int # hash :: ListedAgreement -> Int #
type Rep ListedAgreement Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAgreement type Rep ListedAgreement = D1 ('MetaData "ListedAgreement" "Amazonka.Transfer.Types.ListedAgreement" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListedAgreement'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "agreementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "localProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "partnerProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AgreementStatusType))))))

newListedAgreement :: ListedAgreement Source #

Create a value of ListedAgreement with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:agreementId:ListedAgreement', listedAgreement_agreementId - A unique identifier for the agreement. This identifier is returned when you create an agreement.

$sel:arn:ListedAgreement', listedAgreement_arn - The Amazon Resource Name (ARN) of the specified agreement.

$sel:description:ListedAgreement', listedAgreement_description - The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.

$sel:localProfileId:ListedAgreement', listedAgreement_localProfileId - A unique identifier for the AS2 local profile.

$sel:partnerProfileId:ListedAgreement', listedAgreement_partnerProfileId - A unique identifier for the partner profile.

$sel:serverId:ListedAgreement', listedAgreement_serverId - The unique identifier for the agreement.

$sel:status:ListedAgreement', listedAgreement_status - The agreement can be either ACTIVE or INACTIVE.

listedAgreement_agreementId :: Lens' ListedAgreement (Maybe Text) Source #

A unique identifier for the agreement. This identifier is returned when you create an agreement.

listedAgreement_arn :: Lens' ListedAgreement (Maybe Text) Source #

The Amazon Resource Name (ARN) of the specified agreement.

listedAgreement_description :: Lens' ListedAgreement (Maybe Text) Source #

The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.

listedAgreement_localProfileId :: Lens' ListedAgreement (Maybe Text) Source #

A unique identifier for the AS2 local profile.

listedAgreement_partnerProfileId :: Lens' ListedAgreement (Maybe Text) Source #

A unique identifier for the partner profile.

listedAgreement_serverId :: Lens' ListedAgreement (Maybe Text) Source #

The unique identifier for the agreement.

listedAgreement_status :: Lens' ListedAgreement (Maybe AgreementStatusType) Source #

The agreement can be either ACTIVE or INACTIVE.