Class DescribeCoreCommandProtected

Retrieve an existing core.

Example

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

import { CoresClient, DescribeCoreCommand } from "@stedi/sdk-client-cores"; // ES Modules import
// const { CoresClient, DescribeCoreCommand } = require("@stedi/sdk-client-cores"); // CommonJS import
const client = new CoresClient(config);
const input = { // DescribeCoreInput
  coreName: "STRING_VALUE", // required
};
const command = new DescribeCoreCommand(input);
const response = await client.send(command);
// { // DescribeCoreOutput
//   coreName: "STRING_VALUE", // required
//   resourceDetail: { // DescribeResourceDetail
//     status: "AVAILABLE" || "UNDER_CHANGE" || "CHANGE_FAILED" || "ERROR" || "CREATE_FAILED", // required
//     detailedStatus: "AVAILABLE_UPDATE_FAILED" || "UPDATE_FAILED" || "DELETE_FAILED",
//     statusMessage: "STRING_VALUE",
//     idempotencyKey: "STRING_VALUE", // required
//     createdAt: new Date("TIMESTAMP"), // required
//     updatedAt: new Date("TIMESTAMP"), // required
//   },
// };

Param

DescribeCoreCommandInput

Returns

DescribeCoreCommandOutput

See

• DescribeCoreCommandInput for command's input shape.
• DescribeCoreCommandOutput for command's response shape.
• config for CoresClient's config shape.

Throws

ResourceNotFoundException (client fault)

Throws

ResourceUnderChangeException (client fault)

Throws

ServiceException (server fault)

Throws

CoresServiceException

Base exception class for all service exceptions from Cores service.