Skip to content

CloudFormation  >  Operations  >  list_stack_resources

list_stack_resources

Operation

list_stack_resources async

list_stack_resources(input: ListStackResourcesInput, plugins: list[Plugin] | None = None) -> ListStackResourcesOutput

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.

Parameters:

Name Type Description Default
input ListStackResourcesInput

An instance of ListStackResourcesInput.

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
ListStackResourcesOutput

An instance of ListStackResourcesOutput.

Input

ListStackResourcesInput dataclass

Bases: _SerdeShape

The input for the ListStackResource action.

Attributes

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

The token for the next set of items to return. (You received this token from a previous call.)

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

The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Output

ListStackResourcesOutput dataclass

Bases: _SerdeShape

The output for a ListStackResources action.

Attributes

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

If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.

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_resource_summaries class-attribute instance-attribute
stack_resource_summaries: list[StackResourceSummary] | None = ...

A list of StackResourceSummary structures.