Skip to content

CloudFormation  >  Operations  >  list_resource_scan_resources

list_resource_scan_resources

Operation

list_resource_scan_resources async

list_resource_scan_resources(input: ListResourceScanResourcesInput, plugins: list[Plugin] | None = None) -> ListResourceScanResourcesOutput

Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.

Parameters:

Name Type Description Default
input ListResourceScanResourcesInput

An instance of ListResourceScanResourcesInput.

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
ListResourceScanResourcesOutput

An instance of ListResourceScanResourcesOutput.

Input

ListResourceScanResourcesInput dataclass

Bases: _SerdeShape

Dataclass for ListResourceScanResourcesInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListResourceScanResources API action will return at most 100 results in each response. The maximum value is 100.

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.)

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

If specified, the returned resources will have the specified resource identifier (or one of them in the case where the resource has multiple identifiers).

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

The Amazon Resource Name (ARN) of the resource scan.

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

If specified, the returned resources will be of any of the resource types with the specified prefix.

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

If specified, the returned resources will have a matching tag key.

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

If specified, the returned resources will have a matching tag value.

Output

ListResourceScanResourcesOutput dataclass

Bases: _SerdeShape

Dataclass for ListResourceScanResourcesOutput structure.

Attributes

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

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScanResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

resources class-attribute instance-attribute
resources: list[ScannedResource] | None = ...

List of up to MaxResults resources in the specified resource scan that match all of the specified filters.

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.