2016/04/05 - Amazon Route 53 - 6 updated api methods
{'HealthCheckConfig': {'AlarmIdentifier': {'Name': 'string',
'Region': 'us-east-1 | us-west-1 | '
'us-west-2 | eu-central-1 '
'| eu-west-1 | '
'ap-southeast-1 | '
'ap-southeast-2 | '
'ap-northeast-1 | '
'ap-northeast-2 | '
'sa-east-1'},
'InsufficientDataHealthStatus': 'Healthy | Unhealthy | '
'LastKnownStatus',
'Regions': ['us-east-1 | us-west-1 | us-west-2 | '
'eu-west-1 | ap-southeast-1 | '
'ap-southeast-2 | ap-northeast-1 | '
'sa-east-1'],
'Type': ['CLOUDWATCH_METRIC']}}
Response {'HealthCheck': {'CloudWatchAlarmConfiguration': {'ComparisonOperator': 'GreaterThanOrEqualToThreshold '
'| '
'GreaterThanThreshold '
'| '
'LessThanThreshold '
'| '
'LessThanOrEqualToThreshold',
'Dimensions': [{'Name': 'string',
'Value': 'string'}],
'EvaluationPeriods': 'integer',
'MetricName': 'string',
'Namespace': 'string',
'Period': 'integer',
'Statistic': 'Average | Sum '
'| SampleCount '
'| Maximum | '
'Minimum',
'Threshold': 'double'},
'HealthCheckConfig': {'AlarmIdentifier': {'Name': 'string',
'Region': 'us-east-1 '
'| '
'us-west-1 '
'| '
'us-west-2 '
'| '
'eu-central-1 '
'| '
'eu-west-1 '
'| '
'ap-southeast-1 '
'| '
'ap-southeast-2 '
'| '
'ap-northeast-1 '
'| '
'ap-northeast-2 '
'| '
'sa-east-1'},
'InsufficientDataHealthStatus': 'Healthy '
'| '
'Unhealthy '
'| '
'LastKnownStatus',
'Regions': ['us-east-1 | us-west-1 | '
'us-west-2 | eu-west-1 | '
'ap-southeast-1 | '
'ap-southeast-2 | '
'ap-northeast-1 | '
'sa-east-1'],
'Type': ['CLOUDWATCH_METRIC']}}}
This action creates a new health check.
To create a new health check, send a POST request to the /*Route 53 API version* /healthcheck resource. The request body must include a document with a CreateHealthCheckRequest element. The response returns the CreateHealthCheckResponse element that contains metadata about the health check.
Request Syntax
client.create_health_check(
CallerReference='string',
HealthCheckConfig={
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
],
'EnableSNI': True|False,
'Regions': [
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
'AlarmIdentifier': {
'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
}
)
string
[REQUIRED]
A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a health check. CallerReference can be any unique string; you might choose to use a string that identifies your project.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
dict
[REQUIRED]
A complex type that contains health check configuration.
IPAddress (string) --
IP Address of the instance being checked.
Port (integer) --
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
Type (string) -- [REQUIRED]
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, CALCULATED and CLOUDWATCH_METRIC.
ResourcePath (string) --
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks. The HTTP request is issued to the instance on the given port and path.
FullyQualifiedDomainName (string) --
Fully qualified domain name of the instance to be health checked.
SearchString (string) --
A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks. Amazon Route 53 considers case when searching for SearchString in the response body.
RequestInterval (integer) --
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Amazon Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
MeasureLatency (boolean) --
A Boolean value that indicates whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Amazon Route 53 console.
Inverted (boolean) --
A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Amazon Route 53 considers the health check to be unhealthy.
HealthThreshold (integer) --
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
ChildHealthChecks (list) --
For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
(string) --
EnableSNI (boolean) --
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI , Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.
Regions (list) --
A list of HealthCheckRegion values that you want Amazon Route 53 to use to perform health checks for the specified endpoint. You must specify at least three regions.
(string) --
An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.
AlarmIdentifier (dict) --
A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
Region (string) -- [REQUIRED]
The CloudWatchRegion that the CloudWatch alarm was created in.
Name (string) -- [REQUIRED]
The name of the CloudWatch alarm.
InsufficientDataHealthStatus (string) --
The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus .
dict
Response Syntax
{
'HealthCheck': {
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
],
'EnableSNI': True|False,
'Regions': [
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
'AlarmIdentifier': {
'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
},
'HealthCheckVersion': 123,
'CloudWatchAlarmConfiguration': {
'EvaluationPeriods': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'Period': 123,
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Location': 'string'
}
Response Structure
(dict) --
A complex type containing the response information for the new health check.
HealthCheck (dict) --
A complex type that contains identifying information about the health check.
Id (string) --
The ID of the specified health check.
CallerReference (string) --
A unique string that identifies the request to create the health check.
HealthCheckConfig (dict) --
A complex type that contains the health check configuration.
IPAddress (string) --
IP Address of the instance being checked.
Port (integer) --
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
Type (string) --
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, CALCULATED and CLOUDWATCH_METRIC.
ResourcePath (string) --
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks. The HTTP request is issued to the instance on the given port and path.
FullyQualifiedDomainName (string) --
Fully qualified domain name of the instance to be health checked.
SearchString (string) --
A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks. Amazon Route 53 considers case when searching for SearchString in the response body.
RequestInterval (integer) --
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Amazon Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
MeasureLatency (boolean) --
A Boolean value that indicates whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Amazon Route 53 console.
Inverted (boolean) --
A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Amazon Route 53 considers the health check to be unhealthy.
HealthThreshold (integer) --
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
ChildHealthChecks (list) --
For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
(string) --
EnableSNI (boolean) --
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI , Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.
Regions (list) --
A list of HealthCheckRegion values that you want Amazon Route 53 to use to perform health checks for the specified endpoint. You must specify at least three regions.
(string) --
An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.
AlarmIdentifier (dict) --
A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
Region (string) --
The CloudWatchRegion that the CloudWatch alarm was created in.
Name (string) --
The name of the CloudWatch alarm.
InsufficientDataHealthStatus (string) --
The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus .
HealthCheckVersion (integer) --
The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
CloudWatchAlarmConfiguration (dict) --
For CLOUDWATCH_METRIC health checks, a complex type that contains information about the CloudWatch alarm that you're associating with the health check.
EvaluationPeriods (integer) --
The number of periods over which data is compared to the specified threshold.
Threshold (float) --
The value that the metric is compared with to determine the state of the alarm. For example, if you want the health check to fail if the average TCP connection time is greater than 500 milliseconds for more than 60 seconds, the threshold is 500.
ComparisonOperator (string) --
The arithmetic operation to use when comparing the specified Statistic and Threshold.
Valid Values are GreaterThanOrEqualToThreshold , GreaterThanThreshold , LessThanThreshold and LessThanOrEqualToThreshold
Period (integer) --
An integer that represents the period in seconds over which the statistic is applied.
MetricName (string) --
The name of the CloudWatch metric that is associated with the CloudWatch alarm.
Namespace (string) --
The namespace of the CloudWatch metric that is associated with the CloudWatch alarm.
Statistic (string) --
The statistic to apply to the CloudWatch metric that is associated with the CloudWatch alarm.
Valid Values are SampleCount , Average , Sum , Minimum and Maximum
Dimensions (list) --
A list of Dimension elements for the CloudWatch metric that is associated with the CloudWatch alarm. For information about the metrics and dimensions that CloudWatch supports, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference .
(dict) --
The name and value of a dimension for a CloudWatch metric.
Name (string) --
The name of the dimension.
Value (string) --
The value of the dimension.
Location (string) --
The unique URL representing the new health check.
{'HealthCheck': {'CloudWatchAlarmConfiguration': {'ComparisonOperator': 'GreaterThanOrEqualToThreshold '
'| '
'GreaterThanThreshold '
'| '
'LessThanThreshold '
'| '
'LessThanOrEqualToThreshold',
'Dimensions': [{'Name': 'string',
'Value': 'string'}],
'EvaluationPeriods': 'integer',
'MetricName': 'string',
'Namespace': 'string',
'Period': 'integer',
'Statistic': 'Average | Sum '
'| SampleCount '
'| Maximum | '
'Minimum',
'Threshold': 'double'},
'HealthCheckConfig': {'AlarmIdentifier': {'Name': 'string',
'Region': 'us-east-1 '
'| '
'us-west-1 '
'| '
'us-west-2 '
'| '
'eu-central-1 '
'| '
'eu-west-1 '
'| '
'ap-southeast-1 '
'| '
'ap-southeast-2 '
'| '
'ap-northeast-1 '
'| '
'ap-northeast-2 '
'| '
'sa-east-1'},
'InsufficientDataHealthStatus': 'Healthy '
'| '
'Unhealthy '
'| '
'LastKnownStatus',
'Regions': ['us-east-1 | us-west-1 | '
'us-west-2 | eu-west-1 | '
'ap-southeast-1 | '
'ap-southeast-2 | '
'ap-northeast-1 | '
'sa-east-1'],
'Type': ['CLOUDWATCH_METRIC']}}}
To retrieve the health check, send a GET request to the /*Route 53 API version* /healthcheck/*health check ID* resource.
Request Syntax
client.get_health_check(
HealthCheckId='string'
)
string
[REQUIRED]
The ID of the health check to retrieve.
dict
Response Syntax
{
'HealthCheck': {
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
],
'EnableSNI': True|False,
'Regions': [
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
'AlarmIdentifier': {
'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
},
'HealthCheckVersion': 123,
'CloudWatchAlarmConfiguration': {
'EvaluationPeriods': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'Period': 123,
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
}
}
}
Response Structure
(dict) --
A complex type containing information about the specified health check.
HealthCheck (dict) --
A complex type that contains the information about the specified health check.
Id (string) --
The ID of the specified health check.
CallerReference (string) --
A unique string that identifies the request to create the health check.
HealthCheckConfig (dict) --
A complex type that contains the health check configuration.
IPAddress (string) --
IP Address of the instance being checked.
Port (integer) --
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
Type (string) --
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, CALCULATED and CLOUDWATCH_METRIC.
ResourcePath (string) --
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks. The HTTP request is issued to the instance on the given port and path.
FullyQualifiedDomainName (string) --
Fully qualified domain name of the instance to be health checked.
SearchString (string) --
A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks. Amazon Route 53 considers case when searching for SearchString in the response body.
RequestInterval (integer) --
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Amazon Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
MeasureLatency (boolean) --
A Boolean value that indicates whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Amazon Route 53 console.
Inverted (boolean) --
A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Amazon Route 53 considers the health check to be unhealthy.
HealthThreshold (integer) --
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
ChildHealthChecks (list) --
For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
(string) --
EnableSNI (boolean) --
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI , Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.
Regions (list) --
A list of HealthCheckRegion values that you want Amazon Route 53 to use to perform health checks for the specified endpoint. You must specify at least three regions.
(string) --
An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.
AlarmIdentifier (dict) --
A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
Region (string) --
The CloudWatchRegion that the CloudWatch alarm was created in.
Name (string) --
The name of the CloudWatch alarm.
InsufficientDataHealthStatus (string) --
The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus .
HealthCheckVersion (integer) --
The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
CloudWatchAlarmConfiguration (dict) --
For CLOUDWATCH_METRIC health checks, a complex type that contains information about the CloudWatch alarm that you're associating with the health check.
EvaluationPeriods (integer) --
The number of periods over which data is compared to the specified threshold.
Threshold (float) --
The value that the metric is compared with to determine the state of the alarm. For example, if you want the health check to fail if the average TCP connection time is greater than 500 milliseconds for more than 60 seconds, the threshold is 500.
ComparisonOperator (string) --
The arithmetic operation to use when comparing the specified Statistic and Threshold.
Valid Values are GreaterThanOrEqualToThreshold , GreaterThanThreshold , LessThanThreshold and LessThanOrEqualToThreshold
Period (integer) --
An integer that represents the period in seconds over which the statistic is applied.
MetricName (string) --
The name of the CloudWatch metric that is associated with the CloudWatch alarm.
Namespace (string) --
The namespace of the CloudWatch metric that is associated with the CloudWatch alarm.
Statistic (string) --
The statistic to apply to the CloudWatch metric that is associated with the CloudWatch alarm.
Valid Values are SampleCount , Average , Sum , Minimum and Maximum
Dimensions (list) --
A list of Dimension elements for the CloudWatch metric that is associated with the CloudWatch alarm. For information about the metrics and dimensions that CloudWatch supports, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference .
(dict) --
The name and value of a dimension for a CloudWatch metric.
Name (string) --
The name of the dimension.
Value (string) --
The value of the dimension.
{'HealthCheckObservations': {'Region': 'us-east-1 | us-west-1 | us-west-2 | '
'eu-west-1 | ap-southeast-1 | '
'ap-southeast-2 | ap-northeast-1 | '
'sa-east-1'}}
If you want to learn why a health check is currently failing or why it failed most recently (if at all), you can get the failure reason for the most recent failure. Send a GET request to the /*Route 53 API version* /healthcheck/*health check ID* /lastfailurereason resource.
Request Syntax
client.get_health_check_last_failure_reason(
HealthCheckId='string'
)
string
[REQUIRED]
The ID of the health check for which you want to retrieve the reason for the most recent failure.
dict
Response Syntax
{
'HealthCheckObservations': [
{
'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
'IPAddress': 'string',
'StatusReport': {
'Status': 'string',
'CheckedTime': datetime(2015, 1, 1)
}
},
]
}
Response Structure
(dict) --
A complex type that contains information about the most recent failure for the specified health check.
HealthCheckObservations (list) --
A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker.
(dict) --
A complex type that contains the IP address of a Amazon Route 53 health checker and the reason for the health check status.
Region (string) --
The HealthCheckRegion of the Amazon Route 53 health checker that performed this health check.
IPAddress (string) --
The IP address of the Amazon Route 53 health checker that performed this health check.
StatusReport (dict) --
A complex type that contains information about the health check status for the current observation.
Status (string) --
The observed health check status.
CheckedTime (datetime) --
The date and time the health check status was observed, in the format YYYY-MM-DDThh:mm:ssZ , as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).
{'HealthCheckObservations': {'Region': 'us-east-1 | us-west-1 | us-west-2 | '
'eu-west-1 | ap-southeast-1 | '
'ap-southeast-2 | ap-northeast-1 | '
'sa-east-1'}}
To retrieve the health check status, send a GET request to the /*Route 53 API version* /healthcheck/*health check ID* /status resource. You can use this call to get a health check's current status.
Request Syntax
client.get_health_check_status(
HealthCheckId='string'
)
string
[REQUIRED]
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.
Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.
The HealthCheckId element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:
You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.
You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. For more information about this configuration, see EvaluateTargetHealth . Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.
For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is * ), in that order, until it finds a resource record set for which the endpoint is healthy.
If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName , specify the domain name of the server (such as us-east-1-www.example.com ), not the name of the resource record sets (example.com).
Warning
In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and then associate the health check with those resource record sets, health check results will be unpredictable.
dict
Response Syntax
{
'HealthCheckObservations': [
{
'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
'IPAddress': 'string',
'StatusReport': {
'Status': 'string',
'CheckedTime': datetime(2015, 1, 1)
}
},
]
}
Response Structure
(dict) --
A complex type that contains information about the status of the specified health check.
HealthCheckObservations (list) --
A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker.
(dict) --
A complex type that contains the IP address of a Amazon Route 53 health checker and the reason for the health check status.
Region (string) --
The HealthCheckRegion of the Amazon Route 53 health checker that performed this health check.
IPAddress (string) --
The IP address of the Amazon Route 53 health checker that performed this health check.
StatusReport (dict) --
A complex type that contains information about the health check status for the current observation.
Status (string) --
The observed health check status.
CheckedTime (datetime) --
The date and time the health check status was observed, in the format YYYY-MM-DDThh:mm:ssZ , as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).
{'HealthChecks': {'CloudWatchAlarmConfiguration': {'ComparisonOperator': 'GreaterThanOrEqualToThreshold '
'| '
'GreaterThanThreshold '
'| '
'LessThanThreshold '
'| '
'LessThanOrEqualToThreshold',
'Dimensions': [{'Name': 'string',
'Value': 'string'}],
'EvaluationPeriods': 'integer',
'MetricName': 'string',
'Namespace': 'string',
'Period': 'integer',
'Statistic': 'Average | Sum '
'| SampleCount '
'| Maximum | '
'Minimum',
'Threshold': 'double'},
'HealthCheckConfig': {'AlarmIdentifier': {'Name': 'string',
'Region': 'us-east-1 '
'| '
'us-west-1 '
'| '
'us-west-2 '
'| '
'eu-central-1 '
'| '
'eu-west-1 '
'| '
'ap-southeast-1 '
'| '
'ap-southeast-2 '
'| '
'ap-northeast-1 '
'| '
'ap-northeast-2 '
'| '
'sa-east-1'},
'InsufficientDataHealthStatus': 'Healthy '
'| '
'Unhealthy '
'| '
'LastKnownStatus',
'Regions': ['us-east-1 | us-west-1 | '
'us-west-2 | eu-west-1 | '
'ap-southeast-1 | '
'ap-southeast-2 | '
'ap-northeast-1 | '
'sa-east-1'],
'Type': ['CLOUDWATCH_METRIC']}}}
To retrieve a list of your health checks, send a GET request to the /*Route 53 API version* /healthcheck resource. The response to this request includes a HealthChecks element with zero, one, or multiple HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.
Note
Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.
Request Syntax
client.list_health_checks(
Marker='string',
MaxItems='string'
)
string
If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
string
Specify the maximum number of health checks to return per page of results.
dict
Response Syntax
{
'HealthChecks': [
{
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
],
'EnableSNI': True|False,
'Regions': [
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
'AlarmIdentifier': {
'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
},
'HealthCheckVersion': 123,
'CloudWatchAlarmConfiguration': {
'EvaluationPeriods': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'Period': 123,
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
],
'Marker': 'string',
'IsTruncated': True|False,
'NextMarker': 'string',
'MaxItems': 'string'
}
Response Structure
(dict) --
A complex type that contains the response for the request.
HealthChecks (list) --
A complex type that contains information about the health checks associated with the current AWS account.
(dict) --
A complex type that contains identifying information about the health check.
Id (string) --
The ID of the specified health check.
CallerReference (string) --
A unique string that identifies the request to create the health check.
HealthCheckConfig (dict) --
A complex type that contains the health check configuration.
IPAddress (string) --
IP Address of the instance being checked.
Port (integer) --
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
Type (string) --
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, CALCULATED and CLOUDWATCH_METRIC.
ResourcePath (string) --
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks. The HTTP request is issued to the instance on the given port and path.
FullyQualifiedDomainName (string) --
Fully qualified domain name of the instance to be health checked.
SearchString (string) --
A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks. Amazon Route 53 considers case when searching for SearchString in the response body.
RequestInterval (integer) --
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Amazon Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
MeasureLatency (boolean) --
A Boolean value that indicates whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Amazon Route 53 console.
Inverted (boolean) --
A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Amazon Route 53 considers the health check to be unhealthy.
HealthThreshold (integer) --
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
ChildHealthChecks (list) --
For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
(string) --
EnableSNI (boolean) --
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI , Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.
Regions (list) --
A list of HealthCheckRegion values that you want Amazon Route 53 to use to perform health checks for the specified endpoint. You must specify at least three regions.
(string) --
An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.
AlarmIdentifier (dict) --
A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
Region (string) --
The CloudWatchRegion that the CloudWatch alarm was created in.
Name (string) --
The name of the CloudWatch alarm.
InsufficientDataHealthStatus (string) --
The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus .
HealthCheckVersion (integer) --
The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
CloudWatchAlarmConfiguration (dict) --
For CLOUDWATCH_METRIC health checks, a complex type that contains information about the CloudWatch alarm that you're associating with the health check.
EvaluationPeriods (integer) --
The number of periods over which data is compared to the specified threshold.
Threshold (float) --
The value that the metric is compared with to determine the state of the alarm. For example, if you want the health check to fail if the average TCP connection time is greater than 500 milliseconds for more than 60 seconds, the threshold is 500.
ComparisonOperator (string) --
The arithmetic operation to use when comparing the specified Statistic and Threshold.
Valid Values are GreaterThanOrEqualToThreshold , GreaterThanThreshold , LessThanThreshold and LessThanOrEqualToThreshold
Period (integer) --
An integer that represents the period in seconds over which the statistic is applied.
MetricName (string) --
The name of the CloudWatch metric that is associated with the CloudWatch alarm.
Namespace (string) --
The namespace of the CloudWatch metric that is associated with the CloudWatch alarm.
Statistic (string) --
The statistic to apply to the CloudWatch metric that is associated with the CloudWatch alarm.
Valid Values are SampleCount , Average , Sum , Minimum and Maximum
Dimensions (list) --
A list of Dimension elements for the CloudWatch metric that is associated with the CloudWatch alarm. For information about the metrics and dimensions that CloudWatch supports, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference .
(dict) --
The name and value of a dimension for a CloudWatch metric.
Name (string) --
The name of the dimension.
Value (string) --
The value of the dimension.
Marker (string) --
If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
IsTruncated (boolean) --
A flag indicating whether there are more health checks to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.
Valid Values: true | false
NextMarker (string) --
Indicates where to continue listing health checks. If ListHealthChecksResponse$IsTruncated is true , make another request to ListHealthChecks and include the value of the NextMarker element in the Marker element to get the next page of results.
MaxItems (string) --
The maximum number of health checks to be included in the response body. If the number of health checks associated with this AWS account exceeds MaxItems , the value of ListHealthChecksResponse$IsTruncated in the response is true . Call ListHealthChecks again and specify the value of ListHealthChecksResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.
{'AlarmIdentifier': {'Name': 'string',
'Region': 'us-east-1 | us-west-1 | us-west-2 | '
'eu-central-1 | eu-west-1 | ap-southeast-1 | '
'ap-southeast-2 | ap-northeast-1 | '
'ap-northeast-2 | sa-east-1'},
'InsufficientDataHealthStatus': 'Healthy | Unhealthy | LastKnownStatus',
'Regions': ['us-east-1 | us-west-1 | us-west-2 | eu-west-1 | ap-southeast-1 | '
'ap-southeast-2 | ap-northeast-1 | sa-east-1']}
Response {'HealthCheck': {'CloudWatchAlarmConfiguration': {'ComparisonOperator': 'GreaterThanOrEqualToThreshold '
'| '
'GreaterThanThreshold '
'| '
'LessThanThreshold '
'| '
'LessThanOrEqualToThreshold',
'Dimensions': [{'Name': 'string',
'Value': 'string'}],
'EvaluationPeriods': 'integer',
'MetricName': 'string',
'Namespace': 'string',
'Period': 'integer',
'Statistic': 'Average | Sum '
'| SampleCount '
'| Maximum | '
'Minimum',
'Threshold': 'double'},
'HealthCheckConfig': {'AlarmIdentifier': {'Name': 'string',
'Region': 'us-east-1 '
'| '
'us-west-1 '
'| '
'us-west-2 '
'| '
'eu-central-1 '
'| '
'eu-west-1 '
'| '
'ap-southeast-1 '
'| '
'ap-southeast-2 '
'| '
'ap-northeast-1 '
'| '
'ap-northeast-2 '
'| '
'sa-east-1'},
'InsufficientDataHealthStatus': 'Healthy '
'| '
'Unhealthy '
'| '
'LastKnownStatus',
'Regions': ['us-east-1 | us-west-1 | '
'us-west-2 | eu-west-1 | '
'ap-southeast-1 | '
'ap-southeast-2 | '
'ap-northeast-1 | '
'sa-east-1'],
'Type': ['CLOUDWATCH_METRIC']}}}
This action updates an existing health check.
To update a health check, send a POST request to the /*Route 53 API version* /healthcheck/*health check ID* resource. The request body must include a document with an UpdateHealthCheckRequest element. The response returns an UpdateHealthCheckResponse element, which contains metadata about the health check.
Request Syntax
client.update_health_check(
HealthCheckId='string',
HealthCheckVersion=123,
IPAddress='string',
Port=123,
ResourcePath='string',
FullyQualifiedDomainName='string',
SearchString='string',
FailureThreshold=123,
Inverted=True|False,
HealthThreshold=123,
ChildHealthChecks=[
'string',
],
EnableSNI=True|False,
Regions=[
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
AlarmIdentifier={
'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
InsufficientDataHealthStatus='Healthy'|'Unhealthy'|'LastKnownStatus'
)
string
[REQUIRED]
The ID of the health check to update.
integer
Optional. When you specify a health check version, Amazon Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using HealthCheckVersion lets you prevent overwriting another change to the health check.
string
The IP address of the resource that you want to check.
Specify this value only if you want to change it.
integer
The port on which you want Amazon Route 53 to open a connection to perform health checks.
Specify this value only if you want to change it.
string
The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.
Specify this value only if you want to change it.
string
Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
string
If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH , the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy. Amazon Route 53 considers case when searching for SearchString in the response body.
Specify this value only if you want to change it.
integer
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
boolean
A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Amazon Route 53 considers the health check to be unhealthy.
Specify this value only if you want to change it.
integer
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
Specify this value only if you want to change it.
list
For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
Specify this value only if you want to change it.
(string) --
boolean
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI , Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.
Specify this value only if you want to change it.
list
A list of HealthCheckRegion values that specify the Amazon EC2 regions that you want Amazon Route 53 to use to perform health checks. You must specify at least three regions.
Note
When you remove a region from the list, Amazon Route 53 will briefly continue to check your endpoint from that region.
Specify this value only if you want to change it.
(string) --
An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.
dict
A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
Region (string) -- [REQUIRED]
The CloudWatchRegion that the CloudWatch alarm was created in.
Name (string) -- [REQUIRED]
The name of the CloudWatch alarm.
string
dict
Response Syntax
{
'HealthCheck': {
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
],
'EnableSNI': True|False,
'Regions': [
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
'AlarmIdentifier': {
'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
},
'HealthCheckVersion': 123,
'CloudWatchAlarmConfiguration': {
'EvaluationPeriods': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'Period': 123,
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
}
}
}
Response Structure
(dict) --
HealthCheck (dict) --
A complex type that contains identifying information about the health check.
Id (string) --
The ID of the specified health check.
CallerReference (string) --
A unique string that identifies the request to create the health check.
HealthCheckConfig (dict) --
A complex type that contains the health check configuration.
IPAddress (string) --
IP Address of the instance being checked.
Port (integer) --
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
Type (string) --
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, CALCULATED and CLOUDWATCH_METRIC.
ResourcePath (string) --
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks. The HTTP request is issued to the instance on the given port and path.
FullyQualifiedDomainName (string) --
Fully qualified domain name of the instance to be health checked.
SearchString (string) --
A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks. Amazon Route 53 considers case when searching for SearchString in the response body.
RequestInterval (integer) --
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Amazon Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
MeasureLatency (boolean) --
A Boolean value that indicates whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Amazon Route 53 console.
Inverted (boolean) --
A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Amazon Route 53 considers the health check to be unhealthy.
HealthThreshold (integer) --
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
ChildHealthChecks (list) --
For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
(string) --
EnableSNI (boolean) --
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI , Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.
Regions (list) --
A list of HealthCheckRegion values that you want Amazon Route 53 to use to perform health checks for the specified endpoint. You must specify at least three regions.
(string) --
An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.
AlarmIdentifier (dict) --
A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
Region (string) --
The CloudWatchRegion that the CloudWatch alarm was created in.
Name (string) --
The name of the CloudWatch alarm.
InsufficientDataHealthStatus (string) --
The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus .
HealthCheckVersion (integer) --
The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
CloudWatchAlarmConfiguration (dict) --
For CLOUDWATCH_METRIC health checks, a complex type that contains information about the CloudWatch alarm that you're associating with the health check.
EvaluationPeriods (integer) --
The number of periods over which data is compared to the specified threshold.
Threshold (float) --
The value that the metric is compared with to determine the state of the alarm. For example, if you want the health check to fail if the average TCP connection time is greater than 500 milliseconds for more than 60 seconds, the threshold is 500.
ComparisonOperator (string) --
The arithmetic operation to use when comparing the specified Statistic and Threshold.
Valid Values are GreaterThanOrEqualToThreshold , GreaterThanThreshold , LessThanThreshold and LessThanOrEqualToThreshold
Period (integer) --
An integer that represents the period in seconds over which the statistic is applied.
MetricName (string) --
The name of the CloudWatch metric that is associated with the CloudWatch alarm.
Namespace (string) --
The namespace of the CloudWatch metric that is associated with the CloudWatch alarm.
Statistic (string) --
The statistic to apply to the CloudWatch metric that is associated with the CloudWatch alarm.
Valid Values are SampleCount , Average , Sum , Minimum and Maximum
Dimensions (list) --
A list of Dimension elements for the CloudWatch metric that is associated with the CloudWatch alarm. For information about the metrics and dimensions that CloudWatch supports, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference .
(dict) --
The name and value of a dimension for a CloudWatch metric.
Name (string) --
The name of the dimension.
Value (string) --
The value of the dimension.