DescribeStackSet - AWS CloudFormation

DescribeStackSet

Returns the description of the specified stack set.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

CallAs

[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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

Type: String

Valid Values: SELF | DELEGATED_ADMIN

Required: No

StackSetName

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

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

StackSet

The specified stack set.

Type: StackSet object

Errors

For information about the errors that are common to all actions, see Common Errors.

StackSetNotFound

The specified stack set doesn't exist.

HTTP Status Code: 404

Examples

DescribeStackSet

This example illustrates one usage of DescribeStackSet.

Sample Request

https://cloudformation.us-east-1.amazonaws.com/ ?Action=DescribeStackSet &Version=2010-05-15 &StackSetName=stack-set-example &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=[Access key ID and scope] &X-Amz-Date=20170810T233349Z &X-Amz-SignedHeaders=content-type;host &X-Amz-Signature=[Signature]

Sample Response

<DescribeStackSetResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/"> <DescribeStackSetResult> <StackSet> <Capabilities> <member>CAPABILITY_IAM</member> </Capabilities> <StackSetId>stack-set-example:c14cd6d1-cd17-40bd-82ed-ff97example</StackSetId> <TemplateBody> [details omitted] </TemplateBody> <StackSetName>stack-set-example</StackSetName> <Description>Enable AWS Config</Description> <Parameters> <member> <ParameterKey>AllSupported</ParameterKey> <UsePreviousValue>false</UsePreviousValue> <ParameterValue>true</ParameterValue> </member> <member> <ParameterKey>DeliveryChannelName</ParameterKey> <UsePreviousValue>false</UsePreviousValue> <ParameterValue><Generated></ParameterValue> </member> <member> <ParameterKey>Frequency</ParameterKey> <UsePreviousValue>false</UsePreviousValue> <ParameterValue>24hours</ParameterValue> </member> <member> <ParameterKey>IncludeGlobalResourceTypes</ParameterKey> <UsePreviousValue>false</UsePreviousValue> <ParameterValue>true</ParameterValue> </member> <member> <ParameterKey>NotificationEmail</ParameterKey> <UsePreviousValue>false</UsePreviousValue> <ParameterValue><None></ParameterValue> </member> <member> <ParameterKey>ResourceTypes</ParameterKey> <UsePreviousValue>false</UsePreviousValue> <ParameterValue><All></ParameterValue> </member> <member> <ParameterKey>TopicArn</ParameterKey> <UsePreviousValue>false</UsePreviousValue> <ParameterValue><New Topic></ParameterValue> </member> </Parameters> <Tags> <member> <Value>marketing</Value> <Key>business-unit</Key> </member> </Tags> <StackSetDriftDetectionDetails> <DriftDetectionStatus>COMPLETED</DriftDetectionStatus> <InSyncStackInstancesCount>5</InSyncStackInstancesCount> <FailedStackInstancesCount>0</FailedStackInstancesCount> <DriftStatus>IN_SYNC</DriftStatus> <TotalStackInstancesCount>5</TotalStackInstancesCount> <DriftedStackInstancesCount>0</DriftedStackInstancesCount> <InProgressStackInstancesCount>0</InProgressStackInstancesCount> <LastDriftCheckTimestamp>2019-12-03T20:00:27.877Z</LastDriftCheckTimestamp> </StackSetDriftDetectionDetails> <Status>ACTIVE</Status> </StackSet> </DescribeStackSetResult> <ResponseMetadata> <RequestId>48d13e76-794b-11e7-95e6-f946example</RequestId> </ResponseMetadata> </DescribeStackSetResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: