AWS CloudFormation
API Reference (API Version 2010-05-15)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

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.

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

Example

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> <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: