- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeSchemaCommand
Retrieve the schema definition.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SchemasClient, DescribeSchemaCommand } from "@aws-sdk/client-schemas"; // ES Modules import
// const { SchemasClient, DescribeSchemaCommand } = require("@aws-sdk/client-schemas"); // CommonJS import
const client = new SchemasClient(config);
const input = { // DescribeSchemaRequest
RegistryName: "STRING_VALUE", // required
SchemaName: "STRING_VALUE", // required
SchemaVersion: "STRING_VALUE",
};
const command = new DescribeSchemaCommand(input);
const response = await client.send(command);
// { // DescribeSchemaResponse
// Content: "STRING_VALUE",
// Description: "STRING_VALUE",
// LastModified: new Date("TIMESTAMP"),
// SchemaArn: "STRING_VALUE",
// SchemaName: "STRING_VALUE",
// SchemaVersion: "STRING_VALUE",
// Tags: { // Tags
// "<keys>": "STRING_VALUE",
// },
// Type: "STRING_VALUE",
// VersionCreatedDate: new Date("TIMESTAMP"),
// };
DescribeSchemaCommand Input
See DescribeSchemaCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
RegistryName Required | string | undefined | The name of the registry. |
SchemaName Required | string | undefined | The name of the schema. |
SchemaVersion | string | undefined | Specifying this limits the results to only this schema version. |
DescribeSchemaCommand Output
See DescribeSchemaCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Content | string | undefined | The source of the schema definition. |
Description | string | undefined | The description of the schema. |
LastModified | Date | undefined | The date and time that schema was modified. |
SchemaArn | string | undefined | The ARN of the schema. |
SchemaName | string | undefined | The name of the schema. |
SchemaVersion | string | undefined | The version number of the schema |
Tags | Record<string, string> | undefined | Tags associated with the resource. |
Type | string | undefined | The type of the schema. |
VersionCreatedDate | Date | undefined | The date the schema version was created. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
BadRequestException | client | |
ForbiddenException | client | |
InternalServerErrorException | server | |
NotFoundException | client | |
ServiceUnavailableException | server | |
UnauthorizedException | client | |
SchemasServiceException | Base exception class for all service exceptions from Schemas service. |