Skip to content

CloudFormation  >  Operations  >  describe_stack_instance

describe_stack_instance

Operation

describe_stack_instance async 

describe_stack_instance(input: DescribeStackInstanceInput, plugins: list[Plugin] | None = None) -> DescribeStackInstanceOutput

Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.

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

Parameters:

Name Type Description Default
input DescribeStackInstanceInput

An instance of DescribeStackInstanceInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DescribeStackInstanceOutput

An instance of DescribeStackInstanceOutput.

Input

DescribeStackInstanceInput dataclass

Bases: _SerdeShape

Dataclass for DescribeStackInstanceInput structure.

Attributes

call_as class-attribute instance-attribute 
call_as: str | None = ...

[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 StackSets 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.

stack_instance_account class-attribute instance-attribute 
stack_instance_account: str | None = ...

The ID of an Amazon Web Services account that's associated with this stack instance.

stack_instance_region class-attribute instance-attribute 
stack_instance_region: str | None = ...

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

stack_set_name class-attribute instance-attribute 
stack_set_name: str | None = ...

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

Output

DescribeStackInstanceOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeStackInstanceOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

stack_instance class-attribute instance-attribute 
stack_instance: StackInstance | None = ...

The stack instance that matches the specified request parameters.