# Code examples for Route 53 using AWS SDKs
The following code examples show how to use Route 53 with an AWS software development kit (SDK).
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
**Contents**
+ [Route 53](service_code_examples_route-53.md)
+ [Basics](service_code_examples_route-53_basics.md)
+ [Actions](service_code_examples_route-53_actions.md)
+ [`ChangeResourceRecordSets`](route-53_example_route-53_ChangeResourceRecordSets_section.md)
+ [`CreateHostedZone`](route-53_example_route-53_CreateHostedZone_section.md)
+ [`DeleteHostedZone`](route-53_example_route-53_DeleteHostedZone_section.md)
+ [`GetHostedZone`](route-53_example_route-53_GetHostedZone_section.md)
+ [`ListHostedZones`](route-53_example_route-53_ListHostedZones_section.md)
+ [`ListHostedZonesByName`](route-53_example_route-53_ListHostedZonesByName_section.md)
+ [`ListQueryLoggingConfigs`](route-53_example_route-53_ListQueryLoggingConfigs_section.md)
+ [Route 53 domain registration](service_code_examples_route-53-domains.md)
+ [Basics](service_code_examples_route-53-domains_basics.md)
+ [Hello Route 53 domain registration](route-53-domains_example_route-53-domains_Hello_section.md)
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
+ [Actions](service_code_examples_route-53-domains_actions.md)
+ [`CheckDomainAvailability`](route-53-domains_example_route-53-domains_CheckDomainAvailability_section.md)
+ [`CheckDomainTransferability`](route-53-domains_example_route-53-domains_CheckDomainTransferability_section.md)
+ [`GetDomainDetail`](route-53-domains_example_route-53-domains_GetDomainDetail_section.md)
+ [`GetDomainSuggestions`](route-53-domains_example_route-53-domains_GetDomainSuggestions_section.md)
+ [`GetOperationDetail`](route-53-domains_example_route-53-domains_GetOperationDetail_section.md)
+ [`ListDomains`](route-53-domains_example_route-53-domains_ListDomains_section.md)
+ [`ListOperations`](route-53-domains_example_route-53-domains_ListOperations_section.md)
+ [`ListPrices`](route-53-domains_example_route-53-domains_ListPrices_section.md)
+ [`RegisterDomain`](route-53-domains_example_route-53-domains_RegisterDomain_section.md)
+ [`ViewBilling`](route-53-domains_example_route-53-domains_ViewBilling_section.md)
# Code examples for Route 53 using AWS SDKs
The following code examples show how to use Route 53 with an AWS software development kit (SDK).
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
**Contents**
+ [Basics](service_code_examples_route-53_basics.md)
+ [Actions](service_code_examples_route-53_actions.md)
+ [`ChangeResourceRecordSets`](route-53_example_route-53_ChangeResourceRecordSets_section.md)
+ [`CreateHostedZone`](route-53_example_route-53_CreateHostedZone_section.md)
+ [`DeleteHostedZone`](route-53_example_route-53_DeleteHostedZone_section.md)
+ [`GetHostedZone`](route-53_example_route-53_GetHostedZone_section.md)
+ [`ListHostedZones`](route-53_example_route-53_ListHostedZones_section.md)
+ [`ListHostedZonesByName`](route-53_example_route-53_ListHostedZonesByName_section.md)
+ [`ListQueryLoggingConfigs`](route-53_example_route-53_ListQueryLoggingConfigs_section.md)
# Basic examples for Route 53 using AWS SDKs
The following code examples show how to use the basics of Amazon Route 53 with AWS SDKs.
**Contents**
+ [Actions](service_code_examples_route-53_actions.md)
+ [`ChangeResourceRecordSets`](route-53_example_route-53_ChangeResourceRecordSets_section.md)
+ [`CreateHostedZone`](route-53_example_route-53_CreateHostedZone_section.md)
+ [`DeleteHostedZone`](route-53_example_route-53_DeleteHostedZone_section.md)
+ [`GetHostedZone`](route-53_example_route-53_GetHostedZone_section.md)
+ [`ListHostedZones`](route-53_example_route-53_ListHostedZones_section.md)
+ [`ListHostedZonesByName`](route-53_example_route-53_ListHostedZonesByName_section.md)
+ [`ListQueryLoggingConfigs`](route-53_example_route-53_ListQueryLoggingConfigs_section.md)
# Actions for Route 53 using AWS SDKs
The following code examples demonstrate how to perform individual Route 53 actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
The following examples include only the most commonly used actions. For a complete list, see the [Amazon Route 53 API Reference](https://docs.aws.amazon.com/Route53/latest/APIReference/Welcome.html).
**Topics**
+ [`ChangeResourceRecordSets`](route-53_example_route-53_ChangeResourceRecordSets_section.md)
+ [`CreateHostedZone`](route-53_example_route-53_CreateHostedZone_section.md)
+ [`DeleteHostedZone`](route-53_example_route-53_DeleteHostedZone_section.md)
+ [`GetHostedZone`](route-53_example_route-53_GetHostedZone_section.md)
+ [`ListHostedZones`](route-53_example_route-53_ListHostedZones_section.md)
+ [`ListHostedZonesByName`](route-53_example_route-53_ListHostedZonesByName_section.md)
+ [`ListQueryLoggingConfigs`](route-53_example_route-53_ListQueryLoggingConfigs_section.md)
# Use `ChangeResourceRecordSets` with a CLI
The following code examples show how to use `ChangeResourceRecordSets`.
------
#### [ CLI ]
**AWS CLI**
**To create, update, or delete a resource record set**
The following `change-resource-record-sets` command creates a resource record set using the `hosted-zone-id` `Z1R8UBAEXAMPLE` and the JSON-formatted configuration in the file `C:\awscli\route53\change-resource-record-sets.json`:
```
aws route53 change-resource-record-sets --hosted-zone-id Z1R8UBAEXAMPLE --change-batch file://C:\awscli\route53\change-resource-record-sets.json
```
For more information, see POST ChangeResourceRecordSets in the *Amazon Route 53 API Reference*.
The configuration in the JSON file depends on the kind of resource record set you want to create:
BasicWeightedAliasWeighted AliasLatencyLatency AliasFailoverFailover Alias
**Basic Syntax**:
```
{
"Comment": "optional comment about the changes in this change batch request",
"Changes": [
{
"Action": "CREATE"|"DELETE"|"UPSERT",
"ResourceRecordSet": {
"Name": "DNS domain name",
"Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA",
"TTL": time to live in seconds,
"ResourceRecords": [
{
"Value": "applicable value for the record type"
},
{...}
]
}
},
{...}
]
}
```
**Weighted Syntax**:
```
{
"Comment": "optional comment about the changes in this change batch request",
"Changes": [
{
"Action": "CREATE"|"DELETE"|"UPSERT",
"ResourceRecordSet": {
"Name": "DNS domain name",
"Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA",
"SetIdentifier": "unique description for this resource record set",
"Weight": value between 0 and 255,
"TTL": time to live in seconds,
"ResourceRecords": [
{
"Value": "applicable value for the record type"
},
{...}
],
"HealthCheckId": "optional ID of an Amazon Route 53 health check"
}
},
{...}
]
}
```
**Alias Syntax**:
```
{
"Comment": "optional comment about the changes in this change batch request",
"Changes": [
{
"Action": "CREATE"|"DELETE"|"UPSERT",
"ResourceRecordSet": {
"Name": "DNS domain name",
"Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA",
"AliasTarget": {
"HostedZoneId": "hosted zone ID for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or Amazon Route 53 hosted zone",
"DNSName": "DNS domain name for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or another resource record set in this hosted zone",
"EvaluateTargetHealth": true|false
},
"HealthCheckId": "optional ID of an Amazon Route 53 health check"
}
},
{...}
]
}
```
**Weighted Alias Syntax**:
```
{
"Comment": "optional comment about the changes in this change batch request",
"Changes": [
{
"Action": "CREATE"|"DELETE"|"UPSERT",
"ResourceRecordSet": {
"Name": "DNS domain name",
"Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA",
"SetIdentifier": "unique description for this resource record set",
"Weight": value between 0 and 255,
"AliasTarget": {
"HostedZoneId": "hosted zone ID for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or Amazon Route 53 hosted zone",
"DNSName": "DNS domain name for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or another resource record set in this hosted zone",
"EvaluateTargetHealth": true|false
},
"HealthCheckId": "optional ID of an Amazon Route 53 health check"
}
},
{...}
]
}
```
**Latency Syntax**:
```
{
"Comment": "optional comment about the changes in this change batch request",
"Changes": [
{
"Action": "CREATE"|"DELETE"|"UPSERT",
"ResourceRecordSet": {
"Name": "DNS domain name",
"Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA",
"SetIdentifier": "unique description for this resource record set",
"Region": "Amazon EC2 region name",
"TTL": time to live in seconds,
"ResourceRecords": [
{
"Value": "applicable value for the record type"
},
{...}
],
"HealthCheckId": "optional ID of an Amazon Route 53 health check"
}
},
{...}
]
}
```
**Latency Alias Syntax**:
```
{
"Comment": "optional comment about the changes in this change batch request",
"Changes": [
{
"Action": "CREATE"|"DELETE"|"UPSERT",
"ResourceRecordSet": {
"Name": "DNS domain name",
"Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA",
"SetIdentifier": "unique description for this resource record set",
"Region": "Amazon EC2 region name",
"AliasTarget": {
"HostedZoneId": "hosted zone ID for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or Amazon Route 53 hosted zone",
"DNSName": "DNS domain name for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or another resource record set in this hosted zone",
"EvaluateTargetHealth": true|false
},
"HealthCheckId": "optional ID of an Amazon Route 53 health check"
}
},
{...}
]
}
```
**Failover Syntax**:
```
{
"Comment": "optional comment about the changes in this change batch request",
"Changes": [
{
"Action": "CREATE"|"DELETE"|"UPSERT",
"ResourceRecordSet": {
"Name": "DNS domain name",
"Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA",
"SetIdentifier": "unique description for this resource record set",
"Failover": "PRIMARY" | "SECONDARY",
"TTL": time to live in seconds,
"ResourceRecords": [
{
"Value": "applicable value for the record type"
},
{...}
],
"HealthCheckId": "ID of an Amazon Route 53 health check"
}
},
{...}
]
}
```
**Failover Alias Syntax**:
```
{
"Comment": "optional comment about the changes in this change batch request",
"Changes": [
{
"Action": "CREATE"|"DELETE"|"UPSERT",
"ResourceRecordSet": {
"Name": "DNS domain name",
"Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA",
"SetIdentifier": "unique description for this resource record set",
"Failover": "PRIMARY" | "SECONDARY",
"AliasTarget": {
"HostedZoneId": "hosted zone ID for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or Amazon Route 53 hosted zone",
"DNSName": "DNS domain name for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or another resource record set in this hosted zone",
"EvaluateTargetHealth": true|false
},
"HealthCheckId": "optional ID of an Amazon Route 53 health check"
}
},
{...}
]
}
```
+ For API details, see [ChangeResourceRecordSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53/change-resource-record-sets.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates an A record for www.example.com and changes the A record for test.example.com from 192.0.2.3 to 192.0.2.1. Note that values for changes TXT-type records must be in double quotes. See the Amazon Route 53 documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "www.example.com"
$change1.ResourceRecordSet.Type = "TXT"
$change1.ResourceRecordSet.TTL = 600
$change1.ResourceRecordSet.ResourceRecords.Add(@{Value="item 1 item 2 item 3"})
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "DELETE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "test.example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.TTL = 600
$change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.3"})
$change3 = New-Object Amazon.Route53.Model.Change
$change3.Action = "CREATE"
$change3.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change3.ResourceRecordSet.Name = "test.example.com"
$change3.ResourceRecordSet.Type = "A"
$change3.ResourceRecordSet.TTL = 600
$change3.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.1"})
$params = @{
HostedZoneId="Z1PA6795UKMFR9"
ChangeBatch_Comment="This change batch creates a TXT record for www.example.com. and changes the A record for test.example.com. from 192.0.2.3 to 192.0.2.1."
ChangeBatch_Change=$change1,$change2,$change3
}
Edit-R53ResourceRecordSet @params
```
**Example 2: This example shows how to create alias resource record sets. 'Z222222222' is the ID of the Amazon Route 53 hosted zone in which you're creating the alias resource record set. 'example.com' is the zone apex for which you want to create an alias and 'www.example.com' is a subdomain for which you also want to create an alias. 'Z1111111111111' is an example of a hosted zone ID for the load balancer and 'example-load-balancer-1111111111.us-east-1.elb.amazonaws.com' is an example of a load balancer domain name with which Amazon Route 53 responds to queries for example.com and www.example.com. See the Amazon Route 53 documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.us-east-1.elb.amazonaws.com."
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "www.example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.us-east-1.elb.amazonaws.com."
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $false
$params = @{
HostedZoneId="Z222222222"
ChangeBatch_Comment="This change batch creates two alias resource record sets, one for the zone apex, example.com, and one for www.example.com, that both point to example-load-balancer-1111111111.us-east-1.elb.amazonaws.com."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
**Example 3: This example creates two A records for www.example.com. One-fourth of the time (1/(1\$13)), Amazon Route 53 responds to queries for www.example.com with the two values for the first resource record set (192.0.2.9 and 192.0.2.10). Three-fourths of the time (3/(1\$13)) Amazon Route 53 responds to queries for www.example.com with the two values for the second resource record set (192.0.2.11 and 192.0.2.12). See the Amazon Route 53 documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "www.example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.SetIdentifier = "Rack 2, Positions 4 and 5"
$change1.ResourceRecordSet.Weight = 1
$change1.ResourceRecordSet.TTL = 600
$change1.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.9"})
$change1.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.10"})
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "www.example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.SetIdentifier = "Rack 5, Positions 1 and 2"
$change2.ResourceRecordSet.Weight = 3
$change2.ResourceRecordSet.TTL = 600
$change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.11"})
$change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.12"})
$params = @{
HostedZoneId="Z1PA6795UKMFR9"
ChangeBatch_Comment="This change creates two weighted resource record sets, each of which has two values."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
**Example 4: This example shows how to create weighted alias resource record sets assuming that example.com is the domain for which you want to create weighted alias resource record sets. SetIdentifier differentiates the two weighted alias resource record sets from one another. This element is required because the Name and Type elements have the same values for both resource record sets. Z1111111111111 and Z3333333333333 are examples of hosted zone IDs for the ELB load balancer specified by the value of DNSName. example-load-balancer-2222222222.us-east-1.elb.amazonaws.com and example-load-balancer-4444444444.us-east-1.elb.amazonaws.com are examples of Elastic Load Balancing domains from which Amazon Route 53 responds to queries for example.com. See the Amazon Route 53 documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.SetIdentifier = "1"
$change1.ResourceRecordSet.Weight = 3
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-2222222222.us-east-1.elb.amazonaws.com."
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.SetIdentifier = "2"
$change2.ResourceRecordSet.Weight = 1
$change2.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change2.ResourceRecordSet.AliasTarget.HostedZoneId = "Z3333333333333"
$change2.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-4444444444.us-east-1.elb.amazonaws.com."
$change2.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $false
$params = @{
HostedZoneId="Z5555555555"
ChangeBatch_Comment="This change batch creates two weighted alias resource record sets. Amazon Route 53 responds to queries for example.com with the first ELB domain 3/4ths of the times and the second one 1/4th of the time."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
**Example 5: This example creates two latency alias resource record sets, one for an ELB load balancer in the US West (Oregon) region (us-west-2), and another for a load balancer in the Asia Pacific (Singapore) region (ap-southeast-1). See the Amazon Route 53 documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.SetIdentifier = "Oregon load balancer 1"
$change1.ResourceRecordSet.Region = us-west-2
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-2222222222.us-west-2.elb.amazonaws.com"
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.SetIdentifier = "Singapore load balancer 1"
$change2.ResourceRecordSet.Region = ap-southeast-1
$change2.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change2.ResourceRecordSet.AliasTarget.HostedZoneId = "Z2222222222222"
$change2.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.ap-southeast-1.elb.amazonaws.com"
$change2.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$params = @{
HostedZoneId="Z5555555555"
ChangeBatch_Comment="This change batch creates two latency resource record sets, one for the US West (Oregon) region and one for the Asia Pacific (Singapore) region."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
+ For API details, see [ChangeResourceRecordSets](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates an A record for www.example.com and changes the A record for test.example.com from 192.0.2.3 to 192.0.2.1. Note that values for changes TXT-type records must be in double quotes. See the Amazon Route 53 documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "www.example.com"
$change1.ResourceRecordSet.Type = "TXT"
$change1.ResourceRecordSet.TTL = 600
$change1.ResourceRecordSet.ResourceRecords = @()
$change1.ResourceRecordSet.ResourceRecords.Add(@{Value="item 1 item 2 item 3"})
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "DELETE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "test.example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.TTL = 600
$change2.ResourceRecordSet.ResourceRecords = @()
$change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.3"})
$change3 = New-Object Amazon.Route53.Model.Change
$change3.Action = "CREATE"
$change3.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change3.ResourceRecordSet.Name = "test.example.com"
$change3.ResourceRecordSet.Type = "A"
$change3.ResourceRecordSet.TTL = 600
$change3.ResourceRecordSet.ResourceRecords = @()
$change3.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.1"})
$params = @{
HostedZoneId="Z1PA6795UKMFR9"
ChangeBatch_Comment="This change batch creates a TXT record for www.example.com. and changes the A record for test.example.com. from 192.0.2.3 to 192.0.2.1."
ChangeBatch_Change=$change1,$change2,$change3
}
Edit-R53ResourceRecordSet @params
```
**Example 2: This example shows how to create alias resource record sets. 'Z222222222' is the ID of the Amazon Route 53 hosted zone in which you're creating the alias resource record set. 'example.com' is the zone apex for which you want to create an alias and 'www.example.com' is a subdomain for which you also want to create an alias. 'Z1111111111111' is an example of a hosted zone ID for the load balancer and 'example-load-balancer-1111111111.us-east-1.elb.amazonaws.com' is an example of a load balancer domain name with which Amazon Route 53 responds to queries for example.com and www.example.com. See the Amazon Route 53 documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.us-east-1.elb.amazonaws.com."
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "www.example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.us-east-1.elb.amazonaws.com."
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $false
$params = @{
HostedZoneId="Z222222222"
ChangeBatch_Comment="This change batch creates two alias resource record sets, one for the zone apex, example.com, and one for www.example.com, that both point to example-load-balancer-1111111111.us-east-1.elb.amazonaws.com."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
**Example 3: This example creates two A records for www.example.com. One-fourth of the time (1/(1\$13)), Amazon Route 53 responds to queries for www.example.com with the two values for the first resource record set (192.0.2.9 and 192.0.2.10). Three-fourths of the time (3/(1\$13)) Amazon Route 53 responds to queries for www.example.com with the two values for the second resource record set (192.0.2.11 and 192.0.2.12). See the Amazon Route 53 documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "www.example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.SetIdentifier = "Rack 2, Positions 4 and 5"
$change1.ResourceRecordSet.Weight = 1
$change1.ResourceRecordSet.TTL = 600
$change1.ResourceRecordSet.ResourceRecords = @()
$change1.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.9"})
$change1.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.10"})
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "www.example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.SetIdentifier = "Rack 5, Positions 1 and 2"
$change2.ResourceRecordSet.Weight = 3
$change2.ResourceRecordSet.TTL = 600
$change2.ResourceRecordSet.ResourceRecords = @()
$change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.11"})
$change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.12"})
$params = @{
HostedZoneId="Z1PA6795UKMFR9"
ChangeBatch_Comment="This change creates two weighted resource record sets, each of which has two values."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
**Example 4: This example shows how to create weighted alias resource record sets assuming that example.com is the domain for which you want to create weighted alias resource record sets. SetIdentifier differentiates the two weighted alias resource record sets from one another. This element is required because the Name and Type elements have the same values for both resource record sets. Z1111111111111 and Z3333333333333 are examples of hosted zone IDs for the ELB load balancer specified by the value of DNSName. example-load-balancer-2222222222.us-east-1.elb.amazonaws.com and example-load-balancer-4444444444.us-east-1.elb.amazonaws.com are examples of Elastic Load Balancing domains from which Amazon Route 53 responds to queries for example.com. See the Amazon Route 53 documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.SetIdentifier = "1"
$change1.ResourceRecordSet.Weight = 3
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-2222222222.us-east-1.elb.amazonaws.com."
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.SetIdentifier = "2"
$change2.ResourceRecordSet.Weight = 1
$change2.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change2.ResourceRecordSet.AliasTarget.HostedZoneId = "Z3333333333333"
$change2.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-4444444444.us-east-1.elb.amazonaws.com."
$change2.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $false
$params = @{
HostedZoneId="Z5555555555"
ChangeBatch_Comment="This change batch creates two weighted alias resource record sets. Amazon Route 53 responds to queries for example.com with the first ELB domain 3/4ths of the times and the second one 1/4th of the time."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
**Example 5: This example creates two latency alias resource record sets, one for an ELB load balancer in the US West (Oregon) region (us-west-2), and another for a load balancer in the Asia Pacific (Singapore) region (ap-southeast-1). See the Amazon Route 53 documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.SetIdentifier = "Oregon load balancer 1"
$change1.ResourceRecordSet.Region = us-west-2
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-2222222222.us-west-2.elb.amazonaws.com"
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.SetIdentifier = "Singapore load balancer 1"
$change2.ResourceRecordSet.Region = ap-southeast-1
$change2.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change2.ResourceRecordSet.AliasTarget.HostedZoneId = "Z2222222222222"
$change2.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.ap-southeast-1.elb.amazonaws.com"
$change2.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$params = @{
HostedZoneId="Z5555555555"
ChangeBatch_Comment="This change batch creates two latency resource record sets, one for the US West (Oregon) region and one for the Asia Pacific (Singapore) region."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
+ For API details, see [ChangeResourceRecordSets](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `CreateHostedZone` with a CLI
The following code examples show how to use `CreateHostedZone`.
------
#### [ CLI ]
**AWS CLI**
**To create a hosted zone**
The following `create-hosted-zone` command adds a hosted zone named `example.com` using the caller reference `2014-04-01-18:47`. The optional comment includes a space, so it must be enclosed in quotation marks:
```
aws route53 create-hosted-zone --name example.com --caller-reference 2014-04-01-18:47 --hosted-zone-config Comment="command-line version"
```
For more information, see Working with Hosted Zones in the *Amazon Route 53 Developer Guide*.
+ For API details, see [CreateHostedZone](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53/create-hosted-zone.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Creates a new hosted zone named 'example.com', associated with a reusable delegation set. Note that you must supply a value for the CallerReference parameter so that requests that need to be retried if necessary without the risk of executing the operation twice. Because the hosted zone is being created in a VPC it is automatically private and you should not set the -HostedZoneConfig\$1PrivateZone parameter.**
```
$params = @{
Name="example.com"
CallerReference="myUniqueIdentifier"
HostedZoneConfig_Comment="This is my first hosted zone"
DelegationSetId="NZ8X2CISAMPLE"
VPC_VPCId="vpc-1a2b3c4d"
VPC_VPCRegion="us-east-1"
}
New-R53HostedZone @params
```
+ For API details, see [CreateHostedZone](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Creates a new hosted zone named 'example.com', associated with a reusable delegation set. Note that you must supply a value for the CallerReference parameter so that requests that need to be retried if necessary without the risk of executing the operation twice. Because the hosted zone is being created in a VPC it is automatically private and you should not set the -HostedZoneConfig\$1PrivateZone parameter.**
```
$params = @{
Name="example.com"
CallerReference="myUniqueIdentifier"
HostedZoneConfig_Comment="This is my first hosted zone"
DelegationSetId="NZ8X2CISAMPLE"
VPC_VPCId="vpc-1a2b3c4d"
VPC_VPCRegion="us-east-1"
}
New-R53HostedZone @params
```
+ For API details, see [CreateHostedZone](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `DeleteHostedZone` with a CLI
The following code examples show how to use `DeleteHostedZone`.
------
#### [ CLI ]
**AWS CLI**
**To delete a hosted zone**
The following `delete-hosted-zone` command deletes the hosted zone with an `id` of `Z36KTIQEXAMPLE`:
```
aws route53 delete-hosted-zone --id Z36KTIQEXAMPLE
```
+ For API details, see [DeleteHostedZone](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53/delete-hosted-zone.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Deletes the hosted zone with the specified ID. You will be prompted for confirmation before the command proceeds unless you add the -Force switch parameter.**
```
Remove-R53HostedZone -Id Z1PA6795UKMFR9
```
+ For API details, see [DeleteHostedZone](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Deletes the hosted zone with the specified ID. You will be prompted for confirmation before the command proceeds unless you add the -Force switch parameter.**
```
Remove-R53HostedZone -Id Z1PA6795UKMFR9
```
+ For API details, see [DeleteHostedZone](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `GetHostedZone` with a CLI
The following code examples show how to use `GetHostedZone`.
------
#### [ CLI ]
**AWS CLI**
**To get information about a hosted zone**
The following `get-hosted-zone` command gets information about the hosted zone with an `id` of `Z1R8UBAEXAMPLE`:
```
aws route53 get-hosted-zone --id Z1R8UBAEXAMPLE
```
+ For API details, see [GetHostedZone](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53/get-hosted-zone.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Returns details of the hosted zone with ID Z1D633PJN98FT9.**
```
Get-R53HostedZone -Id Z1D633PJN98FT9
```
+ For API details, see [GetHostedZone](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Returns details of the hosted zone with ID Z1D633PJN98FT9.**
```
Get-R53HostedZone -Id Z1D633PJN98FT9
```
+ For API details, see [GetHostedZone](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `ListHostedZones` with an AWS SDK or CLI
The following code examples show how to use `ListHostedZones`.
------
#### [ CLI ]
**AWS CLI**
**To list the hosted zones associated with the current AWS account**
The following `list-hosted-zones` command lists summary information about the first 100 hosted zones that are associated with the current AWS account.:
```
aws route53 list-hosted-zones
```
If you have more than 100 hosted zones, or if you want to list them in groups smaller than 100, include the `--max-items` parameter. For example, to list hosted zones one at a time, use the following command:
```
aws route53 list-hosted-zones --max-items 1
```
To view information about the next hosted zone, take the value of `NextToken` from the response to the previous command, and include it in the `--starting-token` parameter, for example:
```
aws route53 list-hosted-zones --max-items 1 --starting-token Z3M3LMPEXAMPLE
```
+ For API details, see [ListHostedZones](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53/list-hosted-zones.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Outputs all of your public and private hosted zones.**
```
Get-R53HostedZoneList
```
**Example 2: Outputs all of the hosted zones that are associated with the reusable delegation set that has the ID NZ8X2CISAMPLE**
```
Get-R53HostedZoneList -DelegationSetId NZ8X2CISAMPLE
```
+ For API details, see [ListHostedZones](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Outputs all of your public and private hosted zones.**
```
Get-R53HostedZoneList
```
**Example 2: Outputs all of the hosted zones that are associated with the reusable delegation set that has the ID NZ8X2CISAMPLE**
```
Get-R53HostedZoneList -DelegationSetId NZ8X2CISAMPLE
```
+ For API details, see [ListHostedZones](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/route53#code-examples).
```
async fn show_host_info(client: &aws_sdk_route53::Client) -> Result<(), aws_sdk_route53::Error> {
let hosted_zone_count = client.get_hosted_zone_count().send().await?;
println!(
"Number of hosted zones in region : {}",
hosted_zone_count.hosted_zone_count(),
);
let hosted_zones = client.list_hosted_zones().send().await?;
println!("Zones:");
for hz in hosted_zones.hosted_zones() {
let zone_name = hz.name();
let zone_id = hz.id();
println!(" ID : {}", zone_id);
println!(" Name : {}", zone_name);
println!();
}
Ok(())
}
```
+ For API details, see [ListHostedZones](https://docs.rs/aws-sdk-route53/latest/aws_sdk_route53/client/struct.Client.html#method.list_hosted_zones) in *AWS SDK for Rust API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `ListHostedZonesByName` with a CLI
The following code examples show how to use `ListHostedZonesByName`.
------
#### [ CLI ]
**AWS CLI**
The following command lists up to 100 hosted zones ordered by domain name:
```
aws route53 list-hosted-zones-by-name
```
Output:
```
{
"HostedZones": [
{
"ResourceRecordSetCount": 2,
"CallerReference": "test20150527-2",
"Config": {
"Comment": "test2",
"PrivateZone": false
},
"Id": "/hostedzone/Z119WBBTVP5WFX",
"Name": "2.example.com."
},
{
"ResourceRecordSetCount": 2,
"CallerReference": "test20150527-1",
"Config": {
"Comment": "test",
"PrivateZone": false
},
"Id": "/hostedzone/Z3P5QSUBK4POTI",
"Name": "www.example.com."
}
],
"IsTruncated": false,
"MaxItems": "100"
}
```
The following command lists hosted zones ordered by name, beginning with `www.example.com`:
```
aws route53 list-hosted-zones-by-name --dns-name www.example.com
```
Output:
```
{
"HostedZones": [
{
"ResourceRecordSetCount": 2,
"CallerReference": "mwunderl20150527-1",
"Config": {
"Comment": "test",
"PrivateZone": false
},
"Id": "/hostedzone/Z3P5QSUBK4POTI",
"Name": "www.example.com."
}
],
"DNSName": "www.example.com",
"IsTruncated": false,
"MaxItems": "100"
}
```
+ For API details, see [ListHostedZonesByName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53/list-hosted-zones-by-name.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Returns all of your public and private hosted zones in ASCII order by domain name.**
```
Get-R53HostedZonesByName
```
**Example 2: Returns your public and private hosted zones, in ASCII order by domain name, starting at the specified DNS name.**
```
Get-R53HostedZonesByName -DnsName example2.com
```
+ For API details, see [ListHostedZonesByName](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Returns all of your public and private hosted zones in ASCII order by domain name.**
```
Get-R53HostedZonesByName
```
**Example 2: Returns your public and private hosted zones, in ASCII order by domain name, starting at the specified DNS name.**
```
Get-R53HostedZonesByName -DnsName example2.com
```
+ For API details, see [ListHostedZonesByName](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `ListQueryLoggingConfigs` with a CLI
The following code examples show how to use `ListQueryLoggingConfigs`.
------
#### [ CLI ]
**AWS CLI**
**To list query logging configurations**
The following `list-query-logging-configs` example lists information about the first 100 query logging configurations in your AWS account, for the hosted zone `Z1OX3WQEXAMPLE`.
```
aws route53 list-query-logging-configs \
--hosted-zone-id Z1OX3WQEXAMPLE
```
Output:
```
{
"QueryLoggingConfigs": [
{
"Id": "964ff34e-ae03-4f06-80a2-9683cexample",
"HostedZoneId": "Z1OX3WQEXAMPLE",
"CloudWatchLogsLogGroupArn": "arn:aws:logs:us-east-1:111122223333:log-group:/aws/route53/example.com:*"
}
]
}
```
For more information, see [Logging DNS queries](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html) in the *Amazon Route 53 Developer Guide*.
+ For API details, see [ListQueryLoggingConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53/list-query-logging-configs.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example returns all the configurations for DNS query logging that are associated with the current AWS account.**
```
Get-R53QueryLoggingConfigList
```
**Output:**
```
Id HostedZoneId CloudWatchLogsLogGroupArn
-- ------------ -------------------------
59b0fa33-4fea-4471-a88c-926476aaa40d Z385PDS6EAAAZR arn:aws:logs:us-east-1:111111111112:log-group:/aws/route53/example1.com:*
ee528e95-4e03-4fdc-9d28-9e24ddaaa063 Z94SJHBV1AAAAZ arn:aws:logs:us-east-1:111111111112:log-group:/aws/route53/example2.com:*
e38dddda-ceb6-45c1-8cb7-f0ae56aaaa2b Z3MEQ8T7AAA1BF arn:aws:logs:us-east-1:111111111112:log-group:/aws/route53/example3.com:*
```
+ For API details, see [ListQueryLoggingConfigs](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example returns all the configurations for DNS query logging that are associated with the current AWS account.**
```
Get-R53QueryLoggingConfigList
```
**Output:**
```
Id HostedZoneId CloudWatchLogsLogGroupArn
-- ------------ -------------------------
59b0fa33-4fea-4471-a88c-926476aaa40d Z385PDS6EAAAZR arn:aws:logs:us-east-1:111111111112:log-group:/aws/route53/example1.com:*
ee528e95-4e03-4fdc-9d28-9e24ddaaa063 Z94SJHBV1AAAAZ arn:aws:logs:us-east-1:111111111112:log-group:/aws/route53/example2.com:*
e38dddda-ceb6-45c1-8cb7-f0ae56aaaa2b Z3MEQ8T7AAA1BF arn:aws:logs:us-east-1:111111111112:log-group:/aws/route53/example3.com:*
```
+ For API details, see [ListQueryLoggingConfigs](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Code examples for Route 53 domain registration using AWS SDKs
The following code examples show how to use Route 53 domain registration with an AWS software development kit (SDK).
*Basics* are code examples that show you how to perform the essential operations within a service.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
**Contents**
+ [Basics](service_code_examples_route-53-domains_basics.md)
+ [Hello Route 53 domain registration](route-53-domains_example_route-53-domains_Hello_section.md)
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
+ [Actions](service_code_examples_route-53-domains_actions.md)
+ [`CheckDomainAvailability`](route-53-domains_example_route-53-domains_CheckDomainAvailability_section.md)
+ [`CheckDomainTransferability`](route-53-domains_example_route-53-domains_CheckDomainTransferability_section.md)
+ [`GetDomainDetail`](route-53-domains_example_route-53-domains_GetDomainDetail_section.md)
+ [`GetDomainSuggestions`](route-53-domains_example_route-53-domains_GetDomainSuggestions_section.md)
+ [`GetOperationDetail`](route-53-domains_example_route-53-domains_GetOperationDetail_section.md)
+ [`ListDomains`](route-53-domains_example_route-53-domains_ListDomains_section.md)
+ [`ListOperations`](route-53-domains_example_route-53-domains_ListOperations_section.md)
+ [`ListPrices`](route-53-domains_example_route-53-domains_ListPrices_section.md)
+ [`RegisterDomain`](route-53-domains_example_route-53-domains_RegisterDomain_section.md)
+ [`ViewBilling`](route-53-domains_example_route-53-domains_ViewBilling_section.md)
# Basic examples for Route 53 domain registration using AWS SDKs
The following code examples show how to use the basics of Amazon Route 53 domain registration with AWS SDKs.
**Contents**
+ [Hello Route 53 domain registration](route-53-domains_example_route-53-domains_Hello_section.md)
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
+ [Actions](service_code_examples_route-53-domains_actions.md)
+ [`CheckDomainAvailability`](route-53-domains_example_route-53-domains_CheckDomainAvailability_section.md)
+ [`CheckDomainTransferability`](route-53-domains_example_route-53-domains_CheckDomainTransferability_section.md)
+ [`GetDomainDetail`](route-53-domains_example_route-53-domains_GetDomainDetail_section.md)
+ [`GetDomainSuggestions`](route-53-domains_example_route-53-domains_GetDomainSuggestions_section.md)
+ [`GetOperationDetail`](route-53-domains_example_route-53-domains_GetOperationDetail_section.md)
+ [`ListDomains`](route-53-domains_example_route-53-domains_ListDomains_section.md)
+ [`ListOperations`](route-53-domains_example_route-53-domains_ListOperations_section.md)
+ [`ListPrices`](route-53-domains_example_route-53-domains_ListPrices_section.md)
+ [`RegisterDomain`](route-53-domains_example_route-53-domains_RegisterDomain_section.md)
+ [`ViewBilling`](route-53-domains_example_route-53-domains_ViewBilling_section.md)
# Hello Route 53 domain registration
The following code examples show how to get started using Route 53 domain registration.
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Route53#code-examples).
```
public static class HelloRoute53Domains
{
static async Task Main(string[] args)
{
// Use the AWS .NET Core Setup package to set up dependency injection for the Amazon Route 53 domain registration service.
// Use your AWS profile name, or leave it blank to use the default profile.
using var host = Host.CreateDefaultBuilder(args)
.ConfigureServices((_, services) =>
services.AddAWSService()
).Build();
// Now the client is available for injection.
var route53Client = host.Services.GetRequiredService();
// You can use await and any of the async methods to get a response.
var response = await route53Client.ListPricesAsync(new ListPricesRequest { Tld = "com" });
Console.WriteLine($"Hello Amazon Route 53 Domains! Following are prices for .com domain operations:");
var comPrices = response.Prices.FirstOrDefault();
if (comPrices != null)
{
Console.WriteLine($"\tRegistration: {comPrices.RegistrationPrice?.Price} {comPrices.RegistrationPrice?.Currency}");
Console.WriteLine($"\tRenewal: {comPrices.RenewalPrice?.Price} {comPrices.RenewalPrice?.Currency}");
}
}
}
```
+ For API details, see [ListPrices](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/ListPrices) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53#code-examples).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.route53domains.Route53DomainsClient;
import software.amazon.awssdk.services.route53.model.Route53Exception;
import software.amazon.awssdk.services.route53domains.model.DomainPrice;
import software.amazon.awssdk.services.route53domains.model.ListPricesRequest;
import software.amazon.awssdk.services.route53domains.model.ListPricesResponse;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*
* This Java code examples performs the following operation:
*
* 1. Invokes ListPrices for at least one domain type, such as the “com” type
* and displays the prices for Registration and Renewal.
*
*/
public class HelloRoute53 {
public static final String DASHES = new String(new char[80]).replace("\0", "-");
public static void main(String[] args) {
final String usage = "\n" +
"Usage:\n" +
" \n\n" +
"Where:\n" +
" hostedZoneId - The id value of an existing hosted zone. \n";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String domainType = args[0];
Region region = Region.US_EAST_1;
Route53DomainsClient route53DomainsClient = Route53DomainsClient.builder()
.region(region)
.build();
System.out.println(DASHES);
System.out.println("Invokes ListPrices for at least one domain type.");
listPrices(route53DomainsClient, domainType);
System.out.println(DASHES);
}
public static void listPrices(Route53DomainsClient route53DomainsClient, String domainType) {
try {
ListPricesRequest pricesRequest = ListPricesRequest.builder()
.maxItems(10)
.tld(domainType)
.build();
ListPricesResponse response = route53DomainsClient.listPrices(pricesRequest);
List prices = response.prices();
for (DomainPrice pr : prices) {
System.out.println("Name: " + pr.name());
System.out.println(
"Registration: " + pr.registrationPrice().price() + " " + pr.registrationPrice().currency());
System.out.println("Renewal: " + pr.renewalPrice().price() + " " + pr.renewalPrice().currency());
System.out.println("Transfer: " + pr.transferPrice().price() + " " + pr.transferPrice().currency());
System.out.println("Transfer: " + pr.transferPrice().price() + " " + pr.transferPrice().currency());
System.out.println("Change Ownership: " + pr.changeOwnershipPrice().price() + " "
+ pr.changeOwnershipPrice().currency());
System.out.println(
"Restoration: " + pr.restorationPrice().price() + " " + pr.restorationPrice().currency());
System.out.println(" ");
}
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
}
```
+ For API details, see [ListPrices](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/ListPrices) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/route53#code-examples).
```
/**
Before running this Kotlin code example, set up your development environment,
including your credentials.
For more information, see the following documentation topic:
https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/setup.html
*/
suspend fun main(args: Array) {
val usage = """
Usage:
Where:
domainType - The domain type (for example, com).
"""
if (args.size != 1) {
println(usage)
exitProcess(0)
}
val domainType = args[0]
println("Invokes ListPrices using a Paginated method.")
listPricesPaginated(domainType)
}
suspend fun listPricesPaginated(domainType: String) {
val pricesRequest =
ListPricesRequest {
maxItems = 10
tld = domainType
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
route53DomainsClient
.listPricesPaginated(pricesRequest)
.transform { it.prices?.forEach { obj -> emit(obj) } }
.collect { pr ->
println("Registration: ${pr.registrationPrice} ${pr.registrationPrice?.currency}")
println("Renewal: ${pr.renewalPrice?.price} ${pr.renewalPrice?.currency}")
println("Transfer: ${pr.transferPrice?.price} ${pr.transferPrice?.currency}")
println("Restoration: ${pr.restorationPrice?.price} ${pr.restorationPrice?.currency}")
}
}
}
```
+ For API details, see [ListPrices](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Learn the basics of Route 53 domain registration with an AWS SDK
The following code examples show how to:
+ List current domains, and list operations in the past year.
+ View billing for the past year, and view prices for domain types.
+ Get domain suggestions.
+ Check domain availability and transferability.
+ Optionally, request a domain registration.
+ Get an operation detail.
+ Optionally, get a domain detail.
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Route53#code-examples).
Run an interactive scenario at a command prompt.
```
public static class Route53DomainScenario
{
/*
Before running this .NET code example, set up your development environment, including your credentials.
This .NET example performs the following tasks:
1. List current domains.
2. List operations in the past year.
3. View billing for the account in the past year.
4. View prices for domain types.
5. Get domain suggestions.
6. Check domain availability.
7. Check domain transferability.
8. Optionally, request a domain registration.
9. Get an operation detail.
10. Optionally, get a domain detail.
*/
private static Route53Wrapper _route53Wrapper = null!;
private static IConfiguration _configuration = null!;
static async Task Main(string[] args)
{
// Set up dependency injection for the Amazon service.
using var host = Host.CreateDefaultBuilder(args)
.ConfigureLogging(logging =>
logging.AddFilter("System", LogLevel.Debug)
.AddFilter("Microsoft", LogLevel.Information)
.AddFilter("Microsoft", LogLevel.Trace))
.ConfigureServices((_, services) =>
services.AddAWSService()
.AddTransient()
)
.Build();
_configuration = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("settings.json") // Load settings from .json file.
.AddJsonFile("settings.local.json",
true) // Optionally, load local settings.
.Build();
var logger = LoggerFactory.Create(builder =>
{
builder.AddConsole();
}).CreateLogger(typeof(Route53DomainScenario));
_route53Wrapper = host.Services.GetRequiredService();
Console.WriteLine(new string('-', 80));
Console.WriteLine("Welcome to the Amazon Route 53 domains example scenario.");
Console.WriteLine(new string('-', 80));
try
{
await ListDomains();
await ListOperations();
await ListBillingRecords();
await ListPrices();
await ListDomainSuggestions();
await CheckDomainAvailability();
await CheckDomainTransferability();
var operationId = await RequestDomainRegistration();
await GetOperationalDetail(operationId);
await GetDomainDetails();
}
catch (Exception ex)
{
logger.LogError(ex, "There was a problem executing the scenario.");
}
Console.WriteLine(new string('-', 80));
Console.WriteLine("The Amazon Route 53 domains example scenario is complete.");
Console.WriteLine(new string('-', 80));
}
///
/// List account registered domains.
///
/// Async task.
private static async Task ListDomains()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"1. List account domains.");
var domains = await _route53Wrapper.ListDomains();
for (int i = 0; i < domains.Count; i++)
{
Console.WriteLine($"\t{i + 1}. {domains[i].DomainName}");
}
if (!domains.Any())
{
Console.WriteLine("\tNo domains found in this account.");
}
Console.WriteLine(new string('-', 80));
}
///
/// List domain operations in the past year.
///
/// Async task.
private static async Task ListOperations()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"2. List account domain operations in the past year.");
var operations = await _route53Wrapper.ListOperations(
DateTime.Today.AddYears(-1));
for (int i = 0; i < operations.Count; i++)
{
Console.WriteLine($"\tOperation Id: {operations[i].OperationId}");
Console.WriteLine($"\tStatus: {operations[i].Status}");
Console.WriteLine($"\tDate: {operations[i].SubmittedDate}");
}
Console.WriteLine(new string('-', 80));
}
///
/// List billing in the past year.
///
/// Async task.
private static async Task ListBillingRecords()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"3. View billing for the account in the past year.");
var billingRecords = await _route53Wrapper.ViewBilling(
DateTime.Today.AddYears(-1),
DateTime.Today);
for (int i = 0; i < billingRecords.Count; i++)
{
Console.WriteLine($"\tBill Date: {billingRecords[i].BillDate.ToShortDateString()}");
Console.WriteLine($"\tOperation: {billingRecords[i].Operation}");
Console.WriteLine($"\tPrice: {billingRecords[i].Price}");
}
if (!billingRecords.Any())
{
Console.WriteLine("\tNo billing records found in this account for the past year.");
}
Console.WriteLine(new string('-', 80));
}
///
/// List prices for a few domain types.
///
/// Async task.
private static async Task ListPrices()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"4. View prices for domain types.");
var domainTypes = new List { "net", "com", "org", "co" };
var prices = await _route53Wrapper.ListPrices(domainTypes);
foreach (var pr in prices)
{
Console.WriteLine($"\tName: {pr.Name}");
Console.WriteLine($"\tRegistration: {pr.RegistrationPrice?.Price} {pr.RegistrationPrice?.Currency}");
Console.WriteLine($"\tRenewal: {pr.RenewalPrice?.Price} {pr.RenewalPrice?.Currency}");
Console.WriteLine($"\tTransfer: {pr.TransferPrice?.Price} {pr.TransferPrice?.Currency}");
Console.WriteLine($"\tChange Ownership: {pr.ChangeOwnershipPrice?.Price} {pr.ChangeOwnershipPrice?.Currency}");
Console.WriteLine($"\tRestoration: {pr.RestorationPrice?.Price} {pr.RestorationPrice?.Currency}");
Console.WriteLine();
}
Console.WriteLine(new string('-', 80));
}
///
/// List domain suggestions for a domain name.
///
/// Async task.
private static async Task ListDomainSuggestions()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"5. Get domain suggestions.");
string? domainName = null;
while (domainName == null || string.IsNullOrWhiteSpace(domainName))
{
Console.WriteLine($"Enter a domain name to get available domain suggestions.");
domainName = Console.ReadLine();
}
var suggestions = await _route53Wrapper.GetDomainSuggestions(domainName, true, 5);
foreach (var suggestion in suggestions)
{
Console.WriteLine($"\tSuggestion Name: {suggestion.DomainName}");
Console.WriteLine($"\tAvailability: {suggestion.Availability}");
}
Console.WriteLine(new string('-', 80));
}
///
/// Check availability for a domain name.
///
/// Async task.
private static async Task CheckDomainAvailability()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"6. Check domain availability.");
string? domainName = null;
while (domainName == null || string.IsNullOrWhiteSpace(domainName))
{
Console.WriteLine($"Enter a domain name to check domain availability.");
domainName = Console.ReadLine();
}
var availability = await _route53Wrapper.CheckDomainAvailability(domainName);
Console.WriteLine($"\tAvailability: {availability}");
Console.WriteLine(new string('-', 80));
}
///
/// Check transferability for a domain name.
///
/// Async task.
private static async Task CheckDomainTransferability()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"7. Check domain transferability.");
string? domainName = null;
while (domainName == null || string.IsNullOrWhiteSpace(domainName))
{
Console.WriteLine($"Enter a domain name to check domain transferability.");
domainName = Console.ReadLine();
}
var transferability = await _route53Wrapper.CheckDomainTransferability(domainName);
Console.WriteLine($"\tTransferability: {transferability}");
Console.WriteLine(new string('-', 80));
}
///
/// Check transferability for a domain name.
///
/// Async task.
private static async Task RequestDomainRegistration()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"8. Optionally, request a domain registration.");
Console.WriteLine($"\tNote: This example uses domain request settings in settings.json.");
Console.WriteLine($"\tTo change the domain registration settings, set the values in that file.");
Console.WriteLine($"\tRemember, registering an actual domain will incur an account billing cost.");
Console.WriteLine($"\tWould you like to begin a domain registration? (y/n)");
var ynResponse = Console.ReadLine();
if (ynResponse != null && ynResponse.Equals("y", StringComparison.InvariantCultureIgnoreCase))
{
string domainName = _configuration["DomainName"];
ContactDetail contact = new ContactDetail();
contact.CountryCode = CountryCode.FindValue(_configuration["Contact:CountryCode"]);
contact.ContactType = ContactType.FindValue(_configuration["Contact:ContactType"]);
_configuration.GetSection("Contact").Bind(contact);
var operationId = await _route53Wrapper.RegisterDomain(
domainName,
Convert.ToBoolean(_configuration["AutoRenew"]),
Convert.ToInt32(_configuration["DurationInYears"]),
contact);
if (operationId != null)
{
Console.WriteLine(
$"\tRegistration requested. Operation Id: {operationId}");
}
return operationId;
}
Console.WriteLine(new string('-', 80));
return null;
}
///
/// Get details for an operation.
///
/// Async task.
private static async Task GetOperationalDetail(string? operationId)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"9. Get an operation detail.");
var operationDetails =
await _route53Wrapper.GetOperationDetail(operationId);
Console.WriteLine(operationDetails);
Console.WriteLine(new string('-', 80));
}
///
/// Optionally, get details for a registered domain.
///
/// Async task.
private static async Task GetDomainDetails()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"10. Get details on a domain.");
Console.WriteLine($"\tNote: you must have a registered domain to get details.");
Console.WriteLine($"\tWould you like to get domain details? (y/n)");
var ynResponse = Console.ReadLine();
if (ynResponse != null && ynResponse.Equals("y", StringComparison.InvariantCultureIgnoreCase))
{
string? domainName = null;
while (domainName == null)
{
Console.WriteLine($"\tEnter a domain name to get details.");
domainName = Console.ReadLine();
}
var domainDetails = await _route53Wrapper.GetDomainDetail(domainName);
Console.WriteLine(domainDetails);
}
Console.WriteLine(new string('-', 80));
return null;
}
}
```
Wrapper methods used by the scenario for Route 53 domain registration actions.
```
public class Route53Wrapper
{
private readonly IAmazonRoute53Domains _amazonRoute53Domains;
private readonly ILogger _logger;
public Route53Wrapper(IAmazonRoute53Domains amazonRoute53Domains, ILogger logger)
{
_amazonRoute53Domains = amazonRoute53Domains;
_logger = logger;
}
///
/// List prices for domain type operations.
///
/// Domain types to include in the results.
/// The list of domain prices.
public async Task> ListPrices(List domainTypes)
{
var results = new List();
var paginatePrices = _amazonRoute53Domains.Paginators.ListPrices(new ListPricesRequest());
// Get the entire list using the paginator.
await foreach (var prices in paginatePrices.Prices)
{
results.Add(prices);
}
return results.Where(p => domainTypes.Contains(p.Name)).ToList();
}
///
/// Check the availability of a domain name.
///
/// The domain to check for availability.
/// An availability result string.
public async Task CheckDomainAvailability(string domain)
{
var result = await _amazonRoute53Domains.CheckDomainAvailabilityAsync(
new CheckDomainAvailabilityRequest
{
DomainName = domain
}
);
return result.Availability.Value;
}
///
/// Check the transferability of a domain name.
///
/// The domain to check for transferability.
/// A transferability result string.
public async Task CheckDomainTransferability(string domain)
{
var result = await _amazonRoute53Domains.CheckDomainTransferabilityAsync(
new CheckDomainTransferabilityRequest
{
DomainName = domain
}
);
return result.Transferability.Transferable.Value;
}
///
/// Get a list of suggestions for a given domain.
///
/// The domain to check for suggestions.
/// If true, only returns available domains.
/// The number of suggestions to return. Defaults to the max of 50.
/// A collection of domain suggestions.
public async Task> GetDomainSuggestions(string domain, bool onlyAvailable, int suggestionCount = 50)
{
var result = await _amazonRoute53Domains.GetDomainSuggestionsAsync(
new GetDomainSuggestionsRequest
{
DomainName = domain,
OnlyAvailable = onlyAvailable,
SuggestionCount = suggestionCount
}
);
return result.SuggestionsList;
}
///
/// Get details for a domain action operation.
///
/// The operational Id.
/// A string describing the operational details.
public async Task GetOperationDetail(string? operationId)
{
if (operationId == null)
return "Unable to get operational details because ID is null.";
try
{
var operationDetails =
await _amazonRoute53Domains.GetOperationDetailAsync(
new GetOperationDetailRequest
{
OperationId = operationId
}
);
var details = $"\tOperation {operationId}:\n" +
$"\tFor domain {operationDetails.DomainName} on {operationDetails.SubmittedDate.ToShortDateString()}.\n" +
$"\tMessage is {operationDetails.Message}.\n" +
$"\tStatus is {operationDetails.Status}.\n";
return details;
}
catch (AmazonRoute53DomainsException ex)
{
return $"Unable to get operation details. Here's why: {ex.Message}.";
}
}
///
/// Initiate a domain registration request.
///
/// Contact details.
/// The domain name to register.
/// True if the domain should automatically renew.
/// The duration in years for the domain registration.
/// The operation Id.
public async Task RegisterDomain(string domainName, bool autoRenew, int duration, ContactDetail contact)
{
// This example uses the same contact information for admin, registrant, and tech contacts.
try
{
var result = await _amazonRoute53Domains.RegisterDomainAsync(
new RegisterDomainRequest()
{
AdminContact = contact,
RegistrantContact = contact,
TechContact = contact,
DomainName = domainName,
AutoRenew = autoRenew,
DurationInYears = duration,
PrivacyProtectAdminContact = false,
PrivacyProtectRegistrantContact = false,
PrivacyProtectTechContact = false
}
);
return result.OperationId;
}
catch (InvalidInputException)
{
_logger.LogInformation($"Unable to request registration for domain {domainName}");
return null;
}
}
///
/// View billing records for the account between a start and end date.
///
/// The start date for billing results.
/// The end date for billing results.
/// A collection of billing records.
public async Task> ViewBilling(DateTime startDate, DateTime endDate)
{
var results = new List();
var paginateBilling = _amazonRoute53Domains.Paginators.ViewBilling(
new ViewBillingRequest()
{
Start = startDate,
End = endDate
});
// Get the entire list using the paginator.
await foreach (var billingRecords in paginateBilling.BillingRecords)
{
results.Add(billingRecords);
}
return results;
}
///
/// List the domains for the account.
///
/// A collection of domain summary records.
public async Task> ListDomains()
{
var results = new List();
var paginateDomains = _amazonRoute53Domains.Paginators.ListDomains(
new ListDomainsRequest());
// Get the entire list using the paginator.
await foreach (var domain in paginateDomains.Domains)
{
results.Add(domain);
}
return results;
}
///
/// List operations for the account that are submitted after a specified date.
///
/// A collection of operation summary records.
public async Task> ListOperations(DateTime submittedSince)
{
var results = new List();
var paginateOperations = _amazonRoute53Domains.Paginators.ListOperations(
new ListOperationsRequest()
{
SubmittedSince = submittedSince
});
// Get the entire list using the paginator.
await foreach (var operations in paginateOperations.Operations)
{
results.Add(operations);
}
return results;
}
///
/// Get details for a domain.
///
/// A string with detail information about the domain.
public async Task GetDomainDetail(string domainName)
{
try
{
var result = await _amazonRoute53Domains.GetDomainDetailAsync(
new GetDomainDetailRequest()
{
DomainName = domainName
});
var details = $"\tDomain {domainName}:\n" +
$"\tCreated on {result.CreationDate.ToShortDateString()}.\n" +
$"\tAdmin contact is {result.AdminContact.Email}.\n" +
$"\tAuto-renew is {result.AutoRenew}.\n";
return details;
}
catch (InvalidInputException)
{
return $"Domain {domainName} was not found in your account.";
}
}
}
```
+ For API details, see the following topics in *AWS SDK for .NET API Reference*.
+ [CheckDomainAvailability](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/CheckDomainAvailability)
+ [CheckDomainTransferability](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/CheckDomainTransferability)
+ [GetDomainDetail](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/GetDomainDetail)
+ [GetDomainSuggestions](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/GetDomainSuggestions)
+ [GetOperationDetail](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/GetOperationDetail)
+ [ListDomains](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/ListDomains)
+ [ListOperations](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/ListOperations)
+ [ListPrices](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/ListPrices)
+ [RegisterDomain](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/RegisterDomain)
+ [ViewBilling](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/ViewBilling)
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53#code-examples).
```
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*
* This example uses pagination methods where applicable. For example, to list
* domains, the
* listDomainsPaginator method is used. For more information about pagination,
* see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/pagination.html
*
* This Java code example performs the following operations:
*
* 1. List current domains.
* 2. List operations in the past year.
* 3. View billing for the account in the past year.
* 4. View prices for domain types.
* 5. Get domain suggestions.
* 6. Check domain availability.
* 7. Check domain transferability.
* 8. Request a domain registration.
* 9. Get operation details.
* 10. Optionally, get domain details.
*/
public class Route53Scenario {
public static final String DASHES = new String(new char[80]).replace("\0", "-");
public static void main(String[] args) {
final String usage = """
Usage:
Where:
domainType - The domain type (for example, com).\s
phoneNumber - The phone number to use (for example, +91.9966564xxx) email - The email address to use. domainSuggestion - The domain suggestion (for example, findmy.accountants).\s
firstName - The first name to use to register a domain.\s
lastName - The last name to use to register a domain.\s
city - the city to use to register a domain.\s
""";
if (args.length != 7) {
System.out.println(usage);
System.exit(1);
}
String domainType = args[0];
String phoneNumber = args[1];
String email = args[2];
String domainSuggestion = args[3];
String firstName = args[4];
String lastName = args[5];
String city = args[6];
Region region = Region.US_EAST_1;
Route53DomainsClient route53DomainsClient = Route53DomainsClient.builder()
.region(region)
.build();
System.out.println(DASHES);
System.out.println("Welcome to the Amazon Route 53 domains example scenario.");
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("1. List current domains.");
listDomains(route53DomainsClient);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("2. List operations in the past year.");
listOperations(route53DomainsClient);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("3. View billing for the account in the past year.");
listBillingRecords(route53DomainsClient);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("4. View prices for domain types.");
listPrices(route53DomainsClient, domainType);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("5. Get domain suggestions.");
listDomainSuggestions(route53DomainsClient, domainSuggestion);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("6. Check domain availability.");
checkDomainAvailability(route53DomainsClient, domainSuggestion);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("7. Check domain transferability.");
checkDomainTransferability(route53DomainsClient, domainSuggestion);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("8. Request a domain registration.");
String opId = requestDomainRegistration(route53DomainsClient, domainSuggestion, phoneNumber, email, firstName,
lastName, city);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("9. Get operation details.");
getOperationalDetail(route53DomainsClient, opId);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("10. Get domain details.");
System.out.println("Note: You must have a registered domain to get details.");
System.out.println("Otherwise, an exception is thrown that states ");
System.out.println("Domain xxxxxxx not found in xxxxxxx account.");
getDomainDetails(route53DomainsClient, domainSuggestion);
System.out.println(DASHES);
}
public static void getDomainDetails(Route53DomainsClient route53DomainsClient, String domainSuggestion) {
try {
GetDomainDetailRequest detailRequest = GetDomainDetailRequest.builder()
.domainName(domainSuggestion)
.build();
GetDomainDetailResponse response = route53DomainsClient.getDomainDetail(detailRequest);
System.out.println("The contact first name is " + response.registrantContact().firstName());
System.out.println("The contact last name is " + response.registrantContact().lastName());
System.out.println("The contact org name is " + response.registrantContact().organizationName());
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
public static void getOperationalDetail(Route53DomainsClient route53DomainsClient, String operationId) {
try {
GetOperationDetailRequest detailRequest = GetOperationDetailRequest.builder()
.operationId(operationId)
.build();
GetOperationDetailResponse response = route53DomainsClient.getOperationDetail(detailRequest);
System.out.println("Operation detail message is " + response.message());
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
public static String requestDomainRegistration(Route53DomainsClient route53DomainsClient,
String domainSuggestion,
String phoneNumber,
String email,
String firstName,
String lastName,
String city) {
try {
ContactDetail contactDetail = ContactDetail.builder()
.contactType(ContactType.COMPANY)
.state("LA")
.countryCode(CountryCode.IN)
.email(email)
.firstName(firstName)
.lastName(lastName)
.city(city)
.phoneNumber(phoneNumber)
.organizationName("My Org")
.addressLine1("My Address")
.zipCode("123 123")
.build();
RegisterDomainRequest domainRequest = RegisterDomainRequest.builder()
.adminContact(contactDetail)
.registrantContact(contactDetail)
.techContact(contactDetail)
.domainName(domainSuggestion)
.autoRenew(true)
.durationInYears(1)
.build();
RegisterDomainResponse response = route53DomainsClient.registerDomain(domainRequest);
System.out.println("Registration requested. Operation Id: " + response.operationId());
return response.operationId();
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
return "";
}
public static void checkDomainTransferability(Route53DomainsClient route53DomainsClient, String domainSuggestion) {
try {
CheckDomainTransferabilityRequest transferabilityRequest = CheckDomainTransferabilityRequest.builder()
.domainName(domainSuggestion)
.build();
CheckDomainTransferabilityResponse response = route53DomainsClient
.checkDomainTransferability(transferabilityRequest);
System.out.println("Transferability: " + response.transferability().transferable().toString());
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
public static void checkDomainAvailability(Route53DomainsClient route53DomainsClient, String domainSuggestion) {
try {
CheckDomainAvailabilityRequest availabilityRequest = CheckDomainAvailabilityRequest.builder()
.domainName(domainSuggestion)
.build();
CheckDomainAvailabilityResponse response = route53DomainsClient
.checkDomainAvailability(availabilityRequest);
System.out.println(domainSuggestion + " is " + response.availability().toString());
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
public static void listDomainSuggestions(Route53DomainsClient route53DomainsClient, String domainSuggestion) {
try {
GetDomainSuggestionsRequest suggestionsRequest = GetDomainSuggestionsRequest.builder()
.domainName(domainSuggestion)
.suggestionCount(5)
.onlyAvailable(true)
.build();
GetDomainSuggestionsResponse response = route53DomainsClient.getDomainSuggestions(suggestionsRequest);
List suggestions = response.suggestionsList();
for (DomainSuggestion suggestion : suggestions) {
System.out.println("Suggestion Name: " + suggestion.domainName());
System.out.println("Availability: " + suggestion.availability());
System.out.println(" ");
}
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
public static void listPrices(Route53DomainsClient route53DomainsClient, String domainType) {
try {
ListPricesRequest pricesRequest = ListPricesRequest.builder()
.tld(domainType)
.build();
ListPricesIterable listRes = route53DomainsClient.listPricesPaginator(pricesRequest);
listRes.stream()
.flatMap(r -> r.prices().stream())
.forEach(content -> System.out.println(" Name: " + content.name() +
" Registration: " + content.registrationPrice().price() + " "
+ content.registrationPrice().currency() +
" Renewal: " + content.renewalPrice().price() + " " + content.renewalPrice().currency()));
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
public static void listBillingRecords(Route53DomainsClient route53DomainsClient) {
try {
Date currentDate = new Date();
LocalDateTime localDateTime = currentDate.toInstant().atZone(ZoneId.systemDefault()).toLocalDateTime();
ZoneOffset zoneOffset = ZoneOffset.of("+01:00");
LocalDateTime localDateTime2 = localDateTime.minusYears(1);
Instant myStartTime = localDateTime2.toInstant(zoneOffset);
Instant myEndTime = localDateTime.toInstant(zoneOffset);
ViewBillingRequest viewBillingRequest = ViewBillingRequest.builder()
.start(myStartTime)
.end(myEndTime)
.build();
ViewBillingIterable listRes = route53DomainsClient.viewBillingPaginator(viewBillingRequest);
listRes.stream()
.flatMap(r -> r.billingRecords().stream())
.forEach(content -> System.out.println(" Bill Date:: " + content.billDate() +
" Operation: " + content.operationAsString() +
" Price: " + content.price()));
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
public static void listOperations(Route53DomainsClient route53DomainsClient) {
try {
Date currentDate = new Date();
LocalDateTime localDateTime = currentDate.toInstant().atZone(ZoneId.systemDefault()).toLocalDateTime();
ZoneOffset zoneOffset = ZoneOffset.of("+01:00");
localDateTime = localDateTime.minusYears(1);
Instant myTime = localDateTime.toInstant(zoneOffset);
ListOperationsRequest operationsRequest = ListOperationsRequest.builder()
.submittedSince(myTime)
.build();
ListOperationsIterable listRes = route53DomainsClient.listOperationsPaginator(operationsRequest);
listRes.stream()
.flatMap(r -> r.operations().stream())
.forEach(content -> System.out.println(" Operation Id: " + content.operationId() +
" Status: " + content.statusAsString() +
" Date: " + content.submittedDate()));
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
public static void listDomains(Route53DomainsClient route53DomainsClient) {
try {
ListDomainsIterable listRes = route53DomainsClient.listDomainsPaginator();
listRes.stream()
.flatMap(r -> r.domains().stream())
.forEach(content -> System.out.println("The domain name is " + content.domainName()));
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
}
```
+ For API details, see the following topics in *AWS SDK for Java 2.x API Reference*.
+ [CheckDomainAvailability](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/CheckDomainAvailability)
+ [CheckDomainTransferability](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/CheckDomainTransferability)
+ [GetDomainDetail](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/GetDomainDetail)
+ [GetDomainSuggestions](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/GetDomainSuggestions)
+ [GetOperationDetail](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/GetOperationDetail)
+ [ListDomains](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/ListDomains)
+ [ListOperations](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/ListOperations)
+ [ListPrices](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/ListPrices)
+ [RegisterDomain](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/RegisterDomain)
+ [ViewBilling](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/ViewBilling)
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/route53#code-examples).
```
/**
Before running this Kotlin code example, set up your development environment,
including your credentials.
For more information, see the following documentation topic:
https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/setup.html
This Kotlin code example performs the following operations:
1. List current domains.
2. List operations in the past year.
3. View billing for the account in the past year.
4. View prices for domain types.
5. Get domain suggestions.
6. Check domain availability.
7. Check domain transferability.
8. Request a domain registration.
9. Get operation details.
10. Optionally, get domain details.
*/
val DASHES: String = String(CharArray(80)).replace("\u0000", "-")
suspend fun main(args: Array) {
val usage = """
Usage:
Where:
domainType - The domain type (for example, com).
phoneNumber - The phone number to use (for example, +1.2065550100)
email - The email address to use.
domainSuggestion - The domain suggestion (for example, findmy.example).
firstName - The first name to use to register a domain.
lastName - The last name to use to register a domain.
city - The city to use to register a domain.
"""
if (args.size != 7) {
println(usage)
exitProcess(1)
}
val domainType = args[0]
val phoneNumber = args[1]
val email = args[2]
val domainSuggestion = args[3]
val firstName = args[4]
val lastName = args[5]
val city = args[6]
println(DASHES)
println("Welcome to the Amazon Route 53 domains example scenario.")
println(DASHES)
println(DASHES)
println("1. List current domains.")
listDomains()
println(DASHES)
println(DASHES)
println("2. List operations in the past year.")
listOperations()
println(DASHES)
println(DASHES)
println("3. View billing for the account in the past year.")
listBillingRecords()
println(DASHES)
println(DASHES)
println("4. View prices for domain types.")
listAllPrices(domainType)
println(DASHES)
println(DASHES)
println("5. Get domain suggestions.")
listDomainSuggestions(domainSuggestion)
println(DASHES)
println(DASHES)
println("6. Check domain availability.")
checkDomainAvailability(domainSuggestion)
println(DASHES)
println(DASHES)
println("7. Check domain transferability.")
checkDomainTransferability(domainSuggestion)
println(DASHES)
println(DASHES)
println("8. Request a domain registration.")
val opId = requestDomainRegistration(domainSuggestion, phoneNumber, email, firstName, lastName, city)
println(DASHES)
println(DASHES)
println("9. Get operation details.")
getOperationalDetail(opId)
println(DASHES)
println(DASHES)
println("10. Get domain details.")
println("Note: You must have a registered domain to get details.")
println("Otherwise an exception is thrown that states ")
println("Domain xxxxxxx not found in xxxxxxx account.")
getDomainDetails(domainSuggestion)
println(DASHES)
}
suspend fun getDomainDetails(domainSuggestion: String?) {
val detailRequest =
GetDomainDetailRequest {
domainName = domainSuggestion
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
val response = route53DomainsClient.getDomainDetail(detailRequest)
println("The contact first name is ${response.registrantContact?.firstName}")
println("The contact last name is ${response.registrantContact?.lastName}")
println("The contact org name is ${response.registrantContact?.organizationName}")
}
}
suspend fun getOperationalDetail(opId: String?) {
val detailRequest =
GetOperationDetailRequest {
operationId = opId
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
val response = route53DomainsClient.getOperationDetail(detailRequest)
println("Operation detail message is ${response.message}")
}
}
suspend fun requestDomainRegistration(
domainSuggestion: String?,
phoneNumberVal: String?,
emailVal: String?,
firstNameVal: String?,
lastNameVal: String?,
cityVal: String?,
): String? {
val contactDetail =
ContactDetail {
contactType = ContactType.Company
state = "LA"
countryCode = CountryCode.In
email = emailVal
firstName = firstNameVal
lastName = lastNameVal
city = cityVal
phoneNumber = phoneNumberVal
organizationName = "My Org"
addressLine1 = "My Address"
zipCode = "123 123"
}
val domainRequest =
RegisterDomainRequest {
adminContact = contactDetail
registrantContact = contactDetail
techContact = contactDetail
domainName = domainSuggestion
autoRenew = true
durationInYears = 1
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
val response = route53DomainsClient.registerDomain(domainRequest)
println("Registration requested. Operation Id: ${response.operationId}")
return response.operationId
}
}
suspend fun checkDomainTransferability(domainSuggestion: String?) {
val transferabilityRequest =
CheckDomainTransferabilityRequest {
domainName = domainSuggestion
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
val response = route53DomainsClient.checkDomainTransferability(transferabilityRequest)
println("Transferability: ${response.transferability?.transferable}")
}
}
suspend fun checkDomainAvailability(domainSuggestion: String) {
val availabilityRequest =
CheckDomainAvailabilityRequest {
domainName = domainSuggestion
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
val response = route53DomainsClient.checkDomainAvailability(availabilityRequest)
println("$domainSuggestion is ${response.availability}")
}
}
suspend fun listDomainSuggestions(domainSuggestion: String?) {
val suggestionsRequest =
GetDomainSuggestionsRequest {
domainName = domainSuggestion
suggestionCount = 5
onlyAvailable = true
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
val response = route53DomainsClient.getDomainSuggestions(suggestionsRequest)
response.suggestionsList?.forEach { suggestion ->
println("Suggestion Name: ${suggestion.domainName}")
println("Availability: ${suggestion.availability}")
println(" ")
}
}
}
suspend fun listAllPrices(domainType: String?) {
val pricesRequest =
ListPricesRequest {
tld = domainType
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
route53DomainsClient
.listPricesPaginated(pricesRequest)
.transform { it.prices?.forEach { obj -> emit(obj) } }
.collect { pr ->
println("Registration: ${pr.registrationPrice} ${pr.registrationPrice?.currency}")
println("Renewal: ${pr.renewalPrice?.price} ${pr.renewalPrice?.currency}")
println("Transfer: ${pr.transferPrice?.price} ${pr.transferPrice?.currency}")
println("Restoration: ${pr.restorationPrice?.price} ${pr.restorationPrice?.currency}")
}
}
}
suspend fun listBillingRecords() {
val currentDate = Date()
val localDateTime = currentDate.toInstant().atZone(ZoneId.systemDefault()).toLocalDateTime()
val zoneOffset = ZoneOffset.of("+01:00")
val localDateTime2 = localDateTime.minusYears(1)
val myStartTime = localDateTime2.toInstant(zoneOffset)
val myEndTime = localDateTime.toInstant(zoneOffset)
val timeStart: Instant? = myStartTime?.let { Instant(it) }
val timeEnd: Instant? = myEndTime?.let { Instant(it) }
val viewBillingRequest =
ViewBillingRequest {
start = timeStart
end = timeEnd
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
route53DomainsClient
.viewBillingPaginated(viewBillingRequest)
.transform { it.billingRecords?.forEach { obj -> emit(obj) } }
.collect { billing ->
println("Bill Date: ${billing.billDate}")
println("Operation: ${billing.operation}")
println("Price: ${billing.price}")
}
}
}
suspend fun listOperations() {
val currentDate = Date()
var localDateTime = currentDate.toInstant().atZone(ZoneId.systemDefault()).toLocalDateTime()
val zoneOffset = ZoneOffset.of("+01:00")
localDateTime = localDateTime.minusYears(1)
val myTime: java.time.Instant? = localDateTime.toInstant(zoneOffset)
val time2: Instant? = myTime?.let { Instant(it) }
val operationsRequest =
ListOperationsRequest {
submittedSince = time2
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
route53DomainsClient
.listOperationsPaginated(operationsRequest)
.transform { it.operations?.forEach { obj -> emit(obj) } }
.collect { content ->
println("Operation Id: ${content.operationId}")
println("Status: ${content.status}")
println("Date: ${content.submittedDate}")
}
}
}
suspend fun listDomains() {
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
route53DomainsClient
.listDomainsPaginated(ListDomainsRequest {})
.transform { it.domains?.forEach { obj -> emit(obj) } }
.collect { content ->
println("The domain name is ${content.domainName}")
}
}
}
```
+ For API details, see the following topics in *AWS SDK for Kotlin API reference*.
+ [CheckDomainAvailability](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [CheckDomainTransferability](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [GetDomainDetail](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [GetDomainSuggestions](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [GetOperationDetail](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ListDomains](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ListOperations](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ListPrices](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [RegisterDomain](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ViewBilling](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Actions for Route 53 domain registration using AWS SDKs
The following code examples demonstrate how to perform individual Route 53 domain registration actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
The following examples include only the most commonly used actions. For a complete list, see the [Amazon Route 53 domain registration API Reference](https://docs.aws.amazon.com/Route53/latest/APIReference/API_Operations_Amazon_Route_53_Domains.html).
**Topics**
+ [`CheckDomainAvailability`](route-53-domains_example_route-53-domains_CheckDomainAvailability_section.md)
+ [`CheckDomainTransferability`](route-53-domains_example_route-53-domains_CheckDomainTransferability_section.md)
+ [`GetDomainDetail`](route-53-domains_example_route-53-domains_GetDomainDetail_section.md)
+ [`GetDomainSuggestions`](route-53-domains_example_route-53-domains_GetDomainSuggestions_section.md)
+ [`GetOperationDetail`](route-53-domains_example_route-53-domains_GetOperationDetail_section.md)
+ [`ListDomains`](route-53-domains_example_route-53-domains_ListDomains_section.md)
+ [`ListOperations`](route-53-domains_example_route-53-domains_ListOperations_section.md)
+ [`ListPrices`](route-53-domains_example_route-53-domains_ListPrices_section.md)
+ [`RegisterDomain`](route-53-domains_example_route-53-domains_RegisterDomain_section.md)
+ [`ViewBilling`](route-53-domains_example_route-53-domains_ViewBilling_section.md)
# Use `CheckDomainAvailability` with an AWS SDK or CLI
The following code examples show how to use `CheckDomainAvailability`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Route53#code-examples).
```
///
/// Check the availability of a domain name.
///
/// The domain to check for availability.
/// An availability result string.
public async Task CheckDomainAvailability(string domain)
{
var result = await _amazonRoute53Domains.CheckDomainAvailabilityAsync(
new CheckDomainAvailabilityRequest
{
DomainName = domain
}
);
return result.Availability.Value;
}
```
+ For API details, see [CheckDomainAvailability](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/CheckDomainAvailability) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To determine whether you can register a domain name with Route 53**
The following `check-domain-availability` command returns information about whether the domain name `example.com` is available to be registered using Route 53.
This command runs only in the `us-east-1` Region. If your default region is set to `us-east-1`, you can omit the `region` parameter.
```
aws route53domains check-domain-availability \
--region us-east-1 \
--domain-name example.com
```
Output:
```
{
"Availability": "UNAVAILABLE"
}
```
Route 53 supports a large number of top-level domains (TLDs), such as `.com` and `.jp`, but we don't support all available TLDs. If you check the availability of a domain and Route 53 doesn't support the TLD, `check-domain-availability` returns the following message.
```
An error occurred (UnsupportedTLD) when calling the CheckDomainAvailability operation: tld is not supported.
```
For a list of the TLDs that you can use when registering a domain with Route 53, see [Domains That You Can Register with Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) in the *Amazon Route 53 Developer Guide*. For more information about registering domains with Amazon Route 53, see [Registering a New Domain](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-register.html) in the *Amazon Route 53 Developer Guide*.
+ For API details, see [CheckDomainAvailability](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/check-domain-availability.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53#code-examples).
```
public static void checkDomainAvailability(Route53DomainsClient route53DomainsClient, String domainSuggestion) {
try {
CheckDomainAvailabilityRequest availabilityRequest = CheckDomainAvailabilityRequest.builder()
.domainName(domainSuggestion)
.build();
CheckDomainAvailabilityResponse response = route53DomainsClient
.checkDomainAvailability(availabilityRequest);
System.out.println(domainSuggestion + " is " + response.availability().toString());
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
```
+ For API details, see [CheckDomainAvailability](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/CheckDomainAvailability) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/route53#code-examples).
```
suspend fun checkDomainAvailability(domainSuggestion: String) {
val availabilityRequest =
CheckDomainAvailabilityRequest {
domainName = domainSuggestion
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
val response = route53DomainsClient.checkDomainAvailability(availabilityRequest)
println("$domainSuggestion is ${response.availability}")
}
}
```
+ For API details, see [CheckDomainAvailability](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `CheckDomainTransferability` with an AWS SDK or CLI
The following code examples show how to use `CheckDomainTransferability`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Route53#code-examples).
```
///
/// Check the transferability of a domain name.
///
/// The domain to check for transferability.
/// A transferability result string.
public async Task CheckDomainTransferability(string domain)
{
var result = await _amazonRoute53Domains.CheckDomainTransferabilityAsync(
new CheckDomainTransferabilityRequest
{
DomainName = domain
}
);
return result.Transferability.Transferable.Value;
}
```
+ For API details, see [CheckDomainTransferability](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/CheckDomainTransferability) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To determine whether a domain can be transferred to Route 53**
The following `check-domain-transferability` command returns information about whether you can transfer the domain name `example.com` to Route 53.
This command runs only in the `us-east-1` Region. If your default region is set to `us-east-1`, you can omit the `region` parameter.
```
aws route53domains check-domain-transferability \
--region us-east-1 \
--domain-name example.com
```
Output:
```
{
"Transferability": {
"Transferable": "UNTRANSFERABLE"
}
}
```
For more information, see [Transferring Registration for a Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html) in the *Amazon Route 53 Developer Guide*.
+ For API details, see [CheckDomainTransferability](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/check-domain-transferability.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53#code-examples).
```
public static void checkDomainTransferability(Route53DomainsClient route53DomainsClient, String domainSuggestion) {
try {
CheckDomainTransferabilityRequest transferabilityRequest = CheckDomainTransferabilityRequest.builder()
.domainName(domainSuggestion)
.build();
CheckDomainTransferabilityResponse response = route53DomainsClient
.checkDomainTransferability(transferabilityRequest);
System.out.println("Transferability: " + response.transferability().transferable().toString());
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
```
+ For API details, see [CheckDomainTransferability](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/CheckDomainTransferability) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/route53#code-examples).
```
suspend fun checkDomainTransferability(domainSuggestion: String?) {
val transferabilityRequest =
CheckDomainTransferabilityRequest {
domainName = domainSuggestion
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
val response = route53DomainsClient.checkDomainTransferability(transferabilityRequest)
println("Transferability: ${response.transferability?.transferable}")
}
}
```
+ For API details, see [CheckDomainTransferability](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `GetDomainDetail` with an AWS SDK or CLI
The following code examples show how to use `GetDomainDetail`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Route53#code-examples).
```
///
/// Get details for a domain.
///
/// A string with detail information about the domain.
public async Task GetDomainDetail(string domainName)
{
try
{
var result = await _amazonRoute53Domains.GetDomainDetailAsync(
new GetDomainDetailRequest()
{
DomainName = domainName
});
var details = $"\tDomain {domainName}:\n" +
$"\tCreated on {result.CreationDate.ToShortDateString()}.\n" +
$"\tAdmin contact is {result.AdminContact.Email}.\n" +
$"\tAuto-renew is {result.AutoRenew}.\n";
return details;
}
catch (InvalidInputException)
{
return $"Domain {domainName} was not found in your account.";
}
}
```
+ For API details, see [GetDomainDetail](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/GetDomainDetail) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To get detailed information about a specified domain**
The following `get-domain-detail` command displays detailed information about the specified domain.
This command runs only in the `us-east-1` Region. If your default region is set to `us-east-1`, you can omit the `region` parameter.
```
aws route53domains get-domain-detail \
--region us-east-1 \
--domain-name example.com
```
Output:
```
{
"DomainName": "example.com",
"Nameservers": [
{
"Name": "ns-2048.awsdns-64.com",
"GlueIps": []
},
{
"Name": "ns-2049.awsdns-65.net",
"GlueIps": []
},
{
"Name": "ns-2050.awsdns-66.org",
"GlueIps": []
},
{
"Name": "ns-2051.awsdns-67.co.uk",
"GlueIps": []
}
],
"AutoRenew": true,
"AdminContact": {
"FirstName": "Saanvi",
"LastName": "Sarkar",
"ContactType": "COMPANY",
"OrganizationName": "Example",
"AddressLine1": "123 Main Street",
"City": "Anytown",
"State": "WA",
"CountryCode": "US",
"ZipCode": "98101",
"PhoneNumber": "+1.8005551212",
"Email": "ssarkar@example.com",
"ExtraParams": []
},
"RegistrantContact": {
"FirstName": "Alejandro",
"LastName": "Rosalez",
"ContactType": "COMPANY",
"OrganizationName": "Example",
"AddressLine1": "123 Main Street",
"City": "Anytown",
"State": "WA",
"CountryCode": "US",
"ZipCode": "98101",
"PhoneNumber": "+1.8005551212",
"Email": "arosalez@example.com",
"ExtraParams": []
},
"TechContact": {
"FirstName": "Wang",
"LastName": "Xiulan",
"ContactType": "COMPANY",
"OrganizationName": "Example",
"AddressLine1": "123 Main Street",
"City": "Anytown",
"State": "WA",
"CountryCode": "US",
"ZipCode": "98101",
"PhoneNumber": "+1.8005551212",
"Email": "wxiulan@example.com",
"ExtraParams": []
},
"AdminPrivacy": true,
"RegistrantPrivacy": true,
"TechPrivacy": true,
"RegistrarName": "Amazon Registrar, Inc.",
"WhoIsServer": "whois.registrar.amazon",
"RegistrarUrl": "http://registrar.amazon.com",
"AbuseContactEmail": "abuse@registrar.amazon.com",
"AbuseContactPhone": "+1.2062661000",
"CreationDate": 1444934889.601,
"ExpirationDate": 1602787689.0,
"StatusList": [
"clientTransferProhibited"
]
}
```
+ For API details, see [GetDomainDetail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-domain-detail.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53#code-examples).
```
public static void getDomainDetails(Route53DomainsClient route53DomainsClient, String domainSuggestion) {
try {
GetDomainDetailRequest detailRequest = GetDomainDetailRequest.builder()
.domainName(domainSuggestion)
.build();
GetDomainDetailResponse response = route53DomainsClient.getDomainDetail(detailRequest);
System.out.println("The contact first name is " + response.registrantContact().firstName());
System.out.println("The contact last name is " + response.registrantContact().lastName());
System.out.println("The contact org name is " + response.registrantContact().organizationName());
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
```
+ For API details, see [GetDomainDetail](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/GetDomainDetail) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/route53#code-examples).
```
suspend fun getDomainDetails(domainSuggestion: String?) {
val detailRequest =
GetDomainDetailRequest {
domainName = domainSuggestion
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
val response = route53DomainsClient.getDomainDetail(detailRequest)
println("The contact first name is ${response.registrantContact?.firstName}")
println("The contact last name is ${response.registrantContact?.lastName}")
println("The contact org name is ${response.registrantContact?.organizationName}")
}
}
```
+ For API details, see [GetDomainDetail](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `GetDomainSuggestions` with an AWS SDK or CLI
The following code examples show how to use `GetDomainSuggestions`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Route53#code-examples).
```
///
/// Get a list of suggestions for a given domain.
///
/// The domain to check for suggestions.
/// If true, only returns available domains.
/// The number of suggestions to return. Defaults to the max of 50.
/// A collection of domain suggestions.
public async Task> GetDomainSuggestions(string domain, bool onlyAvailable, int suggestionCount = 50)
{
var result = await _amazonRoute53Domains.GetDomainSuggestionsAsync(
new GetDomainSuggestionsRequest
{
DomainName = domain,
OnlyAvailable = onlyAvailable,
SuggestionCount = suggestionCount
}
);
return result.SuggestionsList;
}
```
+ For API details, see [GetDomainSuggestions](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/GetDomainSuggestions) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To get a list of suggested domain names**
The following `get-domain-suggestions` command displays a list of suggested domain names based on the domain name `example.com`. The response includes only domain names that are available. This command runs only in the `us-east-1` Region. If your default region is set to `us-east-1`, you can omit the `region` parameter.
```
aws route53domains get-domain-suggestions \
--region us-east-1 \
--domain-name example.com \
--suggestion-count 10 \
--only-available
```
Output:
```
{
"SuggestionsList": [
{
"DomainName": "egzaampal.com",
"Availability": "AVAILABLE"
},
{
"DomainName": "examplelaw.com",
"Availability": "AVAILABLE"
},
{
"DomainName": "examplehouse.net",
"Availability": "AVAILABLE"
},
{
"DomainName": "homeexample.net",
"Availability": "AVAILABLE"
},
{
"DomainName": "examplelist.com",
"Availability": "AVAILABLE"
},
{
"DomainName": "examplenews.net",
"Availability": "AVAILABLE"
},
{
"DomainName": "officeexample.com",
"Availability": "AVAILABLE"
},
{
"DomainName": "exampleworld.com",
"Availability": "AVAILABLE"
},
{
"DomainName": "exampleart.com",
"Availability": "AVAILABLE"
}
]
}
```
+ For API details, see [GetDomainSuggestions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-domain-suggestions.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53#code-examples).
```
public static void listDomainSuggestions(Route53DomainsClient route53DomainsClient, String domainSuggestion) {
try {
GetDomainSuggestionsRequest suggestionsRequest = GetDomainSuggestionsRequest.builder()
.domainName(domainSuggestion)
.suggestionCount(5)
.onlyAvailable(true)
.build();
GetDomainSuggestionsResponse response = route53DomainsClient.getDomainSuggestions(suggestionsRequest);
List suggestions = response.suggestionsList();
for (DomainSuggestion suggestion : suggestions) {
System.out.println("Suggestion Name: " + suggestion.domainName());
System.out.println("Availability: " + suggestion.availability());
System.out.println(" ");
}
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
```
+ For API details, see [GetDomainSuggestions](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/GetDomainSuggestions) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/route53#code-examples).
```
suspend fun listDomainSuggestions(domainSuggestion: String?) {
val suggestionsRequest =
GetDomainSuggestionsRequest {
domainName = domainSuggestion
suggestionCount = 5
onlyAvailable = true
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
val response = route53DomainsClient.getDomainSuggestions(suggestionsRequest)
response.suggestionsList?.forEach { suggestion ->
println("Suggestion Name: ${suggestion.domainName}")
println("Availability: ${suggestion.availability}")
println(" ")
}
}
}
```
+ For API details, see [GetDomainSuggestions](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `GetOperationDetail` with an AWS SDK or CLI
The following code examples show how to use `GetOperationDetail`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Route53#code-examples).
```
///
/// Get details for a domain action operation.
///
/// The operational Id.
/// A string describing the operational details.
public async Task GetOperationDetail(string? operationId)
{
if (operationId == null)
return "Unable to get operational details because ID is null.";
try
{
var operationDetails =
await _amazonRoute53Domains.GetOperationDetailAsync(
new GetOperationDetailRequest
{
OperationId = operationId
}
);
var details = $"\tOperation {operationId}:\n" +
$"\tFor domain {operationDetails.DomainName} on {operationDetails.SubmittedDate.ToShortDateString()}.\n" +
$"\tMessage is {operationDetails.Message}.\n" +
$"\tStatus is {operationDetails.Status}.\n";
return details;
}
catch (AmazonRoute53DomainsException ex)
{
return $"Unable to get operation details. Here's why: {ex.Message}.";
}
}
```
+ For API details, see [GetOperationDetail](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/GetOperationDetail) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To get the current status of an operation**
Some domain registration operations operate asynchronously and return a response before they finish. These operations return an operation ID that you can use to get the current status. The following `get-operation-detail` command returns the status of the specified operation.
This command runs only in the `us-east-1` Region. If your default region is set to `us-east-1`, you can omit the `region` parameter.
```
aws route53domains get-operation-detail \
--region us-east-1 \
--operation-id edbd8d63-7fe7-4343-9bc5-54033example
```
Output:
```
{
"OperationId": "edbd8d63-7fe7-4343-9bc5-54033example",
"Status": "SUCCESSFUL",
"DomainName": "example.com",
"Type": "DOMAIN_LOCK",
"SubmittedDate": 1573749367.864
}
```
+ For API details, see [GetOperationDetail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/get-operation-detail.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53#code-examples).
```
public static void getOperationalDetail(Route53DomainsClient route53DomainsClient, String operationId) {
try {
GetOperationDetailRequest detailRequest = GetOperationDetailRequest.builder()
.operationId(operationId)
.build();
GetOperationDetailResponse response = route53DomainsClient.getOperationDetail(detailRequest);
System.out.println("Operation detail message is " + response.message());
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
```
+ For API details, see [GetOperationDetail](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/GetOperationDetail) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/route53#code-examples).
```
suspend fun getOperationalDetail(opId: String?) {
val detailRequest =
GetOperationDetailRequest {
operationId = opId
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
val response = route53DomainsClient.getOperationDetail(detailRequest)
println("Operation detail message is ${response.message}")
}
}
```
+ For API details, see [GetOperationDetail](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `ListDomains` with an AWS SDK or CLI
The following code examples show how to use `ListDomains`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Route53#code-examples).
```
///
/// List the domains for the account.
///
/// A collection of domain summary records.
public async Task> ListDomains()
{
var results = new List();
var paginateDomains = _amazonRoute53Domains.Paginators.ListDomains(
new ListDomainsRequest());
// Get the entire list using the paginator.
await foreach (var domain in paginateDomains.Domains)
{
results.Add(domain);
}
return results;
}
```
+ For API details, see [ListDomains](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/ListDomains) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To list the domains that are registered with the current AWS account**
The following `list-domains` command lists summary information about the domains that are registered with the current AWS account.
This command runs only in the `us-east-1` Region. If your default region is set to `us-east-1`, you can omit the `region` parameter.
```
aws route53domains list-domains
--region us-east-1
```
Output:
```
{
"Domains": [
{
"DomainName": "example.com",
"AutoRenew": true,
"TransferLock": true,
"Expiry": 1602712345.0
},
{
"DomainName": "example.net",
"AutoRenew": true,
"TransferLock": true,
"Expiry": 1602723456.0
},
{
"DomainName": "example.org",
"AutoRenew": true,
"TransferLock": true,
"Expiry": 1602734567.0
}
]
}
```
+ For API details, see [ListDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/list-domains.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53#code-examples).
```
public static void listDomains(Route53DomainsClient route53DomainsClient) {
try {
ListDomainsIterable listRes = route53DomainsClient.listDomainsPaginator();
listRes.stream()
.flatMap(r -> r.domains().stream())
.forEach(content -> System.out.println("The domain name is " + content.domainName()));
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
```
+ For API details, see [ListDomains](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/ListDomains) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/route53#code-examples).
```
suspend fun listDomains() {
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
route53DomainsClient
.listDomainsPaginated(ListDomainsRequest {})
.transform { it.domains?.forEach { obj -> emit(obj) } }
.collect { content ->
println("The domain name is ${content.domainName}")
}
}
}
```
+ For API details, see [ListDomains](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `ListOperations` with an AWS SDK or CLI
The following code examples show how to use `ListOperations`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Route53#code-examples).
```
///
/// List operations for the account that are submitted after a specified date.
///
/// A collection of operation summary records.
public async Task> ListOperations(DateTime submittedSince)
{
var results = new List();
var paginateOperations = _amazonRoute53Domains.Paginators.ListOperations(
new ListOperationsRequest()
{
SubmittedSince = submittedSince
});
// Get the entire list using the paginator.
await foreach (var operations in paginateOperations.Operations)
{
results.Add(operations);
}
return results;
}
```
+ For API details, see [ListOperations](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/ListOperations) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To list the status of operations that return an operation ID**
Some domain registration operations run asynchronously and return a response before they finish. These operations return an operation ID that you can use to get the current status. The following `list-operations` command lists summary information, including the status, about the current domain-registration operations.
This command runs only in the `us-east-1` Region. If your default region is set to `us-east-1`, you can omit the `region` parameter.
```
aws route53domains list-operations
--region us-east-1
```
Output:
```
{
"Operations": [
{
"OperationId": "aab9822f-1da0-4bf3-8a15-fd4e0example",
"Status": "SUCCESSFUL",
"Type": "DOMAIN_LOCK",
"SubmittedDate": 1455321739.986
},
{
"OperationId": "c24379ed-76be-42f8-bdad-9379bexample",
"Status": "SUCCESSFUL",
"Type": "UPDATE_NAMESERVER",
"SubmittedDate": 1468960475.109
},
{
"OperationId": "f47e1297-ef9e-4c2b-ae1e-a5fcbexample",
"Status": "SUCCESSFUL",
"Type": "RENEW_DOMAIN",
"SubmittedDate": 1473561835.943
},
{
"OperationId": "75584f23-b15f-459e-aed7-dc6f5example",
"Status": "SUCCESSFUL",
"Type": "UPDATE_DOMAIN_CONTACT",
"SubmittedDate": 1547501003.41
}
]
}
```
The output includes all the operations that return an operation ID and that you have performed on all the domains that you have ever registered using the current AWS account. If you want to get only the operations that you submitted after a specified date, you can include the `submitted-since` parameter and specify a date in Unix format and Coordinated Universal Time (UTC). The following command gets the status of all operations that were submitted after 12:00 am UTC on January 1, 2020.
```
aws route53domains list-operations \
--submitted-since 1577836800
```
+ For API details, see [ListOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/list-operations.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53#code-examples).
```
public static void listOperations(Route53DomainsClient route53DomainsClient) {
try {
Date currentDate = new Date();
LocalDateTime localDateTime = currentDate.toInstant().atZone(ZoneId.systemDefault()).toLocalDateTime();
ZoneOffset zoneOffset = ZoneOffset.of("+01:00");
localDateTime = localDateTime.minusYears(1);
Instant myTime = localDateTime.toInstant(zoneOffset);
ListOperationsRequest operationsRequest = ListOperationsRequest.builder()
.submittedSince(myTime)
.build();
ListOperationsIterable listRes = route53DomainsClient.listOperationsPaginator(operationsRequest);
listRes.stream()
.flatMap(r -> r.operations().stream())
.forEach(content -> System.out.println(" Operation Id: " + content.operationId() +
" Status: " + content.statusAsString() +
" Date: " + content.submittedDate()));
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
```
+ For API details, see [ListOperations](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/ListOperations) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/route53#code-examples).
```
suspend fun listOperations() {
val currentDate = Date()
var localDateTime = currentDate.toInstant().atZone(ZoneId.systemDefault()).toLocalDateTime()
val zoneOffset = ZoneOffset.of("+01:00")
localDateTime = localDateTime.minusYears(1)
val myTime: java.time.Instant? = localDateTime.toInstant(zoneOffset)
val time2: Instant? = myTime?.let { Instant(it) }
val operationsRequest =
ListOperationsRequest {
submittedSince = time2
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
route53DomainsClient
.listOperationsPaginated(operationsRequest)
.transform { it.operations?.forEach { obj -> emit(obj) } }
.collect { content ->
println("Operation Id: ${content.operationId}")
println("Status: ${content.status}")
println("Date: ${content.submittedDate}")
}
}
}
```
+ For API details, see [ListOperations](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `ListPrices` with an AWS SDK
The following code examples show how to use `ListPrices`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Route53#code-examples).
```
///
/// List prices for domain type operations.
///
/// Domain types to include in the results.
/// The list of domain prices.
public async Task> ListPrices(List domainTypes)
{
var results = new List();
var paginatePrices = _amazonRoute53Domains.Paginators.ListPrices(new ListPricesRequest());
// Get the entire list using the paginator.
await foreach (var prices in paginatePrices.Prices)
{
results.Add(prices);
}
return results.Where(p => domainTypes.Contains(p.Name)).ToList();
}
```
+ For API details, see [ListPrices](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/ListPrices) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53#code-examples).
```
public static void listPrices(Route53DomainsClient route53DomainsClient, String domainType) {
try {
ListPricesRequest pricesRequest = ListPricesRequest.builder()
.tld(domainType)
.build();
ListPricesIterable listRes = route53DomainsClient.listPricesPaginator(pricesRequest);
listRes.stream()
.flatMap(r -> r.prices().stream())
.forEach(content -> System.out.println(" Name: " + content.name() +
" Registration: " + content.registrationPrice().price() + " "
+ content.registrationPrice().currency() +
" Renewal: " + content.renewalPrice().price() + " " + content.renewalPrice().currency()));
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
```
+ For API details, see [ListPrices](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/ListPrices) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/route53#code-examples).
```
suspend fun listAllPrices(domainType: String?) {
val pricesRequest =
ListPricesRequest {
tld = domainType
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
route53DomainsClient
.listPricesPaginated(pricesRequest)
.transform { it.prices?.forEach { obj -> emit(obj) } }
.collect { pr ->
println("Registration: ${pr.registrationPrice} ${pr.registrationPrice?.currency}")
println("Renewal: ${pr.renewalPrice?.price} ${pr.renewalPrice?.currency}")
println("Transfer: ${pr.transferPrice?.price} ${pr.transferPrice?.currency}")
println("Restoration: ${pr.restorationPrice?.price} ${pr.restorationPrice?.currency}")
}
}
}
```
+ For API details, see [ListPrices](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `RegisterDomain` with an AWS SDK or CLI
The following code examples show how to use `RegisterDomain`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Route53#code-examples).
```
///
/// Initiate a domain registration request.
///
/// Contact details.
/// The domain name to register.
/// True if the domain should automatically renew.
/// The duration in years for the domain registration.
/// The operation Id.
public async Task RegisterDomain(string domainName, bool autoRenew, int duration, ContactDetail contact)
{
// This example uses the same contact information for admin, registrant, and tech contacts.
try
{
var result = await _amazonRoute53Domains.RegisterDomainAsync(
new RegisterDomainRequest()
{
AdminContact = contact,
RegistrantContact = contact,
TechContact = contact,
DomainName = domainName,
AutoRenew = autoRenew,
DurationInYears = duration,
PrivacyProtectAdminContact = false,
PrivacyProtectRegistrantContact = false,
PrivacyProtectTechContact = false
}
);
return result.OperationId;
}
catch (InvalidInputException)
{
_logger.LogInformation($"Unable to request registration for domain {domainName}");
return null;
}
}
```
+ For API details, see [RegisterDomain](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/RegisterDomain) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To register a domain**
The following `register-domain` command registers a domain, retrieving all parameter values from a JSON-formatted file.
This command runs only in the `us-east-1` Region. If your default region is set to `us-east-1`, you can omit the `region` parameter.
```
aws route53domains register-domain \
--region us-east-1 \
--cli-input-json file://register-domain.json
```
Contents of `register-domain.json`:
```
{
"DomainName": "example.com",
"DurationInYears": 1,
"AutoRenew": true,
"AdminContact": {
"FirstName": "Martha",
"LastName": "Rivera",
"ContactType": "PERSON",
"OrganizationName": "Example",
"AddressLine1": "1 Main Street",
"City": "Anytown",
"State": "WA",
"CountryCode": "US",
"ZipCode": "98101",
"PhoneNumber": "+1.8005551212",
"Email": "mrivera@example.com"
},
"RegistrantContact": {
"FirstName": "Li",
"LastName": "Juan",
"ContactType": "PERSON",
"OrganizationName": "Example",
"AddressLine1": "1 Main Street",
"City": "Anytown",
"State": "WA",
"CountryCode": "US",
"ZipCode": "98101",
"PhoneNumber": "+1.8005551212",
"Email": "ljuan@example.com"
},
"TechContact": {
"FirstName": "Mateo",
"LastName": "Jackson",
"ContactType": "PERSON",
"OrganizationName": "Example",
"AddressLine1": "1 Main Street",
"City": "Anytown",
"State": "WA",
"CountryCode": "US",
"ZipCode": "98101",
"PhoneNumber": "+1.8005551212",
"Email": "mjackson@example.com"
},
"PrivacyProtectAdminContact": true,
"PrivacyProtectRegistrantContact": true,
"PrivacyProtectTechContact": true
}
```
Output:
```
{
"OperationId": "b114c44a-9330-47d1-a6e8-a0b11example"
}
```
To confirm that the operation succeeded, you can run `get-operation-detail`. For more information, see [get-operation-detail](https://docs.aws.amazon.com/cli/latest/reference/route53domains/get-operation-detail.html) .
For more information, see [Registering a New Domain](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-register.html) in the *Amazon Route 53 Developer Guide*.
For information about which top-level domains (TLDs) require values for `ExtraParams` and what the valid values are, see [ExtraParam](https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ExtraParam.html) in the *Amazon Route 53 API Reference*.
+ For API details, see [RegisterDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/register-domain.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53#code-examples).
```
public static String requestDomainRegistration(Route53DomainsClient route53DomainsClient,
String domainSuggestion,
String phoneNumber,
String email,
String firstName,
String lastName,
String city) {
try {
ContactDetail contactDetail = ContactDetail.builder()
.contactType(ContactType.COMPANY)
.state("LA")
.countryCode(CountryCode.IN)
.email(email)
.firstName(firstName)
.lastName(lastName)
.city(city)
.phoneNumber(phoneNumber)
.organizationName("My Org")
.addressLine1("My Address")
.zipCode("123 123")
.build();
RegisterDomainRequest domainRequest = RegisterDomainRequest.builder()
.adminContact(contactDetail)
.registrantContact(contactDetail)
.techContact(contactDetail)
.domainName(domainSuggestion)
.autoRenew(true)
.durationInYears(1)
.build();
RegisterDomainResponse response = route53DomainsClient.registerDomain(domainRequest);
System.out.println("Registration requested. Operation Id: " + response.operationId());
return response.operationId();
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
return "";
}
```
+ For API details, see [RegisterDomain](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/RegisterDomain) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/route53#code-examples).
```
suspend fun requestDomainRegistration(
domainSuggestion: String?,
phoneNumberVal: String?,
emailVal: String?,
firstNameVal: String?,
lastNameVal: String?,
cityVal: String?,
): String? {
val contactDetail =
ContactDetail {
contactType = ContactType.Company
state = "LA"
countryCode = CountryCode.In
email = emailVal
firstName = firstNameVal
lastName = lastNameVal
city = cityVal
phoneNumber = phoneNumberVal
organizationName = "My Org"
addressLine1 = "My Address"
zipCode = "123 123"
}
val domainRequest =
RegisterDomainRequest {
adminContact = contactDetail
registrantContact = contactDetail
techContact = contactDetail
domainName = domainSuggestion
autoRenew = true
durationInYears = 1
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
val response = route53DomainsClient.registerDomain(domainRequest)
println("Registration requested. Operation Id: ${response.operationId}")
return response.operationId
}
}
```
+ For API details, see [RegisterDomain](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `ViewBilling` with an AWS SDK or CLI
The following code examples show how to use `ViewBilling`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](route-53-domains_example_route-53-domains_Scenario_GetStartedRoute53Domains_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Route53#code-examples).
```
///
/// View billing records for the account between a start and end date.
///
/// The start date for billing results.
/// The end date for billing results.
/// A collection of billing records.
public async Task> ViewBilling(DateTime startDate, DateTime endDate)
{
var results = new List();
var paginateBilling = _amazonRoute53Domains.Paginators.ViewBilling(
new ViewBillingRequest()
{
Start = startDate,
End = endDate
});
// Get the entire list using the paginator.
await foreach (var billingRecords in paginateBilling.BillingRecords)
{
results.Add(billingRecords);
}
return results;
}
```
+ For API details, see [ViewBilling](https://docs.aws.amazon.com/goto/DotNetSDKV3/route53domains-2014-05-15/ViewBilling) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To get billing information for domain registration charges for the current AWS account**
The following `view-billing` command returns all the domain-related billing records for the current account for the period from January 1, 2018 (1514764800 in Unix time) and midnight on December 31, 2019 (1577836800 in Unix time).
This command runs only in the `us-east-1` Region. If your default region is set to `us-east-1`, you can omit the `region` parameter.
```
aws route53domains view-billing \
--region us-east-1 \
--start-time 1514764800 \
--end-time 1577836800
```
Output:
```
{
"BillingRecords": [
{
"DomainName": "example.com",
"Operation": "RENEW_DOMAIN",
"InvoiceId": "149962827",
"BillDate": 1536618063.181,
"Price": 12.0
},
{
"DomainName": "example.com",
"Operation": "RENEW_DOMAIN",
"InvoiceId": "290913289",
"BillDate": 1568162630.884,
"Price": 12.0
}
]
}
```
For more information, see [ViewBilling](https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ViewBilling.html) in the *Amazon Route 53 API Reference*.
+ For API details, see [ViewBilling](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/route53domains/view-billing.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/route53#code-examples).
```
public static void listBillingRecords(Route53DomainsClient route53DomainsClient) {
try {
Date currentDate = new Date();
LocalDateTime localDateTime = currentDate.toInstant().atZone(ZoneId.systemDefault()).toLocalDateTime();
ZoneOffset zoneOffset = ZoneOffset.of("+01:00");
LocalDateTime localDateTime2 = localDateTime.minusYears(1);
Instant myStartTime = localDateTime2.toInstant(zoneOffset);
Instant myEndTime = localDateTime.toInstant(zoneOffset);
ViewBillingRequest viewBillingRequest = ViewBillingRequest.builder()
.start(myStartTime)
.end(myEndTime)
.build();
ViewBillingIterable listRes = route53DomainsClient.viewBillingPaginator(viewBillingRequest);
listRes.stream()
.flatMap(r -> r.billingRecords().stream())
.forEach(content -> System.out.println(" Bill Date:: " + content.billDate() +
" Operation: " + content.operationAsString() +
" Price: " + content.price()));
} catch (Route53Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
```
+ For API details, see [ViewBilling](https://docs.aws.amazon.com/goto/SdkForJavaV2/route53domains-2014-05-15/ViewBilling) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/route53#code-examples).
```
suspend fun listBillingRecords() {
val currentDate = Date()
val localDateTime = currentDate.toInstant().atZone(ZoneId.systemDefault()).toLocalDateTime()
val zoneOffset = ZoneOffset.of("+01:00")
val localDateTime2 = localDateTime.minusYears(1)
val myStartTime = localDateTime2.toInstant(zoneOffset)
val myEndTime = localDateTime.toInstant(zoneOffset)
val timeStart: Instant? = myStartTime?.let { Instant(it) }
val timeEnd: Instant? = myEndTime?.let { Instant(it) }
val viewBillingRequest =
ViewBillingRequest {
start = timeStart
end = timeEnd
}
Route53DomainsClient.fromEnvironment { region = "us-east-1" }.use { route53DomainsClient ->
route53DomainsClient
.viewBillingPaginated(viewBillingRequest)
.transform { it.billingRecords?.forEach { obj -> emit(obj) } }
.collect { billing ->
println("Bill Date: ${billing.billDate}")
println("Operation: ${billing.operation}")
println("Price: ${billing.price}")
}
}
}
```
+ For API details, see [ViewBilling](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Route 53 with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.