Skip to content

CreateStateMachineAliasInput

Source code in docs_src/capo_sfn/types/create_state_machine_alias_input.py
class CreateStateMachineAliasInput(TypedDict, closed=True):
    description: NotRequired["capo_sfn.types.alias_description.AliasDescription"]
    """<p>A description for the state machine alias.</p>"""
    name: "capo_sfn.types.character_restricted_name.CharacterRestrictedName"
    """<p>The name of the state machine alias.</p> <p>To avoid conflict with version ARNs, don't use an integer in the name of the alias.</p>"""
    routing_configuration: (
        "capo_sfn.types.routing_configuration_list.RoutingConfigurationList"
    )
    """<p>The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. <code>routingConfiguration</code> contains an array of <code>RoutingConfig</code> objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each <code>RoutingConfig</code>.</p>"""

description instance-attribute

description: NotRequired[AliasDescription]

A description for the state machine alias.

name instance-attribute

The name of the state machine alias.

To avoid conflict with version ARNs, don't use an integer in the name of the alias.

routing_configuration instance-attribute

routing_configuration: RoutingConfigurationList

The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. routingConfiguration contains an array of RoutingConfig objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each RoutingConfig.