Skip to content

export_ecs_service_recommendations async

export_ecs_service_recommendations(
    s3_destination_config: S3DestinationConfig,
    *,
    config_overrides: Optional[AsyncComputeOptimizerClientConfig] = None,
    account_ids: Optional[AccountIds] = None,
    filters: Optional[ECSServiceRecommendationFilters] = None,
    fields_to_export: Optional[ExportableECSServiceFields] = None,
    file_format: Optional[FileFormat] = None,
    include_member_accounts: Optional[IncludeMemberAccounts] = None,
) -> ExportECSServiceRecommendationsResponse

Exports optimization recommendations for Amazon ECS services on Fargate.

Recommendations are exported in a CSV file, and its metadata in a JSON file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can only have one Amazon ECS service export job in progress per Amazon Web Services Region.

Parameters:

  • account_ids (Optional[AccountIds], default: None ) –

    The Amazon Web Services account IDs for the export Amazon ECS service 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.

  • filters (Optional[ECSServiceRecommendationFilters], default: None ) –

    An array of objects to specify a filter that exports a more specific set of Amazon ECS service recommendations.

  • fields_to_export (Optional[ExportableECSServiceFields], default: None ) –

    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 (Optional[FileFormat], default: None ) –

    The format of the export file.

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

  • include_member_accounts (Optional[IncludeMemberAccounts], default: None ) –

    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.

Raises:

Source code in docs_src/capo_compute_optimizer/_services/async_compute_optimizer.py
async def export_ecs_service_recommendations(
    self,
    s3_destination_config: "capo_compute_optimizer.types.s3_destination_config.S3DestinationConfig",
    *,
    config_overrides: Optional[AsyncComputeOptimizerClientConfig] = None,
    account_ids: Optional[
        "capo_compute_optimizer.types.account_ids.AccountIds"
    ] = None,
    filters: Optional[
        "capo_compute_optimizer.types.ecs_service_recommendation_filters.ECSServiceRecommendationFilters"
    ] = None,
    fields_to_export: Optional[
        "capo_compute_optimizer.types.exportable_ecs_service_fields.ExportableECSServiceFields"
    ] = 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_ecs_service_recommendations_response.ExportECSServiceRecommendationsResponse":
    """<p> Exports optimization recommendations for Amazon ECS services on Fargate. </p> <p>Recommendations are exported in a CSV file, and its metadata in a 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 only have one Amazon ECS service export job in progress per Amazon Web Services Region.</p>

    Args:
        account_ids: <p> The Amazon Web Services account IDs for the export Amazon ECS service 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: <p> An array of objects to specify a filter that exports a more specific set of Amazon ECS service 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 CSV file is the only export file format currently supported.</p>
        include_member_accounts: <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>

    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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_compute_optimizer.types.export_ecs_service_recommendations_request.ExportECSServiceRecommendationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_compute_optimizer.types.export_ecs_service_recommendations_response.ExportECSServiceRecommendationsResponse"
    ]:
        import capo_compute_optimizer._operations.compute_optimizer_service.export_ecs_service_recommendations

        (
            output,
            http_response,
        ) = await capo_compute_optimizer._operations.compute_optimizer_service.export_ecs_service_recommendations.async_export_ecs_service_recommendations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ExportECSServiceRecommendations")
    )
    input_: capo_compute_optimizer.types.export_ecs_service_recommendations_request.ExportECSServiceRecommendationsRequest = {
        "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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output