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

DescribeStackInstance

Returns the stack instance that's associated with the specified stack set, AWS account, and region.

For a list of stack instances that are associated with a specific stack set, use ListStackInstances.

Request Parameters

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

StackInstanceAccount

The ID of an AWS account that's associated with this stack instance.

Type: String

Pattern: [0-9]{12}

Required: Yes

StackInstanceRegion

The name of a region that's associated with this stack instance.

Type: String

Required: Yes

StackSetName

The name or the unique stack ID of the stack set that you want to get stack instance information for.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

StackInstance

The stack instance that matches the specified request parameters.

Type: StackInstance object

Errors

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

StackInstanceNotFound

The specified stack instance doesn't exist.

HTTP Status Code: 404

StackSetNotFound

The specified stack set doesn't exist.

HTTP Status Code: 404

Example

DescribeStackInstance

Sample Request


https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeStackInstance
 &StackInstanceRegion=us-west-2
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &StackInstanceAccount=[account]
 &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


<DescribeStackInstanceResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <DescribeStackInstanceResult>
    <StackInstance>
      <StackId>arn:aws:cloudformation:us-west-2:[account]:stack/StackSet-a3c97291-8df5-448e-b576-8c7cexample/f857db10-793e-11e7-ab1a-50d5example</StackId>
      <StackSetId>stack-set-example:c14cd6d1-cd17-40bd-82ed-ff97dexample</StackSetId>
      <Region>us-west-2</Region>
      <Account>[account]</Account>
      <Status>CURRENT</Status>
    </StackInstance>
  </DescribeStackInstanceResult>
  <ResponseMetadata>
    <RequestId>2ede1ddf-7e19-11e7-bcf2-8951example</RequestId>
  </ResponseMetadata>
</DescribeStackInstanceResponse>

         
         

See Also

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