GetManagedResource - Amazon Route 53 Application Recovery Controller

GetManagedResource

Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this AWS 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.

Request Syntax

GET /managedresources/resourceIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceIdentifier

The identifier for the resource that AWS 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.

Length Constraints: Minimum length of 8. Maximum length of 1024.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "appliedWeights": { "string" : number }, "arn": "string", "autoshifts": [ { "appliedStatus": "string", "awayFrom": "string", "startTime": number } ], "name": "string", "practiceRunConfiguration": { "blockedDates": [ "string" ], "blockedWindows": [ "string" ], "blockingAlarms": [ { "alarmIdentifier": "string", "type": "string" } ], "outcomeAlarms": [ { "alarmIdentifier": "string", "type": "string" } ] }, "zonalAutoshiftStatus": "string", "zonalShifts": [ { "appliedStatus": "string", "awayFrom": "string", "comment": "string", "expiryTime": number, "practiceRunOutcome": "string", "resourceIdentifier": "string", "startTime": number, "zonalShiftId": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

appliedWeights

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.

Type: String to float map

Key Length Constraints: Minimum length of 0. Maximum length of 20.

Valid Range: Minimum value of 0.0. Maximum value of 1.0.

arn

The Amazon Resource Name (ARN) for the resource.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 1024.

Pattern: ^arn:.*$

autoshifts

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

Type: Array of AutoshiftInResource objects

name

The name of the resource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

practiceRunConfiguration

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

Type: PracticeRunConfiguration object

zonalAutoshiftStatus

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

Type: String

Valid Values: ENABLED | DISABLED

zonalShifts

The zonal shifts that are currently active for a resource.

Type: Array of ZonalShiftInResource objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

There was an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The input requested a resource that was not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: