models.route53-2013-04-01-model.json Maven / Gradle / Ivy
Show all versions of aws-java-sdk-route53 Show documentation
{
"version":"2.0",
"metadata":{
"apiVersion":"2013-04-01",
"endpointPrefix":"route53",
"globalEndpoint":"route53.amazonaws.com",
"protocol":"rest-xml",
"serviceAbbreviation":"Route 53",
"serviceFullName":"Amazon Route 53",
"signatureVersion":"v4"
},
"operations":{
"AssociateVPCWithHostedZone":{
"name":"AssociateVPCWithHostedZone",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/hostedzone/{Id}/associatevpc"
},
"input":{
"shape":"AssociateVPCWithHostedZoneRequest",
"locationName":"AssociateVPCWithHostedZoneRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"AssociateVPCWithHostedZoneResponse"},
"errors":[
{"shape":"NoSuchHostedZone"},
{"shape":"InvalidVPCId"},
{"shape":"InvalidInput"},
{"shape":"PublicZoneVPCAssociation"},
{"shape":"ConflictingDomainExists"},
{"shape":"LimitsExceeded"}
],
"documentation":"This action associates a VPC with an hosted zone.
To associate a VPC with an hosted zone, send a POST request to the /Route 53 API version/hostedzone/hosted zone ID/associatevpc resource. The request body must include a document with a AssociateVPCWithHostedZoneRequest element. The response returns the AssociateVPCWithHostedZoneResponse element that contains ChangeInfo for you to track the progress of the AssociateVPCWithHostedZoneRequest you made. See GetChange operation for how to track the progress of your change.
"
},
"ChangeResourceRecordSets":{
"name":"ChangeResourceRecordSets",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/hostedzone/{Id}/rrset/"
},
"input":{
"shape":"ChangeResourceRecordSetsRequest",
"locationName":"ChangeResourceRecordSetsRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"ChangeResourceRecordSetsResponse"},
"errors":[
{"shape":"NoSuchHostedZone"},
{"shape":"NoSuchHealthCheck"},
{"shape":"InvalidChangeBatch"},
{"shape":"InvalidInput"},
{"shape":"PriorRequestNotComplete"}
],
"documentation":"Use this action to create or change your authoritative DNS information. To use this action, send a POST request to the /Route 53 API version/hostedzone/hosted Zone ID/rrset resource. The request body must include a 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 POST ChangeResourceRecordSets in the Amazon Route 53 API Reference.
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, Amazon Route 53 returns an InvalidChangeBatch error. In response to a ChangeResourceRecordSets request, your DNS data is changed on all Amazon Route 53 DNS servers. Initially, the status of a change is PENDING. This means the change has not yet propagated to all the authoritative Amazon 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.
"
},
"ChangeTagsForResource":{
"name":"ChangeTagsForResource",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/tags/{ResourceType}/{ResourceId}"
},
"input":{
"shape":"ChangeTagsForResourceRequest",
"locationName":"ChangeTagsForResourceRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"ChangeTagsForResourceResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"NoSuchHealthCheck"},
{"shape":"NoSuchHostedZone"},
{"shape":"PriorRequestNotComplete"},
{"shape":"ThrottlingException"}
]
},
"CreateHealthCheck":{
"name":"CreateHealthCheck",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/healthcheck",
"responseCode":201
},
"input":{
"shape":"CreateHealthCheckRequest",
"locationName":"CreateHealthCheckRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"CreateHealthCheckResponse"},
"errors":[
{"shape":"TooManyHealthChecks"},
{"shape":"HealthCheckAlreadyExists"},
{"shape":"InvalidInput"}
],
"documentation":"This action creates a new health check.
To create a new health check, send a POST request to the /Route 53 API version/healthcheck resource. The request body must include a document with a CreateHealthCheckRequest element. The response returns the CreateHealthCheckResponse element that contains metadata about the health check.
"
},
"CreateHostedZone":{
"name":"CreateHostedZone",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/hostedzone",
"responseCode":201
},
"input":{
"shape":"CreateHostedZoneRequest",
"locationName":"CreateHostedZoneRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"CreateHostedZoneResponse"},
"errors":[
{"shape":"InvalidDomainName"},
{"shape":"HostedZoneAlreadyExists"},
{"shape":"TooManyHostedZones"},
{"shape":"InvalidVPCId"},
{"shape":"InvalidInput"},
{"shape":"DelegationSetNotAvailable"},
{"shape":"ConflictingDomainExists"},
{"shape":"NoSuchDelegationSet"},
{"shape":"DelegationSetNotReusable"}
],
"documentation":"This action creates a new hosted zone.
To create a new hosted zone, send a POST request to the /Route 53 API version/hostedzone resource. The request body must include a document with a CreateHostedZoneRequest element. The response returns the CreateHostedZoneResponse element that contains metadata about the hosted zone.
Amazon 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 Amazon 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 Amazon Route 53 DNS servers.
When trying to create a hosted zone using a reusable delegation set, you could specify an optional DelegationSetId, and Route53 would assign those 4 NS records for the zone, instead of alloting a new one.
"
},
"CreateReusableDelegationSet":{
"name":"CreateReusableDelegationSet",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/delegationset",
"responseCode":201
},
"input":{
"shape":"CreateReusableDelegationSetRequest",
"locationName":"CreateReusableDelegationSetRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"CreateReusableDelegationSetResponse"},
"errors":[
{"shape":"DelegationSetAlreadyCreated"},
{"shape":"LimitsExceeded"},
{"shape":"HostedZoneNotFound"},
{"shape":"InvalidArgument"},
{"shape":"InvalidInput"},
{"shape":"DelegationSetNotAvailable"},
{"shape":"DelegationSetAlreadyReusable"}
],
"documentation":"This action creates a reusable delegationSet.
To create a new reusable delegationSet, send a POST request to the /Route 53 API version/delegationset resource. The request body must include a document with a CreateReusableDelegationSetRequest element. The response returns the CreateReusableDelegationSetResponse element that contains metadata about the delegationSet.
If the optional parameter HostedZoneId is specified, it marks the delegationSet associated with that particular hosted zone as reusable.
"
},
"CreateTrafficPolicy":{
"name":"CreateTrafficPolicy",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/trafficpolicy",
"responseCode":201
},
"input":{
"shape":"CreateTrafficPolicyRequest",
"locationName":"CreateTrafficPolicyRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"CreateTrafficPolicyResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"TooManyTrafficPolicies"},
{"shape":"TrafficPolicyAlreadyExists"},
{"shape":"InvalidTrafficPolicyDocument"}
],
"documentation":"Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
To create a traffic policy, send a POST request to the /Route 53 API version/trafficpolicy resource. The request body must include a document with a CreateTrafficPolicyRequest element. The response includes the CreateTrafficPolicyResponse element, which contains information about the new traffic policy.
"
},
"CreateTrafficPolicyInstance":{
"name":"CreateTrafficPolicyInstance",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/trafficpolicyinstance",
"responseCode":201
},
"input":{
"shape":"CreateTrafficPolicyInstanceRequest",
"locationName":"CreateTrafficPolicyInstanceRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"CreateTrafficPolicyInstanceResponse"},
"errors":[
{"shape":"NoSuchHostedZone"},
{"shape":"InvalidInput"},
{"shape":"TooManyTrafficPolicyInstances"},
{"shape":"NoSuchTrafficPolicy"},
{"shape":"TrafficPolicyInstanceAlreadyExists"}
],
"documentation":"Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.
To create a traffic policy instance, send a POST request to the /Route 53 API version/trafficpolicyinstance resource. The request body must include a document with a CreateTrafficPolicyRequest element. The response returns the CreateTrafficPolicyInstanceResponse element, which contains information about the traffic policy instance.
"
},
"CreateTrafficPolicyVersion":{
"name":"CreateTrafficPolicyVersion",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/trafficpolicy/{Id}",
"responseCode":201
},
"input":{
"shape":"CreateTrafficPolicyVersionRequest",
"locationName":"CreateTrafficPolicyVersionRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"CreateTrafficPolicyVersionResponse"},
"errors":[
{"shape":"NoSuchTrafficPolicy"},
{"shape":"InvalidInput"},
{"shape":"ConcurrentModification"},
{"shape":"InvalidTrafficPolicyDocument"}
],
"documentation":"Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version.
You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
To create a new version, send a POST request to the /Route 53 API version/trafficpolicy/ resource. The request body includes a document with a CreateTrafficPolicyVersionRequest element. The response returns the CreateTrafficPolicyVersionResponse element, which contains information about the new version of the traffic policy.
"
},
"DeleteHealthCheck":{
"name":"DeleteHealthCheck",
"http":{
"method":"DELETE",
"requestUri":"/2013-04-01/healthcheck/{HealthCheckId}"
},
"input":{"shape":"DeleteHealthCheckRequest"},
"output":{"shape":"DeleteHealthCheckResponse"},
"errors":[
{"shape":"NoSuchHealthCheck"},
{"shape":"HealthCheckInUse"},
{"shape":"InvalidInput"}
],
"documentation":"This action deletes a health check. To delete a health check, send a DELETE request to the /Route 53 API version/healthcheck/health check ID resource.
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, Amazon Route 53 will deny your request with a HealthCheckInUse error. For information about disassociating the records from your health check, see ChangeResourceRecordSets. "
},
"DeleteHostedZone":{
"name":"DeleteHostedZone",
"http":{
"method":"DELETE",
"requestUri":"/2013-04-01/hostedzone/{Id}"
},
"input":{"shape":"DeleteHostedZoneRequest"},
"output":{"shape":"DeleteHostedZoneResponse"},
"errors":[
{"shape":"NoSuchHostedZone"},
{"shape":"HostedZoneNotEmpty"},
{"shape":"PriorRequestNotComplete"},
{"shape":"InvalidInput"},
{"shape":"InvalidDomainName"}
],
"documentation":"This action deletes a hosted zone. To delete a hosted zone, send a DELETE request to the /Route 53 API version/hostedzone/hosted zone ID resource.
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, Amazon Route 53 will deny your request with a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets. "
},
"DeleteReusableDelegationSet":{
"name":"DeleteReusableDelegationSet",
"http":{
"method":"DELETE",
"requestUri":"/2013-04-01/delegationset/{Id}"
},
"input":{"shape":"DeleteReusableDelegationSetRequest"},
"output":{"shape":"DeleteReusableDelegationSetResponse"},
"errors":[
{"shape":"NoSuchDelegationSet"},
{"shape":"DelegationSetInUse"},
{"shape":"DelegationSetNotReusable"},
{"shape":"InvalidInput"}
],
"documentation":"This action deletes a reusable delegation set. To delete a reusable delegation set, send a DELETE request to the /Route 53 API version/delegationset/delegation set ID resource.
You can delete a reusable delegation set only if there are no associated hosted zones. If your reusable delegation set contains associated hosted zones, you must delete them before you can delete your reusable delegation set. If you try to delete a reusable delegation set that contains associated hosted zones, Amazon Route 53 will deny your request with a DelegationSetInUse error. "
},
"DeleteTrafficPolicy":{
"name":"DeleteTrafficPolicy",
"http":{
"method":"DELETE",
"requestUri":"/2013-04-01/trafficpolicy/{Id}/{Version}"
},
"input":{"shape":"DeleteTrafficPolicyRequest"},
"output":{"shape":"DeleteTrafficPolicyResponse"},
"errors":[
{"shape":"NoSuchTrafficPolicy"},
{"shape":"InvalidInput"},
{"shape":"TrafficPolicyInUse"},
{"shape":"ConcurrentModification"}
],
"documentation":"Deletes a traffic policy. To delete a traffic policy, send a DELETE request to the /Route 53 API version/trafficpolicy resource.
"
},
"DeleteTrafficPolicyInstance":{
"name":"DeleteTrafficPolicyInstance",
"http":{
"method":"DELETE",
"requestUri":"/2013-04-01/trafficpolicyinstance/{Id}"
},
"input":{"shape":"DeleteTrafficPolicyInstanceRequest"},
"output":{"shape":"DeleteTrafficPolicyInstanceResponse"},
"errors":[
{"shape":"NoSuchTrafficPolicyInstance"},
{"shape":"InvalidInput"},
{"shape":"PriorRequestNotComplete"}
],
"documentation":"Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
To delete a traffic policy instance, send a DELETE request to the /Route 53 API version/trafficpolicy/traffic policy instance ID resource.
When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance. "
},
"DisassociateVPCFromHostedZone":{
"name":"DisassociateVPCFromHostedZone",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/hostedzone/{Id}/disassociatevpc"
},
"input":{
"shape":"DisassociateVPCFromHostedZoneRequest",
"locationName":"DisassociateVPCFromHostedZoneRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"DisassociateVPCFromHostedZoneResponse"},
"errors":[
{"shape":"NoSuchHostedZone"},
{"shape":"InvalidVPCId"},
{"shape":"VPCAssociationNotFound"},
{"shape":"LastVPCAssociation"},
{"shape":"InvalidInput"}
],
"documentation":"This action disassociates a VPC from an hosted zone.
To disassociate a VPC to a hosted zone, send a POST request to the /Route 53 API version/hostedzone/hosted zone ID/disassociatevpc resource. The request body must include a document with a DisassociateVPCFromHostedZoneRequest element. The response returns the DisassociateVPCFromHostedZoneResponse element that contains ChangeInfo for you to track the progress of the DisassociateVPCFromHostedZoneRequest you made. See GetChange operation for how to track the progress of your change.
"
},
"GetChange":{
"name":"GetChange",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/change/{Id}"
},
"input":{"shape":"GetChangeRequest"},
"output":{"shape":"GetChangeResponse"},
"errors":[
{"shape":"NoSuchChange"},
{"shape":"InvalidInput"}
],
"documentation":"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 Amazon 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.
"
},
"GetChangeDetails":{
"name":"GetChangeDetails",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/changedetails/{Id}"
},
"input":{"shape":"GetChangeDetailsRequest"},
"output":{"shape":"GetChangeDetailsResponse"},
"errors":[
{"shape":"NoSuchChange"},
{"shape":"InvalidInput"}
],
"documentation":"This action returns the status and changes of a change batch request.
",
"deprecated":true
},
"GetCheckerIpRanges":{
"name":"GetCheckerIpRanges",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/checkeripranges"
},
"input":{"shape":"GetCheckerIpRangesRequest"},
"output":{"shape":"GetCheckerIpRangesResponse"},
"documentation":"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 /Route 53 API version/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.
"
},
"GetGeoLocation":{
"name":"GetGeoLocation",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/geolocation"
},
"input":{"shape":"GetGeoLocationRequest"},
"output":{"shape":"GetGeoLocationResponse"},
"errors":[
{"shape":"NoSuchGeoLocation"},
{"shape":"InvalidInput"}
],
"documentation":"To retrieve a single geo location, send a GET request to the /Route 53 API version/geolocation resource with one of these options: continentcode | countrycode | countrycode and subdivisioncode.
"
},
"GetHealthCheck":{
"name":"GetHealthCheck",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/healthcheck/{HealthCheckId}"
},
"input":{"shape":"GetHealthCheckRequest"},
"output":{"shape":"GetHealthCheckResponse"},
"errors":[
{"shape":"NoSuchHealthCheck"},
{"shape":"InvalidInput"},
{"shape":"IncompatibleVersion"}
],
"documentation":"To retrieve the health check, send a GET request to the /Route 53 API version/healthcheck/health check ID resource.
"
},
"GetHealthCheckCount":{
"name":"GetHealthCheckCount",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/healthcheckcount"
},
"input":{"shape":"GetHealthCheckCountRequest"},
"output":{"shape":"GetHealthCheckCountResponse"},
"documentation":"To retrieve a count of all your health checks, send a GET request to the /Route 53 API version/healthcheckcount resource.
"
},
"GetHealthCheckLastFailureReason":{
"name":"GetHealthCheckLastFailureReason",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereason"
},
"input":{"shape":"GetHealthCheckLastFailureReasonRequest"},
"output":{"shape":"GetHealthCheckLastFailureReasonResponse"},
"errors":[
{"shape":"NoSuchHealthCheck"},
{"shape":"InvalidInput"}
],
"documentation":"If you want to learn why a health check is currently failing or why it failed most recently (if at all), you can get the failure reason for the most recent failure. Send a GET request to the /Route 53 API version/healthcheck/health check ID/lastfailurereason resource.
"
},
"GetHealthCheckStatus":{
"name":"GetHealthCheckStatus",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/healthcheck/{HealthCheckId}/status"
},
"input":{"shape":"GetHealthCheckStatusRequest"},
"output":{"shape":"GetHealthCheckStatusResponse"},
"errors":[
{"shape":"NoSuchHealthCheck"},
{"shape":"InvalidInput"}
],
"documentation":"To retrieve the health check status, send a GET request to the /Route 53 API version/healthcheck/health check ID/status resource. You can use this call to get a health check's current status.
"
},
"GetHostedZone":{
"name":"GetHostedZone",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/hostedzone/{Id}"
},
"input":{"shape":"GetHostedZoneRequest"},
"output":{"shape":"GetHostedZoneResponse"},
"errors":[
{"shape":"NoSuchHostedZone"},
{"shape":"InvalidInput"}
],
"documentation":"To retrieve the delegation set for a hosted zone, send a GET request to the /Route 53 API version/hostedzone/hosted zone ID resource. The delegation set is the four Amazon Route 53 name servers that were assigned to the hosted zone when you created it.
"
},
"GetHostedZoneCount":{
"name":"GetHostedZoneCount",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/hostedzonecount"
},
"input":{"shape":"GetHostedZoneCountRequest"},
"output":{"shape":"GetHostedZoneCountResponse"},
"errors":[
{"shape":"InvalidInput"}
],
"documentation":"To retrieve a count of all your hosted zones, send a GET request to the /Route 53 API version/hostedzonecount resource.
"
},
"GetReusableDelegationSet":{
"name":"GetReusableDelegationSet",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/delegationset/{Id}"
},
"input":{"shape":"GetReusableDelegationSetRequest"},
"output":{"shape":"GetReusableDelegationSetResponse"},
"errors":[
{"shape":"NoSuchDelegationSet"},
{"shape":"DelegationSetNotReusable"},
{"shape":"InvalidInput"}
],
"documentation":"To retrieve the reusable delegation set, send a GET request to the /Route 53 API version/delegationset/delegation set ID resource.
"
},
"GetTrafficPolicy":{
"name":"GetTrafficPolicy",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/trafficpolicy/{Id}/{Version}"
},
"input":{"shape":"GetTrafficPolicyRequest"},
"output":{"shape":"GetTrafficPolicyResponse"},
"errors":[
{"shape":"NoSuchTrafficPolicy"},
{"shape":"InvalidInput"}
],
"documentation":"Gets information about a specific traffic policy version. To get the information, send a GET request to the /Route 53 API version/trafficpolicy resource.
"
},
"GetTrafficPolicyInstance":{
"name":"GetTrafficPolicyInstance",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/trafficpolicyinstance/{Id}"
},
"input":{"shape":"GetTrafficPolicyInstanceRequest"},
"output":{"shape":"GetTrafficPolicyInstanceResponse"},
"errors":[
{"shape":"NoSuchTrafficPolicyInstance"},
{"shape":"InvalidInput"}
],
"documentation":"Gets information about a specified traffic policy instance.
To get information about the traffic policy instance, send a GET request to the /Route 53 API version/trafficpolicyinstance resource.
After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. "
},
"GetTrafficPolicyInstanceCount":{
"name":"GetTrafficPolicyInstanceCount",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/trafficpolicyinstancecount"
},
"input":{"shape":"GetTrafficPolicyInstanceCountRequest"},
"output":{"shape":"GetTrafficPolicyInstanceCountResponse"},
"documentation":"Gets the number of traffic policy instances that are associated with the current AWS account.
To get the number of traffic policy instances, send a GET request to the /Route 53 API version/trafficpolicyinstancecount resource.
"
},
"ListChangeBatchesByHostedZone":{
"name":"ListChangeBatchesByHostedZone",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/hostedzone/{Id}/changes"
},
"input":{"shape":"ListChangeBatchesByHostedZoneRequest"},
"output":{"shape":"ListChangeBatchesByHostedZoneResponse"},
"errors":[
{"shape":"NoSuchHostedZone"},
{"shape":"InvalidInput"}
],
"documentation":"This action gets the list of ChangeBatches in a given time period for a given hosted zone.
",
"deprecated":true
},
"ListChangeBatchesByRRSet":{
"name":"ListChangeBatchesByRRSet",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/hostedzone/{Id}/rrsChanges"
},
"input":{"shape":"ListChangeBatchesByRRSetRequest"},
"output":{"shape":"ListChangeBatchesByRRSetResponse"},
"errors":[
{"shape":"NoSuchHostedZone"},
{"shape":"InvalidInput"}
],
"documentation":"This action gets the list of ChangeBatches in a given time period for a given hosted zone and RRSet.
",
"deprecated":true
},
"ListGeoLocations":{
"name":"ListGeoLocations",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/geolocations"
},
"input":{"shape":"ListGeoLocationsRequest"},
"output":{"shape":"ListGeoLocationsResponse"},
"errors":[
{"shape":"InvalidInput"}
],
"documentation":"To retrieve a list of supported geo locations, send a GET request to the /Route 53 API version/geolocations resource. The response to this request includes a GeoLocationDetailsList element with zero, one, or multiple GeoLocationDetails child elements. The list is sorted by country code, and then subdivision code, followed by continents at the end of the list.
By default, the list of geo locations is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. If the list is truncated, IsTruncated will be set to true and a combination of NextContinentCode, NextCountryCode, NextSubdivisionCode will be populated. You can pass these as parameters to StartContinentCode, StartCountryCode, StartSubdivisionCode to control the geo location that the list begins with.
"
},
"ListHealthChecks":{
"name":"ListHealthChecks",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/healthcheck"
},
"input":{"shape":"ListHealthChecksRequest"},
"output":{"shape":"ListHealthChecksResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"IncompatibleVersion"}
],
"documentation":"To retrieve a list of your health checks, send a GET request to the /Route 53 API version/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.
Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100. "
},
"ListHostedZones":{
"name":"ListHostedZones",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/hostedzone"
},
"input":{"shape":"ListHostedZonesRequest"},
"output":{"shape":"ListHostedZonesResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"NoSuchDelegationSet"},
{"shape":"DelegationSetNotReusable"}
],
"documentation":"To retrieve a list of your hosted zones, send a GET request to the /Route 53 API version/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.
Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100. "
},
"ListHostedZonesByName":{
"name":"ListHostedZonesByName",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/hostedzonesbyname"
},
"input":{"shape":"ListHostedZonesByNameRequest"},
"output":{"shape":"ListHostedZonesByNameResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"InvalidDomainName"}
],
"documentation":"To retrieve a list of your hosted zones in lexicographic order, send a GET request to the /Route 53 API version/hostedzonesbyname resource. The response to this request includes a HostedZones element with zero or more HostedZone child elements lexicographically ordered by DNS name. 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 DNSName and HostedZoneId parameters to control the hosted zone that the list begins with.
Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100. "
},
"ListResourceRecordSets":{
"name":"ListResourceRecordSets",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/hostedzone/{Id}/rrset"
},
"input":{"shape":"ListResourceRecordSetsRequest"},
"output":{"shape":"ListResourceRecordSetsResponse"},
"errors":[
{"shape":"NoSuchHostedZone"},
{"shape":"InvalidInput"}
],
"documentation":"List the resource record sets in a specified hosted zone. Send a GET request to the 2013-04-01/hostedzone/hosted zone ID/rrset resource.
ListResourceRecordSets returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements. The action sorts results first by DNS name with the labels reversed, for example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances. When multiple records have the same DNS name, the action sorts results by the record type.
You can use the name and type elements to adjust the beginning position of the list of resource record sets returned:
- If you do not specify
Name or Type: The results begin with the first resource record set that the hosted zone contains. - If you specify
Name but not Type: The results begin with the first resource record set in the list whose name is greater than or equal to Name. - If you specify
Type but not Name: Amazon Route 53 returns the InvalidInput error. - If you specify both
Name and Type: The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type.
This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Amazon Route 53 DNS servers.
To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you are paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.
"
},
"ListReusableDelegationSets":{
"name":"ListReusableDelegationSets",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/delegationset"
},
"input":{"shape":"ListReusableDelegationSetsRequest"},
"output":{"shape":"ListReusableDelegationSetsResponse"},
"errors":[
{"shape":"InvalidInput"}
],
"documentation":"To retrieve a list of your reusable delegation sets, send a GET request to the /Route 53 API version/delegationset resource. The response to this request includes a DelegationSets element with zero, one, or multiple DelegationSet child elements. By default, the list of delegation sets 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 delegation set that the list begins with.
Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100. "
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/tags/{ResourceType}/{ResourceId}"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"NoSuchHealthCheck"},
{"shape":"NoSuchHostedZone"},
{"shape":"PriorRequestNotComplete"},
{"shape":"ThrottlingException"}
]
},
"ListTagsForResources":{
"name":"ListTagsForResources",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/tags/{ResourceType}"
},
"input":{
"shape":"ListTagsForResourcesRequest",
"locationName":"ListTagsForResourcesRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"ListTagsForResourcesResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"NoSuchHealthCheck"},
{"shape":"NoSuchHostedZone"},
{"shape":"PriorRequestNotComplete"},
{"shape":"ThrottlingException"}
]
},
"ListTrafficPolicies":{
"name":"ListTrafficPolicies",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/trafficpolicies"
},
"input":{"shape":"ListTrafficPoliciesRequest"},
"output":{"shape":"ListTrafficPoliciesResponse"},
"errors":[
{"shape":"InvalidInput"}
],
"documentation":"Gets information about the latest version for every traffic policy that is associated with the current AWS account. To get the information, send a GET request to the /Route 53 API version/trafficpolicy resource.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policies, you can use the maxitems parameter to list them in groups of up to 100.
The response includes three values that help you navigate from one group of maxitems traffic policies to the next:
- IsTruncated
If the value of IsTruncated in the response is true, there are more traffic policies associated with the current AWS account.
If IsTruncated is false, this response includes the last traffic policy that is associated with the current account.
- TrafficPolicyIdMarker
If IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies. If you want to list more traffic policies, make another call to ListTrafficPolicies, and specify the value of the TrafficPolicyIdMarker element from the response in the TrafficPolicyIdMarker request parameter.
If IsTruncated is false, the TrafficPolicyIdMarker element is omitted from the response.
- MaxItems
The value that you specified for the MaxItems parameter in the request that produced the current response.
"
},
"ListTrafficPolicyInstances":{
"name":"ListTrafficPolicyInstances",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/trafficpolicyinstances"
},
"input":{"shape":"ListTrafficPolicyInstancesRequest"},
"output":{"shape":"ListTrafficPolicyInstancesResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"NoSuchTrafficPolicyInstance"}
],
"documentation":"Gets information about the traffic policy instances that you created by using the current AWS account.
After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. To get information about the traffic policy instances that are associated with the current AWS account, send a GET request to the /Route 53 API version/trafficpolicyinstance resource.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.
The response includes five values that help you navigate from one group of MaxItems traffic policy instances to the next:
- IsTruncated
If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the current AWS account.
If IsTruncated is false, this response includes the last traffic policy instance that is associated with the current account.
- MaxItems
The value that you specified for the MaxItems parameter in the request that produced the current response.
- HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker
If IsTruncated is true, these three values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstances, and specify these values in the corresponding request parameters.
If IsTruncated is false, all three elements are omitted from the response.
"
},
"ListTrafficPolicyInstancesByHostedZone":{
"name":"ListTrafficPolicyInstancesByHostedZone",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/trafficpolicyinstances/hostedzone"
},
"input":{"shape":"ListTrafficPolicyInstancesByHostedZoneRequest"},
"output":{"shape":"ListTrafficPolicyInstancesByHostedZoneResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"NoSuchTrafficPolicyInstance"},
{"shape":"NoSuchHostedZone"}
],
"documentation":"Gets information about the traffic policy instances that you created in a specified hosted zone.
After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. To get information about the traffic policy instances that you created in a specified hosted zone, send a GET request to the /Route 53 API version/trafficpolicyinstance resource and include the ID of the hosted zone.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.
The response includes four values that help you navigate from one group of MaxItems traffic policy instances to the next:
- IsTruncated
If the value of true, there are more traffic policy instances associated with the current AWS account.
If IsTruncated is false, this response includes the last traffic policy instance that is associated with the current account.
- MaxItems
The value that you specified for the MaxItems parameter in the request that produced the current response.
- TrafficPolicyInstanceNameMarker and TrafficPolicyInstanceTypeMarker
If IsTruncated is true, these two values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstancesByHostedZone, and specify these values in the corresponding request parameters.
If IsTruncated is false, all three elements are omitted from the response.
"
},
"ListTrafficPolicyInstancesByPolicy":{
"name":"ListTrafficPolicyInstancesByPolicy",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/trafficpolicyinstances/trafficpolicy"
},
"input":{"shape":"ListTrafficPolicyInstancesByPolicyRequest"},
"output":{"shape":"ListTrafficPolicyInstancesByPolicyResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"NoSuchTrafficPolicyInstance"},
{"shape":"NoSuchTrafficPolicy"}
],
"documentation":"Gets information about the traffic policy instances that you created by using a specify traffic policy version.
After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element. To get information about the traffic policy instances that you created by using a specify traffic policy version, send a GET request to the /Route 53 API version/trafficpolicyinstance resource and include the ID and version of the traffic policy.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.
The response includes five values that help you navigate from one group of MaxItems traffic policy instances to the next:
- IsTruncated
If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the specified traffic policy.
If IsTruncated is false, this response includes the last traffic policy instance that is associated with the specified traffic policy.
- MaxItems
The value that you specified for the MaxItems parameter in the request that produced the current response.
- HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker
If IsTruncated is true, these values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstancesByPolicy, and specify these values in the corresponding request parameters.
If IsTruncated is false, all three elements are omitted from the response.
"
},
"ListTrafficPolicyVersions":{
"name":"ListTrafficPolicyVersions",
"http":{
"method":"GET",
"requestUri":"/2013-04-01/trafficpolicies/{Id}/versions"
},
"input":{"shape":"ListTrafficPolicyVersionsRequest"},
"output":{"shape":"ListTrafficPolicyVersionsResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"NoSuchTrafficPolicy"}
],
"documentation":"Gets information about all of the versions for a specified traffic policy. ListTrafficPolicyVersions lists only versions that have not been deleted.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policies, you can use the maxitems parameter to list them in groups of up to 100.
The response includes three values that help you navigate from one group of maxitemsmaxitems traffic policies to the next:
- IsTruncated
If the value of IsTruncated in the response is true, there are more traffic policy versions associated with the specified traffic policy.
If IsTruncated is false, this response includes the last traffic policy version that is associated with the specified traffic policy.
- TrafficPolicyVersionMarker
The ID of the next traffic policy version that is associated with the current AWS account. If you want to list more traffic policies, make another call to ListTrafficPolicyVersions, and specify the value of the TrafficPolicyVersionMarker element in the TrafficPolicyVersionMarker request parameter.
If IsTruncated is false, Amazon Route 53 omits the TrafficPolicyVersionMarker element from the response.
- MaxItems
The value that you specified for the MaxItems parameter in the request that produced the current response.
"
},
"UpdateHealthCheck":{
"name":"UpdateHealthCheck",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/healthcheck/{HealthCheckId}"
},
"input":{
"shape":"UpdateHealthCheckRequest",
"locationName":"UpdateHealthCheckRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"UpdateHealthCheckResponse"},
"errors":[
{"shape":"NoSuchHealthCheck"},
{"shape":"InvalidInput"},
{"shape":"HealthCheckVersionMismatch"}
],
"documentation":"This action updates an existing health check.
To update a health check, send a POST request to the /Route 53 API version/healthcheck/health check ID resource. The request body must include a document with an UpdateHealthCheckRequest element. The response returns an UpdateHealthCheckResponse element, which contains metadata about the health check.
"
},
"UpdateHostedZoneComment":{
"name":"UpdateHostedZoneComment",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/hostedzone/{Id}"
},
"input":{
"shape":"UpdateHostedZoneCommentRequest",
"locationName":"UpdateHostedZoneCommentRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"UpdateHostedZoneCommentResponse"},
"errors":[
{"shape":"NoSuchHostedZone"},
{"shape":"InvalidInput"}
],
"documentation":"To update the hosted zone comment, send a POST request to the /Route 53 API version/hostedzone/hosted zone ID resource. The request body must include a document with a UpdateHostedZoneCommentRequest element. The response to this request includes the modified HostedZone element.
The comment can have a maximum length of 256 characters. "
},
"UpdateTrafficPolicyComment":{
"name":"UpdateTrafficPolicyComment",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/trafficpolicy/{Id}/{Version}"
},
"input":{
"shape":"UpdateTrafficPolicyCommentRequest",
"locationName":"UpdateTrafficPolicyCommentRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"UpdateTrafficPolicyCommentResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"NoSuchTrafficPolicy"},
{"shape":"ConcurrentModification"}
],
"documentation":"Updates the comment for a specified traffic policy version.
To update the comment, send a POST request to the /Route 53 API version/trafficpolicy/ resource.
The request body must include a document with an UpdateTrafficPolicyCommentRequest element.
"
},
"UpdateTrafficPolicyInstance":{
"name":"UpdateTrafficPolicyInstance",
"http":{
"method":"POST",
"requestUri":"/2013-04-01/trafficpolicyinstance/{Id}"
},
"input":{
"shape":"UpdateTrafficPolicyInstanceRequest",
"locationName":"UpdateTrafficPolicyInstanceRequest",
"xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}
},
"output":{"shape":"UpdateTrafficPolicyInstanceResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"NoSuchTrafficPolicy"},
{"shape":"NoSuchTrafficPolicyInstance"},
{"shape":"PriorRequestNotComplete"},
{"shape":"ConflictingTypes"}
],
"documentation":"Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.
The DNS type of the resource record sets that you're updating must match the DNS type in the JSON document that is associated with the traffic policy version that you're using to update the traffic policy instance. When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Amazon Route 53 performs the following operations:
- Amazon Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how substantial the differences are between the existing resource record sets and the new resource record sets.
- When all of the new resource record sets have been created, Amazon Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.
- Amazon Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.
To update a traffic policy instance, send a POST request to the /Route 53 API version/trafficpolicyinstance/traffic policy ID resource. The request body must include a document with an UpdateTrafficPolicyInstanceRequest element.
"
}
},
"shapes":{
"AWSAccountID":{"type":"string"},
"AlarmIdentifier":{
"type":"structure",
"required":[
"Region",
"Name"
],
"members":{
"Region":{
"shape":"CloudWatchRegion",
"documentation":"The CloudWatchRegion that the CloudWatch alarm was created in.
"
},
"Name":{
"shape":"AlarmName",
"documentation":"The name of the CloudWatch alarm.
"
}
},
"documentation":"A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
"
},
"AlarmName":{
"type":"string",
"max":256,
"min":1
},
"AliasHealthEnabled":{"type":"boolean"},
"AliasTarget":{
"type":"structure",
"required":[
"HostedZoneId",
"DNSName",
"EvaluateTargetHealth"
],
"members":{
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"Alias resource record sets only: The value you use depends on where you want to route queries:
- A CloudFront distribution: Specify
Z2FDTNDATAQYW2. - An ELB load balancer: Specify the value of the hosted zone ID for the load balancer. You can get the hosted zone ID by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for
HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail. - An Amazon S3 bucket that is configured as a static website: Specify the hosted zone ID for the Amazon S3 website endpoint in which you created the bucket. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference.
- Another Amazon Route 53 resource record set in your hosted zone: Specify the hosted zone ID of your hosted zone. (An alias resource record set cannot reference a resource record set in a different hosted zone.)
"
},
"DNSName":{
"shape":"DNSName",
"documentation":"Alias resource record sets only: The external DNS name associated with the AWS Resource. The value that you specify depends on where you want to route queries:
- A CloudFront distribution: Specify the domain name that CloudFront assigned when you created your distribution. Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is
acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide. - An ELB load balancer: Specify the DNS name associated with the load balancer. You can get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for
HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail. - An Elastic Beanstalk environment: Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.)
- An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3 website endpoint in which you created the bucket; for example,
s3-website-us-east-1.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using Amazon S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon Simple Storage Service Developer Guide. - Another Amazon Route 53 resource record set: Specify the value of the
Name element for a resource record set in the current hosted zone.
"
},
"EvaluateTargetHealth":{
"shape":"AliasHealthEnabled",
"documentation":"Alias resource record sets only: If you set the value of EvaluateTargetHealth to true for the resource record set or sets in an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a value for HealthCheckId for every resource record set that is referenced by these alias resource record sets, the alias resource record sets inherit the health of the referenced resource record sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
- Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.
- Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)
- Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.
- Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.
Note the following:
- You cannot set
EvaluateTargetHealth to true when the alias target is a CloudFront distribution. - If the AWS resource that you specify in
AliasTarget is a resource record set or a group of resource record sets (for example, a group of weighted resource record sets), but it is not another alias resource record set, we recommend that you associate a health check with all of the resource record sets in the alias target. - If you specify an ELB load balancer in
AliasTarget, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If no Amazon EC2 instances are healthy or if the load balancer itself is unhealthy, and if EvaluateTargetHealth is true for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. - When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the Amazon EC2 instances that you register with an ELB load balancer. For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developer Guide.
We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to handle the failure of one or more endpoints.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
"
}
},
"documentation":"Alias resource record sets only: Information about the CloudFront distribution, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are routing traffic.
If you're creating resource record sets for a private hosted zone, note the following:
- You can create alias resource record sets only for Amazon Route 53 resource record sets in the same private hosted zone. Creating alias resource record sets for CloudFront distributions, ELB load balancers, and Amazon S3 buckets is not supported.
- You can't create alias resource record sets for failover, geolocation, or latency resource record sets in a private hosted zone.
"
},
"AssociateVPCComment":{"type":"string"},
"AssociateVPCWithHostedZoneRequest":{
"type":"structure",
"required":[
"HostedZoneId",
"VPC"
],
"members":{
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"The ID of the hosted zone you want to associate your VPC with.
Note that you cannot associate a VPC with a hosted zone that doesn't have an existing VPC association.
",
"location":"uri",
"locationName":"Id"
},
"VPC":{
"shape":"VPC",
"documentation":"The VPC that you want your hosted zone to be associated with.
"
},
"Comment":{
"shape":"AssociateVPCComment",
"documentation":"Optional: Any comments you want to include about a AssociateVPCWithHostedZoneRequest.
"
}
},
"documentation":"A complex type that contains information about the request to associate a VPC with an hosted zone.
"
},
"AssociateVPCWithHostedZoneResponse":{
"type":"structure",
"required":["ChangeInfo"],
"members":{
"ChangeInfo":{
"shape":"ChangeInfo",
"documentation":"A complex type that contains the ID, the status, and the date and time of your AssociateVPCWithHostedZoneRequest.
"
}
},
"documentation":"A complex type containing the response information for the request.
"
},
"Change":{
"type":"structure",
"required":[
"Action",
"ResourceRecordSet"
],
"members":{
"Action":{
"shape":"ChangeAction",
"documentation":"The action to perform:
CREATE: Creates a resource record set that has the specified values.DELETE: Deletes a existing resource record set that has the specified values for Name, Type, SetIdentifier (for latency, weighted, geolocation, and failover resource record sets), and TTL (except alias resource record sets, for which the TTL is determined by the AWS resource that you're routing DNS queries to).UPSERT: If a resource record set does not already exist, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an existing resource record set only when all of the following values match: Name, Type, and SetIdentifier (for weighted, latency, geolocation, and failover resource record sets).
"
},
"ResourceRecordSet":{
"shape":"ResourceRecordSet",
"documentation":"Information about the resource record set to create or delete.
"
}
},
"documentation":"A complex type that contains the information for each change in a change batch request.
"
},
"ChangeAction":{
"type":"string",
"enum":[
"CREATE",
"DELETE",
"UPSERT"
]
},
"ChangeBatch":{
"type":"structure",
"required":["Changes"],
"members":{
"Comment":{
"shape":"ResourceDescription",
"documentation":"Optional: Any comments you want to include about a change batch request.
"
},
"Changes":{
"shape":"Changes",
"documentation":"A complex type that contains one Change element for each resource record set that you want to create or delete.
"
}
},
"documentation":"A complex type that contains an optional comment and the changes that you want to make with a change batch request.
"
},
"ChangeBatchRecord":{
"type":"structure",
"required":[
"Id",
"Status"
],
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
"
},
"SubmittedAt":{
"shape":"TimeStamp",
"documentation":"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).
"
},
"Status":{
"shape":"ChangeStatus",
"documentation":"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
"
},
"Comment":{
"shape":"ResourceDescription",
"documentation":"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.
"
},
"Submitter":{
"shape":"AWSAccountID",
"documentation":"The AWS account ID attached to the changes.
"
},
"Changes":{
"shape":"Changes",
"documentation":"A list of changes made in the ChangeBatch.
"
}
},
"documentation":"A complex type that lists the changes and information for a ChangeBatch.
",
"deprecated":true
},
"ChangeBatchRecords":{
"type":"list",
"member":{
"shape":"ChangeBatchRecord",
"locationName":"ChangeBatchRecord"
},
"deprecated":true,
"min":1
},
"ChangeInfo":{
"type":"structure",
"required":[
"Id",
"Status",
"SubmittedAt"
],
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
"
},
"Status":{
"shape":"ChangeStatus",
"documentation":"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":{
"shape":"TimeStamp",
"documentation":"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).
"
},
"Comment":{
"shape":"ResourceDescription",
"documentation":"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.
"
}
},
"documentation":"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.
"
},
"ChangeResourceRecordSetsRequest":{
"type":"structure",
"required":[
"HostedZoneId",
"ChangeBatch"
],
"members":{
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"The ID of the hosted zone that contains the resource record sets that you want to change.
",
"location":"uri",
"locationName":"Id"
},
"ChangeBatch":{
"shape":"ChangeBatch",
"documentation":"A complex type that contains an optional comment and the Changes element.
"
}
},
"documentation":"A complex type that contains a change batch.
"
},
"ChangeResourceRecordSetsResponse":{
"type":"structure",
"required":["ChangeInfo"],
"members":{
"ChangeInfo":{
"shape":"ChangeInfo",
"documentation":"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.
"
}
},
"documentation":"A complex type containing the response for the request.
"
},
"ChangeStatus":{
"type":"string",
"enum":[
"PENDING",
"INSYNC"
]
},
"ChangeTagsForResourceRequest":{
"type":"structure",
"required":[
"ResourceType",
"ResourceId"
],
"members":{
"ResourceType":{
"shape":"TagResourceType",
"documentation":"The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
",
"location":"uri",
"locationName":"ResourceType"
},
"ResourceId":{
"shape":"TagResourceId",
"documentation":"The ID of the resource for which you want to add, change, or delete tags.
",
"location":"uri",
"locationName":"ResourceId"
},
"AddTags":{
"shape":"TagList",
"documentation":"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.
"
},
"RemoveTagKeys":{
"shape":"TagKeyList",
"documentation":"A list of Tag keys that you want to remove from the specified resource.
"
}
},
"documentation":"A complex type containing information about a request to add, change, or delete the tags that are associated with a resource.
"
},
"ChangeTagsForResourceResponse":{
"type":"structure",
"members":{
},
"documentation":"Empty response for the request.
"
},
"Changes":{
"type":"list",
"member":{
"shape":"Change",
"locationName":"Change"
},
"min":1
},
"CheckerIpRanges":{
"type":"list",
"member":{"shape":"IPAddressCidr"}
},
"ChildHealthCheckList":{
"type":"list",
"member":{
"shape":"HealthCheckId",
"locationName":"ChildHealthCheck"
},
"max":256
},
"CloudWatchAlarmConfiguration":{
"type":"structure",
"required":[
"EvaluationPeriods",
"Threshold",
"ComparisonOperator",
"Period",
"MetricName",
"Namespace",
"Statistic"
],
"members":{
"EvaluationPeriods":{
"shape":"EvaluationPeriods",
"documentation":"The number of periods over which data is compared to the specified threshold.
"
},
"Threshold":{
"shape":"Threshold",
"documentation":"The value that the metric is compared with to determine the state of the alarm. For example, if you want the health check to fail if the average TCP connection time is greater than 500 milliseconds for more than 60 seconds, the threshold is 500.
"
},
"ComparisonOperator":{
"shape":"ComparisonOperator",
"documentation":"The arithmetic operation to use when comparing the specified Statistic and Threshold.
Valid Values are GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold and LessThanOrEqualToThreshold
"
},
"Period":{
"shape":"Period",
"documentation":"An integer that represents the period in seconds over which the statistic is applied.
"
},
"MetricName":{
"shape":"MetricName",
"documentation":"The name of the CloudWatch metric that is associated with the CloudWatch alarm.
"
},
"Namespace":{
"shape":"Namespace",
"documentation":"The namespace of the CloudWatch metric that is associated with the CloudWatch alarm.
"
},
"Statistic":{
"shape":"Statistic",
"documentation":"The statistic to apply to the CloudWatch metric that is associated with the CloudWatch alarm.
Valid Values are SampleCount, Average, Sum, Minimum and Maximum
"
},
"Dimensions":{
"shape":"DimensionList",
"documentation":"A list of Dimension elements for the CloudWatch metric that is associated with the CloudWatch alarm. For information about the metrics and dimensions that CloudWatch supports, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference.
"
}
},
"documentation":"For CLOUDWATCH_METRIC health checks, a complex type that contains information about the CloudWatch alarm that you're associating with the health check.
"
},
"CloudWatchRegion":{
"type":"string",
"enum":[
"us-east-1",
"us-west-1",
"us-west-2",
"eu-central-1",
"eu-west-1",
"ap-southeast-1",
"ap-southeast-2",
"ap-northeast-1",
"ap-northeast-2",
"sa-east-1"
],
"max":64,
"min":1
},
"ComparisonOperator":{
"type":"string",
"enum":[
"GreaterThanOrEqualToThreshold",
"GreaterThanThreshold",
"LessThanThreshold",
"LessThanOrEqualToThreshold"
]
},
"ConcurrentModification":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"Another user submitted a request to update the object at the same time that you did. Retry the request.
",
"error":{"httpStatusCode":400},
"exception":true
},
"ConflictingDomainExists":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"exception":true
},
"ConflictingTypes":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"You tried to update a traffic policy instance by using a traffic policy version that has a different DNS type than the current type for the instance. You specified the type in the JSON document in the CreateTrafficPolicy or CreateTrafficPolicyVersionrequest.
",
"error":{"httpStatusCode":400},
"exception":true
},
"CreateHealthCheckRequest":{
"type":"structure",
"required":[
"CallerReference",
"HealthCheckConfig"
],
"members":{
"CallerReference":{
"shape":"HealthCheckNonce",
"documentation":"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.
"
},
"HealthCheckConfig":{
"shape":"HealthCheckConfig",
"documentation":"A complex type that contains health check configuration.
"
}
},
"documentation":">A complex type that contains information about the request to create a health check.
"
},
"CreateHealthCheckResponse":{
"type":"structure",
"required":[
"HealthCheck",
"Location"
],
"members":{
"HealthCheck":{
"shape":"HealthCheck",
"documentation":"A complex type that contains identifying information about the health check.
"
},
"Location":{
"shape":"ResourceURI",
"documentation":"The unique URL representing the new health check.
",
"location":"header",
"locationName":"Location"
}
},
"documentation":"A complex type containing the response information for the new health check.
"
},
"CreateHostedZoneRequest":{
"type":"structure",
"required":[
"Name",
"CallerReference"
],
"members":{
"Name":{
"shape":"DNSName",
"documentation":"The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon 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.
"
},
"VPC":{
"shape":"VPC",
"documentation":"The VPC that you want your hosted zone to be associated with. By providing this parameter, your newly created hosted cannot be resolved anywhere other than the given VPC.
"
},
"CallerReference":{
"shape":"Nonce",
"documentation":"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.
"
},
"HostedZoneConfig":{
"shape":"HostedZoneConfig",
"documentation":"A complex type that contains an optional comment about your hosted zone.
"
},
"DelegationSetId":{
"shape":"ResourceId",
"documentation":"The delegation set id of the reusable delgation set whose NS records you want to assign to the new hosted zone.
"
}
},
"documentation":"A complex type that contains information about the request to create a hosted zone.
"
},
"CreateHostedZoneResponse":{
"type":"structure",
"required":[
"HostedZone",
"ChangeInfo",
"DelegationSet",
"Location"
],
"members":{
"HostedZone":{
"shape":"HostedZone",
"documentation":"A complex type that contains identifying information about the hosted zone.
"
},
"ChangeInfo":{
"shape":"ChangeInfo",
"documentation":"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.
"
},
"DelegationSet":{
"shape":"DelegationSet",
"documentation":"A complex type that contains name server information.
"
},
"VPC":{"shape":"VPC"},
"Location":{
"shape":"ResourceURI",
"documentation":"The unique URL representing the new hosted zone.
",
"location":"header",
"locationName":"Location"
}
},
"documentation":"A complex type containing the response information for the new hosted zone.
"
},
"CreateReusableDelegationSetRequest":{
"type":"structure",
"required":["CallerReference"],
"members":{
"CallerReference":{
"shape":"Nonce",
"documentation":"A unique string that identifies the request and that allows failed CreateReusableDelegationSet requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a reusable delegation set. 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.
"
},
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"The ID of the hosted zone whose delegation set you want to mark as reusable. It is an optional parameter.
"
}
}
},
"CreateReusableDelegationSetResponse":{
"type":"structure",
"required":[
"DelegationSet",
"Location"
],
"members":{
"DelegationSet":{
"shape":"DelegationSet",
"documentation":"A complex type that contains name server information.
"
},
"Location":{
"shape":"ResourceURI",
"documentation":"The unique URL representing the new reusbale delegation set.
",
"location":"header",
"locationName":"Location"
}
}
},
"CreateTrafficPolicyInstanceRequest":{
"type":"structure",
"required":[
"HostedZoneId",
"Name",
"TTL",
"TrafficPolicyId",
"TrafficPolicyVersion"
],
"members":{
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"The ID of the hosted zone in which you want Amazon Route 53 to create resource record sets by using the configuration in a traffic policy.
"
},
"Name":{
"shape":"DNSName",
"documentation":"The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Amazon Route 53 creates for this traffic policy instance.
"
},
"TTL":{
"shape":"TTL",
"documentation":"The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.
"
},
"TrafficPolicyId":{
"shape":"TrafficPolicyId",
"documentation":"The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
"
},
"TrafficPolicyVersion":{
"shape":"TrafficPolicyVersion",
"documentation":"The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
"
}
},
"documentation":"A complex type that contains information about the resource record sets that you want to create based on a specified traffic policy.
"
},
"CreateTrafficPolicyInstanceResponse":{
"type":"structure",
"required":[
"TrafficPolicyInstance",
"Location"
],
"members":{
"TrafficPolicyInstance":{
"shape":"TrafficPolicyInstance",
"documentation":"A complex type that contains settings for the new traffic policy instance.
"
},
"Location":{
"shape":"ResourceURI",
"documentation":"A unique URL that represents a new traffic policy instance.
",
"location":"header",
"locationName":"Location"
}
},
"documentation":"A complex type that contains the response information for the CreateTrafficPolicyInstance request.
"
},
"CreateTrafficPolicyRequest":{
"type":"structure",
"required":[
"Name",
"Document"
],
"members":{
"Name":{
"shape":"TrafficPolicyName",
"documentation":"The name of the traffic policy.
"
},
"Document":{
"shape":"TrafficPolicyDocument",
"documentation":"The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format in the Amazon Route 53 API Reference.
"
},
"Comment":{
"shape":"TrafficPolicyComment",
"documentation":"Any comments that you want to include about the traffic policy.
"
}
},
"documentation":"A complex type that contains information about the traffic policy that you want to create.
"
},
"CreateTrafficPolicyResponse":{
"type":"structure",
"required":[
"TrafficPolicy",
"Location"
],
"members":{
"TrafficPolicy":{
"shape":"TrafficPolicy",
"documentation":"A complex type that contains settings for the new traffic policy.
"
},
"Location":{
"shape":"ResourceURI",
"location":"header",
"locationName":"Location"
}
},
"documentation":"A complex type that contains the response information for the CreateTrafficPolicy request.
"
},
"CreateTrafficPolicyVersionRequest":{
"type":"structure",
"required":[
"Id",
"Document"
],
"members":{
"Id":{
"shape":"TrafficPolicyId",
"documentation":"The ID of the traffic policy for which you want to create a new version.
",
"location":"uri",
"locationName":"Id"
},
"Document":{
"shape":"TrafficPolicyDocument",
"documentation":"The definition of a new traffic policy version, in JSON format. You must specify the full definition of the new traffic policy. You cannot specify just the differences between the new version and a previous version. For more information, see Traffic Policy Document Format in the Amazon Route 53 API Reference.
"
},
"Comment":{
"shape":"TrafficPolicyComment",
"documentation":"Any comments that you want to include about the new traffic policy version.
"
}
},
"documentation":"A complex type that contains information about the traffic policy for which you want to create a new version.
"
},
"CreateTrafficPolicyVersionResponse":{
"type":"structure",
"required":[
"TrafficPolicy",
"Location"
],
"members":{
"TrafficPolicy":{
"shape":"TrafficPolicy",
"documentation":"A complex type that contains settings for the new version of the traffic policy.
"
},
"Location":{
"shape":"ResourceURI",
"location":"header",
"locationName":"Location"
}
},
"documentation":"A complex type that contains the response information for the CreateTrafficPolicyVersion request.
"
},
"DNSName":{
"type":"string",
"max":1024
},
"Date":{
"type":"string",
"deprecated":true,
"max":256
},
"DelegationSet":{
"type":"structure",
"required":["NameServers"],
"members":{
"Id":{"shape":"ResourceId"},
"CallerReference":{"shape":"Nonce"},
"NameServers":{
"shape":"DelegationSetNameServers",
"documentation":"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.
"
}
},
"documentation":"A complex type that contains name server information.
"
},
"DelegationSetAlreadyCreated":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"A delegation set with the same owner and caller reference combination has already been created.
",
"exception":true
},
"DelegationSetAlreadyReusable":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The specified delegation set has already been marked as reusable.
",
"exception":true
},
"DelegationSetInUse":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.
",
"exception":true
},
"DelegationSetNameServers":{
"type":"list",
"member":{
"shape":"DNSName",
"locationName":"NameServer"
},
"min":1
},
"DelegationSetNotAvailable":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"Amazon Route 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 Amazon Route 53 generates this error, you can request an increase to the limit on the Contact Us page.
",
"exception":true
},
"DelegationSetNotReusable":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The specified delegation set has not been marked as reusable.
",
"exception":true
},
"DelegationSets":{
"type":"list",
"member":{
"shape":"DelegationSet",
"locationName":"DelegationSet"
}
},
"DeleteHealthCheckRequest":{
"type":"structure",
"required":["HealthCheckId"],
"members":{
"HealthCheckId":{
"shape":"HealthCheckId",
"documentation":"The ID of the health check to delete.
",
"location":"uri",
"locationName":"HealthCheckId"
}
},
"documentation":"A complex type containing the request information for delete health check.
"
},
"DeleteHealthCheckResponse":{
"type":"structure",
"members":{
},
"documentation":"Empty response for the request.
"
},
"DeleteHostedZoneRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"The ID of the hosted zone you want to delete.
",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"A complex type that contains information about the hosted zone that you want to delete.
"
},
"DeleteHostedZoneResponse":{
"type":"structure",
"required":["ChangeInfo"],
"members":{
"ChangeInfo":{
"shape":"ChangeInfo",
"documentation":"A complex type that contains the ID, the status, and the date and time of your delete request.
"
}
},
"documentation":"A complex type containing the response information for the request.
"
},
"DeleteReusableDelegationSetRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"The ID of the reusable delegation set you want to delete.
",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"A complex type containing the information for the delete request.
"
},
"DeleteReusableDelegationSetResponse":{
"type":"structure",
"members":{
},
"documentation":"Empty response for the request.
"
},
"DeleteTrafficPolicyInstanceRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"TrafficPolicyInstanceId",
"documentation":"The ID of the traffic policy instance that you want to delete.
When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance. ",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"A complex type that contains information about the traffic policy instance that you want to delete.
"
},
"DeleteTrafficPolicyInstanceResponse":{
"type":"structure",
"members":{
},
"documentation":"An empty element.
"
},
"DeleteTrafficPolicyRequest":{
"type":"structure",
"required":[
"Id",
"Version"
],
"members":{
"Id":{
"shape":"TrafficPolicyId",
"documentation":"The ID of the traffic policy that you want to delete.
",
"location":"uri",
"locationName":"Id"
},
"Version":{
"shape":"TrafficPolicyVersion",
"documentation":"The version number of the traffic policy that you want to delete.
",
"location":"uri",
"locationName":"Version"
}
},
"documentation":"A request to delete a specified traffic policy version.
"
},
"DeleteTrafficPolicyResponse":{
"type":"structure",
"members":{
},
"documentation":"An empty element.
"
},
"Dimension":{
"type":"structure",
"required":[
"Name",
"Value"
],
"members":{
"Name":{
"shape":"DimensionField",
"documentation":"The name of the dimension.
"
},
"Value":{
"shape":"DimensionField",
"documentation":"The value of the dimension.
"
}
},
"documentation":"The name and value of a dimension for a CloudWatch metric.
"
},
"DimensionField":{
"type":"string",
"max":255,
"min":1
},
"DimensionList":{
"type":"list",
"member":{
"shape":"Dimension",
"locationName":"Dimension"
},
"max":10
},
"DisassociateVPCComment":{"type":"string"},
"DisassociateVPCFromHostedZoneRequest":{
"type":"structure",
"required":[
"HostedZoneId",
"VPC"
],
"members":{
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"The ID of the hosted zone you want to disassociate your VPC from.
Note that you cannot disassociate the last VPC from a hosted zone.
",
"location":"uri",
"locationName":"Id"
},
"VPC":{
"shape":"VPC",
"documentation":"The VPC that you want your hosted zone to be disassociated from.
"
},
"Comment":{
"shape":"DisassociateVPCComment",
"documentation":"Optional: Any comments you want to include about a DisassociateVPCFromHostedZoneRequest.
"
}
},
"documentation":"A complex type that contains information about the request to disassociate a VPC from an hosted zone.
"
},
"DisassociateVPCFromHostedZoneResponse":{
"type":"structure",
"required":["ChangeInfo"],
"members":{
"ChangeInfo":{
"shape":"ChangeInfo",
"documentation":"A complex type that contains the ID, the status, and the date and time of your DisassociateVPCFromHostedZoneRequest.
"
}
},
"documentation":"A complex type containing the response information for the request.
"
},
"EnableSNI":{"type":"boolean"},
"ErrorMessage":{"type":"string"},
"ErrorMessages":{
"type":"list",
"member":{
"shape":"ErrorMessage",
"locationName":"Message"
}
},
"EvaluationPeriods":{
"type":"integer",
"min":1
},
"FailureThreshold":{
"type":"integer",
"max":10,
"min":1
},
"FullyQualifiedDomainName":{
"type":"string",
"max":255
},
"GeoLocation":{
"type":"structure",
"members":{
"ContinentCode":{
"shape":"GeoLocationContinentCode",
"documentation":"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":{
"shape":"GeoLocationCountryCode",
"documentation":"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":{
"shape":"GeoLocationSubdivisionCode",
"documentation":"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.
"
}
},
"documentation":"A complex type that contains information about a geo location.
"
},
"GeoLocationContinentCode":{
"type":"string",
"max":2,
"min":2
},
"GeoLocationContinentName":{
"type":"string",
"max":32,
"min":1
},
"GeoLocationCountryCode":{
"type":"string",
"max":2,
"min":1
},
"GeoLocationCountryName":{
"type":"string",
"max":64,
"min":1
},
"GeoLocationDetails":{
"type":"structure",
"members":{
"ContinentCode":{
"shape":"GeoLocationContinentCode",
"documentation":"The code for a continent geo location. Note: only continent locations have a continent code.
"
},
"ContinentName":{
"shape":"GeoLocationContinentName",
"documentation":"The name of the continent. This element is only present if ContinentCode is also present.
"
},
"CountryCode":{
"shape":"GeoLocationCountryCode",
"documentation":"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":{
"shape":"GeoLocationCountryName",
"documentation":"The name of the country. This element is only present if CountryCode is also present.
"
},
"SubdivisionCode":{
"shape":"GeoLocationSubdivisionCode",
"documentation":"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":{
"shape":"GeoLocationSubdivisionName",
"documentation":"The name of the subdivision. This element is only present if SubdivisionCode is also present.
"
}
},
"documentation":"A complex type that contains information about a GeoLocation.
"
},
"GeoLocationDetailsList":{
"type":"list",
"member":{
"shape":"GeoLocationDetails",
"locationName":"GeoLocationDetails"
}
},
"GeoLocationSubdivisionCode":{
"type":"string",
"max":3,
"min":1
},
"GeoLocationSubdivisionName":{
"type":"string",
"max":64,
"min":1
},
"GetChangeDetailsRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"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.
",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"The input for a GetChangeDetails request.
",
"deprecated":true
},
"GetChangeDetailsResponse":{
"type":"structure",
"required":["ChangeBatchRecord"],
"members":{
"ChangeBatchRecord":{
"shape":"ChangeBatchRecord",
"documentation":"A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the contained changes.
"
}
},
"documentation":"A complex type that contains the ChangeBatchRecord element.
",
"deprecated":true
},
"GetChangeRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"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.
",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"The input for a GetChange request.
"
},
"GetChangeResponse":{
"type":"structure",
"required":["ChangeInfo"],
"members":{
"ChangeInfo":{
"shape":"ChangeInfo",
"documentation":"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.
"
}
},
"documentation":"A complex type that contains the ChangeInfo element.
"
},
"GetCheckerIpRangesRequest":{
"type":"structure",
"members":{
},
"documentation":"Empty request.
"
},
"GetCheckerIpRangesResponse":{
"type":"structure",
"required":["CheckerIpRanges"],
"members":{
"CheckerIpRanges":{
"shape":"CheckerIpRanges",
"documentation":"A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.
"
}
},
"documentation":"A complex type that contains the CheckerIpRanges element.
"
},
"GetGeoLocationRequest":{
"type":"structure",
"members":{
"ContinentCode":{
"shape":"GeoLocationContinentCode",
"documentation":"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.
",
"location":"querystring",
"locationName":"continentcode"
},
"CountryCode":{
"shape":"GeoLocationCountryCode",
"documentation":"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.
",
"location":"querystring",
"locationName":"countrycode"
},
"SubdivisionCode":{
"shape":"GeoLocationSubdivisionCode",
"documentation":"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.
",
"location":"querystring",
"locationName":"subdivisioncode"
}
},
"documentation":"A complex type that contains information about the request to get a geo location.
"
},
"GetGeoLocationResponse":{
"type":"structure",
"required":["GeoLocationDetails"],
"members":{
"GeoLocationDetails":{
"shape":"GeoLocationDetails",
"documentation":"A complex type that contains the information about the specified geo location.
"
}
},
"documentation":"A complex type containing information about the specified geo location.
"
},
"GetHealthCheckCountRequest":{
"type":"structure",
"members":{
},
"documentation":"To retrieve a count of all your health checks, send a GET request to the /Route 53 API version/healthcheckcount resource.
"
},
"GetHealthCheckCountResponse":{
"type":"structure",
"required":["HealthCheckCount"],
"members":{
"HealthCheckCount":{
"shape":"HealthCheckCount",
"documentation":"The number of health checks associated with the current AWS account.
"
}
},
"documentation":"A complex type that contains the count of health checks associated with the current AWS account.
"
},
"GetHealthCheckLastFailureReasonRequest":{
"type":"structure",
"required":["HealthCheckId"],
"members":{
"HealthCheckId":{
"shape":"HealthCheckId",
"documentation":"The ID of the health check for which you want to retrieve the reason for the most recent failure.
",
"location":"uri",
"locationName":"HealthCheckId"
}
},
"documentation":"A complex type that contains information about the request to get the most recent failure reason for a health check.
"
},
"GetHealthCheckLastFailureReasonResponse":{
"type":"structure",
"required":["HealthCheckObservations"],
"members":{
"HealthCheckObservations":{
"shape":"HealthCheckObservations",
"documentation":"A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker.
"
}
},
"documentation":"A complex type that contains information about the most recent failure for the specified health check.
"
},
"GetHealthCheckRequest":{
"type":"structure",
"required":["HealthCheckId"],
"members":{
"HealthCheckId":{
"shape":"HealthCheckId",
"documentation":"The ID of the health check to retrieve.
",
"location":"uri",
"locationName":"HealthCheckId"
}
},
"documentation":"A complex type that contains information about the request to get a health check.
"
},
"GetHealthCheckResponse":{
"type":"structure",
"required":["HealthCheck"],
"members":{
"HealthCheck":{
"shape":"HealthCheck",
"documentation":"A complex type that contains the information about the specified health check.
"
}
},
"documentation":"A complex type containing information about the specified health check.
"
},
"GetHealthCheckStatusRequest":{
"type":"structure",
"required":["HealthCheckId"],
"members":{
"HealthCheckId":{
"shape":"HealthCheckId",
"documentation":"If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.
Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.
The HealthCheckId element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:
- You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.
You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. For more information about this configuration, see EvaluateTargetHealth.
Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.
For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is *), in that order, until it finds a resource record set for which the endpoint is healthy.
If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-1-www.example.com), not the name of the resource record sets (example.com).
In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and then associate the health check with those resource record sets, health check results will be unpredictable. ",
"location":"uri",
"locationName":"HealthCheckId"
}
},
"documentation":"A complex type that contains information about the request to get health check status for a health check.
"
},
"GetHealthCheckStatusResponse":{
"type":"structure",
"required":["HealthCheckObservations"],
"members":{
"HealthCheckObservations":{
"shape":"HealthCheckObservations",
"documentation":"A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker.
"
}
},
"documentation":"A complex type that contains information about the status of the specified health check.
"
},
"GetHostedZoneCountRequest":{
"type":"structure",
"members":{
},
"documentation":"To retrieve a count of all your hosted zones, send a GET request to the /Route 53 API version/hostedzonecount resource.
"
},
"GetHostedZoneCountResponse":{
"type":"structure",
"required":["HostedZoneCount"],
"members":{
"HostedZoneCount":{
"shape":"HostedZoneCount",
"documentation":"The number of hosted zones associated with the current AWS account.
"
}
},
"documentation":"A complex type that contains the count of hosted zones associated with the current AWS account.
"
},
"GetHostedZoneRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.
",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"The input for a GetHostedZone request.
"
},
"GetHostedZoneResponse":{
"type":"structure",
"required":["HostedZone"],
"members":{
"HostedZone":{
"shape":"HostedZone",
"documentation":"A complex type that contains the information about the specified hosted zone.
"
},
"DelegationSet":{
"shape":"DelegationSet",
"documentation":"A complex type that contains information about the name servers for the specified hosted zone.
"
},
"VPCs":{
"shape":"VPCs",
"documentation":"A complex type that contains information about VPCs associated with the specified hosted zone.
"
}
},
"documentation":"A complex type containing information about the specified hosted zone.
"
},
"GetReusableDelegationSetRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"The ID of the reusable delegation set for which you want to get a list of the name server.
",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"The input for a GetReusableDelegationSet request.
"
},
"GetReusableDelegationSetResponse":{
"type":"structure",
"required":["DelegationSet"],
"members":{
"DelegationSet":{
"shape":"DelegationSet",
"documentation":"A complex type that contains the information about the nameservers for the specified delegation set ID.
"
}
},
"documentation":"A complex type containing information about the specified reusable delegation set.
"
},
"GetTrafficPolicyInstanceCountRequest":{
"type":"structure",
"members":{
},
"documentation":"To retrieve a count of all your traffic policy instances, send a GET request to the /Route 53 API version/trafficpolicyinstancecount resource.
"
},
"GetTrafficPolicyInstanceCountResponse":{
"type":"structure",
"required":["TrafficPolicyInstanceCount"],
"members":{
"TrafficPolicyInstanceCount":{
"shape":"TrafficPolicyInstanceCount",
"documentation":"The number of traffic policy instances that are associated with the current AWS account.
"
}
},
"documentation":"A complex type that contains information about the number of traffic policy instances that are associated with the current AWS account.
"
},
"GetTrafficPolicyInstanceRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"TrafficPolicyInstanceId",
"documentation":"The ID of the traffic policy instance that you want to get information about.
",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"Gets information about a specified traffic policy instance.
To get information about a traffic policy instance, send a GET request to the /Route 53 API version/trafficpolicyinstance/Id resource.
"
},
"GetTrafficPolicyInstanceResponse":{
"type":"structure",
"required":["TrafficPolicyInstance"],
"members":{
"TrafficPolicyInstance":{
"shape":"TrafficPolicyInstance",
"documentation":"A complex type that contains settings for the traffic policy instance.
"
}
},
"documentation":"A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.
"
},
"GetTrafficPolicyRequest":{
"type":"structure",
"required":[
"Id",
"Version"
],
"members":{
"Id":{
"shape":"TrafficPolicyId",
"documentation":"The ID of the traffic policy that you want to get information about.
",
"location":"uri",
"locationName":"Id"
},
"Version":{
"shape":"TrafficPolicyVersion",
"documentation":"The version number of the traffic policy that you want to get information about.
",
"location":"uri",
"locationName":"Version"
}
},
"documentation":"Gets information about a specific traffic policy version. To get the information, send a GET request to the /Route 53 API version/trafficpolicy resource, and specify the ID and the version of the traffic policy.
"
},
"GetTrafficPolicyResponse":{
"type":"structure",
"required":["TrafficPolicy"],
"members":{
"TrafficPolicy":{
"shape":"TrafficPolicy",
"documentation":"A complex type that contains settings for the specified traffic policy.
"
}
},
"documentation":"A complex type that contains the response information for the request.
"
},
"HealthCheck":{
"type":"structure",
"required":[
"Id",
"CallerReference",
"HealthCheckConfig",
"HealthCheckVersion"
],
"members":{
"Id":{
"shape":"HealthCheckId",
"documentation":"The ID of the specified health check.
"
},
"CallerReference":{
"shape":"HealthCheckNonce",
"documentation":"A unique string that identifies the request to create the health check.
"
},
"HealthCheckConfig":{
"shape":"HealthCheckConfig",
"documentation":"A complex type that contains the health check configuration.
"
},
"HealthCheckVersion":{
"shape":"HealthCheckVersion",
"documentation":"The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
"
},
"CloudWatchAlarmConfiguration":{
"shape":"CloudWatchAlarmConfiguration",
"documentation":"For CLOUDWATCH_METRIC health checks, a complex type that contains information about the CloudWatch alarm that you're associating with the health check.
"
}
},
"documentation":"A complex type that contains identifying information about the health check.
"
},
"HealthCheckAlreadyExists":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The health check you are trying to create already exists. Amazon Route 53 returns this error when a health check has already been created with the specified CallerReference.
",
"error":{"httpStatusCode":409},
"exception":true
},
"HealthCheckConfig":{
"type":"structure",
"required":["Type"],
"members":{
"IPAddress":{
"shape":"IPAddress",
"documentation":"IP Address of the instance being checked.
"
},
"Port":{
"shape":"Port",
"documentation":"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":{
"shape":"HealthCheckType",
"documentation":"The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, CALCULATED and CLOUDWATCH_METRIC.
"
},
"ResourcePath":{
"shape":"ResourcePath",
"documentation":"Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks. The HTTP request is issued to the instance on the given port and path.
"
},
"FullyQualifiedDomainName":{
"shape":"FullyQualifiedDomainName",
"documentation":"Fully qualified domain name of the instance to be health checked.
"
},
"SearchString":{
"shape":"SearchString",
"documentation":"A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks. Amazon Route 53 considers case when searching for SearchString in the response body.
"
},
"RequestInterval":{
"shape":"RequestInterval",
"documentation":"The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Amazon Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
"
},
"FailureThreshold":{
"shape":"FailureThreshold",
"documentation":"The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
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.
"
},
"MeasureLatency":{
"shape":"MeasureLatency",
"documentation":"A Boolean value that indicates whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Amazon Route 53 console.
"
},
"Inverted":{
"shape":"Inverted",
"documentation":"A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True, then Amazon Route 53 considers the health check to be unhealthy.
"
},
"HealthThreshold":{
"shape":"HealthThreshold",
"documentation":"The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
"
},
"ChildHealthChecks":{
"shape":"ChildHealthCheckList",
"documentation":"For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
"
},
"EnableSNI":{
"shape":"EnableSNI",
"documentation":"Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI, Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.
"
},
"Regions":{
"shape":"HealthCheckRegionList",
"documentation":"A list of HealthCheckRegion values that you want Amazon Route 53 to use to perform health checks for the specified endpoint. You must specify at least three regions.
"
},
"AlarmIdentifier":{
"shape":"AlarmIdentifier",
"documentation":"A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
"
},
"InsufficientDataHealthStatus":{
"shape":"InsufficientDataHealthStatus",
"documentation":"The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy, Unhealthy and LastKnownStatus.
"
}
},
"documentation":"A complex type that contains the health check configuration.
"
},
"HealthCheckCount":{"type":"long"},
"HealthCheckId":{
"type":"string",
"max":64
},
"HealthCheckInUse":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"There are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets.
",
"error":{"httpStatusCode":400},
"exception":true
},
"HealthCheckNonce":{
"type":"string",
"max":64,
"min":1
},
"HealthCheckObservation":{
"type":"structure",
"members":{
"Region":{
"shape":"HealthCheckRegion",
"documentation":"The HealthCheckRegion of the Amazon Route 53 health checker that performed this health check.
"
},
"IPAddress":{
"shape":"IPAddress",
"documentation":"The IP address of the Amazon Route 53 health checker that performed this health check.
"
},
"StatusReport":{
"shape":"StatusReport",
"documentation":"A complex type that contains information about the health check status for the current observation.
"
}
},
"documentation":"A complex type that contains the IP address of a Amazon Route 53 health checker and the reason for the health check status.
"
},
"HealthCheckObservations":{
"type":"list",
"member":{
"shape":"HealthCheckObservation",
"locationName":"HealthCheckObservation"
}
},
"HealthCheckRegion":{
"type":"string",
"documentation":"An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.
",
"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"
],
"max":64,
"min":1
},
"HealthCheckRegionList":{
"type":"list",
"member":{
"shape":"HealthCheckRegion",
"locationName":"Region"
},
"max":64,
"min":1
},
"HealthCheckType":{
"type":"string",
"enum":[
"HTTP",
"HTTPS",
"HTTP_STR_MATCH",
"HTTPS_STR_MATCH",
"TCP",
"CALCULATED",
"CLOUDWATCH_METRIC"
]
},
"HealthCheckVersion":{
"type":"long",
"min":1
},
"HealthCheckVersionMismatch":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"error":{"httpStatusCode":409},
"exception":true
},
"HealthChecks":{
"type":"list",
"member":{
"shape":"HealthCheck",
"locationName":"HealthCheck"
}
},
"HealthThreshold":{
"type":"integer",
"max":256,
"min":0
},
"HostedZone":{
"type":"structure",
"required":[
"Id",
"Name",
"CallerReference"
],
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"The ID of the specified hosted zone.
"
},
"Name":{
"shape":"DNSName",
"documentation":"The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon 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":{
"shape":"Nonce",
"documentation":"A unique string that identifies the request to create the hosted zone.
"
},
"Config":{
"shape":"HostedZoneConfig",
"documentation":"A complex type that contains the Comment element.
"
},
"ResourceRecordSetCount":{
"shape":"HostedZoneRRSetCount",
"documentation":"Total number of resource record sets in the hosted zone.
"
}
},
"documentation":"A complex type that contain information about the specified hosted zone.
"
},
"HostedZoneAlreadyExists":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The hosted zone you are trying to create already exists. Amazon Route 53 returns this error when a hosted zone has already been created with the specified CallerReference.
",
"error":{"httpStatusCode":409},
"exception":true
},
"HostedZoneConfig":{
"type":"structure",
"members":{
"Comment":{
"shape":"ResourceDescription",
"documentation":"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.
"
},
"PrivateZone":{
"shape":"IsPrivateZone",
"documentation":"GetHostedZone and ListHostedZone responses: A Boolean value that indicates whether a hosted zone is private.
CreateHostedZone requests: When you're creating a private hosted zone (when you specify values for VPCId and VPCRegion), you can optionally specify true for PrivateZone.
"
}
},
"documentation":"A complex type that contains 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.
"
},
"HostedZoneCount":{"type":"long"},
"HostedZoneNotEmpty":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The 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.
",
"error":{"httpStatusCode":400},
"exception":true
},
"HostedZoneNotFound":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The specified HostedZone cannot be found.
",
"exception":true
},
"HostedZoneRRSetCount":{"type":"long"},
"HostedZones":{
"type":"list",
"member":{
"shape":"HostedZone",
"locationName":"HostedZone"
}
},
"IPAddress":{
"type":"string",
"max":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])$"
},
"IPAddressCidr":{"type":"string"},
"IncompatibleVersion":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.
",
"error":{"httpStatusCode":400},
"exception":true
},
"InsufficientDataHealthStatus":{
"type":"string",
"enum":[
"Healthy",
"Unhealthy",
"LastKnownStatus"
]
},
"InvalidArgument":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"At least one of the specified arguments is invalid.
",
"exception":true
},
"InvalidChangeBatch":{
"type":"structure",
"members":{
"messages":{
"shape":"ErrorMessages",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"This error contains a list of one or more error messages. Each error message indicates one error in the change batch.
",
"exception":true
},
"InvalidDomainName":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"This error indicates that the specified domain name is not valid.
",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidInput":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"Some value specified in the request is invalid or the XML document is malformed.
",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidTrafficPolicyDocument":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The format of the traffic policy document that you specified in the Document element is invalid.
",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidVPCId":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The hosted zone you are trying to create for your VPC_ID does not belong to you. Amazon Route 53 returns this error when the VPC specified by VPCId does not belong to you.
",
"error":{"httpStatusCode":400},
"exception":true
},
"Inverted":{"type":"boolean"},
"IsPrivateZone":{"type":"boolean"},
"LastVPCAssociation":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The VPC you are trying to disassociate from the hosted zone is the last the VPC that is associated with the hosted zone. Amazon Route 53 currently doesn't support disassociate the last VPC from the hosted zone.
",
"error":{"httpStatusCode":400},
"exception":true
},
"LimitsExceeded":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The limits specified for a resource have been exceeded.
",
"exception":true
},
"ListChangeBatchesByHostedZoneRequest":{
"type":"structure",
"required":[
"HostedZoneId",
"StartDate",
"EndDate"
],
"members":{
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"The ID of the hosted zone that you want to see changes for.
",
"location":"uri",
"locationName":"Id"
},
"StartDate":{
"shape":"Date",
"documentation":"The start of the time period you want to see changes for.
",
"location":"querystring",
"locationName":"startDate"
},
"EndDate":{
"shape":"Date",
"documentation":"The end of the time period you want to see changes for.
",
"location":"querystring",
"locationName":"endDate"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of items on a page.
",
"location":"querystring",
"locationName":"maxItems"
},
"Marker":{
"shape":"PageMarker",
"documentation":"The page marker.
",
"location":"querystring",
"locationName":"marker"
}
},
"documentation":"The input for a ListChangeBatchesByHostedZone request.
",
"deprecated":true
},
"ListChangeBatchesByHostedZoneResponse":{
"type":"structure",
"required":[
"MaxItems",
"Marker",
"ChangeBatchRecords"
],
"members":{
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of items on a page.
"
},
"Marker":{
"shape":"PageMarker",
"documentation":"The page marker.
"
},
"IsTruncated":{
"shape":"PageTruncated",
"documentation":"A flag that indicates if there are more change batches to list.
"
},
"ChangeBatchRecords":{
"shape":"ChangeBatchRecords",
"documentation":"The change batches within the given hosted zone and time period.
"
},
"NextMarker":{
"shape":"PageMarker",
"documentation":"The next page marker.
"
}
},
"documentation":"The input for a ListChangeBatchesByHostedZone request.
",
"deprecated":true
},
"ListChangeBatchesByRRSetRequest":{
"type":"structure",
"required":[
"HostedZoneId",
"Name",
"Type",
"StartDate",
"EndDate"
],
"members":{
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"The ID of the hosted zone that you want to see changes for.
",
"location":"uri",
"locationName":"Id"
},
"Name":{
"shape":"DNSName",
"documentation":"The name of the RRSet that you want to see changes for.
",
"location":"querystring",
"locationName":"rrSet_name"
},
"Type":{
"shape":"RRType",
"documentation":"The type of the RRSet that you want to see changes for.
",
"location":"querystring",
"locationName":"type"
},
"SetIdentifier":{
"shape":"ResourceRecordSetIdentifier",
"documentation":"The identifier of the RRSet that you want to see changes for.
",
"location":"querystring",
"locationName":"identifier"
},
"StartDate":{
"shape":"Date",
"documentation":"The start of the time period you want to see changes for.
",
"location":"querystring",
"locationName":"startDate"
},
"EndDate":{
"shape":"Date",
"documentation":"The end of the time period you want to see changes for.
",
"location":"querystring",
"locationName":"endDate"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of items on a page.
",
"location":"querystring",
"locationName":"maxItems"
},
"Marker":{
"shape":"PageMarker",
"documentation":"The page marker.
",
"location":"querystring",
"locationName":"marker"
}
},
"documentation":"The input for a ListChangeBatchesByRRSet request.
",
"deprecated":true
},
"ListChangeBatchesByRRSetResponse":{
"type":"structure",
"required":[
"MaxItems",
"Marker",
"ChangeBatchRecords"
],
"members":{
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of items on a page.
"
},
"Marker":{
"shape":"PageMarker",
"documentation":"The page marker.
"
},
"IsTruncated":{
"shape":"PageTruncated",
"documentation":"A flag that indicates if there are more change batches to list.
"
},
"ChangeBatchRecords":{
"shape":"ChangeBatchRecords",
"documentation":"The change batches within the given hosted zone and time period.
"
},
"NextMarker":{
"shape":"PageMarker",
"documentation":"The next page marker.
"
}
},
"documentation":"The input for a ListChangeBatchesByRRSet request.
",
"deprecated":true
},
"ListGeoLocationsRequest":{
"type":"structure",
"members":{
"StartContinentCode":{
"shape":"GeoLocationContinentCode",
"documentation":"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.
",
"location":"querystring",
"locationName":"startcontinentcode"
},
"StartCountryCode":{
"shape":"GeoLocationCountryCode",
"documentation":"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.
",
"location":"querystring",
"locationName":"startcountrycode"
},
"StartSubdivisionCode":{
"shape":"GeoLocationSubdivisionCode",
"documentation":"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.
",
"location":"querystring",
"locationName":"startsubdivisioncode"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of geo locations you want in the response body.
",
"location":"querystring",
"locationName":"maxitems"
}
},
"documentation":"The input for a ListGeoLocations request.
"
},
"ListGeoLocationsResponse":{
"type":"structure",
"required":[
"GeoLocationDetailsList",
"IsTruncated",
"MaxItems"
],
"members":{
"GeoLocationDetailsList":{
"shape":"GeoLocationDetailsList",
"documentation":"A complex type that contains information about the geo locations that are returned by the request.
"
},
"IsTruncated":{
"shape":"PageTruncated",
"documentation":"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 NextContinentCode, NextCountryCode, and NextSubdivisionCode elements.
Valid Values: true | false
"
},
"NextContinentCode":{
"shape":"GeoLocationContinentCode",
"documentation":"If the results were truncated, the continent code of the next geo location in the list. This element is present only if IsTruncated is true and the next geo location to list is a continent location.
"
},
"NextCountryCode":{
"shape":"GeoLocationCountryCode",
"documentation":"If the results were truncated, the country code of the next geo location in the list. This element is present only if IsTruncated is true and the next geo location to list is not a continent location.
"
},
"NextSubdivisionCode":{
"shape":"GeoLocationSubdivisionCode",
"documentation":"If the results were truncated, the subdivision code of the next geo location in the list. This element is present only if IsTruncated is true and the next geo location has a subdivision.
"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of records you requested. The maximum value of MaxItems is 100.
"
}
},
"documentation":"A complex type that contains information about the geo locations that are returned by the request and information about the response.
"
},
"ListHealthChecksRequest":{
"type":"structure",
"members":{
"Marker":{
"shape":"PageMarker",
"documentation":"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.
",
"location":"querystring",
"locationName":"marker"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"Specify the maximum number of health checks to return per page of results.
",
"location":"querystring",
"locationName":"maxitems"
}
},
"documentation":"To retrieve a list of your health checks, send a GET request to the /Route 53 API version/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.
Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100. "
},
"ListHealthChecksResponse":{
"type":"structure",
"required":[
"HealthChecks",
"Marker",
"IsTruncated",
"MaxItems"
],
"members":{
"HealthChecks":{
"shape":"HealthChecks",
"documentation":"A complex type that contains information about the health checks associated with the current AWS account.
"
},
"Marker":{
"shape":"PageMarker",
"documentation":"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":{
"shape":"PageTruncated",
"documentation":"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":{
"shape":"PageMarker",
"documentation":"Indicates where to continue listing health checks. If 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":{
"shape":"PageMaxItems",
"documentation":"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 IsTruncated in the response is true. Call ListHealthChecks again and specify the value of NextMarker from the last response in the Marker element of the next request to get the next page of results.
"
}
},
"documentation":"A complex type that contains the response for the request.
"
},
"ListHostedZonesByNameRequest":{
"type":"structure",
"members":{
"DNSName":{
"shape":"DNSName",
"documentation":"The first name in the lexicographic ordering of domain names that you want the ListHostedZonesByNameRequest request to list.
If the request returned more than one page of results, submit another request and specify the value of NextDNSName and NextHostedZoneId from the last response in the DNSName and HostedZoneId parameters to get the next page of results.
",
"location":"querystring",
"locationName":"dnsname"
},
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"If the request returned more than one page of results, submit another request and specify the value of NextDNSName and NextHostedZoneId from the last response in the DNSName and HostedZoneId parameters to get the next page of results.
",
"location":"querystring",
"locationName":"hostedzoneid"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"Specify the maximum number of hosted zones to return per page of results.
",
"location":"querystring",
"locationName":"maxitems"
}
},
"documentation":"To retrieve a list of your hosted zones in lexicographic order, send a GET request to the /Route 53 API version/hostedzonesbyname resource. The response to this request includes a HostedZones element with zero or more HostedZone child elements lexicographically ordered by DNS name. 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 DNSName and HostedZoneId parameters to control the hosted zone that the list begins with.
"
},
"ListHostedZonesByNameResponse":{
"type":"structure",
"required":[
"HostedZones",
"IsTruncated",
"MaxItems"
],
"members":{
"HostedZones":{
"shape":"HostedZones",
"documentation":"A complex type that contains information about the hosted zones associated with the current AWS account.
"
},
"DNSName":{
"shape":"DNSName",
"documentation":"The DNSName value sent in the request.
"
},
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"The HostedZoneId value sent in the request.
"
},
"IsTruncated":{
"shape":"PageTruncated",
"documentation":"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 NextDNSName and NextHostedZoneId elements.
Valid Values: true | false
"
},
"NextDNSName":{
"shape":"DNSName",
"documentation":"If the value of IsTruncated in the ListHostedZonesByNameResponse is true, there are more hosted zones associated with the current AWS account. To get the next page of results, make another request to ListHostedZonesByName. Specify the value of NextDNSName in the DNSName parameter. Specify NextHostedZoneId in the HostedZoneId parameter.
"
},
"NextHostedZoneId":{
"shape":"ResourceId",
"documentation":"If the value of IsTruncated in the ListHostedZonesByNameResponse is true, there are more hosted zones associated with the current AWS account. To get the next page of results, make another request to ListHostedZonesByName. Specify the value of NextDNSName in the DNSName parameter. Specify NextHostedZoneId in the HostedZoneId parameter.
"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"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 IsTruncated in the ListHostedZonesByNameResponse is true. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId elements from the previous response to get the next page of results.
"
}
},
"documentation":"A complex type that contains the response for the request.
"
},
"ListHostedZonesRequest":{
"type":"structure",
"members":{
"Marker":{
"shape":"PageMarker",
"documentation":"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.
",
"location":"querystring",
"locationName":"marker"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"Specify the maximum number of hosted zones to return per page of results.
",
"location":"querystring",
"locationName":"maxitems"
},
"DelegationSetId":{
"shape":"ResourceId",
"location":"querystring",
"locationName":"delegationsetid"
}
},
"documentation":"To retrieve a list of your hosted zones, send a GET request to the /Route 53 API version/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.
Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100. "
},
"ListHostedZonesResponse":{
"type":"structure",
"required":[
"HostedZones",
"Marker",
"IsTruncated",
"MaxItems"
],
"members":{
"HostedZones":{
"shape":"HostedZones",
"documentation":"A complex type that contains information about the hosted zones associated with the current AWS account.
"
},
"Marker":{
"shape":"PageMarker",
"documentation":"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":{
"shape":"PageTruncated",
"documentation":"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":{
"shape":"PageMarker",
"documentation":"Indicates where to continue listing hosted zones. If 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":{
"shape":"PageMaxItems",
"documentation":"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 IsTruncated in the response is true. Call ListHostedZones again and specify the value of NextMarker in the Marker parameter to get the next page of results.
"
}
},
"documentation":"A complex type that contains the response for the request.
"
},
"ListResourceRecordSetsRequest":{
"type":"structure",
"required":["HostedZoneId"],
"members":{
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"The ID of the hosted zone that contains the resource record sets that you want to get.
",
"location":"uri",
"locationName":"Id"
},
"StartRecordName":{
"shape":"DNSName",
"documentation":"The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.
",
"location":"querystring",
"locationName":"name"
},
"StartRecordType":{
"shape":"RRType",
"documentation":"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.
",
"location":"querystring",
"locationName":"type"
},
"StartRecordIdentifier":{
"shape":"ResourceRecordSetIdentifier",
"documentation":"Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.
",
"location":"querystring",
"locationName":"identifier"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of records you want in the response body.
",
"location":"querystring",
"locationName":"maxitems"
}
},
"documentation":"The input for a ListResourceRecordSets request.
"
},
"ListResourceRecordSetsResponse":{
"type":"structure",
"required":[
"ResourceRecordSets",
"IsTruncated",
"MaxItems"
],
"members":{
"ResourceRecordSets":{
"shape":"ResourceRecordSets",
"documentation":"A complex type that contains information about the resource record sets that are returned by the request.
"
},
"IsTruncated":{
"shape":"PageTruncated",
"documentation":"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 NextRecordName element.
Valid Values: true | false
"
},
"NextRecordName":{
"shape":"DNSName",
"documentation":"If the results were truncated, the name of the next record in the list. This element is present only if IsTruncated is true.
"
},
"NextRecordType":{
"shape":"RRType",
"documentation":"If the results were truncated, the type of the next record in the list. This element is present only if IsTruncated is true.
"
},
"NextRecordIdentifier":{
"shape":"ResourceRecordSetIdentifier",
"documentation":"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":{
"shape":"PageMaxItems",
"documentation":"The maximum number of records you requested. The maximum value of MaxItems is 100.
"
}
},
"documentation":"A complex type that contains information about the resource record sets that are returned by the request and information about the response.
"
},
"ListReusableDelegationSetsRequest":{
"type":"structure",
"members":{
"Marker":{
"shape":"PageMarker",
"documentation":"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.
",
"location":"querystring",
"locationName":"marker"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"Specify the maximum number of reusable delegation sets to return per page of results.
",
"location":"querystring",
"locationName":"maxitems"
}
},
"documentation":"To retrieve a list of your reusable delegation sets, send a GET request to the /Route 53 API version/delegationset resource. The response to this request includes a DelegationSets element with zero or more DelegationSet child elements. By default, the list of reusable delegation sets 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 delegation set that the list begins with.
Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100. "
},
"ListReusableDelegationSetsResponse":{
"type":"structure",
"required":[
"DelegationSets",
"Marker",
"IsTruncated",
"MaxItems"
],
"members":{
"DelegationSets":{
"shape":"DelegationSets",
"documentation":"A complex type that contains information about the reusable delegation sets associated with the current AWS account.
"
},
"Marker":{
"shape":"PageMarker",
"documentation":"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":{
"shape":"PageTruncated",
"documentation":"A flag indicating whether there are more reusable delegation 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 Marker element.
Valid Values: true | false
"
},
"NextMarker":{
"shape":"PageMarker",
"documentation":"Indicates where to continue listing reusable delegation sets. If IsTruncated is true, make another request to ListReusableDelegationSets and include the value of the NextMarker element in the Marker element of the previous response to get the next page of results.
"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of reusable delegation sets to be included in the response body. If the number of reusable delegation sets associated with this AWS account exceeds MaxItems, the value of IsTruncated in the response is true. To get the next page of results, call ListReusableDelegationSets again and specify the value of NextMarker from the previous response in the Marker element of the request.
"
}
},
"documentation":"A complex type that contains the response for the request.
"
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":[
"ResourceType",
"ResourceId"
],
"members":{
"ResourceType":{
"shape":"TagResourceType",
"documentation":"The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
",
"location":"uri",
"locationName":"ResourceType"
},
"ResourceId":{
"shape":"TagResourceId",
"documentation":"The ID of the resource for which you want to retrieve tags.
",
"location":"uri",
"locationName":"ResourceId"
}
},
"documentation":"A complex type containing information about a request for a list of the tags that are associated with an individual resource.
"
},
"ListTagsForResourceResponse":{
"type":"structure",
"required":["ResourceTagSet"],
"members":{
"ResourceTagSet":{
"shape":"ResourceTagSet",
"documentation":"A ResourceTagSet containing tags associated with the specified resource.
"
}
},
"documentation":"A complex type containing tags for the specified resource.
"
},
"ListTagsForResourcesRequest":{
"type":"structure",
"required":[
"ResourceType",
"ResourceIds"
],
"members":{
"ResourceType":{
"shape":"TagResourceType",
"documentation":"The type of the resources.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
",
"location":"uri",
"locationName":"ResourceType"
},
"ResourceIds":{
"shape":"TagResourceIdList",
"documentation":"A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.
"
}
},
"documentation":"A complex type containing information about a request for a list of the tags that are associated with up to 10 specified resources.
"
},
"ListTagsForResourcesResponse":{
"type":"structure",
"required":["ResourceTagSets"],
"members":{
"ResourceTagSets":{
"shape":"ResourceTagSetList",
"documentation":"A list of ResourceTagSets containing tags associated with the specified resources.
"
}
},
"documentation":"A complex type containing tags for the specified resources.
"
},
"ListTrafficPoliciesRequest":{
"type":"structure",
"members":{
"TrafficPolicyIdMarker":{
"shape":"TrafficPolicyId",
"documentation":"For your first request to ListTrafficPolicies, do not include the TrafficPolicyIdMarker parameter.
If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of MaxItems policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of the TrafficPolicyIdMarker element that was returned in the previous response.
Policies are listed in the order in which they were created.
",
"location":"querystring",
"locationName":"trafficpolicyid"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of traffic policies to be included in the response body for this request. If you have more than MaxItems traffic policies, the value of the IsTruncated element in the response is true, and the value of the TrafficPolicyIdMarker element is the ID of the first traffic policy in the next group of MaxItems traffic policies.
",
"location":"querystring",
"locationName":"maxitems"
}
},
"documentation":"A complex type that contains the information about the request to list the traffic policies that are associated with the current AWS account.
"
},
"ListTrafficPoliciesResponse":{
"type":"structure",
"required":[
"TrafficPolicySummaries",
"IsTruncated",
"TrafficPolicyIdMarker",
"MaxItems"
],
"members":{
"TrafficPolicySummaries":{
"shape":"TrafficPolicySummaries",
"documentation":"A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current AWS account.
"
},
"IsTruncated":{
"shape":"PageTruncated",
"documentation":"A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of MaxItems traffic policies by calling ListTrafficPolicies again and specifying the value of the TrafficPolicyIdMarker element in the TrafficPolicyIdMarker request parameter.
Valid Values: true | false
"
},
"TrafficPolicyIdMarker":{
"shape":"TrafficPolicyId",
"documentation":"If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.
"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The value that you specified for the MaxItems parameter in the call to ListTrafficPolicies that produced the current response.
"
}
},
"documentation":"A complex type that contains the response information for the request.
"
},
"ListTrafficPolicyInstancesByHostedZoneRequest":{
"type":"structure",
"required":["HostedZoneId"],
"members":{
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"The ID of the hosted zone for which you want to list traffic policy instances.
",
"location":"querystring",
"locationName":"id"
},
"TrafficPolicyInstanceNameMarker":{
"shape":"DNSName",
"documentation":"For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.
If the value of IsTruncated in the previous response was false, omit this value.
",
"location":"querystring",
"locationName":"trafficpolicyinstancename"
},
"TrafficPolicyInstanceTypeMarker":{
"shape":"RRType",
"documentation":"For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.
",
"location":"querystring",
"locationName":"trafficpolicyinstancetype"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.
",
"location":"querystring",
"locationName":"maxitems"
}
},
"documentation":"A request for the traffic policy instances that you created in a specified hosted zone.
"
},
"ListTrafficPolicyInstancesByHostedZoneResponse":{
"type":"structure",
"required":[
"TrafficPolicyInstances",
"IsTruncated",
"MaxItems"
],
"members":{
"TrafficPolicyInstances":{
"shape":"TrafficPolicyInstances",
"documentation":"A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.
"
},
"TrafficPolicyInstanceNameMarker":{
"shape":"DNSName",
"documentation":"If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
"
},
"TrafficPolicyInstanceTypeMarker":{
"shape":"RRType",
"documentation":"If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.
"
},
"IsTruncated":{
"shape":"PageTruncated",
"documentation":"A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstancesByHostedZone again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.
Valid Values: true | false
"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByHostedZone that produced the current response.
"
}
},
"documentation":"A complex type that contains the response information for the request.
"
},
"ListTrafficPolicyInstancesByPolicyRequest":{
"type":"structure",
"required":[
"TrafficPolicyId",
"TrafficPolicyVersion"
],
"members":{
"TrafficPolicyId":{
"shape":"TrafficPolicyId",
"documentation":"The ID of the traffic policy for which you want to list traffic policy instances.
",
"location":"querystring",
"locationName":"id"
},
"TrafficPolicyVersion":{
"shape":"TrafficPolicyVersion",
"documentation":"The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.
",
"location":"querystring",
"locationName":"version"
},
"HostedZoneIdMarker":{
"shape":"ResourceId",
"documentation":"For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
If the value of IsTruncated in the previous response was true, HostedZoneIdMarker is the ID of the hosted zone for the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.
If the value of IsTruncated in the previous response was false, omit this value.
",
"location":"querystring",
"locationName":"hostedzoneid"
},
"TrafficPolicyInstanceNameMarker":{
"shape":"DNSName",
"documentation":"For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.
If the value of IsTruncated in the previous response was false, omit this value.
",
"location":"querystring",
"locationName":"trafficpolicyinstancename"
},
"TrafficPolicyInstanceTypeMarker":{
"shape":"RRType",
"documentation":"For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.
",
"location":"querystring",
"locationName":"trafficpolicyinstancetype"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.
",
"location":"querystring",
"locationName":"maxitems"
}
},
"documentation":"A complex type that contains the information about the request to list your traffic policy instances.
"
},
"ListTrafficPolicyInstancesByPolicyResponse":{
"type":"structure",
"required":[
"TrafficPolicyInstances",
"IsTruncated",
"MaxItems"
],
"members":{
"TrafficPolicyInstances":{
"shape":"TrafficPolicyInstances",
"documentation":"A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.
"
},
"HostedZoneIdMarker":{
"shape":"ResourceId",
"documentation":"If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.
"
},
"TrafficPolicyInstanceNameMarker":{
"shape":"DNSName",
"documentation":"If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
"
},
"TrafficPolicyInstanceTypeMarker":{
"shape":"RRType",
"documentation":"If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.
"
},
"IsTruncated":{
"shape":"PageTruncated",
"documentation":"A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.
Valid Values: true | false
"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced the current response.
"
}
},
"documentation":"A complex type that contains the response information for the request.
"
},
"ListTrafficPolicyInstancesRequest":{
"type":"structure",
"members":{
"HostedZoneIdMarker":{
"shape":"ResourceId",
"documentation":"For the first request to ListTrafficPolicyInstances, omit this value.
If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get the next group of MaxItems traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneIdMarker, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.
",
"location":"querystring",
"locationName":"hostedzoneid"
},
"TrafficPolicyInstanceNameMarker":{
"shape":"DNSName",
"documentation":"For the first request to ListTrafficPolicyInstances, omit this value.
If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.
",
"location":"querystring",
"locationName":"trafficpolicyinstancename"
},
"TrafficPolicyInstanceTypeMarker":{
"shape":"RRType",
"documentation":"For the first request to ListTrafficPolicyInstances, omit this value.
If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.
",
"location":"querystring",
"locationName":"trafficpolicyinstancetype"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.
",
"location":"querystring",
"locationName":"maxitems"
}
},
"documentation":"A complex type that contains the information about the request to list your traffic policy instances.
"
},
"ListTrafficPolicyInstancesResponse":{
"type":"structure",
"required":[
"TrafficPolicyInstances",
"IsTruncated",
"MaxItems"
],
"members":{
"TrafficPolicyInstances":{
"shape":"TrafficPolicyInstances",
"documentation":"A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.
"
},
"HostedZoneIdMarker":{
"shape":"ResourceId",
"documentation":"If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.
"
},
"TrafficPolicyInstanceNameMarker":{
"shape":"DNSName",
"documentation":"If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
"
},
"TrafficPolicyInstanceTypeMarker":{
"shape":"RRType",
"documentation":"If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.
"
},
"IsTruncated":{
"shape":"PageTruncated",
"documentation":"A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.
Valid Values: true | false
"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.
"
}
},
"documentation":"A complex type that contains the response information for the request.
"
},
"ListTrafficPolicyVersionsRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"TrafficPolicyId",
"documentation":"Specify the value of Id of the traffic policy for which you want to list all versions.
",
"location":"uri",
"locationName":"Id"
},
"TrafficPolicyVersionMarker":{
"shape":"TrafficPolicyVersionMarker",
"documentation":"For your first request to ListTrafficPolicyVersions, do not include the TrafficPolicyVersionMarker parameter.
If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get the next group of MaxItems traffic policy versions, submit another request to ListTrafficPolicyVersions. For the value of TrafficPolicyVersionMarker, specify the value of the TrafficPolicyVersionMarker element that was returned in the previous response.
Traffic policy versions are listed in sequential order.
",
"location":"querystring",
"locationName":"trafficpolicyversion"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of the IsTruncated element in the response is true, and the value of the TrafficPolicyVersionMarker element is the ID of the first version in the next group of MaxItems traffic policy versions.
",
"location":"querystring",
"locationName":"maxitems"
}
},
"documentation":"A complex type that contains the information about the request to list your traffic policies.
"
},
"ListTrafficPolicyVersionsResponse":{
"type":"structure",
"required":[
"TrafficPolicies",
"IsTruncated",
"TrafficPolicyVersionMarker",
"MaxItems"
],
"members":{
"TrafficPolicies":{
"shape":"TrafficPolicies",
"documentation":"A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy.
"
},
"IsTruncated":{
"shape":"PageTruncated",
"documentation":"A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of maxitems traffic policies by calling ListTrafficPolicyVersions again and specifying the value of the NextMarker element in the marker parameter.
Valid Values: true | false
"
},
"TrafficPolicyVersionMarker":{
"shape":"TrafficPolicyVersionMarker",
"documentation":"If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy in the next group of MaxItems traffic policies. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.
This element is present only if IsTruncated is true.
"
},
"MaxItems":{
"shape":"PageMaxItems",
"documentation":"The value that you specified for the maxitems parameter in the call to ListTrafficPolicyVersions that produced the current response.
"
}
},
"documentation":"A complex type that contains the response information for the request.
"
},
"MeasureLatency":{"type":"boolean"},
"Message":{
"type":"string",
"max":1024
},
"MetricName":{
"type":"string",
"max":255,
"min":1
},
"Namespace":{
"type":"string",
"max":255,
"min":1
},
"NoSuchChange":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchDelegationSet":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The specified delegation set does not exist.
",
"exception":true
},
"NoSuchGeoLocation":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The geo location you are trying to get does not exist.
",
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchHealthCheck":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The health check you are trying to get or delete does not exist.
",
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchHostedZone":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchTrafficPolicy":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"No traffic policy exists with the specified ID.
",
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchTrafficPolicyInstance":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"No traffic policy instance exists with the specified ID.
",
"error":{"httpStatusCode":404},
"exception":true
},
"Nonce":{
"type":"string",
"max":128,
"min":1
},
"PageMarker":{
"type":"string",
"max":64
},
"PageMaxItems":{"type":"string"},
"PageTruncated":{"type":"boolean"},
"Period":{
"type":"integer",
"min":60
},
"Port":{
"type":"integer",
"max":65535,
"min":1
},
"PriorRequestNotComplete":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The request was rejected because Amazon Route 53 was still processing a prior request.
",
"error":{"httpStatusCode":400},
"exception":true
},
"PublicZoneVPCAssociation":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The hosted zone you are trying to associate VPC with doesn't have any VPC association. Amazon Route 53 currently doesn't support associate a VPC with a public hosted zone.
",
"error":{"httpStatusCode":400},
"exception":true
},
"RData":{
"type":"string",
"max":4000
},
"RRType":{
"type":"string",
"enum":[
"SOA",
"A",
"TXT",
"NS",
"CNAME",
"MX",
"PTR",
"SRV",
"SPF",
"AAAA"
]
},
"RequestInterval":{
"type":"integer",
"max":30,
"min":10
},
"ResourceDescription":{
"type":"string",
"max":256
},
"ResourceId":{
"type":"string",
"max":32
},
"ResourcePath":{
"type":"string",
"max":255
},
"ResourceRecord":{
"type":"structure",
"required":["Value"],
"members":{
"Value":{
"shape":"RData",
"documentation":"The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.
You can specify more than one value for all record types except CNAME and SOA.
"
}
},
"documentation":"A complex type that contains the value of the Value element for the current resource record set.
"
},
"ResourceRecordSet":{
"type":"structure",
"required":[
"Name",
"Type"
],
"members":{
"Name":{
"shape":"DNSName",
"documentation":"The name of the domain you want to perform the action on.
Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 still assumes that the domain name that you specify is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
You can use an asterisk (*) character in the name. DNS treats the * character either as a wildcard or as the * character (ASCII 42), depending on where it appears in the name. For more information, see Using an Asterisk (*) in the Names of Hosted Zones and Resource Record Sets in the Amazon Route 53 Developer Guide
You can't use the * wildcard for resource records sets that have a type of NS. "
},
"Type":{
"shape":"RRType",
"documentation":"The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.
Valid values for basic resource record sets: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT
Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CNAME | MX | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.
SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.\" In RFC 7208, see section 14.1, The SPF DNS Record Type. Values for alias resource record sets:
- CloudFront distributions:
A - ELB load balancers:
A | AAAA - Amazon S3 buckets: A
- Another resource record set in this hosted zone: Specify the type of the resource record set for which you're creating the alias. Specify any value except
NS or SOA.
"
},
"SetIdentifier":{
"shape":"ResourceRecordSetIdentifier",
"documentation":"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. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type.
"
},
"Weight":{
"shape":"ResourceRecordSetWeight",
"documentation":"Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:
- You must specify a value for the
Weight element for every weighted resource record set. - You can only specify one
ResourceRecord per weighted resource record set. - You cannot create latency, failover, or geolocation resource record sets that have the same values for the
Name and Type elements as weighted resource record sets. - You can create a maximum of 100 weighted resource record sets that have the same values for the
Name and Type elements. For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Amazon Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.
The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Amazon Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.
"
},
"Region":{
"shape":"ResourceRecordSetRegion",
"documentation":"Latency-based resource record sets only: The Amazon EC2 region where the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an Amazon EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
You can create latency and latency alias resource record sets only in public hosted zones. When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
- You can only specify one
ResourceRecord per latency resource record set. - You can only create one latency resource record set for each Amazon EC2 region.
- You are not required to create latency resource record sets for all Amazon EC2 regions. Amazon Route 53 will choose the region with the best latency from among the regions for which you create latency resource record sets.
- You cannot create non-latency resource record sets that have the same values for the
Name and Type elements as latency resource record sets.
"
},
"GeoLocation":{
"shape":"GeoLocation",
"documentation":"Geo location resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.
You can create geolocation and geolocation alias resource record sets only in public hosted zones. If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.
You cannot create two geolocation resource record sets that specify the same geographic location.
The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.
Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Amazon Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Amazon Route 53 returns a \"no answer\" response for queries from those locations. You cannot create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.
"
},
"Failover":{
"shape":"ResourceRecordSetFailover",
"documentation":"Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
You can create failover and failover alias resource record sets only in public hosted zones. Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:
- When the primary resource record set is healthy, Amazon Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.
- When the primary resource record set is unhealthy and the secondary resource record set is healthy, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
- When the secondary resource record set is unhealthy, Amazon Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.
- If you omit the
HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Amazon Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.
You cannot create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.
For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.
For more information about configuring failover for Amazon Route 53, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
Valid values: PRIMARY | SECONDARY
"
},
"TTL":{
"shape":"TTL",
"documentation":"The cache time to live for the current resource record set. Note the following:
- If you're creating a non-alias resource record set,
TTL is required. - If you're creating an alias resource record set, omit
TTL. Amazon Route 53 uses the value of TTL for the alias target. - If you're associating this resource record set with a health check (if you're adding a
HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status. - All of the resource record sets in a group of weighted, latency, geolocation, or failover resource record sets must have the same value for
TTL. - If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a
TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.
"
},
"ResourceRecords":{
"shape":"ResourceRecords",
"documentation":"A complex type that contains the resource records for the current resource record set.
"
},
"AliasTarget":{
"shape":"AliasTarget",
"documentation":"Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.
"
},
"HealthCheckId":{
"shape":"HealthCheckId",
"documentation":"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.
"
},
"TrafficPolicyInstanceId":{"shape":"TrafficPolicyInstanceId"}
},
"documentation":"A complex type that contains information about the current resource record set.
"
},
"ResourceRecordSetFailover":{
"type":"string",
"enum":[
"PRIMARY",
"SECONDARY"
]
},
"ResourceRecordSetIdentifier":{
"type":"string",
"max":128,
"min":1
},
"ResourceRecordSetRegion":{
"type":"string",
"enum":[
"us-east-1",
"us-west-1",
"us-west-2",
"eu-west-1",
"eu-central-1",
"ap-southeast-1",
"ap-southeast-2",
"ap-northeast-1",
"ap-northeast-2",
"sa-east-1",
"cn-north-1",
"ap-south-1"
],
"max":64,
"min":1
},
"ResourceRecordSetWeight":{
"type":"long",
"max":255,
"min":0
},
"ResourceRecordSets":{
"type":"list",
"member":{
"shape":"ResourceRecordSet",
"locationName":"ResourceRecordSet"
}
},
"ResourceRecords":{
"type":"list",
"member":{
"shape":"ResourceRecord",
"locationName":"ResourceRecord"
},
"min":1
},
"ResourceTagSet":{
"type":"structure",
"members":{
"ResourceType":{
"shape":"TagResourceType",
"documentation":"The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
"
},
"ResourceId":{
"shape":"TagResourceId",
"documentation":"The ID for the specified resource.
"
},
"Tags":{
"shape":"TagList",
"documentation":"The tags associated with the specified resource.
"
}
},
"documentation":"A complex type containing a resource and its associated tags.
"
},
"ResourceTagSetList":{
"type":"list",
"member":{
"shape":"ResourceTagSet",
"locationName":"ResourceTagSet"
}
},
"ResourceURI":{
"type":"string",
"max":1024
},
"SearchString":{
"type":"string",
"max":255
},
"Statistic":{
"type":"string",
"enum":[
"Average",
"Sum",
"SampleCount",
"Maximum",
"Minimum"
]
},
"Status":{"type":"string"},
"StatusReport":{
"type":"structure",
"members":{
"Status":{
"shape":"Status",
"documentation":"The observed health check status.
"
},
"CheckedTime":{
"shape":"TimeStamp",
"documentation":"The date and time the health check status was observed, 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).
"
}
},
"documentation":"A complex type that contains information about the health check status for the current observation.
"
},
"TTL":{
"type":"long",
"max":2147483647,
"min":0
},
"Tag":{
"type":"structure",
"members":{
"Key":{
"shape":"TagKey",
"documentation":"The key for a Tag.
"
},
"Value":{
"shape":"TagValue",
"documentation":"The value for a Tag.
"
}
},
"documentation":"A single tag containing a key and value.
"
},
"TagKey":{
"type":"string",
"max":128
},
"TagKeyList":{
"type":"list",
"member":{
"shape":"TagKey",
"locationName":"Key"
},
"max":10,
"min":1
},
"TagList":{
"type":"list",
"member":{
"shape":"Tag",
"locationName":"Tag"
},
"max":10,
"min":1
},
"TagResourceId":{
"type":"string",
"max":64
},
"TagResourceIdList":{
"type":"list",
"member":{
"shape":"TagResourceId",
"locationName":"ResourceId"
},
"max":10,
"min":1
},
"TagResourceType":{
"type":"string",
"enum":[
"healthcheck",
"hostedzone"
]
},
"TagValue":{
"type":"string",
"max":256
},
"Threshold":{"type":"double"},
"ThrottlingException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"TimeStamp":{"type":"timestamp"},
"TooManyHealthChecks":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"exception":true
},
"TooManyHostedZones":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"This 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.
",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyTrafficPolicies":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"You've created the maximum number of traffic policies that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.
",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyTrafficPolicyInstances":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"You've created the maximum number of traffic policy instances that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.
",
"error":{"httpStatusCode":400},
"exception":true
},
"TrafficPolicies":{
"type":"list",
"member":{
"shape":"TrafficPolicy",
"locationName":"TrafficPolicy"
}
},
"TrafficPolicy":{
"type":"structure",
"required":[
"Id",
"Version",
"Name",
"Type",
"Document"
],
"members":{
"Id":{"shape":"TrafficPolicyId"},
"Version":{"shape":"TrafficPolicyVersion"},
"Name":{"shape":"TrafficPolicyName"},
"Type":{"shape":"RRType"},
"Document":{"shape":"TrafficPolicyDocument"},
"Comment":{"shape":"TrafficPolicyComment"}
}
},
"TrafficPolicyAlreadyExists":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"A traffic policy that has the same value for Name already exists.
",
"error":{"httpStatusCode":409},
"exception":true
},
"TrafficPolicyComment":{
"type":"string",
"max":1024
},
"TrafficPolicyDocument":{
"type":"string",
"max":102400
},
"TrafficPolicyId":{
"type":"string",
"max":36
},
"TrafficPolicyInUse":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"One or more traffic policy instances were created by using the specified traffic policy.
",
"error":{"httpStatusCode":400},
"exception":true
},
"TrafficPolicyInstance":{
"type":"structure",
"required":[
"Id",
"HostedZoneId",
"Name",
"TTL",
"State",
"Message",
"TrafficPolicyId",
"TrafficPolicyVersion",
"TrafficPolicyType"
],
"members":{
"Id":{"shape":"TrafficPolicyInstanceId"},
"HostedZoneId":{"shape":"ResourceId"},
"Name":{"shape":"DNSName"},
"TTL":{"shape":"TTL"},
"State":{"shape":"TrafficPolicyInstanceState"},
"Message":{"shape":"Message"},
"TrafficPolicyId":{"shape":"TrafficPolicyId"},
"TrafficPolicyVersion":{"shape":"TrafficPolicyVersion"},
"TrafficPolicyType":{"shape":"RRType"}
}
},
"TrafficPolicyInstanceAlreadyExists":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"Traffic policy instance with given Id already exists.
",
"error":{"httpStatusCode":409},
"exception":true
},
"TrafficPolicyInstanceCount":{"type":"integer"},
"TrafficPolicyInstanceId":{
"type":"string",
"max":36
},
"TrafficPolicyInstanceState":{"type":"string"},
"TrafficPolicyInstances":{
"type":"list",
"member":{
"shape":"TrafficPolicyInstance",
"locationName":"TrafficPolicyInstance"
}
},
"TrafficPolicyName":{
"type":"string",
"max":512
},
"TrafficPolicySummaries":{
"type":"list",
"member":{
"shape":"TrafficPolicySummary",
"locationName":"TrafficPolicySummary"
}
},
"TrafficPolicySummary":{
"type":"structure",
"required":[
"Id",
"Name",
"Type",
"LatestVersion",
"TrafficPolicyCount"
],
"members":{
"Id":{"shape":"TrafficPolicyId"},
"Name":{"shape":"TrafficPolicyName"},
"Type":{"shape":"RRType"},
"LatestVersion":{"shape":"TrafficPolicyVersion"},
"TrafficPolicyCount":{"shape":"TrafficPolicyVersion"}
}
},
"TrafficPolicyVersion":{
"type":"integer",
"max":1000,
"min":1
},
"TrafficPolicyVersionMarker":{
"type":"string",
"max":4
},
"UpdateHealthCheckRequest":{
"type":"structure",
"required":["HealthCheckId"],
"members":{
"HealthCheckId":{
"shape":"HealthCheckId",
"documentation":"The ID of the health check to update.
",
"location":"uri",
"locationName":"HealthCheckId"
},
"HealthCheckVersion":{
"shape":"HealthCheckVersion",
"documentation":"Optional. When you specify a health check version, Amazon 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.
"
},
"IPAddress":{
"shape":"IPAddress",
"documentation":"The IP address of the resource that you want to check.
Specify this value only if you want to change it.
"
},
"Port":{
"shape":"Port",
"documentation":"The port on which you want Amazon Route 53 to open a connection to perform health checks.
Specify this value only if you want to change it.
"
},
"ResourcePath":{
"shape":"ResourcePath",
"documentation":"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.
"
},
"FullyQualifiedDomainName":{
"shape":"FullyQualifiedDomainName",
"documentation":"Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
"
},
"SearchString":{
"shape":"SearchString",
"documentation":"If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy. Amazon Route 53 considers case when searching for SearchString in the response body.
Specify this value only if you want to change it.
"
},
"FailureThreshold":{
"shape":"FailureThreshold",
"documentation":"The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
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.
"
},
"Inverted":{
"shape":"Inverted",
"documentation":"A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True, then Amazon Route 53 considers the health check to be unhealthy.
Specify this value only if you want to change it.
"
},
"HealthThreshold":{
"shape":"HealthThreshold",
"documentation":"The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
Specify this value only if you want to change it.
"
},
"ChildHealthChecks":{
"shape":"ChildHealthCheckList",
"documentation":"For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
Specify this value only if you want to change it.
"
},
"EnableSNI":{
"shape":"EnableSNI",
"documentation":"Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI, Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.
Specify this value only if you want to change it.
"
},
"Regions":{
"shape":"HealthCheckRegionList",
"documentation":"A list of HealthCheckRegion values that specify the Amazon EC2 regions that you want Amazon Route 53 to use to perform health checks. You must specify at least three regions.
When you remove a region from the list, Amazon Route 53 will briefly continue to check your endpoint from that region. Specify this value only if you want to change it.
"
},
"AlarmIdentifier":{"shape":"AlarmIdentifier"},
"InsufficientDataHealthStatus":{"shape":"InsufficientDataHealthStatus"}
},
"documentation":">A complex type that contains information about the request to update a health check.
"
},
"UpdateHealthCheckResponse":{
"type":"structure",
"required":["HealthCheck"],
"members":{
"HealthCheck":{"shape":"HealthCheck"}
}
},
"UpdateHostedZoneCommentRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"The ID of the hosted zone you want to update.
",
"location":"uri",
"locationName":"Id"
},
"Comment":{
"shape":"ResourceDescription",
"documentation":"A comment about your hosted zone.
"
}
},
"documentation":"A complex type that contains information about the request to update a hosted zone comment.
"
},
"UpdateHostedZoneCommentResponse":{
"type":"structure",
"required":["HostedZone"],
"members":{
"HostedZone":{"shape":"HostedZone"}
},
"documentation":"A complex type containing information about the specified hosted zone after the update.
"
},
"UpdateTrafficPolicyCommentRequest":{
"type":"structure",
"required":[
"Id",
"Version",
"Comment"
],
"members":{
"Id":{
"shape":"TrafficPolicyId",
"documentation":"The value of Id for the traffic policy for which you want to update the comment.
",
"location":"uri",
"locationName":"Id"
},
"Version":{
"shape":"TrafficPolicyVersion",
"documentation":"The value of Version for the traffic policy for which you want to update the comment.
",
"location":"uri",
"locationName":"Version"
},
"Comment":{
"shape":"TrafficPolicyComment",
"documentation":"The new comment for the specified traffic policy and version.
"
}
},
"documentation":"A complex type that contains information about the traffic policy for which you want to update the comment.
"
},
"UpdateTrafficPolicyCommentResponse":{
"type":"structure",
"required":["TrafficPolicy"],
"members":{
"TrafficPolicy":{
"shape":"TrafficPolicy",
"documentation":"A complex type that contains settings for the specified traffic policy.
"
}
},
"documentation":"A complex type that contains the response information for the traffic policy.
"
},
"UpdateTrafficPolicyInstanceRequest":{
"type":"structure",
"required":[
"Id",
"TTL",
"TrafficPolicyId",
"TrafficPolicyVersion"
],
"members":{
"Id":{
"shape":"TrafficPolicyInstanceId",
"documentation":"The ID of the traffic policy instance that you want to update.
",
"location":"uri",
"locationName":"Id"
},
"TTL":{
"shape":"TTL",
"documentation":"The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.
"
},
"TrafficPolicyId":{
"shape":"TrafficPolicyId",
"documentation":"The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
"
},
"TrafficPolicyVersion":{
"shape":"TrafficPolicyVersion",
"documentation":"The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
"
}
},
"documentation":"A complex type that contains information about the resource record sets that you want to update based on a specified traffic policy instance.
"
},
"UpdateTrafficPolicyInstanceResponse":{
"type":"structure",
"required":["TrafficPolicyInstance"],
"members":{
"TrafficPolicyInstance":{
"shape":"TrafficPolicyInstance",
"documentation":"A complex type that contains settings for the updated traffic policy instance.
"
}
},
"documentation":"A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.
"
},
"VPC":{
"type":"structure",
"members":{
"VPCRegion":{"shape":"VPCRegion"},
"VPCId":{"shape":"VPCId"}
}
},
"VPCAssociationNotFound":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"Descriptive message for the error response.
"
}
},
"documentation":"The VPC you specified is not currently associated with the hosted zone.
",
"error":{"httpStatusCode":404},
"exception":true
},
"VPCId":{
"type":"string",
"documentation":"A VPC ID
",
"max":1024
},
"VPCRegion":{
"type":"string",
"enum":[
"us-east-1",
"us-west-1",
"us-west-2",
"eu-west-1",
"eu-central-1",
"ap-southeast-1",
"ap-southeast-2",
"ap-south-1",
"ap-northeast-1",
"ap-northeast-2",
"sa-east-1",
"cn-north-1"
],
"max":64,
"min":1
},
"VPCs":{
"type":"list",
"member":{
"shape":"VPC",
"locationName":"VPC"
},
"documentation":"A list of VPCs
",
"min":1
}
}
}