ListDomains
Lists the domains.
Request Syntax
{
"MaxResults": number,
"NextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
This parameter defines the maximum number of results that can be return in a single response. The
MaxResultsparameter is an upper bound, not a target. If there are more results available than the value specified, aNextTokenis provided in the response. TheNextTokenindicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value forMaxResultsis 10.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*Required: No
Response Syntax
{
"Domains": [
{
"CreationTime": number,
"DomainArn": "string",
"DomainId": "string",
"DomainName": "string",
"LastModifiedTime": number,
"Status": "string",
"Url": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Domains
-
The list of domains.
Type: Array of DomainDetails objects
- NextToken
-
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
