describe_db_recommendations¶
Operation¶
describe_db_recommendations
async
¶
describe_db_recommendations(request: DescribeDBRecommendationsInput | DescribeDBRecommendationsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBRecommendationsOutput
describe_db_recommendations(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBRecommendationsInputDict]) -> DescribeDBRecommendationsOutput
Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeDBRecommendationsOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeDBRecommendationsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDBRecommendationsInput structure.
Attributes¶
filters
class-attribute
instance-attribute
¶
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.
last_updated_after
class-attribute
instance-attribute
¶
last_updated_after: datetime | None = ...
A filter to include only the recommendations that were updated after this specified time.
last_updated_before
class-attribute
instance-attribute
¶
last_updated_before: datetime | None = ...
A filter to include only the recommendations that were updated before this specified time.
locale
class-attribute
instance-attribute
¶
locale: str | None = ...
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
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
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.
max_records
class-attribute
instance-attribute
¶
max_records: int | None = ...
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.
Dictionaries¶
DescribeDBRecommendationsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeDBRecommendationsInput.
Attributes¶
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
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.
last_updated_after
instance-attribute
¶
last_updated_after: datetime | None
A filter to include only the recommendations that were updated after this specified time.
last_updated_before
instance-attribute
¶
last_updated_before: datetime | None
A filter to include only the recommendations that were updated before this specified time.
locale
instance-attribute
¶
locale: str | None
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
Output¶
DescribeDBRecommendationsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDBRecommendationsOutput structure.
Attributes¶
db_recommendations
class-attribute
instance-attribute
¶
db_recommendations: list[DBRecommendation] | None = ...
A list of recommendations which is returned from
DescribeDBRecommendations API request.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DBRecommendationsMessage request. This token can be used later in a
DescribeDBRecomendations request.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.