2015/09/15 - Amazon Route 53 - 4 updated api methods
{'HealthCheckConfig': {'ChildHealthChecks': ['string'],
'HealthThreshold': 'integer',
'Inverted': 'boolean',
'MeasureLatency': 'boolean',
'Type': {'CALCULATED'}}}
Response {'HealthCheck': {'HealthCheckConfig': {'ChildHealthChecks': ['string'],
'HealthThreshold': 'integer',
'Inverted': 'boolean',
'MeasureLatency': 'boolean',
'Type': {'CALCULATED'}}}}
This action creates a new health check.
To create a new health check, send a POST request to the 2013-04-01/healthcheck resource. The request body must include an XML 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',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
]
}
)
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, and HTTPS_STR_MATCH.
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, 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.
RequestInterval (integer) --
The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each 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 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 Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the 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 Route 53 considers the health check to be unhealthy.
HealthThreshold (integer) --
The minimum number of child health checks that must be healthy for 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) --
dict
Response Syntax
{
'HealthCheck': {
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
]
},
'HealthCheckVersion': 123
},
'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, and HTTPS_STR_MATCH.
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, 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.
RequestInterval (integer) --
The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each 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 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 Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the 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 Route 53 considers the health check to be unhealthy.
HealthThreshold (integer) --
The minimum number of child health checks that must be healthy for 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) --
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.
Location (string) --
The unique URL representing the new health check.
{'HealthCheck': {'HealthCheckConfig': {'ChildHealthChecks': ['string'],
'HealthThreshold': 'integer',
'Inverted': 'boolean',
'MeasureLatency': 'boolean',
'Type': {'CALCULATED'}}}}
To retrieve the health check, send a GET request to the 2013-04-01/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',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
]
},
'HealthCheckVersion': 123
}
}
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, and HTTPS_STR_MATCH.
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, 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.
RequestInterval (integer) --
The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each 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 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 Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the 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 Route 53 considers the health check to be unhealthy.
HealthThreshold (integer) --
The minimum number of child health checks that must be healthy for 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) --
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.
{'HealthChecks': {'HealthCheckConfig': {'ChildHealthChecks': ['string'],
'HealthThreshold': 'integer',
'Inverted': 'boolean',
'MeasureLatency': 'boolean',
'Type': {'CALCULATED'}}}}
To retrieve a list of your health checks, send a GET request to the 2013-04-01/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',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
]
},
'HealthCheckVersion': 123
},
],
'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, and HTTPS_STR_MATCH.
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, 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.
RequestInterval (integer) --
The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each 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 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 Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the 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 Route 53 considers the health check to be unhealthy.
HealthThreshold (integer) --
The minimum number of child health checks that must be healthy for 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) --
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.
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.
{'ChildHealthChecks': ['string'],
'HealthThreshold': 'integer',
'Inverted': 'boolean'}
Response {'HealthCheck': {'HealthCheckConfig': {'ChildHealthChecks': ['string'],
'HealthThreshold': 'integer',
'Inverted': 'boolean',
'MeasureLatency': 'boolean',
'Type': {'CALCULATED'}}}}
This action updates an existing health check.
To update a health check, send a POST request to the 2013-04-01/healthcheck/health check ID resource. The request body must include an XML 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',
]
)
string
[REQUIRED]
The ID of the health check to update.
integer
Optional. When you specify a health check version, 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 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 Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.
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 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 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 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) --
dict
Response Syntax
{
'HealthCheck': {
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
]
},
'HealthCheckVersion': 123
}
}
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, and HTTPS_STR_MATCH.
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, 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.
RequestInterval (integer) --
The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each 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 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 Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the 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 Route 53 considers the health check to be unhealthy.
HealthThreshold (integer) --
The minimum number of child health checks that must be healthy for 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) --
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.