TrustedAdvisorPublicAPI / Paginator / ListRecommendationResources

ListRecommendationResources

class TrustedAdvisorPublicAPI.Paginator.ListRecommendationResources

paginator = client.get_paginator('list_recommendation_resources')

paginate(**kwargs)

Creates an iterator that will paginate through responses from TrustedAdvisorPublicAPI.Client.list_recommendation_resources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    status='ok'|'warning'|'error',
    exclusionStatus='excluded'|'included',
    regionCode='string',
    recommendationIdentifier='string',
    language='en'|'ja'|'zh'|'fr'|'de'|'ko'|'zh_TW'|'it'|'es'|'pt_BR'|'id',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• status (string) – The status of the resource

• exclusionStatus (string) – The exclusion status of the resource

• regionCode (string) – The AWS Region code of the resource

• recommendationIdentifier (string) –

  [REQUIRED]

  The Recommendation identifier

• language (string) – The ISO 639-1 code for the language that you want your recommendations to appear in.

• 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

{
    'recommendationResourceSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'awsResourceId': 'string',
            'regionCode': 'string',
            'status': 'ok'|'warning'|'error',
            'metadata': {
                'string': 'string'
            },
            'lastUpdatedAt': datetime(2015, 1, 1),
            'exclusionStatus': 'excluded'|'included',
            'recommendationArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • recommendationResourceSummaries (list) –

    A list of Recommendation Resources

    • (dict) –

      Summary of a Recommendation Resource

      • id (string) –

        The ID of the Recommendation Resource

      • arn (string) –

        The ARN of the Recommendation Resource

      • awsResourceId (string) –

        The AWS resource identifier. There are certain checks that generate recommendation resources without an awsResourceId.

      • regionCode (string) –

        The AWS Region code that the Recommendation Resource is in

      • status (string) –

        The current status of the Recommendation Resource

      • metadata (dict) –

        Metadata associated with the Recommendation Resource

        • (string) –

          • (string) –

      • lastUpdatedAt (datetime) –

        When the Recommendation Resource was last updated

      • exclusionStatus (string) –

        The exclusion status of the Recommendation Resource

      • recommendationArn (string) –

        The Recommendation ARN

  • NextToken (string) –

    A token to resume pagination.