- 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.
DescribeStackSetOperationCommand
Returns the description of the specified StackSet operation.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { CloudFormationClient, DescribeStackSetOperationCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
// const { CloudFormationClient, DescribeStackSetOperationCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
const client = new CloudFormationClient(config);
const input = { // DescribeStackSetOperationInput
StackSetName: "STRING_VALUE", // required
OperationId: "STRING_VALUE", // required
CallAs: "SELF" || "DELEGATED_ADMIN",
};
const command = new DescribeStackSetOperationCommand(input);
const response = await client.send(command);
// { // DescribeStackSetOperationOutput
// StackSetOperation: { // StackSetOperation
// OperationId: "STRING_VALUE",
// StackSetId: "STRING_VALUE",
// Action: "CREATE" || "UPDATE" || "DELETE" || "DETECT_DRIFT",
// Status: "RUNNING" || "SUCCEEDED" || "FAILED" || "STOPPING" || "STOPPED" || "QUEUED",
// OperationPreferences: { // StackSetOperationPreferences
// RegionConcurrencyType: "SEQUENTIAL" || "PARALLEL",
// RegionOrder: [ // RegionList
// "STRING_VALUE",
// ],
// FailureToleranceCount: Number("int"),
// FailureTolerancePercentage: Number("int"),
// MaxConcurrentCount: Number("int"),
// MaxConcurrentPercentage: Number("int"),
// ConcurrencyMode: "STRICT_FAILURE_TOLERANCE" || "SOFT_FAILURE_TOLERANCE",
// },
// RetainStacks: true || false,
// AdministrationRoleARN: "STRING_VALUE",
// ExecutionRoleName: "STRING_VALUE",
// CreationTimestamp: new Date("TIMESTAMP"),
// EndTimestamp: new Date("TIMESTAMP"),
// DeploymentTargets: { // DeploymentTargets
// Accounts: [ // AccountList
// "STRING_VALUE",
// ],
// AccountsUrl: "STRING_VALUE",
// OrganizationalUnitIds: [ // OrganizationalUnitIdList
// "STRING_VALUE",
// ],
// AccountFilterType: "NONE" || "INTERSECTION" || "DIFFERENCE" || "UNION",
// },
// 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"),
// },
// StatusReason: "STRING_VALUE",
// StatusDetails: { // StackSetOperationStatusDetails
// FailedStackInstancesCount: Number("int"),
// },
// },
// };
DescribeStackSetOperationCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
OperationId Required | string | undefined | The unique ID of the stack set operation. |
StackSetName Required | string | undefined | The name or the unique stack ID of the stack set for the stack operation. |
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,
|
DescribeStackSetOperationCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
StackSetOperation | StackSetOperation | undefined | The specified stack set operation. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
OperationNotFoundException | client | The specified ID refers to an operation that doesn't exist. |
StackSetNotFoundException | client | The specified stack set doesn't exist. |
CloudFormationServiceException | Base exception class for all service exceptions from CloudFormation service. |