Amazon Compute Optimizer · JSON Structure

Compute Optimizer Export Ecs Service Recommendations Request Structure

ExportECSServiceRecommendationsRequest schema

Type: object Properties: 6 Required: 1
Cost OptimizationFinOpsMachine LearningResource Recommendations

ExportECSServiceRecommendationsRequest is a JSON Structure definition published by Amazon Compute Optimizer, describing 6 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

accountIds filters fieldsToExport s3DestinationConfig fileFormat includeMemberAccounts

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-compute-optimizer/refs/heads/main/json-structure/compute-optimizer-export-ecs-service-recommendations-request-structure.json",
  "name": "ExportECSServiceRecommendationsRequest",
  "description": "ExportECSServiceRecommendationsRequest schema",
  "type": "object",
  "properties": {
    "accountIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountIds"
        },
        {
          "description": "<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": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ECSServiceRecommendationFilters"
        },
        {
          "description": " An array of objects to specify a filter that exports a more specific set of Amazon ECS service recommendations. "
        }
      ]
    },
    "fieldsToExport": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExportableECSServiceFields"
        },
        {
          "description": "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>."
        }
      ]
    },
    "s3DestinationConfig": {
      "$ref": "#/components/schemas/S3DestinationConfig"
    },
    "fileFormat": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileFormat"
        },
        {
          "description": "<p> The format of the export file. </p> <p>The CSV file is the only export file format currently supported.</p>"
        }
      ]
    },
    "includeMemberAccounts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IncludeMemberAccounts"
        },
        {
          "description": "<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>"
        }
      ]
    }
  },
  "required": [
    "s3DestinationConfig"
  ]
}