Skip to content

CloudFormation  >  Operations  >  describe_stack_set

describe_stack_set

Operation

describe_stack_set async 

describe_stack_set(input: DescribeStackSetInput, plugins: list[Plugin] | None = None) -> DescribeStackSetOutput

Returns the description of the specified StackSet.

Note

This API provides strongly consistent reads meaning it will always return the most up-to-date data.

Parameters:

Name Type Description Default
input DescribeStackSetInput

An instance of DescribeStackSetInput.

 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
DescribeStackSetOutput

An instance of DescribeStackSetOutput.

Input

DescribeStackSetInput dataclass

Bases: _SerdeShape

Dataclass for DescribeStackSetInput 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_set_name class-attribute instance-attribute 
stack_set_name: str | None = ...

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

Output

DescribeStackSetOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeStackSetOutput 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_set class-attribute instance-attribute 
stack_set: StackSet | None = ...

The specified StackSet.