ResilienceHub / Client / list_alarm_recommendations

list_alarm_recommendations#

ResilienceHub.Client.list_alarm_recommendations(**kwargs)#

Lists the alarm recommendations for an Resilience Hub application.

See also: AWS API Documentation

Request Syntax

response = client.list_alarm_recommendations(
    assessmentArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • assessmentArn (string) –

    [REQUIRED]

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition:resiliencehub: region: account:app-assessment/ app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • maxResults (integer) – Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • nextToken (string) – Null, or the token from a previous call to get the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'alarmRecommendations': [
        {
            'appComponentName': 'string',
            'appComponentNames': [
                'string',
            ],
            'description': 'string',
            'items': [
                {
                    'alreadyImplemented': True|False,
                    'excludeReason': 'AlreadyImplemented'|'NotRelevant'|'ComplexityOfImplementation',
                    'excluded': True|False,
                    'resourceId': 'string',
                    'targetAccountId': 'string',
                    'targetRegion': 'string'
                },
            ],
            'name': 'string',
            'prerequisite': 'string',
            'recommendationId': 'string',
            'recommendationStatus': 'Implemented'|'Inactive'|'NotImplemented'|'Excluded',
            'referenceId': 'string',
            'type': 'Metric'|'Composite'|'Canary'|'Logs'|'Event'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • alarmRecommendations (list) –

      The alarm recommendations for an Resilience Hub application, returned as an object. This object includes Application Component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.

      • (dict) –

        Defines a recommendation for a CloudWatch alarm.

        • appComponentName (string) –

          Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item in the appComponentNames list.

        • appComponentNames (list) –

          List of Application Component names for the CloudWatch alarm recommendation.

          • (string) –

        • description (string) –

          Description of the alarm recommendation.

        • items (list) –

          List of CloudWatch alarm recommendations.

          • (dict) –

            Defines a recommendation.

            • alreadyImplemented (boolean) –

              Specifies if the recommendation has already been implemented.

            • excludeReason (string) –

              Indicates the reason for excluding an operational recommendation.

            • excluded (boolean) –

              Indicates if an operational recommendation item is excluded.

            • resourceId (string) –

              Identifier of the resource.

            • targetAccountId (string) –

              Identifier of the target account.

            • targetRegion (string) –

              The target region.

        • name (string) –

          Name of the alarm recommendation.

        • prerequisite (string) –

          The prerequisite for the alarm recommendation.

        • recommendationId (string) –

          Identifier of the alarm recommendation.

        • recommendationStatus (string) –

          Status of the recommended Amazon CloudWatch alarm.

        • referenceId (string) –

          Reference identifier of the alarm recommendation.

        • type (string) –

          Type of alarm recommendation.

    • nextToken (string) –

      Token for the next set of results, or null if there are no more results.

Exceptions