Amazonka.Transfer.DeleteAgreement

Delete the agreement that's specified in the provided AgreementId.

Creating a Request

data DeleteAgreement

See: newDeleteAgreement smart constructor.

Constructors

DeleteAgreement'

Fields

• agreementId :: Text

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

• serverId :: Text

  The server identifier associated with the agreement that you are deleting.

Instances

ToJSON DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

Methods

toJSON :: DeleteAgreement -> Value

toEncoding :: DeleteAgreement -> Encoding

toJSONList :: [DeleteAgreement] -> Value

toEncodingList :: [DeleteAgreement] -> Encoding

ToHeaders DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

Methods

toHeaders :: DeleteAgreement -> [Header]

ToPath DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

Methods

toPath :: DeleteAgreement -> ByteString

ToQuery DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

Methods

toQuery :: DeleteAgreement -> QueryString

AWSRequest DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

Associated Types

type AWSResponse DeleteAgreement

Methods

request :: (Service -> Service) -> DeleteAgreement -> Request DeleteAgreement

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteAgreement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteAgreement)))

Generic DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

Associated Types

type Rep DeleteAgreement :: Type -> Type

Methods

from :: DeleteAgreement -> Rep DeleteAgreement x

to :: Rep DeleteAgreement x -> DeleteAgreement

Read DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

Methods

readsPrec :: Int -> ReadS DeleteAgreement

readList :: ReadS [DeleteAgreement]

readPrec :: ReadPrec DeleteAgreement

readListPrec :: ReadPrec [DeleteAgreement]

Show DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

Methods

showsPrec :: Int -> DeleteAgreement -> ShowS

show :: DeleteAgreement -> String

showList :: [DeleteAgreement] -> ShowS

NFData DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

Methods

rnf :: DeleteAgreement -> ()

Eq DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

Methods

(==) :: DeleteAgreement -> DeleteAgreement -> Bool

(/=) :: DeleteAgreement -> DeleteAgreement -> Bool

Hashable DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

Methods

hashWithSalt :: Int -> DeleteAgreement -> Int

hash :: DeleteAgreement -> Int

type AWSResponse DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

type AWSResponse DeleteAgreement = DeleteAgreementResponse

type Rep DeleteAgreement

Defined in Amazonka.Transfer.DeleteAgreement

type Rep DeleteAgreement = D1 ('MetaData "DeleteAgreement" "Amazonka.Transfer.DeleteAgreement" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteAgreement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "agreementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteAgreement

Arguments

:: Text

DeleteAgreement

-> Text

DeleteAgreement

-> DeleteAgreement

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

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

DeleteAgreement, deleteAgreement_serverId - The server identifier associated with the agreement that you are deleting.

Request Lenses

deleteAgreement_agreementId :: Lens' DeleteAgreement Text

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

deleteAgreement_serverId :: Lens' DeleteAgreement Text

The server identifier associated with the agreement that you are deleting.

Destructuring the Response

data DeleteAgreementResponse

See: newDeleteAgreementResponse smart constructor.

Constructors

DeleteAgreementResponse'

Instances

Generic DeleteAgreementResponse

Defined in Amazonka.Transfer.DeleteAgreement

Associated Types

type Rep DeleteAgreementResponse :: Type -> Type

Methods

from :: DeleteAgreementResponse -> Rep DeleteAgreementResponse x

to :: Rep DeleteAgreementResponse x -> DeleteAgreementResponse

Read DeleteAgreementResponse

Defined in Amazonka.Transfer.DeleteAgreement

Methods

readsPrec :: Int -> ReadS DeleteAgreementResponse

readList :: ReadS [DeleteAgreementResponse]

readPrec :: ReadPrec DeleteAgreementResponse

readListPrec :: ReadPrec [DeleteAgreementResponse]

Show DeleteAgreementResponse

Defined in Amazonka.Transfer.DeleteAgreement

Methods

showsPrec :: Int -> DeleteAgreementResponse -> ShowS

show :: DeleteAgreementResponse -> String

showList :: [DeleteAgreementResponse] -> ShowS

NFData DeleteAgreementResponse

Defined in Amazonka.Transfer.DeleteAgreement

Methods

rnf :: DeleteAgreementResponse -> ()

Eq DeleteAgreementResponse

Defined in Amazonka.Transfer.DeleteAgreement

Methods

(==) :: DeleteAgreementResponse -> DeleteAgreementResponse -> Bool

(/=) :: DeleteAgreementResponse -> DeleteAgreementResponse -> Bool

type Rep DeleteAgreementResponse

Defined in Amazonka.Transfer.DeleteAgreement

type Rep DeleteAgreementResponse = D1 ('MetaData "DeleteAgreementResponse" "Amazonka.Transfer.DeleteAgreement" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteAgreementResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteAgreementResponse :: DeleteAgreementResponse

Create a value of DeleteAgreementResponse with all optional fields omitted.

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