DeleteSchemaCommand

Suggest an Edit

Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs.

Example Syntax

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

import { GlueClient, DeleteSchemaCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, DeleteSchemaCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // DeleteSchemaInput
  SchemaId: { // SchemaId
    SchemaArn: "STRING_VALUE",
    SchemaName: "STRING_VALUE",
    RegistryName: "STRING_VALUE",
  },
};
const command = new DeleteSchemaCommand(input);
const response = await client.send(command);
// { // DeleteSchemaResponse
//   SchemaArn: "STRING_VALUE",
//   SchemaName: "STRING_VALUE",
//   Status: "AVAILABLE" || "PENDING" || "DELETING",
// };

DeleteSchemaCommand Input

See DeleteSchemaCommandInput for more details

Parameter
Type
Description
SchemaId
Required
SchemaId | undefined

This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

DeleteSchemaCommand Output

See DeleteSchemaCommandOutput for details

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

The Amazon Resource Name (ARN) of the schema being deleted.

SchemaName
string | undefined

The name of the schema being deleted.

Status
SchemaStatus | undefined

The status of the schema.

Throws

Name
Fault
Details
AccessDeniedException
client

Access to a resource was denied.

ConcurrentModificationException
client

Two processes are trying to modify a resource simultaneously.

EntityNotFoundException
client

A specified entity does not exist

InvalidInputException
client

The input provided was not valid.

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