ListRegistriesCommand

Suggest an Edit

List the registries.

Example Syntax

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

import { SchemasClient, ListRegistriesCommand } from "@aws-sdk/client-schemas"; // ES Modules import
// const { SchemasClient, ListRegistriesCommand } = require("@aws-sdk/client-schemas"); // CommonJS import
const client = new SchemasClient(config);
const input = { // ListRegistriesRequest
  Limit: Number("int"),
  NextToken: "STRING_VALUE",
  RegistryNamePrefix: "STRING_VALUE",
  Scope: "STRING_VALUE",
};
const command = new ListRegistriesCommand(input);
const response = await client.send(command);
// { // ListRegistriesResponse
//   NextToken: "STRING_VALUE",
//   Registries: [ // __listOfRegistrySummary
//     { // RegistrySummary
//       RegistryArn: "STRING_VALUE",
//       RegistryName: "STRING_VALUE",
//       Tags: { // Tags
//         "<keys>": "STRING_VALUE",
//       },
//     },
//   ],
// };

ListRegistriesCommand Input

See ListRegistriesCommandInput for more details

Parameter
Type
Description
Limit
number | undefined
NextToken
string | undefined

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

RegistryNamePrefix
string | undefined

Specifying this limits the results to only those registry names that start with the specified prefix.

Scope
string | undefined

Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.

ListRegistriesCommand Output

See ListRegistriesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

Registries
RegistrySummary[] | undefined

An array of registry summaries.

Throws

Name
Fault
Details
BadRequestException
client
ForbiddenException
client
InternalServerErrorException
server
ServiceUnavailableException
server
UnauthorizedException
client
SchemasServiceException
Base exception class for all service exceptions from Schemas service.