Network.AWS.SSM.SendCommand

Executes commands on one or more remote instances.

Creating a Request

sendCommand

Arguments

:: Text

scDocumentName

-> 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:

• scServiceRoleARN - The IAM role that Systems Manager uses to send notifications.
• scNotificationConfig - Configurations for sending notifications.
• scDocumentHashType - Sha256 or Sha1.
• scOutputS3KeyPrefix - The directory structure within the S3 bucket where the responses should be stored.
• scMaxErrors - The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors , the systems stops sending the command to additional targets. You can specify a number like “10” or a percentage like “10%”. The default value is 50. For more information about how to use MaxErrors , see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
• scInstanceIds - Required. The instance IDs where the command should execute. You can specify a maximum of 50 IDs.
• scOutputS3Region - (Optional) The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.
• scTargets - (Optional) An array of search criteria that targets instances using a Key ;Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets , see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
• scParameters - The required and optional parameters specified in the SSM document being executed.
• scDocumentHash - The Sha256 or Sha1 hash created by the system when the document was created.
• scTimeoutSeconds - If this time is reached and the command has not already started executing, it will not execute.
• scComment - User-specified information about the command, such as a brief description of what the command should do.
• scOutputS3BucketName - The name of the S3 bucket where command execution responses should be stored.
• scMaxConcurrency - (Optional) The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as “10” or a percentage such as “10%”. The default value is 50. For more information about how to use MaxConcurrency , see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
• scDocumentName - Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.

data SendCommand

See: sendCommand smart constructor.

Instances

Eq SendCommand

Methods

(==) :: SendCommand -> SendCommand -> Bool

(/=) :: SendCommand -> SendCommand -> Bool

Data SendCommand

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SendCommand -> c SendCommand

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SendCommand

toConstr :: SendCommand -> Constr

dataTypeOf :: SendCommand -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SendCommand)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SendCommand)

gmapT :: (forall b. Data b => b -> b) -> SendCommand -> SendCommand

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SendCommand -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SendCommand -> r

gmapQ :: (forall d. Data d => d -> u) -> SendCommand -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SendCommand -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SendCommand -> m SendCommand

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SendCommand -> m SendCommand

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SendCommand -> m SendCommand

Read SendCommand

Methods

readsPrec :: Int -> ReadS SendCommand

readList :: ReadS [SendCommand]

readPrec :: ReadPrec SendCommand

readListPrec :: ReadPrec [SendCommand]

Show SendCommand

Methods

showsPrec :: Int -> SendCommand -> ShowS

show :: SendCommand -> String

showList :: [SendCommand] -> ShowS

Generic SendCommand

Associated Types

type Rep SendCommand :: * -> *

Methods

from :: SendCommand -> Rep SendCommand x

to :: Rep SendCommand x -> SendCommand

Hashable SendCommand

Methods

hashWithSalt :: Int -> SendCommand -> Int

hash :: SendCommand -> Int

ToJSON SendCommand

Methods

toJSON :: SendCommand -> Value

toEncoding :: SendCommand -> Encoding

toJSONList :: [SendCommand] -> Value

toEncodingList :: [SendCommand] -> Encoding

NFData SendCommand

Methods

rnf :: SendCommand -> ()

AWSRequest SendCommand

Associated Types

type Rs SendCommand :: *

Methods

request :: SendCommand -> Request SendCommand

response :: MonadResource m => Logger -> Service -> Proxy * SendCommand -> ClientResponse -> m (Response SendCommand)

ToPath SendCommand

Methods

toPath :: SendCommand -> ByteString

ToHeaders SendCommand

Methods

toHeaders :: SendCommand -> [Header]

ToQuery SendCommand

Methods

toQuery :: SendCommand -> QueryString

type Rep SendCommand

type Rep SendCommand = D1 (MetaData "SendCommand" "Network.AWS.SSM.SendCommand" "amazonka-ssm-1.4.5-B1a5iPTYqlbHaMCHVQ4GNL" False) (C1 (MetaCons "SendCommand'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_scServiceRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_scNotificationConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe NotificationConfig))) (S1 (MetaSel (Just Symbol "_scDocumentHashType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DocumentHashType))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_scOutputS3KeyPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_scMaxErrors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_scInstanceIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_scOutputS3Region") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_scTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Target]))) (S1 (MetaSel (Just Symbol "_scParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text [Text]))))) ((:*:) (S1 (MetaSel (Just Symbol "_scDocumentHash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_scTimeoutSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_scComment") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_scOutputS3BucketName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_scMaxConcurrency") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_scDocumentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs SendCommand

type Rs SendCommand = SendCommandResponse

Request Lenses

scServiceRoleARN :: Lens' SendCommand (Maybe Text)

The IAM role that Systems Manager uses to send notifications.

scNotificationConfig :: Lens' SendCommand (Maybe NotificationConfig)

Configurations for sending notifications.

scDocumentHashType :: Lens' SendCommand (Maybe DocumentHashType)

Sha256 or Sha1.

scOutputS3KeyPrefix :: Lens' SendCommand (Maybe Text)

The directory structure within the S3 bucket where the responses should be stored.

scMaxErrors :: Lens' SendCommand (Maybe Text)

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors , the systems stops sending the command to additional targets. You can specify a number like “10” or a percentage like “10%”. The default value is 50. For more information about how to use MaxErrors , see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

scInstanceIds :: Lens' SendCommand [Text]

Required. The instance IDs where the command should execute. You can specify a maximum of 50 IDs.

scOutputS3Region :: Lens' SendCommand (Maybe Text)

(Optional) The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.

scTargets :: Lens' SendCommand [Target]

(Optional) An array of search criteria that targets instances using a Key ;Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets , see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

scParameters :: Lens' SendCommand (HashMap Text [Text])

The required and optional parameters specified in the SSM document being executed.

scDocumentHash :: Lens' SendCommand (Maybe Text)

The Sha256 or Sha1 hash created by the system when the document was created.

scTimeoutSeconds :: Lens' SendCommand (Maybe Natural)

If this time is reached and the command has not already started executing, it will not execute.

scComment :: Lens' SendCommand (Maybe Text)

User-specified information about the command, such as a brief description of what the command should do.

scOutputS3BucketName :: Lens' SendCommand (Maybe Text)

The name of the S3 bucket where command execution responses should be stored.

scMaxConcurrency :: Lens' SendCommand (Maybe Text)

(Optional) The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as “10” or a percentage such as “10%”. The default value is 50. For more information about how to use MaxConcurrency , see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

scDocumentName :: Lens' SendCommand Text

Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.

Destructuring the Response

sendCommandResponse

Arguments

:: Int

scrsResponseStatus

-> 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:

• scrsCommand - The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.
• scrsResponseStatus - -- | The response status code.

data SendCommandResponse

See: sendCommandResponse smart constructor.

Instances

Eq SendCommandResponse

Methods

(==) :: SendCommandResponse -> SendCommandResponse -> Bool

(/=) :: SendCommandResponse -> SendCommandResponse -> Bool

Data SendCommandResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SendCommandResponse -> c SendCommandResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SendCommandResponse

toConstr :: SendCommandResponse -> Constr

dataTypeOf :: SendCommandResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SendCommandResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SendCommandResponse)

gmapT :: (forall b. Data b => b -> b) -> SendCommandResponse -> SendCommandResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SendCommandResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SendCommandResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> SendCommandResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SendCommandResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SendCommandResponse -> m SendCommandResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SendCommandResponse -> m SendCommandResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SendCommandResponse -> m SendCommandResponse

Read SendCommandResponse

Methods

readsPrec :: Int -> ReadS SendCommandResponse

readList :: ReadS [SendCommandResponse]

readPrec :: ReadPrec SendCommandResponse

readListPrec :: ReadPrec [SendCommandResponse]

Show SendCommandResponse

Methods

showsPrec :: Int -> SendCommandResponse -> ShowS

show :: SendCommandResponse -> String

showList :: [SendCommandResponse] -> ShowS

Generic SendCommandResponse

Associated Types

type Rep SendCommandResponse :: * -> *

Methods

from :: SendCommandResponse -> Rep SendCommandResponse x

to :: Rep SendCommandResponse x -> SendCommandResponse

NFData SendCommandResponse

Methods

rnf :: SendCommandResponse -> ()

type Rep SendCommandResponse

type Rep SendCommandResponse = D1 (MetaData "SendCommandResponse" "Network.AWS.SSM.SendCommand" "amazonka-ssm-1.4.5-B1a5iPTYqlbHaMCHVQ4GNL" False) (C1 (MetaCons "SendCommandResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_scrsCommand") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Command))) (S1 (MetaSel (Just Symbol "_scrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

scrsCommand :: Lens' SendCommandResponse (Maybe Command)

The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.

scrsResponseStatus :: Lens' SendCommandResponse Int

• - | The response status code.