DescribeSchemaCommand

Suggest an Edit

Describes a schema. For more information on schemas, see CreateSchema .

Example Syntax

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

import { PersonalizeClient, DescribeSchemaCommand } from "@aws-sdk/client-personalize"; // ES Modules import
// const { PersonalizeClient, DescribeSchemaCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
const client = new PersonalizeClient(config);
const input = { // DescribeSchemaRequest
  schemaArn: "STRING_VALUE", // required
};
const command = new DescribeSchemaCommand(input);
const response = await client.send(command);
// { // DescribeSchemaResponse
//   schema: { // DatasetSchema
//     name: "STRING_VALUE",
//     schemaArn: "STRING_VALUE",
//     schema: "STRING_VALUE",
//     creationDateTime: new Date("TIMESTAMP"),
//     lastUpdatedDateTime: new Date("TIMESTAMP"),
//     domain: "ECOMMERCE" || "VIDEO_ON_DEMAND",
//   },
// };

DescribeSchemaCommand Input

See DescribeSchemaCommandInput for more details

Parameter
Type
Description
schemaArn
Required
string | undefined

The Amazon Resource Name (ARN) of the schema to retrieve.

DescribeSchemaCommand Output

See DescribeSchemaCommandOutput for details

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

The requested schema.

Throws

Name
Fault
Details
InvalidInputException
client

Provide a valid value for the field or parameter.

ResourceNotFoundException
client

Could not find the specified resource.

PersonalizeServiceException
Base exception class for all service exceptions from Personalize service.