Skip to content

list_resource_scan_related_resources

Operation

list_resource_scan_related_resources(request: ListResourceScanRelatedResourcesInput | ListResourceScanRelatedResourcesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListResourceScanRelatedResourcesInputDict]) -> ListResourceScanRelatedResourcesOutput

Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.

Parameters:

Name Type Description Default
request ListResourceScanRelatedResourcesInput | ListResourceScanRelatedResourcesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListResourceScanRelatedResourcesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListResourceScanRelatedResourcesOutput

An instance of ListResourceScanRelatedResourcesOutput.

list_resource_scan_related_resources(request: ListResourceScanRelatedResourcesInput | ListResourceScanRelatedResourcesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListResourceScanRelatedResourcesInputDict]) -> ListResourceScanRelatedResourcesOutput

Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.

Parameters:

Name Type Description Default
request ListResourceScanRelatedResourcesInput | ListResourceScanRelatedResourcesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListResourceScanRelatedResourcesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListResourceScanRelatedResourcesOutput

An instance of ListResourceScanRelatedResourcesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListResourceScanRelatedResourcesInputDict

Bases: TypedDict

Dictionary form of ListResourceScanRelatedResourcesInput.

Attributes

max_results 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 ListResourceScanRelatedResources API action will return up to 100 results in each response. The maximum value is 100.

next_token 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_scan_id instance-attribute
resource_scan_id: Required[str]

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

resources instance-attribute

The list of resources for which you want to get the related resources. Up to 100 resources can be provided.

ListResourceScanRelatedResourcesInput dataclass

Bases: _SerdeShape

Dataclass for ListResourceScanRelatedResourcesInput 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 ListResourceScanRelatedResources API action will return up to 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_scan_id class-attribute instance-attribute
resource_scan_id: str | None = ...

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

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

The list of resources for which you want to get the related resources. Up to 100 resources can be provided.

Output

ListResourceScanRelatedResourcesOutput dataclass

Bases: _SerdeShape

Dataclass for ListResourceScanRelatedResourcesOutput 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 ListResourceScanRelatedResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

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

List of up to MaxResults resources in the specified resource scan related to the specified resources.

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.