Network.AWS.SSM.SendCommand

Executes commands on one or more managed 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 0. For more information about how to use MaxErrors, see Using Error Controls .
• scInstanceIds - The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see Sending Commands to a Fleet .
• scOutputS3Region - (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
• 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 Sending Commands to a Fleet .
• scParameters - The required and optional parameters specified in the document being executed.
• scDocumentHash - The Sha256 or Sha1 hash created by the system when the document was created.
• scDocumentVersion - The SSM document version to use in the request. You can specify Default, Latest, or a specific version number.
• scTimeoutSeconds - If this time is reached and the command has not already started executing, it will not run.
• 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 Using Concurrency Controls .
• scDocumentName - Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.

data SendCommand

See: sendCommand smart constructor.

Instances

Eq SendCommand

Defined in Network.AWS.SSM.SendCommand

Methods

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

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

Data SendCommand

Defined in Network.AWS.SSM.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

Defined in Network.AWS.SSM.SendCommand

Methods

readsPrec :: Int -> ReadS SendCommand

readList :: ReadS [SendCommand]

readPrec :: ReadPrec SendCommand

readListPrec :: ReadPrec [SendCommand]

Show SendCommand

Defined in Network.AWS.SSM.SendCommand

Methods

showsPrec :: Int -> SendCommand -> ShowS

show :: SendCommand -> String

showList :: [SendCommand] -> ShowS

Generic SendCommand

Defined in Network.AWS.SSM.SendCommand

Associated Types

type Rep SendCommand :: Type -> Type

Methods

from :: SendCommand -> Rep SendCommand x

to :: Rep SendCommand x -> SendCommand

Hashable SendCommand

Defined in Network.AWS.SSM.SendCommand

Methods

hashWithSalt :: Int -> SendCommand -> Int

hash :: SendCommand -> Int

ToJSON SendCommand

Defined in Network.AWS.SSM.SendCommand

Methods

toJSON :: SendCommand -> Value

toEncoding :: SendCommand -> Encoding

toJSONList :: [SendCommand] -> Value

toEncodingList :: [SendCommand] -> Encoding

AWSRequest SendCommand

Defined in Network.AWS.SSM.SendCommand

Associated Types

type Rs SendCommand :: Type

Methods

request :: SendCommand -> Request SendCommand

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

ToHeaders SendCommand

Defined in Network.AWS.SSM.SendCommand

Methods

toHeaders :: SendCommand -> [Header]

ToPath SendCommand

Defined in Network.AWS.SSM.SendCommand

Methods

toPath :: SendCommand -> ByteString

ToQuery SendCommand

Defined in Network.AWS.SSM.SendCommand

Methods

toQuery :: SendCommand -> QueryString

NFData SendCommand

Defined in Network.AWS.SSM.SendCommand

Methods

rnf :: SendCommand -> ()

type Rep SendCommand

Defined in Network.AWS.SSM.SendCommand

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

type Rs SendCommand

Defined in Network.AWS.SSM.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 0. For more information about how to use MaxErrors, see Using Error Controls .

scInstanceIds :: Lens' SendCommand [Text]

The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see Sending Commands to a Fleet .

scOutputS3Region :: Lens' SendCommand (Maybe Text)

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

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 Sending Commands to a Fleet .

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

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

scDocumentHash :: Lens' SendCommand (Maybe Text)

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

scDocumentVersion :: Lens' SendCommand (Maybe Text)

The SSM document version to use in the request. You can specify Default, Latest, or a specific version number.

scTimeoutSeconds :: Lens' SendCommand (Maybe Natural)

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

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 Using Concurrency Controls .

scDocumentName :: Lens' SendCommand Text

Required. The name of the Systems Manager document to execute. This can be a 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

Defined in Network.AWS.SSM.SendCommand

Methods

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

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

Data SendCommandResponse

Defined in Network.AWS.SSM.SendCommand

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

Defined in Network.AWS.SSM.SendCommand

Methods

readsPrec :: Int -> ReadS SendCommandResponse

readList :: ReadS [SendCommandResponse]

readPrec :: ReadPrec SendCommandResponse

readListPrec :: ReadPrec [SendCommandResponse]

Show SendCommandResponse

Defined in Network.AWS.SSM.SendCommand

Methods

showsPrec :: Int -> SendCommandResponse -> ShowS

show :: SendCommandResponse -> String

showList :: [SendCommandResponse] -> ShowS

Generic SendCommandResponse

Defined in Network.AWS.SSM.SendCommand

Associated Types

type Rep SendCommandResponse :: Type -> Type

Methods

from :: SendCommandResponse -> Rep SendCommandResponse x

to :: Rep SendCommandResponse x -> SendCommandResponse

NFData SendCommandResponse

Defined in Network.AWS.SSM.SendCommand

Methods

rnf :: SendCommandResponse -> ()

type Rep SendCommandResponse

Defined in Network.AWS.SSM.SendCommand

type Rep SendCommandResponse = D1 (MetaData "SendCommandResponse" "Network.AWS.SSM.SendCommand" "amazonka-ssm-1.6.1-7PbnocxNW5qAr7pEvzAy6Q" False) (C1 (MetaCons "SendCommandResponse'" PrefixI True) (S1 (MetaSel (Just "_scrsCommand") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Command)) :*: S1 (MetaSel (Just "_scrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (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.