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.DescribeAgreement

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the agreement that's identified by the AgreementId.

Creating a Request

data DescribeAgreement Source #

See: newDescribeAgreement smart constructor.

Constructors

DescribeAgreement'
Fields agreementId :: Text A unique identifier for the agreement. This identifier is returned when you create an agreement. serverId :: Text The server identifier that's associated with the agreement.

Instances

Instances details

ToJSON DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods toJSON :: DescribeAgreement -> Value # toEncoding :: DescribeAgreement -> Encoding # toJSONList :: [DescribeAgreement] -> Value # toEncodingList :: [DescribeAgreement] -> Encoding #
ToHeaders DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods toHeaders :: DescribeAgreement -> [Header] #
ToPath DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods toPath :: DescribeAgreement -> ByteString #
ToQuery DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods toQuery :: DescribeAgreement -> QueryString #
AWSRequest DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Associated Types type AWSResponse DescribeAgreement # Methods request :: (Service -> Service) -> DescribeAgreement -> Request DescribeAgreement # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeAgreement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAgreement))) #
Generic DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Associated Types type Rep DescribeAgreement :: Type -> Type # Methods from :: DescribeAgreement -> Rep DescribeAgreement x # to :: Rep DescribeAgreement x -> DescribeAgreement #
Read DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods readsPrec :: Int -> ReadS DescribeAgreement # readList :: ReadS [DescribeAgreement] # readPrec :: ReadPrec DescribeAgreement # readListPrec :: ReadPrec [DescribeAgreement] #
Show DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods showsPrec :: Int -> DescribeAgreement -> ShowS # show :: DescribeAgreement -> String # showList :: [DescribeAgreement] -> ShowS #
NFData DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods rnf :: DescribeAgreement -> () #
Eq DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods (==) :: DescribeAgreement -> DescribeAgreement -> Bool # (/=) :: DescribeAgreement -> DescribeAgreement -> Bool #
Hashable DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods hashWithSalt :: Int -> DescribeAgreement -> Int # hash :: DescribeAgreement -> Int #
type AWSResponse DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement type AWSResponse DescribeAgreement = DescribeAgreementResponse
type Rep DescribeAgreement Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement type Rep DescribeAgreement = D1 ('MetaData "DescribeAgreement" "Amazonka.Transfer.DescribeAgreement" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeAgreement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "agreementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeAgreement Source #

Arguments

:: Text	`DescribeAgreement`
-> Text	`DescribeAgreement`
-> DescribeAgreement

Create a value of DescribeAgreement 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:

DescribeAgreement, describeAgreement_agreementId - A unique identifier for the agreement. This identifier is returned when you create an agreement.

DescribeAgreement, describeAgreement_serverId - The server identifier that's associated with the agreement.

Request Lenses

describeAgreement_agreementId :: Lens' DescribeAgreement Text Source #

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

describeAgreement_serverId :: Lens' DescribeAgreement Text Source #

The server identifier that's associated with the agreement.

Destructuring the Response

data DescribeAgreementResponse Source #

See: newDescribeAgreementResponse smart constructor.

Constructors

DescribeAgreementResponse'
Fields httpStatus :: Int The response's http status code. agreement :: DescribedAgreement The details for the specified agreement, returned as a `DescribedAgreement` object.

Instances

Instances details

Generic DescribeAgreementResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Associated Types type Rep DescribeAgreementResponse :: Type -> Type # Methods from :: DescribeAgreementResponse -> Rep DescribeAgreementResponse x # to :: Rep DescribeAgreementResponse x -> DescribeAgreementResponse #
Read DescribeAgreementResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods readsPrec :: Int -> ReadS DescribeAgreementResponse # readList :: ReadS [DescribeAgreementResponse] # readPrec :: ReadPrec DescribeAgreementResponse # readListPrec :: ReadPrec [DescribeAgreementResponse] #
Show DescribeAgreementResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods showsPrec :: Int -> DescribeAgreementResponse -> ShowS # show :: DescribeAgreementResponse -> String # showList :: [DescribeAgreementResponse] -> ShowS #
NFData DescribeAgreementResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods rnf :: DescribeAgreementResponse -> () #
Eq DescribeAgreementResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement Methods (==) :: DescribeAgreementResponse -> DescribeAgreementResponse -> Bool # (/=) :: DescribeAgreementResponse -> DescribeAgreementResponse -> Bool #
type Rep DescribeAgreementResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAgreement type Rep DescribeAgreementResponse = D1 ('MetaData "DescribeAgreementResponse" "Amazonka.Transfer.DescribeAgreement" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeAgreementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "agreement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedAgreement)))

newDescribeAgreementResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAgreementResponse'`
-> DescribedAgreement	`$sel:agreement:DescribeAgreementResponse'`
-> DescribeAgreementResponse

Create a value of DescribeAgreementResponse 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:httpStatus:DescribeAgreementResponse', describeAgreementResponse_httpStatus - The response's http status code.

$sel:agreement:DescribeAgreementResponse', describeAgreementResponse_agreement - The details for the specified agreement, returned as a DescribedAgreement object.

Response Lenses

describeAgreementResponse_httpStatus :: Lens' DescribeAgreementResponse Int Source #

The response's http status code.

describeAgreementResponse_agreement :: Lens' DescribeAgreementResponse DescribedAgreement Source #

The details for the specified agreement, returned as a DescribedAgreement object.