ListHealthChecksBySource
Retrieves a list of the health checks that use a specified health check source.
Results are paginated. If IsTruncated is true, specify the NextMarker value for marker to get more results.
Request Syntax
GET /2013-04-01/healthchecks/source/HealthCheckSourceId?marker=Marker&maxitems=MaxItems HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- HealthCheckSourceId
-
The ID of the health check source whose health checks you want to list.
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
- marker
-
The
NextMarkervalue from the previous response, if the value ofIsTruncatedwastrue. Specify it to get the next group of health checks. IfIsTruncatedwasfalse, there are no more health checks to get.Length Constraints: Maximum length of 64.
- maxitems
-
The maximum number of health checks that you want
ListHealthChecksBySourceto return. Route 53 returns a maximum of 1000 health checks. If you specify a value greater than 1000, Route 53 returns only the first 1000.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListHealthChecksBySourceResponse>
<HealthChecks>
<HealthCheck>
<CallerReference>string</CallerReference>
<CloudWatchAlarmConfiguration>
<ComparisonOperator>string</ComparisonOperator>
<Dimensions>
<Dimension>
<Name>string</Name>
<Value>string</Value>
</Dimension>
</Dimensions>
<EvaluationPeriods>integer</EvaluationPeriods>
<MetricName>string</MetricName>
<Namespace>string</Namespace>
<Period>integer</Period>
<Statistic>string</Statistic>
<Threshold>double</Threshold>
</CloudWatchAlarmConfiguration>
<HealthCheckConfig>
<AlarmIdentifier>
<Name>string</Name>
<Region>string</Region>
</AlarmIdentifier>
<ChildHealthChecks>
<ChildHealthCheck>string</ChildHealthCheck>
</ChildHealthChecks>
<Disabled>boolean</Disabled>
<EnableSNI>boolean</EnableSNI>
<EndpointType>string</EndpointType>
<FailureThreshold>integer</FailureThreshold>
<FullyQualifiedDomainName>string</FullyQualifiedDomainName>
<HealthCheckSourceId>string</HealthCheckSourceId>
<HealthThreshold>integer</HealthThreshold>
<InsufficientDataHealthStatus>string</InsufficientDataHealthStatus>
<Inverted>boolean</Inverted>
<IPAddress>string</IPAddress>
<MeasureLatency>boolean</MeasureLatency>
<Port>integer</Port>
<Regions>
<Region>string</Region>
</Regions>
<RequestInterval>integer</RequestInterval>
<ResourcePath>string</ResourcePath>
<RoutingControlArn>string</RoutingControlArn>
<SearchString>string</SearchString>
<Type>string</Type>
</HealthCheckConfig>
<HealthCheckVersion>long</HealthCheckVersion>
<Id>string</Id>
<LinkedService>
<Description>string</Description>
<ServicePrincipal>string</ServicePrincipal>
</LinkedService>
</HealthCheck>
</HealthChecks>
<IsTruncated>boolean</IsTruncated>
<Marker>string</Marker>
<MaxItems>string</MaxItems>
<NextMarker>string</NextMarker>
</ListHealthChecksBySourceResponse>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- ListHealthChecksBySourceResponse
-
Root level tag for the ListHealthChecksBySourceResponse parameters.
Required: Yes
- HealthChecks
-
A complex type that contains one
HealthCheckelement for each health check that uses the specified health check source.Type: Array of HealthCheck objects
- IsTruncated
-
Specifies whether there are more health checks to list. If the value is
true, specify theNextMarkervalue formarkerto get the next group of health checks.Type: Boolean
- Marker
-
The value that you specified for the
markerparameter in the call toListHealthChecksBySourcethat produced the current response. This value is present for the second and subsequent calls toListHealthChecksBySource.Type: String
Length Constraints: Maximum length of 64.
- MaxItems
-
The value that you specified for the
maxitemsparameter in the call toListHealthChecksBySourcethat produced the current response.Type: String
- NextMarker
-
The identifier of the first health check in the next group of health checks. If
IsTruncatedistrue, specify this value in themarkerparameter of anotherListHealthChecksBySourcerequest.Type: String
Length Constraints: Maximum length of 64.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- InvalidInput
-
The input is not valid.
- message
HTTP Status Code: 400
- NoSuchHealthCheckSource
-
No health check source exists with the specified ID. Verify that the ID is correct and that the health check source hasn't been deleted.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: