Amazon Route 53

Request Syntax

client.test_dns_answer(
    HostedZoneId='string',
    RecordName='string',
    RecordType='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
    ResolverIP='string',
    EDNS0ClientSubnetIP='string',
    EDNS0ClientSubnetMask='string'
)

type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

type RecordName:

string

param RecordName:

[REQUIRED]

type RecordType:

string

param RecordType:

[REQUIRED]

type ResolverIP:

string

param ResolverIP:

type EDNS0ClientSubnetIP:

string

param EDNS0ClientSubnetIP:

type EDNS0ClientSubnetMask:

string

param EDNS0ClientSubnetMask:

rtype:

dict

returns:

Response Syntax

{
    'Nameserver': 'string',
    'RecordName': 'string',
    'RecordType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
    'RecordData': [
        'string',
    ],
    'ResponseCode': 'string',
    'Protocol': 'string'
}

Response Structure

• (dict) --

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

  • Nameserver (string) --

    The Amazon Route 53 name server used to respond to the request.

  • RecordName (string) --

    The name of the resource record set that you submitted a request for.

  • RecordType (string) --

    The type of the resource record set that you submitted a request for.

  • RecordData (list) --

    A list that contains values that Amazon Route 53 returned for this resource record set.

    • (string) --

      A value that Amazon Route 53 returned for this resource record set. A RecordDataEntry element is one of the following:

      • For non-alias resource record sets, a RecordDataEntry element contains one value in the resource record set. If the resource record set contains multiple values, the response includes one RecordDataEntry element for each value.

      • For multiple resource record sets that have the same name and type, which includes weighted, latency, geolocation, and failover, a RecordDataEntry element contains the value from the appropriate resource record set based on the request.

      • For alias resource record sets that refer to AWS resources other than another resource record set, the RecordDataEntry element contains an IP address or a domain name for the AWS resource, depending on the type of resource.

      • For alias resource record sets that refer to other resource record sets, a RecordDataEntry element contains one value from the referenced resource record set. If the referenced resource record set contains multiple values, the response includes one RecordDataEntry element for each value.

  • ResponseCode (string) --

    A code that indicates whether the request is valid or not. The most common response code is NOERROR, meaning that the request is valid. If the response is not valid, Amazon Route 53 returns a response code that describes the error. For a list of possible response codes, see DNS RCODES on the IANA website.

  • Protocol (string) --

    The protocol that Amazon Route 53 used to respond to the request, either UDP or TCP.

{'ChangeBatch': {'Changes': {'ResourceRecordSet': {'Type': {'NAPTR'}}}}}

Create, change, update, or delete authoritative DNS information on all Amazon Route 53 servers. Send a POST request to:

/2013-04-01/hostedzone/Amazon Route 53 hosted Zone ID/rrset resource.

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. When using the Amazon Route 53 API to change resource record sets, Amazon Route 53 either makes all or none of the changes in a change batch request. This ensures that Amazon Route 53 never partially implements the intended changes to the resource record sets in a hosted zone.

For example, a change batch request that deletes the CNAME``record for www.example.com and creates an alias resource record set for www.example.com. Amazon Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If either the ``DELETE or the CREATE action fails, then both changes (plus any other changes in the batch) fail, and the original CNAME record continues to exist.

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 for Name, Type, Set Identifier (for code latency, weighted, geolocation, and failover resource record sets), and TTL (except alias resource record sets, for which the TTL is determined by the AWS resource you're routing queries to).

• UPSERT: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an existing resource record set only when all of the following values match: Name, Type, and Set Identifier (for weighted, latency, geolocation, and failover resource record sets).

In response to a ChangeResourceRecordSets request, the DNS data is changed on all Amazon Route 53 DNS servers. Initially, the status of a change is PENDING, meaning the change has not yet propagated to all the authoritative Amazon Route 53 DNS servers. When the change is propagated to all hosts, the change returns a status of INSYNC.

After sending a change request, confirm your change has propagated to all Amazon Route 53 DNS servers. Changes generally propagate to all Amazon Route 53 name servers in a few minutes. In rare circumstances, propagation can take up to 30 minutes. For more information, see GetChange.

Note the following limitations on a ChangeResourceRecordSets request:

• A request cannot contain more than 100 Change elements.

• A request cannot contain more than 1000 ResourceRecord elements.

• The sum of the number of characters (including spaces) in all Value elements in a request cannot exceed 32,000 characters.

• The same resource cannot be deleted more than once in a single batch.

For more information on transactional changes, see ChangeResourceRecordSets.

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',
                    'SetIdentifier': 'string',
                    'Weight': 123,
                    'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'cn-north-1'|'ap-south-1',
                    'GeoLocation': {
                        'ContinentCode': 'string',
                        'CountryCode': 'string',
                        'SubdivisionCode': 'string'
                    },
                    'Failover': 'PRIMARY'|'SECONDARY',
                    '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 that has the specified values for Name, Type, SetIdentifier (for latency, weighted, geolocation, and failover resource record sets), and TTL (except alias resource record sets, for which the TTL is determined by the AWS resource that you're routing DNS queries to).

      • UPSERT: If a resource record set does not already exist, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an existing resource record set only when all of the following values match: Name, Type, and SetIdentifier (for weighted, latency, geolocation, and failover resource record sets).

    • ResourceRecordSet (dict) -- [REQUIRED]

      Information about the resource record set to create or delete.

      • Name (string) -- [REQUIRED]

        The name of the domain you want to perform the action on.

        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 still assumes that the domain name that you specify is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

        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 cannot 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 | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

        Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | 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.

        Values for alias resource record sets:

        • CloudFront distributions: A

        • Elastic Beanstalk environment that has a regionalized subdomain: A

        • ELB load balancers: A | AAAA

        • Amazon S3 buckets: A

        • Another resource record set in this hosted zone: Specify the type of the resource record set for which you're creating the alias. Specify any value except NS or SOA.

      • SetIdentifier (string) --

        Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type. Omit SetIdentifier for any other types of record sets.

      • 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. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon 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 cannot 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, Amazon 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 Amazon 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 the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an Amazon 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, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon 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 are not required to create latency resource record sets for all Amazon EC2 regions. Amazon Route 53 will choose the region with the best latency from among the regions for which you create latency resource record sets.

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

      • GeoLocation (dict) --

        Geo location 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 cannot 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 cannot 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.

          Valid values: AF | AN | AS | EU | OC | NA | SA

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

        • CountryCode (string) --

          The two-letter code for the country.

        • SubdivisionCode (string) --

          The code for the subdivision, for example, a state in the United States or a province in Canada.

      • 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, Amazon 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, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

        • When the secondary resource record set is unhealthy, Amazon 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, Amazon 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 cannot 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 Amazon Route 53, see the following topics in the Amazon Route 53 Developer Guide:

        • Amazon Route 53 Health Checks and DNS Failover

        • Configuring Failover in a Private Hosted Zone

        Valid values: PRIMARY | SECONDARY

      • TTL (integer) --

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

        • If you're creating 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, latency, geolocation, or failover 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 CloudFront distribution, Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are redirecting queries. The Elastic Beanstalk environment must have a regionalized subdomain.

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

        • You can't create alias resource record sets for CloudFront distributions in a private hosted zone.

        • 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 the queries are routed:

          A CloudFront distribution

          Specify Z2FDTNDATAQYW2.

          Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the AWSk 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:

          • AWS Management Console: Go to the Amazon EC2; page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted Zone ID field on the Description tab. Use the same process to get the DNS Name. See HostedZone$Name.

          • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameID. Use the same process to get the CanonicalHostedZoneName. See HostedZone$Name.

          • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneNameID. Use the same process to get the CanonicalHostedZoneName. See HostedZone$Name.

            An Amazon S3 bucket configured as a static website

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

          Another Amazon Route 53 resource record set in your hosted zone

          Specify the hosted zone ID of your hosted zone. (An alias resource record set cannot 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:

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

          • Elastic Beanstalk environment: Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.) You can use the following methods to get the value of the CNAME attribute:

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

            • Elastic Load Balancing 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 Command Line Interface Reference.

          • An ELB load balancer: Specify the DNS name associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.

            • AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS Name field that begins with dualstack. Use the same process to get the Hosted Zone ID. See HostedZone$Id.

            • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneName. Use the same process to get the CanonicalHostedZoneNameId. See HostedZone$Id.

            • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneName. Use the same process to get the CanonicalHostedZoneNameId. See HostedZoneId.

          • An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3 website endpoint in which you created the bucket; for example, s3-website-us-east-1.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using Amazon S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon Simple Storage Service Developer Guide.

          • Another Amazon 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, weighted alias, latency alias, and failover alias record sets: If you set the value of EvaluateTargetHealth to true for the resource record set or sets in an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a value for HealthCheck$Id for every resource record set that is referenced by these alias resource record sets, the alias resource record sets inherit the health of the referenced resource record sets.

          In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:

          • Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.

          • Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)

          • Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.

          • Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.

          Note the following:

          • You cannot set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

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

          • If you specify an Elastic Beanstalk environment in HostedZoneId and DNSName, and if 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, Amazon 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.

          • If you specify an ELB load balancer in AliasTarget ``, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If no Amazon EC2 instances are healthy or if the load balancer itself is unhealthy, and if ``EvaluateTargetHealth is true for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the Amazon EC2 instances that you register with an ELB load balancer. For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.

          • We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to handle the failure of one or more endpoints.

          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 a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.

        Amazon Route 53 determines whether a resource record set is healthy 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 information about how Amazon Route 53 determines whether a health check is healthy, see CreateHealthCheck.

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

        • You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.

        • You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets.

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

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

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

        • Amazon Route 53 Health Checks and DNS Failover

        • Configuring Failover in a Private Hosted Zone

      • TrafficPolicyInstanceId (string) --

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 the change request was submitted, in Coordinated Universal Time (UTC) format: YYYY-MM-DDThh:mm:ssZ. For more information, see the Wikipedia entry ISO 8601.

    • 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': {'ap-south-1'}}}}

{'HealthCheck': {'HealthCheckConfig': {'AlarmIdentifier': {'Region': {'ap-south-1'}}}}}

Creates a new health check.

To create a new health check, send a POST request to the /2013-04-01/healthcheck resource. The request body must include an XML document with a CreateHealthCheckRequest element. The response returns the CreateHealthCheckResponse element, containing the health check ID specified when adding health check to a resource record set. For information about adding health checks to resource record sets, see ResourceRecordSet$HealthCheckId in ChangeResourceRecordSets.

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

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

• Amazon Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.

• You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.

• You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch Developer Guide.

Request Syntax

client.create_health_check(
    CallerReference='string',
    HealthCheckConfig={
        'IPAddress': 'string',
        'Port': 123,
        'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
        'ResourcePath': 'string',
        'FullyQualifiedDomainName': 'string',
        'SearchString': 'string',
        'RequestInterval': 123,
        'FailureThreshold': 123,
        'MeasureLatency': True|False,
        'Inverted': True|False,
        'HealthThreshold': 123,
        'ChildHealthChecks': [
            'string',
        ],
        'EnableSNI': True|False,
        'Regions': [
            'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
        ],
        'AlarmIdentifier': {
            'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
            'Name': 'string'
        },
        'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
    }
)

type CallerReference:

string

param CallerReference:

[REQUIRED]

A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a health check.

type HealthCheckConfig:

dict

param HealthCheckConfig:

[REQUIRED]

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

• IPAddress (string) --

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

  If the endpoint is an Amazon EC2 instance, we recommend that you create an Elastic IP address, associate it with your Amazon EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

  For more information, see HealthCheckConfig$FullyQualifiedDomainName.

  Contraints: Amazon Route 53 cannot 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 cannot create health checks, see RFC 5735, Special Use IPv4 Addresses and RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space.

  When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

• Port (integer) --

  The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.

• Type (string) -- [REQUIRED]

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

  You can create the following types of health checks:

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

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

  • HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

  • HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

  • TCP: Amazon Route 53 tries to establish a TCP connection.

  • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

  • CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

  For more information about how Amazon Route 53 determines whether an endpoint is healthy, see the introduction to this topic.

• ResourcePath (string) --

  The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html.

• FullyQualifiedDomainName (string) --

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

  If you specify IPAddress:

  The value that you want Amazon Route 53 to pass in the Host header in all health checks except TCP health checks. This is typically the fully qualified DNS name of the website that you are attempting to health check. When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

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

  If you don't specify IPAddress:

  If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IP address that DNS returns, Amazon 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-1-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, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

• SearchString (string) --

  If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy.

  Amazon Route 53 considers case when searching for SearchString in the response body.

• RequestInterval (integer) --

  The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request. Each Amazon Route 53 health checker makes requests at this interval.

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

• MeasureLatency (boolean) --

  Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.

• Inverted (boolean) --

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

• HealthThreshold (integer) --

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

  Note the following:

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

  • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

• ChildHealthChecks (list) --

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

  • (string) --

• EnableSNI (boolean) --

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

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

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

• Regions (list) --

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

  • (string) --

    An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.

• AlarmIdentifier (dict) --

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

  • Region (string) -- [REQUIRED]

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

    For the current list of CloudWatch regions, see Amazon CloudWatch in AWS Regions and Endpoints in the Amazon Web Services General Reference.

  • Name (string) -- [REQUIRED]

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

• InsufficientDataHealthStatus (string) --

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

  • Healthy: Amazon Route 53 considers the health check to be healthy.

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

  • LastKnownStatus: Amazon Route 53uses 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.

rtype:

dict

returns:

Response Syntax

{
    'HealthCheck': {
        'Id': 'string',
        'CallerReference': 'string',
        'HealthCheckConfig': {
            'IPAddress': 'string',
            'Port': 123,
            'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
            'ResourcePath': 'string',
            'FullyQualifiedDomainName': 'string',
            'SearchString': 'string',
            'RequestInterval': 123,
            'FailureThreshold': 123,
            'MeasureLatency': True|False,
            'Inverted': True|False,
            'HealthThreshold': 123,
            'ChildHealthChecks': [
                'string',
            ],
            'EnableSNI': True|False,
            'Regions': [
                'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
            ],
            'AlarmIdentifier': {
                'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
                'Name': 'string'
            },
            'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
        },
        'HealthCheckVersion': 123,
        'CloudWatchAlarmConfiguration': {
            'EvaluationPeriods': 123,
            'Threshold': 123.0,
            'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
            'Period': 123,
            'MetricName': 'string',
            'Namespace': 'string',
            'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
            'Dimensions': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ]
        }
    },
    'Location': 'string'
}

Response Structure

• (dict) --

  A complex type containing the response information for the new health check.

  • HealthCheck (dict) --

    A complex type that contains identifying information about the health check.

    • Id (string) --

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

    • CallerReference (string) --

      A unique string that you specified when you created the health check.

    • HealthCheckConfig (dict) --

      A complex type that contains detailed information about one health check.

      • IPAddress (string) --

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

        If the endpoint is an Amazon EC2 instance, we recommend that you create an Elastic IP address, associate it with your Amazon EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

        For more information, see HealthCheckConfig$FullyQualifiedDomainName.

        Contraints: Amazon Route 53 cannot 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 cannot create health checks, see RFC 5735, Special Use IPv4 Addresses and RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space.

        When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

      • Port (integer) --

        The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.

      • Type (string) --

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

        You can create the following types of health checks:

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

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

        • HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

        • HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

        • TCP: Amazon Route 53 tries to establish a TCP connection.

        • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

        • CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

        For more information about how Amazon Route 53 determines whether an endpoint is healthy, see the introduction to this topic.

      • ResourcePath (string) --

        The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html.

      • FullyQualifiedDomainName (string) --

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

        If you specify IPAddress:

        The value that you want Amazon Route 53 to pass in the Host header in all health checks except TCP health checks. This is typically the fully qualified DNS name of the website that you are attempting to health check. When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

        • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

        • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

        • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

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

        If you don't specify IPAddress:

        If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IP address that DNS returns, Amazon 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-1-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, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

      • SearchString (string) --

        If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy.

        Amazon Route 53 considers case when searching for SearchString in the response body.

      • RequestInterval (integer) --

        The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request. Each Amazon Route 53 health checker makes requests at this interval.

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

      • MeasureLatency (boolean) --

        Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.

      • Inverted (boolean) --

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

      • HealthThreshold (integer) --

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

        Note the following:

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

        • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

      • ChildHealthChecks (list) --

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

        • (string) --

      • EnableSNI (boolean) --

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

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

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

      • Regions (list) --

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

        • (string) --

          An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.

      • AlarmIdentifier (dict) --

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

        • Region (string) --

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

          For the current list of CloudWatch regions, see Amazon CloudWatch in AWS Regions and Endpoints in the Amazon Web Services General Reference.

        • Name (string) --

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

      • InsufficientDataHealthStatus (string) --

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

        • Healthy: Amazon Route 53 considers the health check to be healthy.

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

        • LastKnownStatus: Amazon Route 53uses 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.

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

{'TrafficPolicy': {'Type': {'NAPTR'}}}

Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).

Send a POST request to the /Amazon Route 53 API version/trafficpolicy resource. The request body must include a document with a CreateTrafficPolicyRequest element. The response includes the CreateTrafficPolicyResponse element, which contains information about the new traffic policy.

Request Syntax

client.create_traffic_policy(
    Name='string',
    Document='string',
    Comment='string'
)

type Name:

string

param Name:

[REQUIRED]

The name of the traffic policy.

type Document:

string

param Document:

[REQUIRED]

The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format in the Amazon Route 53 API Reference.

type Comment:

string

param Comment:

(Optional) Any comments that you want to include about the traffic policy.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicy': {
        'Id': 'string',
        'Version': 123,
        'Name': 'string',
        'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
        'Document': 'string',
        'Comment': 'string'
    },
    'Location': 'string'
}

Response Structure

• (dict) --

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

  • TrafficPolicy (dict) --

    A complex type that contains settings for the new traffic policy.

    • Id (string) --

    • Version (integer) --

    • Name (string) --

    • Type (string) --

    • Document (string) --

    • Comment (string) --

  • Location (string) --

{'TrafficPolicyInstance': {'TrafficPolicyType': {'NAPTR'}}}

Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.

Send a POST request to the /Amazon Route 53 API version/trafficpolicyinstance resource. The request body must include a document with a CreateTrafficPolicyRequest element. The response returns the CreateTrafficPolicyInstanceResponse element, which contains information about the traffic policy instance.

Request Syntax

client.create_traffic_policy_instance(
    HostedZoneId='string',
    Name='string',
    TTL=123,
    TrafficPolicyId='string',
    TrafficPolicyVersion=123
)

type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

The ID of the hosted zone in which you want Amazon Route 53 to create resource record sets by using the configuration in a traffic policy.

type Name:

string

param Name:

[REQUIRED]

The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Amazon Route 53 creates for this traffic policy instance.

type TTL:

integer

param TTL:

[REQUIRED]

(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.

type TrafficPolicyId:

string

param TrafficPolicyId:

[REQUIRED]

The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

type TrafficPolicyVersion:

integer

param TrafficPolicyVersion:

[REQUIRED]

The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicyInstance': {
        'Id': 'string',
        'HostedZoneId': 'string',
        'Name': 'string',
        'TTL': 123,
        'State': 'string',
        'Message': 'string',
        'TrafficPolicyId': 'string',
        'TrafficPolicyVersion': 123,
        'TrafficPolicyType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'
    },
    'Location': 'string'
}

Response Structure

• (dict) --

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

  • TrafficPolicyInstance (dict) --

    A complex type that contains settings for the new traffic policy instance.

    • Id (string) --

    • HostedZoneId (string) --

    • Name (string) --

    • TTL (integer) --

    • State (string) --

    • Message (string) --

    • TrafficPolicyId (string) --

    • TrafficPolicyVersion (integer) --

    • TrafficPolicyType (string) --

  • Location (string) --

    A unique URL that represents a new traffic policy instance.

{'TrafficPolicy': {'Type': {'NAPTR'}}}

Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.

Send a POST request to the /Amazon Route 53 version/trafficpolicy/ resource. The request body includes a document with a CreateTrafficPolicyVersionRequest element. The response returns the CreateTrafficPolicyVersionResponse element, which contains information about the new version of the traffic policy.

Request Syntax

client.create_traffic_policy_version(
    Id='string',
    Document='string',
    Comment='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the traffic policy for which you want to create a new version.

type Document:

string

param Document:

[REQUIRED]

The definition of this version of the traffic policy, in JSON format. You specified the JSON in the CreateTrafficPolicyVersion request. For more information about the JSON format, see CreateTrafficPolicy.

type Comment:

string

param Comment:

The comment that you specified in the CreateTrafficPolicyVersion request, if any.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicy': {
        'Id': 'string',
        'Version': 123,
        'Name': 'string',
        'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
        'Document': 'string',
        'Comment': 'string'
    },
    'Location': 'string'
}

Response Structure

• (dict) --

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

  • TrafficPolicy (dict) --

    A complex type that contains settings for the new version of the traffic policy.

    • Id (string) --

    • Version (integer) --

    • Name (string) --

    • Type (string) --

    • Document (string) --

    • Comment (string) --

  • Location (string) --

{'ChangeBatchRecord': {'Changes': {'ResourceRecordSet': {'Type': {'NAPTR'}}}}}

Returns the status and changes of a change batch request.

Request Syntax

client.get_change_details(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the change batch. This is the value that you specified in the change ID parameter when you submitted the request.

rtype:

dict

returns:

Response Syntax

{
    'ChangeBatchRecord': {
        'Id': 'string',
        'SubmittedAt': datetime(2015, 1, 1),
        'Status': 'PENDING'|'INSYNC',
        'Comment': 'string',
        'Submitter': 'string',
        'Changes': [
            {
                'Action': 'CREATE'|'DELETE'|'UPSERT',
                'ResourceRecordSet': {
                    'Name': 'string',
                    'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
                    'SetIdentifier': 'string',
                    'Weight': 123,
                    'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'cn-north-1'|'ap-south-1',
                    'GeoLocation': {
                        'ContinentCode': 'string',
                        'CountryCode': 'string',
                        'SubdivisionCode': 'string'
                    },
                    'Failover': 'PRIMARY'|'SECONDARY',
                    'TTL': 123,
                    'ResourceRecords': [
                        {
                            'Value': 'string'
                        },
                    ],
                    'AliasTarget': {
                        'HostedZoneId': 'string',
                        'DNSName': 'string',
                        'EvaluateTargetHealth': True|False
                    },
                    'HealthCheckId': 'string',
                    'TrafficPolicyInstanceId': 'string'
                }
            },
        ]
    }
}

Response Structure

• (dict) --

  A complex type that contains the ChangeBatchRecord element.

  • ChangeBatchRecord (dict) --

    A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the contained changes.

    • Id (string) --

      The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

    • SubmittedAt (datetime) --

      The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).

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

      Valid Values: PENDING | INSYNC

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

    • Submitter (string) --

      The AWS account ID attached to the changes.

    • Changes (list) --

      A list of changes made in the ChangeBatch.

      • (dict) --

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

        • Action (string) --

          The action to perform:

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

          • DELETE: Deletes a existing resource record set that has the specified values for Name, Type, SetIdentifier (for latency, weighted, geolocation, and failover resource record sets), and TTL (except alias resource record sets, for which the TTL is determined by the AWS resource that you're routing DNS queries to).

          • UPSERT: If a resource record set does not already exist, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an existing resource record set only when all of the following values match: Name, Type, and SetIdentifier (for weighted, latency, geolocation, and failover resource record sets).

        • ResourceRecordSet (dict) --

          Information about the resource record set to create or delete.

          • Name (string) --

            The name of the domain you want to perform the action on.

            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 still assumes that the domain name that you specify is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

            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 cannot 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 | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

            Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | 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.

            Values for alias resource record sets:

            • CloudFront distributions: A

            • Elastic Beanstalk environment that has a regionalized subdomain: A

            • ELB load balancers: A | AAAA

            • Amazon S3 buckets: A

            • Another resource record set in this hosted zone: Specify the type of the resource record set for which you're creating the alias. Specify any value except NS or SOA.

          • SetIdentifier (string) --

            Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type. Omit SetIdentifier for any other types of record sets.

          • 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. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon 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 cannot 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, Amazon 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 Amazon 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 the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an Amazon 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, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon 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 are not required to create latency resource record sets for all Amazon EC2 regions. Amazon Route 53 will choose the region with the best latency from among the regions for which you create latency resource record sets.

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

          • GeoLocation (dict) --

            Geo location 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 cannot 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 cannot 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.

              Valid values: AF | AN | AS | EU | OC | NA | SA

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

            • CountryCode (string) --

              The two-letter code for the country.

            • SubdivisionCode (string) --

              The code for the subdivision, for example, a state in the United States or a province in Canada.

          • 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, Amazon 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, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

            • When the secondary resource record set is unhealthy, Amazon 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, Amazon 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 cannot 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 Amazon Route 53, see the following topics in the Amazon Route 53 Developer Guide:

            • Amazon Route 53 Health Checks and DNS Failover

            • Configuring Failover in a Private Hosted Zone

            Valid values: PRIMARY | SECONDARY

          • TTL (integer) --

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

            • If you're creating 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, latency, geolocation, or failover 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 CloudFront distribution, Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are redirecting queries. The Elastic Beanstalk environment must have a regionalized subdomain.

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

            • You can't create alias resource record sets for CloudFront distributions in a private hosted zone.

            • 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 the queries are routed:

              A CloudFront distribution

              Specify Z2FDTNDATAQYW2.

              Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the AWSk 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:

              • AWS Management Console: Go to the Amazon EC2; page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted Zone ID field on the Description tab. Use the same process to get the DNS Name. See HostedZone$Name.

              • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameID. Use the same process to get the CanonicalHostedZoneName. See HostedZone$Name.

              • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneNameID. Use the same process to get the CanonicalHostedZoneName. See HostedZone$Name.

                An Amazon S3 bucket configured as a static website

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

              Another Amazon Route 53 resource record set in your hosted zone

              Specify the hosted zone ID of your hosted zone. (An alias resource record set cannot 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:

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

              • Elastic Beanstalk environment: Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.) You can use the following methods to get the value of the CNAME attribute:

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

                • Elastic Load Balancing 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 Command Line Interface Reference.

              • An ELB load balancer: Specify the DNS name associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.

                • AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS Name field that begins with dualstack. Use the same process to get the Hosted Zone ID. See HostedZone$Id.

                • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneName. Use the same process to get the CanonicalHostedZoneNameId. See HostedZone$Id.

                • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneName. Use the same process to get the CanonicalHostedZoneNameId. See HostedZoneId.

              • An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3 website endpoint in which you created the bucket; for example, s3-website-us-east-1.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using Amazon S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon Simple Storage Service Developer Guide.

              • Another Amazon 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, weighted alias, latency alias, and failover alias record sets: If you set the value of EvaluateTargetHealth to true for the resource record set or sets in an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a value for HealthCheck$Id for every resource record set that is referenced by these alias resource record sets, the alias resource record sets inherit the health of the referenced resource record sets.

              In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:

              • Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.

              • Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)

              • Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.

              • Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.

              Note the following:

              • You cannot set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

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

              • If you specify an Elastic Beanstalk environment in HostedZoneId and DNSName, and if 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, Amazon 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.

              • If you specify an ELB load balancer in AliasTarget ``, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If no Amazon EC2 instances are healthy or if the load balancer itself is unhealthy, and if ``EvaluateTargetHealth is true for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the Amazon EC2 instances that you register with an ELB load balancer. For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.

              • We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to handle the failure of one or more endpoints.

              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 a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.

            Amazon Route 53 determines whether a resource record set is healthy 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 information about how Amazon Route 53 determines whether a health check is healthy, see CreateHealthCheck.

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

            • You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.

            • You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets.

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

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

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

            • Amazon Route 53 Health Checks and DNS Failover

            • Configuring Failover in a Private Hosted Zone

          • TrafficPolicyInstanceId (string) --

{'HealthCheck': {'HealthCheckConfig': {'AlarmIdentifier': {'Region': {'ap-south-1'}}}}}

Gets information about a specified health check. Send a GET request to the /2013-04-01/healthcheck/health check ID resource. For more information about using the console to perform this operation, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

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',
        'HealthCheckConfig': {
            'IPAddress': 'string',
            'Port': 123,
            'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
            'ResourcePath': 'string',
            'FullyQualifiedDomainName': 'string',
            'SearchString': 'string',
            'RequestInterval': 123,
            'FailureThreshold': 123,
            'MeasureLatency': True|False,
            'Inverted': True|False,
            'HealthThreshold': 123,
            'ChildHealthChecks': [
                'string',
            ],
            'EnableSNI': True|False,
            'Regions': [
                'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
            ],
            'AlarmIdentifier': {
                'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
                'Name': 'string'
            },
            'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
        },
        'HealthCheckVersion': 123,
        'CloudWatchAlarmConfiguration': {
            'EvaluationPeriods': 123,
            'Threshold': 123.0,
            'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
            'Period': 123,
            'MetricName': 'string',
            'Namespace': 'string',
            'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
            'Dimensions': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ]
        }
    }
}

Response Structure

• (dict) --

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

  • HealthCheck (dict) --

    A complex type that contains information about one health check that is associated with the current AWS account.

    • Id (string) --

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

    • CallerReference (string) --

      A unique string that you specified when you created the health check.

    • HealthCheckConfig (dict) --

      A complex type that contains detailed information about one health check.

      • IPAddress (string) --

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

        If the endpoint is an Amazon EC2 instance, we recommend that you create an Elastic IP address, associate it with your Amazon EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

        For more information, see HealthCheckConfig$FullyQualifiedDomainName.

        Contraints: Amazon Route 53 cannot 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 cannot create health checks, see RFC 5735, Special Use IPv4 Addresses and RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space.

        When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

      • Port (integer) --

        The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.

      • Type (string) --

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

        You can create the following types of health checks:

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

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

        • HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

        • HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

        • TCP: Amazon Route 53 tries to establish a TCP connection.

        • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

        • CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

        For more information about how Amazon Route 53 determines whether an endpoint is healthy, see the introduction to this topic.

      • ResourcePath (string) --

        The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html.

      • FullyQualifiedDomainName (string) --

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

        If you specify IPAddress:

        The value that you want Amazon Route 53 to pass in the Host header in all health checks except TCP health checks. This is typically the fully qualified DNS name of the website that you are attempting to health check. When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

        • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

        • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

        • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

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

        If you don't specify IPAddress:

        If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IP address that DNS returns, Amazon 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-1-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, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

      • SearchString (string) --

        If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy.

        Amazon Route 53 considers case when searching for SearchString in the response body.

      • RequestInterval (integer) --

        The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request. Each Amazon Route 53 health checker makes requests at this interval.

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

      • MeasureLatency (boolean) --

        Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.

      • Inverted (boolean) --

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

      • HealthThreshold (integer) --

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

        Note the following:

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

        • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

      • ChildHealthChecks (list) --

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

        • (string) --

      • EnableSNI (boolean) --

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

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

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

      • Regions (list) --

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

        • (string) --

          An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.

      • AlarmIdentifier (dict) --

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

        • Region (string) --

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

          For the current list of CloudWatch regions, see Amazon CloudWatch in AWS Regions and Endpoints in the Amazon Web Services General Reference.

        • Name (string) --

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

      • InsufficientDataHealthStatus (string) --

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

        • Healthy: Amazon Route 53 considers the health check to be healthy.

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

        • LastKnownStatus: Amazon Route 53uses 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.

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

{'TrafficPolicy': {'Type': {'NAPTR'}}}

Gets information about a specific traffic policy version.

Send a GET request to the /Amazon Route 53 API version/trafficpolicy resource.

Request Syntax

client.get_traffic_policy(
    Id='string',
    Version=123
)

type Id:

string

param Id:

[REQUIRED]

The ID of the traffic policy that you want to get information about.

type Version:

integer

param Version:

[REQUIRED]

The version number of the traffic policy that you want to get information about.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicy': {
        'Id': 'string',
        'Version': 123,
        'Name': 'string',
        'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
        'Document': 'string',
        'Comment': 'string'
    }
}

Response Structure

• (dict) --

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

  • TrafficPolicy (dict) --

    A complex type that contains settings for the specified traffic policy.

    • Id (string) --

    • Version (integer) --

    • Name (string) --

    • Type (string) --

    • Document (string) --

    • Comment (string) --

{'TrafficPolicyInstance': {'TrafficPolicyType': {'NAPTR'}}}

Gets information about a specified traffic policy instance.

Send a GET request to the /Amazon Route 53 API version/trafficpolicyinstance resource.

Request Syntax

client.get_traffic_policy_instance(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the traffic policy instance that you want to get information about.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicyInstance': {
        'Id': 'string',
        'HostedZoneId': 'string',
        'Name': 'string',
        'TTL': 123,
        'State': 'string',
        'Message': 'string',
        'TrafficPolicyId': 'string',
        'TrafficPolicyVersion': 123,
        'TrafficPolicyType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'
    }
}

Response Structure

• (dict) --

  A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.

  • TrafficPolicyInstance (dict) --

    A complex type that contains settings for the traffic policy instance.

    • Id (string) --

    • HostedZoneId (string) --

    • Name (string) --

    • TTL (integer) --

    • State (string) --

    • Message (string) --

    • TrafficPolicyId (string) --

    • TrafficPolicyVersion (integer) --

    • TrafficPolicyType (string) --

{'ChangeBatchRecords': {'Changes': {'ResourceRecordSet': {'Type': {'NAPTR'}}}}}

Gets the list of ChangeBatches in a given time period for a given hosted zone.

Request Syntax

client.list_change_batches_by_hosted_zone(
    HostedZoneId='string',
    StartDate='string',
    EndDate='string',
    MaxItems='string',
    Marker='string'
)

type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

The ID of the hosted zone that you want to see changes for.

type StartDate:

string

param StartDate:

[REQUIRED]

The start of the time period you want to see changes for.

type EndDate:

string

param EndDate:

[REQUIRED]

The end of the time period you want to see changes for.

type MaxItems:

string

param MaxItems:

The maximum number of items on a page.

type Marker:

string

param Marker:

The page marker.

rtype:

dict

returns:

Response Syntax

{
    'MaxItems': 'string',
    'Marker': 'string',
    'IsTruncated': True|False,
    'ChangeBatchRecords': [
        {
            'Id': 'string',
            'SubmittedAt': datetime(2015, 1, 1),
            'Status': 'PENDING'|'INSYNC',
            'Comment': 'string',
            'Submitter': 'string',
            'Changes': [
                {
                    'Action': 'CREATE'|'DELETE'|'UPSERT',
                    'ResourceRecordSet': {
                        'Name': 'string',
                        'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
                        'SetIdentifier': 'string',
                        'Weight': 123,
                        'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'cn-north-1'|'ap-south-1',
                        'GeoLocation': {
                            'ContinentCode': 'string',
                            'CountryCode': 'string',
                            'SubdivisionCode': 'string'
                        },
                        'Failover': 'PRIMARY'|'SECONDARY',
                        'TTL': 123,
                        'ResourceRecords': [
                            {
                                'Value': 'string'
                            },
                        ],
                        'AliasTarget': {
                            'HostedZoneId': 'string',
                            'DNSName': 'string',
                            'EvaluateTargetHealth': True|False
                        },
                        'HealthCheckId': 'string',
                        'TrafficPolicyInstanceId': 'string'
                    }
                },
            ]
        },
    ],
    'NextMarker': 'string'
}

Response Structure

• (dict) --

  A complex type containing the response information for the request.

  • MaxItems (string) --

    The value that you specified for the maxitems parameter in the call to ListHostedZones that produced the current response.

  • Marker (string) --

    For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the marker parameter in the request that produced the current response.

  • IsTruncated (boolean) --

    A flag that indicates if there are more change batches to list.

  • ChangeBatchRecords (list) --

    The change batches within the given hosted zone and time period.

    • (dict) --

      A complex type that lists the changes and information for a ChangeBatch.

      • Id (string) --

        The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

      • SubmittedAt (datetime) --

        The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).

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

        Valid Values: PENDING | INSYNC

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

      • Submitter (string) --

        The AWS account ID attached to the changes.

      • Changes (list) --

        A list of changes made in the ChangeBatch.

        • (dict) --

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

          • Action (string) --

            The action to perform:

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

            • DELETE: Deletes a existing resource record set that has the specified values for Name, Type, SetIdentifier (for latency, weighted, geolocation, and failover resource record sets), and TTL (except alias resource record sets, for which the TTL is determined by the AWS resource that you're routing DNS queries to).

            • UPSERT: If a resource record set does not already exist, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an existing resource record set only when all of the following values match: Name, Type, and SetIdentifier (for weighted, latency, geolocation, and failover resource record sets).

          • ResourceRecordSet (dict) --

            Information about the resource record set to create or delete.

            • Name (string) --

              The name of the domain you want to perform the action on.

              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 still assumes that the domain name that you specify is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

              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 cannot 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 | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

              Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | 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.

              Values for alias resource record sets:

              • CloudFront distributions: A

              • Elastic Beanstalk environment that has a regionalized subdomain: A

              • ELB load balancers: A | AAAA

              • Amazon S3 buckets: A

              • Another resource record set in this hosted zone: Specify the type of the resource record set for which you're creating the alias. Specify any value except NS or SOA.

            • SetIdentifier (string) --

              Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type. Omit SetIdentifier for any other types of record sets.

            • 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. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon 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 cannot 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, Amazon 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 Amazon 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 the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an Amazon 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, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon 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 are not required to create latency resource record sets for all Amazon EC2 regions. Amazon Route 53 will choose the region with the best latency from among the regions for which you create latency resource record sets.

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

            • GeoLocation (dict) --

              Geo location 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 cannot 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 cannot 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.

                Valid values: AF | AN | AS | EU | OC | NA | SA

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

              • CountryCode (string) --

                The two-letter code for the country.

              • SubdivisionCode (string) --

                The code for the subdivision, for example, a state in the United States or a province in Canada.

            • 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, Amazon 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, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

              • When the secondary resource record set is unhealthy, Amazon 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, Amazon 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 cannot 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 Amazon Route 53, see the following topics in the Amazon Route 53 Developer Guide:

              • Amazon Route 53 Health Checks and DNS Failover

              • Configuring Failover in a Private Hosted Zone

              Valid values: PRIMARY | SECONDARY

            • TTL (integer) --

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

              • If you're creating 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, latency, geolocation, or failover 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 CloudFront distribution, Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are redirecting queries. The Elastic Beanstalk environment must have a regionalized subdomain.

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

              • You can't create alias resource record sets for CloudFront distributions in a private hosted zone.

              • 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 the queries are routed:

                A CloudFront distribution

                Specify Z2FDTNDATAQYW2.

                Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the AWSk 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:

                • AWS Management Console: Go to the Amazon EC2; page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted Zone ID field on the Description tab. Use the same process to get the DNS Name. See HostedZone$Name.

                • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameID. Use the same process to get the CanonicalHostedZoneName. See HostedZone$Name.

                • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneNameID. Use the same process to get the CanonicalHostedZoneName. See HostedZone$Name.

                  An Amazon S3 bucket configured as a static website

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

                Another Amazon Route 53 resource record set in your hosted zone

                Specify the hosted zone ID of your hosted zone. (An alias resource record set cannot 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:

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

                • Elastic Beanstalk environment: Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.) You can use the following methods to get the value of the CNAME attribute:

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

                  • Elastic Load Balancing 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 Command Line Interface Reference.

                • An ELB load balancer: Specify the DNS name associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.

                  • AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS Name field that begins with dualstack. Use the same process to get the Hosted Zone ID. See HostedZone$Id.

                  • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneName. Use the same process to get the CanonicalHostedZoneNameId. See HostedZone$Id.

                  • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneName. Use the same process to get the CanonicalHostedZoneNameId. See HostedZoneId.

                • An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3 website endpoint in which you created the bucket; for example, s3-website-us-east-1.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using Amazon S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon Simple Storage Service Developer Guide.

                • Another Amazon 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, weighted alias, latency alias, and failover alias record sets: If you set the value of EvaluateTargetHealth to true for the resource record set or sets in an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a value for HealthCheck$Id for every resource record set that is referenced by these alias resource record sets, the alias resource record sets inherit the health of the referenced resource record sets.

                In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:

                • Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.

                • Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)

                • Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.

                • Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.

                Note the following:

                • You cannot set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

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

                • If you specify an Elastic Beanstalk environment in HostedZoneId and DNSName, and if 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, Amazon 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.

                • If you specify an ELB load balancer in AliasTarget ``, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If no Amazon EC2 instances are healthy or if the load balancer itself is unhealthy, and if ``EvaluateTargetHealth is true for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the Amazon EC2 instances that you register with an ELB load balancer. For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.

                • We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to handle the failure of one or more endpoints.

                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 a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.

              Amazon Route 53 determines whether a resource record set is healthy 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 information about how Amazon Route 53 determines whether a health check is healthy, see CreateHealthCheck.

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

              • You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.

              • You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets.

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

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

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

              • Amazon Route 53 Health Checks and DNS Failover

              • Configuring Failover in a Private Hosted Zone

            • TrafficPolicyInstanceId (string) --

  • NextMarker (string) --

    The next page marker.

{'Type': {'NAPTR'}}

{'ChangeBatchRecords': {'Changes': {'ResourceRecordSet': {'Type': {'NAPTR'}}}}}

Gets the list of ChangeBatches in a given time period for a given hosted zone and RRSet.

Request Syntax

client.list_change_batches_by_rr_set(
    HostedZoneId='string',
    Name='string',
    Type='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
    SetIdentifier='string',
    StartDate='string',
    EndDate='string',
    MaxItems='string',
    Marker='string'
)

type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

The ID of the hosted zone that you want to see changes for.

type Name:

string

param Name:

[REQUIRED]

The name of the RRSet that you want to see changes for.

type Type:

string

param Type:

[REQUIRED]

The type of the RRSet that you want to see changes for.

type SetIdentifier:

string

param SetIdentifier:

The identifier of the RRSet that you want to see changes for.

type StartDate:

string

param StartDate:

[REQUIRED]

The start of the time period you want to see changes for.

type EndDate:

string

param EndDate:

[REQUIRED]

The end of the time period you want to see changes for.

type MaxItems:

string

param MaxItems:

The maximum number of items on a page.

type Marker:

string

param Marker:

The page marker.

rtype:

dict

returns:

Response Syntax

{
    'MaxItems': 'string',
    'Marker': 'string',
    'IsTruncated': True|False,
    'ChangeBatchRecords': [
        {
            'Id': 'string',
            'SubmittedAt': datetime(2015, 1, 1),
            'Status': 'PENDING'|'INSYNC',
            'Comment': 'string',
            'Submitter': 'string',
            'Changes': [
                {
                    'Action': 'CREATE'|'DELETE'|'UPSERT',
                    'ResourceRecordSet': {
                        'Name': 'string',
                        'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
                        'SetIdentifier': 'string',
                        'Weight': 123,
                        'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'cn-north-1'|'ap-south-1',
                        'GeoLocation': {
                            'ContinentCode': 'string',
                            'CountryCode': 'string',
                            'SubdivisionCode': 'string'
                        },
                        'Failover': 'PRIMARY'|'SECONDARY',
                        'TTL': 123,
                        'ResourceRecords': [
                            {
                                'Value': 'string'
                            },
                        ],
                        'AliasTarget': {
                            'HostedZoneId': 'string',
                            'DNSName': 'string',
                            'EvaluateTargetHealth': True|False
                        },
                        'HealthCheckId': 'string',
                        'TrafficPolicyInstanceId': 'string'
                    }
                },
            ]
        },
    ],
    'NextMarker': 'string'
}

Response Structure

• (dict) --

  The input for a ListChangeBatchesByRRSet request.

  • MaxItems (string) --

    The maximum number of items on a page.

  • Marker (string) --

    The page marker.

  • IsTruncated (boolean) --

    A flag that indicates if there are more change batches to list.

  • ChangeBatchRecords (list) --

    The change batches within the given hosted zone and time period.

    • (dict) --

      A complex type that lists the changes and information for a ChangeBatch.

      • Id (string) --

        The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

      • SubmittedAt (datetime) --

        The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).

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

        Valid Values: PENDING | INSYNC

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

      • Submitter (string) --

        The AWS account ID attached to the changes.

      • Changes (list) --

        A list of changes made in the ChangeBatch.

        • (dict) --

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

          • Action (string) --

            The action to perform:

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

            • DELETE: Deletes a existing resource record set that has the specified values for Name, Type, SetIdentifier (for latency, weighted, geolocation, and failover resource record sets), and TTL (except alias resource record sets, for which the TTL is determined by the AWS resource that you're routing DNS queries to).

            • UPSERT: If a resource record set does not already exist, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an existing resource record set only when all of the following values match: Name, Type, and SetIdentifier (for weighted, latency, geolocation, and failover resource record sets).

          • ResourceRecordSet (dict) --

            Information about the resource record set to create or delete.

            • Name (string) --

              The name of the domain you want to perform the action on.

              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 still assumes that the domain name that you specify is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

              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 cannot 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 | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

              Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | 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.

              Values for alias resource record sets:

              • CloudFront distributions: A

              • Elastic Beanstalk environment that has a regionalized subdomain: A

              • ELB load balancers: A | AAAA

              • Amazon S3 buckets: A

              • Another resource record set in this hosted zone: Specify the type of the resource record set for which you're creating the alias. Specify any value except NS or SOA.

            • SetIdentifier (string) --

              Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type. Omit SetIdentifier for any other types of record sets.

            • 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. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon 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 cannot 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, Amazon 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 Amazon 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 the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an Amazon 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, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon 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 are not required to create latency resource record sets for all Amazon EC2 regions. Amazon Route 53 will choose the region with the best latency from among the regions for which you create latency resource record sets.

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

            • GeoLocation (dict) --

              Geo location 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 cannot 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 cannot 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.

                Valid values: AF | AN | AS | EU | OC | NA | SA

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

              • CountryCode (string) --

                The two-letter code for the country.

              • SubdivisionCode (string) --

                The code for the subdivision, for example, a state in the United States or a province in Canada.

            • 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, Amazon 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, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

              • When the secondary resource record set is unhealthy, Amazon 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, Amazon 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 cannot 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 Amazon Route 53, see the following topics in the Amazon Route 53 Developer Guide:

              • Amazon Route 53 Health Checks and DNS Failover

              • Configuring Failover in a Private Hosted Zone

              Valid values: PRIMARY | SECONDARY

            • TTL (integer) --

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

              • If you're creating 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, latency, geolocation, or failover 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 CloudFront distribution, Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are redirecting queries. The Elastic Beanstalk environment must have a regionalized subdomain.

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

              • You can't create alias resource record sets for CloudFront distributions in a private hosted zone.

              • 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 the queries are routed:

                A CloudFront distribution

                Specify Z2FDTNDATAQYW2.

                Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the AWSk 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:

                • AWS Management Console: Go to the Amazon EC2; page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted Zone ID field on the Description tab. Use the same process to get the DNS Name. See HostedZone$Name.

                • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameID. Use the same process to get the CanonicalHostedZoneName. See HostedZone$Name.

                • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneNameID. Use the same process to get the CanonicalHostedZoneName. See HostedZone$Name.

                  An Amazon S3 bucket configured as a static website

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

                Another Amazon Route 53 resource record set in your hosted zone

                Specify the hosted zone ID of your hosted zone. (An alias resource record set cannot 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:

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

                • Elastic Beanstalk environment: Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.) You can use the following methods to get the value of the CNAME attribute:

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

                  • Elastic Load Balancing 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 Command Line Interface Reference.

                • An ELB load balancer: Specify the DNS name associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.

                  • AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS Name field that begins with dualstack. Use the same process to get the Hosted Zone ID. See HostedZone$Id.

                  • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneName. Use the same process to get the CanonicalHostedZoneNameId. See HostedZone$Id.

                  • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneName. Use the same process to get the CanonicalHostedZoneNameId. See HostedZoneId.

                • An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3 website endpoint in which you created the bucket; for example, s3-website-us-east-1.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using Amazon S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon Simple Storage Service Developer Guide.

                • Another Amazon 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, weighted alias, latency alias, and failover alias record sets: If you set the value of EvaluateTargetHealth to true for the resource record set or sets in an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a value for HealthCheck$Id for every resource record set that is referenced by these alias resource record sets, the alias resource record sets inherit the health of the referenced resource record sets.

                In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:

                • Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.

                • Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)

                • Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.

                • Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.

                Note the following:

                • You cannot set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

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

                • If you specify an Elastic Beanstalk environment in HostedZoneId and DNSName, and if 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, Amazon 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.

                • If you specify an ELB load balancer in AliasTarget ``, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If no Amazon EC2 instances are healthy or if the load balancer itself is unhealthy, and if ``EvaluateTargetHealth is true for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the Amazon EC2 instances that you register with an ELB load balancer. For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.

                • We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to handle the failure of one or more endpoints.

                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 a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.

              Amazon Route 53 determines whether a resource record set is healthy 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 information about how Amazon Route 53 determines whether a health check is healthy, see CreateHealthCheck.

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

              • You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.

              • You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets.

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

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

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

              • Amazon Route 53 Health Checks and DNS Failover

              • Configuring Failover in a Private Hosted Zone

            • TrafficPolicyInstanceId (string) --

  • NextMarker (string) --

    The next page marker.

{'HealthChecks': {'HealthCheckConfig': {'AlarmIdentifier': {'Region': {'ap-south-1'}}}}}

Retrieve a list of your health checks. Send a GET request to the /2013-04-01/healthcheck resource. The response to this request includes a HealthChecks element with zero or more HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.

For information about listing health checks using the Amazon Route 53 console, see Amazon Route 53 Health Checks and DNS Failover.

Request Syntax

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

type Marker:

string

param Marker:

If the response to a ListHealthChecks is more than one page, marker is the health check ID for the first health check on the next page of results. For more information, see ListHealthChecksResponse$MaxItems.

type MaxItems:

string

param MaxItems:

The maximum number of HealthCheck elements you want ListHealthChecks to return on each page of the response body. If the AWS account includes more HealthCheck elements than the value of maxitems, the response is broken into pages. Each page contains the number of HealthCheck elements specified by maxitems.

For example, suppose you specify 10 for maxitems and the current AWS account has 51 health checks. In the response, ListHealthChecks sets ListHealthChecksResponse$IsTruncated to true and includes the ListHealthChecksResponse$NextMarker element. To access the second and subsequent pages, you resend the GET ListHealthChecks request, add the ListHealthChecksResponse$Marker parameter to the request, and specify the value of the ListHealthChecksResponse$NextMarker element from the previous response. On the last (sixth) page of the response, which contains only one HealthCheck element:

• The value of ListHealthChecksResponse$IsTruncated is false.

• ListHealthChecksResponse$NextMarker is omitted.

rtype:

dict

returns:

Response Syntax

{
    'HealthChecks': [
        {
            'Id': 'string',
            'CallerReference': 'string',
            'HealthCheckConfig': {
                'IPAddress': 'string',
                'Port': 123,
                'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
                'ResourcePath': 'string',
                'FullyQualifiedDomainName': 'string',
                'SearchString': 'string',
                'RequestInterval': 123,
                'FailureThreshold': 123,
                'MeasureLatency': True|False,
                'Inverted': True|False,
                'HealthThreshold': 123,
                'ChildHealthChecks': [
                    'string',
                ],
                'EnableSNI': True|False,
                'Regions': [
                    'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
                ],
                'AlarmIdentifier': {
                    'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
                    'Name': 'string'
                },
                'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
            },
            'HealthCheckVersion': 123,
            'CloudWatchAlarmConfiguration': {
                'EvaluationPeriods': 123,
                'Threshold': 123.0,
                'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
                'Period': 123,
                'MetricName': 'string',
                'Namespace': 'string',
                'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
                'Dimensions': [
                    {
                        'Name': 'string',
                        'Value': 'string'
                    },
                ]
            }
        },
    ],
    'Marker': 'string',
    'IsTruncated': True|False,
    'NextMarker': 'string',
    'MaxItems': 'string'
}

Response Structure

• (dict) --

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

  • HealthChecks (list) --

    A complex type that contains one HealthCheck element for each health check that is associated with the current AWS account.

    • (dict) --

      A complex type that contains information about one health check that is associated with the current AWS account.

      • Id (string) --

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

      • CallerReference (string) --

        A unique string that you specified when you created the health check.

      • HealthCheckConfig (dict) --

        A complex type that contains detailed information about one health check.

        • IPAddress (string) --

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

          If the endpoint is an Amazon EC2 instance, we recommend that you create an Elastic IP address, associate it with your Amazon EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

          For more information, see HealthCheckConfig$FullyQualifiedDomainName.

          Contraints: Amazon Route 53 cannot 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 cannot create health checks, see RFC 5735, Special Use IPv4 Addresses and RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space.

          When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

        • Port (integer) --

          The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.

        • Type (string) --

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

          You can create the following types of health checks:

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

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

          • HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

          • HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

          • TCP: Amazon Route 53 tries to establish a TCP connection.

          • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

          • CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

          For more information about how Amazon Route 53 determines whether an endpoint is healthy, see the introduction to this topic.

        • ResourcePath (string) --

          The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html.

        • FullyQualifiedDomainName (string) --

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

          If you specify IPAddress:

          The value that you want Amazon Route 53 to pass in the Host header in all health checks except TCP health checks. This is typically the fully qualified DNS name of the website that you are attempting to health check. When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

          • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

          • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

          • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

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

          If you don't specify IPAddress:

          If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IP address that DNS returns, Amazon 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-1-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, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

        • SearchString (string) --

          If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy.

          Amazon Route 53 considers case when searching for SearchString in the response body.

        • RequestInterval (integer) --

          The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request. Each Amazon Route 53 health checker makes requests at this interval.

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

        • MeasureLatency (boolean) --

          Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.

        • Inverted (boolean) --

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

        • HealthThreshold (integer) --

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

          Note the following:

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

          • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

        • ChildHealthChecks (list) --

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

          • (string) --

        • EnableSNI (boolean) --

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

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

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

        • Regions (list) --

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

          • (string) --

            An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.

        • AlarmIdentifier (dict) --

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

          • Region (string) --

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

            For the current list of CloudWatch regions, see Amazon CloudWatch in AWS Regions and Endpoints in the Amazon Web Services General Reference.

          • Name (string) --

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

        • InsufficientDataHealthStatus (string) --

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

          • Healthy: Amazon Route 53 considers the health check to be healthy.

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

          • LastKnownStatus: Amazon Route 53uses 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.

      • 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 Developer 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 Developer 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 maxitems health checks by calling ListHealthChecks again and specifying the value of the NextMarker element in the marker parameter.

    Valid Values: true | false

  • NextMarker (string) --

    If IsTruncated is true, the value of NextMarker identifies the first health check in the next group of maxitems health checks. Call ListHealthChecks again 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.

{'StartRecordType': {'NAPTR'}}

{'NextRecordType': {'NAPTR'}, 'ResourceRecordSets': {'Type': {'NAPTR'}}}

Request Syntax

client.list_resource_record_sets(
    HostedZoneId='string',
    StartRecordName='string',
    StartRecordType='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
    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 get.

type StartRecordName:

string

param StartRecordName:

The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.

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 | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

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

Values for alias resource record sets:

• CloudFront distribution: A

• Elastic Beanstalk environment that has a regionalized subdomain: A

• ELB load balancer: A | AAAA

• Amazon S3 bucket: A

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

type StartRecordIdentifier:

string

param StartRecordIdentifier:

Weighted resource record sets only: 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',
            'SetIdentifier': 'string',
            'Weight': 123,
            'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'cn-north-1'|'ap-south-1',
            'GeoLocation': {
                'ContinentCode': 'string',
                'CountryCode': 'string',
                'SubdivisionCode': 'string'
            },
            'Failover': 'PRIMARY'|'SECONDARY',
            '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',
    '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) --

        The name of the domain you want to perform the action on.

        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 still assumes that the domain name that you specify is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

        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 cannot 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 | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

        Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | 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.

        Values for alias resource record sets:

        • CloudFront distributions: A

        • Elastic Beanstalk environment that has a regionalized subdomain: A

        • ELB load balancers: A | AAAA

        • Amazon S3 buckets: A

        • Another resource record set in this hosted zone: Specify the type of the resource record set for which you're creating the alias. Specify any value except NS or SOA.

      • SetIdentifier (string) --

        Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type. Omit SetIdentifier for any other types of record sets.

      • 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. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon 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 cannot 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, Amazon 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 Amazon 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 the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an Amazon 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, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon 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 are not required to create latency resource record sets for all Amazon EC2 regions. Amazon Route 53 will choose the region with the best latency from among the regions for which you create latency resource record sets.

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

      • GeoLocation (dict) --

        Geo location 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 cannot 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 cannot 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.

          Valid values: AF | AN | AS | EU | OC | NA | SA

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

        • CountryCode (string) --

          The two-letter code for the country.

        • SubdivisionCode (string) --

          The code for the subdivision, for example, a state in the United States or a province in Canada.

      • 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, Amazon 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, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

        • When the secondary resource record set is unhealthy, Amazon 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, Amazon 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 cannot 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 Amazon Route 53, see the following topics in the Amazon Route 53 Developer Guide:

        • Amazon Route 53 Health Checks and DNS Failover

        • Configuring Failover in a Private Hosted Zone

        Valid values: PRIMARY | SECONDARY

      • TTL (integer) --

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

        • If you're creating 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, latency, geolocation, or failover 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 CloudFront distribution, Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are redirecting queries. The Elastic Beanstalk environment must have a regionalized subdomain.

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

        • You can't create alias resource record sets for CloudFront distributions in a private hosted zone.

        • 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 the queries are routed:

          A CloudFront distribution

          Specify Z2FDTNDATAQYW2.

          Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the AWSk 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:

          • AWS Management Console: Go to the Amazon EC2; page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted Zone ID field on the Description tab. Use the same process to get the DNS Name. See HostedZone$Name.

          • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameID. Use the same process to get the CanonicalHostedZoneName. See HostedZone$Name.

          • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneNameID. Use the same process to get the CanonicalHostedZoneName. See HostedZone$Name.

            An Amazon S3 bucket configured as a static website

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

          Another Amazon Route 53 resource record set in your hosted zone

          Specify the hosted zone ID of your hosted zone. (An alias resource record set cannot 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:

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

          • Elastic Beanstalk environment: Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.) You can use the following methods to get the value of the CNAME attribute:

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

            • Elastic Load Balancing 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 Command Line Interface Reference.

          • An ELB load balancer: Specify the DNS name associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.

            • AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS Name field that begins with dualstack. Use the same process to get the Hosted Zone ID. See HostedZone$Id.

            • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneName. Use the same process to get the CanonicalHostedZoneNameId. See HostedZone$Id.

            • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneName. Use the same process to get the CanonicalHostedZoneNameId. See HostedZoneId.

          • An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3 website endpoint in which you created the bucket; for example, s3-website-us-east-1.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using Amazon S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon Simple Storage Service Developer Guide.

          • Another Amazon 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, weighted alias, latency alias, and failover alias record sets: If you set the value of EvaluateTargetHealth to true for the resource record set or sets in an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a value for HealthCheck$Id for every resource record set that is referenced by these alias resource record sets, the alias resource record sets inherit the health of the referenced resource record sets.

          In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:

          • Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.

          • Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)

          • Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.

          • Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.

          Note the following:

          • You cannot set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

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

          • If you specify an Elastic Beanstalk environment in HostedZoneId and DNSName, and if 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, Amazon 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.

          • If you specify an ELB load balancer in AliasTarget ``, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If no Amazon EC2 instances are healthy or if the load balancer itself is unhealthy, and if ``EvaluateTargetHealth is true for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the Amazon EC2 instances that you register with an ELB load balancer. For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.

          • We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to handle the failure of one or more endpoints.

          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 a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.

        Amazon Route 53 determines whether a resource record set is healthy 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 information about how Amazon Route 53 determines whether a health check is healthy, see CreateHealthCheck.

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

        • You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.

        • You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets.

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

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

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

        • Amazon Route 53 Health Checks and DNS Failover

        • Configuring Failover in a Private Hosted Zone

      • TrafficPolicyInstanceId (string) --

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

    Weighted, latency, geolocation, and failover resource record sets only: 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.

  • MaxItems (string) --

    The maximum number of records you requested.

{'TrafficPolicySummaries': {'Type': {'NAPTR'}}}

Gets information about the latest version for every traffic policy that is associated with the current AWS account. Send a GET request to the /Amazon Route 53 API version/trafficpolicy resource.

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

The response includes three values that help you navigate from one group of maxitems traffic policies to the next:

• IsTruncated If the value of IsTruncated in the response is true, there are more traffic policies associated with the current AWS account. If IsTruncated is false, this response includes the last traffic policy that is associated with the current account.

• TrafficPolicyIdMarker If IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies. If you want to list more traffic policies, make another call to ListTrafficPolicies, and specify the value of the TrafficPolicyIdMarker element from the response in the TrafficPolicyIdMarker request parameter. If IsTruncated is false, the TrafficPolicyIdMarker element is omitted from the response.

• MaxItems The value that you specified for the MaxItems parameter in the request that produced the current response.

Request Syntax

client.list_traffic_policies(
    TrafficPolicyIdMarker='string',
    MaxItems='string'
)

type TrafficPolicyIdMarker:

string

param TrafficPolicyIdMarker:

(Conditional) For your first request to ListTrafficPolicies, do not include the TrafficPolicyIdMarker parameter.

If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of MaxItems policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of the TrafficPolicyIdMarker element that was returned in the previous response.

Policies are listed in the order in which they were created.

type MaxItems:

string

param MaxItems:

(Optional) The maximum number of traffic policies to be included in the response body for this request. If you have more than MaxItems traffic policies, the value of the IsTruncated element in the response is true, and the value of the TrafficPolicyIdMarker element is the ID of the first traffic policy in the next group of MaxItems traffic policies.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicySummaries': [
        {
            'Id': 'string',
            'Name': 'string',
            'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
            'LatestVersion': 123,
            'TrafficPolicyCount': 123
        },
    ],
    'IsTruncated': True|False,
    'TrafficPolicyIdMarker': 'string',
    'MaxItems': 'string'
}

Response Structure

• (dict) --

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

  • TrafficPolicySummaries (list) --

    A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current AWS account.

    • (dict) --

      • Id (string) --

      • Name (string) --

      • Type (string) --

      • LatestVersion (integer) --

      • TrafficPolicyCount (integer) --

  • IsTruncated (boolean) --

    A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of MaxItems traffic policies by calling ListTrafficPolicies again and specifying the value of the TrafficPolicyIdMarker element in the TrafficPolicyIdMarker request parameter.

    Valid Values: true | false

  • TrafficPolicyIdMarker (string) --

    If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.

  • MaxItems (string) --

    The value that you specified for the MaxItems parameter in the call to ListTrafficPolicies that produced the current response.

{'TrafficPolicyInstanceTypeMarker': {'NAPTR'}}

{'TrafficPolicyInstanceTypeMarker': {'NAPTR'},
 'TrafficPolicyInstances': {'TrafficPolicyType': {'NAPTR'}}}

Gets information about the traffic policy instances that you created by using the current AWS account.

Send a GET request to the /Amazon Route 53 API version/trafficpolicyinstance resource.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

The response includes five values that help you navigate from one group of MaxItems traffic policy instances to the next:

• IsTruncated If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the current AWS account. If IsTruncated is false, this response includes the last traffic policy instance that is associated with the current account.

• MaxItems The value that you specified for the MaxItems parameter in the request that produced the current response.

• HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker If IsTruncated is true, these three values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstances, and specify these values in the corresponding request parameters. If IsTruncated is false, all three elements are omitted from the response.

Request Syntax

client.list_traffic_policy_instances(
    HostedZoneIdMarker='string',
    TrafficPolicyInstanceNameMarker='string',
    TrafficPolicyInstanceTypeMarker='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
    MaxItems='string'
)

type HostedZoneIdMarker:

string

param HostedZoneIdMarker:

For the first request to ListTrafficPolicyInstances, omit this value.

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get the next group of MaxItems traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneIdMarker, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

type TrafficPolicyInstanceNameMarker:

string

param TrafficPolicyInstanceNameMarker:

For the first request to ListTrafficPolicyInstances, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

type TrafficPolicyInstanceTypeMarker:

string

param TrafficPolicyInstanceTypeMarker:

For the first request to ListTrafficPolicyInstances, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

type MaxItems:

string

param MaxItems:

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicyInstances': [
        {
            'Id': 'string',
            'HostedZoneId': 'string',
            'Name': 'string',
            'TTL': 123,
            'State': 'string',
            'Message': 'string',
            'TrafficPolicyId': 'string',
            'TrafficPolicyVersion': 123,
            'TrafficPolicyType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'
        },
    ],
    'HostedZoneIdMarker': 'string',
    'TrafficPolicyInstanceNameMarker': 'string',
    'TrafficPolicyInstanceTypeMarker': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
    'IsTruncated': True|False,
    'MaxItems': 'string'
}

Response Structure

• (dict) --

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

  • TrafficPolicyInstances (list) --

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    • (dict) --

      • Id (string) --

      • HostedZoneId (string) --

      • Name (string) --

      • TTL (integer) --

      • State (string) --

      • Message (string) --

      • TrafficPolicyId (string) --

      • TrafficPolicyVersion (integer) --

      • TrafficPolicyType (string) --

  • HostedZoneIdMarker (string) --

    If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.

  • TrafficPolicyInstanceNameMarker (string) --

    If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

  • TrafficPolicyInstanceTypeMarker (string) --

    If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

  • IsTruncated (boolean) --

    A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

  • MaxItems (string) --

    The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.

{'TrafficPolicyInstanceTypeMarker': {'NAPTR'}}

{'TrafficPolicyInstanceTypeMarker': {'NAPTR'},
 'TrafficPolicyInstances': {'TrafficPolicyType': {'NAPTR'}}}

Gets information about the traffic policy instances that you created in a specified hosted zone.

Send a GET request to the /Amazon Route 53 API version/trafficpolicyinstance resource and include the ID of the hosted zone.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

The response includes four values that help you navigate from one group of MaxItems traffic policy instances to the next:

• IsTruncated If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the current AWS account. If IsTruncated is false, this response includes the last traffic policy instance that is associated with the current account.

• MaxItems The value that you specified for the MaxItems parameter in the request that produced the current response.

• TrafficPolicyInstanceNameMarker and TrafficPolicyInstanceTypeMarker If IsTruncated is true, these two values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstancesByHostedZone, and specify these values in the corresponding request parameters. If IsTruncated is false, all three elements are omitted from the response.

Request Syntax

client.list_traffic_policy_instances_by_hosted_zone(
    HostedZoneId='string',
    TrafficPolicyInstanceNameMarker='string',
    TrafficPolicyInstanceTypeMarker='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
    MaxItems='string'
)

type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

The ID of the hosted zone for which you want to list traffic policy instances.

type TrafficPolicyInstanceNameMarker:

string

param TrafficPolicyInstanceNameMarker:

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

type TrafficPolicyInstanceTypeMarker:

string

param TrafficPolicyInstanceTypeMarker:

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

type MaxItems:

string

param MaxItems:

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicyInstances': [
        {
            'Id': 'string',
            'HostedZoneId': 'string',
            'Name': 'string',
            'TTL': 123,
            'State': 'string',
            'Message': 'string',
            'TrafficPolicyId': 'string',
            'TrafficPolicyVersion': 123,
            'TrafficPolicyType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'
        },
    ],
    'TrafficPolicyInstanceNameMarker': 'string',
    'TrafficPolicyInstanceTypeMarker': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
    'IsTruncated': True|False,
    'MaxItems': 'string'
}

Response Structure

• (dict) --

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

  • TrafficPolicyInstances (list) --

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    • (dict) --

      • Id (string) --

      • HostedZoneId (string) --

      • Name (string) --

      • TTL (integer) --

      • State (string) --

      • Message (string) --

      • TrafficPolicyId (string) --

      • TrafficPolicyVersion (integer) --

      • TrafficPolicyType (string) --

  • TrafficPolicyInstanceNameMarker (string) --

    If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

  • TrafficPolicyInstanceTypeMarker (string) --

    If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

  • IsTruncated (boolean) --

    A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstancesByHostedZone again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

  • MaxItems (string) --

    The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByHostedZone that produced the current response.

{'TrafficPolicyInstanceTypeMarker': {'NAPTR'}}

{'TrafficPolicyInstanceTypeMarker': {'NAPTR'},
 'TrafficPolicyInstances': {'TrafficPolicyType': {'NAPTR'}}}

Gets information about the traffic policy instances that you created by using a specify traffic policy version.

Send a GET request to the /Route 53 API version/trafficpolicyinstance resource and include the ID and version of the traffic policy.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

The response includes five values that help you navigate from one group of MaxItems traffic policy instances to the next:

• IsTruncated If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the specified traffic policy. If IsTruncated is false, this response includes the last traffic policy instance that is associated with the specified traffic policy.

• MaxItems The value that you specified for the MaxItems parameter in the request that produced the current response.

• HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker If IsTruncated is true, these values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstancesByPolicy, and specify these values in the corresponding request parameters. If IsTruncated is false, all three elements are omitted from the response.

Request Syntax

client.list_traffic_policy_instances_by_policy(
    TrafficPolicyId='string',
    TrafficPolicyVersion=123,
    HostedZoneIdMarker='string',
    TrafficPolicyInstanceNameMarker='string',
    TrafficPolicyInstanceTypeMarker='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
    MaxItems='string'
)

type TrafficPolicyId:

string

param TrafficPolicyId:

[REQUIRED]

The ID of the traffic policy for which you want to list traffic policy instances.

type TrafficPolicyVersion:

integer

param TrafficPolicyVersion:

[REQUIRED]

The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

type HostedZoneIdMarker:

string

param HostedZoneIdMarker:

For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, HostedZoneIdMarker is the ID of the hosted zone for the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

type TrafficPolicyInstanceNameMarker:

string

param TrafficPolicyInstanceNameMarker:

For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

type TrafficPolicyInstanceTypeMarker:

string

param TrafficPolicyInstanceTypeMarker:

For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

type MaxItems:

string

param MaxItems:

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicyInstances': [
        {
            'Id': 'string',
            'HostedZoneId': 'string',
            'Name': 'string',
            'TTL': 123,
            'State': 'string',
            'Message': 'string',
            'TrafficPolicyId': 'string',
            'TrafficPolicyVersion': 123,
            'TrafficPolicyType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'
        },
    ],
    'HostedZoneIdMarker': 'string',
    'TrafficPolicyInstanceNameMarker': 'string',
    'TrafficPolicyInstanceTypeMarker': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
    'IsTruncated': True|False,
    'MaxItems': 'string'
}

Response Structure

• (dict) --

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

  • TrafficPolicyInstances (list) --

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    • (dict) --

      • Id (string) --

      • HostedZoneId (string) --

      • Name (string) --

      • TTL (integer) --

      • State (string) --

      • Message (string) --

      • TrafficPolicyId (string) --

      • TrafficPolicyVersion (integer) --

      • TrafficPolicyType (string) --

  • HostedZoneIdMarker (string) --

    If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.

  • TrafficPolicyInstanceNameMarker (string) --

    If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

  • TrafficPolicyInstanceTypeMarker (string) --

    If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

  • IsTruncated (boolean) --

    A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

  • MaxItems (string) --

    The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced the current response.

{'TrafficPolicies': {'Type': {'NAPTR'}}}

Gets information about all of the versions for a specified traffic policy.

Send a GET request to the /Amazon Route 53 API version/trafficpolicy resource and specify the ID of the traffic policy for which you want to list versions.

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

The response includes three values that help you navigate from one group of ``maxitems``maxitems traffic policies to the next:

• IsTruncated If the value of IsTruncated in the response is true, there are more traffic policy versions associated with the specified traffic policy. If IsTruncated is false, this response includes the last traffic policy version that is associated with the specified traffic policy.

• TrafficPolicyVersionMarker The ID of the next traffic policy version that is associated with the current AWS account. If you want to list more traffic policies, make another call to ListTrafficPolicyVersions, and specify the value of the TrafficPolicyVersionMarker element in the TrafficPolicyVersionMarker request parameter. If IsTruncated is false, Amazon Route 53 omits the TrafficPolicyVersionMarker element from the response.

• MaxItems The value that you specified for the MaxItems parameter in the request that produced the current response.

Request Syntax

client.list_traffic_policy_versions(
    Id='string',
    TrafficPolicyVersionMarker='string',
    MaxItems='string'
)

type Id:

string

param Id:

[REQUIRED]

Specify the value of Id of the traffic policy for which you want to list all versions.

type TrafficPolicyVersionMarker:

string

param TrafficPolicyVersionMarker:

For your first request to ListTrafficPolicyVersions, do not include the TrafficPolicyVersionMarker parameter.

If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get the next group of MaxItems traffic policy versions, submit another request to ListTrafficPolicyVersions. For the value of TrafficPolicyVersionMarker, specify the value of the TrafficPolicyVersionMarker element that was returned in the previous response.

Traffic policy versions are listed in sequential order.

type MaxItems:

string

param MaxItems:

The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of the IsTruncated element in the response is true, and the value of the TrafficPolicyVersionMarker element is the ID of the first version in the next group of MaxItems traffic policy versions.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicies': [
        {
            'Id': 'string',
            'Version': 123,
            'Name': 'string',
            'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
            'Document': 'string',
            'Comment': 'string'
        },
    ],
    'IsTruncated': True|False,
    'TrafficPolicyVersionMarker': 'string',
    'MaxItems': 'string'
}

Response Structure

• (dict) --

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

  • TrafficPolicies (list) --

    A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy.

    • (dict) --

      • Id (string) --

      • Version (integer) --

      • Name (string) --

      • Type (string) --

      • Document (string) --

      • Comment (string) --

  • IsTruncated (boolean) --

    A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of maxitems traffic policies by calling ListTrafficPolicyVersions again and specifying the value of the NextMarker element in the marker parameter.

  • TrafficPolicyVersionMarker (string) --

    If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy in the next group of MaxItems traffic policies. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.

    This element is present only if IsTruncated is true.

  • MaxItems (string) --

    The value that you specified for the maxitems parameter in the call to ListTrafficPolicyVersions that produced the current response.

{'AlarmIdentifier': {'Region': {'ap-south-1'}}}

{'HealthCheck': {'HealthCheckConfig': {'AlarmIdentifier': {'Region': {'ap-south-1'}}}}}

Updates an existing health check.

Send a POST request to the /Amazon Route 53 API version/healthcheck/health check ID resource. The request body must include an XML document with an UpdateHealthCheckRequest element. For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.

Request Syntax

client.update_health_check(
    HealthCheckId='string',
    HealthCheckVersion=123,
    IPAddress='string',
    Port=123,
    ResourcePath='string',
    FullyQualifiedDomainName='string',
    SearchString='string',
    FailureThreshold=123,
    Inverted=True|False,
    HealthThreshold=123,
    ChildHealthChecks=[
        'string',
    ],
    EnableSNI=True|False,
    Regions=[
        'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
    ],
    AlarmIdentifier={
        'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
        'Name': 'string'
    },
    InsufficientDataHealthStatus='Healthy'|'Unhealthy'|'LastKnownStatus'
)

type HealthCheckId:

string

param HealthCheckId:

[REQUIRED]

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

type HealthCheckVersion:

integer

param HealthCheckVersion:

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

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

• f the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Amazon Route 53 updates the health check with the new settings.

• If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Amazon Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

type IPAddress:

string

param IPAddress:

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

f the endpoint is an Amazon EC2 instance, we recommend that you create an Elastic IP address, associate it with your Amazon 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 Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Linux Instances.

For more information, see UpdateHealthCheckRequest$FullyQualifiedDomainName.

type Port:

integer

param Port:

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

type ResourcePath:

string

param ResourcePath:

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.

Specify this value only if you want to change it.

type FullyQualifiedDomainName:

string

param FullyQualifiedDomainName:

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

If you specify IPAddress:

The value that you want Amazon Route 53 to pass in the Host header in all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks. When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

• If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

• If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

• If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName: Port to the endpoint in the Host header.

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

If you don't specify IPAddress:

If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IP address that DNS returns, Amazon 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-1-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, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

type SearchString:

string

param SearchString:

If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

type FailureThreshold:

integer

param FailureThreshold:

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

type Inverted:

boolean

param Inverted:

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

type HealthThreshold:

integer

param HealthThreshold:

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

Note the following:

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

• If you specify 0, Amazon Route 53 always considers this health check to be healthy.

type ChildHealthChecks:

list

param ChildHealthChecks:

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

• (string) --

type EnableSNI:

boolean

param EnableSNI:

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

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

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

type Regions:

list

param Regions:

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

• (string) --

  An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.

type AlarmIdentifier:

dict

param AlarmIdentifier:

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

• Region (string) -- [REQUIRED]

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

  For the current list of CloudWatch regions, see Amazon CloudWatch in AWS Regions and Endpoints in 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:

rtype:

dict

returns:

Response Syntax

{
    'HealthCheck': {
        'Id': 'string',
        'CallerReference': 'string',
        'HealthCheckConfig': {
            'IPAddress': 'string',
            'Port': 123,
            'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
            'ResourcePath': 'string',
            'FullyQualifiedDomainName': 'string',
            'SearchString': 'string',
            'RequestInterval': 123,
            'FailureThreshold': 123,
            'MeasureLatency': True|False,
            'Inverted': True|False,
            'HealthThreshold': 123,
            'ChildHealthChecks': [
                'string',
            ],
            'EnableSNI': True|False,
            'Regions': [
                'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
            ],
            'AlarmIdentifier': {
                'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-central-1'|'eu-west-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
                'Name': 'string'
            },
            'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
        },
        'HealthCheckVersion': 123,
        'CloudWatchAlarmConfiguration': {
            'EvaluationPeriods': 123,
            'Threshold': 123.0,
            'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
            'Period': 123,
            'MetricName': 'string',
            'Namespace': 'string',
            'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
            'Dimensions': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ]
        }
    }
}

Response Structure

• (dict) --

  • HealthCheck (dict) --

    A complex type that contains information about one health check that is associated with the current AWS account.

    • Id (string) --

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

    • CallerReference (string) --

      A unique string that you specified when you created the health check.

    • HealthCheckConfig (dict) --

      A complex type that contains detailed information about one health check.

      • IPAddress (string) --

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

        If the endpoint is an Amazon EC2 instance, we recommend that you create an Elastic IP address, associate it with your Amazon EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

        For more information, see HealthCheckConfig$FullyQualifiedDomainName.

        Contraints: Amazon Route 53 cannot 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 cannot create health checks, see RFC 5735, Special Use IPv4 Addresses and RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space.

        When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

      • Port (integer) --

        The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.

      • Type (string) --

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

        You can create the following types of health checks:

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

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

        • HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

        • HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

        • TCP: Amazon Route 53 tries to establish a TCP connection.

        • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

        • CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

        For more information about how Amazon Route 53 determines whether an endpoint is healthy, see the introduction to this topic.

      • ResourcePath (string) --

        The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html.

      • FullyQualifiedDomainName (string) --

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

        If you specify IPAddress:

        The value that you want Amazon Route 53 to pass in the Host header in all health checks except TCP health checks. This is typically the fully qualified DNS name of the website that you are attempting to health check. When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

        • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

        • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

        • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

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

        If you don't specify IPAddress:

        If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IP address that DNS returns, Amazon 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-1-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, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

      • SearchString (string) --

        If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy.

        Amazon Route 53 considers case when searching for SearchString in the response body.

      • RequestInterval (integer) --

        The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request. Each Amazon Route 53 health checker makes requests at this interval.

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

      • MeasureLatency (boolean) --

        Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.

      • Inverted (boolean) --

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

      • HealthThreshold (integer) --

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

        Note the following:

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

        • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

      • ChildHealthChecks (list) --

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

        • (string) --

      • EnableSNI (boolean) --

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

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

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

      • Regions (list) --

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

        • (string) --

          An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.

      • AlarmIdentifier (dict) --

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

        • Region (string) --

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

          For the current list of CloudWatch regions, see Amazon CloudWatch in AWS Regions and Endpoints in the Amazon Web Services General Reference.

        • Name (string) --

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

      • InsufficientDataHealthStatus (string) --

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

        • Healthy: Amazon Route 53 considers the health check to be healthy.

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

        • LastKnownStatus: Amazon Route 53uses 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.

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

{'TrafficPolicy': {'Type': {'NAPTR'}}}

Updates the comment for a specified traffic policy version.

Send a POST request to the /Amazon Route 53 API version/trafficpolicy/ resource.

The request body must include a document with an UpdateTrafficPolicyCommentRequest element.

Request Syntax

client.update_traffic_policy_comment(
    Id='string',
    Version=123,
    Comment='string'
)

type Id:

string

param Id:

[REQUIRED]

The value of Id for the traffic policy for which you want to update the comment.

type Version:

integer

param Version:

[REQUIRED]

The value of Version for the traffic policy for which you want to update the comment.

type Comment:

string

param Comment:

[REQUIRED]

The new comment for the specified traffic policy and version.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicy': {
        'Id': 'string',
        'Version': 123,
        'Name': 'string',
        'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
        'Document': 'string',
        'Comment': 'string'
    }
}

Response Structure

• (dict) --

  A complex type that contains the response information for the traffic policy.

  • TrafficPolicy (dict) --

    A complex type that contains settings for the specified traffic policy.

    • Id (string) --

    • Version (integer) --

    • Name (string) --

    • Type (string) --

    • Document (string) --

    • Comment (string) --

{'TrafficPolicyInstance': {'TrafficPolicyType': {'NAPTR'}}}

Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.

Send a POST request to the /Amazon Route 53 API version/trafficpolicyinstance/traffic policy ID resource. The request body must include a document with an UpdateTrafficPolicyInstanceRequest element.

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Amazon Route 53 performs the following operations:

• Amazon Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how substantial the differences are between the existing resource record sets and the new resource record sets.

• When all of the new resource record sets have been created, Amazon Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.

• Amazon Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.

Request Syntax

client.update_traffic_policy_instance(
    Id='string',
    TTL=123,
    TrafficPolicyId='string',
    TrafficPolicyVersion=123
)

type Id:

string

param Id:

[REQUIRED]

The ID of the traffic policy instance that you want to update.

type TTL:

integer

param TTL:

[REQUIRED]

The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.

type TrafficPolicyId:

string

param TrafficPolicyId:

[REQUIRED]

The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

type TrafficPolicyVersion:

integer

param TrafficPolicyVersion:

[REQUIRED]

The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

rtype:

dict

returns:

Response Syntax

{
    'TrafficPolicyInstance': {
        'Id': 'string',
        'HostedZoneId': 'string',
        'Name': 'string',
        'TTL': 123,
        'State': 'string',
        'Message': 'string',
        'TrafficPolicyId': 'string',
        'TrafficPolicyVersion': 123,
        'TrafficPolicyType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'
    }
}

Response Structure

• (dict) --

  A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.

  • TrafficPolicyInstance (dict) --

    A complex type that contains settings for the updated traffic policy instance.

    • Id (string) --

    • HostedZoneId (string) --

    • Name (string) --

    • TTL (integer) --

    • State (string) --

    • Message (string) --

    • TrafficPolicyId (string) --

    • TrafficPolicyVersion (integer) --

    • TrafficPolicyType (string) --