ListRegistriesCommand

Suggest an Edit

Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting status will not be included in the results. Empty results will be returned if there are no registries available.

Example Syntax

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

import { GlueClient, ListRegistriesCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, ListRegistriesCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // ListRegistriesInput
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListRegistriesCommand(input);
const response = await client.send(command);
// { // ListRegistriesResponse
//   Registries: [ // RegistryListDefinition
//     { // RegistryListItem
//       RegistryName: "STRING_VALUE",
//       RegistryArn: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       Status: "AVAILABLE" || "DELETING",
//       CreatedTime: "STRING_VALUE",
//       UpdatedTime: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListRegistriesCommand Input

See ListRegistriesCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

NextToken
string | undefined

A continuation token, if this is a continuation call.

ListRegistriesCommand Output

See ListRegistriesCommandOutput for details

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

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Registries
RegistryListItem[] | undefined

An array of RegistryDetailedListItem objects containing minimal details of each registry.

Throws

Name
Fault
Details
AccessDeniedException
client

Access to a resource was denied.

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

GlueServiceException
Base exception class for all service exceptions from Glue service.