Route53 ******* Client ====== class Route53.Client A low-level client representing Amazon Route 53 Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service. You can use Route 53 to: * Register domain names. For more information, see How domain registration works. * Route internet traffic to the resources for your domain For more information, see How internet traffic is routed to your website or web application. * Check the health of your resources. For more information, see How Route 53 checks the health of your resources. import boto3 client = boto3.client('route53') These are the available methods: * activate_key_signing_key * associate_vpc_with_hosted_zone * can_paginate * change_cidr_collection * change_resource_record_sets * change_tags_for_resource * close * create_cidr_collection * create_health_check * create_hosted_zone * create_key_signing_key * create_query_logging_config * create_reusable_delegation_set * create_traffic_policy * create_traffic_policy_instance * create_traffic_policy_version * create_vpc_association_authorization * deactivate_key_signing_key * delete_cidr_collection * delete_health_check * delete_hosted_zone * delete_key_signing_key * delete_query_logging_config * delete_reusable_delegation_set * delete_traffic_policy * delete_traffic_policy_instance * delete_vpc_association_authorization * disable_hosted_zone_dnssec * disassociate_vpc_from_hosted_zone * enable_hosted_zone_dnssec * get_account_limit * get_change * get_checker_ip_ranges * get_dnssec * get_geo_location * get_health_check * get_health_check_count * get_health_check_last_failure_reason * get_health_check_status * get_hosted_zone * get_hosted_zone_count * get_hosted_zone_limit * get_paginator * get_query_logging_config * get_reusable_delegation_set * get_reusable_delegation_set_limit * get_traffic_policy * get_traffic_policy_instance * get_traffic_policy_instance_count * get_waiter * list_cidr_blocks * list_cidr_collections * list_cidr_locations * list_geo_locations * list_health_checks * list_hosted_zones * list_hosted_zones_by_name * list_hosted_zones_by_vpc * list_query_logging_configs * list_resource_record_sets * list_reusable_delegation_sets * list_tags_for_resource * list_tags_for_resources * list_traffic_policies * list_traffic_policy_instances * list_traffic_policy_instances_by_hosted_zone * list_traffic_policy_instances_by_policy * list_traffic_policy_versions * list_vpc_association_authorizations * test_dns_answer * update_health_check * update_hosted_zone_comment * update_traffic_policy_comment * update_traffic_policy_instance Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListCidrBlocks * ListCidrCollections * ListCidrLocations * ListHealthChecks * ListHostedZones * ListQueryLoggingConfigs * ListResourceRecordSets * ListVPCAssociationAuthorizations Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * ResourceRecordSetsChanged Route53 / Waiter / ResourceRecordSetsChanged ResourceRecordSetsChanged ************************* class Route53.Waiter.ResourceRecordSetsChanged waiter = client.get_waiter('resource_record_sets_changed') wait(**kwargs) Polls "Route53.Client.get_change()" every 30 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Id='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the change batch request. The value that you specify here is the value that "ChangeResourceRecordSets" returned in the "Id" element when you submitted the request. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None Route53 / Paginator / ListResourceRecordSets ListResourceRecordSets ********************** class Route53.Paginator.ListResourceRecordSets paginator = client.get_paginator('list_resource_record_sets') paginate(**kwargs) Creates an iterator that will paginate through responses from "Route53.Client.list_resource_record_sets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( HostedZoneId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **HostedZoneId** (*string*) -- **[REQUIRED]** The ID of the hosted zone that contains the resource record sets that you want to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ResourceRecordSets': [ { 'Name': 'string', 'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS'|'TLSA'|'SSHFP'|'SVCB'|'HTTPS', 'SetIdentifier': 'string', 'Weight': 123, 'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-central-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-north-1'|'cn-northwest-1'|'ap-east-1'|'me-south-1'|'me-central-1'|'ap-south-1'|'ap-south-2'|'af-south-1'|'eu-south-1'|'eu-south-2'|'ap-southeast-4'|'il-central-1'|'ca-west-1'|'ap-southeast-5'|'mx-central-1'|'ap-southeast-7'|'us-gov-east-1'|'us-gov-west-1'|'ap-east-2', 'GeoLocation': { 'ContinentCode': 'string', 'CountryCode': 'string', 'SubdivisionCode': 'string' }, 'Failover': 'PRIMARY'|'SECONDARY', 'MultiValueAnswer': True|False, 'TTL': 123, 'ResourceRecords': [ { 'Value': 'string' }, ], 'AliasTarget': { 'HostedZoneId': 'string', 'DNSName': 'string', 'EvaluateTargetHealth': True|False }, 'HealthCheckId': 'string', 'TrafficPolicyInstanceId': 'string', 'CidrRoutingConfig': { 'CollectionId': 'string', 'LocationName': 'string' }, 'GeoProximityLocation': { 'AWSRegion': 'string', 'LocalZoneGroup': 'string', 'Coordinates': { 'Latitude': 'string', 'Longitude': 'string' }, 'Bias': 123 } }, ], 'IsTruncated': True|False, 'MaxItems': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* A complex type that contains list information for the resource record set. * **ResourceRecordSets** *(list) --* Information about multiple resource record sets. * *(dict) --* Information about the resource record set to create or delete. * **Name** *(string) --* For "ChangeResourceRecordSets" requests, the name of the record that you want to create, update, or delete. For "ListResourceRecordSets" responses, the name of a record in the specified hosted zone. **ChangeResourceRecordSets Only** Enter a fully qualified domain name, for example, "www.example.com". You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats "www.example.com" (without a trailing dot) and "www.example.com." (with a trailing dot) as identical. For information about how to specify characters other than "a-z", "0-9", and "-" (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the *Amazon Route 53 Developer Guide*. You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, "*.example.com". Note the following: * The * must replace the entire label. For example, you can't specify "*prod.example.com" or "prod*.example.com". * The * can't replace any of the middle labels, for example, marketing.*.example.com. * If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard. Warning: You can't use the * wildcard for resource records sets that have a type of NS. * **Type** *(string) --* The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the *Amazon Route 53 Developer Guide*. Valid values for basic resource record sets: "A" | "AAAA" | "CAA" | "CNAME" | "DS" | "MX" | "NAPTR" | "NS" | "PTR" | "SOA" | "SPF" | "SRV" | "TXT``| ``TLSA``| ``SSHFP``| ``SVCB``| ``HTTPS" Values for weighted, latency, geolocation, and failover resource record sets: "A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NAPTR" | "PTR" | "SPF" | "SRV" | "TXT``| ``TLSA``| ``SSHFP``| ``SVCB``| ``HTTPS". When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group. Valid values for multivalue answer resource record sets: "A" | "AAAA" | "MX" | "NAPTR" | "PTR" | "SPF" | "SRV" | "TXT``| ``CAA``| ``TLSA``| ``SSHFP``| ``SVCB``| ``HTTPS" Note: SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of "Type" is "SPF". RFC 7208, *Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1*, has been updated to say, "...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type. Values for alias resource record sets: * **Amazon API Gateway custom regional APIs and edge- optimized APIs:** "A" * **CloudFront distributions:** "A" If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of "A" and one with a value of "AAAA". * **Amazon API Gateway environment that has a regionalized subdomain**: "A" * **ELB load balancers:** "A" | "AAAA" * **Amazon S3 buckets:** "A" * **Amazon Virtual Private Cloud interface VPC endpoints** "A" * **Another resource record set in this hosted zone:** Specify the type of the resource record set that you're creating the alias for. All values are supported except "NS" and "SOA". Note: If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of "Type" is "CNAME". This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record. * **SetIdentifier** *(string) --* *Resource record sets that have a routing policy other than simple:* An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of "SetIdentifier" must be unique for each resource record set. For information about routing policies, see Choosing a Routing Policy in the *Amazon Route 53 Developer Guide*. * **Weight** *(integer) --* *Weighted resource record sets only:* Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following: * You must specify a value for the "Weight" element for every weighted resource record set. * You can only specify one "ResourceRecord" per weighted resource record set. * You can't create latency, failover, or geolocation resource record sets that have the same values for the "Name" and "Type" elements as weighted resource record sets. * You can create a maximum of 100 weighted resource record sets that have the same values for the "Name" and "Type" elements. * For weighted (but not weighted alias) resource record sets, if you set "Weight" to "0" for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set "Weight" to "0" for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability. The effect of setting "Weight" to "0" is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active- Passive Failover in the *Amazon Route 53 Developer Guide*. * **Region** *(string) --* *Latency-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type. When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set. Note the following: * You can only specify one "ResourceRecord" per latency resource record set. * You can only create one latency resource record set for each Amazon EC2 Region. * You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for. * You can't create non-latency resource record sets that have the same values for the "Name" and "Type" elements as latency resource record sets. * **GeoLocation** *(dict) --* *Geolocation resource record sets only:* A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of "192.0.2.111", create a resource record set with a "Type" of "A" and a "ContinentCode" of "AF". If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource. You can't create two geolocation resource record sets that specify the same geographic location. The value "*" in the "CountryCode" element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the "Name" and "Type" elements. Warning: Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of "CountryCode" is "*". Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a "*" resource record set, Route 53 returns a "no answer" response for queries from those locations. You can't create non-geolocation resource record sets that have the same values for the "Name" and "Type" elements as geolocation resource record sets. * **ContinentCode** *(string) --* The two-letter code for the continent. Amazon Route 53 supports the following continent codes: * **AF**: Africa * **AN**: Antarctica * **AS**: Asia * **EU**: Europe * **OC**: Oceania * **NA**: North America * **SA**: South America Constraint: Specifying "ContinentCode" with either "CountryCode" or "SubdivisionCode" returns an "InvalidInput" error. * **CountryCode** *(string) --* For geolocation resource record sets, the two- letter code for a country. Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2. Route 53 also supports the country code **UA** for Ukraine. * **SubdivisionCode** *(string) --* For geolocation resource record sets, the two- letter code for a state of the United States. Route 53 doesn't support any other values for "SubdivisionCode". For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. If you specify "subdivisioncode", you must also specify "US" for "CountryCode". * **Failover** *(string) --* *Failover resource record sets only:* To configure failover, you add the "Failover" element to two resource record sets. For one resource record set, you specify "PRIMARY" as the value for "Failover"; for the other resource record set, you specify "SECONDARY". In addition, you include the "HealthCheckId" element and specify the health check that you want Amazon Route 53 to perform for each resource record set. Except where noted, the following failover behaviors assume that you have included the "HealthCheckId" element in both resource record sets: * When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set. * When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set. * When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set. * If you omit the "HealthCheckId" element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint. You can't create non-failover resource record sets that have the same values for the "Name" and "Type" elements as failover resource record sets. For failover alias resource record sets, you must also include the "EvaluateTargetHealth" element and set the value to true. For more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide*: * Route 53 Health Checks and DNS Failover * Configuring Failover in a Private Hosted Zone * **MultiValueAnswer** *(boolean) --* *Multivalue answer resource record sets only*: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify "true" for "MultiValueAnswer". Note the following: * If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy. * If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy. * Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records. * If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records. * When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records. * If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response. You can't create multivalue answer alias records. * **TTL** *(integer) --* The resource record cache time to live (TTL), in seconds. Note the following: * If you're creating or updating an alias resource record set, omit "TTL". Amazon Route 53 uses the value of "TTL" for the alias target. * If you're associating this resource record set with a health check (if you're adding a "HealthCheckId" element), we recommend that you specify a "TTL" of 60 seconds or less so clients respond quickly to changes in health status. * All of the resource record sets in a group of weighted resource record sets must have the same value for "TTL". * If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a "TTL" of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for "Weight". * **ResourceRecords** *(list) --* Information about the resource records to act upon. Note: If you're creating an alias resource record set, omit "ResourceRecords". * *(dict) --* Information specific to the resource record. Note: If you're creating an alias resource record set, omit "ResourceRecord". * **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". Note: If you're creating an alias resource record set, omit "Value". * **AliasTarget** *(dict) --* *Alias resource record sets only:* Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. If you're creating resource records sets for a private hosted zone, note the following: * You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution. * For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the *Amazon Route 53 Developer Guide*. * **HostedZoneId** *(string) --* *Alias resource records sets only*: The value used depends on where you want to route traffic: Amazon API Gateway custom regional APIs and edge-optimized APIs Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get- domain-names: * For regional APIs, specify the value of "regionalHostedZoneId". * For edge-optimized APIs, specify the value of "distributionHostedZoneId". Amazon Virtual Private Cloud interface VPC endpoint Specify the hosted zone ID for your interface endpoint. You can get the value of "HostedZoneId" using the CLI command describe-vpc-endpoints. CloudFront distribution Specify "Z2FDTNDATAQYW2". Note: Alias resource record sets for CloudFront can't be created in a private zone.Elastic Beanstalk environment Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the *Amazon Web Services General Reference*. ELB load balancer Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID: * Elastic Load Balancing endpoints and quotas topic in the *Amazon Web Services General Reference*: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers. * **Amazon Web Services Management Console**: Go to the Amazon EC2 page, choose **Load Balancers** in the navigation pane, select the load balancer, and get the value of the **Hosted zone** field on the **Description** tab. * **Elastic Load Balancing API**: Use "DescribeLoadBalancers" to get the applicable value. For more information, see the applicable guide: * Classic Load Balancers: Use DescribeLoadBalancers to get the value of "CanonicalHostedZoneNameId". * Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of "CanonicalHostedZoneId". * **CLI**: Use "describe-load-balancers" to get the applicable value. For more information, see the applicable guide: * Classic Load Balancers: Use describe-load- balancers to get the value of "CanonicalHostedZoneNameId". * Application and Network Load Balancers: Use describe-load-balancers to get the value of "CanonicalHostedZoneId". Global Accelerator accelerator Specify "Z2BJ6XQ5FK7U4H". An Amazon S3 bucket configured as a static website Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the *Amazon Web Services General Reference*. Another Route 53 resource record set in your hosted zone Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.) * **DNSName** *(string) --* *Alias resource record sets only:* The value that you specify depends on where you want to route queries: Amazon API Gateway custom regional APIs and edge-optimized APIs Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names: * For regional APIs, specify the value of "regionalDomainName". * For edge-optimized APIs, specify the value of "distributionDomainName". This is the name of the associated CloudFront distribution, such as "da1b2c3d4e5.cloudfront.net". Note: The name of the record that you're creating must match a custom domain name for your API, such as "api.example.com".Amazon Virtual Private Cloud interface VPC endpoint Enter the API endpoint for the interface endpoint, such as "vpce-123456789abcdef01-example-us-east- 1a.elasticloadbalancing.us- east-1.vpce.amazonaws.com". For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of "DnsName" using the CLI command describe-vpc- endpoints. CloudFront distribution Specify the domain name that CloudFront assigned when you created your distribution. Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is *acme.example.com*, your CloudFront distribution must include *acme.example.com* as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the *Amazon CloudFront Developer Guide*. You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution. Note: For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.Elastic Beanstalk environment If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name "my-environment.us- west-2.elasticbeanstalk.com" is a regionalized domain name. Warning: For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment. For Elastic Beanstalk environments that have regionalized subdomains, specify the "CNAME" attribute for the environment. You can use the following methods to get the value of the CNAME attribute: * *Amazon Web Services Management Console*: For information about how to get the value by using the console, see Using Custom Domains with Elastic Beanstalk in the *Elastic Beanstalk Developer Guide*. * *Elastic Beanstalk API*: Use the "DescribeEnvironments" action to get the value of the "CNAME" attribute. For more information, see DescribeEnvironments in the *Elastic Beanstalk API Reference*. * *CLI*: Use the "describe-environments" command to get the value of the "CNAME" attribute. For more information, see describe-environments in the *CLI Command Reference*. ELB load balancer Specify the DNS name that is associated with the load balancer. Get the DNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI. * **Amazon Web Services Management Console**: Go to the EC2 page, choose **Load Balancers** in the navigation pane, choose the load balancer, choose the **Description** tab, and get the value of the **DNS name** field. If you're routing traffic to a Classic Load Balancer, get the value that begins with **dualstack**. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA. * **Elastic Load Balancing API**: Use "DescribeLoadBalancers" to get the value of "DNSName". For more information, see the applicable guide: * Classic Load Balancers: DescribeLoadBalancers * Application and Network Load Balancers: DescribeLoadBalancers * **CLI**: Use "describe-load-balancers" to get the value of "DNSName". For more information, see the applicable guide: * Classic Load Balancers: describe-load-balancers * Application and Network Load Balancers: describe-load-balancers Global Accelerator accelerator Specify the DNS name for your accelerator: * **Global Accelerator API:** To get the DNS name, use DescribeAccelerator. * **CLI:** To get the DNS name, use describe- accelerator. Amazon S3 bucket that is configured as a static website Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, "s3-website.us-east-2.amazonaws.com". For more information about valid values, see the table Amazon S3 Website Endpoints in the *Amazon Web Services General Reference*. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the *Amazon Route 53 Developer Guide.* Another Route 53 resource record set Specify the value of the "Name" element for a resource record set in the current hosted zone. Note: If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of "Type" is "CNAME". This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record. * **EvaluateTargetHealth** *(boolean) --* *Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:* When "EvaluateTargetHealth" is "true", an alias resource record set inherits the health of the referenced Amazon Web Services resource, such as an ELB load balancer or another resource record set in the hosted zone. Note the following: CloudFront distributions You can't set "EvaluateTargetHealth" to "true" when the alias target is a CloudFront distribution. Elastic Beanstalk environments that have regionalized subdomains If you specify an Elastic Beanstalk environment in "DNSName" and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set "EvaluateTargetHealth" to "true" and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any. If the environment contains a single Amazon EC2 instance, there are no special requirements. ELB load balancers Health checking behavior depends on the type of load balancer: * **Classic Load Balancers**: If you specify an ELB Classic Load Balancer in "DNSName", Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set "EvaluateTargetHealth" to "true" and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources. * **Application and Network Load Balancers**: If you specify an ELB Application or Network Load Balancer and you set "EvaluateTargetHealth" to "true", Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer: * For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources. * A target group that has no registered targets is considered unhealthy. Note: When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.S3 buckets There are no special requirements for setting "EvaluateTargetHealth" to "true" when the alias target is an S3 bucket. Other records in the same hosted zone If the Amazon Web Services resource that you specify in "DNSName" is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the *Amazon Route 53 Developer Guide*. For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the *Amazon Route 53 Developer Guide*. * **HealthCheckId** *(string) --* If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the "HealthCheckId" element and specify the ID of the applicable health check. Route 53 determines whether a resource record set is healthy based on one of the following: * By periodically sending a request to the endpoint that is specified in the health check * By aggregating the status of a specified group of health checks (calculated health checks) * By determining the current state of a CloudWatch alarm (CloudWatch metric health checks) Warning: Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the "Value" element. When you add a "HealthCheckId" element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check. For more information, see the following topics in the *Amazon Route 53 Developer Guide*: * How Amazon Route 53 Determines Whether an Endpoint Is Healthy * Route 53 Health Checks and DNS Failover * Configuring Failover in a Private Hosted Zone **When to Specify HealthCheckId** Specifying a value for "HealthCheckId" is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations: * **Non-alias resource record sets**: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets. If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with. If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set. If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly. * **Alias resource record sets**: You specify the following settings: * You set "EvaluateTargetHealth" to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A). * You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone. * You specify a health check ID for the non-alias resource record set. If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with. If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set. Note: The alias resource record set can also route traffic to a *group* of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets. **Geolocation Routing** For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has "*" for "CountryCode" is "*", which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy: * The United States * North America * The default resource record set **Specifying the Health Check Endpoint by Domain Name** If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each "HTTP" server that is serving content for "www.example.com". For the value of "FullyQualifiedDomainName", specify the domain name of the server (such as "us-east-2-www.example.com"), not the name of the resource record sets ( "www.example.com"). Warning: Health check results will be unpredictable if you do the following: * Create a health check that has the same value for "FullyQualifiedDomainName" as the name of a resource record set. * Associate that health check with the resource record set. * **TrafficPolicyInstanceId** *(string) --* When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. "TrafficPolicyInstanceId" is the ID of the traffic policy instance that Route 53 created this resource record set for. Warning: To delete the resource record set that is associated with a traffic policy instance, use "DeleteTrafficPolicyInstance". Route 53 will delete the resource record set automatically. If you delete the resource record set by using "ChangeResourceRecordSets", Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use. * **CidrRoutingConfig** *(dict) --* The object that is specified in resource record set object when you are linking a resource record set to a CIDR location. A "LocationName" with an asterisk “*” can be used to create a default CIDR record. "CollectionId" is still required for default record. * **CollectionId** *(string) --* The CIDR collection ID. * **LocationName** *(string) --* The CIDR collection location name. * **GeoProximityLocation** *(dict) --* *GeoproximityLocation resource record sets only:* A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources. * **AWSRegion** *(string) --* The Amazon Web Services Region the resource you are directing DNS traffic to, is in. * **LocalZoneGroup** *(string) --* Specifies an Amazon Web Services Local Zone Group. A local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is "us-east-1-bue-1a" the Local Zone Group is "us-east-1-bue-1". You can identify the Local Zones Group for a specific Local Zone by using the describe- availability-zones CLI command: This command returns: ""GroupName": "us- west-2-den-1"", specifying that the Local Zone "us- west-2-den-1a" belongs to the Local Zone Group "us- west-2-den-1". * **Coordinates** *(dict) --* Contains the longitude and latitude for a geographic region. * **Latitude** *(string) --* Specifies a coordinate of the north–south position of a geographic point on the surface of the Earth (-90 - 90). * **Longitude** *(string) --* Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth (-180 - 180). * **Bias** *(integer) --* The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource. To use "Bias" to change the size of the geographic region, specify the applicable value for the bias: * To expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions. * To shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions. * **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. * **MaxItems** *(string) --* The maximum number of records you requested. * **NextToken** *(string) --* A token to resume pagination. Route53 / Paginator / ListQueryLoggingConfigs ListQueryLoggingConfigs *********************** class Route53.Paginator.ListQueryLoggingConfigs paginator = client.get_paginator('list_query_logging_configs') paginate(**kwargs) Creates an iterator that will paginate through responses from "Route53.Client.list_query_logging_configs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( HostedZoneId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **HostedZoneId** (*string*) -- (Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in "HostedZoneId". If you don't specify a hosted zone ID, "ListQueryLoggingConfigs" returns all of the configurations that are associated with the current Amazon Web Services account. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'QueryLoggingConfigs': [ { 'Id': 'string', 'HostedZoneId': 'string', 'CloudWatchLogsLogGroupArn': 'string' }, ], } **Response Structure** * *(dict) --* * **QueryLoggingConfigs** *(list) --* An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current Amazon Web Services account. * *(dict) --* A complex type that contains information about a configuration for DNS query logging. * **Id** *(string) --* The ID for a configuration for DNS query logging. * **HostedZoneId** *(string) --* The ID of the hosted zone that CloudWatch Logs is logging queries for. * **CloudWatchLogsLogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to. Route53 / Paginator / ListHealthChecks ListHealthChecks **************** class Route53.Paginator.ListHealthChecks paginator = client.get_paginator('list_health_checks') paginate(**kwargs) Creates an iterator that will paginate through responses from "Route53.Client.list_health_checks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'HealthChecks': [ { 'Id': 'string', 'CallerReference': 'string', 'LinkedService': { 'ServicePrincipal': 'string', 'Description': 'string' }, 'HealthCheckConfig': { 'IPAddress': 'string', 'Port': 123, 'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC'|'RECOVERY_CONTROL', 'ResourcePath': 'string', 'FullyQualifiedDomainName': 'string', 'SearchString': 'string', 'RequestInterval': 123, 'FailureThreshold': 123, 'MeasureLatency': True|False, 'Inverted': True|False, 'Disabled': True|False, 'HealthThreshold': 123, 'ChildHealthChecks': [ 'string', ], 'EnableSNI': True|False, 'Regions': [ 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1', ], 'AlarmIdentifier': { 'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-central-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'ap-east-1'|'me-south-1'|'me-central-1'|'ap-south-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-northwest-1'|'cn-north-1'|'af-south-1'|'eu-south-1'|'eu-south-2'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-iso-west-1'|'us-isob-east-1'|'ap-southeast-4'|'il-central-1'|'ca-west-1'|'ap-southeast-5'|'mx-central-1'|'us-isof-south-1'|'us-isof-east-1'|'ap-southeast-7'|'ap-east-2'|'eu-isoe-west-1', 'Name': 'string' }, 'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus', 'RoutingControlArn': 'string' }, '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, 'MaxItems': 'string', 'NextToken': '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 Amazon Web Services account. * *(dict) --* A complex type that contains information about one health check that is associated with the current Amazon Web Services account. * **Id** *(string) --* 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. * **CallerReference** *(string) --* A unique string that you specified when you created the health check. * **LinkedService** *(dict) --* If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53. * **ServicePrincipal** *(string) --* If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53. * **Description** *(string) --* If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53. * **HealthCheckConfig** *(dict) --* A complex type that contains detailed information about one health check. * **IPAddress** *(string) --* The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for "IPAddress", Route 53 sends a DNS request to resolve the domain name that you specify in "FullyQualifiedDomainName" at the interval that you specify in "RequestInterval". Using an IP address returned by DNS, Route 53 then checks the health of the endpoint. Use one of the following formats for the value of "IPAddress": * **IPv4 address**: four values between 0 and 255, separated by periods (.), for example, "192.0.2.44". * **IPv6 address**: eight groups of four hexadecimal values, separated by colons (:), for example, "2001:0db8:85a3:0000:0000:abcd:0001:2345". You can also shorten IPv6 addresses as described in RFC 5952, for example, "2001:db8:85a3::abcd:1:2345". If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for "IPAddress". This ensures that the IP address of your instance will never change. For more information, see FullyQualifiedDomainName. Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents: * RFC 5735, Special Use IPv4 Addresses * RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space * RFC 5156, Special-Use IPv6 Addresses When the value of "Type" is "CALCULATED" or "CLOUDWATCH_METRIC", omit "IPAddress". * **Port** *(integer) --* The port on the endpoint that you want Amazon Route 53 to perform health checks on. Note: Don't specify a value for "Port" when you specify a value for "Type" of "CLOUDWATCH_METRIC" or "CALCULATED". * **Type** *(string) --* The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy. Warning: You can't change the value of "Type" after you create a health check. You can create the following types of health checks: * **HTTP**: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. * **HTTPS**: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. Warning: If you specify "HTTPS" for the value of "Type", the endpoint must support TLS v1.0, v1.1, or v1.2. * **HTTP_STR_MATCH**: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in "SearchString". * **HTTPS_STR_MATCH**: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an "HTTPS" request and searches the first 5,120 bytes of the response body for the string that you specify in "SearchString". * **TCP**: Route 53 tries to establish a TCP connection. * **CLOUDWATCH_METRIC**: The health check is associated with a CloudWatch alarm. If the state of the alarm is "OK", the health check is considered healthy. If the state is "ALARM", the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is "OK" or "ALARM", the health check status depends on the setting for "InsufficientDataHealthStatus": "Healthy", "Unhealthy", or "LastKnownStatus". * **CALCULATED**: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of "HealthThreshold". * **RECOVERY_CONTROL**: The health check is associated with a Route53 Application Recovery Controller routing control. If the routing control state is "ON", the health check is considered healthy. If the state is "OFF", the health check is considered unhealthy. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the *Amazon Route 53 Developer Guide*. * **ResourcePath** *(string) --* The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53 -health-check.html. You can also include query string parameters, for example, "/welcome.html?language=jp&login=y". * **FullyQualifiedDomainName** *(string) --* Amazon Route 53 behavior depends on whether you specify a value for "IPAddress". **If you specify a value for** "IPAddress": Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of "FullyQualifiedDomainName" in the "Host" header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks. When Route 53 checks the health of an endpoint, here is how it constructs the "Host" header: * If you specify a value of "80" for "Port" and "HTTP" or "HTTP_STR_MATCH" for "Type", Route 53 passes the value of "FullyQualifiedDomainName" to the endpoint in the Host header. * If you specify a value of "443" for "Port" and "HTTPS" or "HTTPS_STR_MATCH" for "Type", Route 53 passes the value of "FullyQualifiedDomainName" to the endpoint in the "Host" header. * If you specify another value for "Port" and any value except "TCP" for "Type", Route 53 passes "FullyQualifiedDomainName:Port" to the endpoint in the "Host" header. If you don't specify a value for "FullyQualifiedDomainName", Route 53 substitutes the value of "IPAddress" in the "Host" header in each of the preceding cases. **If you don't specify a value for** "IPAddress": Route 53 sends a DNS request to the domain that you specify for "FullyQualifiedDomainName" at the interval that you specify for "RequestInterval". Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint. Note: If you don't specify a value for "IPAddress", Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for "FullyQualifiedDomainName", the health check fails with a "DNS resolution failed" error. If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by "FullyQualifiedDomainName", we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of "FullyQualifiedDomainName", specify the domain name of the server (such as us- east-2-www.example.com), not the name of the resource record sets (www.example.com). Warning: In this configuration, if you create a health check for which the value of "FullyQualifiedDomainName" matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable. In addition, if the value that you specify for "Type" is "HTTP", "HTTPS", "HTTP_STR_MATCH", or "HTTPS_STR_MATCH", Route 53 passes the value of "FullyQualifiedDomainName" in the "Host" header, as it does when you specify a value for "IPAddress". If the value of "Type" is "TCP", Route 53 doesn't pass a "Host" header. * **SearchString** *(string) --* If the value of Type is "HTTP_STR_MATCH" or "HTTPS_STR_MATCH", the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. Route 53 considers case when searching for "SearchString" in the response body. * **RequestInterval** *(integer) --* The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval. Warning: You can't change the value of "RequestInterval" after you create a health check. If you don't specify a value for "RequestInterval", the default value is "30" seconds. * **FailureThreshold** *(integer) --* The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the *Amazon Route 53 Developer Guide*. If you don't specify a value for "FailureThreshold", the default value is three health checks. * **MeasureLatency** *(boolean) --* Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple Amazon Web Services regions and your endpoint, and to display CloudWatch latency graphs on the **Health Checks** page in the Route 53 console. Warning: You can't change the value of "MeasureLatency" after you create a health check. * **Inverted** *(boolean) --* Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy. * **Disabled** *(boolean) --* Stops Route 53 from performing health checks. When you disable a health check, here's what happens: * **Health checks that check the health of endpoints:** Route 53 stops submitting requests to your application, server, or other resource. * **Calculated health checks:** Route 53 stops aggregating the status of the referenced health checks. * **Health checks that monitor CloudWatch alarms:** Route 53 stops monitoring the corresponding CloudWatch metrics. After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted. Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing. * **HealthThreshold** *(integer) --* The number of child health checks that are associated with a "CALCULATED" health check that Amazon Route 53 must consider healthy for the "CALCULATED" health check to be considered healthy. To specify the child health checks that you want to associate with a "CALCULATED" health check, use the ChildHealthChecks element. Note the following: * If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy. * If you specify "0", Route 53 always considers this health check to be healthy. * **ChildHealthChecks** *(list) --* (CALCULATED Health Checks Only) A complex type that contains one "ChildHealthCheck" element for each health check that you want to associate with a "CALCULATED" health check. * *(string) --* * **EnableSNI** *(boolean) --* Specify whether you want Amazon Route 53 to send the value of "FullyQualifiedDomainName" to the endpoint in the "client_hello" message during TLS negotiation. This allows the endpoint to respond to "HTTPS" health check requests with the applicable SSL/TLS certificate. Some endpoints require that "HTTPS" requests include the host name in the "client_hello" message. If you don't enable SNI, the status of the health check will be "SSL alert handshake_failure". A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid. The SSL/TLS certificate on your endpoint includes a domain name in the "Common Name" field and possibly several more in the "Subject Alternative Names" field. One of the domain names in the certificate should match the value that you specify for "FullyQualifiedDomainName". If the endpoint responds to the "client_hello" message with a certificate that does not include the domain name that you specified in "FullyQualifiedDomainName", a health checker will retry the handshake. In the second attempt, the health checker will omit "FullyQualifiedDomainName" from the "client_hello" message. * **Regions** *(list) --* A complex type that contains one "Region" element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint. If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under **Valid Values**. If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions). * *(string) --* * **AlarmIdentifier** *(dict) --* A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. * **Region** *(string) --* For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in. For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and quotas 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. Note: Route 53 supports CloudWatch alarms with the following features: * Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the *Amazon CloudWatch User Guide*. * Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported. * **InsufficientDataHealthStatus** *(string) --* When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: * "Healthy": Route 53 considers the health check to be healthy. * "Unhealthy": Route 53 considers the health check to be unhealthy. * "LastKnownStatus": Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy. * **RoutingControlArn** *(string) --* The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control. For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide.. * **HealthCheckVersion** *(integer) --* The version of the health check. You can optionally pass this value in a call to "UpdateHealthCheck" to prevent overwriting another change to the health check. * **CloudWatchAlarmConfiguration** *(dict) --* A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check. * **EvaluationPeriods** *(integer) --* For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold. * **Threshold** *(float) --* For the metric that the CloudWatch alarm is associated with, the value the metric is compared with. * **ComparisonOperator** *(string) --* For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison. * **Period** *(integer) --* For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds. * **MetricName** *(string) --* The name of the CloudWatch metric that the alarm is associated with. * **Namespace** *(string) --* The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the *Amazon CloudWatch User Guide*. * **Statistic** *(string) --* For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric. * **Dimensions** *(list) --* For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the *Amazon CloudWatch User Guide*. * *(dict) --* For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension. * **Name** *(string) --* For the metric that the CloudWatch alarm is associated with, the name of one dimension. * **Value** *(string) --* For the metric that the CloudWatch alarm is associated with, the value of one dimension. * **Marker** *(string) --* For the second and subsequent calls to "ListHealthChecks", "Marker" is the value that you specified for the "marker" parameter in the previous request. * **IsTruncated** *(boolean) --* A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of health checks by submitting another "ListHealthChecks" request and specifying the value of "NextMarker" in the "marker" parameter. * **MaxItems** *(string) --* The value that you specified for the "maxitems" parameter in the call to "ListHealthChecks" that produced the current response. * **NextToken** *(string) --* A token to resume pagination. Route53 / Paginator / ListVPCAssociationAuthorizations ListVPCAssociationAuthorizations ******************************** class Route53.Paginator.ListVPCAssociationAuthorizations paginator = client.get_paginator('list_vpc_association_authorizations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Route53.Client.list_vpc_association_authorizations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( HostedZoneId='string', MaxResults='string', PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: * **HostedZoneId** (*string*) -- **[REQUIRED]** The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone. * **MaxResults** (*string*) -- *Optional*: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. If you don't specify a value for "MaxResults", Route 53 returns up to 50 VPCs per page. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'HostedZoneId': 'string', 'VPCs': [ { 'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-central-2'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-iso-west-1'|'us-isob-east-1'|'me-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-south-1'|'ap-south-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'cn-northwest-1'|'af-south-1'|'eu-south-1'|'eu-south-2'|'ap-southeast-4'|'il-central-1'|'ca-west-1'|'ap-southeast-5'|'mx-central-1'|'us-isof-south-1'|'us-isof-east-1'|'ap-southeast-7'|'ap-east-2'|'eu-isoe-west-1', 'VPCId': 'string' }, ] } **Response Structure** * *(dict) --* A complex type that contains the response information for the request. * **HostedZoneId** *(string) --* The ID of the hosted zone that you can associate the listed VPCs with. * **VPCs** *(list) --* The list of VPCs that are authorized to be associated with the specified hosted zone. * *(dict) --* (Private hosted zones only) A complex type that contains information about an Amazon VPC. If you associate a private hosted zone with an Amazon VPC when you make a CreateHostedZone request, the following parameters are also required. * **VPCRegion** *(string) --* (Private hosted zones only) The region that an Amazon VPC was created in. * **VPCId** *(string) --* (Private hosted zones only) The ID of an Amazon VPC. Route53 / Paginator / ListHostedZones ListHostedZones *************** class Route53.Paginator.ListHostedZones paginator = client.get_paginator('list_hosted_zones') paginate(**kwargs) Creates an iterator that will paginate through responses from "Route53.Client.list_hosted_zones()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DelegationSetId='string', HostedZoneType='PrivateHostedZone', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DelegationSetId** (*string*) -- If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set. * **HostedZoneType** (*string*) -- (Optional) Specifies if the hosted zone is private. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'HostedZones': [ { 'Id': 'string', 'Name': 'string', 'CallerReference': 'string', 'Config': { 'Comment': 'string', 'PrivateZone': True|False }, 'ResourceRecordSetCount': 123, 'LinkedService': { 'ServicePrincipal': 'string', 'Description': 'string' } }, ], 'Marker': 'string', 'IsTruncated': True|False, 'MaxItems': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* * **HostedZones** *(list) --* A complex type that contains general information about the hosted zone. * *(dict) --* A complex type that contains general information about the hosted zone. * **Id** *(string) --* The ID that Amazon Route 53 assigned to the hosted zone when you created it. * **Name** *(string) --* The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar. For information about how to specify characters other than "a-z", "0-9", and "-" (hyphen) and how to specify internationalized domain names, see CreateHostedZone. * **CallerReference** *(string) --* The value that you specified for "CallerReference" when you created the hosted zone. * **Config** *(dict) --* A complex type that includes the "Comment" and "PrivateZone" elements. If you omitted the "HostedZoneConfig" and "Comment" elements from the request, the "Config" and "Comment" elements don't appear in the response. * **Comment** *(string) --* Any comments that you want to include about the hosted zone. * **PrivateZone** *(boolean) --* A value that indicates whether this is a private hosted zone. * **ResourceRecordSetCount** *(integer) --* The number of resource record sets in the hosted zone. * **LinkedService** *(dict) --* If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Route 53. * **ServicePrincipal** *(string) --* If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53. * **Description** *(string) --* If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53. * **Marker** *(string) --* For the second and subsequent calls to "ListHostedZones", "Marker" is the value that you specified for the "marker" parameter in the request that produced the current response. * **IsTruncated** *(boolean) --* A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another "ListHostedZones" request and specifying the value of "NextMarker" in the "marker" parameter. * **MaxItems** *(string) --* The value that you specified for the "maxitems" parameter in the call to "ListHostedZones" that produced the current response. * **NextToken** *(string) --* A token to resume pagination. Route53 / Paginator / ListCidrLocations ListCidrLocations ***************** class Route53.Paginator.ListCidrLocations paginator = client.get_paginator('list_cidr_locations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Route53.Client.list_cidr_locations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CollectionId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **CollectionId** (*string*) -- **[REQUIRED]** The CIDR collection ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CidrLocations': [ { 'LocationName': 'string' }, ] } **Response Structure** * *(dict) --* * **CidrLocations** *(list) --* A complex type that contains information about the list of CIDR locations. * *(dict) --* A complex type that contains information about the CIDR location. * **LocationName** *(string) --* A string that specifies a location name. Route53 / Paginator / ListCidrBlocks ListCidrBlocks ************** class Route53.Paginator.ListCidrBlocks paginator = client.get_paginator('list_cidr_blocks') paginate(**kwargs) Creates an iterator that will paginate through responses from "Route53.Client.list_cidr_blocks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CollectionId='string', LocationName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **CollectionId** (*string*) -- **[REQUIRED]** The UUID of the CIDR collection. * **LocationName** (*string*) -- The name of the CIDR collection location. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CidrBlocks': [ { 'CidrBlock': 'string', 'LocationName': 'string' }, ] } **Response Structure** * *(dict) --* * **CidrBlocks** *(list) --* A complex type that contains information about the CIDR blocks. * *(dict) --* A complex type that lists the CIDR blocks. * **CidrBlock** *(string) --* Value for the CIDR block. * **LocationName** *(string) --* The location name of the CIDR block. Route53 / Paginator / ListCidrCollections ListCidrCollections ******************* class Route53.Paginator.ListCidrCollections paginator = client.get_paginator('list_cidr_collections') paginate(**kwargs) Creates an iterator that will paginate through responses from "Route53.Client.list_cidr_collections()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CidrCollections': [ { 'Arn': 'string', 'Id': 'string', 'Name': 'string', 'Version': 123 }, ] } **Response Structure** * *(dict) --* * **CidrCollections** *(list) --* A complex type with information about the CIDR collection. * *(dict) --* A complex type that is an entry in an CidrCollection array. * **Arn** *(string) --* The ARN of the collection summary. Can be used to reference the collection in IAM policy or cross- account. * **Id** *(string) --* Unique ID for the CIDR collection. * **Name** *(string) --* The name of a CIDR collection. * **Version** *(integer) --* A sequential counter that Route 53 sets to 1 when you create a CIDR collection and increments by 1 each time you update settings for the CIDR collection. Route53 / Client / delete_key_signing_key delete_key_signing_key ********************** Route53.Client.delete_key_signing_key(**kwargs) Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be deactivated before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing. You can use DeactivateKeySigningKey to deactivate the key before you delete it. Use GetDNSSEC to verify that the KSK is in an "INACTIVE" status. See also: AWS API Documentation **Request Syntax** response = client.delete_key_signing_key( HostedZoneId='string', Name='string' ) Parameters: * **HostedZoneId** (*string*) -- **[REQUIRED]** A unique string used to identify a hosted zone. * **Name** (*string*) -- **[REQUIRED]** A string used to identify a key-signing key (KSK). Return type: dict Returns: **Response Syntax** { 'ChangeInfo': { 'Id': 'string', 'Status': 'PENDING'|'INSYNC', 'SubmittedAt': datetime(2015, 1, 1), 'Comment': 'string' } } **Response Structure** * *(dict) --* * **ChangeInfo** *(dict) --* A complex type that describes change information about changes made to your hosted zone. * **Id** *(string) --* This element contains an ID that you use when performing a GetChange action to get detailed information about the change. * **Status** *(string) --* The current state of the request. "PENDING" indicates that this request has not yet been applied to all Amazon Route 53 DNS servers. * **SubmittedAt** *(datetime) --* The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value "2017-03-27T17:48:16.751Z" represents March 27, 2017 at 17:48:16.751 UTC. * **Comment** *(string) --* A comment you can provide. **Exceptions** * "Route53.Client.exceptions.ConcurrentModification" * "Route53.Client.exceptions.NoSuchKeySigningKey" * "Route53.Client.exceptions.InvalidKeySigningKeyStatus" * "Route53.Client.exceptions.InvalidSigningStatus" * "Route53.Client.exceptions.InvalidKMSArn" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / list_cidr_locations list_cidr_locations ******************* Route53.Client.list_cidr_locations(**kwargs) Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks). See also: AWS API Documentation **Request Syntax** response = client.list_cidr_locations( CollectionId='string', NextToken='string', MaxResults='string' ) Parameters: * **CollectionId** (*string*) -- **[REQUIRED]** The CIDR collection ID. * **NextToken** (*string*) -- An opaque pagination token to indicate where the service is to begin enumerating results. If no value is provided, the listing of results starts from the beginning. * **MaxResults** (*string*) -- The maximum number of CIDR collection locations to return in the response. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'CidrLocations': [ { 'LocationName': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* An opaque pagination token to indicate where the service is to begin enumerating results. If no value is provided, the listing of results starts from the beginning. * **CidrLocations** *(list) --* A complex type that contains information about the list of CIDR locations. * *(dict) --* A complex type that contains information about the CIDR location. * **LocationName** *(string) --* A string that specifies a location name. **Exceptions** * "Route53.Client.exceptions.NoSuchCidrCollectionException" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / get_query_logging_config get_query_logging_config ************************ Route53.Client.get_query_logging_config(**kwargs) Gets information about a specified configuration for DNS query logging. For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries. See also: AWS API Documentation **Request Syntax** response = client.get_query_logging_config( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The ID of the configuration for DNS query logging that you want to get information about. Return type: dict Returns: **Response Syntax** { 'QueryLoggingConfig': { 'Id': 'string', 'HostedZoneId': 'string', 'CloudWatchLogsLogGroupArn': 'string' } } **Response Structure** * *(dict) --* * **QueryLoggingConfig** *(dict) --* A complex type that contains information about the query logging configuration that you specified in a GetQueryLoggingConfig request. * **Id** *(string) --* The ID for a configuration for DNS query logging. * **HostedZoneId** *(string) --* The ID of the hosted zone that CloudWatch Logs is logging queries for. * **CloudWatchLogsLogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to. **Exceptions** * "Route53.Client.exceptions.NoSuchQueryLoggingConfig" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / create_vpc_association_authorization create_vpc_association_authorization ************************************ Route53.Client.create_vpc_association_authorization(**kwargs) Authorizes the Amazon Web Services account that created a specified VPC to submit an "AssociateVPCWithHostedZone" request to associate the VPC with a specified hosted zone that was created by a different account. To submit a "CreateVPCAssociationAuthorization" request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an "AssociateVPCWithHostedZone" request. Note: If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC. See also: AWS API Documentation **Request Syntax** response = client.create_vpc_association_authorization( HostedZoneId='string', VPC={ 'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-central-2'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-iso-west-1'|'us-isob-east-1'|'me-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-south-1'|'ap-south-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'cn-northwest-1'|'af-south-1'|'eu-south-1'|'eu-south-2'|'ap-southeast-4'|'il-central-1'|'ca-west-1'|'ap-southeast-5'|'mx-central-1'|'us-isof-south-1'|'us-isof-east-1'|'ap-southeast-7'|'ap-east-2'|'eu-isoe-west-1', 'VPCId': 'string' } ) Parameters: * **HostedZoneId** (*string*) -- **[REQUIRED]** The ID of the private hosted zone that you want to authorize associating a VPC with. * **VPC** (*dict*) -- **[REQUIRED]** A complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone. * **VPCRegion** *(string) --* (Private hosted zones only) The region that an Amazon VPC was created in. * **VPCId** *(string) --* (Private hosted zones only) The ID of an Amazon VPC. Return type: dict Returns: **Response Syntax** { 'HostedZoneId': 'string', 'VPC': { 'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-central-2'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-iso-west-1'|'us-isob-east-1'|'me-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-south-1'|'ap-south-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'cn-northwest-1'|'af-south-1'|'eu-south-1'|'eu-south-2'|'ap-southeast-4'|'il-central-1'|'ca-west-1'|'ap-southeast-5'|'mx-central-1'|'us-isof-south-1'|'us-isof-east-1'|'ap-southeast-7'|'ap-east-2'|'eu-isoe-west-1', 'VPCId': 'string' } } **Response Structure** * *(dict) --* A complex type that contains the response information from a "CreateVPCAssociationAuthorization" request. * **HostedZoneId** *(string) --* The ID of the hosted zone that you authorized associating a VPC with. * **VPC** *(dict) --* The VPC that you authorized associating with a hosted zone. * **VPCRegion** *(string) --* (Private hosted zones only) The region that an Amazon VPC was created in. * **VPCId** *(string) --* (Private hosted zones only) The ID of an Amazon VPC. **Exceptions** * "Route53.Client.exceptions.ConcurrentModification" * "Route53.Client.exceptions.TooManyVPCAssociationAuthorizations" * "Route53.Client.exceptions.NoSuchHostedZone" * "Route53.Client.exceptions.InvalidVPCId" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / get_paginator get_paginator ************* Route53.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Route53 / Client / create_cidr_collection create_cidr_collection ********************** Route53.Client.create_cidr_collection(**kwargs) Creates a CIDR collection in the current Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.create_cidr_collection( Name='string', CallerReference='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** A unique identifier for the account that can be used to reference the collection from other API calls. * **CallerReference** (*string*) -- **[REQUIRED]** A client-specific token that allows requests to be securely retried so that the intended outcome will only occur once, retries receive a similar response, and there are no additional edge cases to handle. Return type: dict Returns: **Response Syntax** { 'Collection': { 'Arn': 'string', 'Id': 'string', 'Name': 'string', 'Version': 123 }, 'Location': 'string' } **Response Structure** * *(dict) --* * **Collection** *(dict) --* A complex type that contains information about the CIDR collection. * **Arn** *(string) --* The ARN of the collection. Can be used to reference the collection in IAM policy or in another Amazon Web Services account. * **Id** *(string) --* The unique ID of the CIDR collection. * **Name** *(string) --* The name of a CIDR collection. * **Version** *(integer) --* A sequential counter that Route 53 sets to 1 when you create a CIDR collection and increments by 1 each time you update settings for the CIDR collection. * **Location** *(string) --* A unique URL that represents the location for the CIDR collection. **Exceptions** * "Route53.Client.exceptions.LimitsExceeded" * "Route53.Client.exceptions.InvalidInput" * "Route53.Client.exceptions.CidrCollectionAlreadyExistsException" * "Route53.Client.exceptions.ConcurrentModification" Route53 / Client / disable_hosted_zone_dnssec disable_hosted_zone_dnssec ************************** Route53.Client.disable_hosted_zone_dnssec(**kwargs) Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any key-signing keys (KSKs) that are active in the hosted zone. See also: AWS API Documentation **Request Syntax** response = client.disable_hosted_zone_dnssec( HostedZoneId='string' ) Parameters: **HostedZoneId** (*string*) -- **[REQUIRED]** A unique string used to identify a hosted zone. Return type: dict Returns: **Response Syntax** { 'ChangeInfo': { 'Id': 'string', 'Status': 'PENDING'|'INSYNC', 'SubmittedAt': datetime(2015, 1, 1), 'Comment': 'string' } } **Response Structure** * *(dict) --* * **ChangeInfo** *(dict) --* A complex type that describes change information about changes made to your hosted zone. * **Id** *(string) --* This element contains an ID that you use when performing a GetChange action to get detailed information about the change. * **Status** *(string) --* The current state of the request. "PENDING" indicates that this request has not yet been applied to all Amazon Route 53 DNS servers. * **SubmittedAt** *(datetime) --* The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value "2017-03-27T17:48:16.751Z" represents March 27, 2017 at 17:48:16.751 UTC. * **Comment** *(string) --* A comment you can provide. **Exceptions** * "Route53.Client.exceptions.NoSuchHostedZone" * "Route53.Client.exceptions.InvalidArgument" * "Route53.Client.exceptions.ConcurrentModification" * "Route53.Client.exceptions.KeySigningKeyInParentDSRecord" * "Route53.Client.exceptions.DNSSECNotFound" * "Route53.Client.exceptions.InvalidKeySigningKeyStatus" * "Route53.Client.exceptions.InvalidKMSArn" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / delete_vpc_association_authorization delete_vpc_association_authorization ************************************ Route53.Client.delete_vpc_association_authorization(**kwargs) Removes authorization to submit an "AssociateVPCWithHostedZone" request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a "DeleteVPCAssociationAuthorization" request. Warning: Sending this request only prevents the Amazon Web Services account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, "DeleteVPCAssociationAuthorization" won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use "DisassociateVPCFromHostedZone". See also: AWS API Documentation **Request Syntax** response = client.delete_vpc_association_authorization( HostedZoneId='string', VPC={ 'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-central-2'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-iso-west-1'|'us-isob-east-1'|'me-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-south-1'|'ap-south-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'cn-northwest-1'|'af-south-1'|'eu-south-1'|'eu-south-2'|'ap-southeast-4'|'il-central-1'|'ca-west-1'|'ap-southeast-5'|'mx-central-1'|'us-isof-south-1'|'us-isof-east-1'|'ap-southeast-7'|'ap-east-2'|'eu-isoe-west-1', 'VPCId': 'string' } ) Parameters: * **HostedZoneId** (*string*) -- **[REQUIRED]** When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone. * **VPC** (*dict*) -- **[REQUIRED]** When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the VPC. * **VPCRegion** *(string) --* (Private hosted zones only) The region that an Amazon VPC was created in. * **VPCId** *(string) --* (Private hosted zones only) The ID of an Amazon VPC. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* Empty response for the request. **Exceptions** * "Route53.Client.exceptions.ConcurrentModification" * "Route53.Client.exceptions.VPCAssociationAuthorizationNotFound" * "Route53.Client.exceptions.NoSuchHostedZone" * "Route53.Client.exceptions.InvalidVPCId" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / get_account_limit get_account_limit ***************** Route53.Client.get_account_limit(**kwargs) Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account. For the default limit, see Limits in the *Amazon Route 53 Developer Guide*. To request a higher limit, open a case. Note: You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to the Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose **Service limits** in the navigation pane. See also: AWS API Documentation **Request Syntax** response = client.get_account_limit( Type='MAX_HEALTH_CHECKS_BY_OWNER'|'MAX_HOSTED_ZONES_BY_OWNER'|'MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER'|'MAX_REUSABLE_DELEGATION_SETS_BY_OWNER'|'MAX_TRAFFIC_POLICIES_BY_OWNER' ) Parameters: **Type** (*string*) -- **[REQUIRED]** The limit that you want to get. Valid values include the following: * **MAX_HEALTH_CHECKS_BY_OWNER**: The maximum number of health checks that you can create using the current account. * **MAX_HOSTED_ZONES_BY_OWNER**: The maximum number of hosted zones that you can create using the current account. * **MAX_REUSABLE_DELEGATION_SETS_BY_OWNER**: The maximum number of reusable delegation sets that you can create using the current account. * **MAX_TRAFFIC_POLICIES_BY_OWNER**: The maximum number of traffic policies that you can create using the current account. * **MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER**: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.) Return type: dict Returns: **Response Syntax** { 'Limit': { 'Type': 'MAX_HEALTH_CHECKS_BY_OWNER'|'MAX_HOSTED_ZONES_BY_OWNER'|'MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER'|'MAX_REUSABLE_DELEGATION_SETS_BY_OWNER'|'MAX_TRAFFIC_POLICIES_BY_OWNER', 'Value': 123 }, 'Count': 123 } **Response Structure** * *(dict) --* A complex type that contains the requested limit. * **Limit** *(dict) --* The current setting for the specified limit. For example, if you specified "MAX_HEALTH_CHECKS_BY_OWNER" for the value of "Type" in the request, the value of "Limit" is the maximum number of health checks that you can create using the current account. * **Type** *(string) --* The limit that you requested. Valid values include the following: * **MAX_HEALTH_CHECKS_BY_OWNER**: The maximum number of health checks that you can create using the current account. * **MAX_HOSTED_ZONES_BY_OWNER**: The maximum number of hosted zones that you can create using the current account. * **MAX_REUSABLE_DELEGATION_SETS_BY_OWNER**: The maximum number of reusable delegation sets that you can create using the current account. * **MAX_TRAFFIC_POLICIES_BY_OWNER**: The maximum number of traffic policies that you can create using the current account. * **MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER**: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.) * **Value** *(integer) --* The current value for the limit that is specified by Type. * **Count** *(integer) --* The current number of entities that you have created of the specified type. For example, if you specified "MAX_HEALTH_CHECKS_BY_OWNER" for the value of "Type" in the request, the value of "Count" is the current number of health checks that you have created using the current account. **Exceptions** * "Route53.Client.exceptions.InvalidInput" Route53 / Client / create_traffic_policy_version create_traffic_policy_version ***************************** Route53.Client.create_traffic_policy_version(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_traffic_policy_version( Id='string', Document='string', Comment='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the traffic policy for which you want to create a new version. * **Document** (*string*) -- **[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. * **Comment** (*string*) -- The comment that you specified in the "CreateTrafficPolicyVersion" request, if any. Return type: dict Returns: **Response Syntax** { 'TrafficPolicy': { 'Id': 'string', 'Version': 123, 'Name': 'string', 'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS'|'TLSA'|'SSHFP'|'SVCB'|'HTTPS', '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) --* The ID that Amazon Route 53 assigned to a traffic policy when you created it. * **Version** *(integer) --* The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of "Version" is always 1. * **Name** *(string) --* The name that you specified when you created the traffic policy. * **Type** *(string) --* The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance. * **Document** *(string) --* The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the "CreateTrafficPolicy" request. For more information about the JSON format, see Traffic Policy Document Format. * **Comment** *(string) --* The comment that you specify in the "CreateTrafficPolicy" request, if any. * **Location** *(string) --* A unique URL that represents a new traffic policy version. **Exceptions** * "Route53.Client.exceptions.NoSuchTrafficPolicy" * "Route53.Client.exceptions.InvalidInput" * "Route53.Client.exceptions.TooManyTrafficPolicyVersionsForCurren tPolicy" * "Route53.Client.exceptions.ConcurrentModification" * "Route53.Client.exceptions.InvalidTrafficPolicyDocument" Route53 / Client / create_traffic_policy_instance create_traffic_policy_instance ****************************** Route53.Client.create_traffic_policy_instance(**kwargs) 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. Note: After you submit an "CreateTrafficPolicyInstance" request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. Use "GetTrafficPolicyInstance" with the "id" of new traffic policy instance to confirm that the "CreateTrafficPolicyInstance" request completed successfully. For more information, see the "State" response element. See also: AWS API Documentation **Request Syntax** response = client.create_traffic_policy_instance( HostedZoneId='string', Name='string', TTL=123, TrafficPolicyId='string', TrafficPolicyVersion=123 ) Parameters: * **HostedZoneId** (*string*) -- **[REQUIRED]** The ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy. * **Name** (*string*) -- **[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 Route 53 creates for this traffic policy instance. * **TTL** (*integer*) -- **[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. * **TrafficPolicyId** (*string*) -- **[REQUIRED]** The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone. * **TrafficPolicyVersion** (*integer*) -- **[REQUIRED]** The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone. Return type: 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'|'CAA'|'DS'|'TLSA'|'SSHFP'|'SVCB'|'HTTPS' }, '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) --* The ID that Amazon Route 53 assigned to the new traffic policy instance. * **HostedZoneId** *(string) --* The ID of the hosted zone that Amazon Route 53 created resource record sets in. * **Name** *(string) --* The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance. * **TTL** *(integer) --* The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone. * **State** *(string) --* The value of "State" is one of the following values: Applied Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations. Creating Route 53 is creating the resource record sets. Use "GetTrafficPolicyInstance" to confirm that the "CreateTrafficPolicyInstance" request completed successfully. Failed Route 53 wasn't able to create or update the resource record sets. When the value of "State" is "Failed", see "Message" for an explanation of what caused the request to fail. * **Message** *(string) --* If "State" is "Failed", an explanation of the reason for the failure. If "State" is another value, "Message" is empty. * **TrafficPolicyId** *(string) --* The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone. * **TrafficPolicyVersion** *(integer) --* The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone. * **TrafficPolicyType** *(string) --* The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance. * **Location** *(string) --* A unique URL that represents a new traffic policy instance. **Exceptions** * "Route53.Client.exceptions.NoSuchHostedZone" * "Route53.Client.exceptions.InvalidInput" * "Route53.Client.exceptions.TooManyTrafficPolicyInstances" * "Route53.Client.exceptions.NoSuchTrafficPolicy" * "Route53.Client.exceptions.TrafficPolicyInstanceAlreadyExists" Route53 / Client / get_traffic_policy_instance get_traffic_policy_instance *************************** Route53.Client.get_traffic_policy_instance(**kwargs) Gets information about a specified traffic policy instance. Note: Use "GetTrafficPolicyInstance" with the "id" of new traffic policy instance to confirm that the "CreateTrafficPolicyInstance" or an "UpdateTrafficPolicyInstance" request completed successfully. For more information, see the "State" response element. Note: In the Route 53 console, traffic policy instances are known as policy records. See also: AWS API Documentation **Request Syntax** response = client.get_traffic_policy_instance( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The ID of the traffic policy instance that you want to get information about. Return type: 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'|'CAA'|'DS'|'TLSA'|'SSHFP'|'SVCB'|'HTTPS' } } **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) --* The ID that Amazon Route 53 assigned to the new traffic policy instance. * **HostedZoneId** *(string) --* The ID of the hosted zone that Amazon Route 53 created resource record sets in. * **Name** *(string) --* The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance. * **TTL** *(integer) --* The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone. * **State** *(string) --* The value of "State" is one of the following values: Applied Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations. Creating Route 53 is creating the resource record sets. Use "GetTrafficPolicyInstance" to confirm that the "CreateTrafficPolicyInstance" request completed successfully. Failed Route 53 wasn't able to create or update the resource record sets. When the value of "State" is "Failed", see "Message" for an explanation of what caused the request to fail. * **Message** *(string) --* If "State" is "Failed", an explanation of the reason for the failure. If "State" is another value, "Message" is empty. * **TrafficPolicyId** *(string) --* The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone. * **TrafficPolicyVersion** *(integer) --* The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone. * **TrafficPolicyType** *(string) --* The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance. **Exceptions** * "Route53.Client.exceptions.NoSuchTrafficPolicyInstance" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / get_health_check_status get_health_check_status *********************** Route53.Client.get_health_check_status(**kwargs) Gets status of a specified health check. Warning: This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses. See also: AWS API Documentation **Request Syntax** response = client.get_health_check_status( HealthCheckId='string' ) Parameters: **HealthCheckId** (*string*) -- **[REQUIRED]** The ID for the health check that you want the current status for. When you created the health check, "CreateHealthCheck" returned the ID in the response, in the "HealthCheckId" element. Note: If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use "GetHealthCheckStatus" to get the status of a calculated health check. Return type: dict Returns: **Response Syntax** { 'HealthCheckObservations': [ { 'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1', 'IPAddress': 'string', 'StatusReport': { 'Status': 'string', 'CheckedTime': datetime(2015, 1, 1) } }, ] } **Response Structure** * *(dict) --* A complex type that contains the response to a "GetHealthCheck" request. * **HealthCheckObservations** *(list) --* A list that contains one "HealthCheckObservation" element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint. * *(dict) --* A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker. * **Region** *(string) --* The region of the Amazon Route 53 health checker that provided the status in "StatusReport". * **IPAddress** *(string) --* The IP address of the Amazon Route 53 health checker that provided the failure reason in "StatusReport". * **StatusReport** *(dict) --* A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker and the time of the failed health check. * **Status** *(string) --* A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers. * **CheckedTime** *(datetime) --* The date and time that the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value "2017-03-27T17:48:16.751Z" represents March 27, 2017 at 17:48:16.751 UTC. **Exceptions** * "Route53.Client.exceptions.NoSuchHealthCheck" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / list_resource_record_sets list_resource_record_sets ************************* Route53.Client.list_resource_record_sets(**kwargs) Lists the resource record sets in a specified hosted zone. "ListResourceRecordSets" returns up to 300 resource record sets at a time in ASCII order, beginning at a position specified by the "name" and "type" elements. **Sort order** "ListResourceRecordSets" sorts results first by DNS name with the labels reversed, for example: "com.example.www." Note the trailing dot, which can change the sort order when the record name contains characters that appear before "." (decimal 46) in the ASCII table. These characters include the following: "! " # $ % & ' ( ) * + , -" When multiple records have the same DNS name, "ListResourceRecordSets" sorts results by the record type. **Specifying where to start listing records** You can use the name and type elements to specify the resource record set that the list begins with: If you do not specify Name or Type The results begin with the first resource record set that the hosted zone contains. If you specify Name but not Type The results begin with the first resource record set in the list whose name is greater than or equal to "Name". If you specify Type but not Name Amazon Route 53 returns the "InvalidInput" error. If you specify both Name and Type The results begin with the first resource record set in the list whose name is greater than or equal to "Name", and whose type is greater than or equal to "Type". Note: Type is only used to sort between records with the same record Name. **Resource record sets that are PENDING** This action returns the most current version of the records. This includes records that are "PENDING", and that are not yet available on all Route 53 DNS servers. **Changing resource record sets** To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a "ChangeResourceRecordSets" request while you're paging through the results of a "ListResourceRecordSets" request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes. **Displaying the next page of results** If a "ListResourceRecordSets" command returns more than one page of results, the value of "IsTruncated" is "true". To display the next page of results, get the values of "NextRecordName", "NextRecordType", and "NextRecordIdentifier" (if any) from the response. Then submit another "ListResourceRecordSets" request, and specify those values for "StartRecordName", "StartRecordType", and "StartRecordIdentifier". See also: AWS API Documentation **Request Syntax** response = client.list_resource_record_sets( HostedZoneId='string', StartRecordName='string', StartRecordType='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS'|'TLSA'|'SSHFP'|'SVCB'|'HTTPS', StartRecordIdentifier='string', MaxItems='string' ) Parameters: * **HostedZoneId** (*string*) -- **[REQUIRED]** The ID of the hosted zone that contains the resource record sets that you want to list. * **StartRecordName** (*string*) -- The first name in the lexicographic ordering of resource record sets that you want to list. If the specified record name doesn't exist, the results begin with the first resource record set that has a name greater than the value of "name". * **StartRecordType** (*string*) -- The type of resource record set to begin the record listing from. Valid values for basic resource record sets: "A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NAPTR" | "NS" | "PTR" | "SOA" | "SPF" | "SRV" | "TXT" Values for weighted, latency, geolocation, and failover resource record sets: "A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NAPTR" | "PTR" | "SPF" | "SRV" | "TXT" Values for alias resource record sets: * **API Gateway custom regional API or edge-optimized API**: A * **CloudFront distribution**: A or AAAA * **Elastic Beanstalk environment that has a regionalized subdomain**: A * **Elastic Load Balancing load balancer**: A | AAAA * **S3 bucket**: A * **VPC interface VPC endpoint**: A * **Another resource record set in this hosted zone:** The type of the resource record set that the alias references. Constraint: Specifying "type" without specifying "name" returns an "InvalidInput" error. * **StartRecordIdentifier** (*string*) -- *Resource record sets that have a routing policy other than simple:* If results were truncated for a given DNS name and type, specify the value of "NextRecordIdentifier" from the previous response to get the next resource record set that has the current DNS name and type. * **MaxItems** (*string*) -- (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. Return type: dict Returns: **Response Syntax** { 'ResourceRecordSets': [ { 'Name': 'string', 'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS'|'TLSA'|'SSHFP'|'SVCB'|'HTTPS', 'SetIdentifier': 'string', 'Weight': 123, 'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-central-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-north-1'|'cn-northwest-1'|'ap-east-1'|'me-south-1'|'me-central-1'|'ap-south-1'|'ap-south-2'|'af-south-1'|'eu-south-1'|'eu-south-2'|'ap-southeast-4'|'il-central-1'|'ca-west-1'|'ap-southeast-5'|'mx-central-1'|'ap-southeast-7'|'us-gov-east-1'|'us-gov-west-1'|'ap-east-2', 'GeoLocation': { 'ContinentCode': 'string', 'CountryCode': 'string', 'SubdivisionCode': 'string' }, 'Failover': 'PRIMARY'|'SECONDARY', 'MultiValueAnswer': True|False, 'TTL': 123, 'ResourceRecords': [ { 'Value': 'string' }, ], 'AliasTarget': { 'HostedZoneId': 'string', 'DNSName': 'string', 'EvaluateTargetHealth': True|False }, 'HealthCheckId': 'string', 'TrafficPolicyInstanceId': 'string', 'CidrRoutingConfig': { 'CollectionId': 'string', 'LocationName': 'string' }, 'GeoProximityLocation': { 'AWSRegion': 'string', 'LocalZoneGroup': 'string', 'Coordinates': { 'Latitude': 'string', 'Longitude': 'string' }, 'Bias': 123 } }, ], 'IsTruncated': True|False, 'NextRecordName': 'string', 'NextRecordType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS'|'TLSA'|'SSHFP'|'SVCB'|'HTTPS', 'NextRecordIdentifier': 'string', 'MaxItems': 'string' } **Response Structure** * *(dict) --* A complex type that contains list information for the resource record set. * **ResourceRecordSets** *(list) --* Information about multiple resource record sets. * *(dict) --* Information about the resource record set to create or delete. * **Name** *(string) --* For "ChangeResourceRecordSets" requests, the name of the record that you want to create, update, or delete. For "ListResourceRecordSets" responses, the name of a record in the specified hosted zone. **ChangeResourceRecordSets Only** Enter a fully qualified domain name, for example, "www.example.com". You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats "www.example.com" (without a trailing dot) and "www.example.com." (with a trailing dot) as identical. For information about how to specify characters other than "a-z", "0-9", and "-" (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the *Amazon Route 53 Developer Guide*. You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, "*.example.com". Note the following: * The * must replace the entire label. For example, you can't specify "*prod.example.com" or "prod*.example.com". * The * can't replace any of the middle labels, for example, marketing.*.example.com. * If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard. Warning: You can't use the * wildcard for resource records sets that have a type of NS. * **Type** *(string) --* The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the *Amazon Route 53 Developer Guide*. Valid values for basic resource record sets: "A" | "AAAA" | "CAA" | "CNAME" | "DS" | "MX" | "NAPTR" | "NS" | "PTR" | "SOA" | "SPF" | "SRV" | "TXT``| ``TLSA``| ``SSHFP``| ``SVCB``| ``HTTPS" Values for weighted, latency, geolocation, and failover resource record sets: "A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NAPTR" | "PTR" | "SPF" | "SRV" | "TXT``| ``TLSA``| ``SSHFP``| ``SVCB``| ``HTTPS". When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group. Valid values for multivalue answer resource record sets: "A" | "AAAA" | "MX" | "NAPTR" | "PTR" | "SPF" | "SRV" | "TXT``| ``CAA``| ``TLSA``| ``SSHFP``| ``SVCB``| ``HTTPS" Note: SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of "Type" is "SPF". RFC 7208, *Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1*, has been updated to say, "...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type. Values for alias resource record sets: * **Amazon API Gateway custom regional APIs and edge- optimized APIs:** "A" * **CloudFront distributions:** "A" If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of "A" and one with a value of "AAAA". * **Amazon API Gateway environment that has a regionalized subdomain**: "A" * **ELB load balancers:** "A" | "AAAA" * **Amazon S3 buckets:** "A" * **Amazon Virtual Private Cloud interface VPC endpoints** "A" * **Another resource record set in this hosted zone:** Specify the type of the resource record set that you're creating the alias for. All values are supported except "NS" and "SOA". Note: If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of "Type" is "CNAME". This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record. * **SetIdentifier** *(string) --* *Resource record sets that have a routing policy other than simple:* An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of "SetIdentifier" must be unique for each resource record set. For information about routing policies, see Choosing a Routing Policy in the *Amazon Route 53 Developer Guide*. * **Weight** *(integer) --* *Weighted resource record sets only:* Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following: * You must specify a value for the "Weight" element for every weighted resource record set. * You can only specify one "ResourceRecord" per weighted resource record set. * You can't create latency, failover, or geolocation resource record sets that have the same values for the "Name" and "Type" elements as weighted resource record sets. * You can create a maximum of 100 weighted resource record sets that have the same values for the "Name" and "Type" elements. * For weighted (but not weighted alias) resource record sets, if you set "Weight" to "0" for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set "Weight" to "0" for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability. The effect of setting "Weight" to "0" is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the *Amazon Route 53 Developer Guide*. * **Region** *(string) --* *Latency-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type. When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set. Note the following: * You can only specify one "ResourceRecord" per latency resource record set. * You can only create one latency resource record set for each Amazon EC2 Region. * You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for. * You can't create non-latency resource record sets that have the same values for the "Name" and "Type" elements as latency resource record sets. * **GeoLocation** *(dict) --* *Geolocation resource record sets only:* A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of "192.0.2.111", create a resource record set with a "Type" of "A" and a "ContinentCode" of "AF". If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource. You can't create two geolocation resource record sets that specify the same geographic location. The value "*" in the "CountryCode" element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the "Name" and "Type" elements. Warning: Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of "CountryCode" is "*". Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a "*" resource record set, Route 53 returns a "no answer" response for queries from those locations. You can't create non-geolocation resource record sets that have the same values for the "Name" and "Type" elements as geolocation resource record sets. * **ContinentCode** *(string) --* The two-letter code for the continent. Amazon Route 53 supports the following continent codes: * **AF**: Africa * **AN**: Antarctica * **AS**: Asia * **EU**: Europe * **OC**: Oceania * **NA**: North America * **SA**: South America Constraint: Specifying "ContinentCode" with either "CountryCode" or "SubdivisionCode" returns an "InvalidInput" error. * **CountryCode** *(string) --* For geolocation resource record sets, the two-letter code for a country. Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2. Route 53 also supports the country code **UA** for Ukraine. * **SubdivisionCode** *(string) --* For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for "SubdivisionCode". For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. If you specify "subdivisioncode", you must also specify "US" for "CountryCode". * **Failover** *(string) --* *Failover resource record sets only:* To configure failover, you add the "Failover" element to two resource record sets. For one resource record set, you specify "PRIMARY" as the value for "Failover"; for the other resource record set, you specify "SECONDARY". In addition, you include the "HealthCheckId" element and specify the health check that you want Amazon Route 53 to perform for each resource record set. Except where noted, the following failover behaviors assume that you have included the "HealthCheckId" element in both resource record sets: * When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set. * When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set. * When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set. * If you omit the "HealthCheckId" element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint. You can't create non-failover resource record sets that have the same values for the "Name" and "Type" elements as failover resource record sets. For failover alias resource record sets, you must also include the "EvaluateTargetHealth" element and set the value to true. For more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide*: * Route 53 Health Checks and DNS Failover * Configuring Failover in a Private Hosted Zone * **MultiValueAnswer** *(boolean) --* *Multivalue answer resource record sets only*: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify "true" for "MultiValueAnswer". Note the following: * If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy. * If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy. * Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records. * If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records. * When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records. * If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response. You can't create multivalue answer alias records. * **TTL** *(integer) --* The resource record cache time to live (TTL), in seconds. Note the following: * If you're creating or updating an alias resource record set, omit "TTL". Amazon Route 53 uses the value of "TTL" for the alias target. * If you're associating this resource record set with a health check (if you're adding a "HealthCheckId" element), we recommend that you specify a "TTL" of 60 seconds or less so clients respond quickly to changes in health status. * All of the resource record sets in a group of weighted resource record sets must have the same value for "TTL". * If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a "TTL" of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for "Weight". * **ResourceRecords** *(list) --* Information about the resource records to act upon. Note: If you're creating an alias resource record set, omit "ResourceRecords". * *(dict) --* Information specific to the resource record. Note: If you're creating an alias resource record set, omit "ResourceRecord". * **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". Note: If you're creating an alias resource record set, omit "Value". * **AliasTarget** *(dict) --* *Alias resource record sets only:* Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. If you're creating resource records sets for a private hosted zone, note the following: * You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution. * For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the *Amazon Route 53 Developer Guide*. * **HostedZoneId** *(string) --* *Alias resource records sets only*: The value used depends on where you want to route traffic: Amazon API Gateway custom regional APIs and edge- optimized APIs Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain- names: * For regional APIs, specify the value of "regionalHostedZoneId". * For edge-optimized APIs, specify the value of "distributionHostedZoneId". Amazon Virtual Private Cloud interface VPC endpoint Specify the hosted zone ID for your interface endpoint. You can get the value of "HostedZoneId" using the CLI command describe-vpc-endpoints. CloudFront distribution Specify "Z2FDTNDATAQYW2". Note: Alias resource record sets for CloudFront can't be created in a private zone.Elastic Beanstalk environment Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the *Amazon Web Services General Reference*. ELB load balancer Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID: * Elastic Load Balancing endpoints and quotas topic in the *Amazon Web Services General Reference*: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers. * **Amazon Web Services Management Console**: Go to the Amazon EC2 page, choose **Load Balancers** in the navigation pane, select the load balancer, and get the value of the **Hosted zone** field on the **Description** tab. * **Elastic Load Balancing API**: Use "DescribeLoadBalancers" to get the applicable value. For more information, see the applicable guide: * Classic Load Balancers: Use DescribeLoadBalancers to get the value of "CanonicalHostedZoneNameId". * Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of "CanonicalHostedZoneId". * **CLI**: Use "describe-load-balancers" to get the applicable value. For more information, see the applicable guide: * Classic Load Balancers: Use describe-load- balancers to get the value of "CanonicalHostedZoneNameId". * Application and Network Load Balancers: Use describe-load-balancers to get the value of "CanonicalHostedZoneId". Global Accelerator accelerator Specify "Z2BJ6XQ5FK7U4H". An Amazon S3 bucket configured as a static website Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the *Amazon Web Services General Reference*. Another Route 53 resource record set in your hosted zone Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.) * **DNSName** *(string) --* *Alias resource record sets only:* The value that you specify depends on where you want to route queries: Amazon API Gateway custom regional APIs and edge- optimized APIs Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names: * For regional APIs, specify the value of "regionalDomainName". * For edge-optimized APIs, specify the value of "distributionDomainName". This is the name of the associated CloudFront distribution, such as "da1b2c3d4e5.cloudfront.net". Note: The name of the record that you're creating must match a custom domain name for your API, such as "api.example.com".Amazon Virtual Private Cloud interface VPC endpoint Enter the API endpoint for the interface endpoint, such as "vpce-123456789abcdef01-example-us-east- 1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com". For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of "DnsName" using the CLI command describe- vpc-endpoints. CloudFront distribution Specify the domain name that CloudFront assigned when you created your distribution. Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is *acme.example.com*, your CloudFront distribution must include *acme.example.com* as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the *Amazon CloudFront Developer Guide*. You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution. Note: For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.Elastic Beanstalk environment If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name "my-environment.us- west-2.elasticbeanstalk.com" is a regionalized domain name. Warning: For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment. For Elastic Beanstalk environments that have regionalized subdomains, specify the "CNAME" attribute for the environment. You can use the following methods to get the value of the CNAME attribute: * *Amazon Web Services Management Console*: For information about how to get the value by using the console, see Using Custom Domains with Elastic Beanstalk in the *Elastic Beanstalk Developer Guide*. * *Elastic Beanstalk API*: Use the "DescribeEnvironments" action to get the value of the "CNAME" attribute. For more information, see DescribeEnvironments in the *Elastic Beanstalk API Reference*. * *CLI*: Use the "describe-environments" command to get the value of the "CNAME" attribute. For more information, see describe-environments in the *CLI Command Reference*. ELB load balancer Specify the DNS name that is associated with the load balancer. Get the DNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI. * **Amazon Web Services Management Console**: Go to the EC2 page, choose **Load Balancers** in the navigation pane, choose the load balancer, choose the **Description** tab, and get the value of the **DNS name** field. If you're routing traffic to a Classic Load Balancer, get the value that begins with **dualstack**. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA. * **Elastic Load Balancing API**: Use "DescribeLoadBalancers" to get the value of "DNSName". For more information, see the applicable guide: * Classic Load Balancers: DescribeLoadBalancers * Application and Network Load Balancers: DescribeLoadBalancers * **CLI**: Use "describe-load-balancers" to get the value of "DNSName". For more information, see the applicable guide: * Classic Load Balancers: describe-load-balancers * Application and Network Load Balancers: describe- load-balancers Global Accelerator accelerator Specify the DNS name for your accelerator: * **Global Accelerator API:** To get the DNS name, use DescribeAccelerator. * **CLI:** To get the DNS name, use describe- accelerator. Amazon S3 bucket that is configured as a static website Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, "s3-website.us-east-2.amazonaws.com". For more information about valid values, see the table Amazon S3 Website Endpoints in the *Amazon Web Services General Reference*. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the *Amazon Route 53 Developer Guide.* Another Route 53 resource record set Specify the value of the "Name" element for a resource record set in the current hosted zone. Note: If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of "Type" is "CNAME". This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record. * **EvaluateTargetHealth** *(boolean) --* *Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:* When "EvaluateTargetHealth" is "true", an alias resource record set inherits the health of the referenced Amazon Web Services resource, such as an ELB load balancer or another resource record set in the hosted zone. Note the following: CloudFront distributions You can't set "EvaluateTargetHealth" to "true" when the alias target is a CloudFront distribution. Elastic Beanstalk environments that have regionalized subdomains If you specify an Elastic Beanstalk environment in "DNSName" and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set "EvaluateTargetHealth" to "true" and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any. If the environment contains a single Amazon EC2 instance, there are no special requirements. ELB load balancers Health checking behavior depends on the type of load balancer: * **Classic Load Balancers**: If you specify an ELB Classic Load Balancer in "DNSName", Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set "EvaluateTargetHealth" to "true" and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources. * **Application and Network Load Balancers**: If you specify an ELB Application or Network Load Balancer and you set "EvaluateTargetHealth" to "true", Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer: * For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources. * A target group that has no registered targets is considered unhealthy. Note: When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.S3 buckets There are no special requirements for setting "EvaluateTargetHealth" to "true" when the alias target is an S3 bucket. Other records in the same hosted zone If the Amazon Web Services resource that you specify in "DNSName" is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the *Amazon Route 53 Developer Guide*. For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the *Amazon Route 53 Developer Guide*. * **HealthCheckId** *(string) --* If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the "HealthCheckId" element and specify the ID of the applicable health check. Route 53 determines whether a resource record set is healthy based on one of the following: * By periodically sending a request to the endpoint that is specified in the health check * By aggregating the status of a specified group of health checks (calculated health checks) * By determining the current state of a CloudWatch alarm (CloudWatch metric health checks) Warning: Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the "Value" element. When you add a "HealthCheckId" element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check. For more information, see the following topics in the *Amazon Route 53 Developer Guide*: * How Amazon Route 53 Determines Whether an Endpoint Is Healthy * Route 53 Health Checks and DNS Failover * Configuring Failover in a Private Hosted Zone **When to Specify HealthCheckId** Specifying a value for "HealthCheckId" is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations: * **Non-alias resource record sets**: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets. If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with. If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set. If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly. * **Alias resource record sets**: You specify the following settings: * You set "EvaluateTargetHealth" to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A). * You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone. * You specify a health check ID for the non-alias resource record set. If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with. If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set. Note: The alias resource record set can also route traffic to a *group* of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets. **Geolocation Routing** For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has "*" for "CountryCode" is "*", which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy: * The United States * North America * The default resource record set **Specifying the Health Check Endpoint by Domain Name** If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each "HTTP" server that is serving content for "www.example.com". For the value of "FullyQualifiedDomainName", specify the domain name of the server (such as "us-east-2-www.example.com"), not the name of the resource record sets ( "www.example.com"). Warning: Health check results will be unpredictable if you do the following: * Create a health check that has the same value for "FullyQualifiedDomainName" as the name of a resource record set. * Associate that health check with the resource record set. * **TrafficPolicyInstanceId** *(string) --* When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. "TrafficPolicyInstanceId" is the ID of the traffic policy instance that Route 53 created this resource record set for. Warning: To delete the resource record set that is associated with a traffic policy instance, use "DeleteTrafficPolicyInstance". Route 53 will delete the resource record set automatically. If you delete the resource record set by using "ChangeResourceRecordSets", Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use. * **CidrRoutingConfig** *(dict) --* The object that is specified in resource record set object when you are linking a resource record set to a CIDR location. A "LocationName" with an asterisk “*” can be used to create a default CIDR record. "CollectionId" is still required for default record. * **CollectionId** *(string) --* The CIDR collection ID. * **LocationName** *(string) --* The CIDR collection location name. * **GeoProximityLocation** *(dict) --* *GeoproximityLocation resource record sets only:* A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources. * **AWSRegion** *(string) --* The Amazon Web Services Region the resource you are directing DNS traffic to, is in. * **LocalZoneGroup** *(string) --* Specifies an Amazon Web Services Local Zone Group. A local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is "us-east-1-bue-1a" the Local Zone Group is "us-east-1-bue-1". You can identify the Local Zones Group for a specific Local Zone by using the describe-availability-zones CLI command: This command returns: ""GroupName": "us- west-2-den-1"", specifying that the Local Zone "us- west-2-den-1a" belongs to the Local Zone Group "us- west-2-den-1". * **Coordinates** *(dict) --* Contains the longitude and latitude for a geographic region. * **Latitude** *(string) --* Specifies a coordinate of the north–south position of a geographic point on the surface of the Earth (-90 - 90). * **Longitude** *(string) --* Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth (-180 - 180). * **Bias** *(integer) --* The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource. To use "Bias" to change the size of the geographic region, specify the applicable value for the bias: * To expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions. * To shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions. * **IsTruncated** *(boolean) --* A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the "NextRecordName" element. * **NextRecordName** *(string) --* If the results were truncated, the name of the next record in the list. This element is present only if "IsTruncated" is true. * **NextRecordType** *(string) --* If the results were truncated, the type of the next record in the list. This element is present only if "IsTruncated" is true. * **NextRecordIdentifier** *(string) --* *Resource record sets that have a routing policy other than simple:* If results were truncated for a given DNS name and type, the value of "SetIdentifier" for the next resource record set that has the current DNS name and type. For information about routing policies, see Choosing a Routing Policy in the *Amazon Route 53 Developer Guide*. * **MaxItems** *(string) --* The maximum number of records you requested. **Exceptions** * "Route53.Client.exceptions.NoSuchHostedZone" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / test_dns_answer test_dns_answer *************** Route53.Client.test_dns_answer(**kwargs) Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask. This call only supports querying public hosted zones. Note: The "TestDnsAnswer" returns information similar to what you would expect from the answer section of the "dig" command. Therefore, if you query for the name servers of a subdomain that point to the parent name servers, those will not be returned. See also: AWS API Documentation **Request Syntax** response = client.test_dns_answer( HostedZoneId='string', RecordName='string', RecordType='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS'|'TLSA'|'SSHFP'|'SVCB'|'HTTPS', ResolverIP='string', EDNS0ClientSubnetIP='string', EDNS0ClientSubnetMask='string' ) Parameters: * **HostedZoneId** (*string*) -- **[REQUIRED]** The ID of the hosted zone that you want Amazon Route 53 to simulate a query for. * **RecordName** (*string*) -- **[REQUIRED]** The name of the resource record set that you want Amazon Route 53 to simulate a query for. * **RecordType** (*string*) -- **[REQUIRED]** The type of the resource record set. * **ResolverIP** (*string*) -- If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value, "TestDnsAnswer" uses the IP address of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region ( "us-east-1"). * **EDNS0ClientSubnetIP** (*string*) -- If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client in the applicable location, for example, "192.0.2.44" or "2001:db8:85a3::8a2e:370:7334". * **EDNS0ClientSubnetMask** (*string*) -- If you specify an IP address for "edns0clientsubnetip", you can optionally specify the number of bits of the IP address that you want the checking tool to include in the DNS query. For example, if you specify "192.0.2.44" for "edns0clientsubnetip" and "24" for "edns0clientsubnetmask", the checking tool will simulate a request from 192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses. The range of valid values depends on whether "edns0clientsubnetip" is an IPv4 or an IPv6 address: * **IPv4**: Specify a value between 0 and 32 * **IPv6**: Specify a value between 0 and 128 Return type: dict Returns: **Response Syntax** { 'Nameserver': 'string', 'RecordName': 'string', 'RecordType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS'|'TLSA'|'SSHFP'|'SVCB'|'HTTPS', '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 Amazon Web Services resources other than another resource record set, the "RecordDataEntry" element contains an IP address or a domain name for the Amazon Web Services 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". **Exceptions** * "Route53.Client.exceptions.NoSuchHostedZone" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / can_paginate can_paginate ************ Route53.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. Route53 / Client / get_reusable_delegation_set get_reusable_delegation_set *************************** Route53.Client.get_reusable_delegation_set(**kwargs) Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set. See also: AWS API Documentation **Request Syntax** response = client.get_reusable_delegation_set( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The ID of the reusable delegation set that you want to get a list of name servers for. Return type: dict Returns: **Response Syntax** { 'DelegationSet': { 'Id': 'string', 'CallerReference': 'string', 'NameServers': [ 'string', ] } } **Response Structure** * *(dict) --* A complex type that contains the response to the "GetReusableDelegationSet" request. * **DelegationSet** *(dict) --* A complex type that contains information about the reusable delegation set. * **Id** *(string) --* The ID that Amazon Route 53 assigns to a reusable delegation set. * **CallerReference** *(string) --* The value that you specified for "CallerReference" when you created the reusable delegation set. * **NameServers** *(list) --* A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set. * *(string) --* **Exceptions** * "Route53.Client.exceptions.NoSuchDelegationSet" * "Route53.Client.exceptions.DelegationSetNotReusable" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / delete_cidr_collection delete_cidr_collection ********************** Route53.Client.delete_cidr_collection(**kwargs) Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted. See also: AWS API Documentation **Request Syntax** response = client.delete_cidr_collection( Id='string' ) Parameters: **Id** (*string*) -- **[REQUIRED]** The UUID of the collection to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Route53.Client.exceptions.NoSuchCidrCollectionException" * "Route53.Client.exceptions.CidrCollectionInUseException" * "Route53.Client.exceptions.InvalidInput" * "Route53.Client.exceptions.ConcurrentModification" Route53 / Client / create_reusable_delegation_set create_reusable_delegation_set ****************************** Route53.Client.create_reusable_delegation_set(**kwargs) Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account. You can also create a reusable delegation set that uses the four name servers that are associated with an existing hosted zone. Specify the hosted zone ID in the "CreateReusableDelegationSet" request. Note: You can't associate a reusable delegation set with a private hosted zone. For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers. The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps: * Create a reusable delegation set. * Recreate hosted zones, and reduce the TTL to 60 seconds or less. * Recreate resource record sets in the new hosted zones. * Change the registrar's name servers to use the name servers for the new hosted zones. * Monitor traffic for the website or application. * Change TTLs back to their original values. If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following: * For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones. * For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set. * For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set. See also: AWS API Documentation **Request Syntax** response = client.create_reusable_delegation_set( CallerReference='string', HostedZoneId='string' ) Parameters: * **CallerReference** (*string*) -- **[REQUIRED]** A unique string that identifies the request, and that allows you to retry failed "CreateReusableDelegationSet" requests without the risk of executing the operation twice. You must use a unique "CallerReference" string every time you submit a "CreateReusableDelegationSet" request. "CallerReference" can be any unique string, for example a date/time stamp. * **HostedZoneId** (*string*) -- If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone. Return type: dict Returns: **Response Syntax** { 'DelegationSet': { 'Id': 'string', 'CallerReference': 'string', 'NameServers': [ 'string', ] }, 'Location': 'string' } **Response Structure** * *(dict) --* * **DelegationSet** *(dict) --* A complex type that contains name server information. * **Id** *(string) --* The ID that Amazon Route 53 assigns to a reusable delegation set. * **CallerReference** *(string) --* The value that you specified for "CallerReference" when you created the reusable delegation set. * **NameServers** *(list) --* A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set. * *(string) --* * **Location** *(string) --* The unique URL representing the new reusable delegation set. **Exceptions** * "Route53.Client.exceptions.DelegationSetAlreadyCreated" * "Route53.Client.exceptions.LimitsExceeded" * "Route53.Client.exceptions.HostedZoneNotFound" * "Route53.Client.exceptions.InvalidArgument" * "Route53.Client.exceptions.InvalidInput" * "Route53.Client.exceptions.DelegationSetNotAvailable" * "Route53.Client.exceptions.DelegationSetAlreadyReusable" Route53 / Client / get_geo_location get_geo_location **************** Route53.Client.get_geo_location(**kwargs) Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets. Route 53 does not perform authorization for this API because it retrieves information that is already available to the public. Use the following syntax to determine whether a continent is supported for geolocation: "GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent" Use the following syntax to determine whether a country is supported for geolocation: "GET /2013-04-01/geolocation?countrycode=two-character country code" Use the following syntax to determine whether a subdivision of a country is supported for geolocation: "GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code" See also: AWS API Documentation **Request Syntax** response = client.get_geo_location( ContinentCode='string', CountryCode='string', SubdivisionCode='string' ) Parameters: * **ContinentCode** (*string*) -- For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Amazon Route 53 supports the following continent codes: * **AF**: Africa * **AN**: Antarctica * **AS**: Asia * **EU**: Europe * **OC**: Oceania * **NA**: North America * **SA**: South America * **CountryCode** (*string*) -- Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2. Route 53 also supports the country code **UA** for Ukraine. * **SubdivisionCode** (*string*) -- The code for the subdivision, such as a particular state within the United States. For a list of US state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. For a list of all supported subdivision codes, use the ListGeoLocations API. Return type: dict Returns: **Response Syntax** { 'GeoLocationDetails': { 'ContinentCode': 'string', 'ContinentName': 'string', 'CountryCode': 'string', 'CountryName': 'string', 'SubdivisionCode': 'string', 'SubdivisionName': 'string' } } **Response Structure** * *(dict) --* A complex type that contains the response information for the specified geolocation code. * **GeoLocationDetails** *(dict) --* A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code. * **ContinentCode** *(string) --* The two-letter code for the continent. * **ContinentName** *(string) --* The full name of the continent. * **CountryCode** *(string) --* The two-letter code for the country. * **CountryName** *(string) --* The name of the country. * **SubdivisionCode** *(string) --* The code for the subdivision, such as a particular state within the United States. For a list of US state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. For a list of all supported subdivision codes, use the ListGeoLocations API. * **SubdivisionName** *(string) --* The full name of the subdivision. Route 53 currently supports only states in the United States. **Exceptions** * "Route53.Client.exceptions.NoSuchGeoLocation" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / create_key_signing_key create_key_signing_key ********************** Route53.Client.create_key_signing_key(**kwargs) Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone. See also: AWS API Documentation **Request Syntax** response = client.create_key_signing_key( CallerReference='string', HostedZoneId='string', KeyManagementServiceArn='string', Name='string', Status='string' ) Parameters: * **CallerReference** (*string*) -- **[REQUIRED]** A unique string that identifies the request. * **HostedZoneId** (*string*) -- **[REQUIRED]** The unique string (ID) used to identify a hosted zone. * **KeyManagementServiceArn** (*string*) -- **[REQUIRED]** The Amazon resource name (ARN) for a customer managed key in Key Management Service (KMS). The "KeyManagementServiceArn" must be unique for each key-signing key (KSK) in a single hosted zone. To see an example of "KeyManagementServiceArn" that grants the correct permissions for DNSSEC, scroll down to **Example**. You must configure the customer managed customer managed key as follows: Status Enabled Key spec ECC_NIST_P256 Key usage Sign and verify Key policy The key policy must give permission for the following actions: * DescribeKey * GetPublicKey * Sign The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following: * ""Service": "dnssec-route53.amazonaws.com"" For more information about working with a customer managed key in KMS, see Key Management Service concepts. * **Name** (*string*) -- **[REQUIRED]** A string used to identify a key-signing key (KSK). "Name" can include numbers, letters, and underscores (_). "Name" must be unique for each key-signing key in the same hosted zone. * **Status** (*string*) -- **[REQUIRED]** A string specifying the initial status of the key-signing key (KSK). You can set the value to "ACTIVE" or "INACTIVE". Return type: dict Returns: **Response Syntax** { 'ChangeInfo': { 'Id': 'string', 'Status': 'PENDING'|'INSYNC', 'SubmittedAt': datetime(2015, 1, 1), 'Comment': 'string' }, 'KeySigningKey': { 'Name': 'string', 'KmsArn': 'string', 'Flag': 123, 'SigningAlgorithmMnemonic': 'string', 'SigningAlgorithmType': 123, 'DigestAlgorithmMnemonic': 'string', 'DigestAlgorithmType': 123, 'KeyTag': 123, 'DigestValue': 'string', 'PublicKey': 'string', 'DSRecord': 'string', 'DNSKEYRecord': 'string', 'Status': 'string', 'StatusMessage': 'string', 'CreatedDate': datetime(2015, 1, 1), 'LastModifiedDate': datetime(2015, 1, 1) }, 'Location': 'string' } **Response Structure** * *(dict) --* * **ChangeInfo** *(dict) --* A complex type that describes change information about changes made to your hosted zone. * **Id** *(string) --* This element contains an ID that you use when performing a GetChange action to get detailed information about the change. * **Status** *(string) --* The current state of the request. "PENDING" indicates that this request has not yet been applied to all Amazon Route 53 DNS servers. * **SubmittedAt** *(datetime) --* The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value "2017-03-27T17:48:16.751Z" represents March 27, 2017 at 17:48:16.751 UTC. * **Comment** *(string) --* A comment you can provide. * **KeySigningKey** *(dict) --* The key-signing key (KSK) that the request creates. * **Name** *(string) --* A string used to identify a key-signing key (KSK). "Name" can include numbers, letters, and underscores (_). "Name" must be unique for each key-signing key in the same hosted zone. * **KmsArn** *(string) --* The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The "KmsArn" must be unique for each key-signing key (KSK) in a single hosted zone. You must configure the customer managed key as follows: Status Enabled Key spec ECC_NIST_P256 Key usage Sign and verify Key policy The key policy must give permission for the following actions: * DescribeKey * GetPublicKey * Sign The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following: * ""Service": "dnssec-route53.amazonaws.com"" For more information about working with the customer managed key in KMS, see Key Management Service concepts. * **Flag** *(integer) --* An integer that specifies how the key is used. For key- signing key (KSK), this value is always 257. * **SigningAlgorithmMnemonic** *(string) --* A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1. * **SigningAlgorithmType** *(integer) --* An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1. * **DigestAlgorithmMnemonic** *(string) --* A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3. * **DigestAlgorithmType** *(integer) --* An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3. * **KeyTag** *(integer) --* An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in RFC-4034 Appendix B. * **DigestValue** *(string) --* A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers can use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system. * **PublicKey** *(string) --* The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5. * **DSRecord** *(string) --* A string that represents a delegation signer (DS) record. * **DNSKEYRecord** *(string) --* A string that represents a DNSKEY record. * **Status** *(string) --* A string that represents the current key-signing key (KSK) status. Status can have one of the following values: ACTIVE The KSK is being used for signing. INACTIVE The KSK is not being used for signing. DELETING The KSK is in the process of being deleted. ACTION_NEEDED There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed. INTERNAL_FAILURE There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK. * **StatusMessage** *(string) --* The status message provided for the following key-signing key (KSK) statuses: "ACTION_NEEDED" or "INTERNAL_FAILURE". The status message includes information about what the problem might be and steps that you can take to correct the issue. * **CreatedDate** *(datetime) --* The date when the key-signing key (KSK) was created. * **LastModifiedDate** *(datetime) --* The last time that the key-signing key (KSK) was changed. * **Location** *(string) --* The unique URL representing the new key-signing key (KSK). **Exceptions** * "Route53.Client.exceptions.NoSuchHostedZone" * "Route53.Client.exceptions.InvalidArgument" * "Route53.Client.exceptions.InvalidInput" * "Route53.Client.exceptions.InvalidKMSArn" * "Route53.Client.exceptions.InvalidKeySigningKeyStatus" * "Route53.Client.exceptions.InvalidSigningStatus" * "Route53.Client.exceptions.InvalidKeySigningKeyName" * "Route53.Client.exceptions.KeySigningKeyAlreadyExists" * "Route53.Client.exceptions.TooManyKeySigningKeys" * "Route53.Client.exceptions.ConcurrentModification" Route53 / Client / disassociate_vpc_from_hosted_zone disassociate_vpc_from_hosted_zone ********************************* Route53.Client.disassociate_vpc_from_hosted_zone(**kwargs) Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following: * You can't disassociate the last Amazon VPC from a private hosted zone. * You can't convert a private hosted zone into a public hosted zone. * You can submit a "DisassociateVPCFromHostedZone" request using either the account that created the hosted zone or the account that created the Amazon VPC. * Some services, such as Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create hosted zones and associate VPCs with the hosted zones. A service can create a hosted zone using your account or using its own account. You can disassociate a VPC from a hosted zone only if the service created the hosted zone using your account. When you run DisassociateVPCFromHostedZone, if the hosted zone has a value for "OwningAccount", you can use "DisassociateVPCFromHostedZone". If the hosted zone has a value for "OwningService", you can't use "DisassociateVPCFromHostedZone". Note: When revoking access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.The following are the supported partitions: * "aws" - Amazon Web Services Regions * "aws-cn" - China Regions * "aws-us-gov" - Amazon Web Services GovCloud (US) Region For more information, see Access Management in the *Amazon Web Services General Reference*. See also: AWS API Documentation **Request Syntax** response = client.disassociate_vpc_from_hosted_zone( HostedZoneId='string', VPC={ 'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-central-2'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-iso-west-1'|'us-isob-east-1'|'me-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-south-1'|'ap-south-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'cn-northwest-1'|'af-south-1'|'eu-south-1'|'eu-south-2'|'ap-southeast-4'|'il-central-1'|'ca-west-1'|'ap-southeast-5'|'mx-central-1'|'us-isof-south-1'|'us-isof-east-1'|'ap-southeast-7'|'ap-east-2'|'eu-isoe-west-1', 'VPCId': 'string' }, Comment='string' ) Parameters: * **HostedZoneId** (*string*) -- **[REQUIRED]** The ID of the private hosted zone that you want to disassociate a VPC from. * **VPC** (*dict*) -- **[REQUIRED]** A complex type that contains information about the VPC that you're disassociating from the specified hosted zone. * **VPCRegion** *(string) --* (Private hosted zones only) The region that an Amazon VPC was created in. * **VPCId** *(string) --* (Private hosted zones only) The ID of an Amazon VPC. * **Comment** (*string*) -- *Optional:* A comment about the disassociation request. Return type: dict Returns: **Response Syntax** { 'ChangeInfo': { 'Id': 'string', 'Status': 'PENDING'|'INSYNC', 'SubmittedAt': datetime(2015, 1, 1), 'Comment': 'string' } } **Response Structure** * *(dict) --* A complex type that contains the response information for the disassociate request. * **ChangeInfo** *(dict) --* A complex type that describes the changes made to the specified private hosted zone. * **Id** *(string) --* This element contains an ID that you use when performing a GetChange action to get detailed information about the change. * **Status** *(string) --* The current state of the request. "PENDING" indicates that this request has not yet been applied to all Amazon Route 53 DNS servers. * **SubmittedAt** *(datetime) --* The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value "2017-03-27T17:48:16.751Z" represents March 27, 2017 at 17:48:16.751 UTC. * **Comment** *(string) --* A comment you can provide. **Exceptions** * "Route53.Client.exceptions.NoSuchHostedZone" * "Route53.Client.exceptions.InvalidVPCId" * "Route53.Client.exceptions.VPCAssociationNotFound" * "Route53.Client.exceptions.LastVPCAssociation" * "Route53.Client.exceptions.InvalidInput" Route53 / Client / list_tags_for_resources list_tags_for_resources *********************** Route53.Client.list_tags_for_resources(**kwargs) Lists tags for up to 10 health checks or hosted zones. For information about using tags for cost allocation, see Using Cost Allocation Tags in the *Billing and Cost Management User Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resources( ResourceType='healthcheck'|'hostedzone', ResourceIds=[ 'string', ] ) Parameters: * **ResourceType** (*string*) -- **[REQUIRED]** The type of the resources. * The resource type for health checks is "healthcheck". * The resource type for hosted zones is "hostedzone". * **ResourceIds** (*list*) -- **[REQUIRED]** A complex type that contains the ResourceId element for each resource for which you want to get a list of tags. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ResourceTagSets': [ { 'ResourceType': 'healthcheck'|'hostedzone', 'ResourceId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] } **Response Structure** * *(dict) --* A complex type containing tags for the specified resources. * **ResourceTagSets** *(list) --* A list of >>``<