export_ebs_volume_recommendations ¶

def export_ebs_volume_recommendations(
    self,
    s3_destination_config: "capo_compute_optimizer.types.s3_destination_config.S3DestinationConfig",
    *,
    config_overrides: Optional[ComputeOptimizerClientConfig] = None,
    account_ids: Optional[
        "capo_compute_optimizer.types.account_ids.AccountIds"
    ] = None,
    filters: Optional["capo_compute_optimizer.types.ebs_filters.EBSFilters"] = None,
    fields_to_export: Optional[
        "capo_compute_optimizer.types.exportable_volume_fields.ExportableVolumeFields"
    ] = None,
    file_format: Optional[
        "capo_compute_optimizer.types.file_format.FileFormat"
    ] = None,
    include_member_accounts: Optional[
        "capo_compute_optimizer.types.include_member_accounts.IncludeMemberAccounts"
    ] = None,
) -> "capo_compute_optimizer.types.export_ebs_volume_recommendations_response.ExportEBSVolumeRecommendationsResponse":
    """<p>Exports optimization recommendations for Amazon EBS volumes.</p> <p>Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html">Exporting Recommendations</a> in the <i>Compute Optimizer User Guide</i>.</p> <p>You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.</p>

    Args:
        account_ids: <p>The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.</p> <p>This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.</p> <p>Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.</p> <p>You can specify multiple account IDs per request.</p>
        filters: <p>An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.</p>
        fields_to_export: <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>
        file_format: <p>The format of the export file.</p> <p>The only export file format currently supported is <code>Csv</code>.</p>
        include_member_accounts: <p>Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an 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>Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.</p> <p>This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.</p> <p>Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.</p>

    Raises:
        capo_compute_optimizer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_compute_optimizer.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred. Try your call again.</p>
        capo_compute_optimizer.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value supplied for the input parameter is out of range or not valid.</p>
        capo_compute_optimizer.errors.limit_exceeded_exception.LimitExceededException: <p>The request exceeds a limit of the service.</p>
        capo_compute_optimizer.errors.missing_authentication_token.MissingAuthenticationToken: <p>The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.</p>
        capo_compute_optimizer.errors.opt_in_required_exception.OptInRequiredException: <p>The account is not opted in to Compute Optimizer.</p>
        capo_compute_optimizer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed due to a temporary failure of the server.</p>
        capo_compute_optimizer.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_compute_optimizer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_compute_optimizer.types.export_ebs_volume_recommendations_request.ExportEBSVolumeRecommendationsRequest]",
    ) -> OperationResponse[
        "capo_compute_optimizer.types.export_ebs_volume_recommendations_response.ExportEBSVolumeRecommendationsResponse"
    ]:
        import capo_compute_optimizer._operations.compute_optimizer_service.export_ebs_volume_recommendations

        output, http_response = (
            capo_compute_optimizer._operations.compute_optimizer_service.export_ebs_volume_recommendations.export_ebs_volume_recommendations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ExportEBSVolumeRecommendations")
    )
    input_: capo_compute_optimizer.types.export_ebs_volume_recommendations_request.ExportEBSVolumeRecommendationsRequest = {
        "s3_destination_config": s3_destination_config
    }
    if account_ids is not None:
        input_["account_ids"] = account_ids
    if filters is not None:
        input_["filters"] = filters
    if fields_to_export is not None:
        input_["fields_to_export"] = fields_to_export
    if file_format is not None:
        input_["file_format"] = file_format
    if include_member_accounts is not None:
        input_["include_member_accounts"] = include_member_accounts

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output