Skip to content

TrafficRoutingConfig

Source code in docs_src/capo_sagemaker/types/traffic_routing_config.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class TrafficRoutingConfig(TypedDict, closed=True):
    type: NotRequired[
        "capo_sagemaker.types.traffic_routing_config_type.TrafficRoutingConfigType"
    ]
    """<p>Traffic routing strategy type.</p> <ul> <li> <p> <code>ALL_AT_ONCE</code>: Endpoint traffic shifts to the new fleet in a single step. </p> </li> <li> <p> <code>CANARY</code>: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic. </p> </li> <li> <p> <code>LINEAR</code>: Endpoint traffic shifts to the new fleet in n steps of a configurable size. </p> </li> </ul>"""
    wait_interval_in_seconds: NotRequired[
        "capo_sagemaker.types.wait_interval_in_seconds.WaitIntervalInSeconds"
    ]
    """<p>The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.</p>"""
    canary_size: NotRequired["capo_sagemaker.types.capacity_size.CapacitySize"]
    """<p>Batch size for the first step to turn on traffic on the new endpoint fleet. <code>Value</code> must be less than or equal to 50% of the variant's total instance count.</p>"""
    linear_step_size: NotRequired["capo_sagemaker.types.capacity_size.CapacitySize"]
    """<p>Batch size for each step to turn on traffic on the new endpoint fleet. <code>Value</code> must be 10-50% of the variant's total instance count.</p>"""

canary_size instance-attribute 

canary_size: NotRequired[CapacitySize]

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant's total instance count.

linear_step_size instance-attribute 

linear_step_size: NotRequired[CapacitySize]

Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant's total instance count.

type instance-attribute 

type: NotRequired[TrafficRoutingConfigType]

Traffic routing strategy type.

  • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.

  • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.

  • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

wait_interval_in_seconds instance-attribute 

wait_interval_in_seconds: NotRequired[WaitIntervalInSeconds]

The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.