AWS SDK for PHP 3.x

Client: Aws\ARCZonalShift\ARCZonalShiftClient

Service ID: arc-zonal-shift

Version: 2022-10-30

This page describes the parameters and results for the operations of the AWS ARC - Zonal Shift (2022-10-30), and shows how to use the Aws\ARCZonalShift\ARCZonalShiftClient object to call the described operations. This documentation is specific to the 2022-10-30 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelZonalShift ( array $params = [] ): Cancel a zonal shift in Amazon Route 53 Application Recovery Controller.
CreatePracticeRunConfiguration ( array $params = [] ): A practice run configuration for zonal autoshift is required when you enable zonal autoshift.
DeletePracticeRunConfiguration ( array $params = [] ): Deletes the practice run configuration for a resource.
GetAutoshiftObserverNotificationStatus ( array $params = [] ): Returns the status of autoshift observer notification.
GetManagedResource ( array $params = [] ): 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.
ListAutoshifts ( array $params = [] ): Returns a list of autoshifts for an Amazon Web Services Region.
ListManagedResources ( array $params = [] ): 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.
ListZonalShifts ( array $params = [] ): 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.
StartZonalShift ( array $params = [] ): 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 Availability Zone.
UpdateAutoshiftObserverNotificationStatus ( array $params = [] ): Update the status of autoshift observer notification.
UpdatePracticeRunConfiguration ( array $params = [] ): 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.
UpdateZonalAutoshiftConfiguration ( array $params = [] ): The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status.
UpdateZonalShift ( array $params = [] ): Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAutoshifts
ListManagedResources
ListZonalShifts

Operations

CancelZonalShift

$result = $client->cancelZonalShift([/* ... */]);
$promise = $client->cancelZonalShiftAsync([/* ... */]);

Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.

A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift.

Parameter Syntax

$result = $client->cancelZonalShift([
    'zonalShiftId' => '<string>', // REQUIRED
]);

Parameter Details

Members

zonalShiftId

: Required: Yes
: Type: string

The internally-generated identifier of a zonal shift.

Result Syntax

[
    'awayFrom' => '<string>',
    'comment' => '<string>',
    'expiryTime' => <DateTime>,
    'resourceIdentifier' => '<string>',
    'startTime' => <DateTime>,
    'status' => 'ACTIVE|EXPIRED|CANCELED',
    'zonalShiftId' => '<string>',
]

Result Details

Members

awayFrom

: Required: Yes
: Type: string

The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.

comment

: Required: Yes
: Type: string

A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.

expiryTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.

When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.

resourceIdentifier

: Required: Yes
: Type: string

The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.

At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

startTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (UTC) when the zonal shift starts.

status

: Required: Yes
: Type: string

A status for a zonal shift.

The Status for a zonal shift can have one of the following values:

ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.

zonalShiftId

: Required: Yes
: Type: string

The identifier of a zonal shift.

Errors

InternalServerException:: There was an internal server error.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException:: The input requested a resource that was not found.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.

CreatePracticeRunConfiguration

$result = $client->createPracticeRunConfiguration([/* ... */]);
$promise = $client->createPracticeRunConfigurationAsync([/* ... */]);

A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.

When a resource has a practice run configuration, Route 53 ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.

For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.

Parameter Syntax

$result = $client->createPracticeRunConfiguration([
    'blockedDates' => ['<string>', ...],
    'blockedWindows' => ['<string>', ...],
    'blockingAlarms' => [
        [
            'alarmIdentifier' => '<string>', // REQUIRED
            'type' => 'CLOUDWATCH', // REQUIRED
        ],
        // ...
    ],
    'outcomeAlarms' => [ // REQUIRED
        [
            'alarmIdentifier' => '<string>', // REQUIRED
            'type' => 'CLOUDWATCH', // REQUIRED
        ],
        // ...
    ],
    'resourceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

blockedDates

: Type: Array of strings

Optionally, you can block Route 53 ARC from starting practice runs for a resource on specific calendar dates.

The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.

For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.

blockedWindows

: Type: Array of strings

Optionally, you can block Route 53 ARC from starting practice runs for specific windows of days and times.

The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.

For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.

blockingAlarms

: Type: Array of ControlCondition structures

An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks Route 53 ARC from starting practice run zonal shifts, and ends a practice run that's in progress, when the alarm is in an ALARM state.

outcomeAlarms

: Required: Yes
: Type: Array of ControlCondition structures

The outcome alarm for practice runs is a required Amazon CloudWatch alarm that you specify that ends a practice run when the alarm is in an ALARM state.

Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability Zone during each weekly practice run. You should configure the alarm to go into an ALARM state if your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the resource return to the Availability Zone.

resourceIdentifier

: Required: Yes
: Type: string

The identifier of the resource that Amazon Web Services shifts traffic for with a practice run zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.

At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
    'practiceRunConfiguration' => [
        'blockedDates' => ['<string>', ...],
        'blockedWindows' => ['<string>', ...],
        'blockingAlarms' => [
            [
                'alarmIdentifier' => '<string>',
                'type' => 'CLOUDWATCH',
            ],
            // ...
        ],
        'outcomeAlarms' => [
            [
                'alarmIdentifier' => '<string>',
                'type' => 'CLOUDWATCH',
            ],
            // ...
        ],
    ],
    'zonalAutoshiftStatus' => 'ENABLED|DISABLED',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource that you configured the practice run for.

name

: Required: Yes
: Type: string

The name of the resource that you configured the practice run for.

practiceRunConfiguration

: Required: Yes
: Type: PracticeRunConfiguration structure

A practice run configuration for a resource. Configurations include the outcome alarm that you specify for practice runs, and, optionally, a blocking alarm and blocking dates and windows.

zonalAutoshiftStatus

: Required: Yes
: Type: string

The status for zonal autoshift for a resource. When you specify ENABLED for the autoshift status, Amazon Web Services shifts traffic away from shifts away application resource traffic from an Availability Zone, on your behalf, when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.

When you enable zonal autoshift, you must also configure practice runs for the resource.

Errors

InternalServerException:: There was an internal server error.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException:: The input requested a resource that was not found.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.

DeletePracticeRunConfiguration

$result = $client->deletePracticeRunConfiguration([/* ... */]);
$promise = $client->deletePracticeRunConfigurationAsync([/* ... */]);

Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.

Parameter Syntax

$result = $client->deletePracticeRunConfiguration([
    'resourceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceIdentifier

: Required: Yes
: Type: string

The identifier for the resource that you want to delete the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
    'zonalAutoshiftStatus' => 'ENABLED|DISABLED',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource that you deleted the practice run for.

name

: Required: Yes
: Type: string

The name of the resource that you deleted the practice run for.

zonalAutoshiftStatus

: Required: Yes
: Type: string

The status of zonal autoshift for the resource.

Errors

InternalServerException:: There was an internal server error.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException:: The input requested a resource that was not found.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.

GetAutoshiftObserverNotificationStatus

$result = $client->getAutoshiftObserverNotificationStatus([/* ... */]);
$promise = $client->getAutoshiftObserverNotificationStatusAsync([/* ... */]);

Returns the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.

If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.

For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.

Parameter Syntax

$result = $client->getAutoshiftObserverNotificationStatus([
]);

Parameter Details

Members

Result Syntax

[
    'status' => 'ENABLED|DISABLED',
]

Result Details

Members

status

: Required: Yes
: Type: string

The status of autoshift observer notification. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the Amazon EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.

Errors

InternalServerException:: There was an internal server error.
ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.

GetManagedResource

$result = $client->getManagedResource([/* ... */]);
$promise = $client->getManagedResourceAsync([/* ... */]);

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. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.

At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

Parameter Syntax

$result = $client->getManagedResource([
    'resourceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceIdentifier

: Required: Yes
: Type: string

The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.

At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

Result Syntax

[
    'appliedWeights' => [<float>, ...],
    'arn' => '<string>',
    'autoshifts' => [
        [
            'appliedStatus' => 'APPLIED|NOT_APPLIED',
            'awayFrom' => '<string>',
            'startTime' => <DateTime>,
        ],
        // ...
    ],
    'name' => '<string>',
    'practiceRunConfiguration' => [
        'blockedDates' => ['<string>', ...],
        'blockedWindows' => ['<string>', ...],
        'blockingAlarms' => [
            [
                'alarmIdentifier' => '<string>',
                'type' => 'CLOUDWATCH',
            ],
            // ...
        ],
        'outcomeAlarms' => [
            [
                'alarmIdentifier' => '<string>',
                'type' => 'CLOUDWATCH',
            ],
            // ...
        ],
    ],
    'zonalAutoshiftStatus' => 'ENABLED|DISABLED',
    'zonalShifts' => [
        [
            'appliedStatus' => 'APPLIED|NOT_APPLIED',
            'awayFrom' => '<string>',
            'comment' => '<string>',
            'expiryTime' => <DateTime>,
            'practiceRunOutcome' => 'FAILED|INTERRUPTED|PENDING|SUCCEEDED',
            'resourceIdentifier' => '<string>',
            'startTime' => <DateTime>,
            'zonalShiftId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

appliedWeights

: Required: Yes
: Type: Associative array of custom strings keys (AvailabilityZone) to floats

A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.

arn

: Type: string

The Amazon Resource Name (ARN) for the resource.

autoshifts

: Type: Array of AutoshiftInResource structures

An array of the autoshifts that are active for the resource.

name

: Type: string

The name of the resource.

practiceRunConfiguration

: Type: PracticeRunConfiguration structure

The practice run configuration for zonal autoshift that's associated with the resource.

zonalAutoshiftStatus

: Type: string

The status for zonal autoshift for a resource. When the autoshift status is ENABLED, Amazon Web Services shifts traffic for a resource away from an Availability Zone, on your behalf, when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.

zonalShifts

: Required: Yes
: Type: Array of ZonalShiftInResource structures

The zonal shifts that are currently active for a resource.

Errors

InternalServerException:: There was an internal server error.
ResourceNotFoundException:: The input requested a resource that was not found.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.

ListAutoshifts

$result = $client->listAutoshifts([/* ... */]);
$promise = $client->listAutoshiftsAsync([/* ... */]);

Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts.

Parameter Syntax

$result = $client->listAutoshifts([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'ACTIVE|COMPLETED',
]);

Parameter Details

Members

maxResults

: Type: int

The number of objects that you want to return with this call.

nextToken

: Type: string

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

status

: Type: string

The status of the autoshift.

Result Syntax

[
    'items' => [
        [
            'awayFrom' => '<string>',
            'endTime' => <DateTime>,
            'startTime' => <DateTime>,
            'status' => 'ACTIVE|COMPLETED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

: Type: Array of AutoshiftSummary structures

The items in the response list.

nextToken

: Type: string

Errors

InternalServerException:: There was an internal server error.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.

ListManagedResources

$result = $client->listManagedResources([/* ... */]);
$promise = $client->listManagedResourcesAsync([/* ... */]);

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. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.

Parameter Syntax

$result = $client->listManagedResources([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The number of objects that you want to return with this call.

nextToken

: Type: string

Result Syntax

[
    'items' => [
        [
            'appliedWeights' => [<float>, ...],
            'arn' => '<string>',
            'autoshifts' => [
                [
                    'appliedStatus' => 'APPLIED|NOT_APPLIED',
                    'awayFrom' => '<string>',
                    'startTime' => <DateTime>,
                ],
                // ...
            ],
            'availabilityZones' => ['<string>', ...],
            'name' => '<string>',
            'practiceRunStatus' => 'ENABLED|DISABLED',
            'zonalAutoshiftStatus' => 'ENABLED|DISABLED',
            'zonalShifts' => [
                [
                    'appliedStatus' => 'APPLIED|NOT_APPLIED',
                    'awayFrom' => '<string>',
                    'comment' => '<string>',
                    'expiryTime' => <DateTime>,
                    'practiceRunOutcome' => 'FAILED|INTERRUPTED|PENDING|SUCCEEDED',
                    'resourceIdentifier' => '<string>',
                    'startTime' => <DateTime>,
                    'zonalShiftId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

: Required: Yes
: Type: Array of ManagedResourceSummary structures

The items in the response list.

nextToken

: Type: string

Errors

InternalServerException:: There was an internal server error.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.

ListZonalShifts

$result = $client->listZonalShifts([/* ... */]);
$promise = $client->listZonalShiftsAsync([/* ... */]);

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. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.

The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see ">ListAutoshifts.

Parameter Syntax

$result = $client->listZonalShifts([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceIdentifier' => '<string>',
    'status' => 'ACTIVE|EXPIRED|CANCELED',
]);

Parameter Details

Members

maxResults

: Type: int

The number of objects that you want to return with this call.

nextToken

: Type: string

resourceIdentifier

: Type: string

The identifier for the resource that you want to list zonal shifts for. The identifier is the Amazon Resource Name (ARN) for the resource.

status

: Type: string

A status for a zonal shift.

The Status for a zonal shift can have one of the following values:

ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.

Result Syntax

[
    'items' => [
        [
            'awayFrom' => '<string>',
            'comment' => '<string>',
            'expiryTime' => <DateTime>,
            'practiceRunOutcome' => 'FAILED|INTERRUPTED|PENDING|SUCCEEDED',
            'resourceIdentifier' => '<string>',
            'startTime' => <DateTime>,
            'status' => 'ACTIVE|EXPIRED|CANCELED',
            'zonalShiftId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

: Type: Array of ZonalShiftSummary structures

The items in the response list.

nextToken

: Type: string

Errors

InternalServerException:: There was an internal server error.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.

StartZonalShift

$result = $client->startZonalShift([/* ... */]);
$promise = $client->startZonalShiftAsync([/* ... */]);

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 Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services.

At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.

For more information, see Zonal shift in the Amazon Route 53 Application Recovery Controller Developer Guide.

Parameter Syntax

$result = $client->startZonalShift([
    'awayFrom' => '<string>', // REQUIRED
    'comment' => '<string>', // REQUIRED
    'expiresIn' => '<string>', // REQUIRED
    'resourceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

awayFrom

: Required: Yes
: Type: string

comment

: Required: Yes
: Type: string

A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.

expiresIn

: Required: Yes
: Type: string

The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).

If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.

To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:

A lowercase letter m: To specify that the value is in minutes.
A lowercase letter h: To specify that the value is in hours.

For example: 20h means the zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 minutes (2 hours).

resourceIdentifier

: Required: Yes
: Type: string

The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.

At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

Result Syntax

[
    'awayFrom' => '<string>',
    'comment' => '<string>',
    'expiryTime' => <DateTime>,
    'resourceIdentifier' => '<string>',
    'startTime' => <DateTime>,
    'status' => 'ACTIVE|EXPIRED|CANCELED',
    'zonalShiftId' => '<string>',
]

Result Details

Members

awayFrom

: Required: Yes
: Type: string

comment

: Required: Yes
: Type: string

A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.

expiryTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

resourceIdentifier

: Required: Yes
: Type: string

The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.

At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

startTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (UTC) when the zonal shift starts.

status

: Required: Yes
: Type: string

A status for a zonal shift.

The Status for a zonal shift can have one of the following values:

ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.

zonalShiftId

: Required: Yes
: Type: string

The identifier of a zonal shift.

Errors

InternalServerException:: There was an internal server error.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException:: The input requested a resource that was not found.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.

UpdateAutoshiftObserverNotificationStatus

$result = $client->updateAutoshiftObserverNotificationStatus([/* ... */]);
$promise = $client->updateAutoshiftObserverNotificationStatusAsync([/* ... */]);

Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.

For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.

Parameter Syntax

$result = $client->updateAutoshiftObserverNotificationStatus([
    'status' => 'ENABLED|DISABLED', // REQUIRED
]);

Parameter Details

Members

status

: Required: Yes
: Type: string

The status to set for autoshift observer notification. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the Amazon EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.

Result Syntax

[
    'status' => 'ENABLED|DISABLED',
]

Result Details

Members

status

: Required: Yes
: Type: string

The status for autoshift observer notification.

Errors

InternalServerException:: There was an internal server error.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.

UpdatePracticeRunConfiguration

$result = $client->updatePracticeRunConfiguration([/* ... */]);
$promise = $client->updatePracticeRunConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updatePracticeRunConfiguration([
    'blockedDates' => ['<string>', ...],
    'blockedWindows' => ['<string>', ...],
    'blockingAlarms' => [
        [
            'alarmIdentifier' => '<string>', // REQUIRED
            'type' => 'CLOUDWATCH', // REQUIRED
        ],
        // ...
    ],
    'outcomeAlarms' => [
        [
            'alarmIdentifier' => '<string>', // REQUIRED
            'type' => 'CLOUDWATCH', // REQUIRED
        ],
        // ...
    ],
    'resourceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

blockedDates

: Type: Array of strings

Add, change, or remove blocked dates for a practice run in zonal autoshift.

Optionally, you can block practice runs for specific calendar dates. The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.

For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.

blockedWindows

: Type: Array of strings

Add, change, or remove windows of days and times for when you can, optionally, block Route 53 ARC from starting a practice run for a resource.

blockingAlarms

: Type: Array of ControlCondition structures

Add, change, or remove the Amazon CloudWatch alarm that you optionally specify as the blocking alarm for practice runs.

outcomeAlarms

: Type: Array of ControlCondition structures

Specify a new the Amazon CloudWatch alarm as the outcome alarm for practice runs.

resourceIdentifier

: Required: Yes
: Type: string

The identifier for the resource that you want to update the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
    'practiceRunConfiguration' => [
        'blockedDates' => ['<string>', ...],
        'blockedWindows' => ['<string>', ...],
        'blockingAlarms' => [
            [
                'alarmIdentifier' => '<string>',
                'type' => 'CLOUDWATCH',
            ],
            // ...
        ],
        'outcomeAlarms' => [
            [
                'alarmIdentifier' => '<string>',
                'type' => 'CLOUDWATCH',
            ],
            // ...
        ],
    ],
    'zonalAutoshiftStatus' => 'ENABLED|DISABLED',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource that you updated the practice run for.

name

: Required: Yes
: Type: string

The name of the resource that you updated the practice run for.

practiceRunConfiguration

: Required: Yes
: Type: PracticeRunConfiguration structure

The practice run configuration that was updated.

zonalAutoshiftStatus

: Required: Yes
: Type: string

The zonal autoshift status for the resource that you updated the practice run for.

Errors

InternalServerException:: There was an internal server error.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException:: The input requested a resource that was not found.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.

UpdateZonalAutoshiftConfiguration

$result = $client->updateZonalAutoshiftConfiguration([/* ... */]);
$promise = $client->updateZonalAutoshiftConfigurationAsync([/* ... */]);

The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.

You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.

Parameter Syntax

$result = $client->updateZonalAutoshiftConfiguration([
    'resourceIdentifier' => '<string>', // REQUIRED
    'zonalAutoshiftStatus' => 'ENABLED|DISABLED', // REQUIRED
]);

Parameter Details

Members

resourceIdentifier

: Required: Yes
: Type: string

The identifier for the resource that you want to update the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.

zonalAutoshiftStatus

: Required: Yes
: Type: string

The zonal autoshift status for the resource that you want to update the zonal autoshift configuration for. Choose ENABLED to authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery.

Result Syntax

[
    'resourceIdentifier' => '<string>',
    'zonalAutoshiftStatus' => 'ENABLED|DISABLED',
]

Result Details

Members

resourceIdentifier

: Required: Yes
: Type: string

The identifier for the resource that you updated the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.

zonalAutoshiftStatus

: Required: Yes
: Type: string

The updated zonal autoshift status for the resource.

Errors

InternalServerException:: There was an internal server error.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException:: The input requested a resource that was not found.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.

UpdateZonalShift

$result = $client->updateZonalShift([/* ... */]);
$promise = $client->updateZonalShiftAsync([/* ... */]);

Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.

Parameter Syntax

$result = $client->updateZonalShift([
    'comment' => '<string>',
    'expiresIn' => '<string>',
    'zonalShiftId' => '<string>', // REQUIRED
]);

Parameter Details

Members

comment

: Type: string

A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.

expiresIn

: Type: string

To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:

A lowercase letter m: To specify that the value is in minutes.
A lowercase letter h: To specify that the value is in hours.

For example: 20h means the zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 minutes (2 hours).

zonalShiftId

: Required: Yes
: Type: string

The identifier of a zonal shift.

Result Syntax

[
    'awayFrom' => '<string>',
    'comment' => '<string>',
    'expiryTime' => <DateTime>,
    'resourceIdentifier' => '<string>',
    'startTime' => <DateTime>,
    'status' => 'ACTIVE|EXPIRED|CANCELED',
    'zonalShiftId' => '<string>',
]

Result Details

Members

awayFrom

: Required: Yes
: Type: string

comment

: Required: Yes
: Type: string

A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.

expiryTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

resourceIdentifier

: Required: Yes
: Type: string

The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.

At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

startTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (UTC) when the zonal shift starts.

status

: Required: Yes
: Type: string

A status for a zonal shift.

The Status for a zonal shift can have one of the following values:

ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.

zonalShiftId

: Required: Yes
: Type: string

The identifier of a zonal shift.

Errors

InternalServerException:: There was an internal server error.
ConflictException:: The request could not be processed because of conflict in the current state of the resource.
ResourceNotFoundException:: The input requested a resource that was not found.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members

message

: Type: string

AutoshiftInResource

Description

A complex structure that lists an autoshift that is currently active for a managed resource and information about the autoshift.

For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.

Members

appliedStatus

: Required: Yes
: Type: string

The appliedStatus field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus field for a shift that is in progress for a resource can have one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus set to APPLIED.

The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.

For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.

awayFrom

: Required: Yes
: Type: string

The Availability Zone (for example, use1-az1) that traffic is shifted away from for a resource, when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.

startTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (UTC) when the autoshift started.

AutoshiftSummary

Description

Information about an autoshift. Amazon Web Services starts an autoshift to temporarily move traffic for a resource away from an Availability Zone in an Amazon Web Services Region when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers. You can configure zonal autoshift in Route 53 ARC for managed resources in your Amazon Web Services account in a Region. Supported Amazon Web Services resources are automatically registered with Route 53 ARC.

Autoshifts are temporary. When the Availability Zone recovers, Amazon Web Services ends the autoshift, and traffic for the resource is no longer directed to the other Availability Zones in the Region.

You can stop an autoshift for a resource by disabling zonal autoshift.

Members

awayFrom

: Required: Yes
: Type: string

The Availability Zone (for example, use1-az1) that traffic is shifted away from for a resource when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.

endTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (in UTC) when the autoshift ended.

startTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (in UTC) when the autoshift started.

status

: Required: Yes
: Type: string

The status for an autoshift.

ConflictException

Description

The request could not be processed because of conflict in the current state of the resource.

Members

message

: Required: Yes
: Type: string

reason

: Required: Yes
: Type: string

The reason for the conflict exception.

zonalShiftId

: Type: string

The zonal shift ID associated with the conflict exception.

ControlCondition

Description

A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting or to interrupt a practice run in progress.

Control condition alarms do not apply for autoshifts.

For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.

Members

alarmIdentifier

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run.

type

: Required: Yes
: Type: string

The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is CLOUDWATCH.

InternalServerException

Description

There was an internal server error.

Members

message

: Type: string

ManagedResourceSummary

Description

A complex structure for a managed resource in an Amazon Web Services account with information about zonal shifts and autoshifts.

A managed resource is a load balancer that has been registered with Route 53 ARC by Elastic Load Balancing. You can start a zonal shift in Route 53 ARC for a managed resource to temporarily move traffic for the resource away from an Availability Zone in an Amazon Web Services Region. You can also configure zonal autoshift for a managed resource.

At this time, managed resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

Members

appliedWeights

: Type: Associative array of custom strings keys (AvailabilityZone) to floats

A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.

arn

: Type: string

The Amazon Resource Name (ARN) for the managed resource.

autoshifts

: Type: Array of AutoshiftInResource structures

An array of the autoshifts that have been completed for a resource.

availabilityZones

: Required: Yes
: Type: Array of strings

The Availability Zones that a resource is deployed in.

name

: Type: string

The name of the managed resource.

practiceRunStatus

: Type: string

This status tracks whether a practice run configuration exists for a resource. When you configure a practice run for a resource so that a practice run configuration exists, Route 53 ARC sets this value to ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, Route 53 ARC sets the value to DISABLED.

Route 53 ARC updates this status; you can't set a practice run status to ENABLED or DISABLED.

zonalAutoshiftStatus

: Type: string

The status of autoshift for a resource. When you configure zonal autoshift for a resource, you can set the value of the status to ENABLED or DISABLED.

zonalShifts

: Type: Array of ZonalShiftInResource structures

An array of the zonal shifts for a resource.

PracticeRunConfiguration

Description

A practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice run, as well as any blocked dates or blocked windows for the practice run. When a resource has a practice run configuration, Route 53 ARC shifts traffic for the resource weekly for practice runs.

Practice runs are required for zonal autoshift. The zonal shifts that Route 53 ARC starts for practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.

You can update or delete a practice run configuration. Before you delete a practice run configuration, you must disable zonal autoshift for the resource. A practice run configuration is required when zonal autoshift is enabled.

Members

blockedDates

: Type: Array of strings

An array of one or more dates that you can specify when Amazon Web Services does not start practice runs for a resource.

Specify blocked dates, in UTC, in the format YYYY-MM-DD, separated by spaces.

blockedWindows

: Type: Array of strings

An array of one or more windows of days and times that you can block Route 53 ARC from starting practice runs for a resource.

Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM, separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30.

blockingAlarms

: Type: Array of ControlCondition structures

The blocking alarm for practice runs is an optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state.

outcomeAlarms

: Required: Yes
: Type: Array of ControlCondition structures

The outcome alarm for practice runs is an alarm that you specify that ends a practice run when the alarm is in an ALARM state.

ResourceNotFoundException

Description

The input requested a resource that was not found.

Members

message

: Required: Yes
: Type: string

ThrottlingException

Description

The request was denied due to request throttling.

Members

message

: Type: string

ValidationException

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members

message

: Required: Yes
: Type: string

reason

: Required: Yes
: Type: string

The reason for the validation exception.

ZonalShiftInResource

Description

A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.

Members

appliedStatus

: Required: Yes
: Type: string

For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.

awayFrom

: Required: Yes
: Type: string

comment

: Required: Yes
: Type: string

A comment that you enter for a customer-initiated zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.

expiryTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

practiceRunOutcome

: Type: string

The outcome, or end state, returned for a practice run. The following values can be returned:

PENDING: Outcome value when a practice run is in progress.
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed the expected 30 minute zonal shift.
INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed.

For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.

resourceIdentifier

: Required: Yes
: Type: string

The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.

At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

startTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (UTC) when the zonal shift starts.

zonalShiftId

: Required: Yes
: Type: string

The identifier of a zonal shift.

ZonalShiftSummary

Description

Lists information about zonal shifts in Amazon Route 53 Application Recovery Controller, including zonal shifts that you start yourself and zonal shifts that Route 53 ARC starts on your behalf for practice runs with zonal autoshift.

Zonal shifts are temporary, including customer-initiated zonal shifts and the zonal autoshift practice run zonal shifts that Route 53 ARC starts weekly, on your behalf. A zonal shift that a customer starts can be active for up to three days (72 hours). A practice run zonal shift has a 30 minute duration.

Members

awayFrom

: Required: Yes
: Type: string

comment

: Required: Yes
: Type: string

A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.

expiryTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

practiceRunOutcome

: Type: string

The outcome, or end state, of a practice run. The following values can be returned:

PENDING: Outcome value when the practice run is in progress.
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed.
INTERRUPTED: Outcome value when the practice run did not run for the expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome.
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed.

For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.

resourceIdentifier

: Required: Yes
: Type: string

The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.

At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

startTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time (UTC) when the zonal shift starts.

status

: Required: Yes
: Type: string

A status for a zonal shift.

The Status for a zonal shift can have one of the following values:

ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.

zonalShiftId

: Required: Yes
: Type: string

The identifier of a zonal shift.

AWS ARC - Zonal Shift 2022-10-30

Operation Summary

Paginators

Operations

CancelZonalShift

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreatePracticeRunConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeletePracticeRunConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetAutoshiftObserverNotificationStatus

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetManagedResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListAutoshifts

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListManagedResources

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListZonalShifts

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

StartZonalShift

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

UpdateAutoshiftObserverNotificationStatus

Parameter Syntax

Parameter Details

Members