WellArchitected / Paginator / ListAgentRecommendationGenerations

ListAgentRecommendationGenerations

class WellArchitected.Paginator.ListAgentRecommendationGenerations

paginator = client.get_paginator('list_agent_recommendation_generations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    profileArn='string',
    recommendationType='RESOURCE'|'ARCHITECTURE'|'APPLICATION',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• profileArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the optimization profile to list generation processes for.

• recommendationType (string) – Optional filter by recommendation 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',
            'profileArn': 'string',
            'name': 'string',
            'status': 'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'ERROR',
            'estimatedCompletionTime': datetime(2015, 1, 1),
            '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 generation summaries.

    • (dict) –

      Summary of a recommendation generation process initiated through the agent API.

      • id (string) –

        The unique identifier of the recommendation generation.

      • profileArn (string) –

        The Amazon Resource Name (ARN) of the profile used for this generation.

      • name (string) –

        The name of the recommendation generation.

      • status (string) –

        The current status of the recommendation generation.

      • estimatedCompletionTime (datetime) –

        The estimated time for the generation to complete.

      • createdBy (string) –

        The identifier of the user or system that started this generation.

      • createdAt (datetime) –

        The timestamp when the generation was started.

      • lastModifiedBy (string) –

        The identifier of the user or system that last modified this generation.

      • lastModifiedAt (datetime) –

        The timestamp when the generation was last modified.

  • NextToken (string) –

    A token to resume pagination.