Class DescribeFunctionScheduleCommandProtected

Describe a FunctionSchedule

Example

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

import { EventsClient, DescribeFunctionScheduleCommand } from "@stedi/sdk-client-events"; // ES Modules import
// const { EventsClient, DescribeFunctionScheduleCommand } = require("@stedi/sdk-client-events"); // CommonJS import
const client = new EventsClient(config);
const input = { // DescribeFunctionScheduleInput
  functionScheduleName: "STRING_VALUE", // required
};
const command = new DescribeFunctionScheduleCommand(input);
const response = await client.send(command);
// { // DescribeFunctionScheduleOutput
//   functionScheduleName: "STRING_VALUE", // required
//   idempotencyKey: "STRING_VALUE",
//   endTime: "STRING_VALUE",
//   functionName: "STRING_VALUE", // required
//   functionInput: "DOCUMENT_VALUE",
//   scheduleExpression: "STRING_VALUE", // required
//   scheduleExpressionTimezone: "STRING_VALUE",
//   startTime: "STRING_VALUE",
//   state: "ENABLED" || "DISABLED", // 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

DescribeFunctionScheduleCommandInput

Returns

DescribeFunctionScheduleCommandOutput

See

• DescribeFunctionScheduleCommandInput for command's input shape.
• DescribeFunctionScheduleCommandOutput for command's response shape.
• config for EventsClient's config shape.

Throws

AccessDeniedException (client fault)

Throws

ProductUnavailableException (client fault)

Throws

ResourceAlreadyExistsException (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

ResourceUnderChangeException (client fault)

Throws

ServiceException (server fault)

Throws

EventsServiceException

Base exception class for all service exceptions from Events service.