Skip to content

List Resource Scan Resources

cloudformation_list_resource_scan_resources R Documentation

Lists the resources from a resource scan

Description

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.

Usage

cloudformation_list_resource_scan_resources(ResourceScanId,
  ResourceIdentifier, ResourceTypePrefix, TagKey, TagValue, NextToken,
  MaxResults)

Arguments

ResourceScanId

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

ResourceIdentifier

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

ResourceTypePrefix

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

TagKey

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

TagValue

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

NextToken

A string that identifies the next page of resource scan results.

MaxResults

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 list_resource_scan_resources API action will return at most 100 results in each response. The maximum value is 100.

Value

A list with the following syntax: 

list(
  Resources = list(
    list(
      ResourceType = "string",
      ResourceIdentifier = list(
        "string"
      ),
      ManagedByStack = TRUE|FALSE
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_resource_scan_resources(
  ResourceScanId = "string",
  ResourceIdentifier = "string",
  ResourceTypePrefix = "string",
  TagKey = "string",
  TagValue = "string",
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# This example lists the resources in your resource scan
svc$list_resource_scan_resources(
  ResourceScanId = "arn:aws:cloudformation:us-east-1:123456789012:resourceS..."
)

# This example lists the resources in your resource scan filtering only
# the resources that start with the passed in prefix
svc$list_resource_scan_resources(
  ResourceScanId = "arn:aws:cloudformation:us-east-1:123456789012:resourceS...",
  ResourceTypePrefix = "AWS::S3"
)

## End(Not run)