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

# ARCZonalShiftClient 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.

# Exceptions.exceptions usage example

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

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions 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

# can_paginate method definition

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

cancel_zonal_shift

Cancel a zonal shift in Amazon Route 53 Application Recovery Controller.

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

# cancel_zonal_shift method definition

def cancel_zonal_shift(
    self,
    *,
    zonalShiftId: str,
) -> ZonalShiftTypeDef:  # (1)
    ...

1. See ZonalShiftTypeDef

# cancel_zonal_shift method usage example with argument unpacking

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

# close method definition

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

create_practice_run_configuration

A practice run configuration for zonal autoshift is required when you enable zonal autoshift.

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

# create_practice_run_configuration method definition

def create_practice_run_configuration(
    self,
    *,
    outcomeAlarms: Sequence[ControlConditionTypeDef],  # (1)
    resourceIdentifier: str,
    blockedDates: Sequence[str] = ...,
    blockedWindows: Sequence[str] = ...,
    blockingAlarms: Sequence[ControlConditionTypeDef] = ...,  # (1)
) -> CreatePracticeRunConfigurationResponseTypeDef:  # (3)
    ...

1. See ControlConditionTypeDef
2. See ControlConditionTypeDef
3. See CreatePracticeRunConfigurationResponseTypeDef

# create_practice_run_configuration method usage example with argument unpacking

kwargs: CreatePracticeRunConfigurationRequestRequestTypeDef = {  # (1)
    "outcomeAlarms": ...,
    "resourceIdentifier": ...,
}

parent.create_practice_run_configuration(**kwargs)

1. See CreatePracticeRunConfigurationRequestRequestTypeDef

delete_practice_run_configuration

Deletes the practice run configuration for a resource.

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

# delete_practice_run_configuration method definition

def delete_practice_run_configuration(
    self,
    *,
    resourceIdentifier: str,
) -> DeletePracticeRunConfigurationResponseTypeDef:  # (1)
    ...

1. See DeletePracticeRunConfigurationResponseTypeDef

# delete_practice_run_configuration method usage example with argument unpacking

kwargs: DeletePracticeRunConfigurationRequestRequestTypeDef = {  # (1)
    "resourceIdentifier": ...,
}

parent.delete_practice_run_configuration(**kwargs)

1. See DeletePracticeRunConfigurationRequestRequestTypeDef

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

# generate_presigned_url method definition

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

get_autoshift_observer_notification_status

Returns the status of autoshift observer notification.

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

# get_autoshift_observer_notification_status method definition

def get_autoshift_observer_notification_status(
    self,
) -> GetAutoshiftObserverNotificationStatusResponseTypeDef:  # (1)
    ...

1. See GetAutoshiftObserverNotificationStatusResponseTypeDef

get_managed_resource

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

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

# get_managed_resource method definition

def get_managed_resource(
    self,
    *,
    resourceIdentifier: str,
) -> GetManagedResourceResponseTypeDef:  # (1)
    ...

1. See GetManagedResourceResponseTypeDef

# get_managed_resource method usage example with argument unpacking

kwargs: GetManagedResourceRequestRequestTypeDef = {  # (1)
    "resourceIdentifier": ...,
}

parent.get_managed_resource(**kwargs)

1. See GetManagedResourceRequestRequestTypeDef

list_autoshifts

Returns a list of autoshifts for an Amazon Web Services Region.

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

# list_autoshifts method definition

def list_autoshifts(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    status: AutoshiftExecutionStatusType = ...,  # (1)
) -> ListAutoshiftsResponseTypeDef:  # (2)
    ...

1. See AutoshiftExecutionStatusType
2. See ListAutoshiftsResponseTypeDef

# list_autoshifts method usage example with argument unpacking

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

parent.list_autoshifts(**kwargs)

1. See ListAutoshiftsRequestRequestTypeDef

list_managed_resources

Lists all the resources in your Amazon Web Services account in this Amazon Web Services 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

# list_managed_resources method definition

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

1. See ListManagedResourcesResponseTypeDef

# list_managed_resources method usage example with argument unpacking

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

parent.list_managed_resources(**kwargs)

1. See ListManagedResourcesRequestRequestTypeDef

list_zonal_shifts

Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region.

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

# list_zonal_shifts method definition

def list_zonal_shifts(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    resourceIdentifier: str = ...,
    status: ZonalShiftStatusType = ...,  # (1)
) -> ListZonalShiftsResponseTypeDef:  # (2)
    ...

1. See ZonalShiftStatusType
2. See ListZonalShiftsResponseTypeDef

# list_zonal_shifts method usage example with argument unpacking

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 an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Av...

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

# start_zonal_shift method definition

def start_zonal_shift(
    self,
    *,
    awayFrom: str,
    comment: str,
    expiresIn: str,
    resourceIdentifier: str,
) -> ZonalShiftTypeDef:  # (1)
    ...

1. See ZonalShiftTypeDef

# start_zonal_shift method usage example with argument unpacking

kwargs: StartZonalShiftRequestRequestTypeDef = {  # (1)
    "awayFrom": ...,
    "comment": ...,
    "expiresIn": ...,
    "resourceIdentifier": ...,
}

parent.start_zonal_shift(**kwargs)

1. See StartZonalShiftRequestRequestTypeDef

update_autoshift_observer_notification_status

Update the status of autoshift observer notification.

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

# update_autoshift_observer_notification_status method definition

def update_autoshift_observer_notification_status(
    self,
    *,
    status: AutoshiftObserverNotificationStatusType,  # (1)
) -> UpdateAutoshiftObserverNotificationStatusResponseTypeDef:  # (2)
    ...

1. See AutoshiftObserverNotificationStatusType
2. See UpdateAutoshiftObserverNotificationStatusResponseTypeDef

# update_autoshift_observer_notification_status method usage example with argument unpacking

kwargs: UpdateAutoshiftObserverNotificationStatusRequestRequestTypeDef = {  # (1)
    "status": ...,
}

parent.update_autoshift_observer_notification_status(**kwargs)

1. See UpdateAutoshiftObserverNotificationStatusRequestRequestTypeDef

update_practice_run_configuration

Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.

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

# update_practice_run_configuration method definition

def update_practice_run_configuration(
    self,
    *,
    resourceIdentifier: str,
    blockedDates: Sequence[str] = ...,
    blockedWindows: Sequence[str] = ...,
    blockingAlarms: Sequence[ControlConditionTypeDef] = ...,  # (1)
    outcomeAlarms: Sequence[ControlConditionTypeDef] = ...,  # (1)
) -> UpdatePracticeRunConfigurationResponseTypeDef:  # (3)
    ...

1. See ControlConditionTypeDef
2. See ControlConditionTypeDef
3. See UpdatePracticeRunConfigurationResponseTypeDef

# update_practice_run_configuration method usage example with argument unpacking

kwargs: UpdatePracticeRunConfigurationRequestRequestTypeDef = {  # (1)
    "resourceIdentifier": ...,
}

parent.update_practice_run_configuration(**kwargs)

1. See UpdatePracticeRunConfigurationRequestRequestTypeDef

update_zonal_autoshift_configuration

The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status.

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

# update_zonal_autoshift_configuration method definition

def update_zonal_autoshift_configuration(
    self,
    *,
    resourceIdentifier: str,
    zonalAutoshiftStatus: ZonalAutoshiftStatusType,  # (1)
) -> UpdateZonalAutoshiftConfigurationResponseTypeDef:  # (2)
    ...

1. See ZonalAutoshiftStatusType
2. See UpdateZonalAutoshiftConfigurationResponseTypeDef

# update_zonal_autoshift_configuration method usage example with argument unpacking

kwargs: UpdateZonalAutoshiftConfigurationRequestRequestTypeDef = {  # (1)
    "resourceIdentifier": ...,
    "zonalAutoshiftStatus": ...,
}

parent.update_zonal_autoshift_configuration(**kwargs)

1. See UpdateZonalAutoshiftConfigurationRequestRequestTypeDef

update_zonal_shift

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

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

# update_zonal_shift method definition

def update_zonal_shift(
    self,
    *,
    zonalShiftId: str,
    comment: str = ...,
    expiresIn: str = ...,
) -> ZonalShiftTypeDef:  # (1)
    ...

1. See ZonalShiftTypeDef

# update_zonal_shift method usage example with argument unpacking

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.

• client.get_paginator("list_autoshifts") -> ListAutoshiftsPaginator
• client.get_paginator("list_managed_resources") -> ListManagedResourcesPaginator
• client.get_paginator("list_zonal_shifts") -> ListZonalShiftsPaginator