String hostedZoneId
Alias resource record sets only: The value you use depends on where you want to route queries:
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.String dNSName
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:
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.Name element for a resource record set in the current
hosted zone.Boolean evaluateTargetHealth
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:
Note the following:
EvaluateTargetHealth to true when the
alias target is a CloudFront distribution.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.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
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.
VPC vPC
The VPC that you want your hosted zone to be associated with.
String comment
Optional: Any comments you want to include about a
AssociateVPCWithHostedZoneRequest.
ChangeInfo changeInfo
A complex type that contains the ID, the status, and the date and time of
your AssociateVPCWithHostedZoneRequest.
String action
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 resourceRecordSet
Information about the resource record set to create or delete.
String comment
Optional: Any comments you want to include about a change batch request.
com.amazonaws.internal.SdkInternalList<T> changes
A complex type that contains one Change element for each
resource record set that you want to create or delete.
String id
The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
Date submittedAt
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).
String status
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
String comment
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.
String submitter
The AWS account ID attached to the changes.
com.amazonaws.internal.SdkInternalList<T> changes
A list of changes made in the ChangeBatch.
String id
The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
String status
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
Date submittedAt
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).
String comment
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.
String hostedZoneId
The ID of the hosted zone that contains the resource record sets that you want to change.
ChangeBatch changeBatch
A complex type that contains an optional comment and the
Changes element.
ChangeInfo changeInfo
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.
String resourceType
The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
String resourceId
The ID of the resource for which you want to add, change, or delete tags.
com.amazonaws.internal.SdkInternalList<T> addTags
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.
com.amazonaws.internal.SdkInternalList<T> removeTagKeys
A list of Tag keys that you want to remove from the
specified resource.
Integer evaluationPeriods
The number of periods over which data is compared to the specified threshold.
Double threshold
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.
String comparisonOperator
The arithmetic operation to use when comparing the specified Statistic and Threshold.
Valid Values are GreaterThanOrEqualToThreshold,
GreaterThanThreshold, LessThanThreshold and
LessThanOrEqualToThreshold
Integer period
An integer that represents the period in seconds over which the statistic is applied.
String metricName
The name of the CloudWatch metric that is associated with the CloudWatch alarm.
String namespace
The namespace of the CloudWatch metric that is associated with the CloudWatch alarm.
String statistic
The statistic to apply to the CloudWatch metric that is associated with the CloudWatch alarm.
Valid Values are SampleCount, Average,
Sum, Minimum and Maximum
com.amazonaws.internal.SdkInternalList<T> dimensions
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.
String callerReference
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 healthCheckConfig
A complex type that contains health check configuration.
HealthCheck healthCheck
A complex type that contains identifying information about the health check.
String location
The unique URL representing the new health check.
String name
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 vPC
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.
String callerReference
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 hostedZoneConfig
A complex type that contains an optional comment about your hosted zone.
String delegationSetId
The delegation set id of the reusable delgation set whose NS records you want to assign to the new hosted zone.
HostedZone hostedZone
A complex type that contains identifying information about the hosted zone.
ChangeInfo changeInfo
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 delegationSet
A complex type that contains name server information.
VPC vPC
String location
The unique URL representing the new hosted zone.
String callerReference
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.
String hostedZoneId
The ID of the hosted zone whose delegation set you want to mark as reusable. It is an optional parameter.
DelegationSet delegationSet
A complex type that contains name server information.
String location
The unique URL representing the new reusbale delegation set.
String hostedZoneId
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.
String name
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.
Long tTL
The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.
String trafficPolicyId
The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
Integer trafficPolicyVersion
The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
TrafficPolicyInstance trafficPolicyInstance
A complex type that contains settings for the new traffic policy instance.
String location
A unique URL that represents a new traffic policy instance.
String name
The name of the traffic policy.
String document
The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format in the Amazon Route 53 API Reference.
String comment
Any comments that you want to include about the traffic policy.
TrafficPolicy trafficPolicy
A complex type that contains settings for the new traffic policy.
String location
String id
The ID of the traffic policy for which you want to create a new version.
String document
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.
String comment
Any comments that you want to include about the new traffic policy version.
TrafficPolicy trafficPolicy
A complex type that contains settings for the new version of the traffic policy.
String location
String id
String callerReference
com.amazonaws.internal.SdkInternalList<T> nameServers
A complex type that contains the authoritative name servers for the
hosted zone. Use the method provided by your domain registrar to add an
NS record to your domain for each NameServer that is
assigned to your hosted zone.
String healthCheckId
The ID of the health check to delete.
String id
The ID of the hosted zone you want to delete.
ChangeInfo changeInfo
A complex type that contains the ID, the status, and the date and time of your delete request.
String id
The ID of the reusable delegation set you want to delete.
String id
The ID of the traffic policy instance that you want to delete.
String hostedZoneId
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.
VPC vPC
The VPC that you want your hosted zone to be disassociated from.
String comment
Optional: Any comments you want to include about a
DisassociateVPCFromHostedZoneRequest.
ChangeInfo changeInfo
A complex type that contains the ID, the status, and the date and time of
your DisassociateVPCFromHostedZoneRequest.
String continentCode
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS |
EU | OC | NA | SA
Constraint: Specifying ContinentCode with either
CountryCode or SubdivisionCode returns an
InvalidInput error.
String countryCode
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All
other country codes follow the ISO 3166 two-character code.
String subdivisionCode
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.
String continentCode
The code for a continent geo location. Note: only continent locations have a continent code.
String continentName
The name of the continent. This element is only present if
ContinentCode is also present.
String countryCode
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All
other country codes follow the ISO 3166 two-character code.
String countryName
The name of the country. This element is only present if
CountryCode is also present.
String subdivisionCode
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
String subdivisionName
The name of the subdivision. This element is only present if
SubdivisionCode is also present.
String id
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.
ChangeBatchRecord changeBatchRecord
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.
String id
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.
ChangeInfo changeInfo
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.
com.amazonaws.internal.SdkInternalList<T> checkerIpRanges
A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.
String continentCode
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS |
EU | OC | NA | SA
Constraint: Specifying ContinentCode with either
CountryCode or SubdivisionCode returns an
InvalidInput error.
String countryCode
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All
other country codes follow the ISO 3166 two-character code.
String subdivisionCode
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.
GeoLocationDetails geoLocationDetails
A complex type that contains the information about the specified geo location.
Long healthCheckCount
The number of health checks associated with the current AWS account.
String healthCheckId
The ID of the health check for which you want to retrieve the reason for the most recent failure.
com.amazonaws.internal.SdkInternalList<T> healthCheckObservations
A list that contains one HealthCheckObservation element for
each Amazon Route 53 health checker.
String healthCheckId
The ID of the health check to retrieve.
HealthCheck healthCheck
A complex type that contains the information about the specified health check.
String healthCheckId
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 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.com.amazonaws.internal.SdkInternalList<T> healthCheckObservations
A list that contains one HealthCheckObservation element for
each Amazon Route 53 health checker.
Long hostedZoneCount
The number of hosted zones associated with the current AWS account.
String id
The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.
HostedZone hostedZone
A complex type that contains the information about the specified hosted zone.
DelegationSet delegationSet
A complex type that contains information about the name servers for the specified hosted zone.
com.amazonaws.internal.SdkInternalList<T> vPCs
A complex type that contains information about VPCs associated with the specified hosted zone.
String id
The ID of the reusable delegation set for which you want to get a list of the name server.
DelegationSet delegationSet
A complex type that contains the information about the nameservers for the specified delegation set ID.
Integer trafficPolicyInstanceCount
The number of traffic policy instances that are associated with the current AWS account.
String id
The ID of the traffic policy instance that you want to get information about.
TrafficPolicyInstance trafficPolicyInstance
A complex type that contains settings for the traffic policy instance.
TrafficPolicy trafficPolicy
A complex type that contains settings for the specified traffic policy.
String id
The ID of the specified health check.
String callerReference
A unique string that identifies the request to create the health check.
HealthCheckConfig healthCheckConfig
A complex type that contains the health check configuration.
Long healthCheckVersion
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 cloudWatchAlarmConfiguration
For CLOUDWATCH_METRIC health checks, a complex type that contains information about the CloudWatch alarm that you're associating with the health check.
String iPAddress
IP Address of the instance being checked.
Integer port
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.
String type
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.
String resourcePath
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.
String fullyQualifiedDomainName
Fully qualified domain name of the instance to be health checked.
String searchString
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.
Integer requestInterval
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.
Integer failureThreshold
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.
Boolean measureLatency
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.
Boolean inverted
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.
Integer healthThreshold
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.
com.amazonaws.internal.SdkInternalList<T> childHealthChecks
For a specified parent health check, a list of HealthCheckId
values for the associated child health checks.
Boolean enableSNI
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.
com.amazonaws.internal.SdkInternalList<T> regions
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 alarmIdentifier
A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
String insufficientDataHealthStatus
The status of the health check when CloudWatch has insufficient data
about the state of associated alarm. Valid values are
Healthy, Unhealthy and
LastKnownStatus.
String region
The HealthCheckRegion of the Amazon Route 53 health checker
that performed this health check.
String iPAddress
The IP address of the Amazon Route 53 health checker that performed this health check.
StatusReport statusReport
A complex type that contains information about the health check status for the current observation.
String id
The ID of the specified hosted zone.
String name
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.
String callerReference
A unique string that identifies the request to create the hosted zone.
HostedZoneConfig config
A complex type that contains the Comment element.
Long resourceRecordSetCount
Total number of resource record sets in the hosted zone.
String comment
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.
Boolean privateZone
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.
com.amazonaws.internal.SdkInternalList<T> messages
Descriptive message for the error response.
String hostedZoneId
The ID of the hosted zone that you want to see changes for.
String startDate
The start of the time period you want to see changes for.
String endDate
The end of the time period you want to see changes for.
String maxItems
The maximum number of items on a page.
String marker
The page marker.
String maxItems
The maximum number of items on a page.
String marker
The page marker.
Boolean isTruncated
A flag that indicates if there are more change batches to list.
com.amazonaws.internal.SdkInternalList<T> changeBatchRecords
The change batches within the given hosted zone and time period.
String nextMarker
The next page marker.
String hostedZoneId
The ID of the hosted zone that you want to see changes for.
String name
The name of the RRSet that you want to see changes for.
String type
The type of the RRSet that you want to see changes for.
String setIdentifier
The identifier of the RRSet that you want to see changes for.
String startDate
The start of the time period you want to see changes for.
String endDate
The end of the time period you want to see changes for.
String maxItems
The maximum number of items on a page.
String marker
The page marker.
String maxItems
The maximum number of items on a page.
String marker
The page marker.
Boolean isTruncated
A flag that indicates if there are more change batches to list.
com.amazonaws.internal.SdkInternalList<T> changeBatchRecords
The change batches within the given hosted zone and time period.
String nextMarker
The next page marker.
String startContinentCode
The first continent code in the lexicographic ordering of geo locations
that you want the ListGeoLocations request to list. For
non-continent geo locations, this should be null.
Valid values: AF | AN | AS |
EU | OC | NA | SA
Constraint: Specifying ContinentCode with either
CountryCode or SubdivisionCode returns an
InvalidInput error.
String startCountryCode
The first country code in the lexicographic ordering of geo locations
that you want the ListGeoLocations request to list.
The default geo location uses a * for the country code. All
other country codes follow the ISO 3166 two-character code.
String startSubdivisionCode
The first subdivision code in the lexicographic ordering of geo locations
that you want the ListGeoLocations request to list.
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
String maxItems
The maximum number of geo locations you want in the response body.
com.amazonaws.internal.SdkInternalList<T> geoLocationDetailsList
A complex type that contains information about the geo locations that are returned by the request.
Boolean isTruncated
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
String nextContinentCode
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.
String nextCountryCode
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.
String nextSubdivisionCode
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.
String maxItems
The maximum number of records you requested. The maximum value of
MaxItems is 100.
String marker
If the request returned more than one page of results, submit another
request and specify the value of NextMarker from the last
response in the marker parameter to get the next page of
results.
String maxItems
Specify the maximum number of health checks to return per page of results.
com.amazonaws.internal.SdkInternalList<T> healthChecks
A complex type that contains information about the health checks associated with the current AWS account.
String marker
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.
Boolean isTruncated
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
String nextMarker
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.
String maxItems
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.
String dNSName
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.
String hostedZoneId
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.
String maxItems
Specify the maximum number of hosted zones to return per page of results.
com.amazonaws.internal.SdkInternalList<T> hostedZones
A complex type that contains information about the hosted zones associated with the current AWS account.
String dNSName
The DNSName value sent in the request.
String hostedZoneId
The HostedZoneId value sent in the request.
Boolean isTruncated
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
String nextDNSName
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.
String nextHostedZoneId
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.
String maxItems
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.
String marker
If the request returned more than one page of results, submit another
request and specify the value of NextMarker from the last
response in the marker parameter to get the next page of
results.
String maxItems
Specify the maximum number of hosted zones to return per page of results.
String delegationSetId
com.amazonaws.internal.SdkInternalList<T> hostedZones
A complex type that contains information about the hosted zones associated with the current AWS account.
String marker
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.
Boolean isTruncated
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
String nextMarker
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.
String maxItems
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.
String hostedZoneId
The ID of the hosted zone that contains the resource record sets that you want to get.
String startRecordName
The first name in the lexicographic ordering of domain names that you
want the ListResourceRecordSets request to list.
String startRecordType
The DNS type at which to begin the listing of resource record sets.
Valid values: A | AAAA | CNAME |
MX | NS | PTR | SOA |
SPF | SRV | TXT
Values for Weighted Resource Record Sets: A |
AAAA | CNAME | TXT
Values for Regional Resource Record Sets: A |
AAAA | CNAME | TXT
Values for Alias Resource Record Sets: A | AAAA
Constraint: Specifying type without specifying
name returns an InvalidInput error.
String startRecordIdentifier
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.
String maxItems
The maximum number of records you want in the response body.
com.amazonaws.internal.SdkInternalList<T> resourceRecordSets
A complex type that contains information about the resource record sets that are returned by the request.
Boolean isTruncated
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
String nextRecordName
If the results were truncated, the name of the next record in the list.
This element is present only if IsTruncated is true.
String nextRecordType
If the results were truncated, the type of the next record in the list.
This element is present only if IsTruncated is true.
String nextRecordIdentifier
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.
String maxItems
The maximum number of records you requested. The maximum value of
MaxItems is 100.
String marker
If the request returned more than one page of results, submit another
request and specify the value of NextMarker from the last
response in the marker parameter to get the next page of
results.
String maxItems
Specify the maximum number of reusable delegation sets to return per page of results.
com.amazonaws.internal.SdkInternalList<T> delegationSets
A complex type that contains information about the reusable delegation sets associated with the current AWS account.
String marker
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.
Boolean isTruncated
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
String nextMarker
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.
String maxItems
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.
ResourceTagSet resourceTagSet
A ResourceTagSet containing tags associated with the
specified resource.
String resourceType
The type of the resources.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
com.amazonaws.internal.SdkInternalList<T> resourceIds
A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.
com.amazonaws.internal.SdkInternalList<T> resourceTagSets
A list of ResourceTagSets containing tags associated with
the specified resources.
String trafficPolicyIdMarker
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.
String maxItems
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.
com.amazonaws.internal.SdkInternalList<T> trafficPolicySummaries
A list that contains one TrafficPolicySummary element for
each traffic policy that was created by the current AWS account.
Boolean isTruncated
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
String trafficPolicyIdMarker
If the value of IsTruncated is true,
TrafficPolicyIdMarker is the ID of the first traffic policy
in the next group of MaxItems traffic policies.
String maxItems
The value that you specified for the MaxItems parameter in
the call to ListTrafficPolicies that produced the current
response.
String hostedZoneId
The ID of the hosted zone for which you want to list traffic policy instances.
String trafficPolicyInstanceNameMarker
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.
String trafficPolicyInstanceTypeMarker
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.
String maxItems
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.
com.amazonaws.internal.SdkInternalList<T> trafficPolicyInstances
A list that contains one TrafficPolicyInstance element for
each traffic policy instance that matches the elements in the request.
String trafficPolicyInstanceNameMarker
If IsTruncated is true,
TrafficPolicyInstanceNameMarker is the name of the first
traffic policy instance in the next group of MaxItems
traffic policy instances.
String trafficPolicyInstanceTypeMarker
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.
Boolean isTruncated
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
String maxItems
The value that you specified for the MaxItems parameter in
the call to ListTrafficPolicyInstancesByHostedZone that
produced the current response.
String trafficPolicyId
The ID of the traffic policy for which you want to list traffic policy instances.
Integer trafficPolicyVersion
The version of the traffic policy for which you want to list traffic
policy instances. The version must be associated with the traffic policy
that is specified by TrafficPolicyId.
String hostedZoneIdMarker
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.
String trafficPolicyInstanceNameMarker
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.
String trafficPolicyInstanceTypeMarker
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.
String maxItems
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.
com.amazonaws.internal.SdkInternalList<T> trafficPolicyInstances
A list that contains one TrafficPolicyInstance element for
each traffic policy instance that matches the elements in the request.
String hostedZoneIdMarker
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.
String trafficPolicyInstanceNameMarker
If IsTruncated is true,
TrafficPolicyInstanceNameMarker is the name of the first
traffic policy instance in the next group of MaxItems
traffic policy instances.
String trafficPolicyInstanceTypeMarker
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.
Boolean isTruncated
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
String maxItems
The value that you specified for the MaxItems parameter in
the call to ListTrafficPolicyInstancesByPolicy that produced
the current response.
String hostedZoneIdMarker
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.
String trafficPolicyInstanceNameMarker
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.
String trafficPolicyInstanceTypeMarker
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.
String maxItems
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.
com.amazonaws.internal.SdkInternalList<T> trafficPolicyInstances
A list that contains one TrafficPolicyInstance element for
each traffic policy instance that matches the elements in the request.
String hostedZoneIdMarker
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.
String trafficPolicyInstanceNameMarker
If IsTruncated is true,
TrafficPolicyInstanceNameMarker is the name of the first
traffic policy instance in the next group of MaxItems
traffic policy instances.
String trafficPolicyInstanceTypeMarker
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.
Boolean isTruncated
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
String maxItems
The value that you specified for the MaxItems parameter in
the call to ListTrafficPolicyInstances that produced the
current response.
String id
Specify the value of Id of the traffic policy for which you
want to list all versions.
String trafficPolicyVersionMarker
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.
String maxItems
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.
com.amazonaws.internal.SdkInternalList<T> trafficPolicies
A list that contains one TrafficPolicy element for each
traffic policy version that is associated with the specified traffic
policy.
Boolean isTruncated
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
String trafficPolicyVersionMarker
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.
String maxItems
The value that you specified for the maxitems parameter in
the call to ListTrafficPolicyVersions that produced the
current response.
String value
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.
String name
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
String type
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.
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.String setIdentifier
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.
Long weight
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:
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.
String region
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.
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.GeoLocation geoLocation
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.
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 resource record sets only: To configure failover, you add
the Failover element to two resource record sets. For one
resource record set, you specify PRIMARY as the value for
Failover; for the other resource record set, you specify
SECONDARY. In addition, you include the
HealthCheckId element and specify the health check that you
want Amazon Route 53 to perform for each resource record set.
Except where noted, the following failover behaviors assume that you have
included the HealthCheckId element in both resource record
sets:
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
Long tTL
The cache time to live for the current resource record set. Note the following:
TTL
is required.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.com.amazonaws.internal.SdkInternalList<T> resourceRecords
A complex type that contains the resource records for the current resource record set.
AliasTarget aliasTarget
Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.
String healthCheckId
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.
String trafficPolicyInstanceId
String resourceType
The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
String resourceId
The ID for the specified resource.
com.amazonaws.internal.SdkInternalList<T> tags
The tags associated with the specified resource.
String status
The observed health check status.
Date checkedTime
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).
String healthCheckId
The ID of the health check to update.
Long healthCheckVersion
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.
String iPAddress
The IP address of the resource that you want to check.
Specify this value only if you want to change it.
Integer port
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.
String resourcePath
The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.
Specify this value only if you want to change it.
String fullyQualifiedDomainName
Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
String searchString
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.
Integer failureThreshold
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.
Boolean inverted
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.
Integer healthThreshold
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.
com.amazonaws.internal.SdkInternalList<T> childHealthChecks
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.
Boolean enableSNI
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.
com.amazonaws.internal.SdkInternalList<T> regions
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.
Specify this value only if you want to change it.
AlarmIdentifier alarmIdentifier
String insufficientDataHealthStatus
HealthCheck healthCheck
HostedZone hostedZone
TrafficPolicy trafficPolicy
A complex type that contains settings for the specified traffic policy.
String id
The ID of the traffic policy instance that you want to update.
Long tTL
The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.
String trafficPolicyId
The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
Integer trafficPolicyVersion
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.
TrafficPolicyInstance trafficPolicyInstance
A complex type that contains settings for the updated traffic policy instance.
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 they're surrounded by letters, numbers, or other hyphens. You can't 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 |
CA_BUSINESS_ENTITY_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 the domain for which you want to know whether the registrant contact has confirmed that the email address is valid.
Type: String
Default: None
Required: Yes
String domainName
The domain name for which you requested the reachability status.
String status
Whether the registrant contact has responded. PENDING
indicates that we sent the confirmation email and haven't received a
response yet, DONE indicates that we sent the email and got
confirmation from the registrant contact, and EXPIRED
indicates that the time limit expired before the registrant contact
responded.
Type: String
Valid values: PENDING, DONE,
EXPIRED
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 the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact.
Type: String
Default: None
Required: Yes
String domainName
The domain name for which you requested a confirmation email.
String emailAddress
The email address for the registrant contact at the time that we sent the verification email.
Boolean isAlreadyVerified
True if the email address for the registrant contact has already been verified, and false otherwise. If the email address has already been verified, we don't send another confirmation email.
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 they're surrounded by letters, numbers, or other hyphens. You can't 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 © 2016. All rights reserved.