Skip to content

GetRDSDatabaseRecommendationsRequest

Source code in docs_src/capo_compute_optimizer/types/get_rds_database_recommendations_request.py
class GetRDSDatabaseRecommendationsRequest(TypedDict, closed=True):
    resource_arns: NotRequired[
        "capo_compute_optimizer.types.resource_arns.ResourceArns"
    ]
    """<p> The ARN that identifies the Amazon Aurora or RDS database. </p> <p> The following is the format of the ARN: </p> <p> <code>arn:aws:rds:{region}:{accountId}:db:{resourceName}</code> </p> <p> The following is the format of a DB Cluster ARN: </p> <p> <code>arn:aws:rds:{region}:{accountId}:cluster:{resourceName}</code> </p>"""
    next_token: NotRequired["capo_compute_optimizer.types.next_token.NextToken"]
    """<p> The token to advance to the next page of Amazon Aurora and RDS database recommendations. </p>"""
    max_results: NotRequired["capo_compute_optimizer.types.max_results.MaxResults"]
    """<p>The maximum number of Amazon Aurora and RDS database recommendations to return with a single request.</p> <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>"""
    filters: NotRequired[
        "capo_compute_optimizer.types.rdsdb_recommendation_filters.RDSDBRecommendationFilters"
    ]
    """<p> An array of objects to specify a filter that returns a more specific list of Amazon Aurora and RDS database recommendations. </p>"""
    account_ids: NotRequired["capo_compute_optimizer.types.account_ids.AccountIds"]
    """<p> Return the Amazon Aurora and RDS database recommendations to the specified Amazon Web Services account IDs. </p> <p>If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon Aurora and RDS database recommendations to specific member accounts.</p> <p>You can only specify one account ID per request.</p>"""
    recommendation_preferences: NotRequired[
        "capo_compute_optimizer.types.recommendation_preferences.RecommendationPreferences"
    ]

account_ids instance-attribute

account_ids: NotRequired[AccountIds]

Return the Amazon Aurora and RDS database recommendations to the specified Amazon Web Services account IDs.

If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon Aurora and RDS database recommendations to specific member accounts.

You can only specify one account ID per request.

filters instance-attribute

filters: NotRequired[RDSDBRecommendationFilters]

An array of objects to specify a filter that returns a more specific list of Amazon Aurora and RDS database recommendations.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of Amazon Aurora and RDS database recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

next_token instance-attribute

next_token: NotRequired[NextToken]

The token to advance to the next page of Amazon Aurora and RDS database recommendations.

recommendation_preferences instance-attribute

recommendation_preferences: NotRequired[RecommendationPreferences]

resource_arns instance-attribute

resource_arns: NotRequired[ResourceArns]

The ARN that identifies the Amazon Aurora or RDS database.

The following is the format of the ARN:

arn:aws:rds:{region}:{accountId}:db:{resourceName}

The following is the format of a DB Cluster ARN:

arn:aws:rds:{region}:{accountId}:cluster:{resourceName}