2020/12/17 - Amazon Route 53 - 7 new 15 updated api methods
Changes This release adds support for DNSSEC signing in Amazon Route 53.
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
client.create_key_signing_key(
CallerReference='string',
HostedZoneId='string',
KeyManagementServiceArn='string',
Name='string',
Status='string'
)
string
[REQUIRED]
A unique string that identifies the request.
string
[REQUIRED]
The unique string (ID) used to identify a hosted zone.
string
[REQUIRED]
The Amazon resource name (ARN) for a customer managed key (CMK) in AWS 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 CMK 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": "api-service.dnssec.route53.aws.internal"
For more information about working with CMK in KMS, see AWS Key Management Service concepts .
string
[REQUIRED]
An alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone.
string
[REQUIRED]
A string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE .
dict
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) --
The ID of the request.
Status (string) --
The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
SubmittedAt (datetime) --
The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.
Comment (string) --
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
KeySigningKey (dict) --
The key signing key (KSK) that the request creates.
Name (string) --
An alphanumeric string used to identify a key signing key (KSK). 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 (CMK) in AWS Key Management Service (KMS). The KmsArn must be unique for each key signing key (KSK) in a single hosted zone.
You must configure the CMK 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": "api-service.dnssec.route53.aws.internal"
For more information about working with the customer managed key (CMK) in KMS, see AWS 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.
ACTION_NEEDED
There is an error in the KSK that requires you to take action to resolve.
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).
Enables DNSSEC signing in a specific hosted zone.
See also: AWS API Documentation
Request Syntax
client.enable_hosted_zone_dnssec(
HostedZoneId='string'
)
string
[REQUIRED]
A unique string used to identify a hosted zone.
dict
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) --
The ID of the request.
Status (string) --
The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
SubmittedAt (datetime) --
The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.
Comment (string) --
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
Deactivates a key signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the KSK status to INACTIVE .
See also: AWS API Documentation
Request Syntax
client.deactivate_key_signing_key(
HostedZoneId='string',
Name='string'
)
string
[REQUIRED]
A unique string used to identify a hosted zone.
string
[REQUIRED]
An alphanumeric string used to identify a key signing key (KSK).
dict
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) --
The ID of the request.
Status (string) --
The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
SubmittedAt (datetime) --
The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.
Comment (string) --
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
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
client.disable_hosted_zone_dnssec(
HostedZoneId='string'
)
string
[REQUIRED]
A unique string used to identify a hosted zone.
dict
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) --
The ID of the request.
Status (string) --
The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
SubmittedAt (datetime) --
The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.
Comment (string) --
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
Returns information about DNSSEC for a specific hosted zone, including the key signing keys (KSKs) and zone signing keys (ZSKs) in the hosted zone.
See also: AWS API Documentation
Request Syntax
client.get_dnssec(
HostedZoneId='string'
)
string
[REQUIRED]
A unique string used to identify a hosted zone.
dict
Response Syntax
{
'Status': {
'ServeSignature': 'string',
'StatusMessage': 'string'
},
'KeySigningKeys': [
{
'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)
},
]
}
Response Structure
(dict) --
Status (dict) --
A string repesenting the status of DNSSEC.
ServeSignature (string) --
Indicates your hosted zone signging status: SIGNING , NOT_SIGNING , or INTERNAL_FAILURE . If the status is INTERNAL_FAILURE , see StatusMessage for information about steps that you can take to correct the problem.
A status INTERNAL_FAILURE means there was an error during a request. Before you can continue to work with DNSSEC signing, including working with key signing keys (KSKs), you must correct the problem by enabling or disabling DNSSEC signing for the hosted zone.
StatusMessage (string) --
The status message provided for the following DNSSEC signing status: INTERNAL_FAILURE . The status message includes information about what the problem might be and steps that you can take to correct the issue.
KeySigningKeys (list) --
The key signing keys (KSKs) in your account.
(dict) --
A key signing key (KSK) is a complex type that represents a public/private key pair. The private key is used to generate a digital signature for the zone signing key (ZSK). The public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always associated with a hosted zone; it cannot exist by itself.
Name (string) --
An alphanumeric string used to identify a key signing key (KSK). 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 (CMK) in AWS Key Management Service (KMS). The KmsArn must be unique for each key signing key (KSK) in a single hosted zone.
You must configure the CMK 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": "api-service.dnssec.route53.aws.internal"
For more information about working with the customer managed key (CMK) in KMS, see AWS 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.
ACTION_NEEDED
There is an error in the KSK that requires you to take action to resolve.
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.
Activates a key signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to ACTIVE .
See also: AWS API Documentation
Request Syntax
client.activate_key_signing_key(
HostedZoneId='string',
Name='string'
)
string
[REQUIRED]
A unique string used to identify a hosted zone.
string
[REQUIRED]
An alphanumeric string used to identify a key signing key (KSK).
dict
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) --
The ID of the request.
Status (string) --
The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
SubmittedAt (datetime) --
The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.
Comment (string) --
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
Deletes a key signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be deactived before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing.
See also: AWS API Documentation
Request Syntax
client.delete_key_signing_key(
HostedZoneId='string',
Name='string'
)
string
[REQUIRED]
A unique string used to identify a hosted zone.
string
[REQUIRED]
An alphanumeric string used to identify a key signing key (KSK).
dict
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) --
The ID of the request.
Status (string) --
The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
SubmittedAt (datetime) --
The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.
Comment (string) --
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
{'ChangeBatch': {'Changes': {'ResourceRecordSet': {'Type': {'DS'}}}}}
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.
Deleting Resource Record Sets
To delete a resource record set, you must specify all the same values that you specified when you created it.
Change Batches and Transactional Changes
The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone.
For example, suppose a change batch request contains two changes: it deletes the CNAME resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the DELETE or the CREATE action fails, then the request is canceled, and the original CNAME record continues to exist.
Note
If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an InvalidChangeBatch error.
Traffic Flow
To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide .
Create, Delete, and Upsert
Use ChangeResourceRecordsSetsRequest to perform the following actions:
CREATE : Creates a resource record set that has the specified values.
DELETE : Deletes an existing resource record set that has the specified values.
UPSERT : If a resource record set does not already exist, AWS creates it. If a resource set does exist, Route 53 updates it with the values in the request.
Syntaxes for Creating, Updating, and Deleting Resource Record Sets
The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.
For an example for each type of resource record set, see "Examples."
Don't refer to the syntax in the "Parameter Syntax" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets .
Change Propagation to Route 53 DNS Servers
When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING . When propagation is complete, GetChange returns a status of INSYNC . Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange .
Limits on ChangeResourceRecordSets Requests
For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide .
See also: AWS API Documentation
Request Syntax
client.change_resource_record_sets(
HostedZoneId='string',
ChangeBatch={
'Comment': 'string',
'Changes': [
{
'Action': 'CREATE'|'DELETE'|'UPSERT',
'ResourceRecordSet': {
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'SetIdentifier': 'string',
'Weight': 123,
'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-north-1'|'cn-northwest-1'|'ap-east-1'|'me-south-1'|'ap-south-1'|'af-south-1'|'eu-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'
}
},
]
}
)
string
[REQUIRED]
The ID of the hosted zone that contains the resource record sets that you want to change.
dict
[REQUIRED]
A complex type that contains an optional comment and the Changes element.
Comment (string) --
Optional: Any comments you want to include about a change batch request.
Changes (list) -- [REQUIRED]
Information about the changes to make to the record sets.
(dict) --
The information for each resource record set that you want to change.
Action (string) -- [REQUIRED]
The action to perform:
CREATE : Creates a resource record set that has the specified values.
DELETE : Deletes a existing resource record set.
Warning
To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance . Amazon 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.
UPSERT : If a resource record set doesn't already exist, Route 53 creates it. If a resource record set does exist, Route 53 updates it with the values in the request.
ResourceRecordSet (dict) -- [REQUIRED]
Information about the resource record set to create, delete, or update.
Name (string) -- [REQUIRED]
For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.
ChangeResourceRecordSets Only
Enter a fully qualified domain name, for example, www.example.com . You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
For information about how to specify characters other than a-z , 0-9 , and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide .
You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com . Note the following:
The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com .
The * can't replace any of the middle labels, for example, marketing.*.example.com.
If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.
Warning
You can't use the * wildcard for resource records sets that have a type of NS.
You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com . You can't use an * for one of the middle labels, for example, marketing.*.example.com . In addition, the * must replace the entire label; for example, you can't specify prod*.example.com .
Type (string) -- [REQUIRED]
The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide .
Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT
Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT . When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.
Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT
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 AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
Note
Although creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported.
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 .
Note
Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.
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 .
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 :
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) -- [REQUIRED]
The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide .
You can specify more than one value for all record types except CNAME and SOA .
Note
If you're creating an alias resource record set, omit Value .
AliasTarget (dict) --
Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
If you're creating resource records sets for a private hosted zone, note the following:
You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide .
HostedZoneId (string) -- [REQUIRED]
Alias resource records sets only : The value used depends on where you want to route traffic:
Amazon API Gateway custom regional APIs and edge-optimized APIs
Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names :
For regional APIs, specify the value of regionalHostedZoneId .
For edge-optimized APIs, specify the value of distributionHostedZoneId .
Amazon Virtual Private Cloud interface VPC endpoint
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints .
CloudFront distribution
Specify Z2FDTNDATAQYW2 .
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 AWS Elastic Beanstalk in the "AWS Service Endpoints" chapter of the Amazon Web Services General Reference .
ELB load balancer
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
Service Endpoints table in the "Elastic Load Balancing Endpoints and Quotas" topic in the Amazon Web Services General Reference : Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.
AWS Management Console : Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.
Elastic Load Balancing API : Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId .
Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneId .
AWS CLI : Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameId .
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId .
AWS Global Accelerator accelerator
Specify Z2BJ6XQ5FK7U4H .
An Amazon S3 bucket configured as a static website
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference .
Another Route 53 resource record set in your hosted zone
Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)
DNSName (string) -- [REQUIRED]
Alias resource record sets only: The value that you specify depends on where you want to route queries:
Amazon API Gateway custom regional APIs and edge-optimized APIs
Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names :
For regional APIs, specify the value of regionalDomainName .
For edge-optimized APIs, specify the value of distributionDomainName . This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net .
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 AWS CLI command describe-vpc-endpoints .
CloudFront distribution
Specify the domain name that CloudFront assigned when you created your distribution.
Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com , your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide .
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
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:
AWS Management Console : For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide .
Elastic Beanstalk API : Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference .
AWS CLI : Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS CLI Command Reference .
ELB load balancer
Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI.
AWS Management Console : Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field. If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack . If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.
Elastic Load Balancing API : Use DescribeLoadBalancers to get the value of DNSName . For more information, see the applicable guide:
Classic Load Balancers: DescribeLoadBalancers
Application and Network Load Balancers: DescribeLoadBalancers
AWS CLI : Use describe-load-balancers to get the value of DNSName . For more information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
AWS Global Accelerator accelerator
Specify the DNS name for your accelerator:
Global Accelerator API: To get the DNS name, use DescribeAccelerator .
AWS CLI: To get the DNS name, use describe-accelerator .
Amazon S3 bucket that is configured as a static website
Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com . For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference . For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Another Route 53 resource record set
Specify the value of the Name element for a resource record set in the current hosted zone.
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) -- [REQUIRED]
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true , an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.
Note the following:
CloudFront distributions
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.
Elastic Beanstalk environments that have regionalized subdomains
If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.
If the environment contains a single Amazon EC2 instance, there are no special requirements.
ELB load balancers
Health checking behavior depends on the type of load balancer:
Classic Load Balancers : If you specify an ELB Classic Load Balancer in DNSName , Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.
Application and Network Load Balancers : If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true , Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:
For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.
A target group that has no registered targets is considered unhealthy.
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 AWS resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide .
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide .
HealthCheckId (string) --
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.
Route 53 determines whether a resource record set is healthy based on one of the following:
By periodically sending a request to the endpoint that is specified in the health check
By aggregating the status of a specified group of health checks (calculated health checks)
By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)
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 :
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.
dict
Response Syntax
{
'ChangeInfo': {
'Id': 'string',
'Status': 'PENDING'|'INSYNC',
'SubmittedAt': datetime(2015, 1, 1),
'Comment': 'string'
}
}
Response Structure
(dict) --
A complex type containing the response for the request.
ChangeInfo (dict) --
A complex type that contains information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
Id (string) --
The ID of the request.
Status (string) --
The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
SubmittedAt (datetime) --
The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.
Comment (string) --
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
{'TrafficPolicy': {'Type': {'DS'}}}
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
client.create_traffic_policy(
Name='string',
Document='string',
Comment='string'
)
string
[REQUIRED]
The name of the traffic policy.
string
[REQUIRED]
The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format .
string
(Optional) Any comments that you want to include about the traffic policy.
dict
Response Syntax
{
'TrafficPolicy': {
'Id': 'string',
'Version': 123,
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'Document': 'string',
'Comment': 'string'
},
'Location': 'string'
}
Response Structure
(dict) --
A complex type that contains the response information for the CreateTrafficPolicy request.
TrafficPolicy (dict) --
A complex type that contains settings for the new traffic policy.
Id (string) --
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.
{'TrafficPolicyInstance': {'TrafficPolicyType': {'DS'}}}
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
client.create_traffic_policy_instance(
HostedZoneId='string',
Name='string',
TTL=123,
TrafficPolicyId='string',
TrafficPolicyVersion=123
)
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.
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.
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.
string
[REQUIRED]
The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
integer
[REQUIRED]
The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
dict
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'
},
'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.
{'TrafficPolicy': {'Type': {'DS'}}}
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
client.create_traffic_policy_version(
Id='string',
Document='string',
Comment='string'
)
string
[REQUIRED]
The ID of the traffic policy for which you want to create a new version.
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 .
string
The comment that you specified in the CreateTrafficPolicyVersion request, if any.
dict
Response Syntax
{
'TrafficPolicy': {
'Id': 'string',
'Version': 123,
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'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.
{'TrafficPolicy': {'Type': {'DS'}}}
Gets information about a specific traffic policy version.
For information about how of deleting a traffic policy affects the response from GetTrafficPolicy , see DeleteTrafficPolicy .
See also: AWS API Documentation
Request Syntax
client.get_traffic_policy(
Id='string',
Version=123
)
string
[REQUIRED]
The ID of the traffic policy that you want to get information about.
integer
[REQUIRED]
The version number of the traffic policy that you want to get information about.
dict
Response Syntax
{
'TrafficPolicy': {
'Id': 'string',
'Version': 123,
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'Document': 'string',
'Comment': 'string'
}
}
Response Structure
(dict) --
A complex type that contains the response information for the request.
TrafficPolicy (dict) --
A complex type that contains settings for the specified traffic policy.
Id (string) --
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.
{'TrafficPolicyInstance': {'TrafficPolicyType': {'DS'}}}
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 Route 53 console, traffic policy instances are known as policy records.
See also: AWS API Documentation
Request Syntax
client.get_traffic_policy_instance(
Id='string'
)
string
[REQUIRED]
The ID of the traffic policy instance that you want to get information about.
dict
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'
}
}
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.
{'StartRecordType': {'DS'}}
Response {'NextRecordType': {'DS'}, 'ResourceRecordSets': {'Type': {'DS'}}}
Lists the resource record sets in a specified hosted zone.
ListResourceRecordSets returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements.
Sort order
ListResourceRecordSets sorts results first by DNS name with the labels reversed, for example:
com.example.www.
Note the trailing dot, which can change the sort order when the record name contains characters that appear before . (decimal 46) in the ASCII table. These characters include the following: ! " # $ % & ' ( ) * + , -
When multiple records have the same DNS name, ListResourceRecordSets sorts results by the record type.
Specifying where to start listing records
You can use the name and type elements to specify the resource record set that the list begins with:
If you do not specify Name or Type
The results begin with the first resource record set that the hosted zone contains.
If you specify Name but not Type
The results begin with the first resource record set in the list whose name is greater than or equal to Name .
If you specify Type but not Name
Amazon Route 53 returns the InvalidInput error.
If you specify both Name and Type
The results begin with the first resource record set in the list whose name is greater than or equal to Name , and whose type is greater than or equal to Type .
Resource record sets that are PENDING
This action returns the most current version of the records. This includes records that are PENDING , and that are not yet available on all Route 53 DNS servers.
Changing resource record sets
To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you're paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.
Displaying the next page of results
If a ListResourceRecordSets command returns more than one page of results, the value of IsTruncated is true . To display the next page of results, get the values of NextRecordName , NextRecordType , and NextRecordIdentifier (if any) from the response. Then submit another ListResourceRecordSets request, and specify those values for StartRecordName , StartRecordType , and StartRecordIdentifier .
See also: AWS API Documentation
Request Syntax
client.list_resource_record_sets(
HostedZoneId='string',
StartRecordName='string',
StartRecordType='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
StartRecordIdentifier='string',
MaxItems='string'
)
string
[REQUIRED]
The ID of the hosted zone that contains the resource record sets that you want to list.
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 .
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.
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.
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.
dict
Response Syntax
{
'ResourceRecordSets': [
{
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'SetIdentifier': 'string',
'Weight': 123,
'Region': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'ca-central-1'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'cn-north-1'|'cn-northwest-1'|'ap-east-1'|'me-south-1'|'ap-south-1'|'af-south-1'|'eu-south-1',
'GeoLocation': {
'ContinentCode': 'string',
'CountryCode': 'string',
'SubdivisionCode': 'string'
},
'Failover': 'PRIMARY'|'SECONDARY',
'MultiValueAnswer': True|False,
'TTL': 123,
'ResourceRecords': [
{
'Value': 'string'
},
],
'AliasTarget': {
'HostedZoneId': 'string',
'DNSName': 'string',
'EvaluateTargetHealth': True|False
},
'HealthCheckId': 'string',
'TrafficPolicyInstanceId': 'string'
},
],
'IsTruncated': True|False,
'NextRecordName': 'string',
'NextRecordType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'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.
You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com . You can't use an * for one of the middle labels, for example, marketing.*.example.com . In addition, the * must replace the entire label; for example, you can't specify prod*.example.com .
Type (string) --
The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide .
Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT
Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT . When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.
Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT
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 AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
Note
Although creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported.
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 .
Note
Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.
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 .
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 :
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 AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
If you're creating resource records sets for a private hosted zone, note the following:
You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide .
HostedZoneId (string) --
Alias resource records sets only : The value used depends on where you want to route traffic:
Amazon API Gateway custom regional APIs and edge-optimized APIs
Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names :
For regional APIs, specify the value of regionalHostedZoneId .
For edge-optimized APIs, specify the value of distributionHostedZoneId .
Amazon Virtual Private Cloud interface VPC endpoint
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints .
CloudFront distribution
Specify Z2FDTNDATAQYW2 .
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 AWS Elastic Beanstalk in the "AWS Service Endpoints" chapter of the Amazon Web Services General Reference .
ELB load balancer
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
Service Endpoints table in the "Elastic Load Balancing Endpoints and Quotas" topic in the Amazon Web Services General Reference : Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.
AWS Management Console : Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.
Elastic Load Balancing API : Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId .
Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneId .
AWS CLI : Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameId .
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId .
AWS Global Accelerator accelerator
Specify Z2BJ6XQ5FK7U4H .
An Amazon S3 bucket configured as a static website
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference .
Another Route 53 resource record set in your hosted zone
Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)
DNSName (string) --
Alias resource record sets only: The value that you specify depends on where you want to route queries:
Amazon API Gateway custom regional APIs and edge-optimized APIs
Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names :
For regional APIs, specify the value of regionalDomainName .
For edge-optimized APIs, specify the value of distributionDomainName . This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net .
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 AWS CLI command describe-vpc-endpoints .
CloudFront distribution
Specify the domain name that CloudFront assigned when you created your distribution.
Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com , your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide .
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
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:
AWS Management Console : For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide .
Elastic Beanstalk API : Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference .
AWS CLI : Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS CLI Command Reference .
ELB load balancer
Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI.
AWS Management Console : Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field. If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack . If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.
Elastic Load Balancing API : Use DescribeLoadBalancers to get the value of DNSName . For more information, see the applicable guide:
Classic Load Balancers: DescribeLoadBalancers
Application and Network Load Balancers: DescribeLoadBalancers
AWS CLI : Use describe-load-balancers to get the value of DNSName . For more information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
AWS Global Accelerator accelerator
Specify the DNS name for your accelerator:
Global Accelerator API: To get the DNS name, use DescribeAccelerator .
AWS CLI: To get the DNS name, use describe-accelerator .
Amazon S3 bucket that is configured as a static website
Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com . For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference . For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Another Route 53 resource record set
Specify the value of the Name element for a resource record set in the current hosted zone.
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 AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.
Note the following:
CloudFront distributions
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.
Elastic Beanstalk environments that have regionalized subdomains
If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.
If the environment contains a single Amazon EC2 instance, there are no special requirements.
ELB load balancers
Health checking behavior depends on the type of load balancer:
Classic Load Balancers : If you specify an ELB Classic Load Balancer in DNSName , Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.
Application and Network Load Balancers : If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true , Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:
For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.
A target group that has no registered targets is considered unhealthy.
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 AWS resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide .
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide .
HealthCheckId (string) --
If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.
Route 53 determines whether a resource record set is healthy based on one of the following:
By periodically sending a request to the endpoint that is specified in the health check
By aggregating the status of a specified group of health checks (calculated health checks)
By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)
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 :
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.
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.
{'TrafficPolicySummaries': {'Type': {'DS'}}}
Gets information about the latest version for every traffic policy that is associated with the current AWS account. Policies are listed in the order that they were created in.
For information about how of deleting a traffic policy affects the response from ListTrafficPolicies , see DeleteTrafficPolicy .
See also: AWS API Documentation
Request Syntax
client.list_traffic_policies(
TrafficPolicyIdMarker='string',
MaxItems='string'
)
string
(Conditional) For your first request to ListTrafficPolicies , don't include the TrafficPolicyIdMarker parameter.
If you have more traffic policies than the value of MaxItems , ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of policies, submit another request to ListTrafficPolicies . For the value of TrafficPolicyIdMarker , specify the value of TrafficPolicyIdMarker that was returned in the previous response.
string
(Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is true , and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if you submit another request.
dict
Response Syntax
{
'TrafficPolicySummaries': [
{
'Id': 'string',
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'LatestVersion': 123,
'TrafficPolicyCount': 123
},
],
'IsTruncated': True|False,
'TrafficPolicyIdMarker': 'string',
'MaxItems': 'string'
}
Response Structure
(dict) --
A complex type that contains the response information for the request.
TrafficPolicySummaries (list) --
A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current AWS account.
(dict) --
A complex type that contains information about the latest version of one traffic policy that is associated with the current AWS account.
Id (string) --
The ID that Amazon Route 53 assigned to the traffic policy when you created it.
Name (string) --
The name that you specified for the traffic policy when you created it.
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.
LatestVersion (integer) --
The version number of the latest version of the traffic policy.
TrafficPolicyCount (integer) --
The number of traffic policies that are associated with the current AWS account.
IsTruncated (boolean) --
A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request parameter.
TrafficPolicyIdMarker (string) --
If the value of IsTruncated is true , TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.
MaxItems (string) --
The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced the current response.
{'TrafficPolicyInstanceTypeMarker': {'DS'}}
Response {'TrafficPolicyInstanceTypeMarker': {'DS'},
'TrafficPolicyInstances': {'TrafficPolicyType': {'DS'}}}
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.
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
client.list_traffic_policy_instances(
HostedZoneIdMarker='string',
TrafficPolicyInstanceNameMarker='string',
TrafficPolicyInstanceTypeMarker='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
MaxItems='string'
)
string
If the value of IsTruncated in the previous response was true , you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneId , specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances.
If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.
string
If the value of IsTruncated in the previous response was true , you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename , specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.
If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.
string
If the value of IsTruncated in the previous response was true , you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype , specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.
If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.
string
The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true , and the values of HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.
dict
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'|'CAA'|'DS'
},
],
'HostedZoneIdMarker': 'string',
'TrafficPolicyInstanceNameMarker': 'string',
'TrafficPolicyInstanceTypeMarker': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'IsTruncated': True|False,
'MaxItems': 'string'
}
Response Structure
(dict) --
A complex type that contains the response information for the request.
TrafficPolicyInstances (list) --
A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.
(dict) --
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.
HostedZoneIdMarker (string) --
If IsTruncated is true , HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.
TrafficPolicyInstanceNameMarker (string) --
If IsTruncated is true , TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.
TrafficPolicyInstanceTypeMarker (string) --
If IsTruncated is true , TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request.
IsTruncated (boolean) --
A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.
MaxItems (string) --
The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.
{'TrafficPolicyInstanceTypeMarker': {'DS'}}
Response {'TrafficPolicyInstanceTypeMarker': {'DS'},
'TrafficPolicyInstances': {'TrafficPolicyType': {'DS'}}}
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.
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
client.list_traffic_policy_instances_by_hosted_zone(
HostedZoneId='string',
TrafficPolicyInstanceNameMarker='string',
TrafficPolicyInstanceTypeMarker='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
MaxItems='string'
)
string
[REQUIRED]
The ID of the hosted zone that you want to list traffic policy instances for.
string
If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename , specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.
If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.
string
If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype , specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.
If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.
string
The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true , and the values of HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.
dict
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'|'CAA'|'DS'
},
],
'TrafficPolicyInstanceNameMarker': 'string',
'TrafficPolicyInstanceTypeMarker': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'IsTruncated': True|False,
'MaxItems': 'string'
}
Response Structure
(dict) --
A complex type that contains the response information for the request.
TrafficPolicyInstances (list) --
A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.
(dict) --
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.
TrafficPolicyInstanceNameMarker (string) --
If IsTruncated is true , TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of traffic policy instances.
TrafficPolicyInstanceTypeMarker (string) --
If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of traffic policy instances.
IsTruncated (boolean) --
A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by submitting another ListTrafficPolicyInstancesByHostedZone request and specifying the values of HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.
MaxItems (string) --
The value that you specified for the MaxItems parameter in the ListTrafficPolicyInstancesByHostedZone request that produced the current response.
{'TrafficPolicyInstanceTypeMarker': {'DS'}}
Response {'TrafficPolicyInstanceTypeMarker': {'DS'},
'TrafficPolicyInstances': {'TrafficPolicyType': {'DS'}}}
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.
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
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'|'CAA'|'DS',
MaxItems='string'
)
string
[REQUIRED]
The ID of the traffic policy for which you want to list traffic policy instances.
integer
[REQUIRED]
The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId .
string
If the value of IsTruncated in the previous response was true , you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.
For the value of hostedzoneid , specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.
string
If the value of IsTruncated in the previous response was true , you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.
For the value of trafficpolicyinstancename , specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.
string
If the value of IsTruncated in the previous response was true , you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.
For the value of trafficpolicyinstancetype , specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.
string
The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true , and the values of HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.
dict
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'|'CAA'|'DS'
},
],
'HostedZoneIdMarker': 'string',
'TrafficPolicyInstanceNameMarker': 'string',
'TrafficPolicyInstanceTypeMarker': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'IsTruncated': True|False,
'MaxItems': 'string'
}
Response Structure
(dict) --
A complex type that contains the response information for the request.
TrafficPolicyInstances (list) --
A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.
(dict) --
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.
HostedZoneIdMarker (string) --
If IsTruncated is true , HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of traffic policy instances.
TrafficPolicyInstanceNameMarker (string) --
If IsTruncated is true , TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
TrafficPolicyInstanceTypeMarker (string) --
If IsTruncated is true , TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.
IsTruncated (boolean) --
A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.
MaxItems (string) --
The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced the current response.
{'TrafficPolicies': {'Type': {'DS'}}}
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
client.list_traffic_policy_versions(
Id='string',
TrafficPolicyVersionMarker='string',
MaxItems='string'
)
string
[REQUIRED]
Specify the value of Id of the traffic policy for which you want to list all versions.
string
For your first request to ListTrafficPolicyVersions , don't include the TrafficPolicyVersionMarker parameter.
If you have more traffic policy versions than the value of MaxItems , ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get more traffic policy versions, submit another ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker , specify the value of TrafficPolicyVersionMarker in the previous response.
string
The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of IsTruncated in the response is true , and the value of the TrafficPolicyVersionMarker element is the ID of the first version that Route 53 will return if you submit another request.
dict
Response Syntax
{
'TrafficPolicies': [
{
'Id': 'string',
'Version': 123,
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'Document': 'string',
'Comment': 'string'
},
],
'IsTruncated': True|False,
'TrafficPolicyVersionMarker': 'string',
'MaxItems': 'string'
}
Response Structure
(dict) --
A complex type that contains the response information for the request.
TrafficPolicies (list) --
A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy.
(dict) --
A complex type that contains settings for a 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.
IsTruncated (boolean) --
A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicyVersions request and specifying the value of NextMarker in the marker parameter.
TrafficPolicyVersionMarker (string) --
If IsTruncated is true , the value of TrafficPolicyVersionMarker identifies the first traffic policy that Amazon Route 53 will return if you submit another request. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.
This element is present only if IsTruncated is true .
MaxItems (string) --
The value that you specified for the maxitems parameter in the ListTrafficPolicyVersions request that produced the current response.
{'RecordType': {'DS'}}
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
client.test_dns_answer(
HostedZoneId='string',
RecordName='string',
RecordType='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
ResolverIP='string',
EDNS0ClientSubnetIP='string',
EDNS0ClientSubnetMask='string'
)
string
[REQUIRED]
The ID of the hosted zone that you want Amazon Route 53 to simulate a query for.
string
[REQUIRED]
The name of the resource record set that you want Amazon Route 53 to simulate a query for.
string
[REQUIRED]
The type of the resource record set.
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 AWS US East (N. Virginia) Region (us-east-1 ).
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 .
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
dict
Response Syntax
{
'Nameserver': 'string',
'RecordName': 'string',
'RecordType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'RecordData': [
'string',
],
'ResponseCode': 'string',
'Protocol': 'string'
}
Response Structure
(dict) --
A complex type that contains the response to a TestDNSAnswer request.
Nameserver (string) --
The Amazon Route 53 name server used to respond to the request.
RecordName (string) --
The name of the resource record set that you submitted a request for.
RecordType (string) --
The type of the resource record set that you submitted a request for.
RecordData (list) --
A list that contains values that Amazon Route 53 returned for this resource record set.
(string) --
A value that Amazon Route 53 returned for this resource record set. A RecordDataEntry element is one of the following:
For non-alias resource record sets, a RecordDataEntry element contains one value in the resource record set. If the resource record set contains multiple values, the response includes one RecordDataEntry element for each value.
For multiple resource record sets that have the same name and type, which includes weighted, latency, geolocation, and failover, a RecordDataEntry element contains the value from the appropriate resource record set based on the request.
For alias resource record sets that refer to AWS resources other than another resource record set, the RecordDataEntry element contains an IP address or a domain name for the AWS resource, depending on the type of resource.
For alias resource record sets that refer to other resource record sets, a RecordDataEntry element contains one value from the referenced resource record set. If the referenced resource record set contains multiple values, the response includes one RecordDataEntry element for each value.
ResponseCode (string) --
A code that indicates whether the request is valid or not. The most common response code is NOERROR , meaning that the request is valid. If the response is not valid, Amazon Route 53 returns a response code that describes the error. For a list of possible response codes, see DNS RCODES on the IANA website.
Protocol (string) --
The protocol that Amazon Route 53 used to respond to the request, either UDP or TCP .
{'TrafficPolicy': {'Type': {'DS'}}}
Updates the comment for a specified traffic policy version.
See also: AWS API Documentation
Request Syntax
client.update_traffic_policy_comment(
Id='string',
Version=123,
Comment='string'
)
string
[REQUIRED]
The value of Id for the traffic policy that you want to update the comment for.
integer
[REQUIRED]
The value of Version for the traffic policy that you want to update the comment for.
string
[REQUIRED]
The new comment for the specified traffic policy and version.
dict
Response Syntax
{
'TrafficPolicy': {
'Id': 'string',
'Version': 123,
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
'Document': 'string',
'Comment': 'string'
}
}
Response Structure
(dict) --
A complex type that contains the response information for the traffic policy.
TrafficPolicy (dict) --
A complex type that contains settings for the specified traffic policy.
Id (string) --
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.
{'TrafficPolicyInstance': {'TrafficPolicyType': {'DS'}}}
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. Route 53 performs the following operations:
Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets.
When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.
Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.
See also: AWS API Documentation
Request Syntax
client.update_traffic_policy_instance(
Id='string',
TTL=123,
TrafficPolicyId='string',
TrafficPolicyVersion=123
)
string
[REQUIRED]
The ID of the traffic policy instance that you want to update.
integer
[REQUIRED]
The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.
string
[REQUIRED]
The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
integer
[REQUIRED]
The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
dict
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'
}
}
Response Structure
(dict) --
A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.
TrafficPolicyInstance (dict) --
A complex type that contains settings for the updated traffic policy instance.
Id (string) --
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.