ListRoute53HealthChecks - Amazon Application Recovery Controller

ListRoute53HealthChecks

List the Amazon Route 53 health checks.

Request Parameters

arn

The Amazon Resource Name (ARN) of the Amazon Route 53 health check request.

Type: String

Pattern: arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})

Required: Yes

hostedZoneId

The hosted zone ID for the health checks.

Type: String

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

Required: No

maxResults

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

Type: Integer

Valid Range: Minimum value of 10. Maximum value of 100.

Required: No

nextToken

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.

Type: String

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

Required: No

recordName

The record name for the health checks.

Type: String

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

Required: No

Response Elements

The following elements are returned by the service.

healthChecks

List of the health checks requested.

Type: Array of Route53HealthCheck objects

nextToken

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.

Type: String

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

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

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

HTTP Status Code: 404

See Also

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