Runbook
Information about an Automation runbook used in a runbook workflow in Change Manager.
Note
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Contents
- DocumentName
-
The name of the Automation runbook used in a runbook workflow.
Type: String
Pattern:
^[a-zA-Z0-9_\-.:/]{3,128}$Required: Yes
- DocumentVersion
-
The version of the Automation runbook used in a runbook workflow.
Type: String
Pattern:
([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)Required: No
- MaxConcurrency
-
The
MaxConcurrencyvalue specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.Type: String
Length Constraints: Minimum length of 1. Maximum length of 7.
Pattern:
^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$Required: No
- MaxErrors
-
The
MaxErrorsvalue specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.Type: String
Length Constraints: Minimum length of 1. Maximum length of 7.
Pattern:
^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$Required: No
- Parameters
-
The key-value map of execution parameters, which were supplied when calling
StartChangeRequestExecution.Type: String to array of strings map
Map Entries: Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 50.
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 512.
Required: No
- TargetLocations
-
Information about the AWS Regions and AWS accounts targeted by the current Runbook operation.
Type: Array of TargetLocation objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
- TargetMaps
-
A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.
Type: Array of string to array of strings maps
Array Members: Minimum number of 0 items. Maximum number of 300 items.
Map Entries: Maximum number of 20 items.
Key Length Constraints: Minimum length of 1. Maximum length of 50.
Array Members: Minimum number of 0 items. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: No
- TargetParameterName
-
The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify
Targets.Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: No
- Targets
-
A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify
TargetParameterName.Type: Array of Target objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: