Table of Contents
Route53.Client¶A low-level client representing Amazon Route 53:
client = session.create_client('route53')
These are the available methods:
associate_vpc_with_hosted_zone()can_paginate()change_resource_record_sets()change_tags_for_resource()create_health_check()create_hosted_zone()create_reusable_delegation_set()create_traffic_policy()create_traffic_policy_instance()create_traffic_policy_version()create_vpc_association_authorization()delete_health_check()delete_hosted_zone()delete_reusable_delegation_set()delete_traffic_policy()delete_traffic_policy_instance()delete_vpc_association_authorization()disassociate_vpc_from_hosted_zone()generate_presigned_url()get_change()get_checker_ip_ranges()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_paginator()get_reusable_delegation_set()get_traffic_policy()get_traffic_policy_instance()get_traffic_policy_instance_count()get_waiter()list_geo_locations()list_health_checks()list_hosted_zones()list_hosted_zones_by_name()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()associate_vpc_with_hosted_zone(**kwargs)¶Associates an Amazon VPC with a private hosted zone.
Warning
To perform the association, the VPC and the private hosted zone must already exist. You can’t convert a public hosted zone into a private hosted zone.
Note
If you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request.
See also: AWS API Documentation
Request Syntax
response = client.associate_vpc_with_hosted_zone(
HostedZoneId='string',
VPC={
'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'ca-central-1'|'cn-north-1',
'VPCId': 'string'
},
Comment='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ChangeInfo': {
'Id': 'string',
'Status': 'PENDING'|'INSYNC',
'SubmittedAt': datetime(2015, 1, 1),
'Comment': 'string'
}
}
Response Structure
|
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. |
change_resource_record_sets(**kwargs)¶Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.
Change Batches and Transactional Changes
The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. When using the Amazon Route 53 API to change resource record sets, Amazon Route 53 either makes all or none of the changes in a change batch request. This ensures that Amazon Route 53 never partially implements the intended changes to the resource record sets in a hosted zone.
For example, a change batch request that deletes the CNAME record for www.example.com and creates an alias resource record set for www.example.com. Amazon Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If either the DELETE or the CREATE action fails, then both changes (plus any other changes in the batch) fail, and the original CNAME record continues to exist.
Warning
Due to the nature of transactional changes, you can’t delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Amazon Route 53 returns anInvalidChangeBatcherror.
Traffic Flow
To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Amazon Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn’t performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide .
Create, Delete, and Upsert
Use ChangeResourceRecordsSetsRequest to perform the following actions:
CREATE : Creates a resource record set that has the specified values.DELETE : Deletes an existing resource record set that has the specified values.UPSERT : If a resource record set does not already exist, AWS creates it. If a resource set does exist, Amazon Route 53 updates it with the values in the request.Syntaxes for Creating, Updating, and Deleting Resource Record Sets
The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.
For an example for each type of resource record set, see “Examples.”
Don’t refer to the syntax in the “Parameter Syntax” section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets .
Change Propagation to Amazon Route 53 DNS Servers
When you submit a ChangeResourceRecordSets request, Amazon Route 53 propagates your changes to all of the Amazon Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING . When propagation is complete, GetChange returns a status of INSYNC . Changes generally propagate to all Amazon Route 53 name servers within 60 seconds. For more information, see GetChange .
Limits on ChangeResourceRecordSets Requests
For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.change_resource_record_sets(
HostedZoneId='string',
ChangeBatch={
'Comment': 'string',
'Changes': [
{
'Action': 'CREATE'|'DELETE'|'UPSERT',
'ResourceRecordSet': {
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
'SetIdentifier': 'string',
'Weight': 123,
'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-west-1'|'eu-west-2'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'cn-north-1'|'ap-south-1',
'GeoLocation': {
'ContinentCode': 'string',
'CountryCode': 'string',
'SubdivisionCode': 'string'
},
'Failover': 'PRIMARY'|'SECONDARY',
'MultiValueAnswer': True|False,
'TTL': 123,
'ResourceRecords': [
{
'Value': 'string'
},
],
'AliasTarget': {
'HostedZoneId': 'string',
'DNSName': 'string',
'EvaluateTargetHealth': True|False
},
'HealthCheckId': 'string',
'TrafficPolicyInstanceId': 'string'
}
},
]
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ChangeInfo': {
'Id': 'string',
'Status': 'PENDING'|'INSYNC',
'SubmittedAt': datetime(2015, 1, 1),
'Comment': 'string'
}
}
Response Structure
|
Adds, edits, or deletes tags for a health check or a hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .
See also: AWS API Documentation
Request Syntax
response = client.change_tags_for_resource(
ResourceType='healthcheck'|'hostedzone',
ResourceId='string',
AddTags=[
{
'Key': 'string',
'Value': 'string'
},
],
RemoveTagKeys=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
create_health_check(**kwargs)¶Creates a new health check.
For information about adding health checks to resource record sets, see ResourceRecordSet$HealthCheckId in ChangeResourceRecordSets .
ELB Load Balancers
If you’re registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to an Amazon Route 53 health check.
Private Hosted Zones
You can associate health checks with failover resource record sets in a private hosted zone. Note the following:
StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide .See also: AWS API Documentation
Request Syntax
response = client.create_health_check(
CallerReference='string',
HealthCheckConfig={
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
],
'EnableSNI': True|False,
'Regions': [
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
'AlarmIdentifier': {
'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'HealthCheck': {
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
],
'EnableSNI': True|False,
'Regions': [
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
'AlarmIdentifier': {
'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
},
'HealthCheckVersion': 123,
'CloudWatchAlarmConfiguration': {
'EvaluationPeriods': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'Period': 123,
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
'Location': 'string'
}
Response Structure
|
create_hosted_zone(**kwargs)¶Creates a new public hosted zone, which you use to specify how the Domain Name System (DNS) routes traffic on the Internet for a domain, such as example.com, and its subdomains.
Warning
You can’t convert a public hosted zones to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
For more information about charges for hosted zones, see Amazon Route 53 Pricing .
Note the following:
DelegationSetId element.When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING . This means that the NS and SOA records are not yet available on all Amazon Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC .
See also: AWS API Documentation
Request Syntax
response = client.create_hosted_zone(
Name='string',
VPC={
'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'ca-central-1'|'cn-north-1',
'VPCId': 'string'
},
CallerReference='string',
HostedZoneConfig={
'Comment': 'string',
'PrivateZone': True|False
},
DelegationSetId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'HostedZone': {
'Id': 'string',
'Name': 'string',
'CallerReference': 'string',
'Config': {
'Comment': 'string',
'PrivateZone': True|False
},
'ResourceRecordSetCount': 123
},
'ChangeInfo': {
'Id': 'string',
'Status': 'PENDING'|'INSYNC',
'SubmittedAt': datetime(2015, 1, 1),
'Comment': 'string'
},
'DelegationSet': {
'Id': 'string',
'CallerReference': 'string',
'NameServers': [
'string',
]
},
'VPC': {
'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'ca-central-1'|'cn-north-1',
'VPCId': 'string'
},
'Location': 'string'
}
Response Structure
|
create_reusable_delegation_set(**kwargs)¶Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones. If a hosted zoned ID is specified, CreateReusableDelegationSet marks the delegation set associated with that zone as reusable
Note
A reusable delegation set can’t be associated with a private hosted zone.
For information on how to use a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers .
See also: AWS API Documentation
Request Syntax
response = client.create_reusable_delegation_set(
CallerReference='string',
HostedZoneId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'DelegationSet': {
'Id': 'string',
'CallerReference': 'string',
'NameServers': [
'string',
]
},
'Location': 'string'
}
Response Structure
|
create_traffic_policy(**kwargs)¶Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
See also: AWS API Documentation
Request Syntax
response = client.create_traffic_policy(
Name='string',
Document='string',
Comment='string'
)
| Parameters: |
|
|---|---|
| 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',
'Document': 'string',
'Comment': 'string'
},
'Location': 'string'
}
Response Structure
|
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.
See also: AWS API Documentation
Request Syntax
response = client.create_traffic_policy_instance(
HostedZoneId='string',
Name='string',
TTL=123,
TrafficPolicyId='string',
TrafficPolicyVersion=123
)
| Parameters: |
|
|---|---|
| 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'
},
'Location': 'string'
}
Response Structure
|
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: |
|
|---|---|
| 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',
'Document': 'string',
'Comment': 'string'
},
'Location': 'string'
}
Response Structure
|
Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.
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-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'ca-central-1'|'cn-north-1',
'VPCId': 'string'
}
)
| Parameters: |
|
|---|---|
| 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-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'ca-central-1'|'cn-north-1',
'VPCId': 'string'
}
}
Response Structure
|
delete_health_check(**kwargs)¶Deletes a health check.
Warning
Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don’t update the associated resource record sets, the future status of the health check can’t be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_health_check(
HealthCheckId='string'
)
| Parameters: | HealthCheckId (string) – [REQUIRED] The ID of the health check that you want to delete. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{}
Response Structure
|
delete_hosted_zone(**kwargs)¶Deletes a hosted zone.
Warning
If the name servers for the hosted zone are associated with a domain and if you want to make the domain unavailable on the Internet, we recommend that you delete the name servers from the domain to prevent future DNS queries from possibly being misrouted. If the domain is registered with Amazon Route 53, see UpdateDomainNameservers . If the domain is registered with another registrar, use the method provided by the registrar to delete name servers for the domain.
Some domain registries don’t allow you to remove all of the name servers for a domain. If the registry for your domain requires one or more name servers, we recommend that you delete the hosted zone only if you transfer DNS service to another service provider, and you replace the name servers for the domain with name servers from the new provider.
You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Amazon Route 53 returns a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets .
To verify that the hosted zone has been deleted, do one of the following:
GetHostedZone action to request information about the hosted zone.ListHostedZones action to get a list of the hosted zones associated with the current AWS account.See also: AWS API Documentation
Request Syntax
response = client.delete_hosted_zone(
Id='string'
)
| Parameters: | Id (string) – [REQUIRED] The ID of the hosted zone you want to delete. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'ChangeInfo': {
'Id': 'string',
'Status': 'PENDING'|'INSYNC',
'SubmittedAt': datetime(2015, 1, 1),
'Comment': 'string'
}
}
Response Structure
|
delete_reusable_delegation_set(**kwargs)¶Deletes a reusable delegation set.
Warning
You can delete a reusable delegation set only if it isn’t associated with any hosted zones.
To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.
See also: AWS API Documentation
Request Syntax
response = client.delete_reusable_delegation_set(
Id='string'
)
| Parameters: | Id (string) – [REQUIRED] The ID of the reusable delegation set that you want to delete. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{}
Response Structure
|
delete_traffic_policy(**kwargs)¶Deletes a traffic policy.
See also: AWS API Documentation
Request Syntax
response = client.delete_traffic_policy(
Id='string',
Version=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
delete_traffic_policy_instance(**kwargs)¶Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
Note
In the Amazon Route 53 console, traffic policy instances are known as policy records.
See also: AWS API Documentation
Request Syntax
response = client.delete_traffic_policy_instance(
Id='string'
)
| Parameters: | Id (string) – [REQUIRED] The ID of the traffic policy instance that you want to delete. Warning When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{}
Response Structure
|
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 AWS 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-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'ca-central-1'|'cn-north-1',
'VPCId': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
disassociate_vpc_from_hosted_zone(**kwargs)¶Disassociates a VPC from a Amazon Route 53 private hosted zone.
Note
You can’t disassociate the last VPC from a private hosted zone.
Warning
You can’t disassociate a VPC from a private hosted zone when only one VPC is associated with the hosted zone. You also can’t convert a private hosted zone into a public hosted zone.
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-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'ca-central-1'|'cn-north-1',
'VPCId': 'string'
},
Comment='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ChangeInfo': {
'Id': 'string',
'Status': 'PENDING'|'INSYNC',
'SubmittedAt': datetime(2015, 1, 1),
'Comment': 'string'
}
}
Response Structure
|
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
| Parameters: |
|
|---|---|
| Returns: | The presigned url |
get_change(**kwargs)¶Returns the current status of a change batch request. The status is one of the following values:
PENDING indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests.INSYNC indicates that the changes have propagated to all Amazon Route 53 DNS servers.See also: AWS API Documentation
Request Syntax
response = client.get_change(
Id='string'
)
| Parameters: | Id (string) – [REQUIRED] The ID of the change batch request. The value that you specify here is the value that |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'ChangeInfo': {
'Id': 'string',
'Status': 'PENDING'|'INSYNC',
'SubmittedAt': datetime(2015, 1, 1),
'Comment': 'string'
}
}
Response Structure
|
get_checker_ip_ranges()¶GetCheckerIpRangesstill works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all AWS services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_checker_ip_ranges()
| Return type: | dict |
|---|---|
| Returns: | Response Syntax{
'CheckerIpRanges': [
'string',
]
}
Response Structure
|
get_geo_location(**kwargs)¶Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.
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: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'GeoLocationDetails': {
'ContinentCode': 'string',
'ContinentName': 'string',
'CountryCode': 'string',
'CountryName': 'string',
'SubdivisionCode': 'string',
'SubdivisionName': 'string'
}
}
Response Structure
|
get_health_check(**kwargs)¶Gets information about a specified health check.
See also: AWS API Documentation
Request Syntax
response = client.get_health_check(
HealthCheckId='string'
)
| Parameters: | HealthCheckId (string) – [REQUIRED] The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'HealthCheck': {
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
],
'EnableSNI': True|False,
'Regions': [
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
'AlarmIdentifier': {
'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
},
'HealthCheckVersion': 123,
'CloudWatchAlarmConfiguration': {
'EvaluationPeriods': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'Period': 123,
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
}
}
}
Response Structure
|
get_health_check_count()¶Retrieves the number of health checks that are associated with the current AWS account.
See also: AWS API Documentation
Request Syntax
response = client.get_health_check_count()
| Return type: | dict |
|---|---|
| Returns: | Response Syntax{
'HealthCheckCount': 123
}
Response Structure
|
get_health_check_last_failure_reason(**kwargs)¶Gets the reason that a specified health check failed most recently.
See also: AWS API Documentation
Request Syntax
response = client.get_health_check_last_failure_reason(
HealthCheckId='string'
)
| Parameters: | HealthCheckId (string) – [REQUIRED] The ID for the health check for which you want the last failure reason. When you created the 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
|
get_health_check_status(**kwargs)¶Gets status of a specified health check.
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, 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 |
|---|---|
| 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
|
get_hosted_zone(**kwargs)¶Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.
See also: AWS API Documentation
Request Syntax
response = client.get_hosted_zone(
Id='string'
)
| Parameters: | Id (string) – [REQUIRED] The ID of the hosted zone that you want to get information about. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'HostedZone': {
'Id': 'string',
'Name': 'string',
'CallerReference': 'string',
'Config': {
'Comment': 'string',
'PrivateZone': True|False
},
'ResourceRecordSetCount': 123
},
'DelegationSet': {
'Id': 'string',
'CallerReference': 'string',
'NameServers': [
'string',
]
},
'VPCs': [
{
'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'ca-central-1'|'cn-north-1',
'VPCId': 'string'
},
]
}
Response Structure
|
get_hosted_zone_count()¶Retrieves the number of hosted zones that are associated with the current AWS account.
See also: AWS API Documentation
Request Syntax
response = client.get_hosted_zone_count()
| Return type: | dict |
|---|---|
| Returns: | Response Syntax{
'HostedZoneCount': 123
}
Response Structure
|
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: | L{botocore.paginate.Paginator} |
| Returns: | A paginator object. |
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
|
get_traffic_policy(**kwargs)¶Gets information about a specific traffic policy version.
See also: AWS API Documentation
Request Syntax
response = client.get_traffic_policy(
Id='string',
Version=123
)
| Parameters: |
|
|---|---|
| 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',
'Document': 'string',
'Comment': 'string'
}
}
Response Structure
|
get_traffic_policy_instance(**kwargs)¶Gets information about a specified traffic policy instance.
Note
After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there’s a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.
Note
In the Amazon 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'
}
}
Response Structure
|
get_traffic_policy_instance_count()¶Gets the number of traffic policy instances that are associated with the current AWS account.
See also: AWS API Documentation
Request Syntax
response = client.get_traffic_policy_instance_count()
| Return type: | dict |
|---|---|
| Returns: | Response Syntax{
'TrafficPolicyInstanceCount': 123
}
Response Structure
|
get_waiter(waiter_name)¶list_geo_locations(**kwargs)¶Retrieves a list of supported geo locations.
Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.
See also: AWS API Documentation
Request Syntax
response = client.list_geo_locations(
StartContinentCode='string',
StartCountryCode='string',
StartSubdivisionCode='string',
MaxItems='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'GeoLocationDetailsList': [
{
'ContinentCode': 'string',
'ContinentName': 'string',
'CountryCode': 'string',
'CountryName': 'string',
'SubdivisionCode': 'string',
'SubdivisionName': 'string'
},
],
'IsTruncated': True|False,
'NextContinentCode': 'string',
'NextCountryCode': 'string',
'NextSubdivisionCode': 'string',
'MaxItems': 'string'
}
Response Structure
|
list_health_checks(**kwargs)¶Retrieve a list of the health checks that are associated with the current AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_health_checks(
Marker='string',
MaxItems='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'HealthChecks': [
{
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
],
'EnableSNI': True|False,
'Regions': [
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
'AlarmIdentifier': {
'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
},
'HealthCheckVersion': 123,
'CloudWatchAlarmConfiguration': {
'EvaluationPeriods': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'Period': 123,
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
],
'Marker': 'string',
'IsTruncated': True|False,
'NextMarker': 'string',
'MaxItems': 'string'
}
Response Structure
|
list_hosted_zones(**kwargs)¶Retrieves a list of the public and private hosted zones that are associated with the current AWS account. The response includes a HostedZones child element for each hosted zone.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100.
See also: AWS API Documentation
Request Syntax
response = client.list_hosted_zones(
Marker='string',
MaxItems='string',
DelegationSetId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'HostedZones': [
{
'Id': 'string',
'Name': 'string',
'CallerReference': 'string',
'Config': {
'Comment': 'string',
'PrivateZone': True|False
},
'ResourceRecordSetCount': 123
},
],
'Marker': 'string',
'IsTruncated': True|False,
'NextMarker': 'string',
'MaxItems': 'string'
}
Response Structure
|
list_hosted_zones_by_name(**kwargs)¶Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current AWS account.
ListHostedZonesByNamesorts hosted zones by name with the labels reversed. For example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:
com.ex\344mple.
The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide .
Amazon Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:
DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response.MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response.IsTruncated in the response is true, there are more hosted zones associated with the current AWS account. If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZonesByName , and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.See also: AWS API Documentation
Request Syntax
response = client.list_hosted_zones_by_name(
DNSName='string',
HostedZoneId='string',
MaxItems='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'HostedZones': [
{
'Id': 'string',
'Name': 'string',
'CallerReference': 'string',
'Config': {
'Comment': 'string',
'PrivateZone': True|False
},
'ResourceRecordSetCount': 123
},
],
'DNSName': 'string',
'HostedZoneId': 'string',
'IsTruncated': True|False,
'NextDNSName': 'string',
'NextHostedZoneId': 'string',
'MaxItems': 'string'
}
Response Structure
|
list_resource_record_sets(**kwargs)¶Lists the resource record sets in a specified hosted zone.
ListResourceRecordSetsreturns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by thenameandtypeelements. The action 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 in some circumstances.
When multiple records have the same DNS name, the action sorts results by the record type.
You can use the name and type elements to adjust the beginning position of the list of resource record sets returned:
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 .
This action returns the most current version of the records. This includes records that are PENDING , and that are not yet available on all Amazon Route 53 DNS servers.
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.
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',
StartRecordIdentifier='string',
MaxItems='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ResourceRecordSets': [
{
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
'SetIdentifier': 'string',
'Weight': 123,
'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-west-1'|'eu-west-2'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'cn-north-1'|'ap-south-1',
'GeoLocation': {
'ContinentCode': 'string',
'CountryCode': 'string',
'SubdivisionCode': 'string'
},
'Failover': 'PRIMARY'|'SECONDARY',
'MultiValueAnswer': True|False,
'TTL': 123,
'ResourceRecords': [
{
'Value': 'string'
},
],
'AliasTarget': {
'HostedZoneId': 'string',
'DNSName': 'string',
'EvaluateTargetHealth': True|False
},
'HealthCheckId': 'string',
'TrafficPolicyInstanceId': 'string'
},
],
'IsTruncated': True|False,
'NextRecordName': 'string',
'NextRecordType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
'NextRecordIdentifier': 'string',
'MaxItems': 'string'
}
Response Structure
|
list_reusable_delegation_sets(**kwargs)¶Retrieves a list of the reusable delegation sets that are associated with the current AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_reusable_delegation_sets(
Marker='string',
MaxItems='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'DelegationSets': [
{
'Id': 'string',
'CallerReference': 'string',
'NameServers': [
'string',
]
},
],
'Marker': 'string',
'IsTruncated': True|False,
'NextMarker': 'string',
'MaxItems': 'string'
}
Response Structure
|
Lists tags for one health check or hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceType='healthcheck'|'hostedzone',
ResourceId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ResourceTagSet': {
'ResourceType': 'healthcheck'|'hostedzone',
'ResourceId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
|
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 AWS 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: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ResourceTagSets': [
{
'ResourceType': 'healthcheck'|'hostedzone',
'ResourceId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
|
list_traffic_policies(**kwargs)¶Gets information about the latest version for every traffic policy that is associated with the current AWS account. Policies are listed in the order in which they were created.
See also: AWS API Documentation
Request Syntax
response = client.list_traffic_policies(
TrafficPolicyIdMarker='string',
MaxItems='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'TrafficPolicySummaries': [
{
'Id': 'string',
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
'LatestVersion': 123,
'TrafficPolicyCount': 123
},
],
'IsTruncated': True|False,
'TrafficPolicyIdMarker': 'string',
'MaxItems': 'string'
}
Response Structure
|
list_traffic_policy_instances(**kwargs)¶Gets information about the traffic policy instances that you created by using the current AWS account.
Note
After you submit an UpdateTrafficPolicyInstance request, there’s a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.
See also: AWS API Documentation
Request Syntax
response = client.list_traffic_policy_instances(
HostedZoneIdMarker='string',
TrafficPolicyInstanceNameMarker='string',
TrafficPolicyInstanceTypeMarker='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
MaxItems='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'TrafficPolicyInstances': [
{
'Id': 'string',
'HostedZoneId': 'string',
'Name': 'string',
'TTL': 123,
'State': 'string',
'Message': 'string',
'TrafficPolicyId': 'string',
'TrafficPolicyVersion': 123,
'TrafficPolicyType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'
},
],
'HostedZoneIdMarker': 'string',
'TrafficPolicyInstanceNameMarker': 'string',
'TrafficPolicyInstanceTypeMarker': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
'IsTruncated': True|False,
'MaxItems': 'string'
}
Response Structure
|
list_traffic_policy_instances_by_hosted_zone(**kwargs)¶Gets information about the traffic policy instances that you created in a specified hosted zone.
Note
After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there’s a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.
See also: AWS API Documentation
Request Syntax
response = client.list_traffic_policy_instances_by_hosted_zone(
HostedZoneId='string',
TrafficPolicyInstanceNameMarker='string',
TrafficPolicyInstanceTypeMarker='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
MaxItems='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'TrafficPolicyInstances': [
{
'Id': 'string',
'HostedZoneId': 'string',
'Name': 'string',
'TTL': 123,
'State': 'string',
'Message': 'string',
'TrafficPolicyId': 'string',
'TrafficPolicyVersion': 123,
'TrafficPolicyType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'
},
],
'TrafficPolicyInstanceNameMarker': 'string',
'TrafficPolicyInstanceTypeMarker': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
'IsTruncated': True|False,
'MaxItems': 'string'
}
Response Structure
|
list_traffic_policy_instances_by_policy(**kwargs)¶Gets information about the traffic policy instances that you created by using a specify traffic policy version.
Note
After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there’s a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.
See also: AWS API Documentation
Request Syntax
response = client.list_traffic_policy_instances_by_policy(
TrafficPolicyId='string',
TrafficPolicyVersion=123,
HostedZoneIdMarker='string',
TrafficPolicyInstanceNameMarker='string',
TrafficPolicyInstanceTypeMarker='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
MaxItems='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'TrafficPolicyInstances': [
{
'Id': 'string',
'HostedZoneId': 'string',
'Name': 'string',
'TTL': 123,
'State': 'string',
'Message': 'string',
'TrafficPolicyId': 'string',
'TrafficPolicyVersion': 123,
'TrafficPolicyType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'
},
],
'HostedZoneIdMarker': 'string',
'TrafficPolicyInstanceNameMarker': 'string',
'TrafficPolicyInstanceTypeMarker': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
'IsTruncated': True|False,
'MaxItems': 'string'
}
Response Structure
|
list_traffic_policy_versions(**kwargs)¶Gets information about all of the versions for a specified traffic policy.
Traffic policy versions are listed in numerical order by VersionNumber .
See also: AWS API Documentation
Request Syntax
response = client.list_traffic_policy_versions(
Id='string',
TrafficPolicyVersionMarker='string',
MaxItems='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'TrafficPolicies': [
{
'Id': 'string',
'Version': 123,
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
'Document': 'string',
'Comment': 'string'
},
],
'IsTruncated': True|False,
'TrafficPolicyVersionMarker': 'string',
'MaxItems': 'string'
}
Response Structure
|
Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you’ve submitted one or more CreateVPCAssociationAuthorization requests.
The response includes a VPCs element with a VPC child element for each VPC that can be associated with the hosted zone.
See also: AWS API Documentation
Request Syntax
response = client.list_vpc_association_authorizations(
HostedZoneId='string',
NextToken='string',
MaxResults='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'HostedZoneId': 'string',
'NextToken': 'string',
'VPCs': [
{
'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-south-1'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'ca-central-1'|'cn-north-1',
'VPCId': 'string'
},
]
}
Response Structure
|
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.
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',
ResolverIP='string',
EDNS0ClientSubnetIP='string',
EDNS0ClientSubnetMask='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Nameserver': 'string',
'RecordName': 'string',
'RecordType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
'RecordData': [
'string',
],
'ResponseCode': 'string',
'Protocol': 'string'
}
Response Structure
|
update_health_check(**kwargs)¶Updates an existing health check. Note that some values can’t be updated.
For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.update_health_check(
HealthCheckId='string',
HealthCheckVersion=123,
IPAddress='string',
Port=123,
ResourcePath='string',
FullyQualifiedDomainName='string',
SearchString='string',
FailureThreshold=123,
Inverted=True|False,
HealthThreshold=123,
ChildHealthChecks=[
'string',
],
EnableSNI=True|False,
Regions=[
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
AlarmIdentifier={
'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
InsufficientDataHealthStatus='Healthy'|'Unhealthy'|'LastKnownStatus'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'HealthCheck': {
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
],
'EnableSNI': True|False,
'Regions': [
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
'AlarmIdentifier': {
'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
},
'HealthCheckVersion': 123,
'CloudWatchAlarmConfiguration': {
'EvaluationPeriods': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'Period': 123,
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
}
}
}
Response Structure
|
update_hosted_zone_comment(**kwargs)¶Updates the comment for a specified hosted zone.
See also: AWS API Documentation
Request Syntax
response = client.update_hosted_zone_comment(
Id='string',
Comment='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'HostedZone': {
'Id': 'string',
'Name': 'string',
'CallerReference': 'string',
'Config': {
'Comment': 'string',
'PrivateZone': True|False
},
'ResourceRecordSetCount': 123
}
}
Response Structure
|
update_traffic_policy_comment(**kwargs)¶Updates the comment for a specified traffic policy version.
See also: AWS API Documentation
Request Syntax
response = client.update_traffic_policy_comment(
Id='string',
Version=123,
Comment='string'
)
| Parameters: |
|
|---|---|
| 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',
'Document': 'string',
'Comment': 'string'
}
}
Response Structure
|
update_traffic_policy_instance(**kwargs)¶Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.
When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Amazon Route 53 performs the following operations:
See also: AWS API Documentation
Request Syntax
response = client.update_traffic_policy_instance(
Id='string',
TTL=123,
TrafficPolicyId='string',
TrafficPolicyVersion=123
)
| Parameters: |
|
|---|---|
| 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'
}
}
Response Structure
|
The available paginators are:
Route53.Paginator.ListHealthChecksRoute53.Paginator.ListHostedZonesRoute53.Paginator.ListResourceRecordSetsRoute53.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.
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'HealthChecks': [
{
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP'|'CALCULATED'|'CLOUDWATCH_METRIC',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123,
'MeasureLatency': True|False,
'Inverted': True|False,
'HealthThreshold': 123,
'ChildHealthChecks': [
'string',
],
'EnableSNI': True|False,
'Regions': [
'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
],
'AlarmIdentifier': {
'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1',
'Name': 'string'
},
'InsufficientDataHealthStatus': 'Healthy'|'Unhealthy'|'LastKnownStatus'
},
'HealthCheckVersion': 123,
'CloudWatchAlarmConfiguration': {
'EvaluationPeriods': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'Period': 123,
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'Average'|'Sum'|'SampleCount'|'Maximum'|'Minimum',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
],
'Marker': 'string',
'IsTruncated': True|False,
'MaxItems': 'string',
'NextToken': 'string'
}
Response Structure
|
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',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'HostedZones': [
{
'Id': 'string',
'Name': 'string',
'CallerReference': 'string',
'Config': {
'Comment': 'string',
'PrivateZone': True|False
},
'ResourceRecordSetCount': 123
},
],
'Marker': 'string',
'IsTruncated': True|False,
'MaxItems': 'string',
'NextToken': 'string'
}
Response Structure
|
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: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ResourceRecordSets': [
{
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA',
'SetIdentifier': 'string',
'Weight': 123,
'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-west-1'|'eu-west-2'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'sa-east-1'|'cn-north-1'|'ap-south-1',
'GeoLocation': {
'ContinentCode': 'string',
'CountryCode': 'string',
'SubdivisionCode': 'string'
},
'Failover': 'PRIMARY'|'SECONDARY',
'MultiValueAnswer': True|False,
'TTL': 123,
'ResourceRecords': [
{
'Value': 'string'
},
],
'AliasTarget': {
'HostedZoneId': 'string',
'DNSName': 'string',
'EvaluateTargetHealth': True|False
},
'HealthCheckId': 'string',
'TrafficPolicyInstanceId': 'string'
},
],
'IsTruncated': True|False,
'MaxItems': 'string',
'NextToken': 'string'
}
Response Structure
|
The available waiters are:
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 returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Id='string'
)
| Parameters: | Id (string) – [REQUIRED] The ID of the change batch request. The value that you specify here is the value that |
|---|---|
| Returns: | None |