CloudFormation / Paginator / ListResourceScanRelatedResources

ListResourceScanRelatedResources

class CloudFormation.Paginator.ListResourceScanRelatedResources

paginator = client.get_paginator('list_resource_scan_related_resources')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceScanId='string',
    Resources=[
        {
            'ResourceType': 'string',
            'ResourceIdentifier': {
                'string': 'string'
            }
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ResourceScanId (string) –

  [REQUIRED]

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

• Resources (list) –

  [REQUIRED]

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

  • (dict) –

    Identifies a scanned resource. This is used with the ListResourceScanRelatedResources API action.

    • ResourceType (string) – [REQUIRED]

      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) – [REQUIRED]

      A list of up to 256 key-value pairs that identifies 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) –

• 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

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

}

Response Structure

• (dict) –

  • RelatedResources (list) –

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

    • (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 Resource type support 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.