CloudFormation / Paginator / ListResourceScanResources

ListResourceScanResources

class CloudFormation.Paginator.ListResourceScanResources

paginator = client.get_paginator('list_resource_scan_resources')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudFormation.Client.list_resource_scan_resources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceScanId='string',
    ResourceIdentifier='string',
    ResourceTypePrefix='string',
    TagKey='string',
    TagValue='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ResourceScanId (string) –

  [REQUIRED]

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

• ResourceIdentifier (string) – 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 (string) – If specified, the returned resources will be of any of the resource types with the specified prefix.

• TagKey (string) – If specified, the returned resources will have a matching tag key.

• TagValue (string) – If specified, the returned resources will have a matching tag value.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Resources': [
        {
            'ResourceType': 'string',
            'ResourceIdentifier': {
                'string': 'string'
            },
            'ManagedByStack': True|False
        },
    ],

}

Response Structure

• (dict) –

  • Resources (list) –

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

    • (dict) –

      A scanned resource returned by ListResourceScanResources or ListResourceScanRelatedResources.

      • ResourceType (string) –

        The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide

      • ResourceIdentifier (dict) –

        A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

        • (string) –

          • (string) –

      • ManagedByStack (boolean) –

        If true, the resource is managed by a CloudFormation stack.