Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

ListRecommendations

class DevOpsGuru.Paginator.ListRecommendations
paginator = client.get_paginator('list_recommendations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsGuru.Client.list_recommendations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InsightId='string',
    Locale='DE_DE'|'EN_US'|'EN_GB'|'ES_ES'|'FR_FR'|'IT_IT'|'JA_JP'|'KO_KR'|'PT_BR'|'ZH_CN'|'ZH_TW',
    AccountId='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InsightId (string) --

    [REQUIRED]

    The ID of the requested insight.

  • Locale (string) -- A locale that specifies the language to use for recommendations.
  • AccountId (string) -- The ID of the Amazon Web Services account.
  • 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.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Recommendations': [
        {
            'Description': 'string',
            'Link': 'string',
            'Name': 'string',
            'Reason': 'string',
            'RelatedEvents': [
                {
                    'Name': 'string',
                    'Resources': [
                        {
                            'Name': 'string',
                            'Type': 'string'
                        },
                    ]
                },
            ],
            'RelatedAnomalies': [
                {
                    'Resources': [
                        {
                            'Name': 'string',
                            'Type': 'string'
                        },
                    ],
                    'SourceDetails': [
                        {
                            'CloudWatchMetrics': [
                                {
                                    'MetricName': 'string',
                                    'Namespace': 'string'
                                },
                            ]
                        },
                    ],
                    'AnomalyId': 'string'
                },
            ],
            'Category': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • Recommendations (list) --

      An array of the requested recommendations.

      • (dict) --

        Recommendation information to help you remediate detected anomalous behavior that generated an insight.

        • Description (string) --

          A description of the problem.

        • Link (string) --

          A hyperlink to information to help you address the problem.

        • Name (string) --

          The name of the recommendation.

        • Reason (string) --

          The reason DevOps Guru flagged the anomalous behavior as a problem.

        • RelatedEvents (list) --

          Events that are related to the problem. Use these events to learn more about what's happening and to help address the issue.

          • (dict) --

            Information about an event that is related to a recommendation.

            • Name (string) --

              The name of the event. This corresponds to the Name field in an Event object.

            • Resources (list) --

              A ResourceCollection object that contains arrays of the names of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

              • (dict) --

                Information about an Amazon Web Services resource that emitted and event that is related to a recommendation in an insight.

                • Name (string) --

                  The name of the resource that emitted the event. This corresponds to the Name field in an EventResource object.

                • Type (string) --

                  The type of the resource that emitted the event. This corresponds to the Type field in an EventResource object.

        • RelatedAnomalies (list) --

          Anomalies that are related to the problem. Use these Anomalies to learn more about what's happening and to help address the issue.

          • (dict) --

            Information about an anomaly that is related to a recommendation.

            • Resources (list) --

              An array of objects that represent resources in which DevOps Guru detected anomalous behavior. Each object contains the name and type of the resource.

              • (dict) --

                Information about a resource in which DevOps Guru detected anomalous behavior.

                • Name (string) --

                  The name of the resource.

                • Type (string) --

                  The type of the resource. Resource types take the same form that is used by Amazon Web Services CloudFormation resource type identifiers, service-provider::service-name::data-type-name . For example, AWS::RDS::DBCluster . For more information, see Amazon Web Services resource and property types reference in the Amazon Web Services CloudFormation User Guide .

            • SourceDetails (list) --

              Information about where the anomalous behavior related the recommendation was found. For example, details in Amazon CloudWatch metrics.

              • (dict) --

                Contains an array of RecommendationRelatedCloudWatchMetricsSourceDetail objects that contain the name and namespace of an Amazon CloudWatch metric.

                • CloudWatchMetrics (list) --

                  An array of CloudWatchMetricsDetail objects that contains information about the analyzed metrics that displayed anomalous behavior.

                  • (dict) --

                    Information about an Amazon CloudWatch metric that is analyzed by DevOps Guru. It is one of many analyzed metrics that are used to generate insights.

                    • MetricName (string) --

                      The name of the CloudWatch metric.

                    • Namespace (string) --

                      The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.

            • AnomalyId (string) --

              The ID of an anomaly that generated the insight with this recommendation.

        • Category (string) --

          The category type of the recommendation.