Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DataSync.DeleteAgent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.

Synopsis

data DeleteAgent = DeleteAgent' {
- agentArn :: Text
}
newDeleteAgent :: Text -> DeleteAgent
deleteAgent_agentArn :: Lens' DeleteAgent Text
data DeleteAgentResponse = DeleteAgentResponse' {
- httpStatus :: Int
}
newDeleteAgentResponse :: Int -> DeleteAgentResponse
deleteAgentResponse_httpStatus :: Lens' DeleteAgentResponse Int

Creating a Request

data DeleteAgent Source #

DeleteAgentRequest

See: newDeleteAgent smart constructor.

Constructors

DeleteAgent'
Fields agentArn :: Text The Amazon Resource Name (ARN) of the agent to delete. Use the `ListAgents` operation to return a list of agents for your account and Amazon Web Services Region.

Instances

Instances details

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

newDeleteAgent Source #

Arguments

:: Text	`$sel:agentArn:DeleteAgent'`
-> DeleteAgent

Create a value of DeleteAgent 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:agentArn:DeleteAgent', deleteAgent_agentArn - The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list of agents for your account and Amazon Web Services Region.

Request Lenses

deleteAgent_agentArn :: Lens' DeleteAgent Text Source #

The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list of agents for your account and Amazon Web Services Region.

Destructuring the Response

data DeleteAgentResponse Source #

See: newDeleteAgentResponse smart constructor.

Constructors

DeleteAgentResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DeleteAgentResponse Source #
Instance details Defined in Amazonka.DataSync.DeleteAgent Methods (==) :: DeleteAgentResponse -> DeleteAgentResponse -> Bool # (/=) :: DeleteAgentResponse -> DeleteAgentResponse -> Bool #
Read DeleteAgentResponse Source #
Instance details Defined in Amazonka.DataSync.DeleteAgent Methods readsPrec :: Int -> ReadS DeleteAgentResponse # readList :: ReadS [DeleteAgentResponse] # readPrec :: ReadPrec DeleteAgentResponse # readListPrec :: ReadPrec [DeleteAgentResponse] #
Show DeleteAgentResponse Source #
Instance details Defined in Amazonka.DataSync.DeleteAgent Methods showsPrec :: Int -> DeleteAgentResponse -> ShowS # show :: DeleteAgentResponse -> String # showList :: [DeleteAgentResponse] -> ShowS #
Generic DeleteAgentResponse Source #
Instance details Defined in Amazonka.DataSync.DeleteAgent Associated Types type Rep DeleteAgentResponse :: Type -> Type # Methods from :: DeleteAgentResponse -> Rep DeleteAgentResponse x # to :: Rep DeleteAgentResponse x -> DeleteAgentResponse #
NFData DeleteAgentResponse Source #
Instance details Defined in Amazonka.DataSync.DeleteAgent Methods rnf :: DeleteAgentResponse -> () #
type Rep DeleteAgentResponse Source #
Instance details Defined in Amazonka.DataSync.DeleteAgent type Rep DeleteAgentResponse = D1 ('MetaData "DeleteAgentResponse" "Amazonka.DataSync.DeleteAgent" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "DeleteAgentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteAgentResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteAgentResponse'`
-> DeleteAgentResponse

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

Response Lenses

deleteAgentResponse_httpStatus :: Lens' DeleteAgentResponse Int Source #

The response's http status code.