WellArchitected / Paginator / ListAgentRecommendationItems

ListAgentRecommendationItems¶

class WellArchitected.Paginator.ListAgentRecommendationItems¶

paginator = client.get_paginator('list_agent_recommendation_items')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from WellArchitected.Client.list_agent_recommendation_items().

Request Syntax

response_iterator = paginator.paginate(
    recommendationArn='string',
    type='AWS_RESOURCE'|'RECOMMENDATION',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

recommendationArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the recommendation to list items for.
type (string) – Optional filter to return only recommendation items of the specified type.
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

{
    'items': [
        {
            'id': 'string',
            'recommendationArn': 'string',
            'type': 'AWS_RESOURCE'|'RECOMMENDATION',
            'metadata': {...}|[...]|123|123.4|'string'|True|None,
            'createdBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastModifiedBy': 'string',
            'lastModifiedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  A list of recommendation items with their detailed metadata and configuration information.
  - (dict) –
    
    Summary of an agent recommendation item, representing an Amazon Web Services resource or recommendation affected by the optimization recommendation.
    - id (string) –
      
      The unique identifier of the recommendation item.
    - recommendationArn (string) –
      
      The Amazon Resource Name (ARN) of the associated recommendation.
    - type (string) –
      
      The type of the recommendation item.
    - metadata (document) –
      
      Metadata containing a snapshot of the resource or recommendation at the time of generation.
    - createdBy (string) –
      
      The identifier of the user or system that created this recommendation item.
    - createdAt (datetime) –
      
      The timestamp when the recommendation item was created.
    - lastModifiedBy (string) –
      
      The identifier of the user or system that last modified this recommendation item.
    - lastModifiedAt (datetime) –
      
      The timestamp when the recommendation item was last modified.
- NextToken (string) –
  
  A token to resume pagination.