Skip to content

Export Ecs Service Recommendations

computeoptimizer_export_ecs_service_recommendations R Documentation

Exports optimization recommendations for Amazon ECS services on Fargate

Description

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.

Usage

computeoptimizer_export_ecs_service_recommendations(accountIds, filters,
  fieldsToExport, s3DestinationConfig, fileFormat, includeMemberAccounts)

Arguments

accountIds

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

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

fieldsToExport

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.

s3DestinationConfig

[required]

fileFormat

The format of the export file.

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

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.

Value

A list with the following syntax: 

list(
  jobId = "string",
  s3Destination = list(
    bucket = "string",
    key = "string",
    metadataKey = "string"
  )
)

Request syntax

svc$export_ecs_service_recommendations(
  accountIds = list(
    "string"
  ),
  filters = list(
    list(
      name = "Finding"|"FindingReasonCode",
      values = list(
        "string"
      )
    )
  ),
  fieldsToExport = list(
    "AccountId"|"ServiceArn"|"LookbackPeriodInDays"|"LastRefreshTimestamp"|"LaunchType"|"CurrentPerformanceRisk"|"CurrentServiceConfigurationMemory"|"CurrentServiceConfigurationCpu"|"CurrentServiceConfigurationTaskDefinitionArn"|"CurrentServiceConfigurationAutoScalingConfiguration"|"CurrentServiceContainerConfigurations"|"UtilizationMetricsCpuMaximum"|"UtilizationMetricsMemoryMaximum"|"Finding"|"FindingReasonCodes"|"RecommendationOptionsMemory"|"RecommendationOptionsCpu"|"RecommendationOptionsSavingsOpportunityPercentage"|"RecommendationOptionsEstimatedMonthlySavingsCurrency"|"RecommendationOptionsEstimatedMonthlySavingsValue"|"RecommendationOptionsContainerRecommendations"|"RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"|"RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"|"Tags"|"EffectiveRecommendationPreferencesSavingsEstimationMode"|"RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage"|"RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts"|"RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts"
  ),
  s3DestinationConfig = list(
    bucket = "string",
    keyPrefix = "string"
  ),
  fileFormat = "Csv",
  includeMemberAccounts = TRUE|FALSE
)