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

Result Syntax

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

Result Details

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.

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

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

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

Result Syntax

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

Result Details

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.

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

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

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 the active autoshifts for a specified resource.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

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

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-started 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

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

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

Result Syntax

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

Result Details

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.

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

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

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([/* ... */]);

You can update the zonal autoshift status for a resource, to enable or disable zonal autoshift. When zonal autoshift is ENABLED, Amazon Web Services shifts away resource traffic 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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.