TargetLocation - AWS Systems Manager

TargetLocation

The combination of AWS Regions and AWS accounts targeted by the current Automation execution.

Contents

Accounts

The AWS accounts targeted by the current Automation execution.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

ExcludeAccounts

AWS accounts or organizational units to exclude as expanded targets.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5000 items.

Length Constraints: Minimum length of 6. Maximum length of 68.

Pattern: ^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32})|(\d{12})$

Required: No

ExecutionRoleName

The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\w+=,.@/-]+

Required: No

IncludeChildOrganizationUnits

Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false.

Type: Boolean

Required: No

Regions

The AWS Regions targeted by the current Automation execution.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

TargetLocationAlarmConfiguration

The details for the CloudWatch alarm you want to apply to an automation or command.

Type: AlarmConfiguration object

Required: No

TargetLocationMaxConcurrency

The maximum number of AWS Regions and AWS accounts allowed to run the Automation concurrently.

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

TargetLocationMaxErrors

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

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

Targets

A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for TargetParameterName.

This Targets parameter takes precedence over the StartAutomationExecution:Targets parameter if both are supplied.

Type: Array of Target objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No

TargetsMaxConcurrency

The maximum number of targets allowed to run this task in parallel. This TargetsMaxConcurrency takes precedence over the StartAutomationExecution:MaxConcurrency parameter if both are supplied.

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

TargetsMaxErrors

The maximum number of errors that are allowed before the system stops running the automation on additional targets. This TargetsMaxErrors parameter takes precedence over the StartAutomationExecution:MaxErrors parameter if both are supplied.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: