- 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.
DescribeStackRefactorCommand
Describes the stack refactor status.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { CloudFormationClient, DescribeStackRefactorCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
// const { CloudFormationClient, DescribeStackRefactorCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
const client = new CloudFormationClient(config);
const input = { // DescribeStackRefactorInput
StackRefactorId: "STRING_VALUE", // required
};
const command = new DescribeStackRefactorCommand(input);
const response = await client.send(command);
// { // DescribeStackRefactorOutput
// Description: "STRING_VALUE",
// StackRefactorId: "STRING_VALUE",
// StackIds: [ // StackIds
// "STRING_VALUE",
// ],
// ExecutionStatus: "UNAVAILABLE" || "AVAILABLE" || "OBSOLETE" || "EXECUTE_IN_PROGRESS" || "EXECUTE_COMPLETE" || "EXECUTE_FAILED" || "ROLLBACK_IN_PROGRESS" || "ROLLBACK_COMPLETE" || "ROLLBACK_FAILED",
// ExecutionStatusReason: "STRING_VALUE",
// Status: "CREATE_IN_PROGRESS" || "CREATE_COMPLETE" || "CREATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_COMPLETE" || "DELETE_FAILED",
// StatusReason: "STRING_VALUE",
// };
DescribeStackRefactorCommand Input
See DescribeStackRefactorCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
StackRefactorIdRequired | string | undefined | The ID associated with the stack refactor created from the CreateStackRefactor action. |
DescribeStackRefactorCommand Output
See DescribeStackRefactorCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Description | string | undefined | A description to help you identify the refactor. |
ExecutionStatus | StackRefactorExecutionStatus | undefined | The stack refactor execution operation status that's provided after calling the ExecuteStackRefactor action. |
ExecutionStatusReason | string | undefined | A detailed explanation for the stack refactor |
StackIds | string[] | undefined | The unique ID for each stack. |
StackRefactorId | string | undefined | The ID associated with the stack refactor created from the CreateStackRefactor action. |
Status | StackRefactorStatus | undefined | The stack refactor operation status that's provided after calling the CreateStackRefactor action. |
StatusReason | string | undefined | A detailed explanation for the stack refactor operation |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| StackRefactorNotFoundException | client | The specified stack refactor can't be found. |
| CloudFormationServiceException | Base exception class for all service exceptions from CloudFormation service. |