CreateRegistryCommand

Creates a new registry which may be used to hold a collection of schemas.

Example Syntax

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

import { GlueClient, CreateRegistryCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, CreateRegistryCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // CreateRegistryInput
  RegistryName: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  Tags: { // TagsMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new CreateRegistryCommand(input);
const response = await client.send(command);
// { // CreateRegistryResponse
//   RegistryArn: "STRING_VALUE",
//   RegistryName: "STRING_VALUE",
//   Description: "STRING_VALUE",
//   Tags: { // TagsMap
//     "<keys>": "STRING_VALUE",
//   },
// };

CreateRegistryCommand Input

See CreateRegistryCommandInput for more details

Parameter
Type
Description
RegistryName
Required
string | undefined

Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.

Description
string | undefined

A description of the registry. If description is not provided, there will not be any default value for this.

Tags
Record<string, string> | undefined

Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.

CreateRegistryCommand Output

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

A description of the registry.

RegistryArn
string | undefined

The Amazon Resource Name (ARN) of the newly created registry.

RegistryName
string | undefined

The name of the registry.

Tags
Record<string, string> | undefined

The tags for the registry.

Throws

Name
Fault
Details
AccessDeniedException
client

Access to a resource was denied.

AlreadyExistsException
client

A resource to be created or added already exists.

ConcurrentModificationException
client

Two processes are trying to modify a resource simultaneously.

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

ResourceNumberLimitExceededException
client

A resource numerical limit was exceeded.

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