AWS API Changes

2017/11/14 - Amazon Route 53 - 9 updated api methods

Changes When a Route 53 health check or hosted zone is created by a linked AWS service, the object now includes information about the service that created it. Hosted zones or health checks that are created by a linked service can't be updated or deleted using Route 53.

CreateHealthCheck (updated)

Link ¶
Changes (response)

{'HealthCheck': {'LinkedService': {'Description': 'string',
                                   'ServicePrincipal': 'string'}}}

Creates a new health check.

For information about adding health checks to resource record sets, see ResourceRecordSet$HealthCheckId in ChangeResourceRecordSets .

ELB Load Balancers

If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to an Amazon Route 53 health check.

Private Hosted Zones

You can associate health checks with failover resource record sets in a private hosted zone. Note the following:

Amazon Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.
You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.
You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide .

See also: AWS API Documentation

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-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
            'Name': 'string'
        },
        'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
    }
)

type CallerReference

string

param CallerReference

[REQUIRED]

A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks:

If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Amazon Route 53 returns the settings for the existing health check.
If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Amazon Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Amazon Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Amazon Route 53 creates the health check.

type HealthCheckConfig

dict

param HealthCheckConfig

[REQUIRED]

A complex type that contains the response to a CreateHealthCheck request.

IPAddress (string) --

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress , Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval . Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress :
- IPv4 address : four values between 0 and 255, separated by periods (.), for example, 192.0.2.44 .
- IPv6 address : eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 . You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345 .
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress . This ensures that the IP address of your instance will never change.

For more information, see HealthCheckConfig$FullyQualifiedDomainName .

Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress .
Port (integer) --

The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress .
Type (string) -- [REQUIRED]

The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

Warning

You can't change the value of Type after you create a health check.

You can create the following types of health checks:
- HTTP : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
- HTTPS : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
Warning

If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.
- HTTP_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
- HTTPS_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
- TCP : Amazon Route 53 tries to establish a TCP connection.
- CLOUDWATCH_METRIC : The health check is associated with a CloudWatch alarm. If the state of the alarm is OK , the health check is considered healthy. If the state is ALARM , the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM , the health check status depends on the setting for InsufficientDataHealthStatus : Healthy , Unhealthy , or LastKnownStatus .
- CALCULATED : For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold .
For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide .
ResourcePath (string) --

The path, if any, 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.
FullyQualifiedDomainName (string) --

Amazon Route 53 behavior depends on whether you specify a value for IPAddress .

If you specify a value for IPAddress :

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.

When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:
- If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type , Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
- If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type , Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
- If you specify another value for Port and any value except TCP for Type , Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.
If you don't specify a value for FullyQualifiedDomainName , Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.

**If you don't specify a value for IPAddress ** :

Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval . Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.

Note

If you don't specify a value for IPAddress , Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName , the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName , 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-2-www.example.com), not the name of the resource record sets (www.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 you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value that you specify for Type is HTTP , HTTPS , HTTP_STR_MATCH , or HTTPS_STR_MATCH , Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress . If the value of Type is TCP , Amazon Route 53 doesn't pass a Host header.
SearchString (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.
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.

Warning

You can't change the value of RequestInterval after you create a health check.

If you don't specify a value for RequestInterval , the default value is 30 seconds.
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. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide .

If you don't specify a value for FailureThreshold , the default value is three health checks.
MeasureLatency (boolean) --

Specify 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 on the Health Checks page in the Amazon Route 53 console.

Warning

You can't change the value of MeasureLatency after you create a health check.
Inverted (boolean) --

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
HealthThreshold (integer) --

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.

Note the following:
- If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
- If you specify 0 , Amazon Route 53 always considers this health check to be healthy.
ChildHealthChecks (list) --

(CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.
- (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. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure . A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName . If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName , a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.
Regions (list) --

A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.

If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values .

If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
- (string) --
AlarmIdentifier (dict) --

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
- Region (string) -- [REQUIRED]
  
  A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
  
  For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference .
- Name (string) -- [REQUIRED]
  
  The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
InsufficientDataHealthStatus (string) --

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
- Healthy : Amazon Route 53 considers the health check to be healthy.
- Unhealthy : Amazon Route 53 considers the health check to be unhealthy.
- LastKnownStatus : Amazon Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

rtype

dict

returns

Response Syntax

{
    'HealthCheck': {
        'Id': 'string',
        'CallerReference': 'string',
        'LinkedService': {
            'ServicePrincipal': 'string',
            'Description': '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-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-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 identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.
  - CallerReference (string) --
    
    A unique string that you specified when you created the health check.
  - LinkedService (dict) --
    
    If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53.
    - ServicePrincipal (string) --
      
      If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
    - Description (string) --
      
      If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
  - HealthCheckConfig (dict) --
    
    A complex type that contains detailed information about one health check.
    - IPAddress (string) --
      
      The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress , Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval . Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint.
      
      Use one of the following formats for the value of IPAddress :
      - IPv4 address : four values between 0 and 255, separated by periods (.), for example, 192.0.2.44 .
      - IPv6 address : eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 . You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345 .
      If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress . This ensures that the IP address of your instance will never change.
      
      For more information, see HealthCheckConfig$FullyQualifiedDomainName .
      
      Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
      When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress .
    - Port (integer) --
      
      The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress .
    - Type (string) --
      
      The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
      
      Warning
      
      You can't change the value of Type after you create a health check.
      
      You can create the following types of health checks:
      - HTTP : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
      - HTTPS : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
      Warning
      
      If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.
      - HTTP_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
      - HTTPS_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
      - TCP : Amazon Route 53 tries to establish a TCP connection.
      - CLOUDWATCH_METRIC : The health check is associated with a CloudWatch alarm. If the state of the alarm is OK , the health check is considered healthy. If the state is ALARM , the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM , the health check status depends on the setting for InsufficientDataHealthStatus : Healthy , Unhealthy , or LastKnownStatus .
      - CALCULATED : For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold .
      For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide .
    - ResourcePath (string) --
      
      The path, if any, 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.
    - FullyQualifiedDomainName (string) --
      
      Amazon Route 53 behavior depends on whether you specify a value for IPAddress .
      
      If you specify a value for IPAddress :
      
      Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.
      
      When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:
      - If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type , Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
      - If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type , Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
      - If you specify another value for Port and any value except TCP for Type , Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.
      If you don't specify a value for FullyQualifiedDomainName , Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.
      
      **If you don't specify a value for IPAddress ** :
      
      Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval . Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.
      
      Note
      
      If you don't specify a value for IPAddress , Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName , the health check fails with a "DNS resolution failed" error.
      
      If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName , 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-2-www.example.com), not the name of the resource record sets (www.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 you then associate the health check with those resource record sets, health check results will be unpredictable.
      
      In addition, if the value that you specify for Type is HTTP , HTTPS , HTTP_STR_MATCH , or HTTPS_STR_MATCH , Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress . If the value of Type is TCP , Amazon Route 53 doesn't pass a Host header.
    - SearchString (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.
    - 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.
      
      Warning
      
      You can't change the value of RequestInterval after you create a health check.
      
      If you don't specify a value for RequestInterval , the default value is 30 seconds.
    - 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. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide .
      
      If you don't specify a value for FailureThreshold , the default value is three health checks.
    - MeasureLatency (boolean) --
      
      Specify 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 on the Health Checks page in the Amazon Route 53 console.
      
      Warning
      
      You can't change the value of MeasureLatency after you create a health check.
    - Inverted (boolean) --
      
      Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
    - HealthThreshold (integer) --
      
      The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.
      
      Note the following:
      - If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
      - If you specify 0 , Amazon Route 53 always considers this health check to be healthy.
    - ChildHealthChecks (list) --
      
      (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.
      - (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. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.
      
      Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure . A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.
      
      The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName . If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName , a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.
    - Regions (list) --
      
      A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.
      
      If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values .
      
      If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
      - (string) --
    - AlarmIdentifier (dict) --
      
      A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
      - Region (string) --
        
        A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
        
        For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference .
      - Name (string) --
        
        The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
    - InsufficientDataHealthStatus (string) --
      
      When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
      - Healthy : Amazon Route 53 considers the health check to be healthy.
      - Unhealthy : Amazon Route 53 considers the health check to be unhealthy.
      - LastKnownStatus : Amazon Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.
  - 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) --
    
    A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.
    - EvaluationPeriods (integer) --
      
      For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.
    - Threshold (float) --
      
      For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.
    - ComparisonOperator (string) --
      
      For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
    - Period (integer) --
      
      For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.
    - MetricName (string) --
      
      The name of the CloudWatch metric that the alarm is associated with.
    - Namespace (string) --
      
      The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide .
    - Statistic (string) --
      
      For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
    - Dimensions (list) --
      
      For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide .
      - (dict) --
        
        For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension.
        
        Name (string) --
        
        For the metric that the CloudWatch alarm is associated with, the name of one dimension.
        
        Value (string) --
        
        For the metric that the CloudWatch alarm is associated with, the value of one dimension.
- Location (string) --
  
  The unique URL representing the new health check.

CreateHostedZone (updated)

Link ¶
Changes (response)

{'HostedZone': {'LinkedService': {'Description': 'string',
                                  'ServicePrincipal': 'string'}}}

Creates a new public hosted zone, which you use to specify how the Domain Name System (DNS) routes traffic on the Internet for a domain, such as example.com, and its subdomains.

Warning

You can't convert a public hosted zones to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.

For more information about charges for hosted zones, see Amazon Route 53 Pricing .

Note the following:

You can't create a hosted zone for a top-level domain (TLD).
Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Amazon Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide . If you want to use the same name servers for multiple hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element.
If your domain is registered with a registrar other than Amazon Route 53, you must update the name servers with your registrar to make Amazon Route 53 your DNS service. For more information, see Configuring Amazon Route 53 as your DNS Service in the Amazon Route 53 Developer Guide .

When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING . This means that the NS and SOA records are not yet available on all Amazon Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC .

See also: AWS API Documentation

Request Syntax

client.create_hosted_zone(
    Name='string',
    VPC={
        'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'ca-central-1'|'cn-north-1',
        'VPCId': 'string'
    },
    CallerReference='string',
    HostedZoneConfig={
        'Comment': 'string',
        'PrivateZone': True|False
    },
    DelegationSetId='string'
)

type Name

string

param Name

[REQUIRED]

The name of the domain. For resource record types that include a domain name, specify a fully qualified domain name, for example, www.example.com . The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Amazon Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet .

type VPC

dict

param VPC

(Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.

You can specify only one Amazon VPC when you create a private hosted zone. To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

VPCRegion (string) --

(Private hosted zones only) The region in which you created an Amazon VPC.
VPCId (string) --

(Private hosted zones only) The ID of an Amazon VPC.

type CallerReference

string

param CallerReference

[REQUIRED]

A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp.

type HostedZoneConfig

dict

param HostedZoneConfig

(Optional) A complex type that contains the following optional values:

For public and private hosted zones, an optional comment
For private hosted zones, an optional PrivateZone element

If you don't specify a comment or the PrivateZone element, omit HostedZoneConfig and the other elements.

Comment (string) --

Any comments that you want to include about the hosted zone.
PrivateZone (boolean) --

A value that indicates whether this is a private hosted zone.

type DelegationSetId

string

param DelegationSetId

If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet .

rtype

dict

returns

Response Syntax

{
    'HostedZone': {
        'Id': 'string',
        'Name': 'string',
        'CallerReference': 'string',
        'Config': {
            'Comment': 'string',
            'PrivateZone': True|False
        },
        'ResourceRecordSetCount': 123,
        'LinkedService': {
            'ServicePrincipal': 'string',
            'Description': 'string'
        }
    },
    'ChangeInfo': {
        'Id': 'string',
        'Status': 'PENDING'|'INSYNC',
        'SubmittedAt': datetime(2015, 1, 1),
        'Comment': 'string'
    },
    'DelegationSet': {
        'Id': 'string',
        'CallerReference': 'string',
        'NameServers': [
            'string',
        ]
    },
    'VPC': {
        'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'ca-central-1'|'cn-north-1',
        'VPCId': 'string'
    },
    'Location': 'string'
}

Response Structure

(dict) --

A complex type containing the response information for the hosted zone.
- HostedZone (dict) --
  
  A complex type that contains general information about the hosted zone.
  - Id (string) --
    
    The ID that Amazon Route 53 assigned to the hosted zone when you created it.
  - Name (string) --
    
    The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
    
    For information about how to specify characters other than a-z , 0-9 , and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone .
  - CallerReference (string) --
    
    The value that you specified for CallerReference when you created the hosted zone.
  - Config (dict) --
    
    A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.
    - Comment (string) --
      
      Any comments that you want to include about the hosted zone.
    - PrivateZone (boolean) --
      
      A value that indicates whether this is a private hosted zone.
  - ResourceRecordSetCount (integer) --
    
    The number of resource record sets in the hosted zone.
  - LinkedService (dict) --
    
    If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Amazon Route 53.
    - ServicePrincipal (string) --
      
      If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
    - Description (string) --
      
      If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
- ChangeInfo (dict) --
  
  A complex type that contains information about the CreateHostedZone request.
  - Id (string) --
    
    The ID of the request.
  - Status (string) --
    
    The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
  - SubmittedAt (datetime) --
    
    The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.
  - Comment (string) --
    
    A complex type that describes change information about changes made to your hosted zone.
    
    This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
- DelegationSet (dict) --
  
  A complex type that describes the name servers for this hosted zone.
  - Id (string) --
    
    The ID that Amazon Route 53 assigns to a reusable delegation set.
  - CallerReference (string) --
    
    The value that you specified for CallerReference when you created the reusable delegation set.
  - NameServers (list) --
    
    A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.
    - (string) --
- VPC (dict) --
  
  A complex type that contains information about an Amazon VPC that you associated with this hosted zone.
  - VPCRegion (string) --
    
    (Private hosted zones only) The region in which you created an Amazon VPC.
  - VPCId (string) --
    
    (Private hosted zones only) The ID of an Amazon VPC.
- Location (string) --
  
  The unique URL representing the new hosted zone.

GetHealthCheck (updated)

Link ¶
Changes (response)

{'HealthCheck': {'LinkedService': {'Description': 'string',
                                   'ServicePrincipal': 'string'}}}

Gets information about a specified health check.

See also: AWS API Documentation

Request Syntax

client.get_health_check(
    HealthCheckId='string'
)

type HealthCheckId

string

param HealthCheckId

[REQUIRED]

The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

rtype

dict

returns

Response Syntax

{
    'HealthCheck': {
        'Id': 'string',
        'CallerReference': 'string',
        'LinkedService': {
            'ServicePrincipal': 'string',
            'Description': '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-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-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 that contains the response to a GetHealthCheck request.
- HealthCheck (dict) --
  
  A complex type that contains information about one health check that is associated with the current AWS account.
  - Id (string) --
    
    The identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.
  - CallerReference (string) --
    
    A unique string that you specified when you created the health check.
  - LinkedService (dict) --
    
    If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53.
    - ServicePrincipal (string) --
      
      If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
    - Description (string) --
      
      If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
  - HealthCheckConfig (dict) --
    
    A complex type that contains detailed information about one health check.
    - IPAddress (string) --
      
      The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress , Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval . Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint.
      
      Use one of the following formats for the value of IPAddress :
      - IPv4 address : four values between 0 and 255, separated by periods (.), for example, 192.0.2.44 .
      - IPv6 address : eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 . You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345 .
      If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress . This ensures that the IP address of your instance will never change.
      
      For more information, see HealthCheckConfig$FullyQualifiedDomainName .
      
      Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
      When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress .
    - Port (integer) --
      
      The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress .
    - Type (string) --
      
      The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
      
      Warning
      
      You can't change the value of Type after you create a health check.
      
      You can create the following types of health checks:
      - HTTP : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
      - HTTPS : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
      Warning
      
      If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.
      - HTTP_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
      - HTTPS_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
      - TCP : Amazon Route 53 tries to establish a TCP connection.
      - CLOUDWATCH_METRIC : The health check is associated with a CloudWatch alarm. If the state of the alarm is OK , the health check is considered healthy. If the state is ALARM , the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM , the health check status depends on the setting for InsufficientDataHealthStatus : Healthy , Unhealthy , or LastKnownStatus .
      - CALCULATED : For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold .
      For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide .
    - ResourcePath (string) --
      
      The path, if any, 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.
    - FullyQualifiedDomainName (string) --
      
      Amazon Route 53 behavior depends on whether you specify a value for IPAddress .
      
      If you specify a value for IPAddress :
      
      Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.
      
      When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:
      - If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type , Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
      - If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type , Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
      - If you specify another value for Port and any value except TCP for Type , Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.
      If you don't specify a value for FullyQualifiedDomainName , Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.
      
      **If you don't specify a value for IPAddress ** :
      
      Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval . Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.
      
      Note
      
      If you don't specify a value for IPAddress , Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName , the health check fails with a "DNS resolution failed" error.
      
      If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName , 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-2-www.example.com), not the name of the resource record sets (www.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 you then associate the health check with those resource record sets, health check results will be unpredictable.
      
      In addition, if the value that you specify for Type is HTTP , HTTPS , HTTP_STR_MATCH , or HTTPS_STR_MATCH , Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress . If the value of Type is TCP , Amazon Route 53 doesn't pass a Host header.
    - SearchString (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.
    - 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.
      
      Warning
      
      You can't change the value of RequestInterval after you create a health check.
      
      If you don't specify a value for RequestInterval , the default value is 30 seconds.
    - 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. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide .
      
      If you don't specify a value for FailureThreshold , the default value is three health checks.
    - MeasureLatency (boolean) --
      
      Specify 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 on the Health Checks page in the Amazon Route 53 console.
      
      Warning
      
      You can't change the value of MeasureLatency after you create a health check.
    - Inverted (boolean) --
      
      Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
    - HealthThreshold (integer) --
      
      The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.
      
      Note the following:
      - If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
      - If you specify 0 , Amazon Route 53 always considers this health check to be healthy.
    - ChildHealthChecks (list) --
      
      (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.
      - (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. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.
      
      Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure . A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.
      
      The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName . If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName , a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.
    - Regions (list) --
      
      A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.
      
      If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values .
      
      If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
      - (string) --
    - AlarmIdentifier (dict) --
      
      A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
      - Region (string) --
        
        A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
        
        For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference .
      - Name (string) --
        
        The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
    - InsufficientDataHealthStatus (string) --
      
      When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
      - Healthy : Amazon Route 53 considers the health check to be healthy.
      - Unhealthy : Amazon Route 53 considers the health check to be unhealthy.
      - LastKnownStatus : Amazon Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.
  - 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) --
    
    A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.
    - EvaluationPeriods (integer) --
      
      For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.
    - Threshold (float) --
      
      For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.
    - ComparisonOperator (string) --
      
      For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
    - Period (integer) --
      
      For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.
    - MetricName (string) --
      
      The name of the CloudWatch metric that the alarm is associated with.
    - Namespace (string) --
      
      The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide .
    - Statistic (string) --
      
      For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
    - Dimensions (list) --
      
      For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide .
      - (dict) --
        
        For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension.
        
        Name (string) --
        
        For the metric that the CloudWatch alarm is associated with, the name of one dimension.
        
        Value (string) --
        
        For the metric that the CloudWatch alarm is associated with, the value of one dimension.

GetHostedZone (updated)

Link ¶
Changes (response)

{'HostedZone': {'LinkedService': {'Description': 'string',
                                  'ServicePrincipal': 'string'}}}

Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.

See also: AWS API Documentation

Request Syntax

client.get_hosted_zone(
    Id='string'
)

type Id

string

param Id

[REQUIRED]

The ID of the hosted zone that you want to get information about.

rtype

dict

returns

Response Syntax

{
    'HostedZone': {
        'Id': 'string',
        'Name': 'string',
        'CallerReference': 'string',
        'Config': {
            'Comment': 'string',
            'PrivateZone': True|False
        },
        'ResourceRecordSetCount': 123,
        'LinkedService': {
            'ServicePrincipal': 'string',
            'Description': 'string'
        }
    },
    'DelegationSet': {
        'Id': 'string',
        'CallerReference': 'string',
        'NameServers': [
            'string',
        ]
    },
    'VPCs': [
        {
            'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'ca-central-1'|'cn-north-1',
            'VPCId': 'string'
        },
    ]
}

Response Structure

(dict) --

A complex type that contain the response to a GetHostedZone request.
- HostedZone (dict) --
  
  A complex type that contains general information about the specified hosted zone.
  - Id (string) --
    
    The ID that Amazon Route 53 assigned to the hosted zone when you created it.
  - Name (string) --
    
    The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
    
    For information about how to specify characters other than a-z , 0-9 , and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone .
  - CallerReference (string) --
    
    The value that you specified for CallerReference when you created the hosted zone.
  - Config (dict) --
    
    A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.
    - Comment (string) --
      
      Any comments that you want to include about the hosted zone.
    - PrivateZone (boolean) --
      
      A value that indicates whether this is a private hosted zone.
  - ResourceRecordSetCount (integer) --
    
    The number of resource record sets in the hosted zone.
  - LinkedService (dict) --
    
    If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Amazon Route 53.
    - ServicePrincipal (string) --
      
      If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
    - Description (string) --
      
      If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
- DelegationSet (dict) --
  
  A complex type that lists the Amazon Route 53 name servers for the specified hosted zone.
  - Id (string) --
    
    The ID that Amazon Route 53 assigns to a reusable delegation set.
  - CallerReference (string) --
    
    The value that you specified for CallerReference when you created the reusable delegation set.
  - NameServers (list) --
    
    A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.
    - (string) --
- VPCs (list) --
  
  A complex type that contains information about the VPCs that are associated with the specified hosted zone.
  - (dict) --
    
    (Private hosted zones only) A complex type that contains information about an Amazon VPC.
    - VPCRegion (string) --
      
      (Private hosted zones only) The region in which you created an Amazon VPC.
    - VPCId (string) --
      
      (Private hosted zones only) The ID of an Amazon VPC.

ListHealthChecks (updated)

Link ¶
Changes (response)

{'HealthChecks': {'LinkedService': {'Description': 'string',
                                    'ServicePrincipal': 'string'}}}

Retrieve a list of the health checks that are associated with the current AWS account.

See also: AWS API Documentation

Request Syntax

client.list_health_checks(
    Marker='string',
    MaxItems='string'
)

type Marker

string

param Marker

If the value of IsTruncated in the previous response was true , you have more health checks. To get another group, submit another ListHealthChecks request.

For the value of marker , specify the value of NextMarker from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false , there are no more health checks to get.

type MaxItems

string

param MaxItems

The maximum number of health checks that you want ListHealthChecks to return in response to the current request. 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 health checks.

rtype

dict

returns

Response Syntax

{
    'HealthChecks': [
        {
            'Id': 'string',
            'CallerReference': 'string',
            'LinkedService': {
                'ServicePrincipal': 'string',
                'Description': '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-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-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 to a ListHealthChecks request.
- HealthChecks (list) --
  
  A complex type that contains one HealthCheck element for each health check that is associated with the current AWS account.
  - (dict) --
    
    A complex type that contains information about one health check that is associated with the current AWS account.
    - Id (string) --
      
      The identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.
    - CallerReference (string) --
      
      A unique string that you specified when you created the health check.
    - LinkedService (dict) --
      
      If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53.
      - ServicePrincipal (string) --
        
        If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
      - Description (string) --
        
        If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
    - HealthCheckConfig (dict) --
      
      A complex type that contains detailed information about one health check.
      - IPAddress (string) --
        
        The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress , Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval . Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint.
        
        Use one of the following formats for the value of IPAddress :
        
        IPv4 address : four values between 0 and 255, separated by periods (.), for example, 192.0.2.44 .
        
        IPv6 address : eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 . You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345 .
        
        If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress . This ensures that the IP address of your instance will never change.
        
        For more information, see HealthCheckConfig$FullyQualifiedDomainName .
        
        Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
        
        RFC 5735, Special Use IPv4 Addresses
        
        RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space
        
        RFC 5156, Special-Use IPv6 Addresses
        
        When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress .
      - Port (integer) --
        
        The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress .
      - Type (string) --
        
        The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
        
        Warning
        
        You can't change the value of Type after you create a health check.
        
        You can create the following types of health checks:
        
        HTTP : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
        
        HTTPS : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
        
        Warning
        
        If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.
        
        HTTP_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
        
        HTTPS_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
        
        TCP : Amazon Route 53 tries to establish a TCP connection.
        
        CLOUDWATCH_METRIC : The health check is associated with a CloudWatch alarm. If the state of the alarm is OK , the health check is considered healthy. If the state is ALARM , the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM , the health check status depends on the setting for InsufficientDataHealthStatus : Healthy , Unhealthy , or LastKnownStatus .
        
        CALCULATED : For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold .
        
        For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide .
      - ResourcePath (string) --
        
        The path, if any, 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.
      - FullyQualifiedDomainName (string) --
        
        Amazon Route 53 behavior depends on whether you specify a value for IPAddress .
        
        If you specify a value for IPAddress :
        
        Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.
        
        When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:
        
        If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type , Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
        
        If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type , Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
        
        If you specify another value for Port and any value except TCP for Type , Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.
        
        If you don't specify a value for FullyQualifiedDomainName , Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.
        
        **If you don't specify a value for IPAddress ** :
        
        Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval . Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.
        
        Note
        
        If you don't specify a value for IPAddress , Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName , the health check fails with a "DNS resolution failed" error.
        
        If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName , 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-2-www.example.com), not the name of the resource record sets (www.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 you then associate the health check with those resource record sets, health check results will be unpredictable.
        
        In addition, if the value that you specify for Type is HTTP , HTTPS , HTTP_STR_MATCH , or HTTPS_STR_MATCH , Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress . If the value of Type is TCP , Amazon Route 53 doesn't pass a Host header.
      - SearchString (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.
      - 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.
        
        Warning
        
        You can't change the value of RequestInterval after you create a health check.
        
        If you don't specify a value for RequestInterval , the default value is 30 seconds.
      - 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. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide .
        
        If you don't specify a value for FailureThreshold , the default value is three health checks.
      - MeasureLatency (boolean) --
        
        Specify 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 on the Health Checks page in the Amazon Route 53 console.
        
        Warning
        
        You can't change the value of MeasureLatency after you create a health check.
      - Inverted (boolean) --
        
        Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
      - HealthThreshold (integer) --
        
        The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.
        
        Note the following:
        
        If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
        
        If you specify 0 , Amazon Route 53 always considers this health check to be healthy.
      - ChildHealthChecks (list) --
        
        (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.
        
        (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. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.
        
        Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure . A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.
        
        The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName . If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName , a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.
      - Regions (list) --
        
        A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.
        
        If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values .
        
        If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
        
        (string) --
      - AlarmIdentifier (dict) --
        
        A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
        
        Region (string) --
        
        A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
        
        For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference .
        
        Name (string) --
        
        The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
      - InsufficientDataHealthStatus (string) --
        
        When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
        
        Healthy : Amazon Route 53 considers the health check to be healthy.
        
        Unhealthy : Amazon Route 53 considers the health check to be unhealthy.
        
        LastKnownStatus : Amazon Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.
    - 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) --
      
      A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.
      - EvaluationPeriods (integer) --
        
        For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.
      - Threshold (float) --
        
        For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.
      - ComparisonOperator (string) --
        
        For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
      - Period (integer) --
        
        For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.
      - MetricName (string) --
        
        The name of the CloudWatch metric that the alarm is associated with.
      - Namespace (string) --
        
        The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide .
      - Statistic (string) --
        
        For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
      - Dimensions (list) --
        
        For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide .
        
        (dict) --
        
        For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension.
        
        Name (string) --
        
        For the metric that the CloudWatch alarm is associated with, the name of one dimension.
        
        Value (string) --
        
        For the metric that the CloudWatch alarm is associated with, the value of one dimension.
- Marker (string) --
  
  For the second and subsequent calls to ListHealthChecks , Marker is the value that you specified for the marker parameter in the previous request.
- IsTruncated (boolean) --
  
  A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of health checks by submitting another ListHealthChecks request and specifying the value of NextMarker in the marker parameter.
- NextMarker (string) --
  
  If IsTruncated is true , the value of NextMarker identifies the first health check that Amazon Route 53 returns if you submit another ListHealthChecks request and specify the value of NextMarker in the marker parameter.
- MaxItems (string) --
  
  The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the current response.

ListHostedZones (updated)

Link ¶
Changes (response)

{'HostedZones': {'LinkedService': {'Description': 'string',
                                   'ServicePrincipal': 'string'}}}

Retrieves a list of the public and private hosted zones that are associated with the current AWS account. The response includes a HostedZones child element for each hosted zone.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100.

See also: AWS API Documentation

Request Syntax

client.list_hosted_zones(
    Marker='string',
    MaxItems='string',
    DelegationSetId='string'
)

type Marker

string

param Marker

If the value of IsTruncated in the previous response was true , you have more hosted zones. To get more hosted zones, submit another ListHostedZones request.

For the value of marker , specify the value of NextMarker from the previous response, which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false , there are no more hosted zones to get.

type MaxItems

string

param MaxItems

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems hosted zones, the value of IsTruncated in the response is true , and the value of NextMarker is the hosted zone ID of the first hosted zone that Amazon Route 53 will return if you submit another request.

type DelegationSetId

string

param DelegationSetId

If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.

rtype

dict

returns

Response Syntax

{
    'HostedZones': [
        {
            'Id': 'string',
            'Name': 'string',
            'CallerReference': 'string',
            'Config': {
                'Comment': 'string',
                'PrivateZone': True|False
            },
            'ResourceRecordSetCount': 123,
            'LinkedService': {
                'ServicePrincipal': 'string',
                'Description': 'string'
            }
        },
    ],
    'Marker': 'string',
    'IsTruncated': True|False,
    'NextMarker': 'string',
    'MaxItems': 'string'
}

Response Structure

(dict) --
- HostedZones (list) --
  
  A complex type that contains general information about the hosted zone.
  - (dict) --
    
    A complex type that contains general information about the hosted zone.
    - Id (string) --
      
      The ID that Amazon Route 53 assigned to the hosted zone when you created it.
    - Name (string) --
      
      The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
      
      For information about how to specify characters other than a-z , 0-9 , and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone .
    - CallerReference (string) --
      
      The value that you specified for CallerReference when you created the hosted zone.
    - Config (dict) --
      
      A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.
      - Comment (string) --
        
        Any comments that you want to include about the hosted zone.
      - PrivateZone (boolean) --
        
        A value that indicates whether this is a private hosted zone.
    - ResourceRecordSetCount (integer) --
      
      The number of resource record sets in the hosted zone.
    - LinkedService (dict) --
      
      If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Amazon Route 53.
      - ServicePrincipal (string) --
        
        If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
      - Description (string) --
        
        If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
- Marker (string) --
  
  For the second and subsequent calls to ListHostedZones , Marker is the value that you specified for the marker parameter in the request that produced the current response.
- IsTruncated (boolean) --
  
  A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another ListHostedZones request and specifying the value of NextMarker in the marker parameter.
- NextMarker (string) --
  
  If IsTruncated is true , the value of NextMarker identifies the first hosted zone in the next group of hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the marker parameter.
  
  This element is present only if IsTruncated is true .
- MaxItems (string) --
  
  The value that you specified for the maxitems parameter in the call to ListHostedZones that produced the current response.

ListHostedZonesByName (updated)

Link ¶
Changes (response)

{'HostedZones': {'LinkedService': {'Description': 'string',
                                   'ServicePrincipal': 'string'}}}

Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current AWS account.

ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:

com.example.www.

Note the trailing dot, which can change the sort order in some circumstances.

If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:

com.ex\344mple.

The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide .

Amazon Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:

The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response.
The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response.
If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account. If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.
The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZonesByName , and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

See also: AWS API Documentation

Request Syntax

client.list_hosted_zones_by_name(
    DNSName='string',
    HostedZoneId='string',
    MaxItems='string'
)

type DNSName

string

param DNSName

(Optional) For your first request to ListHostedZonesByName , include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current AWS account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname , specify the value of NextDNSName from the previous response.

type HostedZoneId

string

param HostedZoneId

(Optional) For your first request to ListHostedZonesByName , do not include the hostedzoneid parameter.

If you have more hosted zones than the value of maxitems , ListHostedZonesByName returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of hostedzoneid , specify the value of the NextHostedZoneId element from the previous response.

type MaxItems

string

param MaxItems

The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.

rtype

dict

returns

Response Syntax

{
    'HostedZones': [
        {
            'Id': 'string',
            'Name': 'string',
            'CallerReference': 'string',
            'Config': {
                'Comment': 'string',
                'PrivateZone': True|False
            },
            'ResourceRecordSetCount': 123,
            'LinkedService': {
                'ServicePrincipal': 'string',
                'Description': 'string'
            }
        },
    ],
    'DNSName': 'string',
    'HostedZoneId': 'string',
    'IsTruncated': True|False,
    'NextDNSName': 'string',
    'NextHostedZoneId': 'string',
    'MaxItems': 'string'
}

Response Structure

(dict) --

A complex type that contains the response information for the request.
- HostedZones (list) --
  
  A complex type that contains general information about the hosted zone.
  - (dict) --
    
    A complex type that contains general information about the hosted zone.
    - Id (string) --
      
      The ID that Amazon Route 53 assigned to the hosted zone when you created it.
    - Name (string) --
      
      The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
      
      For information about how to specify characters other than a-z , 0-9 , and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone .
    - CallerReference (string) --
      
      The value that you specified for CallerReference when you created the hosted zone.
    - Config (dict) --
      
      A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.
      - Comment (string) --
        
        Any comments that you want to include about the hosted zone.
      - PrivateZone (boolean) --
        
        A value that indicates whether this is a private hosted zone.
    - ResourceRecordSetCount (integer) --
      
      The number of resource record sets in the hosted zone.
    - LinkedService (dict) --
      
      If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Amazon Route 53.
      - ServicePrincipal (string) --
        
        If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
      - Description (string) --
        
        If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
- DNSName (string) --
  
  For the second and subsequent calls to ListHostedZonesByName , DNSName is the value that you specified for the dnsname parameter in the request that produced the current response.
- HostedZoneId (string) --
  
  The ID that Amazon Route 53 assigned to the hosted zone when you created it.
- IsTruncated (boolean) --
  
  A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and NextHostedZoneId elements in the dnsname and hostedzoneid parameters.
- NextDNSName (string) --
  
  If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.
  
  This element is present only if IsTruncated is true .
- NextHostedZoneId (string) --
  
  If IsTruncated is true , the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.
  
  This element is present only if IsTruncated is true .
- MaxItems (string) --
  
  The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response.

UpdateHealthCheck (updated)

Link ¶
Changes (response)

{'HealthCheck': {'LinkedService': {'Description': 'string',
                                   'ServicePrincipal': 'string'}}}

Updates an existing health check. Note that some values can't be updated.

For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide .

See also: AWS API Documentation

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-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
        'Name': 'string'
    },
    InsufficientDataHealthStatus='Healthy'|'Unhealthy'|'LastKnownStatus',
    ResetElements=[
        'FullyQualifiedDomainName'|'Regions'|'ResourcePath'|'ChildHealthChecks',
    ]
)

type HealthCheckId

string

param HealthCheckId

[REQUIRED]

The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

type HealthCheckVersion

integer

param HealthCheckVersion

A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Amazon Route 53 from overwriting an intervening update:

If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Amazon Route 53 updates the health check with the new settings.
If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Amazon Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

type IPAddress

string

param IPAddress

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress , Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval . Using an IP address that is returned by DNS, Amazon Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress :

IPv4 address : four values between 0 and 255, separated by periods (.), for example, 192.0.2.44 .
IPv6 address : eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 . You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345 .

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress . This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

Linux: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Linux Instances
Windows: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Windows Instances

Note

If a health check already has a value for IPAddress , you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress .

For more information, see UpdateHealthCheckRequest$FullyQualifiedDomainName .

Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

type Port

integer

param Port

The port on the endpoint on which you want Amazon Route 53 to perform health checks.

type ResourcePath

string

param ResourcePath

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.

type FullyQualifiedDomainName

string

param FullyQualifiedDomainName

Amazon Route 53 behavior depends on whether you specify a value for IPAddress .

Note

If a health check already has a value for IPAddress , you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress .

If you specify a value for IPAddress :

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.

When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type , Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type , Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
If you specify another value for Port and any value except TCP for Type , Amazon Route 53 passes * FullyQualifiedDomainName :Port * to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName , Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress :

If you don't specify a value for IPAddress , Amazon Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval . Using an IPv4 address that is returned by DNS, Amazon Route 53 then checks the health of the endpoint.

Note

If you don't specify a value for IPAddress , Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName , the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName , 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-2-www.example.com ), not the name of the resource record sets (www.example.com).

Warning

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP , HTTPS , HTTP_STR_MATCH , or HTTPS_STR_MATCH , Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress . If the value of Type is TCP , Amazon Route 53 doesn't pass a Host header.

type SearchString

string

param SearchString

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. (You can't change the value of Type when you update a health check.)

type FailureThreshold

integer

param FailureThreshold

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. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide .

If you don't specify a value for FailureThreshold , the default value is three health checks.

type Inverted

boolean

param Inverted

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

type HealthThreshold

integer

param HealthThreshold

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

Note the following:

If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
If you specify 0 , Amazon Route 53 always considers this health check to be healthy.

type ChildHealthChecks

list

param ChildHealthChecks

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

(string) --

type EnableSNI

boolean

param EnableSNI

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure . A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName . If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName , a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

type Regions

list

param Regions

A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

(string) --

type AlarmIdentifier

dict

param AlarmIdentifier

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

Region (string) -- [REQUIRED]

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference .
Name (string) -- [REQUIRED]

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

type InsufficientDataHealthStatus

string

param InsufficientDataHealthStatus

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

Healthy : Amazon Route 53 considers the health check to be healthy.
Unhealthy : Amazon Route 53 considers the health check to be unhealthy.
LastKnownStatus : Amazon Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

type ResetElements

list

param ResetElements

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

ChildHealthChecks : Amazon Route 53 resets HealthCheckConfig$ChildHealthChecks to null.
FullyQualifiedDomainName : Amazon Route 53 resets HealthCheckConfig$FullyQualifiedDomainName to null.
Regions : Amazon Route 53 resets the HealthCheckConfig$Regions list to the default set of regions.
ResourcePath : Amazon Route 53 resets HealthCheckConfig$ResourcePath to null.

(string) --

rtype

dict

returns

Response Syntax

{
    'HealthCheck': {
        'Id': 'string',
        'CallerReference': 'string',
        'LinkedService': {
            'ServicePrincipal': 'string',
            'Description': '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-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-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 information about one health check that is associated with the current AWS account.
  - Id (string) --
    
    The identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.
  - CallerReference (string) --
    
    A unique string that you specified when you created the health check.
  - LinkedService (dict) --
    
    If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53.
    - ServicePrincipal (string) --
      
      If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
    - Description (string) --
      
      If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
  - HealthCheckConfig (dict) --
    
    A complex type that contains detailed information about one health check.
    - IPAddress (string) --
      
      The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress , Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval . Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint.
      
      Use one of the following formats for the value of IPAddress :
      - IPv4 address : four values between 0 and 255, separated by periods (.), for example, 192.0.2.44 .
      - IPv6 address : eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 . You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345 .
      If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress . This ensures that the IP address of your instance will never change.
      
      For more information, see HealthCheckConfig$FullyQualifiedDomainName .
      
      Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
      When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress .
    - Port (integer) --
      
      The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress .
    - Type (string) --
      
      The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
      
      Warning
      
      You can't change the value of Type after you create a health check.
      
      You can create the following types of health checks:
      - HTTP : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
      - HTTPS : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
      Warning
      
      If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.
      - HTTP_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
      - HTTPS_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString .
      - TCP : Amazon Route 53 tries to establish a TCP connection.
      - CLOUDWATCH_METRIC : The health check is associated with a CloudWatch alarm. If the state of the alarm is OK , the health check is considered healthy. If the state is ALARM , the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM , the health check status depends on the setting for InsufficientDataHealthStatus : Healthy , Unhealthy , or LastKnownStatus .
      - CALCULATED : For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold .
      For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide .
    - ResourcePath (string) --
      
      The path, if any, 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.
    - FullyQualifiedDomainName (string) --
      
      Amazon Route 53 behavior depends on whether you specify a value for IPAddress .
      
      If you specify a value for IPAddress :
      
      Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.
      
      When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:
      - If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type , Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
      - If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type , Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
      - If you specify another value for Port and any value except TCP for Type , Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.
      If you don't specify a value for FullyQualifiedDomainName , Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.
      
      **If you don't specify a value for IPAddress ** :
      
      Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval . Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.
      
      Note
      
      If you don't specify a value for IPAddress , Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName , the health check fails with a "DNS resolution failed" error.
      
      If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName , 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-2-www.example.com), not the name of the resource record sets (www.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 you then associate the health check with those resource record sets, health check results will be unpredictable.
      
      In addition, if the value that you specify for Type is HTTP , HTTPS , HTTP_STR_MATCH , or HTTPS_STR_MATCH , Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress . If the value of Type is TCP , Amazon Route 53 doesn't pass a Host header.
    - SearchString (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.
    - 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.
      
      Warning
      
      You can't change the value of RequestInterval after you create a health check.
      
      If you don't specify a value for RequestInterval , the default value is 30 seconds.
    - 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. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide .
      
      If you don't specify a value for FailureThreshold , the default value is three health checks.
    - MeasureLatency (boolean) --
      
      Specify 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 on the Health Checks page in the Amazon Route 53 console.
      
      Warning
      
      You can't change the value of MeasureLatency after you create a health check.
    - Inverted (boolean) --
      
      Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
    - HealthThreshold (integer) --
      
      The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.
      
      Note the following:
      - If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.
      - If you specify 0 , Amazon Route 53 always considers this health check to be healthy.
    - ChildHealthChecks (list) --
      
      (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.
      - (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. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.
      
      Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure . A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.
      
      The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName . If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName , a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.
    - Regions (list) --
      
      A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.
      
      If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values .
      
      If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
      - (string) --
    - AlarmIdentifier (dict) --
      
      A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
      - Region (string) --
        
        A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
        
        For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference .
      - Name (string) --
        
        The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
    - InsufficientDataHealthStatus (string) --
      
      When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
      - Healthy : Amazon Route 53 considers the health check to be healthy.
      - Unhealthy : Amazon Route 53 considers the health check to be unhealthy.
      - LastKnownStatus : Amazon Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.
  - 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) --
    
    A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.
    - EvaluationPeriods (integer) --
      
      For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.
    - Threshold (float) --
      
      For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.
    - ComparisonOperator (string) --
      
      For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
    - Period (integer) --
      
      For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.
    - MetricName (string) --
      
      The name of the CloudWatch metric that the alarm is associated with.
    - Namespace (string) --
      
      The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide .
    - Statistic (string) --
      
      For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
    - Dimensions (list) --
      
      For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide .
      - (dict) --
        
        For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension.
        
        Name (string) --
        
        For the metric that the CloudWatch alarm is associated with, the name of one dimension.
        
        Value (string) --
        
        For the metric that the CloudWatch alarm is associated with, the value of one dimension.

UpdateHostedZoneComment (updated)

Link ¶
Changes (response)

{'HostedZone': {'LinkedService': {'Description': 'string',
                                  'ServicePrincipal': 'string'}}}

Updates the comment for a specified hosted zone.

See also: AWS API Documentation

Request Syntax

client.update_hosted_zone_comment(
    Id='string',
    Comment='string'
)

type Id

string

param Id

[REQUIRED]

The ID for the hosted zone that you want to update the comment for.

type Comment

string

param Comment

The new comment for the hosted zone. If you don't specify a value for Comment , Amazon Route 53 deletes the existing value of the Comment element, if any.

rtype

dict

returns

Response Syntax

{
    'HostedZone': {
        'Id': 'string',
        'Name': 'string',
        'CallerReference': 'string',
        'Config': {
            'Comment': 'string',
            'PrivateZone': True|False
        },
        'ResourceRecordSetCount': 123,
        'LinkedService': {
            'ServicePrincipal': 'string',
            'Description': 'string'
        }
    }
}

Response Structure

(dict) --

A complex type that contains the response to the UpdateHostedZoneComment request.
- HostedZone (dict) --
  
  A complex type that contains general information about the hosted zone.
  - Id (string) --
    
    The ID that Amazon Route 53 assigned to the hosted zone when you created it.
  - Name (string) --
    
    The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
    
    For information about how to specify characters other than a-z , 0-9 , and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone .
  - CallerReference (string) --
    
    The value that you specified for CallerReference when you created the hosted zone.
  - Config (dict) --
    
    A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.
    - Comment (string) --
      
      Any comments that you want to include about the hosted zone.
    - PrivateZone (boolean) --
      
      A value that indicates whether this is a private hosted zone.
  - ResourceRecordSetCount (integer) --
    
    The number of resource record sets in the hosted zone.
  - LinkedService (dict) --
    
    If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Amazon Route 53.
    - ServicePrincipal (string) --
      
      If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
    - Description (string) --
      
      If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.