TrustedAdvisorPublicAPI / Client / list_organization_recommendations

list_organization_recommendations

TrustedAdvisorPublicAPI.Client.list_organization_recommendations(**kwargs)

List a filterable set of Recommendations within an Organization. This API only supports prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region.

See also: AWS API Documentation

Request Syntax

response = client.list_organization_recommendations(
    nextToken='string',
    maxResults=123,
    type='standard'|'priority',
    status='ok'|'warning'|'error',
    pillar='cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
    awsService='string',
    source='aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected'|'cost_optimization_hub',
    checkIdentifier='string',
    afterLastUpdatedAt=datetime(2015, 1, 1),
    beforeLastUpdatedAt=datetime(2015, 1, 1)
)

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.

• type (string) – The type of the Recommendation

• status (string) – The status of the Recommendation

• pillar (string) – The pillar of the Recommendation

• awsService (string) – The aws service associated with the Recommendation

• source (string) – The source of the Recommendation

• checkIdentifier (string) – The check identifier of the Recommendation

• afterLastUpdatedAt (datetime) – After the last update of the Recommendation

• beforeLastUpdatedAt (datetime) – Before the last update of the Recommendation

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'organizationRecommendationSummaries': [
        {
            'id': 'string',
            'type': 'standard'|'priority',
            'checkArn': 'string',
            'status': 'ok'|'warning'|'error',
            'lifecycleStage': 'in_progress'|'pending_response'|'dismissed'|'resolved',
            'pillars': [
                'cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
            ],
            'source': 'aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected'|'cost_optimization_hub',
            'awsServices': [
                'string',
            ],
            'name': 'string',
            'resourcesAggregates': {
                'okCount': 123,
                'warningCount': 123,
                'errorCount': 123,
                'excludedCount': 123
            },
            'pillarSpecificAggregates': {
                'costOptimizing': {
                    'estimatedMonthlySavings': 123.0,
                    'estimatedPercentMonthlySavings': 123.0
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'arn': '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.

  • organizationRecommendationSummaries (list) –

    The list of Recommendations

    • (dict) –

      Summary of recommendation for accounts within an Organization

      • id (string) –

        The ID which identifies where the Recommendation was produced

      • type (string) –

        Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

      • checkArn (string) –

        The AWS Trusted Advisor Check ARN that relates to the Recommendation

      • status (string) –

        The status of the Recommendation

      • lifecycleStage (string) –

        The lifecycle stage from AWS Trusted Advisor Priority

      • pillars (list) –

        The Pillars that the Recommendation is optimizing

        • (string) –

      • source (string) –

        The source of the Recommendation

      • awsServices (list) –

        The AWS Services that the Recommendation applies to

        • (string) –

      • name (string) –

        The name of the AWS Trusted Advisor Recommendation

      • resourcesAggregates (dict) –

        An aggregation of all resources

        • okCount (integer) –

          The number of AWS resources that were flagged to be OK according to the Trusted Advisor check

        • warningCount (integer) –

          The number of AWS resources that were flagged to have warning according to the Trusted Advisor check

        • errorCount (integer) –

          The number of AWS resources that were flagged to have errors according to the Trusted Advisor check

        • excludedCount (integer) –

          The number of AWS resources belonging to this Trusted Advisor check that were excluded by the customer

      • pillarSpecificAggregates (dict) –

        The pillar aggregations for cost savings

        • costOptimizing (dict) –

          Cost optimizing aggregates

          • estimatedMonthlySavings (float) –

            The estimated monthly savings

          • estimatedPercentMonthlySavings (float) –

            The estimated percently monthly savings

      • createdAt (datetime) –

        When the Recommendation was created, if created by AWS Trusted Advisor Priority

      • lastUpdatedAt (datetime) –

        When the Recommendation was last updated

      • arn (string) –

        The ARN of the Recommendation

Exceptions

• TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException

• TrustedAdvisorPublicAPI.Client.exceptions.InternalServerException

• TrustedAdvisorPublicAPI.Client.exceptions.ValidationException

• TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException