TrustedAdvisorPublicAPI / Client / list_recommendation_resources

list_recommendation_resources

TrustedAdvisorPublicAPI.Client.list_recommendation_resources(**kwargs)

List Resources of a Recommendation. This API provides global recommendations, eliminating the need to call the API in each AWS Region.

See also: AWS API Documentation

Request Syntax

response = client.list_recommendation_resources(
    nextToken='string',
    maxResults=123,
    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'
)
Parameters:

  • nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • maxResults (integer) – The maximum number of results to return per page.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    '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'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • 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

Exceptions

  • TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException

  • TrustedAdvisorPublicAPI.Client.exceptions.InternalServerException

  • TrustedAdvisorPublicAPI.Client.exceptions.ValidationException

  • TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException

  • TrustedAdvisorPublicAPI.Client.exceptions.ResourceNotFoundException