Skip to content

ARCZonalShiftClient

Index > ARCZonalShift > ARCZonalShiftClient

Auto-generated documentation for ARCZonalShift type annotations stubs module mypy-boto3-arc-zonal-shift.

ARCZonalShiftClient

Type annotations and code completion for boto3.client("arc-zonal-shift"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_arc_zonal_shift.client import ARCZonalShiftClient

def get_arc-zonal-shift_client() -> ARCZonalShiftClient:
    return Session().client("arc-zonal-shift")

Exceptions

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

Usage example
client = boto3.client("arc-zonal-shift")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_arc_zonal_shift.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

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

cancel_zonal_shift

Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've started for a resource in your AWS account in an AWS Region.

Type annotations and code completion for boto3.client("arc-zonal-shift").cancel_zonal_shift method. boto3 documentation

Method definition
def cancel_zonal_shift(
    self,
    *,
    zonalShiftId: str,
) -> ZonalShiftTypeDef:  # (1)
    ...
  1. See ZonalShiftTypeDef
Usage example with kwargs
kwargs: CancelZonalShiftRequestRequestTypeDef = {  # (1)
    "zonalShiftId": ...,
}

parent.cancel_zonal_shift(**kwargs)
  1. See CancelZonalShiftRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("arc-zonal-shift").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

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

get_managed_resource

Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this AWS Region.

Type annotations and code completion for boto3.client("arc-zonal-shift").get_managed_resource method. boto3 documentation

Method definition
def get_managed_resource(
    self,
    *,
    resourceIdentifier: str,
) -> GetManagedResourceResponseTypeDef:  # (1)
    ...
  1. See GetManagedResourceResponseTypeDef
Usage example with kwargs
kwargs: GetManagedResourceRequestRequestTypeDef = {  # (1)
    "resourceIdentifier": ...,
}

parent.get_managed_resource(**kwargs)
  1. See GetManagedResourceRequestRequestTypeDef

list_managed_resources

Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them.

Type annotations and code completion for boto3.client("arc-zonal-shift").list_managed_resources method. boto3 documentation

Method definition
def list_managed_resources(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListManagedResourcesResponseTypeDef:  # (1)
    ...
  1. See ListManagedResourcesResponseTypeDef
Usage example with kwargs
kwargs: ListManagedResourcesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_managed_resources(**kwargs)
  1. See ListManagedResourcesRequestRequestTypeDef

list_zonal_shifts

Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.

Type annotations and code completion for boto3.client("arc-zonal-shift").list_zonal_shifts method. boto3 documentation

Method definition
def list_zonal_shifts(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    status: ZonalShiftStatusType = ...,  # (1)
) -> ListZonalShiftsResponseTypeDef:  # (2)
    ...
  1. See ZonalShiftStatusType
  2. See ListZonalShiftsResponseTypeDef
Usage example with kwargs
kwargs: ListZonalShiftsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_zonal_shifts(**kwargs)
  1. See ListZonalShiftsRequestRequestTypeDef

start_zonal_shift

You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone.

Type annotations and code completion for boto3.client("arc-zonal-shift").start_zonal_shift method. boto3 documentation

Method definition
def start_zonal_shift(
    self,
    *,
    awayFrom: str,
    comment: str,
    expiresIn: str,
    resourceIdentifier: str,
) -> ZonalShiftTypeDef:  # (1)
    ...
  1. See ZonalShiftTypeDef
Usage example with kwargs
kwargs: StartZonalShiftRequestRequestTypeDef = {  # (1)
    "awayFrom": ...,
    "comment": ...,
    "expiresIn": ...,
    "resourceIdentifier": ...,
}

parent.start_zonal_shift(**kwargs)
  1. See StartZonalShiftRequestRequestTypeDef

update_zonal_shift

Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account.

Type annotations and code completion for boto3.client("arc-zonal-shift").update_zonal_shift method. boto3 documentation

Method definition
def update_zonal_shift(
    self,
    *,
    zonalShiftId: str,
    comment: str = ...,
    expiresIn: str = ...,
) -> ZonalShiftTypeDef:  # (1)
    ...
  1. See ZonalShiftTypeDef
Usage example with kwargs
kwargs: UpdateZonalShiftRequestRequestTypeDef = {  # (1)
    "zonalShiftId": ...,
}

parent.update_zonal_shift(**kwargs)
  1. See UpdateZonalShiftRequestRequestTypeDef

get_paginator

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