Expand description
Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.
If you’re using the service, you’re probably looking for Route53Client and Route53.
Modules§
- util
- Utility helpers for working with Route53
Structs§
- Account
Limit A complex type that contains the type of limit that you specified in the request and the current value for that limit.
- Account
Limit Type Serializer - Activate
KeySigning KeyRequest - Activate
KeySigning KeyResponse - Alarm
Identifier A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
- Alarm
Identifier Serializer - Alarm
Name Serializer - Alias
Health Enabled Serializer - Alias
Target Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
When creating resource record sets for a private hosted zone, note the following:
-
Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
-
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone.
-
- Alias
Target Serializer - AssociateVPC
Comment Serializer - AssociateVPC
With Hosted Zone Request A complex type that contains information about the request to associate a VPC with a private hosted zone.
- AssociateVPC
With Hosted Zone Request Serializer - AssociateVPC
With Hosted Zone Response A complex type that contains the response information for the
AssociateVPCWithHostedZonerequest.- Change
The information for each resource record set that you want to change.
- Change
Action Serializer - Change
Batch The information for a change request.
- Change
Batch Serializer - Change
Info A complex type that describes change information about changes made to your hosted zone.
- Change
Resource Record Sets Request A complex type that contains change information for the resource record set.
- Change
Resource Record Sets Request Serializer - Change
Resource Record Sets Response A complex type containing the response for the request.
- Change
Serializer - Change
Tags ForResource Request A complex type that contains information about the tags that you want to add, edit, or delete.
- Change
Tags ForResource Request Serializer - Change
Tags ForResource Response Empty response for the request.
- Changes
Serializer - Child
Health Check List Serializer - Cloud
Watch Alarm Configuration A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.
- Cloud
Watch Logs LogGroup ArnSerializer - Cloud
Watch Region Serializer - Create
Health Check Request A complex type that contains the health check request information.
- Create
Health Check Request Serializer - Create
Health Check Response A complex type containing the response information for the new health check.
- Create
Hosted Zone Request A complex type that contains information about the request to create a public or private hosted zone.
- Create
Hosted Zone Request Serializer - Create
Hosted Zone Response A complex type containing the response information for the hosted zone.
- Create
KeySigning KeyRequest - Create
KeySigning KeyRequest Serializer - Create
KeySigning KeyResponse - Create
Query Logging Config Request - Create
Query Logging Config Request Serializer - Create
Query Logging Config Response - Create
Reusable Delegation SetRequest - Create
Reusable Delegation SetRequest Serializer - Create
Reusable Delegation SetResponse - Create
Traffic Policy Instance Request A complex type that contains information about the resource record sets that you want to create based on a specified traffic policy.
- Create
Traffic Policy Instance Request Serializer - Create
Traffic Policy Instance Response A complex type that contains the response information for the
CreateTrafficPolicyInstancerequest.- Create
Traffic Policy Request A complex type that contains information about the traffic policy that you want to create.
- Create
Traffic Policy Request Serializer - Create
Traffic Policy Response A complex type that contains the response information for the
CreateTrafficPolicyrequest.- Create
Traffic Policy Version Request A complex type that contains information about the traffic policy that you want to create a new version for.
- Create
Traffic Policy Version Request Serializer - Create
Traffic Policy Version Response A complex type that contains the response information for the
CreateTrafficPolicyVersionrequest.- CreateVPC
Association Authorization Request A complex type that contains information about the request to authorize associating a VPC with your private hosted zone. Authorization is only required when a private hosted zone and a VPC were created by using different accounts.
- CreateVPC
Association Authorization Request Serializer - CreateVPC
Association Authorization Response A complex type that contains the response information from a
CreateVPCAssociationAuthorizationrequest.- DNSName
Serializer - DNSSEC
Status A string repesenting the status of DNSSEC signing.
- Deactivate
KeySigning KeyRequest - Deactivate
KeySigning KeyResponse - Delegation
Set A complex type that lists the name servers in a delegation set, as well as the
CallerReferenceand theIDfor the delegation set.- Delete
Health Check Request This action deletes a health check.
- Delete
Health Check Response An empty element.
- Delete
Hosted Zone Request A request to delete a hosted zone.
- Delete
Hosted Zone Response A complex type that contains the response to a
DeleteHostedZonerequest.- Delete
KeySigning KeyRequest - Delete
KeySigning KeyResponse - Delete
Query Logging Config Request - Delete
Query Logging Config Response - Delete
Reusable Delegation SetRequest A request to delete a reusable delegation set.
- Delete
Reusable Delegation SetResponse An empty element.
- Delete
Traffic Policy Instance Request A request to delete a specified traffic policy instance.
- Delete
Traffic Policy Instance Response An empty element.
- Delete
Traffic Policy Request A request to delete a specified traffic policy version.
- Delete
Traffic Policy Response An empty element.
- DeleteVPC
Association Authorization Request A complex type that contains information about the request to remove authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account.
- DeleteVPC
Association Authorization Request Serializer - DeleteVPC
Association Authorization Response Empty response for the request.
- Dimension
For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension.
- Disable
Hosted ZoneDNSSEC Request - Disable
Hosted ZoneDNSSEC Response - Disabled
Serializer - DisassociateVPC
Comment Serializer - DisassociateVPC
From Hosted Zone Request A complex type that contains information about the VPC that you want to disassociate from a specified private hosted zone.
- DisassociateVPC
From Hosted Zone Request Serializer - DisassociateVPC
From Hosted Zone Response A complex type that contains the response information for the disassociate request.
- Enable
Hosted ZoneDNSSEC Request - Enable
Hosted ZoneDNSSEC Response - EnableSNI
Serializer - Failure
Threshold Serializer - Fully
Qualified Domain Name Serializer - GeoLocation
A complex type that contains information about a geographic location.
- GeoLocation
Continent Code Serializer - GeoLocation
Country Code Serializer - GeoLocation
Details A complex type that contains the codes and full continent, country, and subdivision names for the specified
geolocationcode.- GeoLocation
Serializer - GeoLocation
Subdivision Code Serializer - GetAccount
Limit Request A complex type that contains information about the request to create a hosted zone.
- GetAccount
Limit Response A complex type that contains the requested limit.
- GetChange
Request The input for a GetChange request.
- GetChange
Response A complex type that contains the
ChangeInfoelement.- GetChecker
IpRanges Request Empty request.
- GetChecker
IpRanges Response A complex type that contains the
CheckerIpRangeselement.- GetDNSSEC
Request - GetDNSSEC
Response - GetGeo
Location Request A request for information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.
- GetGeo
Location Response A complex type that contains the response information for the specified geolocation code.
- GetHealth
Check Count Request A request for the number of health checks that are associated with the current AWS account.
- GetHealth
Check Count Response A complex type that contains the response to a
GetHealthCheckCountrequest.- GetHealth
Check Last Failure Reason Request A request for the reason that a health check failed most recently.
- GetHealth
Check Last Failure Reason Response A complex type that contains the response to a
GetHealthCheckLastFailureReasonrequest.- GetHealth
Check Request A request to get information about a specified health check.
- GetHealth
Check Response A complex type that contains the response to a
GetHealthCheckrequest.- GetHealth
Check Status Request A request to get the status for a health check.
- GetHealth
Check Status Response A complex type that contains the response to a
GetHealthCheckrequest.- GetHosted
Zone Count Request A request to retrieve a count of all the hosted zones that are associated with the current AWS account.
- GetHosted
Zone Count Response A complex type that contains the response to a
GetHostedZoneCountrequest.- GetHosted
Zone Limit Request A complex type that contains information about the request to create a hosted zone.
- GetHosted
Zone Limit Response A complex type that contains the requested limit.
- GetHosted
Zone Request A request to get information about a specified hosted zone.
- GetHosted
Zone Response A complex type that contain the response to a
GetHostedZonerequest.- GetQuery
Logging Config Request - GetQuery
Logging Config Response - GetReusable
Delegation SetLimit Request A complex type that contains information about the request to create a hosted zone.
- GetReusable
Delegation SetLimit Response A complex type that contains the requested limit.
- GetReusable
Delegation SetRequest A request to get information about a specified reusable delegation set.
- GetReusable
Delegation SetResponse A complex type that contains the response to the
GetReusableDelegationSetrequest.- GetTraffic
Policy Instance Count Request Request to get the number of traffic policy instances that are associated with the current AWS account.
- GetTraffic
Policy Instance Count Response A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.
- GetTraffic
Policy Instance Request Gets information about a specified traffic policy instance.
- GetTraffic
Policy Instance Response A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.
- GetTraffic
Policy Request Gets information about a specific traffic policy version.
- GetTraffic
Policy Response A complex type that contains the response information for the request.
- Health
Check A complex type that contains information about one health check that is associated with the current AWS account.
- Health
Check Config A complex type that contains information about the health check.
- Health
Check Config Serializer - Health
Check IdSerializer - Health
Check Nonce Serializer - Health
Check Observation A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker.
- Health
Check Region List Serializer - Health
Check Region Serializer - Health
Check Type Serializer - Health
Check Version Serializer - Health
Threshold Serializer - Hosted
Zone A complex type that contains general information about the hosted zone.
- Hosted
Zone Config A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the
HostedZoneConfigandCommentelements.- Hosted
Zone Config Serializer - Hosted
Zone Limit A complex type that contains the type of limit that you specified in the request and the current value for that limit.
- Hosted
Zone Limit Type Serializer - Hosted
Zone Owner A complex type that identifies a hosted zone that a specified Amazon VPC is associated with and the owner of the hosted zone. If there is a value for
OwningAccount, there is no value forOwningService, and vice versa.- Hosted
Zone Summary In the response to a
ListHostedZonesByVPCrequest, theHostedZoneSummarieselement contains oneHostedZoneSummaryelement for each hosted zone that the specified Amazon VPC is associated with. EachHostedZoneSummaryelement contains the hosted zone name and ID, and information about who owns the hosted zone.- IPAddress
Serializer - Insufficient
Data Health Status Serializer - Inverted
Serializer - IsPrivate
Zone Serializer - KeySigning
Key A key-signing key (KSK) is a complex type that represents a public/private key pair. The private key is used to generate a digital signature for the zone signing key (ZSK). The public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always associated with a hosted zone; it cannot exist by itself.
- Linked
Service If a health check or hosted zone was created by another service,
LinkedServiceis a complex type that describes the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.- List
GeoLocations Request A request to get a list of geographic locations that Amazon Route 53 supports for geolocation resource record sets.
- List
GeoLocations Response A complex type containing the response information for the request.
- List
Health Checks Request A request to retrieve a list of the health checks that are associated with the current AWS account.
- List
Health Checks Response A complex type that contains the response to a
ListHealthChecksrequest.- List
Hosted Zones ByName Request Retrieves a list of the public and private hosted zones that are associated with the current AWS account in ASCII order by domain name.
- List
Hosted Zones ByName Response A complex type that contains the response information for the request.
- List
Hosted Zones ByVPC Request Lists all the private hosted zones that a specified VPC is associated with, regardless of which AWS account created the hosted zones.
- List
Hosted Zones ByVPC Response - List
Hosted Zones Request A request to retrieve a list of the public and private hosted zones that are associated with the current AWS account.
- List
Hosted Zones Response - List
Query Logging Configs Request - List
Query Logging Configs Response - List
Resource Record Sets Request A request for the resource record sets that are associated with a specified hosted zone.
- List
Resource Record Sets Response A complex type that contains list information for the resource record set.
- List
Reusable Delegation Sets Request A request to get a list of the reusable delegation sets that are associated with the current AWS account.
- List
Reusable Delegation Sets Response A complex type that contains information about the reusable delegation sets that are associated with the current AWS account.
- List
Tags ForResource Request A complex type containing information about a request for a list of the tags that are associated with an individual resource.
- List
Tags ForResource Response A complex type that contains information about the health checks or hosted zones for which you want to list tags.
- List
Tags ForResources Request A complex type that contains information about the health checks or hosted zones for which you want to list tags.
- List
Tags ForResources Request Serializer - List
Tags ForResources Response A complex type containing tags for the specified resources.
- List
Traffic Policies Request A complex type that contains the information about the request to list the traffic policies that are associated with the current AWS account.
- List
Traffic Policies Response A complex type that contains the response information for the request.
- List
Traffic Policy Instances ByHosted Zone Request A request for the traffic policy instances that you created in a specified hosted zone.
- List
Traffic Policy Instances ByHosted Zone Response A complex type that contains the response information for the request.
- List
Traffic Policy Instances ByPolicy Request A complex type that contains the information about the request to list your traffic policy instances.
- List
Traffic Policy Instances ByPolicy Response A complex type that contains the response information for the request.
- List
Traffic Policy Instances Request A request to get information about the traffic policy instances that you created by using the current AWS account.
- List
Traffic Policy Instances Response A complex type that contains the response information for the request.
- List
Traffic Policy Versions Request A complex type that contains the information about the request to list your traffic policies.
- List
Traffic Policy Versions Response A complex type that contains the response information for the request.
- ListVPC
Association Authorizations Request A complex type that contains information about that can be associated with your hosted zone.
- ListVPC
Association Authorizations Response A complex type that contains the response information for the request.
- MaxResults
Serializer - Measure
Latency Serializer - Nonce
Serializer - Page
Marker Serializer - Page
MaxItems Serializer - Pagination
Token Serializer - Port
Serializer - Query
Logging Config A complex type that contains information about a configuration for DNS query logging.
- Query
Logging Config IdSerializer - RData
Serializer - RRType
Serializer - Request
Interval Serializer - Resettable
Element Name List Serializer - Resettable
Element Name Serializer - Resource
Description Serializer - Resource
IdSerializer - Resource
Path Serializer - Resource
Record Information specific to the resource record.
If you're creating an alias resource record set, omit
ResourceRecord.- Resource
Record Serializer - Resource
Record Set Information about the resource record set to create or delete.
- Resource
Record SetFailover Serializer - Resource
Record SetIdentifier Serializer - Resource
Record SetMulti Value Answer Serializer - Resource
Record SetRegion Serializer - Resource
Record SetSerializer - Resource
Record SetWeight Serializer - Resource
Records Serializer - Resource
TagSet A complex type containing a resource and its associated tags.
- Reusable
Delegation SetLimit A complex type that contains the type of limit that you specified in the request and the current value for that limit.
- Reusable
Delegation SetLimit Type Serializer - Route53
Client - A client for the Route 53 API.
- Search
String Serializer - Signing
KeyName Serializer - Signing
KeyStatus Serializer - Signing
KeyString Serializer - Status
Report A complex type that contains the status that one Amazon Route 53 health checker reports and the time of the health check.
- Subnet
Mask Serializer - TTLSerializer
- Tag
A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone.
- TagKey
List Serializer - TagKey
Serializer - TagList
Serializer - TagResource
IdList Serializer - TagResource
IdSerializer - TagResource
Type Serializer - TagSerializer
- TagValue
Serializer - TestDNS
Answer Request Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.
- TestDNS
Answer Response A complex type that contains the response to a
TestDNSAnswerrequest.- Traffic
Policy A complex type that contains settings for a traffic policy.
- Traffic
Policy Comment Serializer - Traffic
Policy Document Serializer - Traffic
Policy IdSerializer - Traffic
Policy Instance A complex type that contains settings for the new traffic policy instance.
- Traffic
Policy Instance IdSerializer - Traffic
Policy Name Serializer - Traffic
Policy Summary A complex type that contains information about the latest version of one traffic policy that is associated with the current AWS account.
- Traffic
Policy Version Marker Serializer - Traffic
Policy Version Serializer - Update
Health Check Request A complex type that contains information about a request to update a health check.
- Update
Health Check Request Serializer - Update
Health Check Response A complex type that contains the response to the
UpdateHealthCheckrequest.- Update
Hosted Zone Comment Request A request to update the comment for a hosted zone.
- Update
Hosted Zone Comment Request Serializer - Update
Hosted Zone Comment Response A complex type that contains the response to the
UpdateHostedZoneCommentrequest.- Update
Traffic Policy Comment Request A complex type that contains information about the traffic policy that you want to update the comment for.
- Update
Traffic Policy Comment Request Serializer - Update
Traffic Policy Comment Response A complex type that contains the response information for the traffic policy.
- Update
Traffic Policy Instance Request A complex type that contains information about the resource record sets that you want to update based on a specified traffic policy instance.
- Update
Traffic Policy Instance Request Serializer - Update
Traffic Policy Instance Response A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.
- VPC
(Private hosted zones only) A complex type that contains information about an Amazon VPC.
- VPCId
Serializer - VPCRegion
Serializer - VPCSerializer
Enums§
- Activate
KeySigning KeyError - Errors returned by ActivateKeySigningKey
- AssociateVPC
With Hosted Zone Error - Errors returned by AssociateVPCWithHostedZone
- Change
Resource Record Sets Error - Errors returned by ChangeResourceRecordSets
- Change
Tags ForResource Error - Errors returned by ChangeTagsForResource
- Create
Health Check Error - Errors returned by CreateHealthCheck
- Create
Hosted Zone Error - Errors returned by CreateHostedZone
- Create
KeySigning KeyError - Errors returned by CreateKeySigningKey
- Create
Query Logging Config Error - Errors returned by CreateQueryLoggingConfig
- Create
Reusable Delegation SetError - Errors returned by CreateReusableDelegationSet
- Create
Traffic Policy Error - Errors returned by CreateTrafficPolicy
- Create
Traffic Policy Instance Error - Errors returned by CreateTrafficPolicyInstance
- Create
Traffic Policy Version Error - Errors returned by CreateTrafficPolicyVersion
- CreateVPC
Association Authorization Error - Errors returned by CreateVPCAssociationAuthorization
- Deactivate
KeySigning KeyError - Errors returned by DeactivateKeySigningKey
- Delete
Health Check Error - Errors returned by DeleteHealthCheck
- Delete
Hosted Zone Error - Errors returned by DeleteHostedZone
- Delete
KeySigning KeyError - Errors returned by DeleteKeySigningKey
- Delete
Query Logging Config Error - Errors returned by DeleteQueryLoggingConfig
- Delete
Reusable Delegation SetError - Errors returned by DeleteReusableDelegationSet
- Delete
Traffic Policy Error - Errors returned by DeleteTrafficPolicy
- Delete
Traffic Policy Instance Error - Errors returned by DeleteTrafficPolicyInstance
- DeleteVPC
Association Authorization Error - Errors returned by DeleteVPCAssociationAuthorization
- Disable
Hosted ZoneDNSSEC Error - Errors returned by DisableHostedZoneDNSSEC
- DisassociateVPC
From Hosted Zone Error - Errors returned by DisassociateVPCFromHostedZone
- Enable
Hosted ZoneDNSSEC Error - Errors returned by EnableHostedZoneDNSSEC
- GetAccount
Limit Error - Errors returned by GetAccountLimit
- GetChange
Error - Errors returned by GetChange
- GetChecker
IpRanges Error - Errors returned by GetCheckerIpRanges
- GetDNSSEC
Error - Errors returned by GetDNSSEC
- GetGeo
Location Error - Errors returned by GetGeoLocation
- GetHealth
Check Count Error - Errors returned by GetHealthCheckCount
- GetHealth
Check Error - Errors returned by GetHealthCheck
- GetHealth
Check Last Failure Reason Error - Errors returned by GetHealthCheckLastFailureReason
- GetHealth
Check Status Error - Errors returned by GetHealthCheckStatus
- GetHosted
Zone Count Error - Errors returned by GetHostedZoneCount
- GetHosted
Zone Error - Errors returned by GetHostedZone
- GetHosted
Zone Limit Error - Errors returned by GetHostedZoneLimit
- GetQuery
Logging Config Error - Errors returned by GetQueryLoggingConfig
- GetReusable
Delegation SetError - Errors returned by GetReusableDelegationSet
- GetReusable
Delegation SetLimit Error - Errors returned by GetReusableDelegationSetLimit
- GetTraffic
Policy Error - Errors returned by GetTrafficPolicy
- GetTraffic
Policy Instance Count Error - Errors returned by GetTrafficPolicyInstanceCount
- GetTraffic
Policy Instance Error - Errors returned by GetTrafficPolicyInstance
- List
GeoLocations Error - Errors returned by ListGeoLocations
- List
Health Checks Error - Errors returned by ListHealthChecks
- List
Hosted Zones ByName Error - Errors returned by ListHostedZonesByName
- List
Hosted Zones ByVPC Error - Errors returned by ListHostedZonesByVPC
- List
Hosted Zones Error - Errors returned by ListHostedZones
- List
Query Logging Configs Error - Errors returned by ListQueryLoggingConfigs
- List
Resource Record Sets Error - Errors returned by ListResourceRecordSets
- List
Reusable Delegation Sets Error - Errors returned by ListReusableDelegationSets
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Tags ForResources Error - Errors returned by ListTagsForResources
- List
Traffic Policies Error - Errors returned by ListTrafficPolicies
- List
Traffic Policy Instances ByHosted Zone Error - Errors returned by ListTrafficPolicyInstancesByHostedZone
- List
Traffic Policy Instances ByPolicy Error - Errors returned by ListTrafficPolicyInstancesByPolicy
- List
Traffic Policy Instances Error - Errors returned by ListTrafficPolicyInstances
- List
Traffic Policy Versions Error - Errors returned by ListTrafficPolicyVersions
- ListVPC
Association Authorizations Error - Errors returned by ListVPCAssociationAuthorizations
- TestDNS
Answer Error - Errors returned by TestDNSAnswer
- Update
Health Check Error - Errors returned by UpdateHealthCheck
- Update
Hosted Zone Comment Error - Errors returned by UpdateHostedZoneComment
- Update
Traffic Policy Comment Error - Errors returned by UpdateTrafficPolicyComment
- Update
Traffic Policy Instance Error - Errors returned by UpdateTrafficPolicyInstance
Traits§
- Route53
- Trait representing the capabilities of the Route 53 API. Route 53 clients implement this trait.