libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.CancelCommand

Description

Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

Synopsis

Creating a Request

data CancelCommand Source #

See: newCancelCommand smart constructor.

Constructors

CancelCommand' 

Fields

  • instanceIds :: Maybe [Text]

    (Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.

  • commandId :: Text

    The ID of the command you want to cancel.

Instances

Instances details
Eq CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

(==) :: CancelCommand -> CancelCommand -> Bool #

(/=) :: CancelCommand -> CancelCommand -> Bool #

Read CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

readsPrec :: Int -> ReadS CancelCommand #

readList :: ReadS [CancelCommand] #

readPrec :: ReadPrec CancelCommand #

readListPrec :: ReadPrec [CancelCommand] #

Show CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

showsPrec :: Int -> CancelCommand -> ShowS #

show :: CancelCommand -> String #

showList :: [CancelCommand] -> ShowS #

Generic CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Associated Types

type Rep CancelCommand :: Type -> Type #

Methods

from :: CancelCommand -> Rep CancelCommand x #

to :: Rep CancelCommand x -> CancelCommand #

NFData CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

rnf :: CancelCommand -> () #

Hashable CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

hashWithSalt :: Int -> CancelCommand -> Int #

hash :: CancelCommand -> Int #

ToJSON CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

toJSON :: CancelCommand -> Value #

toEncoding :: CancelCommand -> Encoding #

toJSONList :: [CancelCommand] -> Value #

toEncodingList :: [CancelCommand] -> Encoding #

AWSRequest CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Associated Types

type AWSResponse CancelCommand #

Methods

request :: CancelCommand -> Request CancelCommand #

response :: MonadResource m => Logger -> Service -> Proxy CancelCommand -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CancelCommand))) #

ToHeaders CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

toHeaders :: CancelCommand -> [Header] #

ToPath CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

toPath :: CancelCommand -> ByteString #

ToQuery CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

toQuery :: CancelCommand -> QueryString #

type Rep CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

type Rep CancelCommand = D1 ('MetaData "CancelCommand" "Amazonka.SSM.CancelCommand" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "CancelCommand'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "commandId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CancelCommand Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

type AWSResponse CancelCommand = CancelCommandResponse

newCancelCommand Source #

Arguments

:: Text

$sel:commandId:CancelCommand'

-> CancelCommand 

Create a value of CancelCommand 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:instanceIds:CancelCommand', cancelCommand_instanceIds - (Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.

$sel:commandId:CancelCommand', cancelCommand_commandId - The ID of the command you want to cancel.

Request Lenses

cancelCommand_instanceIds :: Lens' CancelCommand (Maybe [Text]) Source #

(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.

cancelCommand_commandId :: Lens' CancelCommand Text Source #

The ID of the command you want to cancel.

Destructuring the Response

data CancelCommandResponse Source #

Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.

See: newCancelCommandResponse smart constructor.

Constructors

CancelCommandResponse' 

Fields

Instances

Instances details
Eq CancelCommandResponse Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

(==) :: CancelCommandResponse -> CancelCommandResponse -> Bool #

(/=) :: CancelCommandResponse -> CancelCommandResponse -> Bool #

Read CancelCommandResponse Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

readsPrec :: Int -> ReadS CancelCommandResponse #

readList :: ReadS [CancelCommandResponse] #

readPrec :: ReadPrec CancelCommandResponse #

readListPrec :: ReadPrec [CancelCommandResponse] #

Show CancelCommandResponse Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

showsPrec :: Int -> CancelCommandResponse -> ShowS #

show :: CancelCommandResponse -> String #

showList :: [CancelCommandResponse] -> ShowS #

Generic CancelCommandResponse Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Associated Types

type Rep CancelCommandResponse :: Type -> Type #

Methods

from :: CancelCommandResponse -> Rep CancelCommandResponse x #

to :: Rep CancelCommandResponse x -> CancelCommandResponse #

NFData CancelCommandResponse Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

Methods

rnf :: CancelCommandResponse -> () #

type Rep CancelCommandResponse Source # 
Instance details

Defined in Amazonka.SSM.CancelCommand

type Rep CancelCommandResponse = D1 ('MetaData "CancelCommandResponse" "Amazonka.SSM.CancelCommand" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "CancelCommandResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelCommandResponse Source #

Arguments

:: Int

$sel:httpStatus:CancelCommandResponse'

-> CancelCommandResponse 

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

Response Lenses

cancelCommandResponse_httpStatus :: Lens' CancelCommandResponse Int Source #

The response's http status code.