Skip to content

List Recommendations

redshift_list_recommendations R Documentation

List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account

Description

List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.

Usage

redshift_list_recommendations(ClusterIdentifier, NamespaceArn,
  MaxRecords, Marker)

Arguments

ClusterIdentifier

The unique identifier of the Amazon Redshift cluster for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

NamespaceArn

The Amazon Redshift cluster namespace Amazon Resource Name (ARN) for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

MaxRecords

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Marker

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Value

A list with the following syntax: 

list(
  Recommendations = list(
    list(
      Id = "string",
      ClusterIdentifier = "string",
      NamespaceArn = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      RecommendationType = "string",
      Title = "string",
      Description = "string",
      Observation = "string",
      ImpactRanking = "HIGH"|"MEDIUM"|"LOW",
      RecommendationText = "string",
      RecommendedActions = list(
        list(
          Text = "string",
          Database = "string",
          Command = "string",
          Type = "SQL"|"CLI"
        )
      ),
      ReferenceLinks = list(
        list(
          Text = "string",
          Link = "string"
        )
      )
    )
  ),
  Marker = "string"
)

Request syntax

svc$list_recommendations(
  ClusterIdentifier = "string",
  NamespaceArn = "string",
  MaxRecords = 123,
  Marker = "string"
)