String hostedZoneId
Z2FDTNDATAQYW2.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.For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.
Constraints:
Length: 0 - 32
String dNSName
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.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.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.For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.
Constraints:
Length: 0 - 1024
Boolean evaluateTargetHealth
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:
Note the following:
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. For more
information, see What
Happens When You Omit Health Checks? in the Amazon Route 53
Developer Guide.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.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.
String hostedZoneId
Note that you cannot associate a VPC with a hosted zone that doesn't have an existing VPC association.
Constraints:
Length: 0 - 32
VPC vPC
String comment
AssociateVPCWithHostedZoneRequest.ChangeInfo changeInfo
AssociateVPCWithHostedZoneRequest.String action
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).
Constraints:
Allowed Values: CREATE, DELETE, UPSERT
ResourceRecordSet resourceRecordSet
String comment
Constraints:
Length: 0 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> changes
Change element for each
resource record set that you want to create or delete.
Constraints:
Length: 1 -
String id
Constraints:
Length: 0 - 32
Date submittedAt
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).String status
PENDING indicates that
this request has not yet been applied to all Amazon Route 53 DNS
servers. Valid Values: PENDING | INSYNC
Constraints:
Allowed Values: PENDING, INSYNC
String comment
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
Constraints:
Length: 0 - 256
String submitter
com.amazonaws.internal.ListWithAutoConstructFlag<T> changes
Constraints:
Length: 1 -
String id
Constraints:
Length: 0 - 32
String status
PENDING indicates that
this request has not yet been applied to all Amazon Route 53 DNS
servers. Valid Values: PENDING | INSYNC
Constraints:
Allowed Values: PENDING, INSYNC
Date submittedAt
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).String comment
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
Constraints:
Length: 0 - 256
String hostedZoneId
Constraints:
Length: 0 - 32
ChangeBatch changeBatch
Changes element.ChangeInfo changeInfo
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
String resourceType
- The resource type for health checks is
healthcheck.
- The resource type for hosted zones is
hostedzone.
Constraints:
Allowed Values: healthcheck, hostedzone
String resourceId
Constraints:
Length: 0 - 64
com.amazonaws.internal.ListWithAutoConstructFlag<T> addTags
Tag elements. Each
Tag element identifies a tag that you want to add or
update for the specified resource.
Constraints:
Length: 1 - 10
com.amazonaws.internal.ListWithAutoConstructFlag<T> removeTagKeys
Tag keys that you want to remove from the
specified resource.
Constraints:
Length: 1 - 10
String callerReference
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.
Constraints:
Length: 1 - 64
HealthCheckConfig healthCheckConfig
HealthCheck healthCheck
String location
Constraints:
Length: 0 - 1024
String name
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.
Constraints:
Length: 0 - 1024
VPC vPC
String callerReference
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.
Constraints:
Length: 1 - 128
HostedZoneConfig hostedZoneConfig
String delegationSetId
Constraints:
Length: 0 - 32
HostedZone hostedZone
ChangeInfo changeInfo
DelegationSet delegationSet
VPC vPC
String location
Constraints:
Length: 0 - 1024
String callerReference
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.
Constraints:
Length: 1 - 128
String hostedZoneId
Constraints:
Length: 0 - 32
DelegationSet delegationSet
String location
Constraints:
Length: 0 - 1024
String hostedZoneId
Constraints:
Length: 0 - 32
String name
Constraints:
Length: 0 - 1024
Long tTL
Constraints:
Range: 0 - 2147483647
String trafficPolicyId
Constraints:
Length: 0 - 36
Integer trafficPolicyVersion
Constraints:
Range: 1 - 1000
TrafficPolicyInstance trafficPolicyInstance
String location
Constraints:
Length: 0 - 1024
String name
Constraints:
Length: 0 - 512
String document
Constraints:
Length: 0 - 102400
String comment
Constraints:
Length: 0 - 1024
TrafficPolicy trafficPolicy
String location
String id
Constraints:
Length: 0 - 36
String document
Constraints:
Length: 0 - 102400
String comment
Constraints:
Length: 0 - 1024
TrafficPolicy trafficPolicy
String location
String id
String callerReference
com.amazonaws.internal.ListWithAutoConstructFlag<T> nameServers
NameServer that is
assigned to your hosted zone.
Constraints:
Length: 1 -
String healthCheckId
Constraints:
Length: 0 - 64
String id
Constraints:
Length: 0 - 32
ChangeInfo changeInfo
String id
Constraints:
Length: 0 - 32
String id
Constraints:
Length: 0 - 36
String hostedZoneId
Note that you cannot disassociate the last VPC from a hosted zone.
Constraints:
Length: 0 - 32
VPC vPC
String comment
DisassociateVPCFromHostedZoneRequest.ChangeInfo changeInfo
DisassociateVPCFromHostedZoneRequest.String continentCode
Valid values: AF |
AN | AS | EU | OC
| NA | SA
Constraint: Specifying
ContinentCode with either CountryCode or
SubdivisionCode returns an InvalidInput error.
Constraints:
Length: 2 - 2
String countryCode
The default geo location uses a * for
the country code. All other country codes follow the ISO 3166
two-character code.
Constraints:
Length: 1 - 2
String subdivisionCode
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
Constraints:
Length: 1 - 3
String continentCode
Constraints:
Length: 2 - 2
String continentName
ContinentCode is also present.
Constraints:
Length: 1 - 32
String countryCode
The default geo location uses a * for
the country code. All other country codes follow the ISO 3166
two-character code.
Constraints:
Length: 1 - 2
String countryName
CountryCode is also present.
Constraints:
Length: 1 - 64
String subdivisionCode
Constraints:
Length: 1 - 3
String subdivisionName
SubdivisionCode is also present.
Constraints:
Length: 1 - 64
String id
ChangeResourceRecordSets returned in the
Id element when you submitted the request.
Constraints:
Length: 0 - 32
ChangeBatchRecord changeBatchRecord
String id
ChangeResourceRecordSets returned in the
Id element when you submitted the request.
Constraints:
Length: 0 - 32
ChangeInfo changeInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> checkerIpRanges
String continentCode
Valid values: AF |
AN | AS | EU | OC
| NA | SA
Constraint: Specifying
ContinentCode with either CountryCode or
SubdivisionCode returns an InvalidInput error.
Constraints:
Length: 2 - 2
String countryCode
The default geo location uses a * for
the country code. All other country codes follow the ISO 3166
two-character code.
Constraints:
Length: 1 - 2
String subdivisionCode
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
Constraints:
Length: 1 - 3
GeoLocationDetails geoLocationDetails
Long healthCheckCount
String healthCheckId
Constraints:
Length: 0 - 64
com.amazonaws.internal.ListWithAutoConstructFlag<T> healthCheckObservations
HealthCheckObservation element
for each Amazon Route 53 health checker.String healthCheckId
Constraints:
Length: 0 - 64
HealthCheck healthCheck
String healthCheckId
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
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). 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.
Constraints:
Length: 0 - 64
com.amazonaws.internal.ListWithAutoConstructFlag<T> healthCheckObservations
HealthCheckObservation element
for each Amazon Route 53 health checker.Long hostedZoneCount
String id
Constraints:
Length: 0 - 32
HostedZone hostedZone
DelegationSet delegationSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> vPCs
Constraints:
Length: 1 -
String id
Constraints:
Length: 0 - 32
DelegationSet delegationSet
Integer trafficPolicyInstanceCount
String id
Constraints:
Length: 0 - 36
TrafficPolicyInstance trafficPolicyInstance
TrafficPolicy trafficPolicy
String id
Constraints:
Length: 0 - 64
String callerReference
Constraints:
Length: 1 - 64
HealthCheckConfig healthCheckConfig
Long healthCheckVersion
UpdateHealthCheck to prevent overwriting
another change to the health check.
Constraints:
Range: 1 -
String iPAddress
Constraints:
Length: 0 - 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])$
Integer port
Constraints:
Range: 1 - 65535
String type
Constraints:
Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED
String resourcePath
Constraints:
Length: 0 - 255
String fullyQualifiedDomainName
Constraints:
Length: 0 - 255
String searchString
Constraints:
Length: 0 - 255
Integer requestInterval
Each Amazon Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
Constraints:
Range: 10 - 30
Integer failureThreshold
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.
Constraints:
Range: 1 - 10
Boolean measureLatency
Boolean inverted
Inverted is True, then Amazon Route 53
considers the health check to be unhealthy.Integer healthThreshold
Constraints:
Range: 0 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> childHealthChecks
HealthCheckId values for the associated child health
checks.
Constraints:
Length: 0 - 256
String iPAddress
Constraints:
Length: 0 - 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])$
StatusReport statusReport
String id
Constraints:
Length: 0 - 32
String name
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.
Constraints:
Length: 0 - 1024
String callerReference
Constraints:
Length: 1 - 128
HostedZoneConfig config
Comment element.Long resourceRecordSetCount
String hostedZoneId
Constraints:
Length: 0 - 32
String startDate
Constraints:
Length: 0 - 256
String endDate
Constraints:
Length: 0 - 256
String maxItems
String marker
Constraints:
Length: 0 - 64
String maxItems
String marker
Constraints:
Length: 0 - 64
Boolean isTruncated
com.amazonaws.internal.ListWithAutoConstructFlag<T> changeBatchRecords
Constraints:
Length: 1 -
String nextMarker
Constraints:
Length: 0 - 64
String hostedZoneId
Constraints:
Length: 0 - 32
String name
Constraints:
Length: 0 - 1024
String type
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
String setIdentifier
Constraints:
Length: 1 - 128
String startDate
Constraints:
Length: 0 - 256
String endDate
Constraints:
Length: 0 - 256
String maxItems
String marker
Constraints:
Length: 0 - 64
String maxItems
String marker
Constraints:
Length: 0 - 64
Boolean isTruncated
com.amazonaws.internal.ListWithAutoConstructFlag<T> changeBatchRecords
Constraints:
Length: 1 -
String nextMarker
Constraints:
Length: 0 - 64
String startContinentCode
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.
Constraints:
Length: 2 - 2
String startCountryCode
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.
Constraints:
Length: 1 - 2
String startSubdivisionCode
ListGeoLocations request to
list. Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
Constraints:
Length: 1 - 3
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> geoLocationDetailsList
Boolean isTruncated
Valid
Values: true | false
String nextContinentCode
Constraints:
Length: 2 - 2
String nextCountryCode
Constraints:
Length: 1 - 2
String nextSubdivisionCode
Constraints:
Length: 1 - 3
String maxItems
MaxItems is 100.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> healthChecks
String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
Boolean isTruncated
Marker element.
Valid Values: true | false
String nextMarker
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.
Constraints:
Length: 0 - 64
String maxItems
MaxItems, the value of
ListHealthChecksResponse$IsTruncated in the response is
true. Call ListHealthChecks again and
specify the value of ListHealthChecksResponse$NextMarker in the
ListHostedZonesRequest$Marker element to get the next page of
results.String dNSName
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.
Constraints:
Length: 0 - 1024
String hostedZoneId
NextDNSName and
NextHostedZoneId from the last response in the
DNSName and HostedZoneId parameters to get
the next page of results.
Constraints:
Length: 0 - 32
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> hostedZones
String dNSName
DNSName value sent in the request.
Constraints:
Length: 0 - 1024
String hostedZoneId
HostedZoneId value sent in the request.
Constraints:
Length: 0 - 32
Boolean isTruncated
NextDNSName and
NextHostedZoneId elements. Valid Values:
true | false
String nextDNSName
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
ListHostedZonesByNameResponse$NextDNSName in the
ListHostedZonesByNameRequest$DNSName element and
ListHostedZonesByNameResponse$NextHostedZoneId in the
ListHostedZonesByNameRequest$HostedZoneId element.
Constraints:
Length: 0 - 1024
String nextHostedZoneId
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
ListHostedZonesByNameResponse$NextDNSName in the
ListHostedZonesByNameRequest$DNSName element and
ListHostedZonesByNameResponse$NextHostedZoneId in the
ListHostedZonesByNameRequest$HostedZoneId element.
Constraints:
Length: 0 - 32
String maxItems
MaxItems, the value of
ListHostedZonesByNameResponse$IsTruncated in the response is
true. Call ListHostedZonesByName again and
specify the value of ListHostedZonesByNameResponse$NextDNSName
and ListHostedZonesByNameResponse$NextHostedZoneId elements
respectively to get the next page of results.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
String maxItems
String delegationSetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> hostedZones
String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
Boolean isTruncated
Marker element.
Valid Values: true | false
String nextMarker
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.
Constraints:
Length: 0 - 64
String maxItems
MaxItems, the value of
ListHostedZonesResponse$IsTruncated in the response is
true. Call ListHostedZones again and specify
the value of ListHostedZonesResponse$NextMarker in the
ListHostedZonesRequest$Marker element to get the next page of
results.String hostedZoneId
Constraints:
Length: 0 - 32
String startRecordName
ListResourceRecordSets request to list.
Constraints:
Length: 0 - 1024
String startRecordType
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.
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
String startRecordIdentifier
ListResourceRecordSetsResponse$NextRecordIdentifier from
the previous response to get the next resource record set that has the
current DNS name and type.
Constraints:
Length: 1 - 128
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceRecordSets
Boolean isTruncated
Valid
Values: true | false
String nextRecordName
Constraints:
Length: 0 - 1024
String nextRecordType
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
String nextRecordIdentifier
SetIdentifier
for the next resource record set that has the current DNS name and
type.
Constraints:
Length: 1 - 128
String maxItems
MaxItems is 100.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> delegationSets
String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
Boolean isTruncated
Marker
element. Valid Values: true | false
String nextMarker
true, make another request to
ListReusableDelegationSets and include the value of the
NextMarker element in the Marker element to
get the next page of results.
Constraints:
Length: 0 - 64
String maxItems
MaxItems, the value of
ListReusablDelegationSetsResponse$IsTruncated in the response
is true. Call ListReusableDelegationSets
again and specify the value of
ListReusableDelegationSetsResponse$NextMarker in the
ListReusableDelegationSetsRequest$Marker element to get the
next page of results.String resourceType
- The resource type for health checks is
healthcheck.
- The resource type for hosted zones is
hostedzone.
Constraints:
Allowed Values: healthcheck, hostedzone
String resourceId
Constraints:
Length: 0 - 64
ResourceTagSet resourceTagSet
ResourceTagSet containing tags associated with the
specified resource.String resourceType
- The resource type for health checks is
healthcheck.
- The resource type for hosted zones is
hostedzone.
Constraints:
Allowed Values: healthcheck, hostedzone
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceIds
Constraints:
Length: 1 - 10
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceTagSets
ResourceTagSets containing tags associated with
the specified resources.String trafficPolicyIdMarker
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.
Constraints:
Length: 0 - 36
String maxItems
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> trafficPolicySummaries
TrafficPolicySummary element for
each traffic policy that was created by the current AWS account.Boolean isTruncated
MaxItems traffic policies by calling
ListTrafficPolicies again and specifying the value of the
TrafficPolicyIdMarker element in the
TrafficPolicyIdMarker request parameter. Valid Values:
true | false
String trafficPolicyIdMarker
IsTruncated is true,
TrafficPolicyIdMarker is the ID of the first traffic
policy in the next group of MaxItems traffic policies.
Constraints:
Length: 0 - 36
String maxItems
MaxItems parameter
in the call to ListTrafficPolicies that produced the
current response.String hostedZoneId
Constraints:
Length: 0 - 32
String trafficPolicyInstanceNameMarker
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.
Constraints:
Length: 0 - 1024
String trafficPolicyInstanceTypeMarker
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.
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
String maxItems
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> trafficPolicyInstances
TrafficPolicyInstance element
for each traffic policy instance that matches the elements in the
request.String trafficPolicyInstanceNameMarker
IsTruncated is true,
TrafficPolicyInstanceNameMarker is the name of the first
traffic policy instance in the next group of MaxItems
traffic policy instances.
Constraints:
Length: 0 - 1024
String trafficPolicyInstanceTypeMarker
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.
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
Boolean isTruncated
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
String maxItems
MaxItems parameter
in the call to ListTrafficPolicyInstancesByHostedZone
that produced the current response.String trafficPolicyId
Constraints:
Length: 0 - 36
Integer trafficPolicyVersion
TrafficPolicyId.
Constraints:
Range: 1 - 1000
String hostedZoneIdMarker
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.
Constraints:
Length: 0 - 32
String trafficPolicyInstanceNameMarker
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.
Constraints:
Length: 0 - 1024
String trafficPolicyInstanceTypeMarker
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.
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
String maxItems
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> trafficPolicyInstances
TrafficPolicyInstance element
for each traffic policy instance that matches the elements in the
request.String hostedZoneIdMarker
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.
Constraints:
Length: 0 - 32
String trafficPolicyInstanceNameMarker
IsTruncated is true,
TrafficPolicyInstanceNameMarker is the name of the first
traffic policy instance in the next group of MaxItems
traffic policy instances.
Constraints:
Length: 0 - 1024
String trafficPolicyInstanceTypeMarker
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.
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
Boolean isTruncated
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
String maxItems
MaxItems parameter
in the call to ListTrafficPolicyInstancesByPolicy that
produced the current response.String hostedZoneIdMarker
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.
Constraints:
Length: 0 - 32
String trafficPolicyInstanceNameMarker
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.
Constraints:
Length: 0 - 1024
String trafficPolicyInstanceTypeMarker
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.
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
String maxItems
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> trafficPolicyInstances
TrafficPolicyInstance element
for each traffic policy instance that matches the elements in the
request.String hostedZoneIdMarker
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.
Constraints:
Length: 0 - 32
String trafficPolicyInstanceNameMarker
IsTruncated is true,
TrafficPolicyInstanceNameMarker is the name of the first
traffic policy instance in the next group of MaxItems
traffic policy instances.
Constraints:
Length: 0 - 1024
String trafficPolicyInstanceTypeMarker
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.
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
Boolean isTruncated
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
String maxItems
MaxItems parameter
in the call to ListTrafficPolicyInstances that produced
the current response.String id
Id of the traffic policy for which
you want to list all versions.
Constraints:
Length: 0 - 36
String trafficPolicyVersionMarker
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.
Constraints:
Length: 0 - 4
String maxItems
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> trafficPolicies
TrafficPolicy element for each
traffic policy version that is associated with the specified traffic
policy.Boolean isTruncated
maxitems traffic policies by calling
ListTrafficPolicyVersions again and specifying the value
of the NextMarker element in the marker parameter.
Valid Values: true | false
String trafficPolicyVersionMarker
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.
Constraints:
Length: 0 - 4
String maxItems
maxitems parameter
in the call to ListTrafficPolicyVersions that produced
the current response.String value
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.
Constraints:
Length: 0 - 4000
String name
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
Constraints:
Length: 0 - 1024
String type
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. 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:
AA | AAAANS or SOA.
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
String setIdentifier
SetIdentifier must be unique for each resource record set
that has the same combination of DNS name and type.
Constraints:
Length: 1 - 128
Long weight
Weight element for every weighted resource record
set.ResourceRecord per
weighted resource record set.Name and Type elements as
weighted resource record sets.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.
Constraints:
Range: 0 - 255
String region
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:
ResourceRecord per latency resource record set.Name and Type elements as latency
resource record sets.
Constraints:
Length: 1 - 64
Allowed Values: us-east-1, us-west-1, us-west-2, eu-west-1, eu-central-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1, cn-north-1
GeoLocation geoLocation
192.0.2.111, create a resource record set with a
Type of A and a ContinentCode
of AF. 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.
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.
String failover
Failover element to two resource record sets. For
one resource record set, you specify PRIMARY as the value
for Failover; for the other resource record set, you
specify SECONDARY. In addition, you include the
HealthCheckId element and specify the health check that
you want Amazon Route 53 to perform for each resource record set.
Except where noted, the
following failover behaviors assume that you have included the
HealthCheckId element in both resource record sets:
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
Constraints:
Allowed Values: PRIMARY, SECONDARY
Long tTL
TTL. Amazon Route 53 uses the value of
TTL for the alias target. HealthCheckId element), we recommend that you specify a
TTL of 60 seconds or less so clients respond quickly to
changes in health status.TTL.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.
Constraints:
Range: 0 - 2147483647
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceRecords
Constraints:
Length: 1 -
AliasTarget aliasTarget
String healthCheckId
Constraints:
Length: 0 - 64
String trafficPolicyInstanceId
String resourceType
- The resource type for health checks is
healthcheck.
- The resource type for hosted zones is
hostedzone.
Constraints:
Allowed Values: healthcheck, hostedzone
String resourceId
Constraints:
Length: 0 - 64
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 1 - 10
String status
Date checkedTime
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).String healthCheckId
Constraints:
Length: 0 - 64
Long healthCheckVersion
HealthCheckVersion lets you prevent
overwriting another change to the health check.
Constraints:
Range: 1 -
String iPAddress
Specify this value only if you want to change it.
Constraints:
Length: 0 - 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])$
Integer port
Specify this value only if you want to change it.
Constraints:
Range: 1 - 65535
String resourcePath
Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
String fullyQualifiedDomainName
Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
String searchString
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. Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
Integer failureThreshold
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.
Constraints:
Range: 1 - 10
Boolean inverted
Inverted is True, then Amazon Route 53
considers the health check to be unhealthy. Specify this value only if you want to change it.
Integer healthThreshold
Specify this value only if you want to change it.
Constraints:
Range: 0 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> childHealthChecks
HealthCheckId values for the associated child health
checks. Specify this value only if you want to change it.
Constraints:
Length: 0 - 256
HealthCheck healthCheck
HostedZone hostedZone
String id
Id for the traffic policy for which you want
to update the comment.
Constraints:
Length: 0 - 36
Integer version
Version for the traffic policy for which you
want to update the comment.
Constraints:
Range: 1 - 1000
String comment
Constraints:
Length: 0 - 1024
TrafficPolicy trafficPolicy
String id
Constraints:
Length: 0 - 36
Long tTL
Constraints:
Range: 0 - 2147483647
String trafficPolicyId
Constraints:
Length: 0 - 36
Integer trafficPolicyVersion
Constraints:
Range: 1 - 1000
TrafficPolicyInstance trafficPolicyInstance
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String idnLangCode
Reserved for future use.
String availability
Whether the domain name is available for registering.
You can only register domains designated as AVAILABLE.
Type: String
Valid values:
AVAILABLE – The domain name is available.AVAILABLE_RESERVED – The domain name is reserved under
specific conditions.AVAILABLE_PREORDER – The domain name is available and
can be preordered.UNAVAILABLE – The domain name is not available.UNAVAILABLE_PREMIUM – The domain name is not available.UNAVAILABLE_RESTRICTED – The domain name is forbidden.RESERVED – The domain name has been reserved for another
person or organization.DONT_KNOW – The TLD registry didn't reply with a
definitive answer about whether the domain name is available. Amazon
Route 53 can return this response for a variety of reasons, for example,
the registry is performing maintenance. Try again later.String firstName
First name of contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String lastName
Last name of contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String contactType
Indicates whether the contact is a person, company, association, or
public organization. If you choose an option other than
PERSON, you must enter an organization name, and you can't
enable privacy protection for the contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Valid values: PERSON | COMPANY |
ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String organizationName
Name of the organization for contact types other than PERSON
.
Type: String
Default: None
Constraints: Maximum 255 characters. Contact type must not be
PERSON.
Parents: RegistrantContact, AdminContact,
TechContact
Required: No
String addressLine1
First line of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String addressLine2
Second line of contact's address, if any.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: No
String city
The city of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String state
The state or province of the contact's city.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: No
String countryCode
Code for the country of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String zipCode
The zip or postal code of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: No
String phoneNumber
The phone number of the contact.
Type: String
Default: None
Constraints: Phone number must be specified in the format
"+[country dialing code].[number including any area code>]". For
example, a US phone number might appear as "+1.1234567890".
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String email
Email address of the contact.
Type: String
Default: None
Constraints: Maximum 254 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String fax
Fax number of the contact.
Type: String
Default: None
Constraints: Phone number must be specified in the format
"+[country dialing code].[number including any area code]". For example,
a US phone number might appear as "+1.1234567890".
Parents: RegistrantContact, AdminContact,
TechContact
Required: No
com.amazonaws.internal.SdkInternalList<T> extraParams
A list of name-value pairs for parameters required by certain top-level domains.
Type: Complex
Default: None
Parents: RegistrantContact, AdminContact,
TechContact
Children: Name, Value
Required: No
String domainName
The domain for which you want to delete one or more tags.
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when theyaposre surrounded by letters, numbers, or other hyphens. You canapost specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.
Required: Yes
com.amazonaws.internal.SdkInternalList<T> tagsToDelete
A list of tag keys to delete.
Type: A list that contains the keys of the tags that you want to delete.
Default: None
Required: No
'>String domainName
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Boolean autoRenew
Indicates whether the domain is automatically renewed upon expiration.
Type: Boolean
Valid values: True | False
Boolean transferLock
Indicates whether a domain is locked from unauthorized transfer to another party.
Type: Boolean
Valid values: True | False
Date expiry
Expiration date of the domain in Coordinated Universal Time (UTC).
Type: Long
String domainName
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String name
Name of the additional parameter required by the top-level domain.
Type: String
Default: None
Valid values: DUNS_NUMBER | BRAND_NUMBER |
BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD |
BIRTH_COUNTRY | BIRTH_CITY |
DOCUMENT_NUMBER | AU_ID_NUMBER |
AU_ID_TYPE | CA_LEGAL_TYPE |
ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE |
ES_LEGAL_FORM | FI_BUSINESS_NUMBER |
FI_ID_NUMBER | IT_PIN |
RU_PASSPORT_DATA | SE_ID_NUMBER |
SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
String value
Values corresponding to the additional parameter names required by some top-level domains.
Type: String
Default: None
Constraints: Maximum 2048 characters.
Parent: ExtraParams
Required: Yes
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String domainName
The name of a domain.
Type: String
com.amazonaws.internal.SdkInternalList<T> nameservers
The name of the domain.
Type: String
Boolean autoRenew
Specifies whether the domain registration is set to renew automatically.
Type: Boolean
ContactDetail adminContact
Provides details about the domain administrative contact.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
ContactDetail registrantContact
Provides details about the domain registrant.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
ContactDetail techContact
Provides details about the domain technical contact.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Boolean adminPrivacy
Specifies whether contact information for the admin contact is concealed
from WHOIS queries. If the value is true, WHOIS ("who is")
queries will return contact information for our registrar partner, Gandi,
instead of the contact information that you enter.
Type: Boolean
Boolean registrantPrivacy
Specifies whether contact information for the registrant contact is
concealed from WHOIS queries. If the value is true, WHOIS
("who is") queries will return contact information for our registrar
partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Boolean techPrivacy
Specifies whether contact information for the tech contact is concealed
from WHOIS queries. If the value is true, WHOIS ("who is")
queries will return contact information for our registrar partner, Gandi,
instead of the contact information that you enter.
Type: Boolean
String registrarName
Name of the registrar of the domain as identified in the registry. Amazon
Route 53 domains are registered by registrar Gandi. The value is
"GANDI SAS".
Type: String
String whoIsServer
The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.
Type: String
String registrarUrl
Web address of the registrar.
Type: String
String abuseContactEmail
Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.
Type: String
String abuseContactPhone
Phone number for reporting abuse.
Type: String
String registryDomainId
Reserved for future use.
Date creationDate
The date when the domain was created as found in the response to a WHOIS query. The date format is Unix time.
Date updatedDate
The last updated date of the domain as found in the response to a WHOIS query. The date format is Unix time.
Date expirationDate
The date when the registration for the domain is set to expire. The date format is Unix time.
String reseller
Reseller of the domain. Domains registered or transferred using Amazon
Route 53 domains will have "Amazon" as the reseller.
Type: String
String dnsSec
Reserved for future use.
com.amazonaws.internal.SdkInternalList<T> statusList
An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.
ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.
For a current list of domain name status codes and an explanation of what
each code means, go to the ICANN
website and search for epp status codes. (Search on the
ICANN website; web searches sometimes return an old version of the
document.)
Type: Array of String
String operationId
The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.
Type: String
Default: None
Required: Yes
String operationId
The identifier for the operation.
Type: String
String status
The current status of the requested operation in the system.
Type: String
String message
Detailed information on the status including possible errors.
Type: String
String domainName
The name of a domain.
Type: String
String type
The type of operation that was requested.
Type: String
Date submittedDate
The date when the request was submitted.
String marker
For an initial request for a list of domains, omit this element. If the
number of domains that are associated with the current AWS account is
greater than the value that you specified for MaxItems, you
can use Marker to return additional domains. Get the value
of NextPageMarker from the previous response, and submit
another request that includes the value of NextPageMarker in
the Marker element.
Type: String
Default: None
Constraints: The marker must match the value specified in the previous request.
Required: No
Integer maxItems
Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A numeral between 1 and 100.
Required: No
com.amazonaws.internal.SdkInternalList<T> domains
A summary of domains.
Type: Complex type containing a list of domain summaries.
Children: AutoRenew, DomainName,
Expiry, TransferLock
String nextPageMarker
If there are more domains than you specified for MaxItems in
the request, submit another request and include the value of
NextPageMarker in the value of Marker.
Type: String
Parent: Operations
String marker
For an initial request for a list of operations, omit this element. If
the number of operations that are not yet complete is greater than the
value that you specified for MaxItems, you can use
Marker to return additional operations. Get the value of
NextPageMarker from the previous response, and submit
another request that includes the value of NextPageMarker in
the Marker element.
Type: String
Default: None
Required: No
Integer maxItems
Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A value between 1 and 100.
Required: No
com.amazonaws.internal.SdkInternalList<T> operations
Lists summaries of the operations.
Type: Complex type containing a list of operation summaries
Children: OperationId, Status,
SubmittedDate, Type
String nextPageMarker
If there are more operations than you specified for MaxItems
in the request, submit another request and include the value of
NextPageMarker in the value of Marker.
Type: String
Parent: Operations
String domainName
The domain for which you want to get a list of tags.
com.amazonaws.internal.SdkInternalList<T> tagList
A list of the tags that are associated with the specified domain.
Type: A complex type containing a list of tags
Each tag includes the following elements.
Key
The key (name) of a tag.
Type: String
Value
The value of a tag.
Type: String
String name
The fully qualified host name of the name server.
Type: String
Constraint: Maximum 255 characterss
Parent: Nameservers
com.amazonaws.internal.SdkInternalList<T> glueIps
Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.
Type: List of IP addresses.
Constraints: The list can contain only one IPv4 and one IPv6 address.
Parent: Nameservers
String operationId
Identifier returned to track the requested action.
Type: String
String status
The current status of the requested operation in the system.
Type: String
String type
Type of the action requested.
Type: String
Valid values: REGISTER_DOMAIN | DELETE_DOMAIN |
TRANSFER_IN_DOMAIN | UPDATE_DOMAIN_CONTACT |
UPDATE_NAMESERVER | CHANGE_PRIVACY_PROTECTION |
DOMAIN_LOCK
Date submittedDate
The date when the request was submitted.
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String idnLangCode
Reserved for future use.
Integer durationInYears
The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
Boolean autoRenew
Indicates whether the domain will be automatically renewed (
true) or not (false). Autorenewal only takes
effect after the account is charged.
Type: Boolean
Valid values: true | false
Default: true
Required: No
ContactDetail adminContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
ContactDetail registrantContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
ContactDetail techContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
Boolean privacyProtectAdminContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
Boolean privacyProtectRegistrantContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
Boolean privacyProtectTechContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String authCode
The authorization code for the domain.
Type: String
String key
The key (name) of a tag.
Type: String
Default: None
Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"
Constraints: Each key can be 1-128 characters long.
Required: Yes
String value
The value of a tag.
Type: String
Default: None
Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"
Constraints: Each value can be 0-256 characters long.
Required: Yes
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String idnLangCode
Reserved for future use.
Integer durationInYears
The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
com.amazonaws.internal.SdkInternalList<T> nameservers
Contains details for the host and glue IP addresses.
Type: Complex
Children: GlueIps, Name
Required: No
String authCode
The authorization code for the domain. You get this value from the current registrar.
Type: String
Required: Yes
Boolean autoRenew
Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.
Type: Boolean
Valid values: true | false
Default: true
Required: No
ContactDetail adminContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
ContactDetail registrantContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
ContactDetail techContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
Boolean privacyProtectAdminContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
Boolean privacyProtectRegistrantContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
Boolean privacyProtectTechContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Boolean adminPrivacy
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
Boolean registrantPrivacy
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
Boolean techPrivacy
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
ContactDetail adminContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
ContactDetail registrantContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
ContactDetail techContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String fIAuthKey
The authorization key for .fi domains
com.amazonaws.internal.SdkInternalList<T> nameservers
A list of new name servers for the domain.
Type: Complex
Children: Name, GlueIps
Required: Yes
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The domain for which you want to add or update tags.
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when theyaposre surrounded by letters, numbers, or other hyphens. You canapost specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.
Required: Yes
com.amazonaws.internal.SdkInternalList<T> tagsToUpdate
A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced.
Type: A complex type containing a list of tags
Default: None
Required: No
'>Each tag includes the following elements:
Key
The key (name) of a tag.
Type: String
Default: None
Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@"
Constraints: Each key can be 1-128 characters long.
Required: Yes
Value
The value of a tag.
Type: String
Default: None
Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@"
Constraints: Each value can be 0-256 characters long.
Required: Yes
Copyright © 2015. All rights reserved.