Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSM.StartAutomationExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Initiates execution of an Automation runbook.

Synopsis

data StartAutomationExecution = StartAutomationExecution' {
- targetParameterName :: Maybe Text
- targetLocations :: Maybe (NonEmpty TargetLocation)
- clientToken :: Maybe Text
- mode :: Maybe ExecutionMode
- targetMaps :: Maybe [HashMap Text [Text]]
- maxErrors :: Maybe Text
- targets :: Maybe [Target]
- parameters :: Maybe (HashMap Text [Text])
- documentVersion :: Maybe Text
- tags :: Maybe [Tag]
- maxConcurrency :: Maybe Text
- documentName :: Text
}
newStartAutomationExecution :: Text -> StartAutomationExecution
startAutomationExecution_targetParameterName :: Lens' StartAutomationExecution (Maybe Text)
startAutomationExecution_targetLocations :: Lens' StartAutomationExecution (Maybe (NonEmpty TargetLocation))
startAutomationExecution_clientToken :: Lens' StartAutomationExecution (Maybe Text)
startAutomationExecution_mode :: Lens' StartAutomationExecution (Maybe ExecutionMode)
startAutomationExecution_targetMaps :: Lens' StartAutomationExecution (Maybe [HashMap Text [Text]])
startAutomationExecution_maxErrors :: Lens' StartAutomationExecution (Maybe Text)
startAutomationExecution_targets :: Lens' StartAutomationExecution (Maybe [Target])
startAutomationExecution_parameters :: Lens' StartAutomationExecution (Maybe (HashMap Text [Text]))
startAutomationExecution_documentVersion :: Lens' StartAutomationExecution (Maybe Text)
startAutomationExecution_tags :: Lens' StartAutomationExecution (Maybe [Tag])
startAutomationExecution_maxConcurrency :: Lens' StartAutomationExecution (Maybe Text)
startAutomationExecution_documentName :: Lens' StartAutomationExecution Text
data StartAutomationExecutionResponse = StartAutomationExecutionResponse' {
- automationExecutionId :: Maybe Text
- httpStatus :: Int
}
newStartAutomationExecutionResponse :: Int -> StartAutomationExecutionResponse
startAutomationExecutionResponse_automationExecutionId :: Lens' StartAutomationExecutionResponse (Maybe Text)
startAutomationExecutionResponse_httpStatus :: Lens' StartAutomationExecutionResponse Int

Creating a Request

data StartAutomationExecution Source #

See: newStartAutomationExecution smart constructor.

Constructors

StartAutomationExecution'

Fields

targetParameterName :: Maybe Text
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
targetLocations :: Maybe (NonEmpty TargetLocation)
A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts in the Amazon Web Services Systems Manager User Guide.
clientToken :: Maybe Text
User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
mode :: Maybe ExecutionMode
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
targetMaps :: Maybe [HashMap Text [Text]]
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
maxErrors :: Maybe Text
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.
targets :: Maybe [Target]
A key-value mapping to target resources. Required if you specify TargetParameterName.
parameters :: Maybe (HashMap Text [Text])
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
documentVersion :: Maybe Text
The version of the Automation runbook to use for this execution.
tags :: Maybe [Tag]
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:
- ```
Key=environment,Value=test
```
- ```
Key=OS,Value=Windows
```
To add tags to an existing patch baseline, use the AddTagsToResource operation.
maxConcurrency :: Maybe Text
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.
documentName :: Text
The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

Instances

Instances details

Eq StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods (==) :: StartAutomationExecution -> StartAutomationExecution -> Bool # (/=) :: StartAutomationExecution -> StartAutomationExecution -> Bool #
Read StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods readsPrec :: Int -> ReadS StartAutomationExecution # readList :: ReadS [StartAutomationExecution] # readPrec :: ReadPrec StartAutomationExecution # readListPrec :: ReadPrec [StartAutomationExecution] #
Show StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods showsPrec :: Int -> StartAutomationExecution -> ShowS # show :: StartAutomationExecution -> String # showList :: [StartAutomationExecution] -> ShowS #
Generic StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Associated Types type Rep StartAutomationExecution :: Type -> Type # Methods from :: StartAutomationExecution -> Rep StartAutomationExecution x # to :: Rep StartAutomationExecution x -> StartAutomationExecution #
NFData StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods rnf :: StartAutomationExecution -> () #
Hashable StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods hashWithSalt :: Int -> StartAutomationExecution -> Int # hash :: StartAutomationExecution -> Int #
ToJSON StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods toJSON :: StartAutomationExecution -> Value # toEncoding :: StartAutomationExecution -> Encoding # toJSONList :: [StartAutomationExecution] -> Value # toEncodingList :: [StartAutomationExecution] -> Encoding #
AWSRequest StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Associated Types type AWSResponse StartAutomationExecution # Methods request :: StartAutomationExecution -> Request StartAutomationExecution # response :: MonadResource m => Logger -> Service -> Proxy StartAutomationExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartAutomationExecution))) #
ToHeaders StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods toHeaders :: StartAutomationExecution -> [Header] #
ToPath StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods toPath :: StartAutomationExecution -> ByteString #
ToQuery StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods toQuery :: StartAutomationExecution -> QueryString #
type Rep StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution type Rep StartAutomationExecution = D1 ('MetaData "StartAutomationExecution" "Amazonka.SSM.StartAutomationExecution" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "StartAutomationExecution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "targetParameterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "targetLocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty TargetLocation))) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionMode)) :: (S1 ('MetaSel ('Just "targetMaps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HashMap Text [Text]])) :: S1 ('MetaSel ('Just "maxErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Target])) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :: S1 ('MetaSel ('Just "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "maxConcurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "documentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse StartAutomationExecution Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution type AWSResponse StartAutomationExecution = StartAutomationExecutionResponse

newStartAutomationExecution Source #

Arguments

:: Text	`$sel:documentName:StartAutomationExecution'`
-> StartAutomationExecution

Create a value of StartAutomationExecution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:targetParameterName:StartAutomationExecution', startAutomationExecution_targetParameterName - The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

$sel:targetLocations:StartAutomationExecution', startAutomationExecution_targetLocations - A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts in the Amazon Web Services Systems Manager User Guide.

$sel:clientToken:StartAutomationExecution', startAutomationExecution_clientToken - User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

$sel:mode:StartAutomationExecution', startAutomationExecution_mode - The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

$sel:targetMaps:StartAutomationExecution', startAutomationExecution_targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

$sel:maxErrors:StartAutomationExecution', startAutomationExecution_maxErrors - 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.

$sel:targets:StartAutomationExecution', startAutomationExecution_targets - A key-value mapping to target resources. Required if you specify TargetParameterName.

$sel:parameters:StartAutomationExecution', startAutomationExecution_parameters - A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

$sel:documentVersion:StartAutomationExecution', startAutomationExecution_documentVersion - The version of the Automation runbook to use for this execution.

$sel:tags:StartAutomationExecution', startAutomationExecution_tags - Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

```
Key=environment,Value=test
```
```
Key=OS,Value=Windows
```

To add tags to an existing patch baseline, use the AddTagsToResource operation.

$sel:maxConcurrency:StartAutomationExecution', startAutomationExecution_maxConcurrency - 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.

$sel:documentName:StartAutomationExecution', startAutomationExecution_documentName - The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

Request Lenses

startAutomationExecution_targetParameterName :: Lens' StartAutomationExecution (Maybe Text) Source #

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

startAutomationExecution_targetLocations :: Lens' StartAutomationExecution (Maybe (NonEmpty TargetLocation)) Source #

A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts in the Amazon Web Services Systems Manager User Guide.

startAutomationExecution_clientToken :: Lens' StartAutomationExecution (Maybe Text) Source #

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

startAutomationExecution_mode :: Lens' StartAutomationExecution (Maybe ExecutionMode) Source #

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

startAutomationExecution_targetMaps :: Lens' StartAutomationExecution (Maybe [HashMap Text [Text]]) Source #

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

startAutomationExecution_maxErrors :: Lens' StartAutomationExecution (Maybe Text) Source #

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.

startAutomationExecution_targets :: Lens' StartAutomationExecution (Maybe [Target]) Source #

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

startAutomationExecution_parameters :: Lens' StartAutomationExecution (Maybe (HashMap Text [Text])) Source #

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

startAutomationExecution_documentVersion :: Lens' StartAutomationExecution (Maybe Text) Source #

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

startAutomationExecution_tags :: Lens' StartAutomationExecution (Maybe [Tag]) Source #

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

```
Key=environment,Value=test
```
```
Key=OS,Value=Windows
```

To add tags to an existing patch baseline, use the AddTagsToResource operation.

startAutomationExecution_maxConcurrency :: Lens' StartAutomationExecution (Maybe Text) Source #

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.

startAutomationExecution_documentName :: Lens' StartAutomationExecution Text Source #

The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

Destructuring the Response

data StartAutomationExecutionResponse Source #

See: newStartAutomationExecutionResponse smart constructor.

Constructors

StartAutomationExecutionResponse'
Fields automationExecutionId :: Maybe Text The unique ID of a newly scheduled automation execution. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartAutomationExecutionResponse Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods (==) :: StartAutomationExecutionResponse -> StartAutomationExecutionResponse -> Bool # (/=) :: StartAutomationExecutionResponse -> StartAutomationExecutionResponse -> Bool #
Read StartAutomationExecutionResponse Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods readsPrec :: Int -> ReadS StartAutomationExecutionResponse # readList :: ReadS [StartAutomationExecutionResponse] # readPrec :: ReadPrec StartAutomationExecutionResponse # readListPrec :: ReadPrec [StartAutomationExecutionResponse] #
Show StartAutomationExecutionResponse Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods showsPrec :: Int -> StartAutomationExecutionResponse -> ShowS # show :: StartAutomationExecutionResponse -> String # showList :: [StartAutomationExecutionResponse] -> ShowS #
Generic StartAutomationExecutionResponse Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Associated Types type Rep StartAutomationExecutionResponse :: Type -> Type # Methods from :: StartAutomationExecutionResponse -> Rep StartAutomationExecutionResponse x # to :: Rep StartAutomationExecutionResponse x -> StartAutomationExecutionResponse #
NFData StartAutomationExecutionResponse Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution Methods rnf :: StartAutomationExecutionResponse -> () #
type Rep StartAutomationExecutionResponse Source #
Instance details Defined in Amazonka.SSM.StartAutomationExecution type Rep StartAutomationExecutionResponse = D1 ('MetaData "StartAutomationExecutionResponse" "Amazonka.SSM.StartAutomationExecution" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "StartAutomationExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "automationExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartAutomationExecutionResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartAutomationExecutionResponse'`
-> StartAutomationExecutionResponse

Create a value of StartAutomationExecutionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:automationExecutionId:StartAutomationExecutionResponse', startAutomationExecutionResponse_automationExecutionId - The unique ID of a newly scheduled automation execution.

$sel:httpStatus:StartAutomationExecutionResponse', startAutomationExecutionResponse_httpStatus - The response's http status code.

Response Lenses

startAutomationExecutionResponse_automationExecutionId :: Lens' StartAutomationExecutionResponse (Maybe Text) Source #

The unique ID of a newly scheduled automation execution.

startAutomationExecutionResponse_httpStatus :: Lens' StartAutomationExecutionResponse Int Source #

The response's http status code.