Skip to content

TargetLocation

Source code in docs_src/capo_ssm/types/target_location.py
class TargetLocation(TypedDict, closed=True):
    accounts: NotRequired["capo_ssm.types.accounts.Accounts"]
    """<p>The Amazon Web Services accounts targeted by the current Automation execution.</p>"""
    regions: NotRequired["capo_ssm.types.regions.Regions"]
    """<p>The Amazon Web Services Regions targeted by the current Automation execution.</p>"""
    target_location_max_concurrency: NotRequired[
        "capo_ssm.types.max_concurrency.MaxConcurrency"
    ]
    """<p>The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently. <code>TargetLocationMaxConcurrency</code> has a default value of 1.</p>"""
    target_location_max_errors: NotRequired["capo_ssm.types.max_errors.MaxErrors"]
    """<p>The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation. <code>TargetLocationMaxErrors</code> has a default value of 0.</p>"""
    execution_role_name: NotRequired[
        "capo_ssm.types.execution_role_name.ExecutionRoleName"
    ]
    """<p>The Automation execution role used by the currently running Automation. If not specified, the default value is <code>AWS-SystemsManager-AutomationExecutionRole</code>.</p>"""
    target_location_alarm_configuration: NotRequired[
        "capo_ssm.types.alarm_configuration.AlarmConfiguration"
    ]
    include_child_organization_units: "capo_ssm.types.boolean.Boolean"
    """<p>Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is <code>false</code>.</p>"""
    exclude_accounts: NotRequired["capo_ssm.types.exclude_accounts.ExcludeAccounts"]
    """<p>Amazon Web Services accounts or organizational units to exclude as expanded targets.</p>"""
    targets: NotRequired["capo_ssm.types.automation_targets.AutomationTargets"]
    """<p>A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for <code>TargetParameterName</code>.</p> <p>This <code>Targets</code> parameter takes precedence over the <code>StartAutomationExecution:Targets</code> parameter if both are supplied.</p>"""
    targets_max_concurrency: NotRequired[
        "capo_ssm.types.max_concurrency.MaxConcurrency"
    ]
    """<p>The maximum number of targets allowed to run this task in parallel. This <code>TargetsMaxConcurrency</code> takes precedence over the <code>StartAutomationExecution:MaxConcurrency</code> parameter if both are supplied.</p>"""
    targets_max_errors: NotRequired["capo_ssm.types.max_errors.MaxErrors"]
    """<p>The maximum number of errors that are allowed before the system stops running the automation on additional targets. This <code>TargetsMaxErrors</code> parameter takes precedence over the <code>StartAutomationExecution:MaxErrors</code> parameter if both are supplied.</p>"""

accounts instance-attribute

accounts: NotRequired[Accounts]

The Amazon Web Services accounts targeted by the current Automation execution.

exclude_accounts instance-attribute

exclude_accounts: NotRequired[ExcludeAccounts]

Amazon Web Services accounts or organizational units to exclude as expanded targets.

execution_role_name instance-attribute

execution_role_name: NotRequired[ExecutionRoleName]

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

include_child_organization_units instance-attribute

include_child_organization_units: Boolean

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

regions instance-attribute

regions: NotRequired[Regions]

The Amazon Web Services Regions targeted by the current Automation execution.

target_location_alarm_configuration instance-attribute

target_location_alarm_configuration: NotRequired[AlarmConfiguration]

target_location_max_concurrency instance-attribute

target_location_max_concurrency: NotRequired[MaxConcurrency]

The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently. TargetLocationMaxConcurrency has a default value of 1.

target_location_max_errors instance-attribute

target_location_max_errors: NotRequired[MaxErrors]

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation. TargetLocationMaxErrors has a default value of 0.

targets instance-attribute

targets: NotRequired[AutomationTargets]

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.

targets_max_concurrency instance-attribute

targets_max_concurrency: NotRequired[MaxConcurrency]

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.

targets_max_errors instance-attribute

targets_max_errors: NotRequired[MaxErrors]

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.