| 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.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
- data CancelCommand = CancelCommand' {
- instanceIds :: Maybe [Text]
- commandId :: Text
- newCancelCommand :: Text -> CancelCommand
- cancelCommand_instanceIds :: Lens' CancelCommand (Maybe [Text])
- cancelCommand_commandId :: Lens' CancelCommand Text
- data CancelCommandResponse = CancelCommandResponse' {
- httpStatus :: Int
- newCancelCommandResponse :: Int -> CancelCommandResponse
- cancelCommandResponse_httpStatus :: Lens' CancelCommandResponse Int
Creating a Request
data CancelCommand Source #
See: newCancelCommand smart constructor.
Constructors
| CancelCommand' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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:
CancelCommand, cancelCommand_instanceIds - (Optional) A list of managed node IDs on which you want to cancel the
command. If not provided, the command is canceled on every node on which
it was requested.
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 managed node IDs on which you want to cancel the command. If not provided, the command is canceled on every node 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
newCancelCommandResponse Source #
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.