{ "api_version": "2013-04-01", "type": "rest-xml", "signature_version": "v3https", "service_full_name": "Amazon Route 53", "service_abbreviation": "Route 53", "global_endpoint": "route53.amazonaws.com", "endpoint_prefix": "route53", "xmlnamespace": "https://route53.amazonaws.com/doc/2013-04-01/", "documentation": "\n ", "operations": { "ChangeResourceRecordSets": { "name": "ChangeResourceRecordSets", "http": { "method": "POST", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/rrset/" }, "input": { "shape_name": "ChangeResourceRecordSetsRequest", "type": "structure", "members": { "HostedZoneId": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n
The ID of the hosted zone that contains the resource record sets that you want to change.
\n ", "required": true, "location": "uri" }, "ChangeBatch": { "shape_name": "ChangeBatch", "type": "structure", "members": { "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\nOptional: Any comments you want to include about a change batch request.
\n " }, "Changes": { "shape_name": "Changes", "type": "list", "members": { "shape_name": "Change", "type": "structure", "members": { "Action": { "shape_name": "ChangeAction", "type": "string", "enum": [ "CREATE", "DELETE", "UPSERT" ], "documentation": "\nThe action to perform.
\nValid values: CREATE
| DELETE
| UPSERT
The domain name of the current resource record set.
\n ", "required": true }, "Type": { "shape_name": "RRType", "type": "string", "enum": [ "SOA", "A", "TXT", "NS", "CNAME", "MX", "PTR", "SRV", "SPF", "AAAA" ], "documentation": "\nThe type of the current resource record set.
\n ", "required": true }, "SetIdentifier": { "shape_name": "ResourceRecordSetIdentifier", "type": "string", "min_length": 1, "max_length": 128, "documentation": "\nWeighted, Regional, 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.
\n " }, "Weight": { "shape_name": "ResourceRecordSetWeight", "type": "long", "min_length": 0, "max_length": 255, "documentation": "\nWeighted 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.
\n " }, "Region": { "shape_name": "ResourceRecordSetRegion", "type": "string", "min_length": 1, "max_length": 64, "enum": [ "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" ], "documentation": "\nRegional 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.
\n " }, "Failover": { "shape_name": "ResourceRecordSetFailover", "type": "string", "enum": [ "PRIMARY", "SECONDARY" ], "documentation": "\nFailover 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.
\nValid values: PRIMARY
| SECONDARY
The cache time to live for the current resource record set.
\n " }, "ResourceRecords": { "shape_name": "ResourceRecords", "type": "list", "members": { "shape_name": "ResourceRecord", "type": "structure", "members": { "Value": { "shape_name": "RData", "type": "string", "max_length": 4000, "documentation": "\nThe value of the Value
element for the current resource record set.
A complex type that contains the value of the Value
element for the current resource record set.
A complex type that contains the resource records for the current resource record set.
\n " }, "AliasTarget": { "shape_name": "AliasTarget", "type": "structure", "members": { "HostedZoneId": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\nAlias resource record sets only: The value of the hosted zone ID for the AWS resource.
\nFor more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.\n ", "required": true }, "DNSName": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\nAlias resource record sets only: The external DNS name associated with the AWS Resource.
\nFor more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.\n ", "required": true }, "EvaluateTargetHealth": { "shape_name": "AliasHealthEnabled", "type": "boolean", "documentation": "\nAlias 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.
\nFor more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.\n ", "required": true } }, "member_order": [ "HostedZoneId", "DNSName", "EvaluateTargetHealth" ], "documentation": "\nAlias resource record sets only: Information about the AWS resource to which you are redirecting traffic.
\n " }, "HealthCheckId": { "shape_name": "HealthCheckId", "type": "string", "max_length": 64, "documentation": "\nHealth 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.
\n " } }, "member_order": [ "Name", "Type", "SetIdentifier", "Weight", "Region", "Failover", "TTL", "ResourceRecords", "AliasTarget", "HealthCheckId" ], "documentation": "\nInformation about the resource record set to create or delete.
\n ", "required": true } }, "member_order": [ "Action", "ResourceRecordSet" ], "documentation": "\nA complex type that contains the information for each change in a change batch request.
\n ", "xmlname": "Change" }, "min_length": 1, "documentation": "\nA complex type that contains one Change
element for each resource record set that you want to create or delete.
A complex type that contains an optional comment and the Changes
element.
A complex type that contains a change batch.
\n " }, "output": { "shape_name": "ChangeResourceRecordSetsResponse", "type": "structure", "members": { "ChangeInfo": { "shape_name": "ChangeInfo", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\nThe ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
\n ", "required": true }, "Status": { "shape_name": "ChangeStatus", "type": "string", "enum": [ "PENDING", "INSYNC" ], "documentation": "\nThe 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
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.
A complex type that describes change information about changes made to your hosted zone.
\nThis element contains an ID that you use when performing a GetChange action to get detailed information about the change.
\n " } }, "member_order": [ "Id", "Status", "SubmittedAt", "Comment" ], "documentation": "\nA complex type that contains information about changes made to your hosted zone.
\nThis element contains an ID that you use when performing a GetChange action to get detailed information about the change.
\n ", "required": true } }, "member_order": [ "ChangeInfo" ], "documentation": "\nA complex type containing the response for the request.
\n " }, "errors": [ { "shape_name": "NoSuchHostedZone", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "NoSuchHealthCheck", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nThe health check you are trying to get or delete does not exist.
\n " }, { "shape_name": "InvalidChangeBatch", "type": "structure", "members": { "messages": { "shape_name": "ErrorMessages", "type": "list", "members": { "shape_name": "ErrorMessage", "type": "string", "documentation": null, "xmlname": "Message" }, "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nThis error contains a list of one or more error messages. Each error message indicates one error in the change batch. For more information, see Example InvalidChangeBatch Errors.
\n " }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " }, { "shape_name": "PriorRequestNotComplete", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\nThe request was rejected because Route 53 was still processing a prior request.
\n " } ], "documentation": "\nUse 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.
\nInvalidChangeBatch
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.
\n- A request cannot contain more than 1000 ResourceRecord elements.
\nThe sum of the number of characters (including spaces) in all Value
elements in a request cannot exceed 32,000 characters.
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.
\n ", "required": true }, "HealthCheckConfig": { "shape_name": "HealthCheckConfig", "type": "structure", "members": { "IPAddress": { "shape_name": "IPAddress", "type": "string", "max_length": 15, "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", "documentation": "\nIP Address of the instance being checked.
\n ", "required": true }, "Port": { "shape_name": "Port", "type": "integer", "min_length": 1, "max_length": 65535, "documentation": "\nPort 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.
\n " }, "Type": { "shape_name": "HealthCheckType", "type": "string", "enum": [ "HTTP", "HTTPS", "HTTP_STR_MATCH", "HTTPS_STR_MATCH", "TCP" ], "documentation": "\nThe type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
\n ", "required": true }, "ResourcePath": { "shape_name": "ResourcePath", "type": "string", "max_length": 255, "documentation": "\nPath 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.
\n " }, "FullyQualifiedDomainName": { "shape_name": "FullyQualifiedDomainName", "type": "string", "max_length": 255, "documentation": "\nFully qualified domain name of the instance to be health checked.
\n " }, "SearchString": { "shape_name": "SearchString", "type": "string", "max_length": 255, "documentation": "\nA string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
\n " }, "RequestInterval": { "shape_name": "RequestInterval", "type": "integer", "min_length": 10, "max_length": 30, "documentation": "\nThe 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.
\nEach Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
\n " }, "FailureThreshold": { "shape_name": "FailureThreshold", "type": "integer", "min_length": 1, "max_length": 10, "documentation": "\nThe number of consecutive health checks that an endpoint must pass or fail for Route 53 to\n change the current status of the endpoint from unhealthy to healthy or vice versa.
\nValid values are integers between 1 and 10. For more information,\n see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the\n Amazon Route 53 Developer Guide.
\n " } }, "member_order": [ "IPAddress", "Port", "Type", "ResourcePath", "FullyQualifiedDomainName", "SearchString", "RequestInterval", "FailureThreshold" ], "documentation": "\nA complex type that contains health check configuration.
\n ", "required": true } }, "member_order": [ "CallerReference", "HealthCheckConfig" ], "documentation": "\n>A complex type that contains information about the request to create a health check.
\n " }, "output": { "shape_name": "CreateHealthCheckResponse", "type": "structure", "members": { "HealthCheck": { "shape_name": "HealthCheck", "type": "structure", "members": { "Id": { "shape_name": "HealthCheckId", "type": "string", "max_length": 64, "documentation": "\nThe ID of the specified health check.
\n ", "required": true }, "CallerReference": { "shape_name": "HealthCheckNonce", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\nA unique string that identifies the request to create the health check.
\n ", "required": true }, "HealthCheckConfig": { "shape_name": "HealthCheckConfig", "type": "structure", "members": { "IPAddress": { "shape_name": "IPAddress", "type": "string", "max_length": 15, "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", "documentation": "\nIP Address of the instance being checked.
\n ", "required": true }, "Port": { "shape_name": "Port", "type": "integer", "min_length": 1, "max_length": 65535, "documentation": "\nPort 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.
\n " }, "Type": { "shape_name": "HealthCheckType", "type": "string", "enum": [ "HTTP", "HTTPS", "HTTP_STR_MATCH", "HTTPS_STR_MATCH", "TCP" ], "documentation": "\nThe type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
\n ", "required": true }, "ResourcePath": { "shape_name": "ResourcePath", "type": "string", "max_length": 255, "documentation": "\nPath 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.
\n " }, "FullyQualifiedDomainName": { "shape_name": "FullyQualifiedDomainName", "type": "string", "max_length": 255, "documentation": "\nFully qualified domain name of the instance to be health checked.
\n " }, "SearchString": { "shape_name": "SearchString", "type": "string", "max_length": 255, "documentation": "\nA string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
\n " }, "RequestInterval": { "shape_name": "RequestInterval", "type": "integer", "min_length": 10, "max_length": 30, "documentation": "\nThe 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.
\nEach Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
\n " }, "FailureThreshold": { "shape_name": "FailureThreshold", "type": "integer", "min_length": 1, "max_length": 10, "documentation": "\nThe number of consecutive health checks that an endpoint must pass or fail for Route 53 to\n change the current status of the endpoint from unhealthy to healthy or vice versa.
\nValid values are integers between 1 and 10. For more information,\n see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the\n Amazon Route 53 Developer Guide.
\n " } }, "member_order": [ "IPAddress", "Port", "Type", "ResourcePath", "FullyQualifiedDomainName", "SearchString", "RequestInterval", "FailureThreshold" ], "documentation": "\nA complex type that contains the health check configuration.
\n ", "required": true } }, "member_order": [ "Id", "CallerReference", "HealthCheckConfig" ], "documentation": "\nA complex type that contains identifying information about the health check.
\n ", "required": true }, "Location": { "shape_name": "ResourceURI", "type": "string", "max_length": 1024, "documentation": "\nThe unique URL representing the new health check.
\n ", "required": true, "location": "header", "location_name": "Location" } }, "member_order": [ "HealthCheck", "Location" ], "documentation": "\nA complex type containing the response information for the new health check.
\n " }, "errors": [ { "shape_name": "TooManyHealthChecks", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "HealthCheckAlreadyExists", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nThe health check you are trying to create already exists. Route 53 returns this error when a health check has already been created with the specified CallerReference
.
Descriptive message for the error response.
\n " } }, "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " } ], "documentation": "\nThis action creates a new health check.
\n 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.
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.
\nThis 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
.
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.
\n ", "required": true }, "HostedZoneConfig": { "shape_name": "HostedZoneConfig", "type": "structure", "members": { "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\nAn 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.
A complex type that contains an optional comment about your hosted zone.
\n " } }, "member_order": [ "Name", "CallerReference", "HostedZoneConfig" ], "documentation": "\nA complex type that contains information about the request to create a hosted zone.
\n " }, "output": { "shape_name": "CreateHostedZoneResponse", "type": "structure", "members": { "HostedZone": { "shape_name": "HostedZone", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\nThe ID of the specified hosted zone.
\n ", "required": true }, "Name": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\nThe 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.
\nThis 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
.
A unique string that identifies the request to create the hosted zone.
\n ", "required": true }, "Config": { "shape_name": "HostedZoneConfig", "type": "structure", "members": { "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\nAn 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.
A complex type that contains the Comment
element.
Total number of resource record sets in the hosted zone.
\n " } }, "member_order": [ "Id", "Name", "CallerReference", "Config", "ResourceRecordSetCount" ], "documentation": "\nA complex type that contains identifying information about the hosted zone.
\n ", "required": true }, "ChangeInfo": { "shape_name": "ChangeInfo", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\nThe ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
\n ", "required": true }, "Status": { "shape_name": "ChangeStatus", "type": "string", "enum": [ "PENDING", "INSYNC" ], "documentation": "\nThe 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
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.
A complex type that describes change information about changes made to your hosted zone.
\nThis element contains an ID that you use when performing a GetChange action to get detailed information about the change.
\n " } }, "member_order": [ "Id", "Status", "SubmittedAt", "Comment" ], "documentation": "\nA 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.
\n ", "required": true }, "DelegationSet": { "shape_name": "DelegationSet", "type": "structure", "members": { "NameServers": { "shape_name": "DelegationSetNameServers", "type": "list", "members": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": null, "xmlname": "NameServer" }, "min_length": 1, "documentation": "\nA 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.
A complex type that contains name server information.
\n ", "required": true }, "Location": { "shape_name": "ResourceURI", "type": "string", "max_length": 1024, "documentation": "\nThe unique URL representing the new hosted zone.
\n ", "required": true, "location": "header", "location_name": "Location" } }, "member_order": [ "HostedZone", "ChangeInfo", "DelegationSet", "Location" ], "documentation": "\nA complex type containing the response information for the new hosted zone.
\n " }, "errors": [ { "shape_name": "InvalidDomainName", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nThis error indicates that the specified domain name is not valid.
\n " }, { "shape_name": "HostedZoneAlreadyExists", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nThe hosted zone you are trying to create already exists. Route 53 returns this error when a hosted zone has already been created with the specified CallerReference
.
Descriptive message for the error response.
\n " } }, "documentation": "\nThis error indicates that you've reached the maximum number of hosted zones that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.
\n " }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " }, { "shape_name": "DelegationSetNotAvailable", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nRoute 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Route 53 generates this error, you can request an increase to the limit on the Contact Us page.
\n " } ], "documentation": "\nThis action creates a new hosted zone.
\nTo 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.
\nWhen 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.
The ID of the health check to delete.
\n ", "required": true, "location": "uri" } }, "member_order": [ "HealthCheckId" ], "documentation": "\nA complex type containing the request information for delete health check.
\n " }, "output": { "shape_name": "DeleteHealthCheckResponse", "type": "structure", "members": {}, "documentation": "\nEmpty response for the request.
\n " }, "errors": [ { "shape_name": "NoSuchHealthCheck", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nThe health check you are trying to get or delete does not exist.
\n " }, { "shape_name": "HealthCheckInUse", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nThere are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets.
\n " }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " } ], "documentation": "\nThis action deletes a health check. To delete a health check, send a DELETE
request to the 2013-04-01/healthcheck/health check ID
resource.
HealthCheckInUse
error. For information about disassociating the records from your health check, see ChangeResourceRecordSets.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.
\n ", "required": true, "location": "uri" } }, "member_order": [ "Id" ], "documentation": "\nA complex type containing the response information for the delete request.
\n " }, "output": { "shape_name": "DeleteHostedZoneResponse", "type": "structure", "members": { "ChangeInfo": { "shape_name": "ChangeInfo", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\nThe ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
\n ", "required": true }, "Status": { "shape_name": "ChangeStatus", "type": "string", "enum": [ "PENDING", "INSYNC" ], "documentation": "\nThe 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
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.
A complex type that describes change information about changes made to your hosted zone.
\nThis element contains an ID that you use when performing a GetChange action to get detailed information about the change.
\n " } }, "member_order": [ "Id", "Status", "SubmittedAt", "Comment" ], "documentation": "\nA complex type that contains the ID, the status, and the date and time of your delete request.
\n ", "required": true } }, "member_order": [ "ChangeInfo" ], "documentation": "\nA complex type containing the response information for the request.
\n " }, "errors": [ { "shape_name": "NoSuchHostedZone", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "HostedZoneNotEmpty", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nThe hosted zone contains resource record sets in addition to the default NS and SOA resource record sets. Before you can delete the hosted zone, you must delete the additional resource record sets.
\n " }, { "shape_name": "PriorRequestNotComplete", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\nThe request was rejected because Route 53 was still processing a prior request.
\n " }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " } ], "documentation": "\nThis 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.
\nHostedZoneNotEmpty
error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets. 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.
The input for a GetChange request.
\n " }, "output": { "shape_name": "GetChangeResponse", "type": "structure", "members": { "ChangeInfo": { "shape_name": "ChangeInfo", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\nThe ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
\n ", "required": true }, "Status": { "shape_name": "ChangeStatus", "type": "string", "enum": [ "PENDING", "INSYNC" ], "documentation": "\nThe 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
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.
A complex type that describes change information about changes made to your hosted zone.
\nThis element contains an ID that you use when performing a GetChange action to get detailed information about the change.
\n " } }, "member_order": [ "Id", "Status", "SubmittedAt", "Comment" ], "documentation": "\nA 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.
\n ", "required": true } }, "member_order": [ "ChangeInfo" ], "documentation": "\nA complex type that contains the ChangeInfo
element.
Descriptive message for the error response.
\n " } }, "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " } ], "documentation": "\nThis action returns the current status of a change batch request. The status is one of the following values:
\n- 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.
The ID of the health check to retrieve.
\n ", "required": true, "location": "uri" } }, "member_order": [ "HealthCheckId" ], "documentation": "\nA complex type that contains information about the request to get a health check.
\n " }, "output": { "shape_name": "GetHealthCheckResponse", "type": "structure", "members": { "HealthCheck": { "shape_name": "HealthCheck", "type": "structure", "members": { "Id": { "shape_name": "HealthCheckId", "type": "string", "max_length": 64, "documentation": "\nThe ID of the specified health check.
\n ", "required": true }, "CallerReference": { "shape_name": "HealthCheckNonce", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\nA unique string that identifies the request to create the health check.
\n ", "required": true }, "HealthCheckConfig": { "shape_name": "HealthCheckConfig", "type": "structure", "members": { "IPAddress": { "shape_name": "IPAddress", "type": "string", "max_length": 15, "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", "documentation": "\nIP Address of the instance being checked.
\n ", "required": true }, "Port": { "shape_name": "Port", "type": "integer", "min_length": 1, "max_length": 65535, "documentation": "\nPort 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.
\n " }, "Type": { "shape_name": "HealthCheckType", "type": "string", "enum": [ "HTTP", "HTTPS", "HTTP_STR_MATCH", "HTTPS_STR_MATCH", "TCP" ], "documentation": "\nThe type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
\n ", "required": true }, "ResourcePath": { "shape_name": "ResourcePath", "type": "string", "max_length": 255, "documentation": "\nPath 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.
\n " }, "FullyQualifiedDomainName": { "shape_name": "FullyQualifiedDomainName", "type": "string", "max_length": 255, "documentation": "\nFully qualified domain name of the instance to be health checked.
\n " }, "SearchString": { "shape_name": "SearchString", "type": "string", "max_length": 255, "documentation": "\nA string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
\n " }, "RequestInterval": { "shape_name": "RequestInterval", "type": "integer", "min_length": 10, "max_length": 30, "documentation": "\nThe 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.
\nEach Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
\n " }, "FailureThreshold": { "shape_name": "FailureThreshold", "type": "integer", "min_length": 1, "max_length": 10, "documentation": "\nThe number of consecutive health checks that an endpoint must pass or fail for Route 53 to\n change the current status of the endpoint from unhealthy to healthy or vice versa.
\nValid values are integers between 1 and 10. For more information,\n see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the\n Amazon Route 53 Developer Guide.
\n " } }, "member_order": [ "IPAddress", "Port", "Type", "ResourcePath", "FullyQualifiedDomainName", "SearchString", "RequestInterval", "FailureThreshold" ], "documentation": "\nA complex type that contains the health check configuration.
\n ", "required": true } }, "member_order": [ "Id", "CallerReference", "HealthCheckConfig" ], "documentation": "\nA complex type that contains the information about the specified health check.
\n ", "required": true } }, "member_order": [ "HealthCheck" ], "documentation": "\nA complex type containing information about the specified health check.
\n " }, "errors": [ { "shape_name": "NoSuchHealthCheck", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nThe health check you are trying to get or delete does not exist.
\n " }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " }, { "shape_name": "IncompatibleVersion", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\nThe resource you are trying to access is unsupported on this Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.
\n " } ], "documentation": "\n To retrieve the health check, send a GET
request to the 2013-04-01/healthcheck/health check ID
resource.
The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.
\n ", "required": true, "location": "uri" } }, "member_order": [ "Id" ], "documentation": "\nThe input for a GetHostedZone request.
\n " }, "output": { "shape_name": "GetHostedZoneResponse", "type": "structure", "members": { "HostedZone": { "shape_name": "HostedZone", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\nThe ID of the specified hosted zone.
\n ", "required": true }, "Name": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\nThe 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.
\nThis 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
.
A unique string that identifies the request to create the hosted zone.
\n ", "required": true }, "Config": { "shape_name": "HostedZoneConfig", "type": "structure", "members": { "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\nAn 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.
A complex type that contains the Comment
element.
Total number of resource record sets in the hosted zone.
\n " } }, "member_order": [ "Id", "Name", "CallerReference", "Config", "ResourceRecordSetCount" ], "documentation": "\nA complex type that contains the information about the specified hosted zone.
\n ", "required": true }, "DelegationSet": { "shape_name": "DelegationSet", "type": "structure", "members": { "NameServers": { "shape_name": "DelegationSetNameServers", "type": "list", "members": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": null, "xmlname": "NameServer" }, "min_length": 1, "documentation": "\nA 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.
A complex type that contains information about the name servers for the specified hosted zone.
\n ", "required": true } }, "member_order": [ "HostedZone", "DelegationSet" ], "documentation": "\nA complex type containing information about the specified hosted zone.
\n " }, "errors": [ { "shape_name": "NoSuchHostedZone", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " } ], "documentation": "\n 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.
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.
Specify the maximum number of health checks to return per page of results.
\n ", "location": "uri" } }, "member_order": [ "Marker", "MaxItems" ], "documentation": "\n 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 or more HealthCheck
child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems
parameter. You can use the Marker
parameter to control the health check that the list begins with.
MaxItems
to a value greater than 100, Route 53 returns only the first 100.The ID of the specified health check.
\n ", "required": true }, "CallerReference": { "shape_name": "HealthCheckNonce", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\nA unique string that identifies the request to create the health check.
\n ", "required": true }, "HealthCheckConfig": { "shape_name": "HealthCheckConfig", "type": "structure", "members": { "IPAddress": { "shape_name": "IPAddress", "type": "string", "max_length": 15, "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", "documentation": "\nIP Address of the instance being checked.
\n ", "required": true }, "Port": { "shape_name": "Port", "type": "integer", "min_length": 1, "max_length": 65535, "documentation": "\nPort 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.
\n " }, "Type": { "shape_name": "HealthCheckType", "type": "string", "enum": [ "HTTP", "HTTPS", "HTTP_STR_MATCH", "HTTPS_STR_MATCH", "TCP" ], "documentation": "\nThe type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
\n ", "required": true }, "ResourcePath": { "shape_name": "ResourcePath", "type": "string", "max_length": 255, "documentation": "\nPath 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.
\n " }, "FullyQualifiedDomainName": { "shape_name": "FullyQualifiedDomainName", "type": "string", "max_length": 255, "documentation": "\nFully qualified domain name of the instance to be health checked.
\n " }, "SearchString": { "shape_name": "SearchString", "type": "string", "max_length": 255, "documentation": "\nA string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
\n " }, "RequestInterval": { "shape_name": "RequestInterval", "type": "integer", "min_length": 10, "max_length": 30, "documentation": "\nThe 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.
\nEach Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
\n " }, "FailureThreshold": { "shape_name": "FailureThreshold", "type": "integer", "min_length": 1, "max_length": 10, "documentation": "\nThe number of consecutive health checks that an endpoint must pass or fail for Route 53 to\n change the current status of the endpoint from unhealthy to healthy or vice versa.
\nValid values are integers between 1 and 10. For more information,\n see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the\n Amazon Route 53 Developer Guide.
\n " } }, "member_order": [ "IPAddress", "Port", "Type", "ResourcePath", "FullyQualifiedDomainName", "SearchString", "RequestInterval", "FailureThreshold" ], "documentation": "\nA complex type that contains the health check configuration.
\n ", "required": true } }, "member_order": [ "Id", "CallerReference", "HealthCheckConfig" ], "documentation": "\nA complex type that contains identifying information about the health check.
\n ", "xmlname": "HealthCheck" }, "documentation": "\nA complex type that contains information about the health checks associated with the current AWS account.
\n ", "required": true }, "Marker": { "shape_name": "PageMarker", "type": "string", "max_length": 64, "documentation": "\nIf 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.
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
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.
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.
A complex type that contains the response for the request.
\n " }, "errors": [ { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " }, { "shape_name": "IncompatibleVersion", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\nThe resource you are trying to access is unsupported on this Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.
\n " } ], "documentation": "\n 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.
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.
Specify the maximum number of hosted zones to return per page of results.
\n ", "location": "uri" } }, "member_order": [ "Marker", "MaxItems" ], "documentation": "\n 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 or more 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. For more information about listing hosted zones, see Listing the Hosted Zones for an AWS Account in the Amazon Route 53 Developer Guide.
MaxItems
to a value greater than 100, Route 53 returns only the first 100.The ID of the specified hosted zone.
\n ", "required": true }, "Name": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\nThe 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.
\nThis 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
.
A unique string that identifies the request to create the hosted zone.
\n ", "required": true }, "Config": { "shape_name": "HostedZoneConfig", "type": "structure", "members": { "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\nAn 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.
A complex type that contains the Comment
element.
Total number of resource record sets in the hosted zone.
\n " } }, "member_order": [ "Id", "Name", "CallerReference", "Config", "ResourceRecordSetCount" ], "documentation": "\nA complex type that contain information about the specified hosted zone.
\n ", "xmlname": "HostedZone" }, "documentation": "\nA complex type that contains information about the hosted zones associated with the current AWS account.
\n ", "required": true }, "Marker": { "shape_name": "PageMarker", "type": "string", "max_length": 64, "documentation": "\nIf 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.
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
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.
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.
A complex type that contains the response for the request.
\n " }, "errors": [ { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " } ], "documentation": "\n 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.
The ID of the hosted zone that contains the resource record sets that you want to get.
\n ", "required": true, "location": "uri" }, "StartRecordName": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\nThe first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets
request to list.
The DNS type at which to begin the listing of resource record sets.
\nValid 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.
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.
The maximum number of records you want in the response body.
\n ", "location": "uri" } }, "member_order": [ "HostedZoneId", "StartRecordName", "StartRecordType", "StartRecordIdentifier", "MaxItems" ], "documentation": "\nThe input for a ListResourceRecordSets request.
\n " }, "output": { "shape_name": "ListResourceRecordSetsResponse", "type": "structure", "members": { "ResourceRecordSets": { "shape_name": "ResourceRecordSets", "type": "list", "members": { "shape_name": "ResourceRecordSet", "type": "structure", "members": { "Name": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\nThe domain name of the current resource record set.
\n ", "required": true }, "Type": { "shape_name": "RRType", "type": "string", "enum": [ "SOA", "A", "TXT", "NS", "CNAME", "MX", "PTR", "SRV", "SPF", "AAAA" ], "documentation": "\nThe type of the current resource record set.
\n ", "required": true }, "SetIdentifier": { "shape_name": "ResourceRecordSetIdentifier", "type": "string", "min_length": 1, "max_length": 128, "documentation": "\nWeighted, Regional, 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.
\n " }, "Weight": { "shape_name": "ResourceRecordSetWeight", "type": "long", "min_length": 0, "max_length": 255, "documentation": "\nWeighted 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.
\n " }, "Region": { "shape_name": "ResourceRecordSetRegion", "type": "string", "min_length": 1, "max_length": 64, "enum": [ "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" ], "documentation": "\nRegional 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.
\n " }, "Failover": { "shape_name": "ResourceRecordSetFailover", "type": "string", "enum": [ "PRIMARY", "SECONDARY" ], "documentation": "\nFailover 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.
\nValid values: PRIMARY
| SECONDARY
The cache time to live for the current resource record set.
\n " }, "ResourceRecords": { "shape_name": "ResourceRecords", "type": "list", "members": { "shape_name": "ResourceRecord", "type": "structure", "members": { "Value": { "shape_name": "RData", "type": "string", "max_length": 4000, "documentation": "\nThe value of the Value
element for the current resource record set.
A complex type that contains the value of the Value
element for the current resource record set.
A complex type that contains the resource records for the current resource record set.
\n " }, "AliasTarget": { "shape_name": "AliasTarget", "type": "structure", "members": { "HostedZoneId": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\nAlias resource record sets only: The value of the hosted zone ID for the AWS resource.
\nFor more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.\n ", "required": true }, "DNSName": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\nAlias resource record sets only: The external DNS name associated with the AWS Resource.
\nFor more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.\n ", "required": true }, "EvaluateTargetHealth": { "shape_name": "AliasHealthEnabled", "type": "boolean", "documentation": "\nAlias 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.
\nFor more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.\n ", "required": true } }, "member_order": [ "HostedZoneId", "DNSName", "EvaluateTargetHealth" ], "documentation": "\nAlias resource record sets only: Information about the AWS resource to which you are redirecting traffic.
\n " }, "HealthCheckId": { "shape_name": "HealthCheckId", "type": "string", "max_length": 64, "documentation": "\nHealth 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.
\n " } }, "member_order": [ "Name", "Type", "SetIdentifier", "Weight", "Region", "Failover", "TTL", "ResourceRecords", "AliasTarget", "HealthCheckId" ], "documentation": "\nA complex type that contains information about the current resource record set.
\n ", "xmlname": "ResourceRecordSet" }, "documentation": "\nA complex type that contains information about the resource record sets that are returned by the request.
\n ", "required": true }, "IsTruncated": { "shape_name": "PageTruncated", "type": "boolean", "documentation": "\nA 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.
\nValid Values: true
| false
If the results were truncated, the name of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.
\n " }, "NextRecordType": { "shape_name": "RRType", "type": "string", "enum": [ "SOA", "A", "TXT", "NS", "CNAME", "MX", "PTR", "SRV", "SPF", "AAAA" ], "documentation": "\nIf the results were truncated, the type of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.
\n " }, "NextRecordIdentifier": { "shape_name": "ResourceRecordSetIdentifier", "type": "string", "min_length": 1, "max_length": 128, "documentation": "\nWeighted 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.
The maximum number of records you requested. The maximum value of MaxItems
is 100.
A complex type that contains information about the resource record sets that are returned by the request and information about the response.
\n " }, "errors": [ { "shape_name": "NoSuchHostedZone", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nDescriptive message for the error response.
\n " } }, "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " } ], "documentation": "\nImagine all the resource record sets in a zone listed out in front of you.\n Imagine them sorted lexicographically first by DNS name (with the labels\n reversed, like \"com.amazon.www\" for example), and secondarily,\n lexicographically by record type. This operation retrieves at most MaxItems\n resource record sets from this list, in order, starting at a position\n specified by the Name and Type arguments:
\nUse ListResourceRecordSets to retrieve a single known record set by\n specifying the record set's name and type, and setting MaxItems = 1
\nTo retrieve all the records in a HostedZone, first pause any processes\n making calls to ChangeResourceRecordSets. Initially call ListResourceRecordSets\n without a Name and Type to get the first page of record sets. For subsequent\n calls, set Name and Type to the NextName and NextType values returned by the\n previous response.\n
\nIn the presence of concurrent ChangeResourceRecordSets calls, there is no\n consistency of results across calls to ListResourceRecordSets. The only way\n to get a consistent multi-page snapshot of all RRSETs in a zone is to stop\n making changes while pagination is in progress.
\nHowever, the results from ListResourceRecordSets are consistent within a\n page. If MakeChange calls are taking place concurrently, the result of each\n one will either be completely visible in your results or not at all. You will\n not see partial changes, or changes that do not ultimately succeed. (This\n follows from the fact that MakeChange is atomic)\n
\nThe results from ListResourceRecordSets are strongly consistent with\n ChangeResourceRecordSets. To be precise, if a single process makes a call to\n ChangeResourceRecordSets and receives a successful response, the effects of that\n change will be visible in a subsequent call to ListResourceRecordSets by\n that process.
\n ", "pagination": { "more_results": "IsTruncated", "limit_key": "MaxItems", "result_key": "ResourceRecordSets", "input_token": [ "StartRecordName", "StartRecordType", "StartRecordIdentifier" ], "output_token": [ "NextRecordName", "NextRecordType", "NextRecordIdentifier" ], "py_input_token": [ "start_record_name", "start_record_type", "start_record_identifier" ] } } }, "metadata": { "regions": { "us-east-1": "https://route53.amazonaws.com/" }, "protocols": [ "https" ] }, "pagination": { "ListHealthChecks": { "input_token": "Marker", "output_token": "NextMarker", "more_results": "IsTruncated", "limit_key": "MaxItems", "result_key": "HealthChecks", "py_input_token": "marker" }, "ListHostedZones": { "input_token": "Marker", "output_token": "NextMarker", "more_results": "IsTruncated", "limit_key": "MaxItems", "result_key": "HostedZones", "py_input_token": "marker" }, "ListResourceRecordSets": { "more_results": "IsTruncated", "limit_key": "MaxItems", "result_key": "ResourceRecordSets", "input_token": [ "StartRecordName", "StartRecordType", "StartRecordIdentifier" ], "output_token": [ "NextRecordName", "NextRecordType", "NextRecordIdentifier" ], "py_input_token": [ "start_record_name", "start_record_type", "start_record_identifier" ] } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }