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.

list_test_recommendations

list_test_recommendations(**kwargs)

Lists the test recommendations for the AWS Resilience Hub application.

See also: AWS API Documentation

Request Syntax

response = client.list_test_recommendations(
    assessmentArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • assessmentArn (string) --

    [REQUIRED]

    The 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 AWS General Reference guide.

  • maxResults (integer) -- The 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

{
    'nextToken': 'string',
    'testRecommendations': [
        {
            'appComponentName': 'string',
            'dependsOnAlarms': [
                'string',
            ],
            'description': 'string',
            'intent': 'string',
            'items': [
                {
                    'alreadyImplemented': True|False,
                    'resourceId': 'string',
                    'targetAccountId': 'string',
                    'targetRegion': 'string'
                },
            ],
            'name': 'string',
            'prerequisite': 'string',
            'recommendationId': 'string',
            'referenceId': 'string',
            'risk': 'Small'|'Medium'|'High',
            'type': 'Software'|'Hardware'|'AZ'|'Region'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

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

    • testRecommendations (list) --

      The test recommendations for the AWS Resilience Hub application.

      • (dict) --

        Defines a test recommendation.

        • appComponentName (string) --

          The name of the Application Component.

        • dependsOnAlarms (list) --

          A list of recommended alarms that are used in the test and must be exported before or with the test.

          • (string) --
        • description (string) --

          The description for the test recommendation.

        • intent (string) --

          The intent of the test recommendation.

        • items (list) --

          The test recommendation items.

          • (dict) --

            Defines a recommendation.

            • alreadyImplemented (boolean) --

              Specifies if the recommendation has already been implemented.

            • resourceId (string) --

              The resource identifier.

            • targetAccountId (string) --

              The target account identifier.

            • targetRegion (string) --

              The target region.

        • name (string) --

          The name of the test recommendation.

        • prerequisite (string) --

          The prerequisite of the test recommendation.

        • recommendationId (string) --

          Identifier for the test recommendation.

        • referenceId (string) --

          The reference identifier for the test recommendation.

        • risk (string) --

          The level of risk for this test recommendation.

        • type (string) --

          The type of test recommendation.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException
  • ResilienceHub.Client.exceptions.ResourceNotFoundException
  • ResilienceHub.Client.exceptions.ConflictException
  • ResilienceHub.Client.exceptions.ThrottlingException
  • ResilienceHub.Client.exceptions.ValidationException
  • ResilienceHub.Client.exceptions.AccessDeniedException