Amazon Route 53

{'VPC': {'VPCRegion': {'af-south-1',
                       'us-gov-east-1',
                       'us-gov-west-1',
                       'us-iso-east-1',
                       'us-isob-east-1'}}}

Associates an Amazon VPC with a private hosted zone.

If you want to associate a VPC that was created by one AWS account with a private hosted zone that was created by a different account, do one of the following:

• Use the AWS account that created the private hosted zone to submit a CreateVPCAssociationAuthorization request. Then use the account that created the VPC to submit an AssociateVPCWithHostedZone request.

• If a subnet in the VPC was shared with another account, you can use the account that the subnet was shared with to submit an AssociateVPCWithHostedZone request. For more information about sharing subnets, see Working with Shared VPCs.

See also: AWS API Documentation

Request Syntax

client.associate_vpc_with_hosted_zone(
    HostedZoneId='string',
    VPC={
        'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-east-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'af-south-1',
        'VPCId': 'string'
    },
    Comment='string'
)

type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

The ID of the private hosted zone that you want to associate an Amazon VPC with.

Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.

type VPC:

dict

param VPC:

[REQUIRED]

A complex type that contains information about the VPC that you want to associate with a private hosted zone.

• VPCRegion (string) --

  (Private hosted zones only) The region that an Amazon VPC was created in.

• VPCId (string) --

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

type Comment:

string

param Comment:

Optional: A comment about the association request.

rtype:

dict

returns:

Response Syntax

{
    'ChangeInfo': {
        'Id': 'string',
        'Status': 'PENDING'|'INSYNC',
        'SubmittedAt': datetime(2015, 1, 1),
        'Comment': 'string'
    }
}

Response Structure

• (dict) --

  A complex type that contains the response information for the AssociateVPCWithHostedZone request.

  • ChangeInfo (dict) --

    A complex type that describes the changes made to your hosted zone.

    • 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.

{'ChangeBatch': {'Changes': {'ResourceRecordSet': {'Region': {'af-south-1'}}}}}

Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.

Deleting Resource Record Sets

To delete a resource record set, you must specify all the same values that you specified when you created it.

Change Batches and Transactional Changes

The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone.

For example, suppose a change batch request contains two changes: it deletes the CNAME resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the DELETE or the CREATE action fails, then the request is canceled, and the original CNAME record continues to exist.

Traffic Flow

To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.

Create, Delete, and Upsert

Use ChangeResourceRecordsSetsRequest to perform the following actions:

• CREATE: Creates a resource record set that has the specified values.

• DELETE: Deletes an existing resource record set that has the specified values.

• UPSERT: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Route 53 updates it with the values in the request.

Syntaxes for Creating, Updating, and Deleting Resource Record Sets

The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.

For an example for each type of resource record set, see "Examples."

Don't refer to the syntax in the "Parameter Syntax" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets.

Change Propagation to Route 53 DNS Servers

When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange.

Limits on ChangeResourceRecordSets Requests

For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.

See also: AWS API Documentation

Request Syntax

client.change_resource_record_sets(
    HostedZoneId='string',
    ChangeBatch={
        'Comment': 'string',
        'Changes': [
            {
                'Action': 'CREATE'|'DELETE'|'UPSERT',
                'ResourceRecordSet': {
                    'Name': 'string',
                    'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA',
                    'SetIdentifier': 'string',
                    'Weight': 123,
                    'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-north-1'|'cn-northwest-1'|'ap-east-1'|'me-south-1'|'ap-south-1'|'af-south-1',
                    'GeoLocation': {
                        'ContinentCode': 'string',
                        'CountryCode': 'string',
                        'SubdivisionCode': 'string'
                    },
                    'Failover': 'PRIMARY'|'SECONDARY',
                    'MultiValueAnswer': True|False,
                    'TTL': 123,
                    'ResourceRecords': [
                        {
                            'Value': 'string'
                        },
                    ],
                    'AliasTarget': {
                        'HostedZoneId': 'string',
                        'DNSName': 'string',
                        'EvaluateTargetHealth': True|False
                    },
                    'HealthCheckId': 'string',
                    'TrafficPolicyInstanceId': 'string'
                }
            },
        ]
    }
)

type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

The ID of the hosted zone that contains the resource record sets that you want to change.

type ChangeBatch:

dict

param ChangeBatch:

[REQUIRED]

A complex type that contains an optional comment and the Changes element.

• Comment (string) --

  Optional: Any comments you want to include about a change batch request.

• Changes (list) -- [REQUIRED]

  Information about the changes to make to the record sets.

  • (dict) --

    The information for each resource record set that you want to change.

    • Action (string) -- [REQUIRED]

      The action to perform:

      • CREATE: Creates a resource record set that has the specified values.

      • DELETE: Deletes a existing resource record set.

      • UPSERT: If a resource record set doesn't already exist, Route 53 creates it. If a resource record set does exist, Route 53 updates it with the values in the request.

    • ResourceRecordSet (dict) -- [REQUIRED]

      Information about the resource record set to create, delete, or update.

      • Name (string) -- [REQUIRED]

        For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.

        ChangeResourceRecordSets Only

        Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

        For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

        You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following:

        • The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.

        • The * can't replace any of the middle labels, for example, marketing.*.example.com.

        • If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

        You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com.

      • Type (string) -- [REQUIRED]

        The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

        Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

        Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

        Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT

        Values for alias resource record sets:

        • Amazon API Gateway custom regional APIs and edge-optimized APIs: A

        • CloudFront distributions: A If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.

        • Amazon API Gateway environment that has a regionalized subdomain: A

        • ELB load balancers: A | AAAA

        • Amazon S3 buckets: A

        • Amazon Virtual Private Cloud interface VPC endpoints A

        • Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA.

      • SetIdentifier (string) --

        Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.

        For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

      • Weight (integer) --

        Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:

        • You must specify a value for the Weight element for every weighted resource record set.

        • You can only specify one ResourceRecord per weighted resource record set.

        • You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.

        • You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.

        • For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability. The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.

      • Region (string) --

        Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

        When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.

        Note the following:

        • You can only specify one ResourceRecord per latency resource record set.

        • You can only create one latency resource record set for each Amazon EC2 Region.

        • You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.

        • You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

      • GeoLocation (dict) --

        Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.

        If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.

        You can't create two geolocation resource record sets that specify the same geographic location.

        The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.

        You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.

        • ContinentCode (string) --

          The two-letter code for the continent.

          Amazon Route 53 supports the following continent codes:

          • AF: Africa

          • AN: Antarctica

          • AS: Asia

          • EU: Europe

          • OC: Oceania

          • NA: North America

          • SA: South America

          Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

        • CountryCode (string) --

          For geolocation resource record sets, the two-letter code for a country.

          Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

        • SubdivisionCode (string) --

          For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for SubdivisionCode. For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website.

          If you specify subdivisioncode, you must also specify US for CountryCode.

      • Failover (string) --

        Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.

        Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:

        • When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.

        • When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

        • When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.

        • If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

        You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.

        For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

        For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:

        • Route 53 Health Checks and DNS Failover

        • Configuring Failover in a Private Hosted Zone

      • MultiValueAnswer (boolean) --

        Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following:

        • If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.

        • If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.

        • Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.

        • If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.

        • When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.

        • If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.

        You can't create multivalue answer alias records.

      • TTL (integer) --

        The resource record cache time to live (TTL), in seconds. Note the following:

        • If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target.

        • If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.

        • All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.

        • If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.

      • ResourceRecords (list) --

        Information about the resource records to act upon.

        • (dict) --

          Information specific to the resource record.

          • Value (string) -- [REQUIRED]

            The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

            You can specify more than one value for all record types except CNAME and SOA.

      • AliasTarget (dict) --

        Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

        If you're creating resource records sets for a private hosted zone, note the following:

        • You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.

        • Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.

        • For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.

        • HostedZoneId (string) -- [REQUIRED]

          Alias resource records sets only: The value used depends on where you want to route traffic:

          Amazon API Gateway custom regional APIs and edge-optimized APIs

          Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names:

          • For regional APIs, specify the value of regionalHostedZoneId.

          • For edge-optimized APIs, specify the value of distributionHostedZoneId.

            Amazon Virtual Private Cloud interface VPC endpoint

          Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints.

          CloudFront distribution

          Specify Z2FDTNDATAQYW2.

          Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the "AWS Service Endpoints" chapter of the Amazon Web Services General Reference.

          ELB load balancer

          Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:

          • Service Endpoints table in the "Elastic Load Balancing Endpoints and Quotas" topic in the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.

          • AWS Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.

          • Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:

            • Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId.

            • Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneId.

          • AWS CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:

            • Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameId.

            • Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.

            AWS Global Accelerator accelerator

          Specify Z2BJ6XQ5FK7U4H.

          An Amazon S3 bucket configured as a static website

          Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference.

          Another Route 53 resource record set in your hosted zone

          Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)

        • DNSName (string) -- [REQUIRED]

          Alias resource record sets only: The value that you specify depends on where you want to route queries:

          Amazon API Gateway custom regional APIs and edge-optimized APIs

          Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names:

          • For regional APIs, specify the value of regionalDomainName.

          • For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.

          Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints.

          CloudFront distribution

          Specify the domain name that CloudFront assigned when you created your distribution.

          Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.

          You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.

          If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.

          For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:

          • AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.

          • Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.

          • AWS CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS CLI Command Reference.

            ELB load balancer

          Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI.

          • AWS Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field. If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.

          • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:

            • Classic Load Balancers: DescribeLoadBalancers

            • Application and Network Load Balancers: DescribeLoadBalancers

          • AWS CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:

            • Classic Load Balancers: describe-load-balancers

            • Application and Network Load Balancers: describe-load-balancers

            AWS Global Accelerator accelerator

          Specify the DNS name for your accelerator:

          • Global Accelerator API: To get the DNS name, use DescribeAccelerator.

          • AWS CLI: To get the DNS name, use describe-accelerator.

            Amazon S3 bucket that is configured as a static website

          Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.

          Another Route 53 resource record set

          Specify the value of the Name element for a resource record set in the current hosted zone.

        • EvaluateTargetHealth (boolean) -- [REQUIRED]

          Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.

          Note the following:

          CloudFront distributions

          You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

          Elastic Beanstalk environments that have regionalized subdomains

          If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.

          If the environment contains a single Amazon EC2 instance, there are no special requirements.

          ELB load balancers

          Health checking behavior depends on the type of load balancer:

          • Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.

          • Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:

            • For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.

            • A target group that has no registered targets is considered unhealthy.

          There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.

          Other records in the same hosted zone

          If the AWS resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.

          For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

      • HealthCheckId (string) --

        If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

        Route 53 determines whether a resource record set is healthy based on one of the following:

        • By periodically sending a request to the endpoint that is specified in the health check

        • By aggregating the status of a specified group of health checks (calculated health checks)

        • By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

        For more information, see the following topics in the Amazon Route 53 Developer Guide:

        • How Amazon Route 53 Determines Whether an Endpoint Is Healthy

        • Route 53 Health Checks and DNS Failover

        • Configuring Failover in a Private Hosted Zone

        When to Specify HealthCheckId

        Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:

        • Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets. If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with. If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set. If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.

        • Alias resource record sets: You specify the following settings:

          • You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).

          • You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.

          • You specify a health check ID for the non-alias resource record set.

        If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.

        If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.

        Geolocation Routing

        For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:

        • The United States

        • North America

        • The default resource record set

        Specifying the Health Check Endpoint by Domain Name

        If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets ( www.example.com).

      • TrafficPolicyInstanceId (string) --

        When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Route 53 created this resource record set for.

rtype:

dict

returns:

Response Syntax

{
    'ChangeInfo': {
        'Id': 'string',
        'Status': 'PENDING'|'INSYNC',
        'SubmittedAt': datetime(2015, 1, 1),
        'Comment': 'string'
    }
}

Response Structure

• (dict) --

  A complex type containing the response for the request.

  • ChangeInfo (dict) --

    A complex type that contains 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.

    • 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.

{'HealthCheckConfig': {'AlarmIdentifier': {'Region': {'af-south-1',
                                                      'us-gov-east-1',
                                                      'us-gov-west-1',
                                                      'us-iso-east-1',
                                                      'us-isob-east-1'}}}}

{'HealthCheck': {'HealthCheckConfig': {'AlarmIdentifier': {'Region': {'af-south-1',
                                                                      'us-gov-east-1',
                                                                      'us-gov-west-1',
                                                                      'us-iso-east-1',
                                                                      'us-isob-east-1'}}}}}

Creates a new health check.

For information about adding health checks to resource record sets, see 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 a 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:

• 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,
        'Disabled': 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'|'eu-west-3'|'ap-east-1'|'me-south-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-northwest-1'|'cn-north-1'|'af-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-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, 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, 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, Route 53 returns a HealthCheckAlreadyExists error.

• If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check.

type HealthCheckConfig:

dict

param HealthCheckConfig:

[REQUIRED]

A complex type that contains settings for a new 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, 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, 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 FullyQualifiedDomainName.

  Constraints: 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 that you want Amazon Route 53 to perform health checks on.

• 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.

  You can create the following types of health checks:

  • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

  • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

  • HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, 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: Route 53 tries to establish a TCP connection. If successful, 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: 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, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

  For more information, see How 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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

• 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 Route 53 to perform health checks.

  When 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, 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, 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, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

  If you don't specify a value for FullyQualifiedDomainName, 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 :

  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, Route 53 then checks the health of the endpoint.

  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).

  In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, 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, Route 53 doesn't pass a Host header.

• SearchString (string) --

  If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

  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 Route 53 health checker makes requests at this interval.

  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 Route 53 console.

• 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.

• Disabled (boolean) --

  Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

  • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

  • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

  • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

  After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

  Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

• HealthThreshold (integer) --

  The number of child health checks that are associated with a CALCULATED health check 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 element.

  Note the following:

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

  • If you specify 0, 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, 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, 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 the specified health check is healthy.

  • Region (string) -- [REQUIRED]

    For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

    For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Service 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: Route 53 considers the health check to be healthy.

  • Unhealthy: Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: 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,
            'Disabled': 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'|'eu-west-3'|'ap-east-1'|'me-south-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-northwest-1'|'cn-north-1'|'af-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-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, 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, 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 FullyQualifiedDomainName.

        Constraints: 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 that you want Amazon Route 53 to perform health checks on.

      • Type (string) --

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

        You can create the following types of health checks:

        • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

        • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

        • HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, 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: Route 53 tries to establish a TCP connection. If successful, 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: 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, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

        For more information, see How 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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

      • 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 Route 53 to perform health checks.

        When 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, 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, 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, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

        If you don't specify a value for FullyQualifiedDomainName, 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 :

        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, Route 53 then checks the health of the endpoint.

        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).

        In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, 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, Route 53 doesn't pass a Host header.

      • SearchString (string) --

        If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

        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 Route 53 health checker makes requests at this interval.

        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 Route 53 console.

      • 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.

      • Disabled (boolean) --

        Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

        • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

        • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

        • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

        After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

        Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

      • HealthThreshold (integer) --

        The number of child health checks that are associated with a CALCULATED health check 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 element.

        Note the following:

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

        • If you specify 0, 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, 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, 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 the specified health check is healthy.

        • Region (string) --

          For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

          For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Service 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: Route 53 considers the health check to be healthy.

        • Unhealthy: Route 53 considers the health check to be unhealthy.

        • LastKnownStatus: 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.

{'VPC': {'VPCRegion': {'af-south-1',
                       'us-gov-east-1',
                       'us-gov-west-1',
                       'us-iso-east-1',
                       'us-isob-east-1'}}}

Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).

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) such as .com.

• For public hosted zones, 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 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 public 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 Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.

When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all 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-west-3'|'eu-central-1'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-east-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'af-south-1',
        'VPCId': 'string'
    },
    CallerReference='string',
    HostedZoneConfig={
        'Comment': 'string',
        'PrivateZone': True|False
    },
    DelegationSetId='string'
)

type Name:

string

param Name:

[REQUIRED]

The name of the domain. 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 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 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 that an Amazon VPC was created in.

• 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-west-3'|'eu-central-1'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-east-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'af-south-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 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 that an Amazon VPC was created in.

    • VPCId (string) --

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

  • Location (string) --

    The unique URL representing the new hosted zone.

{'VPC': {'VPCRegion': {'af-south-1',
                       'us-gov-east-1',
                       'us-gov-west-1',
                       'us-iso-east-1',
                       'us-isob-east-1'}}}

Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.

See also: AWS API Documentation

Request Syntax

client.create_vpc_association_authorization(
    HostedZoneId='string',
    VPC={
        'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-east-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'af-south-1',
        'VPCId': 'string'
    }
)

type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

The ID of the private hosted zone that you want to authorize associating a VPC with.

type VPC:

dict

param VPC:

[REQUIRED]

A complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone.

• VPCRegion (string) --

  (Private hosted zones only) The region that an Amazon VPC was created in.

• VPCId (string) --

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

rtype:

dict

returns:

Response Syntax

{
    'HostedZoneId': 'string',
    'VPC': {
        'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-east-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'af-south-1',
        'VPCId': 'string'
    }
}

Response Structure

• (dict) --

  A complex type that contains the response information from a CreateVPCAssociationAuthorization request.

  • HostedZoneId (string) --

    The ID of the hosted zone that you authorized associating a VPC with.

  • VPC (dict) --

    The VPC that you authorized associating with a hosted zone.

    • VPCRegion (string) --

      (Private hosted zones only) The region that an Amazon VPC was created in.

    • VPCId (string) --

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

{'VPC': {'VPCRegion': {'af-south-1',
                       'us-gov-east-1',
                       'us-gov-west-1',
                       'us-iso-east-1',
                       'us-isob-east-1'}}}

Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request.

See also: AWS API Documentation

Request Syntax

client.delete_vpc_association_authorization(
    HostedZoneId='string',
    VPC={
        'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-east-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'af-south-1',
        'VPCId': 'string'
    }
)

type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, the ID of the hosted zone.

type VPC:

dict

param VPC:

[REQUIRED]

When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, a complex type that includes the ID and region of the VPC.

• VPCRegion (string) --

  (Private hosted zones only) The region that an Amazon VPC was created in.

• VPCId (string) --

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

  Empty response for the request.

{'VPC': {'VPCRegion': {'af-south-1',
                       'us-gov-east-1',
                       'us-gov-west-1',
                       'us-iso-east-1',
                       'us-isob-east-1'}}}

Disassociates a VPC from a Amazon Route 53 private hosted zone. Note the following:

• You can't disassociate the last VPC from a private hosted zone.

• You can't convert a private hosted zone into a public hosted zone.

• You can submit a DisassociateVPCFromHostedZone request using either the account that created the hosted zone or the account that created the VPC.

See also: AWS API Documentation

Request Syntax

client.disassociate_vpc_from_hosted_zone(
    HostedZoneId='string',
    VPC={
        'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-east-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'af-south-1',
        'VPCId': 'string'
    },
    Comment='string'
)

type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

The ID of the private hosted zone that you want to disassociate a VPC from.

type VPC:

dict

param VPC:

[REQUIRED]

A complex type that contains information about the VPC that you're disassociating from the specified hosted zone.

• VPCRegion (string) --

  (Private hosted zones only) The region that an Amazon VPC was created in.

• VPCId (string) --

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

type Comment:

string

param Comment:

Optional: A comment about the disassociation request.

rtype:

dict

returns:

Response Syntax

{
    'ChangeInfo': {
        'Id': 'string',
        'Status': 'PENDING'|'INSYNC',
        'SubmittedAt': datetime(2015, 1, 1),
        'Comment': 'string'
    }
}

Response Structure

• (dict) --

  A complex type that contains the response information for the disassociate request.

  • ChangeInfo (dict) --

    A complex type that describes the changes made to the specified private hosted zone.

    • 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.

{'HealthCheck': {'HealthCheckConfig': {'AlarmIdentifier': {'Region': {'af-south-1',
                                                                      'us-gov-east-1',
                                                                      'us-gov-west-1',
                                                                      'us-iso-east-1',
                                                                      'us-isob-east-1'}}}}}

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,
            'Disabled': 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'|'eu-west-3'|'ap-east-1'|'me-south-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-northwest-1'|'cn-north-1'|'af-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-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, 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, 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 FullyQualifiedDomainName.

        Constraints: 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 that you want Amazon Route 53 to perform health checks on.

      • Type (string) --

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

        You can create the following types of health checks:

        • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

        • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

        • HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, 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: Route 53 tries to establish a TCP connection. If successful, 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: 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, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

        For more information, see How 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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

      • 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 Route 53 to perform health checks.

        When 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, 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, 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, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

        If you don't specify a value for FullyQualifiedDomainName, 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 :

        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, Route 53 then checks the health of the endpoint.

        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).

        In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, 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, Route 53 doesn't pass a Host header.

      • SearchString (string) --

        If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

        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 Route 53 health checker makes requests at this interval.

        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 Route 53 console.

      • 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.

      • Disabled (boolean) --

        Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

        • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

        • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

        • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

        After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

        Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

      • HealthThreshold (integer) --

        The number of child health checks that are associated with a CALCULATED health check 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 element.

        Note the following:

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

        • If you specify 0, 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, 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, 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 the specified health check is healthy.

        • Region (string) --

          For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

          For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Service 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: Route 53 considers the health check to be healthy.

        • Unhealthy: Route 53 considers the health check to be unhealthy.

        • LastKnownStatus: 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.

{'VPCs': {'VPCRegion': {'af-south-1',
                        'us-gov-east-1',
                        'us-gov-west-1',
                        'us-iso-east-1',
                        'us-isob-east-1'}}}

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-west-3'|'eu-central-1'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-east-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'af-south-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 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 that an Amazon VPC was created in.

      • VPCId (string) --

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

{'HealthChecks': {'HealthCheckConfig': {'AlarmIdentifier': {'Region': {'af-south-1',
                                                                       'us-gov-east-1',
                                                                       'us-gov-west-1',
                                                                       'us-iso-east-1',
                                                                       'us-isob-east-1'}}}}}

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, 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,
                'Disabled': 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'|'eu-west-3'|'ap-east-1'|'me-south-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-northwest-1'|'cn-north-1'|'af-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-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, 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, 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 FullyQualifiedDomainName.

          Constraints: 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 that you want Amazon Route 53 to perform health checks on.

        • Type (string) --

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

          You can create the following types of health checks:

          • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

          • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

          • HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, 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: Route 53 tries to establish a TCP connection. If successful, 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: 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, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

          For more information, see How 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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

        • 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 Route 53 to perform health checks.

          When 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, 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, 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, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

          If you don't specify a value for FullyQualifiedDomainName, 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 :

          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, Route 53 then checks the health of the endpoint.

          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).

          In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, 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, Route 53 doesn't pass a Host header.

        • SearchString (string) --

          If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

          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 Route 53 health checker makes requests at this interval.

          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 Route 53 console.

        • 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.

        • Disabled (boolean) --

          Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

          • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

          • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

          • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

          After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

          Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

        • HealthThreshold (integer) --

          The number of child health checks that are associated with a CALCULATED health check 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 element.

          Note the following:

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

          • If you specify 0, 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, 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, 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 the specified health check is healthy.

          • Region (string) --

            For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

            For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Service 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: Route 53 considers the health check to be healthy.

          • Unhealthy: Route 53 considers the health check to be unhealthy.

          • LastKnownStatus: 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.

{'ResourceRecordSets': {'Region': {'af-south-1'}}}

Lists the resource record sets in a specified hosted zone.

ListResourceRecordSets returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements.

Sort order

ListResourceRecordSets sorts results first by DNS name with the labels reversed, for example:

com.example.www.

Note the trailing dot, which can change the sort order when the record name contains characters that appear before . (decimal 46) in the ASCII table. These characters include the following: ! " # $ % & ' ( ) * + , -

When multiple records have the same DNS name, ListResourceRecordSets sorts results by the record type.

Specifying where to start listing records

You can use the name and type elements to specify the resource record set that the list begins with:

If you do not specify Name or Type

The results begin with the first resource record set that the hosted zone contains.

If you specify Name but not Type

The results begin with the first resource record set in the list whose name is greater than or equal to Name.

If you specify Type but not Name

Amazon Route 53 returns the InvalidInput error.

If you specify both Name and Type

The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type.

Resource record sets that are PENDING

This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Route 53 DNS servers.

Changing resource record sets

To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you're paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.

Displaying the next page of results

If a ListResourceRecordSets command returns more than one page of results, the value of IsTruncated is true. To display the next page of results, get the values of NextRecordName, NextRecordType, and NextRecordIdentifier (if any) from the response. Then submit another ListResourceRecordSets request, and specify those values for StartRecordName, StartRecordType, and StartRecordIdentifier.

See also: AWS API Documentation

Request Syntax

client.list_resource_record_sets(
    HostedZoneId='string',
    StartRecordName='string',
    StartRecordType='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA',
    StartRecordIdentifier='string',
    MaxItems='string'
)

type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

The ID of the hosted zone that contains the resource record sets that you want to list.

type StartRecordName:

string

param StartRecordName:

The first name in the lexicographic ordering of resource record sets that you want to list. If the specified record name doesn't exist, the results begin with the first resource record set that has a name greater than the value of name.

type StartRecordType:

string

param StartRecordType:

The type of resource record set to begin the record listing from.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

Values for alias resource record sets:

• API Gateway custom regional API or edge-optimized API: A

• CloudFront distribution: A or AAAA

• Elastic Beanstalk environment that has a regionalized subdomain: A

• Elastic Load Balancing load balancer: A | AAAA

• S3 bucket: A

• VPC interface VPC endpoint: A

• Another resource record set in this hosted zone: The type of the resource record set that the alias references.

Constraint: Specifying type without specifying name returns an InvalidInput error.

type StartRecordIdentifier:

string

param StartRecordIdentifier:

Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

type MaxItems:

string

param MaxItems:

(Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets.

rtype:

dict

returns:

Response Syntax

{
    'ResourceRecordSets': [
        {
            'Name': 'string',
            'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA',
            'SetIdentifier': 'string',
            'Weight': 123,
            'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-north-1'|'cn-northwest-1'|'ap-east-1'|'me-south-1'|'ap-south-1'|'af-south-1',
            'GeoLocation': {
                'ContinentCode': 'string',
                'CountryCode': 'string',
                'SubdivisionCode': 'string'
            },
            'Failover': 'PRIMARY'|'SECONDARY',
            'MultiValueAnswer': True|False,
            'TTL': 123,
            'ResourceRecords': [
                {
                    'Value': 'string'
                },
            ],
            'AliasTarget': {
                'HostedZoneId': 'string',
                'DNSName': 'string',
                'EvaluateTargetHealth': True|False
            },
            'HealthCheckId': 'string',
            'TrafficPolicyInstanceId': 'string'
        },
    ],
    'IsTruncated': True|False,
    'NextRecordName': 'string',
    'NextRecordType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA',
    'NextRecordIdentifier': 'string',
    'MaxItems': 'string'
}

Response Structure

• (dict) --

  A complex type that contains list information for the resource record set.

  • ResourceRecordSets (list) --

    Information about multiple resource record sets.

    • (dict) --

      Information about the resource record set to create or delete.

      • Name (string) --

        For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.

        ChangeResourceRecordSets Only

        Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

        For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

        You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following:

        • The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.

        • The * can't replace any of the middle labels, for example, marketing.*.example.com.

        • If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

        You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com.

      • Type (string) --

        The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

        Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

        Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

        Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT

        Values for alias resource record sets:

        • Amazon API Gateway custom regional APIs and edge-optimized APIs: A

        • CloudFront distributions: A If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.

        • Amazon API Gateway environment that has a regionalized subdomain: A

        • ELB load balancers: A | AAAA

        • Amazon S3 buckets: A

        • Amazon Virtual Private Cloud interface VPC endpoints A

        • Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA.

      • SetIdentifier (string) --

        Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.

        For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

      • Weight (integer) --

        Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:

        • You must specify a value for the Weight element for every weighted resource record set.

        • You can only specify one ResourceRecord per weighted resource record set.

        • You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.

        • You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.

        • For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability. The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.

      • Region (string) --

        Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

        When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.

        Note the following:

        • You can only specify one ResourceRecord per latency resource record set.

        • You can only create one latency resource record set for each Amazon EC2 Region.

        • You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.

        • You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

      • GeoLocation (dict) --

        Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.

        If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.

        You can't create two geolocation resource record sets that specify the same geographic location.

        The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.

        You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.

        • ContinentCode (string) --

          The two-letter code for the continent.

          Amazon Route 53 supports the following continent codes:

          • AF: Africa

          • AN: Antarctica

          • AS: Asia

          • EU: Europe

          • OC: Oceania

          • NA: North America

          • SA: South America

          Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

        • CountryCode (string) --

          For geolocation resource record sets, the two-letter code for a country.

          Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

        • SubdivisionCode (string) --

          For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for SubdivisionCode. For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website.

          If you specify subdivisioncode, you must also specify US for CountryCode.

      • Failover (string) --

        Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.

        Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:

        • When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.

        • When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

        • When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.

        • If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

        You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.

        For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

        For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:

        • Route 53 Health Checks and DNS Failover

        • Configuring Failover in a Private Hosted Zone

      • MultiValueAnswer (boolean) --

        Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following:

        • If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.

        • If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.

        • Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.

        • If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.

        • When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.

        • If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.

        You can't create multivalue answer alias records.

      • TTL (integer) --

        The resource record cache time to live (TTL), in seconds. Note the following:

        • If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target.

        • If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.

        • All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.

        • If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.

      • ResourceRecords (list) --

        Information about the resource records to act upon.

        • (dict) --

          Information specific to the resource record.

          • Value (string) --

            The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

            You can specify more than one value for all record types except CNAME and SOA.

      • AliasTarget (dict) --

        Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

        If you're creating resource records sets for a private hosted zone, note the following:

        • You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.

        • Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.

        • For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.

        • HostedZoneId (string) --

          Alias resource records sets only: The value used depends on where you want to route traffic:

          Amazon API Gateway custom regional APIs and edge-optimized APIs

          Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names:

          • For regional APIs, specify the value of regionalHostedZoneId.

          • For edge-optimized APIs, specify the value of distributionHostedZoneId.

            Amazon Virtual Private Cloud interface VPC endpoint

          Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints.

          CloudFront distribution

          Specify Z2FDTNDATAQYW2.

          Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the "AWS Service Endpoints" chapter of the Amazon Web Services General Reference.

          ELB load balancer

          Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:

          • Service Endpoints table in the "Elastic Load Balancing Endpoints and Quotas" topic in the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.

          • AWS Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.

          • Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:

            • Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId.

            • Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneId.

          • AWS CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:

            • Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameId.

            • Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.

            AWS Global Accelerator accelerator

          Specify Z2BJ6XQ5FK7U4H.

          An Amazon S3 bucket configured as a static website

          Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference.

          Another Route 53 resource record set in your hosted zone

          Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)

        • DNSName (string) --

          Alias resource record sets only: The value that you specify depends on where you want to route queries:

          Amazon API Gateway custom regional APIs and edge-optimized APIs

          Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names:

          • For regional APIs, specify the value of regionalDomainName.

          • For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.

          Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints.

          CloudFront distribution

          Specify the domain name that CloudFront assigned when you created your distribution.

          Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.

          You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.

          If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.

          For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:

          • AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.

          • Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.

          • AWS CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS CLI Command Reference.

            ELB load balancer

          Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI.

          • AWS Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field. If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.

          • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:

            • Classic Load Balancers: DescribeLoadBalancers

            • Application and Network Load Balancers: DescribeLoadBalancers

          • AWS CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:

            • Classic Load Balancers: describe-load-balancers

            • Application and Network Load Balancers: describe-load-balancers

            AWS Global Accelerator accelerator

          Specify the DNS name for your accelerator:

          • Global Accelerator API: To get the DNS name, use DescribeAccelerator.

          • AWS CLI: To get the DNS name, use describe-accelerator.

            Amazon S3 bucket that is configured as a static website

          Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.

          Another Route 53 resource record set

          Specify the value of the Name element for a resource record set in the current hosted zone.

        • EvaluateTargetHealth (boolean) --

          Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.

          Note the following:

          CloudFront distributions

          You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

          Elastic Beanstalk environments that have regionalized subdomains

          If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.

          If the environment contains a single Amazon EC2 instance, there are no special requirements.

          ELB load balancers

          Health checking behavior depends on the type of load balancer:

          • Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.

          • Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:

            • For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.

            • A target group that has no registered targets is considered unhealthy.

          There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.

          Other records in the same hosted zone

          If the AWS resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.

          For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

      • HealthCheckId (string) --

        If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

        Route 53 determines whether a resource record set is healthy based on one of the following:

        • By periodically sending a request to the endpoint that is specified in the health check

        • By aggregating the status of a specified group of health checks (calculated health checks)

        • By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

        For more information, see the following topics in the Amazon Route 53 Developer Guide:

        • How Amazon Route 53 Determines Whether an Endpoint Is Healthy

        • Route 53 Health Checks and DNS Failover

        • Configuring Failover in a Private Hosted Zone

        When to Specify HealthCheckId

        Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:

        • Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets. If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with. If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set. If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.

        • Alias resource record sets: You specify the following settings:

          • You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).

          • You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.

          • You specify a health check ID for the non-alias resource record set.

        If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.

        If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.

        Geolocation Routing

        For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:

        • The United States

        • North America

        • The default resource record set

        Specifying the Health Check Endpoint by Domain Name

        If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets ( www.example.com).

      • TrafficPolicyInstanceId (string) --

        When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Route 53 created this resource record set for.

  • IsTruncated (boolean) --

    A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the NextRecordName element.

  • NextRecordName (string) --

    If the results were truncated, the name of the next record in the list.

    This element is present only if IsTruncated is true.

  • NextRecordType (string) --

    If the results were truncated, the type of the next record in the list.

    This element is present only if IsTruncated is true.

  • NextRecordIdentifier (string) --

    Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

    For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

  • MaxItems (string) --

    The maximum number of records you requested.

{'VPCs': {'VPCRegion': {'af-south-1',
                        'us-gov-east-1',
                        'us-gov-west-1',
                        'us-iso-east-1',
                        'us-isob-east-1'}}}

Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests.

The response includes a VPCs element with a VPC child element for each VPC that can be associated with the hosted zone.

See also: AWS API Documentation

Request Syntax

client.list_vpc_association_authorizations(
    HostedZoneId='string',
    NextToken='string',
    MaxResults='string'
)

type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone.

type NextToken:

string

param NextToken:

Optional: If a response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of results, submit another request, and include the value of NextToken from the response in the nexttoken parameter in another ListVPCAssociationAuthorizations request.

type MaxResults:

string

param MaxResults:

Optional: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53 returns up to 50 VPCs per page.

rtype:

dict

returns:

Response Syntax

{
    'HostedZoneId': 'string',
    'NextToken': 'string',
    'VPCs': [
        {
            'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-east-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'af-south-1',
            'VPCId': 'string'
        },
    ]
}

Response Structure

• (dict) --

  A complex type that contains the response information for the request.

  • HostedZoneId (string) --

    The ID of the hosted zone that you can associate the listed VPCs with.

  • NextToken (string) --

    When the response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations request, and include the value of the NextToken element from the response in the nexttoken request parameter.

  • VPCs (list) --

    The list of VPCs that are authorized to be 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 that an Amazon VPC was created in.

      • VPCId (string) --

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

{'AlarmIdentifier': {'Region': {'af-south-1',
                                'us-gov-east-1',
                                'us-gov-west-1',
                                'us-iso-east-1',
                                'us-isob-east-1'}}}

{'HealthCheck': {'HealthCheckConfig': {'AlarmIdentifier': {'Region': {'af-south-1',
                                                                      'us-gov-east-1',
                                                                      'us-gov-west-1',
                                                                      'us-iso-east-1',
                                                                      'us-isob-east-1'}}}}}

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,
    Disabled=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'|'eu-west-3'|'ap-east-1'|'me-south-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-northwest-1'|'cn-north-1'|'af-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-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 Route 53 from overwriting an intervening update:

• If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, 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. 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, 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, 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

For more information, see FullyQualifiedDomainName.

Constraints: 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

type Port:

integer

param Port:

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

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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

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.

If you specify a value for IPAddress:

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 Route 53 to perform health checks.

When 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, 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, 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, Route 53 passes FullyQualifiedDomainName: Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, 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, 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, Route 53 then checks the health of the endpoint.

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).

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, 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, Route 53 doesn't pass a Host header.

type SearchString:

string

param SearchString:

If the value of Type is HTTP_STR_MATCH or HTTPS_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, 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 Disabled:

boolean

param Disabled:

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

• Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

• Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

• Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

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, Route 53 always considers this health check to be unhealthy.

• If you specify 0, 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 the specified health check is healthy.

• Region (string) -- [REQUIRED]

  For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

  For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Service 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: Route 53 considers the health check to be healthy.

• Unhealthy: Route 53 considers the health check to be unhealthy.

• LastKnownStatus: 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 ChildHealthChecks to null.

• FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null.

• Regions: Route 53 resets the Regions list to the default set of regions.

• ResourcePath: Route 53 resets 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,
            'Disabled': 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'|'eu-west-3'|'ap-east-1'|'me-south-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-northwest-1'|'cn-north-1'|'af-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-isob-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 the UpdateHealthCheck request.

  • HealthCheck (dict) --

    A complex type that contains the response to an UpdateHealthCheck request.

    • 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, 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, 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 FullyQualifiedDomainName.

        Constraints: 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 that you want Amazon Route 53 to perform health checks on.

      • Type (string) --

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

        You can create the following types of health checks:

        • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

        • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

        • HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, 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: Route 53 tries to establish a TCP connection. If successful, 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: 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, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

        For more information, see How 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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

      • 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 Route 53 to perform health checks.

        When 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, 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, 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, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

        If you don't specify a value for FullyQualifiedDomainName, 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 :

        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, Route 53 then checks the health of the endpoint.

        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).

        In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, 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, Route 53 doesn't pass a Host header.

      • SearchString (string) --

        If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

        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 Route 53 health checker makes requests at this interval.

        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 Route 53 console.

      • 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.

      • Disabled (boolean) --

        Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

        • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

        • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

        • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

        After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

        Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

      • HealthThreshold (integer) --

        The number of child health checks that are associated with a CALCULATED health check 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 element.

        Note the following:

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

        • If you specify 0, 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, 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, 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 the specified health check is healthy.

        • Region (string) --

          For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

          For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Service 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: Route 53 considers the health check to be healthy.

        • Unhealthy: Route 53 considers the health check to be unhealthy.

        • LastKnownStatus: 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.