DescribeStackSetCommand

Returns the description of the specified StackSet.

Example Syntax

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

import { CloudFormationClient, DescribeStackSetCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
// const { CloudFormationClient, DescribeStackSetCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
const client = new CloudFormationClient(config);
const input = { // DescribeStackSetInput
  StackSetName: "STRING_VALUE", // required
  CallAs: "SELF" || "DELEGATED_ADMIN",
};
const command = new DescribeStackSetCommand(input);
const response = await client.send(command);
// { // DescribeStackSetOutput
//   StackSet: { // StackSet
//     StackSetName: "STRING_VALUE",
//     StackSetId: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     Status: "ACTIVE" || "DELETED",
//     TemplateBody: "STRING_VALUE",
//     Parameters: [ // Parameters
//       { // Parameter
//         ParameterKey: "STRING_VALUE",
//         ParameterValue: "STRING_VALUE",
//         UsePreviousValue: true || false,
//         ResolvedValue: "STRING_VALUE",
//       },
//     ],
//     Capabilities: [ // Capabilities
//       "CAPABILITY_IAM" || "CAPABILITY_NAMED_IAM" || "CAPABILITY_AUTO_EXPAND",
//     ],
//     Tags: [ // Tags
//       { // Tag
//         Key: "STRING_VALUE", // required
//         Value: "STRING_VALUE", // required
//       },
//     ],
//     StackSetARN: "STRING_VALUE",
//     AdministrationRoleARN: "STRING_VALUE",
//     ExecutionRoleName: "STRING_VALUE",
//     StackSetDriftDetectionDetails: { // StackSetDriftDetectionDetails
//       DriftStatus: "DRIFTED" || "IN_SYNC" || "NOT_CHECKED",
//       DriftDetectionStatus: "COMPLETED" || "FAILED" || "PARTIAL_SUCCESS" || "IN_PROGRESS" || "STOPPED",
//       LastDriftCheckTimestamp: new Date("TIMESTAMP"),
//       TotalStackInstancesCount: Number("int"),
//       DriftedStackInstancesCount: Number("int"),
//       InSyncStackInstancesCount: Number("int"),
//       InProgressStackInstancesCount: Number("int"),
//       FailedStackInstancesCount: Number("int"),
//     },
//     AutoDeployment: { // AutoDeployment
//       Enabled: true || false,
//       RetainStacksOnAccountRemoval: true || false,
//     },
//     PermissionModel: "SERVICE_MANAGED" || "SELF_MANAGED",
//     OrganizationalUnitIds: [ // OrganizationalUnitIdList
//       "STRING_VALUE",
//     ],
//     ManagedExecution: { // ManagedExecution
//       Active: true || false,
//     },
//     Regions: [ // RegionList
//       "STRING_VALUE",
//     ],
//   },
// };

DescribeStackSetCommand Input

See DescribeStackSetCommandInput for more details

Parameter
Type
Description
StackSetName
Required
string | undefined

The name or unique ID of the stack set whose description you want.

CallAs
CallAs | undefined

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator  in the CloudFormation User Guide.

DescribeStackSetCommand Output

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

The specified stack set.

Throws

Name
Fault
Details
StackSetNotFoundException
client

The specified stack set doesn't exist.

CloudFormationServiceException
Base exception class for all service exceptions from CloudFormation service.