Skip to content

Get Recommendations

codeguruprofiler_get_recommendations R Documentation

Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period

Description

Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned.

Usage

codeguruprofiler_get_recommendations(endTime, locale,
  profilingGroupName, startTime)

Arguments

endTime

[required] The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

locale

The language used to provide analysis. Specify using a string that is one of the following ⁠BCP 47⁠ language codes.

  • de-DE - German, Germany

  • en-GB - English, United Kingdom

  • en-US - English, United States

  • es-ES - Spanish, Spain

  • fr-FR - French, France

  • it-IT - Italian, Italy

  • ja-JP - Japanese, Japan

  • ko-KR - Korean, Republic of Korea

  • pt-BR - Portugese, Brazil

  • zh-CN - Chinese, China

  • zh-TW - Chinese, Taiwan

profilingGroupName

[required] The name of the profiling group to get analysis data about.

startTime

[required] The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Value

A list with the following syntax: 

list(
  anomalies = list(
    list(
      instances = list(
        list(
          endTime = as.POSIXct(
            "2015-01-01"
          ),
          id = "string",
          startTime = as.POSIXct(
            "2015-01-01"
          ),
          userFeedback = list(
            type = "Positive"|"Negative"
          )
        )
      ),
      metric = list(
        frameName = "string",
        threadStates = list(
          "string"
        ),
        type = "AggregatedRelativeTotalTime"
      ),
      reason = "string"
    )
  ),
  profileEndTime = as.POSIXct(
    "2015-01-01"
  ),
  profileStartTime = as.POSIXct(
    "2015-01-01"
  ),
  profilingGroupName = "string",
  recommendations = list(
    list(
      allMatchesCount = 123,
      allMatchesSum = 123.0,
      endTime = as.POSIXct(
        "2015-01-01"
      ),
      pattern = list(
        countersToAggregate = list(
          "string"
        ),
        description = "string",
        id = "string",
        name = "string",
        resolutionSteps = "string",
        targetFrames = list(
          list(
            "string"
          )
        ),
        thresholdPercent = 123.0
      ),
      startTime = as.POSIXct(
        "2015-01-01"
      ),
      topMatches = list(
        list(
          frameAddress = "string",
          targetFramesIndex = 123,
          thresholdBreachValue = 123.0
        )
      )
    )
  )
)

Request syntax

svc$get_recommendations(
  endTime = as.POSIXct(
    "2015-01-01"
  ),
  locale = "string",
  profilingGroupName = "string",
  startTime = as.POSIXct(
    "2015-01-01"
  )
)