Redshift / Client / list_recommendations

list_recommendations#

Redshift.Client.list_recommendations(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_recommendations(
    ClusterIdentifier='string',
    NamespaceArn='string',
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • ClusterIdentifier (string) – 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 (string) – 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 (integer) – 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 (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Recommendations': [
        {
            'Id': 'string',
            'ClusterIdentifier': 'string',
            'NamespaceArn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'RecommendationType': 'string',
            'Title': 'string',
            'Description': 'string',
            'Observation': 'string',
            'ImpactRanking': 'HIGH'|'MEDIUM'|'LOW',
            'RecommendationText': 'string',
            'RecommendedActions': [
                {
                    'Text': 'string',
                    'Database': 'string',
                    'Command': 'string',
                    'Type': 'SQL'|'CLI'
                },
            ],
            'ReferenceLinks': [
                {
                    'Text': 'string',
                    'Link': 'string'
                },
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) –

    • Recommendations (list) –

      The Advisor recommendations for action on the Amazon Redshift cluster.

      • (dict) –

        An Amazon Redshift Advisor recommended action on the Amazon Redshift cluster.

        • Id (string) –

          A unique identifier of the Advisor recommendation.

        • ClusterIdentifier (string) –

          The unique identifier of the cluster for which the recommendation is returned.

        • NamespaceArn (string) –

          The Amazon Redshift cluster namespace ARN for which the recommendations is returned.

        • CreatedAt (datetime) –

          The date and time (UTC) that the recommendation was created.

        • RecommendationType (string) –

          The type of Advisor recommendation.

        • Title (string) –

          The title of the recommendation.

        • Description (string) –

          The description of the recommendation.

        • Observation (string) –

          The description of what was observed about your cluster.

        • ImpactRanking (string) –

          The scale of the impact that the Advisor recommendation has to the performance and cost of the cluster.

        • RecommendationText (string) –

          The description of the recommendation.

        • RecommendedActions (list) –

          List of Amazon Redshift recommended actions.

          • (dict) –

            The recommended action from the Amazon Redshift Advisor recommendation.

            • Text (string) –

              The specific instruction about the command.

            • Database (string) –

              The database name to perform the action on. Only applicable if the type of command is SQL.

            • Command (string) –

              The command to run.

            • Type (string) –

              The type of command.

        • ReferenceLinks (list) –

          List of helpful links for more information about the Advisor recommendation.

          • (dict) –

            A link to an Amazon Redshift Advisor reference for more information about a recommendation.

            • Text (string) –

              The hyperlink text that describes the link to more information.

            • Link (string) –

              The URL address to find more information.

    • Marker (string) –

      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.

Exceptions