Network.AWS.SSM.SendCommand

Executes commands on one or more remote instances.

Creating a Request

sendCommand

Arguments

:: NonEmpty Text

scInstanceIds

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

• scOutputS3KeyPrefix
• scParameters
• scTimeoutSeconds
• scComment
• scOutputS3BucketName
• scInstanceIds
• scDocumentName

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

ToJSON SendCommand

Methods

toJSON :: SendCommand -> Value

toEncoding :: SendCommand -> Encoding

Hashable SendCommand

Methods

hashWithSalt :: Int -> SendCommand -> Int

hash :: SendCommand -> Int

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.2-Lvh1tC8Iy8m7qxZ5ouVyq3" False) (C1 (MetaCons "SendCommand'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_scOutputS3KeyPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_scParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text [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 "_scInstanceIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 Text))) (S1 (MetaSel (Just Symbol "_scDocumentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs SendCommand

type Rs SendCommand = SendCommandResponse

Request Lenses

scOutputS3KeyPrefix :: Lens' SendCommand (Maybe Text)

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

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

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

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.

scInstanceIds :: Lens' SendCommand (NonEmpty Text)

Required. The instance IDs where the command should execute.

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
• scrsResponseStatus

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.2-Lvh1tC8Iy8m7qxZ5ouVyq3" False) (C1 (MetaCons "SendCommandResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_scrsCommand") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Command))) (S1 (MetaSel (Just Symbol "_scrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

scrsCommand :: Lens' SendCommandResponse (Maybe Command)

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

The response status code.