Copyright | (c) 2013-2016 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 |
Executes commands on one or more remote instances.
- sendCommand :: NonEmpty Text -> Text -> SendCommand
- data SendCommand
- scServiceRoleARN :: Lens' SendCommand (Maybe Text)
- scNotificationConfig :: Lens' SendCommand (Maybe NotificationConfig)
- scDocumentHashType :: Lens' SendCommand (Maybe DocumentHashType)
- scOutputS3KeyPrefix :: Lens' SendCommand (Maybe Text)
- scParameters :: Lens' SendCommand (HashMap Text [Text])
- scDocumentHash :: Lens' SendCommand (Maybe 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
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.
Request Lenses
scServiceRoleARN :: Lens' SendCommand (Maybe Text) Source #
The IAM role that SSM uses to send notifications.
scNotificationConfig :: Lens' SendCommand (Maybe NotificationConfig) Source #
Configurations for sending notifications.
scDocumentHashType :: Lens' SendCommand (Maybe DocumentHashType) Source #
Sha256 or Sha1.
Sha1 hashes have been deprecated.
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.
scDocumentHash :: Lens' SendCommand (Maybe Text) Source #
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
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. You can specify a maximum of 50 IDs.
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
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.