describe_stack_resources¶
Operation¶
describe_stack_resources
async
¶
describe_stack_resources(request: DescribeStackResourcesInput | DescribeStackResourcesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeStackResourcesOutput
describe_stack_resources(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeStackResourcesInputDict]) -> DescribeStackResourcesOutput
Returns Amazon Web Services resource descriptions for running and
deleted stacks. If StackName is specified, all the associated
resources that are part of the stack are returned. If
PhysicalResourceId is specified, the associated resources of the stack
that the resource belongs to are returned.
Note
Only the first 100 resources will be returned. If your stack has more
resources than this, you should use ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource
information for up to 90 days after the stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not
both. In addition, you can specify LogicalResourceId to filter the
returned result. For more information about resources, the
LogicalResourceId and PhysicalResourceId, see the CloudFormation
User
Guide.
Note
A ValidationError is returned if you specify both StackName and
PhysicalResourceId in the same request.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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 |
|---|---|
DescribeStackResourcesOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeStackResourcesInput
dataclass
¶
Bases: _SerdeShape
The input for DescribeStackResources action.
Attributes¶
logical_resource_id
class-attribute
instance-attribute
¶
logical_resource_id: str | None = ...
The logical name of the resource as specified in the template.
physical_resource_id
class-attribute
instance-attribute
¶
physical_resource_id: str | None = ...
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance,
PhysicalResourceId corresponds to the InstanceId. You can pass the
EC2 InstanceId to DescribeStackResources to find which stack the
instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId, you
must specify StackName.
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.
Required: Conditional. If you don't specify StackName, you must
specify PhysicalResourceId.
Dictionaries¶
DescribeStackResourcesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeStackResourcesInput.
Attributes¶
logical_resource_id
instance-attribute
¶
logical_resource_id: str | None
The logical name of the resource as specified in the template.
physical_resource_id
instance-attribute
¶
physical_resource_id: str | None
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance,
PhysicalResourceId corresponds to the InstanceId. You can pass the
EC2 InstanceId to DescribeStackResources to find which stack the
instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId, you
must specify StackName.
stack_name
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.
Required: Conditional. If you don't specify StackName, you must
specify PhysicalResourceId.
Output¶
DescribeStackResourcesOutput
dataclass
¶
Bases: _SerdeShape
The output for a DescribeStackResources action.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
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_resources
class-attribute
instance-attribute
¶
stack_resources: list[StackResource] | None = ...
A list of StackResource structures.