| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.SSM.SendCommand
Description
Executes commands on one or more remote instances.
See: AWS API Reference for SendCommand.
- sendCommand :: NonEmpty Text -> Text -> SendCommand
- data SendCommand
- scOutputS3KeyPrefix :: Lens' SendCommand (Maybe Text)
- scParameters :: Lens' SendCommand (HashMap Text [Text])
- scTimeoutSeconds :: Lens' SendCommand (Maybe Natural)
- scComment :: Lens' SendCommand (Maybe Text)
- scOutputS3BucketName :: Lens' SendCommand (Maybe Text)
- scInstanceIds :: Lens' SendCommand (NonEmpty Text)
- scDocumentName :: Lens' SendCommand Text
- sendCommandResponse :: Int -> SendCommandResponse
- data SendCommandResponse
- scrsCommand :: Lens' SendCommandResponse (Maybe Command)
- scrsResponseStatus :: Lens' SendCommandResponse Int
Creating a Request
Arguments
| :: NonEmpty Text | |
| -> Text | |
| -> SendCommand |
Creates a value of SendCommand with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data SendCommand Source
See: sendCommand smart constructor.
Instances
Request Lenses
scOutputS3KeyPrefix :: Lens' SendCommand (Maybe Text) Source
The directory structure within the S3 bucket where the responses should be stored.
scParameters :: Lens' SendCommand (HashMap Text [Text]) Source
The required and optional parameters specified in the SSM document being executed.
scTimeoutSeconds :: Lens' SendCommand (Maybe Natural) Source
If this time is reached and the command has not already started executing, it will not execute.
scComment :: Lens' SendCommand (Maybe Text) Source
User-specified information about the command, such as a brief description of what the command should do.
scOutputS3BucketName :: Lens' SendCommand (Maybe Text) Source
The name of the S3 bucket where command execution responses should be stored.
scInstanceIds :: Lens' SendCommand (NonEmpty Text) Source
Required. The instance IDs where the command should execute.
scDocumentName :: Lens' SendCommand Text Source
Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
Destructuring the Response
Arguments
| :: Int | |
| -> SendCommandResponse |
Creates a value of SendCommandResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data SendCommandResponse Source
See: sendCommandResponse smart constructor.
Response Lenses
scrsCommand :: Lens' SendCommandResponse (Maybe Command) Source
The request as it was received by SSM. Also provides the command ID which can be used future references to this request.
scrsResponseStatus :: Lens' SendCommandResponse Int Source
The response status code.