ListDomainsCommand

Suggest an Edit

Lists Amazon DataZone domains.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, ListDomainsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListDomainsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListDomainsInput
  status: "CREATING" || "AVAILABLE" || "CREATION_FAILED" || "DELETING" || "DELETED" || "DELETION_FAILED",
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListDomainsCommand(input);
const response = await client.send(command);
// { // ListDomainsOutput
//   items: [ // DomainSummaries // required
//     { // DomainSummary
//       id: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       arn: "STRING_VALUE", // required
//       managedAccountId: "STRING_VALUE", // required
//       status: "CREATING" || "AVAILABLE" || "CREATION_FAILED" || "DELETING" || "DELETED" || "DELETION_FAILED", // required
//       portalUrl: "STRING_VALUE",
//       createdAt: new Date("TIMESTAMP"), // required
//       lastUpdatedAt: new Date("TIMESTAMP"),
//       domainVersion: "V1" || "V2",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListDomainsCommand Input

See ListDomainsCommandInput for more details

Parameter
Type
Description
maxResults
number | undefined

The maximum number of domains to return in a single call to ListDomains. When the number of domains to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDomains to list the next set of domains.

nextToken
string | undefined

When the number of domains is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domains, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomains to list the next set of domains.

status
DomainStatus | undefined

The status of the data source.

ListDomainsCommand Output

See ListDomainsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
items
Required
DomainSummary[] | undefined

The results of the ListDomains action.

nextToken
string | undefined

When the number of domains is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domains, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomains to list the next set of domains.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

There is a conflict while performing this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The specified resource cannot be found.

ServiceQuotaExceededException
client

The request has exceeded the specified service quota.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.