List Alarm Recommendations

resiliencehub_list_alarm_recommendations

R Documentation

Lists the alarm recommendations for an Resilience Hub application¶

Description¶

Lists the alarm recommendations for an Resilience Hub application.

Usage¶

resiliencehub_list_alarm_recommendations(assessmentArn, maxResults,
  nextToken)

Arguments¶

assessmentArn

[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

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

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

Value¶

A list with the following syntax:

list(
  alarmRecommendations = list(
    list(
      appComponentName = "string",
      appComponentNames = list(
        "string"
      ),
      description = "string",
      items = list(
        list(
          alreadyImplemented = TRUE|FALSE,
          discoveredAlarm = list(
            alarmArn = "string",
            source = "string"
          ),
          excludeReason = "AlreadyImplemented"|"NotRelevant"|"ComplexityOfImplementation",
          excluded = TRUE|FALSE,
          latestDiscoveredExperiment = list(
            experimentArn = "string",
            experimentTemplateId = "string"
          ),
          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"
)

Request syntax¶

svc$list_alarm_recommendations(
  assessmentArn = "string",
  maxResults = 123,
  nextToken = "string"
)