ExportEBSVolumeRecommendationsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-compute-optimizer/refs/heads/main/json-schema/compute-optimizer-export-ebs-volume-recommendations-request-schema.json",
  "title": "ExportEBSVolumeRecommendationsRequest",
  "description": "ExportEBSVolumeRecommendationsRequest schema",
  "type": "object",
  "properties": {
    "accountIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountIds"
        },
        {
          "description": "<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": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EBSFilters"
        },
        {
          "description": "An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations."
        }
      ]
    },
    "fieldsToExport": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExportableVolumeFields"
        },
        {
          "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 only export file format currently supported is <code>Csv</code>.</p>"
        }
      ]
    },
    "includeMemberAccounts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IncludeMemberAccounts"
        },
        {
          "description": "<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>"
        }
      ]
    }
  },
  "required": [
    "s3DestinationConfig"
  ]
}