ResilienceHubV2 / Paginator / ListResources

ListResources¶

class ResilienceHubV2.Paginator.ListResources¶

paginator = client.get_paginator('list_resources')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from ResilienceHubV2.Client.list_resources().

Request Syntax

response_iterator = paginator.paginate(
    serviceArn='string',
    serviceFunctionId='string',
    awsRegion='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

serviceArn (string) –
[REQUIRED]

ARN identifier.
serviceFunctionId (string) – Filter resources by service function identifier.
awsRegion (string) – Filter resources by AWS Region.
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

{
    'serviceFunctionId': 'string',
    'serviceResources': [
        {
            'resourceIdentifier': 'string',
            'inputSource': {
                'identifier': 'string',
                'type': 'CFN_STACK'|'TAGS'|'EKS'|'TERRAFORM'|'DESIGN_FILE'|'MONITORING'
            },
            'resource': {
                'identifier': 'string',
                'awsRegion': 'string',
                'awsAccountId': 'string',
                'resourceType': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- serviceFunctionId (string) –
  
  The service function identifier for the returned resources.
- serviceResources (list) –
  
  The list of service resources.
  - (dict) –
    
    Represents a resource associated with a service.
    - resourceIdentifier (string) –
      
      The identifier of the resource.
    - inputSource (dict) –
      
      The input source that discovered the resource.
      - identifier (string) –
        
        The identifier of the input source.
      - type (string) –
        
        The type of the input source.
    - resource (dict) –
      
      The resource details.
      - identifier (string) –
        
        The identifier of the resource.
      - awsRegion (string) –
        
        The AWS Region where the resource is located.
      - awsAccountId (string) –
        
        The AWS account ID that owns the resource.
      - resourceType (string) –
        
        The type of the resource.
- NextToken (string) –
  
  A token to resume pagination.