Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListRecommendationTemplates

Lists the recommendation templates for the AWS Resilience Hub applications.

Request Syntax


GET /list-recommendation-templates?assessmentArn=assessmentArn&maxResults=maxResults&name=name&nextToken=nextToken&recommendationTemplateArn=recommendationTemplateArn&reverseOrder=reverseOrder&status=status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

assessmentArn

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.

Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}$

maxResults

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.

Valid Range: Minimum value of 1. Maximum value of 100.

name

The name for one of the listed recommendation templates.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$

nextToken

Null, or the token from a previous call to get the next set of results.

Pattern: ^\S{1,2000}$

recommendationTemplateArn

The Amazon Resource Name (ARN) for a recommendation template.

reverseOrder

The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

status

Status of the action.

Array Members: Minimum number of 1 item. Maximum number of 4 items.

Valid Values: Pending | InProgress | Failed | Success

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "recommendationTemplates": [ 
      { 
         "appArn": "string",
         "assessmentArn": "string",
         "endTime": number,
         "format": "string",
         "message": "string",
         "name": "string",
         "needsReplacements": boolean,
         "recommendationIds": [ "string" ],
         "recommendationTemplateArn": "string",
         "recommendationTypes": [ "string" ],
         "startTime": number,
         "status": "string",
         "tags": { 
            "string" : "string" 
         },
         "templatesLocation": { 
            "bucket": "string",
            "prefix": "string"
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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

Type: String

Pattern: ^\S{1,2000}$

recommendationTemplates

The recommendation templates for the AWS Resilience Hub applications.

Type: Array of RecommendationTemplate objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the AWS Resilience Hub service.

HTTP Status Code: 500

ThrottlingException

This exception occurs when you have exceeded the limit on the number of requests per second.

HTTP Status Code: 429

ValidationException

This exception occurs when a request is not valid.

HTTP Status Code: 400