get-domains¶
Description¶
Returns a list of all domains in the user’s account.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-domains is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: domains
Synopsis¶
get-domains
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
Options¶
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items (integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To get information about all domains
The following get-domains example displays details about all of the domains in the configured AWS Region.
Note: Lightsail’s domain-related API operations are available in only the us-east-1 AWS Region. If your CLI profile is configured to use a different Region, you must include the --region us-east-1 parameter or the command fails.
aws lightsail get-domains \
--region us-east-1
Output:
{
"domains": [
{
"name": "example.com",
"arn": "arn:aws:lightsail:global:111122223333:Domain/28cda903-3f15-44b2-9baf-3EXAMPLEb304",
"supportCode": "6EXAMPLE3362//hostedzone/ZEXAMPLEONGSC1",
"createdAt": 1570728588.6,
"location": {
"availabilityZone": "all",
"regionName": "global"
},
"resourceType": "Domain",
"tags": [],
"domainEntries": [
{
"id": "-1682899164",
"name": "example.com",
"target": "192.0.2.0",
"isAlias": false,
"type": "A"
},
{
"id": "1703104243",
"name": "example.com",
"target": "ns-137.awsdns-17.com",
"isAlias": false,
"type": "NS"
},
{
"id": "-1038331153",
"name": "example.com",
"target": "ns-4567.awsdns-21.co.uk",
"isAlias": false,
"type": "NS"
},
{
"id": "-2107289565",
"name": "example.com",
"target": "ns-333.awsdns-22.net",
"isAlias": false,
"type": "NS"
},
{
"id": "1582095705",
"name": "example.com",
"target": "ns-1111.awsdns-51.org",
"isAlias": false,
"type": "NS"
},
{
"id": "-1769796132",
"name": "example.com",
"target": "ns-1234.awsdns-21.co.uk. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400",
"isAlias": false,
"type": "SOA"
},
{
"id": "1029454894",
"name": "_dead6a124ede046a0319eb44a4eb3cbc.example.com",
"target": "_be133b0a0899fb7b6bf79d9741d1a383.hkvuiqjoua.acm-validations.aws",
"isAlias": false,
"type": "CNAME"
}
]
},
{
"name": "example.net",
"arn": "arn:aws:lightsail:global:111122223333:Domain/9c9f0d70-c92e-4753-86c2-6EXAMPLE029d",
"supportCode": "6EXAMPLE3362//hostedzone/ZEXAMPLE5TPKMV",
"createdAt": 1556661071.384,
"location": {
"availabilityZone": "all",
"regionName": "global"
},
"resourceType": "Domain",
"tags": [],
"domainEntries": [
{
"id": "-766320943",
"name": "example.net",
"target": "192.0.2.2",
"isAlias": false,
"type": "A"
},
{
"id": "-453913825",
"name": "example.net",
"target": "ns-123.awsdns-10.net",
"isAlias": false,
"type": "NS"
},
{
"id": "1553601564",
"name": "example.net",
"target": "ns-4444.awsdns-47.co.uk",
"isAlias": false,
"type": "NS"
},
{
"id": "1653797661",
"name": "example.net",
"target": "ns-7890.awsdns-61.org",
"isAlias": false,
"type": "NS"
},
{
"id": "706414698",
"name": "example.net",
"target": "ns-123.awsdns-44.com",
"isAlias": false,
"type": "NS"
},
{
"id": "337271745",
"name": "example.net",
"target": "ns-4444.awsdns-47.co.uk. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400",
"isAlias": false,
"type": "SOA"
},
{
"id": "-1785431096",
"name": "www.example.net",
"target": "192.0.2.2",
"isAlias": false,
"type": "A"
}
]
},
{
"name": "example.org",
"arn": "arn:aws:lightsail:global:111122223333:Domain/f0f13ba3-3df0-4fdc-8ebb-1EXAMPLEf26e",
"supportCode": "6EXAMPLE3362//hostedzone/ZEXAMPLEAFO38",
"createdAt": 1556661199.106,
"location": {
"availabilityZone": "all",
"regionName": "global"
},
"resourceType": "Domain",
"tags": [],
"domainEntries": [
{
"id": "2065301345",
"name": "example.org",
"target": "192.0.2.4",
"isAlias": false,
"type": "A"
},
{
"id": "-447198516",
"name": "example.org",
"target": "ns-123.awsdns-45.com",
"isAlias": false,
"type": "NS"
},
{
"id": "136463022",
"name": "example.org",
"target": "ns-9999.awsdns-15.co.uk",
"isAlias": false,
"type": "NS"
},
{
"id": "1395941679",
"name": "example.org",
"target": "ns-555.awsdns-01.net",
"isAlias": false,
"type": "NS"
},
{
"id": "872052569",
"name": "example.org",
"target": "ns-6543.awsdns-38.org",
"isAlias": false,
"type": "NS"
},
{
"id": "1001949377",
"name": "example.org",
"target": "ns-1234.awsdns-15.co.uk. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400",
"isAlias": false,
"type": "SOA"
},
{
"id": "1046191192",
"name": "www.example.org",
"target": "192.0.2.4",
"isAlias": false,
"type": "A"
}
]
}
]
}
Output¶
domains -> (list)
An array of key-value pairs containing information about each of the domain entries in the user’s account.
(structure)
Describes a domain where you are storing recordsets.
name -> (string)
The name of the domain.
arn -> (string)
The Amazon Resource Name (ARN) of the domain recordset (e.g.,
arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).supportCode -> (string)
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
createdAt -> (timestamp)
The date when the domain recordset was created.
location -> (structure)
The AWS Region and Availability Zones where the domain recordset was created.
availabilityZone -> (string)
The Availability Zone. Follows the format
us-east-2a(case-sensitive).regionName -> (string)
The AWS Region name.
resourceType -> (string)
The resource type.
tags -> (list)
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide .
(structure)
Describes a tag key and optional value assigned to an Amazon Lightsail resource.
For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide .
key -> (string)
The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value -> (string)
The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
domainEntries -> (list)
An array of key-value pairs containing information about the domain entries.
(structure)
Describes a domain recordset entry.
id -> (string)
The ID of the domain recordset entry.
name -> (string)
The name of the domain.
target -> (string)
The target IP address (e.g.,
192.0.2.0), or AWS name server (e.g.,ns-111.awsdns-22.com.).For Lightsail load balancers, the value looks like
ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For Lightsail distributions, the value looks likeexampled1182ne.cloudfront.net. For Lightsail container services, the value looks likecontainer-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to also setisAliastotruewhen setting up an A record for a Lightsail load balancer, distribution, or container service.isAlias -> (boolean)
When
true, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer.type -> (string)
The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The following domain entry types can be used:
A
AAAA
CNAME
MX
NS
SOA
SRV
TXToptions -> (map)
(Deprecated) The options for the domain entry.
Note
In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
key -> (string)
value -> (string)
nextPageToken -> (string)
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another
GetDomainsrequest and specify the next page token using thepageTokenparameter.