Network.AWS.SSM.StartAutomationExecution

Initiates execution of an Automation document.

Creating a Request

startAutomationExecution

Arguments

:: Text

saeDocumentName

-> StartAutomationExecution

Creates a value of StartAutomationExecution with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• saeParameters - A key-value map of execution parameters, which match the declared parameters in the Automation document.
• saeDocumentVersion - The version of the Automation document to use for this execution.
• saeDocumentName - The name of the Automation document to use for this execution.

data StartAutomationExecution

See: startAutomationExecution smart constructor.

Instances

Eq StartAutomationExecution

Methods

(==) :: StartAutomationExecution -> StartAutomationExecution -> Bool

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

Data StartAutomationExecution

Methods

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

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

toConstr :: StartAutomationExecution -> Constr

dataTypeOf :: StartAutomationExecution -> DataType

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

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

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

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

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

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

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

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

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

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

Read StartAutomationExecution

Methods

readsPrec :: Int -> ReadS StartAutomationExecution

readList :: ReadS [StartAutomationExecution]

readPrec :: ReadPrec StartAutomationExecution

readListPrec :: ReadPrec [StartAutomationExecution]

Show StartAutomationExecution

Methods

showsPrec :: Int -> StartAutomationExecution -> ShowS

show :: StartAutomationExecution -> String

showList :: [StartAutomationExecution] -> ShowS

Generic StartAutomationExecution

Associated Types

type Rep StartAutomationExecution :: * -> *

Methods

from :: StartAutomationExecution -> Rep StartAutomationExecution x

to :: Rep StartAutomationExecution x -> StartAutomationExecution

Hashable StartAutomationExecution

Methods

hashWithSalt :: Int -> StartAutomationExecution -> Int

hash :: StartAutomationExecution -> Int

ToJSON StartAutomationExecution

Methods

toJSON :: StartAutomationExecution -> Value

toEncoding :: StartAutomationExecution -> Encoding

toJSONList :: [StartAutomationExecution] -> Value

toEncodingList :: [StartAutomationExecution] -> Encoding

NFData StartAutomationExecution

Methods

rnf :: StartAutomationExecution -> ()

AWSRequest StartAutomationExecution

Associated Types

type Rs StartAutomationExecution :: *

Methods

request :: StartAutomationExecution -> Request StartAutomationExecution

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

ToPath StartAutomationExecution

Methods

toPath :: StartAutomationExecution -> ByteString

ToHeaders StartAutomationExecution

Methods

toHeaders :: StartAutomationExecution -> [Header]

ToQuery StartAutomationExecution

Methods

toQuery :: StartAutomationExecution -> QueryString

type Rep StartAutomationExecution

type Rep StartAutomationExecution = D1 (MetaData "StartAutomationExecution" "Network.AWS.SSM.StartAutomationExecution" "amazonka-ssm-1.4.5-B1a5iPTYqlbHaMCHVQ4GNL" False) (C1 (MetaCons "StartAutomationExecution'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_saeParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_saeDocumentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_saeDocumentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs StartAutomationExecution

type Rs StartAutomationExecution = StartAutomationExecutionResponse

Request Lenses

saeParameters :: Lens' StartAutomationExecution (HashMap Text [Text])

A key-value map of execution parameters, which match the declared parameters in the Automation document.

saeDocumentVersion :: Lens' StartAutomationExecution (Maybe Text)

The version of the Automation document to use for this execution.

saeDocumentName :: Lens' StartAutomationExecution Text

The name of the Automation document to use for this execution.

Destructuring the Response

startAutomationExecutionResponse

Arguments

:: Int

srsResponseStatus

-> StartAutomationExecutionResponse

Creates a value of StartAutomationExecutionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• srsAutomationExecutionId - The unique ID of a newly scheduled automation execution.
• srsResponseStatus - -- | The response status code.

data StartAutomationExecutionResponse

See: startAutomationExecutionResponse smart constructor.

Instances

Eq StartAutomationExecutionResponse

Methods

(==) :: StartAutomationExecutionResponse -> StartAutomationExecutionResponse -> Bool

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

Data StartAutomationExecutionResponse

Methods

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

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

toConstr :: StartAutomationExecutionResponse -> Constr

dataTypeOf :: StartAutomationExecutionResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read StartAutomationExecutionResponse

Methods

readsPrec :: Int -> ReadS StartAutomationExecutionResponse

readList :: ReadS [StartAutomationExecutionResponse]

readPrec :: ReadPrec StartAutomationExecutionResponse

readListPrec :: ReadPrec [StartAutomationExecutionResponse]

Show StartAutomationExecutionResponse

Methods

showsPrec :: Int -> StartAutomationExecutionResponse -> ShowS

show :: StartAutomationExecutionResponse -> String

showList :: [StartAutomationExecutionResponse] -> ShowS

Generic StartAutomationExecutionResponse

Associated Types

type Rep StartAutomationExecutionResponse :: * -> *

Methods

from :: StartAutomationExecutionResponse -> Rep StartAutomationExecutionResponse x

to :: Rep StartAutomationExecutionResponse x -> StartAutomationExecutionResponse

NFData StartAutomationExecutionResponse

Methods

rnf :: StartAutomationExecutionResponse -> ()

type Rep StartAutomationExecutionResponse

type Rep StartAutomationExecutionResponse = D1 (MetaData "StartAutomationExecutionResponse" "Network.AWS.SSM.StartAutomationExecution" "amazonka-ssm-1.4.5-B1a5iPTYqlbHaMCHVQ4GNL" False) (C1 (MetaCons "StartAutomationExecutionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_srsAutomationExecutionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_srsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

srsAutomationExecutionId :: Lens' StartAutomationExecutionResponse (Maybe Text)

The unique ID of a newly scheduled automation execution.

srsResponseStatus :: Lens' StartAutomationExecutionResponse Int

• - | The response status code.