startAutomationExecution method
- required String documentName,
- String? clientToken,
- String? documentVersion,
- String? maxConcurrency,
- String? maxErrors,
- ExecutionMode? mode,
- Map<
String, List< ? parameters,String> > - List<
Tag> ? tags, - List<
TargetLocation> ? targetLocations, - List<
Map< ? targetMaps,String, List< >String> > - String? targetParameterName,
- List<
Target> ? targets,
Initiates execution of an Automation document.
May throw AutomationDefinitionNotFoundException. May throw InvalidAutomationExecutionParametersException. May throw AutomationExecutionLimitExceededException. May throw AutomationDefinitionVersionNotFoundException. May throw IdempotentParameterMismatch. May throw InvalidTarget. May throw InternalServerError.
Parameter documentName
:
The name of the Automation document to use for this execution.
Parameter clientToken
:
User-provided idempotency token. The token must be unique, is case
insensitive, enforces the UUID format, and can't be reused.
Parameter documentVersion
:
The version of the Automation document to use for this execution.
Parameter 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.
Parameter 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.
Parameter mode
:
The execution mode of the automation. Valid modes include the following:
Auto and Interactive. The default mode is Auto.
Parameter parameters
:
A key-value map of execution parameters, which match the declared
parameters in the Automation document.
Parameter 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
name/value pairs:
-
Key=environment,Value=test
-
Key=OS,Value=Windows
Parameter targetLocations
:
A location is a combination of AWS Regions and/or AWS accounts where you
want to run the Automation. Use this action to start an Automation in
multiple Regions and multiple accounts. For more information, see Running
Automation workflows in multiple AWS Regions and accounts in the
AWS Systems Manager User Guide.
Parameter targetMaps
:
A key-value mapping of document parameters to target resources. Both
Targets and TargetMaps cannot be specified together.
Parameter targetParameterName
:
The name of the parameter used as the target resource for the
rate-controlled execution. Required if you specify targets.
Parameter targets
:
A key-value mapping to target resources. Required if you specify
TargetParameterName.
Implementation
Future<StartAutomationExecutionResult> startAutomationExecution({
required String documentName,
String? clientToken,
String? documentVersion,
String? maxConcurrency,
String? maxErrors,
ExecutionMode? mode,
Map<String, List<String>>? parameters,
List<Tag>? tags,
List<TargetLocation>? targetLocations,
List<Map<String, List<String>>>? targetMaps,
String? targetParameterName,
List<Target>? targets,
}) async {
ArgumentError.checkNotNull(documentName, 'documentName');
_s.validateStringLength(
'clientToken',
clientToken,
36,
36,
);
_s.validateStringLength(
'maxConcurrency',
maxConcurrency,
1,
7,
);
_s.validateStringLength(
'maxErrors',
maxErrors,
1,
7,
);
_s.validateStringLength(
'targetParameterName',
targetParameterName,
1,
50,
);
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.1',
'X-Amz-Target': 'AmazonSSM.StartAutomationExecution'
};
final jsonResponse = await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
// TODO queryParams
headers: headers,
payload: {
'DocumentName': documentName,
if (clientToken != null) 'ClientToken': clientToken,
if (documentVersion != null) 'DocumentVersion': documentVersion,
if (maxConcurrency != null) 'MaxConcurrency': maxConcurrency,
if (maxErrors != null) 'MaxErrors': maxErrors,
if (mode != null) 'Mode': mode.toValue(),
if (parameters != null) 'Parameters': parameters,
if (tags != null) 'Tags': tags,
if (targetLocations != null) 'TargetLocations': targetLocations,
if (targetMaps != null) 'TargetMaps': targetMaps,
if (targetParameterName != null)
'TargetParameterName': targetParameterName,
if (targets != null) 'Targets': targets,
},
);
return StartAutomationExecutionResult.fromJson(jsonResponse.body);
}