ARCRegionswitchClient

Index > ARCRegionswitch > ARCRegionswitchClient

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

ARCRegionswitchClient

Type annotations and code completion for boto3.client("arc-region-switch"). boto3 documentation

# ARCRegionswitchClient usage example

from boto3.session import Session
from mypy_boto3_arc_region_switch.client import ARCRegionswitchClient

def get_arc-region-switch_client() -> ARCRegionswitchClient:
    return Session().client("arc-region-switch")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("arc-region-switch").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("arc-region-switch")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.IllegalArgumentException,
    client.exceptions.IllegalStateException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_arc_region_switch.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("arc-region-switch").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("arc-region-switch").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

approve_plan_execution_step

Approves a step in a plan execution that requires manual approval.

Type annotations and code completion for boto3.client("arc-region-switch").approve_plan_execution_step method. boto3 documentation

# approve_plan_execution_step method definition

def approve_plan_execution_step(
    self,
    *,
    planArn: str,
    executionId: str,
    stepName: str,
    approval: ApprovalType,  # (1)
    comment: str = ...,
) -> Dict[str, Any]:
    ...

1. See ApprovalType

# approve_plan_execution_step method usage example with argument unpacking

kwargs: ApprovePlanExecutionStepRequestTypeDef = {  # (1)
    "planArn": ...,
    "executionId": ...,
    "stepName": ...,
    "approval": ...,
}

parent.approve_plan_execution_step(**kwargs)

1. See ApprovePlanExecutionStepRequestTypeDef

cancel_plan_execution

Cancels an in-progress plan execution.

Type annotations and code completion for boto3.client("arc-region-switch").cancel_plan_execution method. boto3 documentation

# cancel_plan_execution method definition

def cancel_plan_execution(
    self,
    *,
    planArn: str,
    executionId: str,
    comment: str = ...,
) -> Dict[str, Any]:
    ...

# cancel_plan_execution method usage example with argument unpacking

kwargs: CancelPlanExecutionRequestTypeDef = {  # (1)
    "planArn": ...,
    "executionId": ...,
}

parent.cancel_plan_execution(**kwargs)

1. See CancelPlanExecutionRequestTypeDef

create_plan

Creates a new Region switch plan.

Type annotations and code completion for boto3.client("arc-region-switch").create_plan method. boto3 documentation

# create_plan method definition

def create_plan(
    self,
    *,
    workflows: Sequence[WorkflowUnionTypeDef],  # (1)
    executionRole: str,
    name: str,
    regions: Sequence[str],
    recoveryApproach: RecoveryApproachType,  # (2)
    description: str = ...,
    recoveryTimeObjectiveMinutes: int = ...,
    associatedAlarms: Mapping[str, AssociatedAlarmTypeDef] = ...,  # (3)
    triggers: Sequence[TriggerUnionTypeDef] = ...,  # (4)
    primaryRegion: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreatePlanResponseTypeDef:  # (5)
    ...

1. See Sequence[WorkflowUnionTypeDef]
2. See RecoveryApproachType
3. See Mapping[str, AssociatedAlarmTypeDef]
4. See Sequence[TriggerUnionTypeDef]
5. See CreatePlanResponseTypeDef

# create_plan method usage example with argument unpacking

kwargs: CreatePlanRequestTypeDef = {  # (1)
    "workflows": ...,
    "executionRole": ...,
    "name": ...,
    "regions": ...,
    "recoveryApproach": ...,
}

parent.create_plan(**kwargs)

1. See CreatePlanRequestTypeDef

delete_plan

Deletes a Region switch plan.

Type annotations and code completion for boto3.client("arc-region-switch").delete_plan method. boto3 documentation

# delete_plan method definition

def delete_plan(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

# delete_plan method usage example with argument unpacking

kwargs: DeletePlanRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_plan(**kwargs)

1. See DeletePlanRequestTypeDef

get_plan

Retrieves detailed information about a Region switch plan.

Type annotations and code completion for boto3.client("arc-region-switch").get_plan method. boto3 documentation

# get_plan method definition

def get_plan(
    self,
    *,
    arn: str,
) -> GetPlanResponseTypeDef:  # (1)
    ...

1. See GetPlanResponseTypeDef

# get_plan method usage example with argument unpacking

kwargs: GetPlanRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_plan(**kwargs)

1. See GetPlanRequestTypeDef

get_plan_evaluation_status

Retrieves the evaluation status of a Region switch plan.

Type annotations and code completion for boto3.client("arc-region-switch").get_plan_evaluation_status method. boto3 documentation

# get_plan_evaluation_status method definition

def get_plan_evaluation_status(
    self,
    *,
    planArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetPlanEvaluationStatusResponseTypeDef:  # (1)
    ...

1. See GetPlanEvaluationStatusResponseTypeDef

# get_plan_evaluation_status method usage example with argument unpacking

kwargs: GetPlanEvaluationStatusRequestTypeDef = {  # (1)
    "planArn": ...,
}

parent.get_plan_evaluation_status(**kwargs)

1. See GetPlanEvaluationStatusRequestTypeDef

get_plan_execution

Retrieves detailed information about a specific plan execution.

Type annotations and code completion for boto3.client("arc-region-switch").get_plan_execution method. boto3 documentation

# get_plan_execution method definition

def get_plan_execution(
    self,
    *,
    planArn: str,
    executionId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetPlanExecutionResponseTypeDef:  # (1)
    ...

1. See GetPlanExecutionResponseTypeDef

# get_plan_execution method usage example with argument unpacking

kwargs: GetPlanExecutionRequestTypeDef = {  # (1)
    "planArn": ...,
    "executionId": ...,
}

parent.get_plan_execution(**kwargs)

1. See GetPlanExecutionRequestTypeDef

get_plan_in_region

Retrieves information about a Region switch plan in a specific Amazon Web Services Region.

Type annotations and code completion for boto3.client("arc-region-switch").get_plan_in_region method. boto3 documentation

# get_plan_in_region method definition

def get_plan_in_region(
    self,
    *,
    arn: str,
) -> GetPlanInRegionResponseTypeDef:  # (1)
    ...

1. See GetPlanInRegionResponseTypeDef

# get_plan_in_region method usage example with argument unpacking

kwargs: GetPlanInRegionRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_plan_in_region(**kwargs)

1. See GetPlanInRegionRequestTypeDef

list_plan_execution_events

Lists the events that occurred during a plan execution.

Type annotations and code completion for boto3.client("arc-region-switch").list_plan_execution_events method. boto3 documentation

# list_plan_execution_events method definition

def list_plan_execution_events(
    self,
    *,
    planArn: str,
    executionId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    name: str = ...,
) -> ListPlanExecutionEventsResponseTypeDef:  # (1)
    ...

1. See ListPlanExecutionEventsResponseTypeDef

# list_plan_execution_events method usage example with argument unpacking

kwargs: ListPlanExecutionEventsRequestTypeDef = {  # (1)
    "planArn": ...,
    "executionId": ...,
}

parent.list_plan_execution_events(**kwargs)

1. See ListPlanExecutionEventsRequestTypeDef

list_plan_executions

Lists the executions of a Region switch plan.

Type annotations and code completion for boto3.client("arc-region-switch").list_plan_executions method. boto3 documentation

# list_plan_executions method definition

def list_plan_executions(
    self,
    *,
    planArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
    state: ExecutionStateType = ...,  # (1)
) -> ListPlanExecutionsResponseTypeDef:  # (2)
    ...

1. See ExecutionStateType
2. See ListPlanExecutionsResponseTypeDef

# list_plan_executions method usage example with argument unpacking

kwargs: ListPlanExecutionsRequestTypeDef = {  # (1)
    "planArn": ...,
}

parent.list_plan_executions(**kwargs)

1. See ListPlanExecutionsRequestTypeDef

list_plans

Lists all Region switch plans in your Amazon Web Services account.

Type annotations and code completion for boto3.client("arc-region-switch").list_plans method. boto3 documentation

# list_plans method definition

def list_plans(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListPlansResponseTypeDef:  # (1)
    ...

1. See ListPlansResponseTypeDef

# list_plans method usage example with argument unpacking

kwargs: ListPlansRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_plans(**kwargs)

1. See ListPlansRequestTypeDef

list_plans_in_region

Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.

Type annotations and code completion for boto3.client("arc-region-switch").list_plans_in_region method. boto3 documentation

# list_plans_in_region method definition

def list_plans_in_region(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListPlansInRegionResponseTypeDef:  # (1)
    ...

1. See ListPlansInRegionResponseTypeDef

# list_plans_in_region method usage example with argument unpacking

kwargs: ListPlansInRegionRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_plans_in_region(**kwargs)

1. See ListPlansInRegionRequestTypeDef

list_route53_health_checks

List the Amazon Route 53 health checks.

Type annotations and code completion for boto3.client("arc-region-switch").list_route53_health_checks method. boto3 documentation

# list_route53_health_checks method definition

def list_route53_health_checks(
    self,
    *,
    arn: str,
    hostedZoneId: str = ...,
    recordName: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListRoute53HealthChecksResponseTypeDef:  # (1)
    ...

1. See ListRoute53HealthChecksResponseTypeDef

# list_route53_health_checks method usage example with argument unpacking

kwargs: ListRoute53HealthChecksRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_route53_health_checks(**kwargs)

1. See ListRoute53HealthChecksRequestTypeDef

list_tags_for_resource

Lists the tags attached to a Region switch resource.

Type annotations and code completion for boto3.client("arc-region-switch").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    arn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

start_plan_execution

Starts the execution of a Region switch plan.

Type annotations and code completion for boto3.client("arc-region-switch").start_plan_execution method. boto3 documentation

# start_plan_execution method definition

def start_plan_execution(
    self,
    *,
    planArn: str,
    targetRegion: str,
    action: ExecutionActionType,  # (1)
    mode: ExecutionModeType = ...,  # (2)
    comment: str = ...,
    latestVersion: str = ...,
) -> StartPlanExecutionResponseTypeDef:  # (3)
    ...

1. See ExecutionActionType
2. See ExecutionModeType
3. See StartPlanExecutionResponseTypeDef

# start_plan_execution method usage example with argument unpacking

kwargs: StartPlanExecutionRequestTypeDef = {  # (1)
    "planArn": ...,
    "targetRegion": ...,
    "action": ...,
}

parent.start_plan_execution(**kwargs)

1. See StartPlanExecutionRequestTypeDef

tag_resource

Adds or updates tags for a Region switch resource.

Type annotations and code completion for boto3.client("arc-region-switch").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    arn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "arn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes tags from a Region switch resource.

Type annotations and code completion for boto3.client("arc-region-switch").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    arn: str,
    resourceTagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "arn": ...,
    "resourceTagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_plan

Updates an existing Region switch plan.

Type annotations and code completion for boto3.client("arc-region-switch").update_plan method. boto3 documentation

# update_plan method definition

def update_plan(
    self,
    *,
    arn: str,
    workflows: Sequence[WorkflowUnionTypeDef],  # (1)
    executionRole: str,
    description: str = ...,
    recoveryTimeObjectiveMinutes: int = ...,
    associatedAlarms: Mapping[str, AssociatedAlarmTypeDef] = ...,  # (2)
    triggers: Sequence[TriggerUnionTypeDef] = ...,  # (3)
) -> UpdatePlanResponseTypeDef:  # (4)
    ...

1. See Sequence[WorkflowUnionTypeDef]
2. See Mapping[str, AssociatedAlarmTypeDef]
3. See Sequence[TriggerUnionTypeDef]
4. See UpdatePlanResponseTypeDef

# update_plan method usage example with argument unpacking

kwargs: UpdatePlanRequestTypeDef = {  # (1)
    "arn": ...,
    "workflows": ...,
    "executionRole": ...,
}

parent.update_plan(**kwargs)

1. See UpdatePlanRequestTypeDef

update_plan_execution

Updates an in-progress plan execution.

Type annotations and code completion for boto3.client("arc-region-switch").update_plan_execution method. boto3 documentation

# update_plan_execution method definition

def update_plan_execution(
    self,
    *,
    planArn: str,
    executionId: str,
    action: UpdatePlanExecutionActionType,  # (1)
    comment: str = ...,
) -> Dict[str, Any]:
    ...

1. See UpdatePlanExecutionActionType

# update_plan_execution method usage example with argument unpacking

kwargs: UpdatePlanExecutionRequestTypeDef = {  # (1)
    "planArn": ...,
    "executionId": ...,
    "action": ...,
}

parent.update_plan_execution(**kwargs)

1. See UpdatePlanExecutionRequestTypeDef

update_plan_execution_step

Updates a specific step in an in-progress plan execution.

Type annotations and code completion for boto3.client("arc-region-switch").update_plan_execution_step method. boto3 documentation

# update_plan_execution_step method definition

def update_plan_execution_step(
    self,
    *,
    planArn: str,
    executionId: str,
    comment: str,
    stepName: str,
    actionToTake: UpdatePlanExecutionStepActionType,  # (1)
) -> Dict[str, Any]:
    ...

1. See UpdatePlanExecutionStepActionType

# update_plan_execution_step method usage example with argument unpacking

kwargs: UpdatePlanExecutionStepRequestTypeDef = {  # (1)
    "planArn": ...,
    "executionId": ...,
    "comment": ...,
    "stepName": ...,
    "actionToTake": ...,
}

parent.update_plan_execution_step(**kwargs)

1. See UpdatePlanExecutionStepRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("arc-region-switch").get_paginator method with overloads.

• client.get_paginator("get_plan_evaluation_status") -> GetPlanEvaluationStatusPaginator
• client.get_paginator("get_plan_execution") -> GetPlanExecutionPaginator
• client.get_paginator("list_plan_execution_events") -> ListPlanExecutionEventsPaginator
• client.get_paginator("list_plan_executions") -> ListPlanExecutionsPaginator
• client.get_paginator("list_plans_in_region") -> ListPlansInRegionPaginator
• client.get_paginator("list_plans") -> ListPlansPaginator
• client.get_paginator("list_route53_health_checks") -> ListRoute53HealthChecksPaginator

get_waiter

Type annotations and code completion for boto3.client("arc-region-switch").get_waiter method with overloads.

• client.get_waiter("plan_evaluation_status_passed") -> PlanEvaluationStatusPassedWaiter
• client.get_waiter("plan_execution_completed") -> PlanExecutionCompletedWaiter