Examples

Index > ARCRegionswitch > Examples

Auto-generated documentation for ARCRegionswitch type annotations stubs module mypy-boto3-arc-region-switch.

Client

Implicit type annotations

Can be used with boto3-stubs[arc-region-switch] package installed.

Write your ARCRegionswitch code as usual, type checking and code completion should work out of the box.

Client method usage example

# ARCRegionswitchClient usage example

from boto3.session import Session


session = Session()

client = session.client("arc-region-switch")  # (1)
result = client.create_plan()  # (2)

1. client: ARCRegionswitchClient
2. result: CreatePlanResponseTypeDef

Paginator usage example

# GetPlanEvaluationStatusPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("arc-region-switch")  # (1)

paginator = client.get_paginator("get_plan_evaluation_status")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: ARCRegionswitchClient
2. paginator: GetPlanEvaluationStatusPaginator
3. item: GetPlanEvaluationStatusResponseTypeDef

Waiter usage example

# PlanEvaluationStatusPassedWaiter usage example

from boto3.session import Session


session = Session()
client = session.client("arc-region-switch")  # (1)

waiter = client.get_waiter("plan_evaluation_status_passed")  # (2)
waiter.wait(...)

1. client: ARCRegionswitchClient
2. waiter: PlanEvaluationStatusPassedWaiter

Explicit type annotations

With boto3-stubs-lite[arc-region-switch] or a standalone mypy_boto3_arc_region_switch package, you have to explicitly specify client: ARCRegionswitchClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client method usage example

# ARCRegionswitchClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_arc_region_switch.client import ARCRegionswitchClient
from mypy_boto3_arc_region_switch.type_defs import CreatePlanResponseTypeDef
from mypy_boto3_arc_region_switch.type_defs import CreatePlanRequestTypeDef


session = Session()

client: ARCRegionswitchClient = session.client("arc-region-switch")

kwargs: CreatePlanRequestTypeDef = {...}
result: CreatePlanResponseTypeDef = client.create_plan(**kwargs)

Paginator usage example

# GetPlanEvaluationStatusPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_arc_region_switch.client import ARCRegionswitchClient
from mypy_boto3_arc_region_switch.paginator import GetPlanEvaluationStatusPaginator
from mypy_boto3_arc_region_switch.type_defs import GetPlanEvaluationStatusResponseTypeDef


session = Session()
client: ARCRegionswitchClient = session.client("arc-region-switch")

paginator: GetPlanEvaluationStatusPaginator = client.get_paginator("get_plan_evaluation_status")
for item in paginator.paginate(...):
    item: GetPlanEvaluationStatusResponseTypeDef
    print(item)

Waiter usage example

# PlanEvaluationStatusPassedWaiter usage example with type annotations

from boto3.session import Session

from mypy_boto3_arc_region_switch.client import ARCRegionswitchClient
from mypy_boto3_arc_region_switch.waiter import PlanEvaluationStatusPassedWaiter

session = Session()
client: ARCRegionswitchClient = session.client("arc-region-switch")

waiter: PlanEvaluationStatusPassedWaiter = client.get_waiter("plan_evaluation_status_passed")
waiter.wait(...)