ResilienceHub / Client / list_recommendation_templates

list_recommendation_templates#

ResilienceHub.Client.list_recommendation_templates(**kwargs)#

Lists the recommendation templates for the Resilience Hub applications.

See also: AWS API Documentation

Request Syntax

response = client.list_recommendation_templates(
    assessmentArn='string',
    maxResults=123,
    name='string',
    nextToken='string',
    recommendationTemplateArn='string',
    reverseOrder=True|False,
    status=[
        'Pending'|'InProgress'|'Failed'|'Success',
    ]
)
Parameters:

  • assessmentArn (string) – 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.

  • name (string) – The name for one of the listed recommendation templates.

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

  • recommendationTemplateArn (string) – The Amazon Resource Name (ARN) for a recommendation template.

  • reverseOrder (boolean) – The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

  • status (list) –

    Status of the action.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'recommendationTemplates': [
        {
            'appArn': 'string',
            'assessmentArn': 'string',
            'endTime': datetime(2015, 1, 1),
            'format': 'CfnYaml'|'CfnJson',
            'message': 'string',
            'name': 'string',
            'needsReplacements': True|False,
            'recommendationIds': [
                'string',
            ],
            'recommendationTemplateArn': 'string',
            'recommendationTypes': [
                'Alarm'|'Sop'|'Test',
            ],
            'startTime': datetime(2015, 1, 1),
            'status': 'Pending'|'InProgress'|'Failed'|'Success',
            'tags': {
                'string': 'string'
            },
            'templatesLocation': {
                'bucket': 'string',
                'prefix': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

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

    • recommendationTemplates (list) –

      The recommendation templates for the Resilience Hub applications.

      • (dict) –

        Defines a recommendation template created with the CreateRecommendationTemplate action.

        • appArn (string) –

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

        • assessmentArn (string) –

          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.

        • endTime (datetime) –

          The end time for the action.

        • format (string) –

          Format of the recommendation template.

          CfnJson

          The template is CloudFormation JSON.

          CfnYaml

          The template is CloudFormation YAML.

        • message (string) –

          Message for the recommendation template.

        • name (string) –

          Name for the recommendation template.

        • needsReplacements (boolean) –

          Indicates if replacements are needed.

        • recommendationIds (list) –

          Identifiers for the recommendations used in the recommendation template.

          • (string) –

        • recommendationTemplateArn (string) –

          Amazon Resource Name (ARN) for the recommendation template.

        • recommendationTypes (list) –

          An array of strings that specify the recommendation template type or types.

          Alarm

          The template is an AlarmRecommendation template.

          Sop

          The template is a SopRecommendation template.

          Test

          The template is a TestRecommendation template.

          • (string) –

        • startTime (datetime) –

          The start time for the action.

        • status (string) –

          Status of the action.

        • tags (dict) –

          Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

          • (string) –

            • (string) –

        • templatesLocation (dict) –

          The file location of the template.

          • bucket (string) –

            The name of the Amazon S3 bucket.

          • prefix (string) –

            The prefix for the Amazon S3 bucket.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException

  • ResilienceHub.Client.exceptions.ThrottlingException

  • ResilienceHub.Client.exceptions.ValidationException

  • ResilienceHub.Client.exceptions.AccessDeniedException