2014/10/16 - Amazon Route 53 - 19 new api methods
To retrieve a list of the IP ranges used by Amazon Route 53 health checkers to check the health of your resources, send a GET request to the 2013-04-01/checkeripranges resource. You can use these IP addresses to configure router and firewall rules to allow health checkers to check the health of your resources.
Request Syntax
client.get_checker_ip_ranges()
dict
Response Syntax
{
'CheckerIpRanges': [
'string',
]
}
Response Structure
(dict) --
A complex type that contains the CheckerIpRanges element.
CheckerIpRanges (list) --
A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.
(string) --
This action creates a new hosted zone.
To create a new hosted zone, send a POST request to the 2013-04-01/hostedzone resource. The request body must include an XML document with a CreateHostedZoneRequest element. The response returns the CreateHostedZoneResponse element that contains metadata about the hosted zone.
Route 53 automatically creates a default SOA record and four NS records for the zone. The NS records in the hosted zone are the name servers you give your registrar to delegate your domain to. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide .
When you create a zone, its initial status is PENDING . This means that it is not yet available on all DNS servers. The status of the zone changes to INSYNC when the NS and SOA records are available on all Route 53 DNS servers.
Request Syntax
client.create_hosted_zone(
Name='string',
CallerReference='string',
HostedZoneConfig={
'Comment': 'string'
}
)
string
[REQUIRED]
The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet .
string
[REQUIRED]
A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a hosted zone. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration_01 .
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
dict
A complex type that contains an optional comment about your hosted zone.
Comment (string) --
An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
dict
Response Syntax
{
'HostedZone': {
'Id': 'string',
'Name': 'string',
'CallerReference': 'string',
'Config': {
'Comment': 'string'
},
'ResourceRecordSetCount': 123
},
'ChangeInfo': {
'Id': 'string',
'Status': 'PENDING'|'INSYNC',
'SubmittedAt': datetime(2015, 1, 1),
'Comment': 'string'
},
'DelegationSet': {
'NameServers': [
'string',
]
},
'Location': 'string'
}
Response Structure
(dict) --
A complex type containing the response information for the new hosted zone.
HostedZone (dict) --
A complex type that contains identifying information about the hosted zone.
Id (string) --
The ID of the specified hosted zone.
Name (string) --
The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet .
CallerReference (string) --
A unique string that identifies the request to create the hosted zone.
Config (dict) --
A complex type that contains the Comment element.
Comment (string) --
An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
ResourceRecordSetCount (integer) --
Total number of resource record sets in the hosted zone.
ChangeInfo (dict) --
A complex type that contains information about the request to create a hosted zone. This includes an ID that you use when you call the GetChange action to get the current status of the change request.
Id (string) --
The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
Status (string) --
The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
SubmittedAt (datetime) --
The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ , as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
Comment (string) --
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
DelegationSet (dict) --
A complex type that contains name server information.
NameServers (list) --
A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.
(string) --
Location (string) --
The unique URL representing the new hosted zone.
Request Syntax
client.list_geo_locations(
StartContinentCode='string',
StartCountryCode='string',
StartSubdivisionCode='string',
MaxItems='string'
)
string
The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
string
The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
string
The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
string
The maximum number of geo locations you want in the response body.
dict
Response Syntax
{
'GeoLocationDetailsList': [
{
'ContinentCode': 'string',
'ContinentName': 'string',
'CountryCode': 'string',
'CountryName': 'string',
'SubdivisionCode': 'string',
'SubdivisionName': 'string'
},
],
'IsTruncated': True|False,
'NextContinentCode': 'string',
'NextCountryCode': 'string',
'NextSubdivisionCode': 'string',
'MaxItems': 'string'
}
Response Structure
(dict) --
A complex type that contains information about the geo locations that are returned by the request and information about the response.
GeoLocationDetailsList (list) --
A complex type that contains information about the geo locations that are returned by the request.
(dict) --
A complex type that contains information about a GeoLocation .
ContinentCode (string) --
The code for a continent geo location. Note: only continent locations have a continent code.
ContinentName (string) --
The name of the continent. This element is only present if ContinentCode is also present.
CountryCode (string) --
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
CountryName (string) --
The name of the country. This element is only present if CountryCode is also present.
SubdivisionCode (string) --
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
SubdivisionName (string) --
The name of the subdivision. This element is only present if SubdivisionCode is also present.
IsTruncated (boolean) --
A flag that indicates whether there are more geo locations to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the values included in the ListGeoLocationsResponse$NextContinentCode, ListGeoLocationsResponse$NextCountryCode and ListGeoLocationsResponse$NextSubdivisionCode elements.
Valid Values: true | false
NextContinentCode (string) --
If the results were truncated, the continent code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is a continent location.
NextCountryCode (string) --
If the results were truncated, the country code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is not a continent location.
NextSubdivisionCode (string) --
If the results were truncated, the subdivision code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location has a subdivision.
MaxItems (string) --
The maximum number of records you requested. The maximum value of MaxItems is 100.
To retrieve a list of your hosted zones, send a GET request to the 2013-04-01/hostedzone resource. The response to this request includes a HostedZones element with zero, one, or multiple HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with.
Request Syntax
client.list_hosted_zones(
Marker='string',
MaxItems='string'
)
string
If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
string
Specify the maximum number of hosted zones to return per page of results.
dict
Response Syntax
{
'HostedZones': [
{
'Id': 'string',
'Name': 'string',
'CallerReference': 'string',
'Config': {
'Comment': 'string'
},
'ResourceRecordSetCount': 123
},
],
'Marker': 'string',
'IsTruncated': True|False,
'NextMarker': 'string',
'MaxItems': 'string'
}
Response Structure
(dict) --
A complex type that contains the response for the request.
HostedZones (list) --
A complex type that contains information about the hosted zones associated with the current AWS account.
(dict) --
A complex type that contain information about the specified hosted zone.
Id (string) --
The ID of the specified hosted zone.
Name (string) --
The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet .
CallerReference (string) --
A unique string that identifies the request to create the hosted zone.
Config (dict) --
A complex type that contains the Comment element.
Comment (string) --
An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
ResourceRecordSetCount (integer) --
Total number of resource record sets in the hosted zone.
Marker (string) --
If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
IsTruncated (boolean) --
A flag indicating whether there are more hosted zones to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.
Valid Values: true | false
NextMarker (string) --
Indicates where to continue listing hosted zones. If ListHostedZonesResponse$IsTruncated is true , make another request to ListHostedZones and include the value of the NextMarker element in the Marker element to get the next page of results.
MaxItems (string) --
The maximum number of hosted zones to be included in the response body. If the number of hosted zones associated with this AWS account exceeds MaxItems , the value of ListHostedZonesResponse$IsTruncated in the response is true . Call ListHostedZones again and specify the value of ListHostedZonesResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.
To retrieve a count of all your health checks, send a GET request to the 2013-04-01/healthcheckcount resource.
Request Syntax
client.get_health_check_count()
dict
Response Syntax
{
'HealthCheckCount': 123
}
Response Structure
(dict) --
A complex type that contains the count of health checks associated with the current AWS account.
HealthCheckCount (integer) --
The number of health checks associated with the current AWS account.
This action creates a new health check.
To create a new health check, send a POST request to the 2013-04-01/healthcheck resource. The request body must include an XML document with a CreateHealthCheckRequest element. The response returns the CreateHealthCheckResponse element that contains metadata about the health check.
Request Syntax
client.create_health_check(
CallerReference='string',
HealthCheckConfig={
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123
}
)
string
[REQUIRED]
A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a health check. CallerReference can be any unique string; you might choose to use a string that identifies your project.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
dict
[REQUIRED]
A complex type that contains health check configuration.
IPAddress (string) --
IP Address of the instance being checked.
Port (integer) --
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
Type (string) -- [REQUIRED]
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
ResourcePath (string) --
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
FullyQualifiedDomainName (string) --
Fully qualified domain name of the instance to be health checked.
SearchString (string) --
A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
RequestInterval (integer) --
The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
dict
Response Syntax
{
'HealthCheck': {
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123
},
'HealthCheckVersion': 123
},
'Location': 'string'
}
Response Structure
(dict) --
A complex type containing the response information for the new health check.
HealthCheck (dict) --
A complex type that contains identifying information about the health check.
Id (string) --
The ID of the specified health check.
CallerReference (string) --
A unique string that identifies the request to create the health check.
HealthCheckConfig (dict) --
A complex type that contains the health check configuration.
IPAddress (string) --
IP Address of the instance being checked.
Port (integer) --
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
Type (string) --
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
ResourcePath (string) --
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
FullyQualifiedDomainName (string) --
Fully qualified domain name of the instance to be health checked.
SearchString (string) --
A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
RequestInterval (integer) --
The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
HealthCheckVersion (integer) --
The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
Location (string) --
The unique URL representing the new health check.
This action deletes a hosted zone. To delete a hosted zone, send a DELETE request to the 2013-04-01/hostedzone/hosted zone ID resource.
For more information about deleting a hosted zone, see Deleting a Hosted Zone in the Amazon Route 53 Developer Guide .
Warning
You can delete a hosted zone only if there are no resource record sets other than the default SOA record and NS resource record sets. If your hosted zone contains other resource record sets, you must delete them before you can delete your hosted zone. If you try to delete a hosted zone that contains other resource record sets, Route 53 will deny your request with a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.
Request Syntax
client.delete_hosted_zone(
Id='string'
)
string
[REQUIRED]
The ID of the request. Include this ID in a call to GetChange to track when the change has propagated to all Route 53 DNS servers.
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 information for the request.
ChangeInfo (dict) --
A complex type that contains the ID, the status, and the date and time of your delete request.
Id (string) --
The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
Status (string) --
The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
SubmittedAt (datetime) --
The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ , as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
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.
To retrieve a list of your health checks, send a GET request to the 2013-04-01/healthcheck resource. The response to this request includes a HealthChecks element with zero, one, or multiple HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.
Request Syntax
client.list_health_checks(
Marker='string',
MaxItems='string'
)
string
If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
string
Specify the maximum number of health checks to return per page of results.
dict
Response Syntax
{
'HealthChecks': [
{
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123
},
'HealthCheckVersion': 123
},
],
'Marker': 'string',
'IsTruncated': True|False,
'NextMarker': 'string',
'MaxItems': 'string'
}
Response Structure
(dict) --
A complex type that contains the response for the request.
HealthChecks (list) --
A complex type that contains information about the health checks associated with the current AWS account.
(dict) --
A complex type that contains identifying information about the health check.
Id (string) --
The ID of the specified health check.
CallerReference (string) --
A unique string that identifies the request to create the health check.
HealthCheckConfig (dict) --
A complex type that contains the health check configuration.
IPAddress (string) --
IP Address of the instance being checked.
Port (integer) --
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
Type (string) --
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
ResourcePath (string) --
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
FullyQualifiedDomainName (string) --
Fully qualified domain name of the instance to be health checked.
SearchString (string) --
A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
RequestInterval (integer) --
The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
HealthCheckVersion (integer) --
The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
Marker (string) --
If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
IsTruncated (boolean) --
A flag indicating whether there are more health checks to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.
Valid Values: true | false
NextMarker (string) --
Indicates where to continue listing health checks. If ListHealthChecksResponse$IsTruncated is true , make another request to ListHealthChecks and include the value of the NextMarker element in the Marker element to get the next page of results.
MaxItems (string) --
The maximum number of health checks to be included in the response body. If the number of health checks associated with this AWS account exceeds MaxItems , the value of ListHealthChecksResponse$IsTruncated in the response is true . Call ListHealthChecks again and specify the value of ListHealthChecksResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.
This action updates an existing health check.
To update a health check, send a POST request to the 2013-05-27/healthcheck/health check ID resource. The request body must include an XML document with an UpdateHealthCheckRequest element. The response returns an UpdateHealthCheckResponse element, which contains metadata about the health check.
Request Syntax
client.update_health_check(
HealthCheckId='string',
HealthCheckVersion=123,
IPAddress='string',
Port=123,
ResourcePath='string',
FullyQualifiedDomainName='string',
SearchString='string',
FailureThreshold=123
)
string
[REQUIRED]
The ID of the health check to update.
integer
Optional. When you specify a health check version, Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using HealthCheckVersion lets you prevent overwriting another change to the health check.
string
The IP address of the resource that you want to check.
Specify this value only if you want to change it.
integer
The port on which you want Route 53 to open a connection to perform health checks.
Specify this value only if you want to change it.
string
The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.
Specify this value only if you want to change it.
string
Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
string
If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH , the string that you want Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.
Specify this value only if you want to change it.
integer
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
dict
Response Syntax
{
'HealthCheck': {
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123
},
'HealthCheckVersion': 123
}
}
Response Structure
(dict) --
HealthCheck (dict) --
A complex type that contains identifying information about the health check.
Id (string) --
The ID of the specified health check.
CallerReference (string) --
A unique string that identifies the request to create the health check.
HealthCheckConfig (dict) --
A complex type that contains the health check configuration.
IPAddress (string) --
IP Address of the instance being checked.
Port (integer) --
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
Type (string) --
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
ResourcePath (string) --
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
FullyQualifiedDomainName (string) --
Fully qualified domain name of the instance to be health checked.
SearchString (string) --
A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
RequestInterval (integer) --
The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
HealthCheckVersion (integer) --
The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
This action returns the current status of a change batch request. The status is one of the following values:
PENDING indicates that the changes in this request have not replicated to all Route 53 DNS servers. This is the initial status of all change batch requests.
INSYNC indicates that the changes have replicated to all Amazon Route 53 DNS servers.
Request Syntax
client.get_change(
Id='string'
)
string
[REQUIRED]
The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.
dict
Response Syntax
{
'ChangeInfo': {
'Id': 'string',
'Status': 'PENDING'|'INSYNC',
'SubmittedAt': datetime(2015, 1, 1),
'Comment': 'string'
}
}
Response Structure
(dict) --
A complex type that contains the ChangeInfo element.
ChangeInfo (dict) --
A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the date and time of the request.
Id (string) --
The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
Status (string) --
The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
SubmittedAt (datetime) --
The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ , as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
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.
To retrieve the health check, send a GET request to the 2013-04-01/healthcheck/health check ID resource.
Request Syntax
client.get_health_check(
HealthCheckId='string'
)
string
[REQUIRED]
The ID of the health check to retrieve.
dict
Response Syntax
{
'HealthCheck': {
'Id': 'string',
'CallerReference': 'string',
'HealthCheckConfig': {
'IPAddress': 'string',
'Port': 123,
'Type': 'HTTP'|'HTTPS'|'HTTP_STR_MATCH'|'HTTPS_STR_MATCH'|'TCP',
'ResourcePath': 'string',
'FullyQualifiedDomainName': 'string',
'SearchString': 'string',
'RequestInterval': 123,
'FailureThreshold': 123
},
'HealthCheckVersion': 123
}
}
Response Structure
(dict) --
A complex type containing information about the specified health check.
HealthCheck (dict) --
A complex type that contains the information about the specified health check.
Id (string) --
The ID of the specified health check.
CallerReference (string) --
A unique string that identifies the request to create the health check.
HealthCheckConfig (dict) --
A complex type that contains the health check configuration.
IPAddress (string) --
IP Address of the instance being checked.
Port (integer) --
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
Type (string) --
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
ResourcePath (string) --
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
FullyQualifiedDomainName (string) --
Fully qualified domain name of the instance to be health checked.
SearchString (string) --
A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
RequestInterval (integer) --
The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
HealthCheckVersion (integer) --
The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
Imagine all the resource record sets in a zone listed out in front of you. Imagine them sorted lexicographically first by DNS name (with the labels reversed, like "com.amazon.www" for example), and secondarily, lexicographically by record type. This operation retrieves at most MaxItems resource record sets from this list, in order, starting at a position specified by the Name and Type arguments:
If both Name and Type are omitted, this means start the results at the first RRSET in the HostedZone.
If Name is specified but Type is omitted, this means start the results at the first RRSET in the list whose name is greater than or equal to Name.
If both Name and Type are specified, this means start the results at the first RRSET in the list whose name is greater than or equal to Name and whose type is greater than or equal to Type.
It is an error to specify the Type but not the Name.
Use ListResourceRecordSets to retrieve a single known record set by specifying the record set's name and type, and setting MaxItems = 1
To retrieve all the records in a HostedZone, first pause any processes making calls to ChangeResourceRecordSets. Initially call ListResourceRecordSets without a Name and Type to get the first page of record sets. For subsequent calls, set Name and Type to the NextName and NextType values returned by the previous response.
In the presence of concurrent ChangeResourceRecordSets calls, there is no consistency of results across calls to ListResourceRecordSets. The only way to get a consistent multi-page snapshot of all RRSETs in a zone is to stop making changes while pagination is in progress.
However, the results from ListResourceRecordSets are consistent within a page. If MakeChange calls are taking place concurrently, the result of each one will either be completely visible in your results or not at all. You will not see partial changes, or changes that do not ultimately succeed. (This follows from the fact that MakeChange is atomic)
The results from ListResourceRecordSets are strongly consistent with ChangeResourceRecordSets. To be precise, if a single process makes a call to ChangeResourceRecordSets and receives a successful response, the effects of that change will be visible in a subsequent call to ListResourceRecordSets by that process.
Request Syntax
client.list_resource_record_sets(
HostedZoneId='string',
StartRecordName='string',
StartRecordType='SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'PTR'|'SRV'|'SPF'|'AAAA',
StartRecordIdentifier='string',
MaxItems='string'
)
string
[REQUIRED]
The ID of the hosted zone that contains the resource record sets that you want to get.
string
The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.
string
The DNS type at which to begin the listing of resource record sets.
Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT
Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT
Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT
Values for Alias Resource Record Sets: A | AAAA
Constraint: Specifying type without specifying name returns an InvalidInput error.
string
Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.
string
The maximum number of records you want in the response body.
dict
Response Syntax
{
'ResourceRecordSets': [
{
'Name': 'string',
'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'PTR'|'SRV'|'SPF'|'AAAA',
'SetIdentifier': 'string',
'Weight': 123,
'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1'|'cn-north-1',
'GeoLocation': {
'ContinentCode': 'string',
'CountryCode': 'string',
'SubdivisionCode': 'string'
},
'Failover': 'PRIMARY'|'SECONDARY',
'TTL': 123,
'ResourceRecords': [
{
'Value': 'string'
},
],
'AliasTarget': {
'HostedZoneId': 'string',
'DNSName': 'string',
'EvaluateTargetHealth': True|False
},
'HealthCheckId': 'string'
},
],
'IsTruncated': True|False,
'NextRecordName': 'string',
'NextRecordType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'PTR'|'SRV'|'SPF'|'AAAA',
'NextRecordIdentifier': 'string',
'MaxItems': 'string'
}
Response Structure
(dict) --
A complex type that contains information about the resource record sets that are returned by the request and information about the response.
ResourceRecordSets (list) --
A complex type that contains information about the resource record sets that are returned by the request.
(dict) --
A complex type that contains information about the current resource record set.
Name (string) --
The domain name of the current resource record set.
Type (string) --
The type of the current resource record set.
SetIdentifier (string) --
Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.
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 what portion of traffic for the current resource record set is routed to the associated location.
Region (string) --
Latency-based resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.
GeoLocation (dict) --
Geo location resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.
ContinentCode (string) --
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
CountryCode (string) --
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
SubdivisionCode (string) --
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
Failover (string) --
Failover resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that indicates whether the current resource record set is a primary or secondary resource record set. A failover set may contain at most one resource record set marked as primary and one resource record set marked as secondary. A resource record set marked as primary will be returned if any of the following are true: (1) an associated health check is passing, (2) if the resource record set is an alias with the evaluate target health and at least one target resource record set is healthy, (3) both the primary and secondary resource record set are failing health checks or (4) there is no secondary resource record set. A secondary resource record set will be returned if: (1) the primary is failing a health check and either the secondary is passing a health check or has no associated health check, or (2) there is no primary resource record set.
Valid values: PRIMARY | SECONDARY
TTL (integer) --
The cache time to live for the current resource record set.
ResourceRecords (list) --
A complex type that contains the resource records for the current resource record set.
(dict) --
A complex type that contains the value of the Value element for the current resource record set.
Value (string) --
The value of the Value element for the current resource record set.
AliasTarget (dict) --
Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.
HostedZoneId (string) --
Alias resource record sets only: The value of the hosted zone ID for the AWS resource.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.
DNSName (string) --
Alias resource record sets only: The external DNS name associated with the AWS Resource.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.
EvaluateTargetHealth (boolean) --
Alias resource record sets only: A boolean value that indicates whether this Resource Record Set should respect the health status of any health checks associated with the ALIAS target record which it is linked to.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.
HealthCheckId (string) --
Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.
IsTruncated (boolean) --
A flag that indicates whether there are more resource record sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the ListResourceRecordSetsResponse$NextRecordName element.
Valid Values: true | false
NextRecordName (string) --
If the results were truncated, the name of the next record in the list. This element is present only if ListResourceRecordSetsResponse$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 ListResourceRecordSetsResponse$IsTruncated is true.
NextRecordIdentifier (string) --
Weighted resource record sets only: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.
MaxItems (string) --
The maximum number of records you requested. The maximum value of MaxItems is 100.
This action deletes a health check. To delete a health check, send a DELETE request to the 2013-04-01/healthcheck/health check ID resource.
Warning
You can delete a health check only if there are no resource record sets associated with this health check. If resource record sets are associated with this health check, you must disassociate them before you can delete your health check. If you try to delete a health check that is associated with resource record sets, Route 53 will deny your request with a HealthCheckInUse error. For information about disassociating the records from your health check, see ChangeResourceRecordSets.
Request Syntax
client.delete_health_check(
HealthCheckId='string'
)
string
[REQUIRED]
The ID of the health check to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Empty response for the request.
Request Syntax
client.list_tags_for_resources(
ResourceType='healthcheck',
ResourceIds=[
'string',
]
)
string
[REQUIRED]
The type of the resources. The resource type for health checks is healthcheck .
list
[REQUIRED]
A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.
(string) --
dict
Response Syntax
{
'ResourceTagSets': [
{
'ResourceType': 'healthcheck',
'ResourceId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
A complex type containing tags for the specified resources.
ResourceTagSets (list) --
A list of ResourceTagSet s containing tags associated with the specified resources.
(dict) --
A complex type containing a resource and its associated tags.
ResourceType (string) --
The type of the resource. The resource type for health checks is healthcheck .
ResourceId (string) --
The ID for the specified resource.
Tags (list) --
The tags associated with the specified resource.
(dict) --
A single tag containing a key and value.
Key (string) --
The key for a Tag .
Value (string) --
The value for a Tag .
Use this action to create or change your authoritative DNS information. To use this action, send a POST request to the 2013-04-01/hostedzone/hosted Zone ID/rrset resource. The request body must include an XML document with a ChangeResourceRecordSetsRequest element.
Changes are a list of change items and are considered transactional. For more information on transactional changes, also known as change batches, see Creating, Changing, and Deleting Resource Record Sets Using the Route 53 API in the Amazon Route 53 Developer Guide .
Warning
Due to the nature of transactional changes, you cannot delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Route 53 returns an InvalidChangeBatch error.
In response to a ChangeResourceRecordSets request, your DNS data is changed on all Route 53 DNS servers. Initially, the status of a change is PENDING . This means the change has not yet propagated to all the authoritative Route 53 DNS servers. When the change is propagated to all hosts, the change returns a status of INSYNC .
Note the following limitations on a ChangeResourceRecordSets request:
A request cannot contain more than 100 Change elements.
A request cannot contain more than 1000 ResourceRecord elements.
The sum of the number of characters (including spaces) in all Value elements in a request cannot exceed 32,000 characters.
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'|'PTR'|'SRV'|'SPF'|'AAAA',
'SetIdentifier': 'string',
'Weight': 123,
'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1'|'cn-north-1',
'GeoLocation': {
'ContinentCode': 'string',
'CountryCode': 'string',
'SubdivisionCode': 'string'
},
'Failover': 'PRIMARY'|'SECONDARY',
'TTL': 123,
'ResourceRecords': [
{
'Value': 'string'
},
],
'AliasTarget': {
'HostedZoneId': 'string',
'DNSName': 'string',
'EvaluateTargetHealth': True|False
},
'HealthCheckId': 'string'
}
},
]
}
)
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]
A complex type that contains one Change element for each resource record set that you want to create or delete.
(dict) --
A complex type that contains the information for each change in a change batch request.
Action (string) -- [REQUIRED]
The action to perform.
Valid values: CREATE | DELETE | UPSERT
ResourceRecordSet (dict) -- [REQUIRED]
Information about the resource record set to create or delete.
Name (string) -- [REQUIRED]
The domain name of the current resource record set.
Type (string) -- [REQUIRED]
The type of the current resource record set.
SetIdentifier (string) --
Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.
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 what portion of traffic for the current resource record set is routed to the associated location.
Region (string) --
Latency-based resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.
GeoLocation (dict) --
Geo location resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.
ContinentCode (string) --
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
CountryCode (string) --
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
SubdivisionCode (string) --
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
Failover (string) --
Failover resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that indicates whether the current resource record set is a primary or secondary resource record set. A failover set may contain at most one resource record set marked as primary and one resource record set marked as secondary. A resource record set marked as primary will be returned if any of the following are true: (1) an associated health check is passing, (2) if the resource record set is an alias with the evaluate target health and at least one target resource record set is healthy, (3) both the primary and secondary resource record set are failing health checks or (4) there is no secondary resource record set. A secondary resource record set will be returned if: (1) the primary is failing a health check and either the secondary is passing a health check or has no associated health check, or (2) there is no primary resource record set.
Valid values: PRIMARY | SECONDARY
TTL (integer) --
The cache time to live for the current resource record set.
ResourceRecords (list) --
A complex type that contains the resource records for the current resource record set.
(dict) --
A complex type that contains the value of the Value element for the current resource record set.
Value (string) -- [REQUIRED]
The value of the Value element for the current resource record set.
AliasTarget (dict) --
Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.
HostedZoneId (string) -- [REQUIRED]
Alias resource record sets only: The value of the hosted zone ID for the AWS resource.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.
DNSName (string) -- [REQUIRED]
Alias resource record sets only: The external DNS name associated with the AWS Resource.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.
EvaluateTargetHealth (boolean) -- [REQUIRED]
Alias resource record sets only: A boolean value that indicates whether this Resource Record Set should respect the health status of any health checks associated with the ALIAS target record which it is linked to.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.
HealthCheckId (string) --
Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.
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. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
Status (string) --
The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
SubmittedAt (datetime) --
The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ , as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
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.
To retrieve the delegation set for a hosted zone, send a GET request to the 2013-04-01/hostedzone/hosted zone ID resource. The delegation set is the four Route 53 name servers that were assigned to the hosted zone when you created it.
Request Syntax
client.get_hosted_zone(
Id='string'
)
string
[REQUIRED]
The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.
dict
Response Syntax
{
'HostedZone': {
'Id': 'string',
'Name': 'string',
'CallerReference': 'string',
'Config': {
'Comment': 'string'
},
'ResourceRecordSetCount': 123
},
'DelegationSet': {
'NameServers': [
'string',
]
}
}
Response Structure
(dict) --
A complex type containing information about the specified hosted zone.
HostedZone (dict) --
A complex type that contains the information about the specified hosted zone.
Id (string) --
The ID of the specified hosted zone.
Name (string) --
The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet .
CallerReference (string) --
A unique string that identifies the request to create the hosted zone.
Config (dict) --
A complex type that contains the Comment element.
Comment (string) --
An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
ResourceRecordSetCount (integer) --
Total number of resource record sets in the hosted zone.
DelegationSet (dict) --
A complex type that contains information about the name servers for the specified hosted zone.
NameServers (list) --
A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.
(string) --
Request Syntax
client.change_tags_for_resource(
ResourceType='healthcheck',
ResourceId='string',
AddTags=[
{
'Key': 'string',
'Value': 'string'
},
],
RemoveTagKeys=[
'string',
]
)
string
[REQUIRED]
The type of the resource. The resource type for health checks is healthcheck .
string
[REQUIRED]
The ID of the resource for which you want to add, change, or delete tags.
list
A complex type that contains a list of Tag elements. Each Tag element identifies a tag that you want to add or update for the specified resource.
(dict) --
A single tag containing a key and value.
Key (string) --
The key for a Tag .
Value (string) --
The value for a Tag .
list
A list of Tag keys that you want to remove from the specified resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Empty response for the request.
Request Syntax
client.list_tags_for_resource(
ResourceType='healthcheck',
ResourceId='string'
)
string
[REQUIRED]
The type of the resource. The resource type for health checks is healthcheck .
string
[REQUIRED]
The ID of the resource for which you want to retrieve tags.
dict
Response Syntax
{
'ResourceTagSet': {
'ResourceType': 'healthcheck',
'ResourceId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
A complex type containing tags for the specified resource.
ResourceTagSet (dict) --
A ResourceTagSet containing tags associated with the specified resource.
ResourceType (string) --
The type of the resource. The resource type for health checks is healthcheck .
ResourceId (string) --
The ID for the specified resource.
Tags (list) --
The tags associated with the specified resource.
(dict) --
A single tag containing a key and value.
Key (string) --
The key for a Tag .
Value (string) --
The value for a Tag .
Request Syntax
client.get_geo_location(
ContinentCode='string',
CountryCode='string',
SubdivisionCode='string'
)
string
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
string
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
string
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
dict
Response Syntax
{
'GeoLocationDetails': {
'ContinentCode': 'string',
'ContinentName': 'string',
'CountryCode': 'string',
'CountryName': 'string',
'SubdivisionCode': 'string',
'SubdivisionName': 'string'
}
}
Response Structure
(dict) --
A complex type containing information about the specified geo location.
GeoLocationDetails (dict) --
A complex type that contains the information about the specified geo location.
ContinentCode (string) --
The code for a continent geo location. Note: only continent locations have a continent code.
ContinentName (string) --
The name of the continent. This element is only present if ContinentCode is also present.
CountryCode (string) --
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
CountryName (string) --
The name of the country. This element is only present if CountryCode is also present.
SubdivisionCode (string) --
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
SubdivisionName (string) --
The name of the subdivision. This element is only present if SubdivisionCode is also present.