Class DescribeFunctionCommandProtected

Retrieve an existing function.

Example

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

import { FunctionsClient, DescribeFunctionCommand } from "@stedi/sdk-client-functions"; // ES Modules import
// const { FunctionsClient, DescribeFunctionCommand } = require("@stedi/sdk-client-functions"); // CommonJS import
const client = new FunctionsClient(config);
const input = { // DescribeFunctionInput
  functionName: "STRING_VALUE", // required
};
const command = new DescribeFunctionCommand(input);
const response = await client.send(command);
// { // DescribeFunctionOutput
//   functionName: "STRING_VALUE", // required
//   packageBucket: "STRING_VALUE", // required
//   packageKey: "STRING_VALUE", // required
//   packageSha256: "STRING_VALUE",
//   environmentVariables: { // EnvironmentVariables
//     "<keys>": "STRING_VALUE",
//   },
//   timeout: Number("int"),
//   logRetention: 1 || 3 || 5 || 7 || 14 || 30 || 60 || 90 || 120 || 150 || 180 || 365 || 400 || 545 || 731 || 1827 || 3653,
//   errorQueue: { // QueueInfo
//     queueName: "STRING_VALUE", // required
//     queueUrl: "STRING_VALUE", // required
//   },
//   asyncInvokeConfig: { // AsyncInvokeConfig
//     maximumRetryAttempts: Number("int"),
//   },
//   reservedConcurrentExecutions: Number("int"),
//   issueManagerName: "STRING_VALUE",
//   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

DescribeFunctionCommandInput

Returns

DescribeFunctionCommandOutput

See

• DescribeFunctionCommandInput for command's input shape.
• DescribeFunctionCommandOutput for command's response shape.
• config for FunctionsClient's config shape.

Throws

InvalidZipFileException (client fault)

Throws

RequestTooLargeException (client fault)

Throws

TooManyRequestsException (client fault)

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

FunctionsServiceException

Base exception class for all service exceptions from Functions service.