Class: Aws::RDS::Types::DescribeDBRecommendationsMessage

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DescribeDBRecommendationsMessage

Includes:

Structure

Defined in:

lib/aws-sdk-rds/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Array<Types::Filter>

  A filter that specifies one or more recommendations to describe.

• #last_updated_after ⇒ Time

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

• #last_updated_before ⇒ Time

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

• #locale ⇒ String

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

• #marker ⇒ String

  An optional pagination token provided by a previous ‘DescribeDBRecommendations` request.

• #max_records ⇒ Integer

  The maximum number of recommendations to include in the response.

Instance Attribute Details

#filters ⇒ Array<Types::Filter>

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.

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-rds/types.rb', line 13382

class DescribeDBRecommendationsMessage < Struct.new(
  :last_updated_after,
  :last_updated_before,
  :locale,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_after ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-rds/types.rb', line 13382

class DescribeDBRecommendationsMessage < Struct.new(
  :last_updated_after,
  :last_updated_before,
  :locale,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_before ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-rds/types.rb', line 13382

class DescribeDBRecommendationsMessage < Struct.new(
  :last_updated_after,
  :last_updated_before,
  :locale,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#locale ⇒ String

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`

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 13382

class DescribeDBRecommendationsMessage < Struct.new(
  :last_updated_after,
  :last_updated_before,
  :locale,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#marker ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 13382

class DescribeDBRecommendationsMessage < Struct.new(
  :last_updated_after,
  :last_updated_before,
  :locale,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#max_records ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-rds/types.rb', line 13382

class DescribeDBRecommendationsMessage < Struct.new(
  :last_updated_after,
  :last_updated_before,
  :locale,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end