Skip to main content

recommendations

Creates, updates, deletes, gets or lists a recommendations resource.

Overview

Namerecommendations
TypeResource
Idaws.redshift.recommendations

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
cluster_identifierstringThe unique identifier of the cluster for which the recommendation is returned.
created_atstringThe date and time (UTC) that the recommendation was created.
descriptionstringThe description of the recommendation.
idstringA unique identifier of the Advisor recommendation.
impact_rankingstringThe scale of the impact that the Advisor recommendation has to the performance and cost of the cluster.
namespace_arnstringThe Amazon Redshift cluster namespace ARN for which the recommendations is returned.
observationstringThe description of what was observed about your cluster.
recommendation_textstringThe description of the recommendation.
recommendation_typestringThe type of Advisor recommendation.
recommended_actionsstringList of Amazon Redshift recommended actions.
reference_linksstringList of helpful links for more information about the Advisor recommendation.
titlestringThe title of the recommendation.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_recommendationsselectregionClusterIdentifier, NamespaceArn, MaxRecords, MarkerList the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
ClusterIdentifierstringThe 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.
MarkerstringA 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.
MaxRecordsintegerThe 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.
NamespaceArnstringThe 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.

SELECT examples

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

SELECT
cluster_identifier,
created_at,
description,
id,
impact_ranking,
namespace_arn,
observation,
recommendation_text,
recommendation_type,
recommended_actions,
reference_links,
title
FROM aws.redshift.recommendations
WHERE region = '{{ region }}' -- required
AND ClusterIdentifier = '{{ ClusterIdentifier }}'
AND NamespaceArn = '{{ NamespaceArn }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;