Describe Db Recommendations

rds_describe_db_recommendations

R Documentation

Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups

Description

Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.

Usage

rds_describe_db_recommendations(LastUpdatedAfter, LastUpdatedBefore,
  Locale, Filters, MaxRecords, Marker)

Arguments

LastUpdatedAfter

A filter to include only the recommendations that were updated after this specified time.

LastUpdatedBefore

A filter to include only the recommendations that were updated before this specified time.

Locale

The language that you choose to return the list of recommendations.

Valid values:

• en

• en_UK

• de

• es

• fr

• id

• it

• ja

• ko

• pt_BR

• zh_TW

• zh_CN

Filters

A filter that specifies one or more recommendations to describe.

Supported Filters:

• recommendation-id - Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values.

• status - Accepts a list of recommendation statuses.

  Valid values:

  • active - The recommendations which are ready for you to apply.

  • pending - The applied or scheduled recommendations which are in progress.

  • resolved - The recommendations which are completed.

  • dismissed - The recommendations that you dismissed.

  The results list only includes the recommendations whose status is one of the specified filter values.

• severity - Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.

  Valid values:

  • high

  • medium

  • low

  • informational

• type-id - Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values.

• dbi-resource-id - Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases.

• cluster-resource-id - Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters.

• pg-arn - Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups.

• cluster-pg-arn - Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.

MaxRecords

The maximum number of recommendations to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Marker

An optional pagination token provided by a previous describe_db_recommendations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Value

A list with the following syntax:

list(
  DBRecommendations = list(
    list(
      RecommendationId = "string",
      TypeId = "string",
      Severity = "string",
      ResourceArn = "string",
      Status = "string",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      Detection = "string",
      Recommendation = "string",
      Description = "string",
      Reason = "string",
      RecommendedActions = list(
        list(
          ActionId = "string",
          Title = "string",
          Description = "string",
          Operation = "string",
          Parameters = list(
            list(
              Key = "string",
              Value = "string"
            )
          ),
          ApplyModes = list(
            "string"
          ),
          Status = "string",
          IssueDetails = list(
            PerformanceIssueDetails = list(
              StartTime = as.POSIXct(
                "2015-01-01"
              ),
              EndTime = as.POSIXct(
                "2015-01-01"
              ),
              Metrics = list(
                list(
                  Name = "string",
                  References = list(
                    list(
                      Name = "string",
                      ReferenceDetails = list(
                        ScalarReferenceDetails = list(
                          Value = 123.0
                        )
                      )
                    )
                  ),
                  StatisticsDetails = "string",
                  MetricQuery = list(
                    PerformanceInsightsMetricQuery = list(
                      GroupBy = list(
                        Dimensions = list(
                          "string"
                        ),
                        Group = "string",
                        Limit = 123
                      ),
                      Metric = "string"
                    )
                  )
                )
              ),
              Analysis = "string"
            )
          ),
          ContextAttributes = list(
            list(
              Key = "string",
              Value = "string"
            )
          )
        )
      ),
      Category = "string",
      Source = "string",
      TypeDetection = "string",
      TypeRecommendation = "string",
      Impact = "string",
      AdditionalInfo = "string",
      Links = list(
        list(
          Text = "string",
          Url = "string"
        )
      ),
      IssueDetails = list(
        PerformanceIssueDetails = list(
          StartTime = as.POSIXct(
            "2015-01-01"
          ),
          EndTime = as.POSIXct(
            "2015-01-01"
          ),
          Metrics = list(
            list(
              Name = "string",
              References = list(
                list(
                  Name = "string",
                  ReferenceDetails = list(
                    ScalarReferenceDetails = list(
                      Value = 123.0
                    )
                  )
                )
              ),
              StatisticsDetails = "string",
              MetricQuery = list(
                PerformanceInsightsMetricQuery = list(
                  GroupBy = list(
                    Dimensions = list(
                      "string"
                    ),
                    Group = "string",
                    Limit = 123
                  ),
                  Metric = "string"
                )
              )
            )
          ),
          Analysis = "string"
        )
      )
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_db_recommendations(
  LastUpdatedAfter = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedBefore = as.POSIXct(
    "2015-01-01"
  ),
  Locale = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)