amazonka-ssm-1.6.0: Amazon Simple Systems Manager (SSM) SDK.

Copyright (c) 2013-2018 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

Network.AWS.SSM.StartAutomationExecution

Description

Initiates execution of an Automation document.

# Creating a Request

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:

• saeTargetParameterName - The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify Targets.
• saeClientToken - User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
• saeMode - The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
• saeMaxErrors - The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received. Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.
• saeTargets - A key-value mapping to target resources. Required if you specify TargetParameterName.
• 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.
• saeMaxConcurrency - The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.
• saeDocumentName - The name of the Automation document to use for this execution.

See: startAutomationExecution smart constructor.

Instances

 Source # Methods Source # Methodsgfoldl :: (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 #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 # Source # Source # Methods Source # Associated Typestype Rep StartAutomationExecution :: * -> * # Methods Source # Methods Source # Methods Source # Methodsrnf :: StartAutomationExecution -> () # Source # Associated Types Methods Source # Methods Source # Methods Source # Methods Source # type Rep StartAutomationExecution = D1 * (MetaData "StartAutomationExecution" "Network.AWS.SSM.StartAutomationExecution" "amazonka-ssm-1.6.0-FkXaKF9jjpY64HF15tLQlO" False) (C1 * (MetaCons "StartAutomationExecution'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_saeTargetParameterName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_saeClientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_saeMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ExecutionMode))) (S1 * (MetaSel (Just Symbol "_saeMaxErrors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_saeTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Target]))) (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 "_saeMaxConcurrency") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_saeDocumentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))) Source #

# Request Lenses

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify Targets.

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received. Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

A key-value mapping to target resources. Required if you specify TargetParameterName.

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

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

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

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

# Destructuring the Response

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.

See: startAutomationExecutionResponse smart constructor.

Instances

 Source # Source # Methodsgfoldl :: (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 #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 # Source # Source # Methods Source # Associated Types Source # Methods Source # type Rep StartAutomationExecutionResponse = D1 * (MetaData "StartAutomationExecutionResponse" "Network.AWS.SSM.StartAutomationExecution" "amazonka-ssm-1.6.0-FkXaKF9jjpY64HF15tLQlO" False) (C1 * (MetaCons "StartAutomationExecutionResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_srsAutomationExecutionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_srsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

# Response Lenses

The unique ID of a newly scheduled automation execution.

• - | The response status code.