Skip to content

ExportIdleRecommendationsRequest

Source code in docs_src/capo_compute_optimizer/types/export_idle_recommendations_request.py
class ExportIdleRecommendationsRequest(TypedDict, closed=True):
    account_ids: NotRequired["capo_compute_optimizer.types.account_ids.AccountIds"]
    """<p> The Amazon Web Services account IDs for the export idle resource recommendations. </p> <p>If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.</p> <p>This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.</p> <p>If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.</p> <p>You can specify multiple account IDs per request.</p>"""
    filters: NotRequired[
        "capo_compute_optimizer.types.idle_recommendation_filters.IdleRecommendationFilters"
    ]
    """<p>An array of objects to specify a filter that exports a more specific set of idle resource recommendations.</p>"""
    fields_to_export: NotRequired[
        "capo_compute_optimizer.types.exportable_idle_fields.ExportableIdleFields"
    ]
    """<p>The recommendations data to include in the export file. For more information about the fields that can be exported, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files">Exported files</a> in the <i>Compute Optimizer User Guide</i>.</p>"""
    s3_destination_config: (
        "capo_compute_optimizer.types.s3_destination_config.S3DestinationConfig"
    )
    file_format: NotRequired["capo_compute_optimizer.types.file_format.FileFormat"]
    """<p>The format of the export file. The CSV file is the only export file format currently supported.</p>"""
    include_member_accounts: (
        "capo_compute_optimizer.types.include_member_accounts.IncludeMemberAccounts"
    )
    """<p>If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.</p> <p>The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access">Compute Optimizer and Amazon Web Services Organizations trusted access</a> in the <i>Compute Optimizer User Guide</i>.</p> <p>If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.</p> <p>If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.</p>"""

account_ids instance-attribute

account_ids: NotRequired[AccountIds]

The Amazon Web Services account IDs for the export idle resource recommendations.

If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.

This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.

If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.

You can specify multiple account IDs per request.

fields_to_export instance-attribute

fields_to_export: NotRequired[ExportableIdleFields]

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

file_format instance-attribute

file_format: NotRequired[FileFormat]

The format of the export file. The CSV file is the only export file format currently supported.

filters instance-attribute

filters: NotRequired[IdleRecommendationFilters]

An array of objects to specify a filter that exports a more specific set of idle resource recommendations.

include_member_accounts instance-attribute

include_member_accounts: IncludeMemberAccounts

If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.

If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.

s3_destination_config instance-attribute

s3_destination_config: S3DestinationConfig