List Recommendation Templates

resiliencehub_list_recommendation_templates

R Documentation

Lists the recommendation templates for the Resilience Hub applications

Description

Lists the recommendation templates for the Resilience Hub applications.

Usage

resiliencehub_list_recommendation_templates(assessmentArn, maxResults,
  name, nextToken, recommendationTemplateArn, reverseOrder, status)

Arguments

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 Amazon Web Services General Reference guide.

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.

name

The name for one of the listed recommendation templates.

nextToken

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

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.

Value

A list with the following syntax:

list(
  nextToken = "string",
  recommendationTemplates = list(
    list(
      appArn = "string",
      assessmentArn = "string",
      endTime = as.POSIXct(
        "2015-01-01"
      ),
      format = "CfnYaml"|"CfnJson",
      message = "string",
      name = "string",
      needsReplacements = TRUE|FALSE,
      recommendationIds = list(
        "string"
      ),
      recommendationTemplateArn = "string",
      recommendationTypes = list(
        "Alarm"|"Sop"|"Test"
      ),
      startTime = as.POSIXct(
        "2015-01-01"
      ),
      status = "Pending"|"InProgress"|"Failed"|"Success",
      tags = list(
        "string"
      ),
      templatesLocation = list(
        bucket = "string",
        prefix = "string"
      )
    )
  )
)

Request syntax

svc$list_recommendation_templates(
  assessmentArn = "string",
  maxResults = 123,
  name = "string",
  nextToken = "string",
  recommendationTemplateArn = "string",
  reverseOrder = TRUE|FALSE,
  status = list(
    "Pending"|"InProgress"|"Failed"|"Success"
  )
)