{ "openapi": "3.0.1", "info": { "title": "Commitment Orchestrator APIs", "description": "Commitment Orchestrator API documentation", "contact": { "email": "ccm@harness.io" }, "version": "1.0.0" }, "externalDocs": { "description": "Find out more about Swagger", "url": "http://swagger.io" }, "servers": [ { "url": "https://app.harness.io/gateway", "description": "Production server" } ], "tags": [ { "name": "Commitment Orchestrator Events APIs", "description": "This contains APIs to fetch commitment orchestrator events data." } ], "paths": { "/accounts/{account_id}/v1/events/logs": { "post": { "tags": [ "Commitment Orchestrator APIs" ], "summary": "List event logs", "description": "Obtains list of event logs generated as part of commitment orchestration", "operationId": "EventLogs", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cloud_account_id", "description": "Cloud Account Identifier", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "description": "Start date of the period in YYYY-MM-DD format", "example": "2023-11-07" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "description": "End date of the period in YYYY-MM-DD format (will be adjusted to end of day)", "example": "2023-11-07" } }, { "name": "event_type", "description": "Type of event to filter by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "service", "description": "AWS Service type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service" ], "default": "Amazon Elastic Compute Cloud - Compute" } } ], "requestBody": { "description": "Input for Pagination and Filters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EventLogsRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventLogsSuccessResponse" } } } }, "400": { "description": "Invalid status value", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/accounts/{account_id}/v1/events/chart": { "post": { "tags": [ "Commitment Orchestrator Events APIs" ], "summary": "List event logs", "description": "Obtains list of events and the count of their occurences grouped by date", "operationId": "EventsChart", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start time of the period", "example": "2021-10-19" } }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End time of the period", "example": "2021-10-19" } } ], "requestBody": { "description": "Optional filters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EventsFilter" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventsChartsSuccessResponse" } } } }, "400": { "description": "Invalid status value", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/accounts/{account_id}/v1/events/renewal_events": { "post": { "tags": [ "Commitment Orchestrator Events APIs" ], "summary": "List auto-renewal events", "description": "Returns auto-renewal activities (upcoming and completed) for the account, filtered by date range and optional cloud account, regions, and AWS service. Used to annotate charts such as Compute Coverage when savings or coverage dip around RI/SP renewals. If start_date and end_date are omitted, the server defaults to the last 30 days (UTC).", "operationId": "RenewalEvents", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Date range and optional filters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewalEventsRequest" } }, "*/*": { "schema": { "$ref": "#/components/schemas/RenewalEventsRequest" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewalEventsSuccessResponse" } } } }, "400": { "description": "Invalid request (e.g. invalid date format or end_date before start_date)", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/accounts/{account_id}/v1/events/ri_recommendation_schedule": { "get": { "tags": [ "Commitment Orchestrator Events APIs" ], "summary": "RI recommendation cooldown schedule", "description": "Returns the configured minimum interval between RI recommendation engine runs and when the next run becomes eligible, based on the latest completed approval transaction for the account and service.", "operationId": "RIRecommendationSchedule", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "service", "description": "AWS Service type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service", "Amazon ElastiCache" ], "default": "Amazon Elastic Compute Cloud - Compute" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RIRecommendationScheduleSuccessResponse" } } } }, "400": { "description": "Invalid parameters", "content": {} } } } }, "/accounts/{account_id}/v1/setup": { "post": { "tags": [ "Commitment Orchestrator Setup APIs" ], "summary": "Create commitment orchestration setup", "description": "Creates a new commitment orchestration setup configuration for a cloud account, including optional notification settings", "operationId": "SetupConfiguration", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Setup configuration details", "content": { "application/json": { "schema": { "type": "object", "properties": { "cloud_account_id": { "type": "string", "description": "Cloud Account ID for which to create the commitment orchestration setup" }, "cloud_account_name": { "type": "string", "description": "Name of the cloud account" }, "enabled": { "type": "boolean", "description": "Whether the commitment orchestration is enabled", "default": true }, "dry_run_mode": { "type": "boolean", "description": "Whether to run in dry run mode", "default": false }, "approval_mode": { "type": "string", "description": "Mode of approval for commitment actions", "enum": [ "auto", "manual", "semiAutomated" ], "default": "manual" }, "service": { "type": "string", "description": "Service for which to set up commitment orchestration", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service" ], "default": "Amazon Elastic Compute Cloud - Compute" }, "config": { "type": "object", "description": "Configuration details for the commitment orchestration", "properties": { "exclusion_list": { "type": "array", "description": "List of instance types to exclude from commitment orchestration", "items": { "$ref": "#/components/schemas/ExclusionEntry" } }, "excluded_cloud_accounts": { "type": "array", "description": "List of cloud account IDs to exclude from commitment orchestration", "items": { "type": "string" } }, "excluded_regions": { "type": "array", "description": "List of regions to exclude from commitment orchestration", "items": { "type": "string" } }, "savings_plans_coverage": { "type": "number", "format": "float", "description": "Target coverage percentage for savings plans (0-1)", "minimum": 0, "maximum": 1 }, "reserved_instances_coverage": { "type": "number", "format": "float", "description": "Target coverage percentage for reserved instances (0-1)", "minimum": 0, "maximum": 1 }, "total_coverage": { "type": "number", "format": "float", "description": "Total target coverage percentage (0-1)", "minimum": 0, "maximum": 1 }, "seed_config": { "type": "object", "description": "Configuration for seed instances", "properties": { "start_with": { "type": "string", "description": "Strategy for starting with seed instances", "enum": [ "seed_auto_discovery", "purchase_new_seed" ], "default": "seed_auto_discovery" }, "monthly_purchase_enabled": { "type": "boolean", "description": "Whether monthly purchase of seed instances is enabled", "default": false }, "purchase_terms": { "type": "array", "description": "Purchase terms for seed instances in seconds", "items": { "type": "integer", "enum": [ 31536000, 94608000 ], "description": "Purchase term in seconds (1 year = 31536000, 3 years = 94608000)" } } } }, "payment_option": { "type": "string", "description": "Payment option for commitments", "enum": [ "No Upfront", "Partial Upfront", "All Upfront" ] }, "savings_plan_renewal_rate": { "type": "number", "format": "float", "description": "Renewal rate for savings plans (0-1), required for semiAutomated approval mode", "minimum": 0, "maximum": 1 }, "savings_plan_layering": { "type": "object", "description": "Savings Plan laddering configuration", "properties": { "enabled": { "type": "boolean", "description": "Whether Savings Plan laddering is enabled", "default": false }, "aggressiveness": { "type": "string", "description": "Ladder purchase pace. Maps to configurable purchase fractions (slow/balanced/aggressive). Balanced and omitted use autocud.sp_ladder_purchase_fraction; slow and aggressive use their own config keys. Defaults target ≈25%/50%/75% coverable demand in the first month.", "enum": [ "slow", "balanced", "aggressive" ] } } }, "max_sp_hourly_commitment": { "type": "number", "format": "double", "description": "Maximum hourly commitment for a net-new Savings Plan purchase in USD/hour; 0 or omitted means no ceiling", "minimum": 0 }, "preferred_commitment_mode": { "type": "string", "description": "Commitment type that receives the shared coverage budget first", "enum": [ "ri_preferred", "sp_preferred" ], "default": "ri_preferred" } }, "required": [ "total_coverage" ] }, "notification": { "type": "object", "description": "Optional notification configuration for commitment orchestration alerts", "properties": { "email_list": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "List of email addresses to receive notifications", "example": [ "user1@example.com", "user2@example.com" ] }, "timezone": { "type": "string", "description": "Timezone for scheduling notifications (IANA timezone format)", "example": "America/New_York" }, "sp_notif_range": { "type": "integer", "format": "int64", "description": "Number of days before Savings Plan expiry to send notifications", "example": 30, "minimum": 1, "maximum": 365 }, "schedule_time": { "type": "string", "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", "description": "Time to send notifications in HH:MM format (24-hour)", "example": "09:00" }, "purchase_notifications_enabled": { "type": "boolean", "description": "Whether to enable notifications for completed purchases", "example": true }, "recommendations_notifications_enabled": { "type": "boolean", "description": "Whether to enable notifications for new recommendations", "example": true } }, "required": [ "email_list", "timezone", "schedule_time" ] } }, "required": [ "cloud_account_id", "config", "service" ] } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64", "description": "Timestamp of the response" }, "success": { "type": "boolean", "description": "Whether the operation was successful" }, "response": { "type": "object", "description": "Empty object as no content is expected in the response", "additionalProperties": false } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64" }, "success": { "type": "boolean", "enum": [ false ] }, "errors": { "type": "array", "items": { "type": "string" } } } } } } } } } }, "/accounts/{account_id}/v1/setup/validate": { "post": { "tags": [ "Commitment Orchestrator Setup APIs" ], "summary": "Validate commitment Setup", "description": "Obtains maximum allowed configuration values for Savings Plans given a target total coverage", "operationId": "SetupValidate", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "cloud_account_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Account Identifier for which Commitment Orchestration Setup is being performed" } } ], "requestBody": { "description": "Configured setup values", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AutoCUDConfig" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetupValidateSuccessResponse" } } } }, "400": { "description": "Invalid status value", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/accounts/{account_id}/v1/setup/{cloud_account_id}/instance_types": { "post": { "tags": [ "Commitment Orchestrator Setup APIs" ], "summary": "Instance types in usage to support configuring exclusions", "description": "Lists all instance types by region in usage for the given master account", "operationId": "SetupInstanceTypes", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cloud_account_id", "description": "Cloud Account ID of the master account in Harness", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "cloud_account_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Account Identifier for which Commitment Orchestration Setup is being performed" } } ], "requestBody": { "description": "Configured setup values", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/InstanceTypesPayload" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetupInstanceTypesSuccessResponse" } } } }, "400": { "description": "Invalid status value", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/accounts/{account_id}/v1/setup/{cloudAccountID}": { "delete": { "tags": [ "Commitment Orchestrator Setup APIs" ], "summary": "Delete commitment orchestration setup", "description": "Deletes a commitment orchestration setup configuration for a specific cloud account, including any associated notification settings", "operationId": "DeleteSetupConfiguration", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cloudAccountID", "description": "Cloud Account ID for which to delete the commitment orchestration setup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "service", "description": "Service for which to delete the commitment orchestration setup", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service - RDS" ], "default": "Amazon Elastic Compute Cloud - Compute" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericSuccessResponse" } } } }, "400": { "description": "Invalid request or setup not found", "content": {} } } }, "get": { "tags": [ "Commitment Orchestrator Setup APIs" ], "summary": "Get commitment orchestration setup", "description": "Retrieves the commitment orchestration setup configuration for a specific cloud account, including notification settings if configured", "operationId": "GetSetupConfiguration", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cloudAccountID", "description": "Cloud Account ID for which to retrieve the commitment orchestration setup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "service", "description": "Service for which to retrieve the commitment orchestration setup", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service" ], "default": "Amazon Elastic Compute Cloud - Compute" } }, { "name": "routingId", "description": "Routing identifier for the request", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful retrieval of the commitment orchestration setup", "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Unix timestamp of the response", "example": 1758063197 }, "success": { "type": "boolean", "description": "Indicates whether the request was successful", "example": true }, "errors": { "type": "array", "description": "List of errors if the request failed", "items": { "type": "string" }, "nullable": true, "example": null }, "response": { "type": "object", "description": "The setup configuration details", "properties": { "id": { "type": "integer", "example": 0 }, "account_id": { "type": "string", "description": "Account Identifier", "example": "account_identifier" }, "cloud_account_id": { "type": "string", "description": "Cloud Account Identifier", "example": "cloud_account_id" }, "cloud_account_name": { "type": "string", "description": "Name of the cloud account", "example": "" }, "config": { "type": "object", "description": "Configuration details", "properties": { "exclusion_list": { "type": "array", "description": "List of excluded instance types", "items": { "$ref": "#/components/schemas/ExclusionEntry" } }, "excluded_cloud_accounts": { "type": "array", "description": "List of excluded cloud accounts", "items": { "type": "string" } }, "excluded_regions": { "type": "array", "description": "List of excluded regions", "items": { "type": "string" } }, "savings_plans_coverage": { "type": "number", "format": "float", "example": 0 }, "reserved_instances_coverage": { "type": "number", "format": "float", "example": 0 }, "total_coverage": { "type": "number", "format": "float", "example": 0.4 }, "payment_option": { "type": "string", "description": "Payment option for the setup", "example": "No Upfront" }, "savings_plan_renewal_rate": { "type": "number", "format": "float", "description": "Renewal rate for savings plans (0-1)", "example": 0.91 }, "savings_plan_layering": { "type": "object", "description": "Savings Plan laddering configuration", "properties": { "enabled": { "type": "boolean", "description": "Whether Savings Plan laddering is enabled", "example": true }, "aggressiveness": { "type": "string", "description": "Ladder purchase pace. Maps to configurable purchase fractions (slow/balanced/aggressive). Balanced and omitted use autocud.sp_ladder_purchase_fraction; slow and aggressive use their own config keys. Defaults target ≈25%/50%/75% coverable demand in the first month.", "enum": [ "slow", "balanced", "aggressive" ], "example": "balanced" } } }, "max_sp_hourly_commitment": { "type": "number", "format": "double", "description": "Maximum hourly commitment for a net-new Savings Plan purchase in USD/hour; 0 or omitted means no ceiling", "example": 25 }, "preferred_commitment_mode": { "type": "string", "description": "Commitment type that receives the shared coverage budget first", "enum": [ "ri_preferred", "sp_preferred" ], "example": "ri_preferred" }, "seed_config": { "type": "object", "description": "Configuration for seed instances", "properties": { "start_with": { "type": "string", "description": "Strategy for starting with seed instances", "enum": [ "seed_auto_discovery", "purchase_new_seed" ], "example": "seed_auto_discovery" }, "monthly_purchase_enabled": { "type": "boolean", "description": "Whether monthly purchase of seed instances is enabled", "example": false }, "purchase_terms": { "type": "array", "description": "Purchase terms for seed instances in seconds", "items": { "type": "integer", "enum": [ 31536000, 94608000 ], "description": "Purchase term in seconds (1 year = 31536000, 3 years = 94608000)" }, "example": [ 31536000 ] } } } } }, "enabled": { "type": "boolean", "description": "Whether the setup is enabled", "example": false }, "dry_run_mode": { "type": "boolean", "description": "Whether the setup is running in dry-run mode", "example": false }, "updated_at": { "type": "string", "format": "date-time", "example": "2025-09-23T23:29:08.731554Z" }, "created_at": { "type": "string", "format": "date-time", "example": "2025-09-23T23:25:53.925238Z" }, "approval_mode": { "type": "string", "description": "Mode of approval for operations", "enum": [ "auto", "manual", "semiAutomated" ], "example": "semiAutomated" }, "service": { "type": "string", "description": "The associated service", "example": "Amazon Elastic Compute Cloud - Compute" }, "notification": { "type": "object", "description": "Notification configuration for commitment orchestration alerts", "nullable": true, "properties": { "email_list": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "List of email addresses to receive notifications" }, "timezone": { "type": "string", "description": "Timezone for scheduling notifications" }, "sp_notif_range": { "type": "integer", "format": "int64", "description": "Number of days before Savings Plan expiry to send notifications" }, "schedule_time": { "type": "string", "description": "Time to send notifications in HH:MM format" }, "purchase_notifications_enabled": { "type": "boolean", "description": "Whether notifications for completed purchases are enabled" }, "recommendations_notifications_enabled": { "type": "boolean", "description": "Whether notifications for new recommendations are enabled" } } } } } } } } } }, "400": { "description": "Invalid request or setup not found", "content": {} } } }, "put": { "tags": [ "Commitment Orchestrator Setup APIs" ], "summary": "Update commitment orchestration setup", "description": "Updates an existing commitment orchestration setup configuration for a specific cloud account, including notification settings", "operationId": "UpdateSetupConfiguration", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cloudAccountID", "description": "Cloud Account ID for which to update the commitment orchestration setup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Setup configuration details", "content": { "application/json": { "schema": { "type": "object", "properties": { "cloud_account_id": { "type": "string", "description": "Cloud Account ID for which to update the commitment orchestration setup" }, "cloud_account_name": { "type": "string", "description": "Name of the cloud account" }, "enabled": { "type": "boolean", "description": "Whether the commitment orchestration is enabled", "default": true }, "dry_run_mode": { "type": "boolean", "description": "Whether to run in dry run mode", "default": false }, "approval_mode": { "type": "string", "description": "Mode of approval for commitment actions", "enum": [ "auto", "manual", "semiAutomated" ], "default": "manual" }, "service": { "type": "string", "description": "Service for which to set up commitment orchestration", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service" ], "default": "Amazon Elastic Compute Cloud - Compute" }, "config": { "type": "object", "description": "Configuration details for the commitment orchestration", "properties": { "exclusion_list": { "type": "array", "description": "List of instance types to exclude from commitment orchestration", "items": { "$ref": "#/components/schemas/ExclusionEntry" } }, "excluded_cloud_accounts": { "type": "array", "description": "List of cloud account IDs to exclude from commitment orchestration", "items": { "type": "string" } }, "excluded_regions": { "type": "array", "description": "List of regions to exclude from commitment orchestration", "items": { "type": "string" } }, "savings_plans_coverage": { "type": "number", "format": "float", "description": "Target coverage percentage for savings plans (0-1)", "minimum": 0, "maximum": 1 }, "reserved_instances_coverage": { "type": "number", "format": "float", "description": "Target coverage percentage for reserved instances (0-1)", "minimum": 0, "maximum": 1 }, "total_coverage": { "type": "number", "format": "float", "description": "Total target coverage percentage (0-1)", "minimum": 0, "maximum": 1 }, "seed_config": { "type": "object", "description": "Configuration for seed instances", "properties": { "start_with": { "type": "string", "description": "Strategy for starting with seed instances", "enum": [ "seed_auto_discovery", "purchase_new_seed" ], "default": "seed_auto_discovery" }, "monthly_purchase_enabled": { "type": "boolean", "description": "Whether monthly purchase of seed instances is enabled", "default": false }, "purchase_terms": { "type": "array", "description": "Purchase terms for seed instances in seconds", "items": { "type": "integer", "enum": [ 31536000, 94608000 ], "description": "Purchase term in seconds (1 year = 31536000, 3 years = 94608000)" } } } }, "payment_option": { "type": "string", "description": "Payment option for commitments", "enum": [ "No Upfront", "Partial Upfront", "All Upfront" ] }, "savings_plan_renewal_rate": { "type": "number", "format": "float", "description": "Renewal rate for savings plans (0-1), required for semiAutomated approval mode", "minimum": 0, "maximum": 1 }, "savings_plan_layering": { "type": "object", "description": "Savings Plan laddering configuration", "properties": { "enabled": { "type": "boolean", "description": "Whether Savings Plan laddering is enabled", "default": false }, "aggressiveness": { "type": "string", "description": "Ladder purchase pace. Maps to configurable purchase fractions (slow/balanced/aggressive). Balanced and omitted use autocud.sp_ladder_purchase_fraction; slow and aggressive use their own config keys. Defaults target ≈25%/50%/75% coverable demand in the first month.", "enum": [ "slow", "balanced", "aggressive" ] } } }, "max_sp_hourly_commitment": { "type": "number", "format": "double", "description": "Maximum hourly commitment for a net-new Savings Plan purchase in USD/hour; 0 or omitted means no ceiling", "minimum": 0 }, "preferred_commitment_mode": { "type": "string", "description": "Commitment type that receives the shared coverage budget first", "enum": [ "ri_preferred", "sp_preferred" ], "default": "ri_preferred" } }, "required": [ "total_coverage" ] }, "notification": { "type": "object", "description": "Optional notification configuration for commitment orchestration alerts", "properties": { "email_list": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "List of email addresses to receive notifications", "example": [ "user1@example.com", "user2@example.com" ] }, "timezone": { "type": "string", "description": "Timezone for scheduling notifications (IANA timezone format)", "example": "America/New_York" }, "sp_notif_range": { "type": "integer", "format": "int64", "description": "Number of days before Savings Plan expiry to send notifications", "example": 30, "minimum": 1, "maximum": 365 }, "schedule_time": { "type": "string", "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", "description": "Time to send notifications in HH:MM format (24-hour)", "example": "09:00" }, "purchase_notifications_enabled": { "type": "boolean", "description": "Whether to enable notifications for completed purchases", "example": true }, "recommendations_notifications_enabled": { "type": "boolean", "description": "Whether to enable notifications for new recommendations", "example": true } }, "required": [ "email_list", "timezone", "schedule_time" ] } }, "required": [ "cloud_account_id", "config", "service" ] } } }, "required": true }, "responses": { "200": { "description": "Setup configuration updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericSuccessResponse" } } } }, "400": { "description": "Invalid request or setup not found", "content": {} } } } }, "/accounts/{account_id}/v2/setup/{cloudAccountID}/estimated_savings": { "post": { "tags": [ "Commitment Orchestrator Setup APIs" ], "summary": "Get estimated savings for a target coverage", "description": "Returns estimated savings data based on a target coverage percentage", "operationId": "GetEstimatedSavingsForSetup", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the Entity" }, { "name": "cloudAccountID", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Cloud Account ID for which to retrieve estimated savings data" } ], "requestBody": { "description": "Parameters for estimated savings calculation", "content": { "application/json": { "schema": { "type": "object", "properties": { "instance_types": { "type": "array", "items": { "type": "string" }, "description": "List of instance types to filter by. Empty array means all instance types." }, "regions": { "type": "array", "items": { "type": "string" }, "description": "List of regions to filter by. Empty array means all regions." }, "linked_accounts": { "type": "array", "items": { "type": "string" }, "description": "List of linked accounts to filter by. Empty array means all linked accounts." }, "service": { "type": "string", "description": "Service name to filter by, e.g., 'Amazon Elastic Compute Cloud - Compute'. Defaults to EC2 if not specified." }, "target_coverage": { "type": "number", "format": "float", "description": "Target coverage percentage (between 0 and 100)", "minimum": 0, "maximum": 100 } }, "required": [ "target_coverage" ] } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64", "description": "Timestamp of the response" }, "success": { "type": "boolean", "description": "Whether the operation was successful" }, "response": { "type": "object", "properties": { "current_coverage": { "type": "number", "format": "float", "description": "Current coverage percentage" }, "target_coverage": { "type": "number", "format": "float", "description": "Target coverage percentage" }, "current_savings": { "type": "number", "format": "float", "description": "Current savings amount" }, "estimated_savings": { "type": "number", "format": "float", "description": "Estimated savings amount at target coverage" } } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64" }, "success": { "type": "boolean", "enum": [ false ] }, "errors": { "type": "array", "items": { "type": "string" } } } } } } } } } }, "/accounts/{account_id}/v2/setup/{cloudAccountID}/cost_coverage": { "post": { "tags": [ "Commitment Orchestrator Setup APIs" ], "summary": "Get cost coverage data for setup", "description": "Returns cost breakdown and coverage data for EC2 instances, grouped by instance type, region, or account", "operationId": "GetCostCoverageForSetup", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the Entity" }, { "name": "cloudAccountID", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Cloud Account ID for which to retrieve cost coverage data" } ], "requestBody": { "description": "Cost coverage filter parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "instance_types": { "type": "array", "items": { "type": "string" }, "description": "List of instance types to filter by. Empty array means all instance types." }, "regions": { "type": "array", "items": { "type": "string" }, "description": "List of regions to filter by. Empty array means all regions." }, "linked_accounts": { "type": "array", "items": { "type": "string" }, "description": "List of linked accounts to filter by. Empty array means all linked accounts." }, "service": { "type": "string", "description": "Service name to filter by, e.g., 'Amazon Elastic Compute Cloud - Compute'" } } } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64", "description": "Timestamp of the response" }, "success": { "type": "boolean", "description": "Whether the operation was successful" }, "response": { "type": "array", "items": { "type": "object", "properties": { "start_date": { "type": "string", "format": "date", "description": "Start date of the cost data period" }, "end_date": { "type": "string", "format": "date", "description": "End date of the cost data period" }, "costs": { "type": "object", "additionalProperties": { "type": "number" }, "description": "Map of purchase types to costs. For instance type breakdown, this contains region as keys." }, "total_cost": { "type": "number", "description": "Total cost for the period" }, "committed_cost": { "type": "number", "description": "Committed cost for the period" }, "coverage": { "type": "number", "description": "Coverage percentage (committed_cost/total_cost * 100)" }, "breakdown_type": { "type": "string", "description": "Type of breakdown used (instance_type_breakdown, region_breakdown, or account_breakdown)" }, "region_breakdown": { "type": "object", "additionalProperties": { "type": "object", "properties": { "costs": { "type": "object", "additionalProperties": { "type": "number" }, "description": "Map of purchase types to costs" }, "total_cost": { "type": "number", "description": "Total cost for this region" }, "committed_cost": { "type": "number", "description": "Committed cost for this region" }, "coverage": { "type": "number", "description": "Coverage percentage for this region" } } }, "description": "Breakdown of costs by region" }, "instance_type_breakdown": { "type": "object", "additionalProperties": { "type": "object", "properties": { "costs": { "type": "object", "additionalProperties": { "type": "number" }, "description": "Map of purchase types to costs" }, "total_cost": { "type": "number", "description": "Total cost for this instance type" }, "committed_cost": { "type": "number", "description": "Committed cost for this instance type" }, "coverage": { "type": "number", "description": "Coverage percentage for this instance type" }, "region": { "type": "string", "description": "Region for this instance type" } } }, "description": "Breakdown of costs by instance type" }, "account_breakdown": { "type": "object", "additionalProperties": { "type": "object", "properties": { "costs": { "type": "object", "additionalProperties": { "type": "number" }, "description": "Map of purchase types to costs" }, "total_cost": { "type": "number", "description": "Total cost for this account" }, "committed_cost": { "type": "number", "description": "Committed cost for this account" }, "coverage": { "type": "number", "description": "Coverage percentage for this account" }, "account_name": { "type": "string", "description": "Name of the account" } } }, "description": "Breakdown of costs by account" } } } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64" }, "success": { "type": "boolean", "example": false }, "error": { "type": "string" } } } } } } } } }, "/accounts/{account_id}/v1/setup/listMasterAccounts": { "post": { "tags": [ "Commitment Orchestrator Setup APIs" ], "summary": "List master accounts for commitment Setup", "description": "Lists master accounts available for commitment orchestrator setup", "operationId": "ListMasters", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMasterSuccessResponse" } } } }, "400": { "description": "Invalid status value", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/accounts/{account_id}/v1/setup/{cloud_account_id}/child_accounts": { "get": { "tags": [ "Commitment Orchestrator Setup APIs" ], "summary": "List child accounts for a given master account", "description": "Lists child accounts with their name and id for a given master account", "operationId": "ListAccounts", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cloud_account_id", "description": "Cloud Account ID of the master account in Harness", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListChildAccountsSuccessResponse" } } } }, "400": { "description": "Invalid status value", "content": {} } } } }, "/accounts/{account_id}/v1/setup/list": { "get": { "tags": [ "Commitment Orchestrator Setup APIs" ], "summary": "List of commitment Setups", "description": "Lists setups available for commitment orchestrator", "operationId": "ListSetups", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSetupsSuccessResponse" } } } }, "400": { "description": "Invalid status value", "content": {} } } } }, "/accounts/{account_id}/v2/approvals/list": { "post": { "tags": [ "Commitment Orchestrator User Approval APIs" ], "summary": "List of Commitment transactions with filtering options", "description": "List of commitment related transactions with advanced filtering options", "operationId": "ApprovalsListV2", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "routingId", "description": "Routing Identifier for the request", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Start date for the approval period." }, { "name": "end_date", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "End date for the approval period." } ], "requestBody": { "description": "Input for filtering and pagination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalsListRequestV2" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalsListResponseV2" } } } }, "400": { "description": "Invalid request", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/accounts/{account_id}/v1/approvals/list": { "post": { "tags": [ "Commitment Orchestrator User Approval APIs" ], "summary": "List of Commitment transactions awaiting user approvals", "description": "List of commitment related transactions waiting for user approvals", "operationId": "ApprovalsList", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Input for Pagination", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PaginationInput" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalEventsSuccessResponse" } } } }, "400": { "description": "Invalid status value", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/accounts/{account_id}/v1/approvals/update": { "post": { "tags": [ "Commitment Orchestrator User Approval APIs" ], "summary": "Approve/Reject commitment transactions", "description": "Approve or Reject commitment transactions", "operationId": "ApprovalsUpdate", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Actions and their approval or rejection status", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ApprovalPayload" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericSuccessResponse" } } } }, "400": { "description": "Invalid status value", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/accounts/{account_id}/v2/approvals/overview": { "post": { "tags": [ "Commitment Orchestrator User Approval APIs" ], "summary": "Overview API with summary for different types of approval events", "description": "Overview API with summary of event types with the status and potential savings opportunities", "operationId": "ApprovalsOverview", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountIdentifier", "description": "Account Identifier for the Entity", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Input for Supported optional filters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ApprovalsOverviewRequestFilters" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalOverviewSuccessResponse" } } } }, "400": { "description": "Invalid status value", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/accounts/{account_id}/v2/savings/overview": { "post": { "tags": [ "Savings Overview" ], "summary": "Get Savings Overview", "description": "Fetches the overall savings, managed, and unmanaged savings for the provided account.", "operationId": "GetSavingsOverview", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity." }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing." }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" }, "description": "Start date for the savings period." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" }, "description": "End date for the savings period." }, { "name": "accountIdentifier", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Identifier of the account." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "service": { "type": "string", "enum": [ "Amazon Relational Database Service", "Amazon Elastic Compute Cloud - Compute", "VirtualMachines" ], "default": "Amazon Elastic Compute Cloud - Compute" } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavingsOverviewResponse" } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{accountId}/v2/savings/detail": { "post": { "tags": [ "Savings Detail" ], "summary": "Fetch savings details", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The account ID" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing ID" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" }, "description": "Start date for the savings query" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" }, "description": "End date for the savings query" }, { "name": "accountIdentifier", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Account identifier" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "group_by": { "type": "string", "enum": [ "Regions", "Commitment Type", "Instance family" ], "description": "The dimension to group savings by" }, "is_harness_managed": { "type": "boolean", "description": "Indicates whether the savings are managed by Harness" }, "service": { "type": "string", "enum": [ "Amazon Relational Database Service", "Amazon Elastic Compute Cloud - Compute", "VirtualMachines" ], "default": "Amazon Elastic Compute Cloud - Compute" } }, "required": [ "group_by", "is_harness_managed" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavingsDetailResponse" } } } } } } }, "/accounts/{account_id}/v1/detail/commitment_utilisation": { "get": { "tags": [ "Commitment Utilization" ], "summary": "Get commitment utilization details", "description": "Retrieves detailed utilization data for savings plans and reserved instances with charts and trends", "operationId": "GetCommitmentUtilizationDetails", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" }, { "name": "accountIdentifier", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Account identifier" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-01" }, "description": "Start date for the utilization data period" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-31" }, "description": "End date for the utilization data period" }, { "name": "regions", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Filter by regions (Note: Regional filtering has limitations for savings plans)", "style": "form", "explode": true }, { "name": "cloud_account_ids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Filter by cloud account IDs", "style": "form", "explode": true }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service" ] }, "description": "Filter by AWS service" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitmentUtilizationDetailResponse" } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{account_id}/v2/savings/savings-rate": { "post": { "tags": [ "Savings Rate" ], "summary": "Get Effective Savings Rate", "description": "Fetches the effective savings rate and total spend percentage for the given account within the specified date range.", "operationId": "GetSavingsRate", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity." }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing." }, { "name": "accountIdentifier", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Identifier of the account." }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "example": "2021-10-19" }, "description": "Start date for the savings calculation period." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "example": "2021-10-19" }, "description": "End date for the savings calculation period." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtilizationOverviewRequestFilters" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavingsRateResponse" } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{accountId}/v2/utilisation/overview": { "post": { "tags": [ "Utilization Overview" ], "summary": "Get Utilization Overview", "parameters": [ { "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the account" }, { "in": "query", "name": "routingId", "required": true, "schema": { "type": "string" }, "description": "The routing ID for the account" }, { "in": "query", "name": "start_date", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The start date for the utilization data" }, { "in": "query", "name": "end_date", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The end date for the utilization data" }, { "in": "query", "name": "accountIdentifier", "required": true, "schema": { "type": "string" }, "description": "The identifier of the account for context" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "service": { "type": "string", "enum": [ "Amazon Relational Database Service", "Amazon Elastic Compute Cloud - Compute", "VirtualMachines" ], "default": "Amazon Elastic Compute Cloud - Compute", "description": "Service to fetch the details for. VirtualMachines returns Azure reservation and savings plan utilization." } } } } } }, "responses": { "200": { "description": "Successful response with utilization overview", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtilizationOverviewResponse" } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{account_id}/v2/spend/overview": { "post": { "tags": [ "Spend Overview" ], "summary": "Get overall spend breakdown across RI, SP and Ondemand cost", "description": "Fetches spend breakdown across RI, SP and Ondemand cost in terms of cost incurred for the given account within the specified date range.", "operationId": "SpendOverview", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity." }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing." }, { "name": "accountIdentifier", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Identifier of the account." }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "example": "2021-10-19" }, "description": "Start date for the spend calculation period." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "example": "2021-10-19" }, "description": "End date for the spend calculation period." } ], "requestBody": { "required": false, "description": "Filters for Spend Overview", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SpendBreakdownFilter" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpendBreakdownResponse" } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{account_id}/v2/spend/detail": { "post": { "tags": [ "Spend Details" ], "summary": "Get detailed breakdown of spend across RI, SP and Ondemand cost with charts and tabular data", "description": "Get detailed breakdown of spend across RI, SP and Ondemand cost", "operationId": "SpendDetails", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity." }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing." }, { "name": "accountIdentifier", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Identifier of the account." }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "example": "2021-10-19" }, "description": "Start date for the spend calculation period." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "example": "2021-10-19" }, "description": "End date for the spend calculation period." } ], "requestBody": { "required": false, "description": "Supported filters for Spends", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SpendBreakdownFilter" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpendBreakdownResponse" } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{account_id}/v2/coverage/overview": { "post": { "tags": [ "Coverage Overview" ], "summary": "Get overall coverage across RI, SP and Ondemand", "description": "Fetches coverage across RI, SP and Ondemand cost in terms of cost incurred for the given account within the specified date range.", "operationId": "CoverageOverview", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity." }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing." }, { "name": "accountIdentifier", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Identifier of the account." }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "example": "2021-10-19" }, "description": "Start date for the compute coverage calculation period." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "example": "2021-10-19" }, "description": "End date for the compute coverage calculation period." } ], "requestBody": { "required": false, "description": "Service definition", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CopmputeCoverageFilter" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputeCoverageResponse" } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{account_id}/v2/coverage/detail": { "post": { "tags": [ "Coverage Detail" ], "summary": "Get detailed coverage breakdown by specified grouping", "description": "Fetches detailed coverage breakdown for specific dimensions like Instance Family, Region, etc. within the specified date range.", "operationId": "CoverageDetail", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity." }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing." }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-01" }, "description": "Start date for the coverage calculation period." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-31" }, "description": "End date for the coverage calculation period." }, { "name": "accountIdentifier", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Identifier of the account." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "group_by": { "type": "string", "enum": [ "Instance Family", "Region", "Machine Type" ], "description": "Dimension to group coverage data by" }, "service": { "type": "string", "enum": [ "Amazon Relational Database Service", "Amazon Elastic Compute Cloud - Compute", "VirtualMachines" ], "default": "Amazon Elastic Compute Cloud - Compute", "description": "Service to fetch the details for." } }, "required": [ "group_by" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputeCoveragesDetailResponse" } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{account_id}/v2/coverage/details/savingsplans": { "post": { "tags": [ "Coverage Details" ], "summary": "Get Savings Plans coverage details", "description": "Returns SP coverage detail rows grouped by (service, instance_family, region). Each row contains SP-covered spend, on-demand spend and coverage percentage for the given date range.", "operationId": "SPCoverageDetails", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity." }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing." }, { "name": "accountIdentifier", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Identifier of the account." }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-01" }, "description": "Start date for the coverage calculation period." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-31" }, "description": "End date for the coverage calculation period." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopmputeCoverageFilter" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SPCoverageDetailsResponse" } } } }, "400": { "description": "Invalid request parameters" }, "500": { "description": "Internal server error" } } } }, "/accounts/{account_id}/v2/coverage/details/reservedinstances": { "post": { "tags": [ "Coverage Details" ], "summary": "Get Reserved Instances coverage details", "description": "Returns RI coverage detail rows grouped by (instance_type, platform, tenancy, region). Each row contains reservation covered hours, on-demand hours, total running hours, on-demand cost and average coverage percentage for the given date range.", "operationId": "RICoverageDetails", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity." }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing." }, { "name": "accountIdentifier", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Identifier of the account." }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-01" }, "description": "Start date for the coverage calculation period." }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-31" }, "description": "End date for the coverage calculation period." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopmputeCoverageFilter" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RICoverageDetailsResponse" } } } }, "400": { "description": "Invalid request parameters" }, "500": { "description": "Internal server error" } } } }, "/accounts/{account_id}/v2/inventory/ri/overview": { "post": { "tags": [ "RI Inventory Overview" ], "summary": "Get Reserved Instance Inventory Overview", "description": "Fetches overview of Reserved Instance inventory including total counts, distribution, status, and pending actions", "operationId": "GetRIInventoryOverview", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the Entity" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2022-01-01" }, "description": "Start date for the inventory period" }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2025-08-30" }, "description": "End date for the inventory period" } ], "requestBody": { "description": "Optional filters for the RI inventory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryRIAPIFilter" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RIInventoryOverviewResponse" } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{account_id}/v2/inventory/sp/overview": { "post": { "tags": [ "SP Inventory Overview" ], "summary": "Get Savings Plans Inventory Overview", "description": "Fetches overview of Savings Plans inventory including total counts, distribution, status, and pending actions", "operationId": "GetSPInventoryOverview", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the Entity" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start date for the inventory period" }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2025-08-30" }, "description": "End date for the inventory period" } ], "requestBody": { "description": "Optional filters for the SP inventory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventorySPAPIFilter" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SPInventoryOverviewResponse" } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{account_id}/v2/inventory/ri/list": { "post": { "tags": [ "RI Inventory APIs" ], "summary": "List Reserved Instances", "description": "Retrieves a paginated list of Reserved Instances with optional filtering", "operationId": "ListReservedInstances", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the Entity" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2020-01-01" }, "description": "Start date for filtering Reserved Instances" }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2025-08-30" }, "description": "End date for filtering Reserved Instances" } ], "requestBody": { "description": "Pagination and filtering options", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListReservedInstancesRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListReservedInstancesResponse" } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{account_id}/v2/inventory/sp/list": { "post": { "tags": [ "SP Inventory APIs" ], "summary": "List Savings Plans", "description": "Retrieves a paginated list of Savings Plans with optional filtering", "operationId": "ListSavingsPlans", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the Entity" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2020-01-01" }, "description": "Start date for filtering Savings Plans" }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2025-08-30" }, "description": "End date for filtering Savings Plans" } ], "requestBody": { "description": "Pagination and filtering options", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSavingsPlansRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSavingsPlansResponse" } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{account_id}/v2/inventory/ri/{riId}/detail": { "get": { "tags": [ "RI Inventory APIs" ], "summary": "Get Reserved Instance Details", "description": "Retrieves detailed information about a specific Reserved Instance", "operationId": "GetReservedInstanceDetails", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the Entity" }, { "name": "riId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the Reserved Instance" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservedInstanceDetailsResponse" } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "Reserved Instance not found" } } } }, "/accounts/{account_id}/v2/inventory/sp/{spId}/detail": { "get": { "tags": [ "SP Inventory APIs" ], "summary": "Get Savings Plan Details", "description": "Retrieves detailed information about a specific Savings Plan", "operationId": "GetSavingsPlanDetails", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the Entity" }, { "name": "spId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the Savings Plan" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavingsPlanDetailsResponse" } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "Savings Plan not found" } } } }, "/accounts/{account_id}/v2/filters/ri": { "get": { "tags": [ "RI Inventory APIs" ], "summary": "Get Reserved Instance Filter Options", "description": "Retrieves available filter options for Reserved Instances including account IDs, instance types, platforms, etc.", "operationId": "GetRIFilterOptions", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the Entity" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Amazon Relational Database Service", "Amazon Elastic Compute Cloud - Compute", "VirtualMachines" ] }, "description": "Service to fetch filters for. VirtualMachines returns Azure reservation filters, which include instance families (VM series) but no RI types or tenancy." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Indicates if the request was successful" }, "errors": { "type": "string", "nullable": true, "description": "Error details, if any" }, "response": { "$ref": "#/components/schemas/InventoryRIAPIFilter" } } } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{account_id}/v2/filters/sp": { "get": { "tags": [ "SP Inventory APIs" ], "summary": "Get Savings Plans Filter Options", "description": "Retrieves available filter options for Savings Plans including account IDs, instance families, payment options, etc.", "operationId": "GetSPFilterOptions", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the Entity" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Amazon Relational Database Service", "Amazon Elastic Compute Cloud - Compute", "VirtualMachines" ] }, "description": "Service to fetch filters for. VirtualMachines returns Azure savings plan filters, where the only plan type is AzureComputeSavingsPlans." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Indicates if the request was successful" }, "errors": { "type": "string", "nullable": true, "description": "Error details, if any" }, "response": { "$ref": "#/components/schemas/InventorySPAPIFilter" } } } } } }, "400": { "description": "Invalid request parameters" } } } }, "/accounts/{account_id}/v1/filters": { "post": { "tags": [ "Filter APIs" ], "summary": "Get all filter options", "description": "Retrieves all available filter options including regions, instance families, and provider account IDs for the specified account and optional date range.", "operationId": "GetFilters", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-10-19" }, "description": "Start date for filtering data (YYYY-MM-DD format)" }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-10-19" }, "description": "End date for filtering data (YYYY-MM-DD format)" }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service" ] }, "description": "AWS service type for filtering. Supported services are EC2 and RDS" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterResponse" } } } }, "400": { "description": "Invalid request parameters or unsupported service" } } } }, "/accounts/{account_id}/v1/filters/regions": { "post": { "tags": [ "Filter APIs" ], "summary": "Get available regions", "description": "Retrieves all available AWS regions for the specified account and optional date range.", "operationId": "GetRegionFilters", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-10-19" }, "description": "Start date for filtering data (YYYY-MM-DD format)" }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-10-19" }, "description": "End date for filtering data (YYYY-MM-DD format)" }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service", "VirtualMachines" ] }, "description": "Service type for filtering. Supported services are AWS EC2, AWS RDS and Azure VirtualMachines" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "example": [ "us-east-1", "us-west-2", "eu-west-1" ] } } } }, "400": { "description": "Invalid request parameters or unsupported service" } } } }, "/accounts/{account_id}/v1/filters/instancefamilies": { "post": { "tags": [ "Filter APIs" ], "summary": "Get available instance families", "description": "Retrieves all available instance families for the specified account and optional date range.", "operationId": "GetInstanceFamilyFilters", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-10-19" }, "description": "Start date for filtering data (YYYY-MM-DD format)" }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-10-19" }, "description": "End date for filtering data (YYYY-MM-DD format)" }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service", "VirtualMachines" ] }, "description": "Service type for filtering. Supported services are AWS EC2, AWS RDS and Azure VirtualMachines" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "example": [ "m5", "c5", "r5", "db.t3", "db.r5" ] } } } }, "400": { "description": "Invalid request parameters or unsupported service" } } } }, "/accounts/{account_id}/v1/filters/provideraccounts": { "post": { "tags": [ "Filter APIs" ], "summary": "Get available provider account IDs", "description": "Retrieves all available cloud provider account IDs for the specified account and optional date range.", "operationId": "GetProviderAccountFilters", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Account Identifier for the entity" }, { "name": "routingId", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Routing identifier for request processing" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-10-19" }, "description": "Start date for filtering data (YYYY-MM-DD format)" }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-10-19" }, "description": "End date for filtering data (YYYY-MM-DD format)" }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service", "VirtualMachines" ] }, "description": "Service type for filtering. Supported services are AWS EC2, AWS RDS and Azure VirtualMachines" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "example": [ "123456789012", "987654321098" ] } } } }, "400": { "description": "Invalid request parameters or unsupported service" } } } }, "/accounts/{account_id}/v2/landing": { "get": { "tags": [ "Commitment Orchestrator Landing Page" ], "summary": "Get commitment landing page data", "description": "Obtains list of cloud account connectors with their commitment status, coverage, and savings information", "operationId": "LandingPageHandler", "parameters": [ { "name": "account_id", "description": "Account Identifier for the Entity", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LandingPageResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } } }, "components": { "schemas": { "LandingPageResponse": { "type": "object", "required": [ "ts", "success", "response" ], "properties": { "ts": { "type": "integer", "format": "int64", "description": "Timestamp of the response", "example": 1747338580 }, "success": { "type": "boolean", "description": "Indicates if the request was successful", "example": true }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Error messages if any", "example": null }, "response": { "type": "array", "description": "List of cloud accounts with their commitment details", "items": { "$ref": "#/components/schemas/CloudAccountCommitment" } } } }, "CloudAccountCommitment": { "type": "object", "required": [ "cloud_provider", "provider_id", "name", "cloud_account_id", "connector_status", "services" ], "properties": { "cloud_provider": { "type": "string", "enum": [ "AWS", "AZURE" ], "description": "Cloud provider of the account", "example": "AWS" }, "provider_id": { "type": "string", "description": "Cloud provider account ID (AWS account ID, or Azure tenant ID for AZURE)", "example": "101852341822" }, "name": { "type": "string", "description": "Display name of the cloud account", "example": "Master Payer CCM" }, "cloud_account_id": { "type": "string", "description": "Unique identifier for the cloud account", "example": "Master_Payer_CCM" }, "connector_status": { "type": "string", "enum": [ "SUCCESS", "FAILURE", "UNKNOWN" ], "description": "Status of the connector (SUCCESS, FAILURE, UNKNOWN)", "example": "FAILURE" }, "last_ping": { "type": "string", "format": "date-time", "description": "Last time the connector was pinged", "example": "2025-05-15T03:01:49-07:00" }, "services": { "type": "array", "description": "List of services with their commitment details", "items": { "$ref": "#/components/schemas/CommitmentService" } } } }, "CommitmentService": { "type": "object", "required": [ "name", "is_enabled", "coverage", "target_coverage", "annualized_savings" ], "properties": { "name": { "type": "string", "description": "Name of the service", "example": "Amazon Elastic Compute Cloud - Compute" }, "is_enabled": { "type": "boolean", "description": "Whether the service is enabled for commitment orchestration", "example": true }, "coverage": { "type": "number", "format": "double", "description": "Current coverage percentage", "example": 41.422 }, "target_coverage": { "type": "number", "format": "double", "description": "Target coverage percentage", "example": 85 }, "annualized_savings": { "type": "string", "description": "Annualized savings amount as a string", "example": "417217.58" }, "approval_mode": { "type": "string", "description": "Approval mode for the service (auto or manual)", "example": "manual" }, "pending_actions_count": { "type": "integer", "format": "int64", "description": "Count of pending approval actions for the service in the last 30 days", "example": 0 }, "atomization_enabled": { "type": "boolean", "description": "Whether Atom 2.0 (monthly seed purchase) is enabled. Present only for EC2 service.", "example": true } } }, "PaginationInput": { "type": "object", "properties": { "limit": { "type": "integer", "maximum": 100, "example": 20 }, "page": { "type": "integer", "example": 1, "maximum": 100 } } }, "EventsFilter": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "string" } }, "group_by": { "type": "string" }, "service": { "type": "string", "enum": [ "Amazon Relational Database Service", "Amazon Elastic Compute Cloud - Compute" ], "default": "Amazon Elastic Compute Cloud - Compute", "description": "Service to fetch the details for." } } }, "GenericFilter": { "type": "object", "properties": { "field": { "type": "string", "description": "Field name to filter by (e.g., region, account_id, etc.)", "example": "region" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of values to filter by", "example": [ "us-east-1" ] } }, "required": [ "field", "values" ] }, "EventLogsRequest": { "type": "object", "properties": { "limit": { "type": "integer", "maximum": 100, "example": 20, "description": "Number of results per page" }, "page": { "type": "integer", "example": 1, "maximum": 100, "description": "Page number" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/GenericFilter" }, "description": "Array of filters to apply to the event logs" } } }, "RIRecommendationSchedule": { "type": "object", "properties": { "minIntervalDays": { "type": "integer", "description": "Minimum calendar days after the last completed RI approval transaction before a non-force recommendation run proceeds" }, "lastTransactionAt": { "type": "string", "format": "date-time", "description": "Omitted when no qualifying completed approval transaction exists (e.g. recommendation job never ran or none completed yet). Otherwise, updated time of the latest transaction used for cooldown." }, "nextEligibleAt": { "type": "string", "format": "date-time", "description": "Earliest time a non-force run clears the cooldown; omitted when there is no prior transaction or cooldown is disabled" }, "isEligibleNow": { "type": "boolean", "description": "Whether a non-force recommendation run would not be skipped for cooldown reasons" }, "lastRunCompletedAt": { "type": "string", "format": "date-time", "description": "When the latest completed RI recommendation engine job finished for this cloud account and service" }, "recommendationsGenerated": { "type": "integer", "description": "Number of RI recommendations enqueued in that last completed run" }, "noNewRecommendationsReason": { "type": "string", "description": "When no new recommendations were produced, machine-readable reason (e.g. target_coverage_achieved, guardrails_validation_failed, pending_jobs_or_cooldown, recommendation_cooldown, no_forecast_data)" }, "noNewRecommendationsReasonMessage": { "type": "string", "description": "Default English explanation for the UI when noNewRecommendationsReason is set; clients may localize using noNewRecommendationsReason as the key" } } }, "RIRecommendationScheduleSuccessResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation is successful" }, "errors": { "type": "string", "description": "Specifies the error if the operation failed" }, "response": { "$ref": "#/components/schemas/RIRecommendationSchedule" } } }, "EventLogsSuccessResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation is successful" }, "errors": { "type": "string", "description": "Specifies the error if the operation failed" }, "response": { "type": "object", "properties": { "total": { "type": "integer" }, "pages": { "type": "integer" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/EventResponse" } } } } } }, "EventResponse": { "type": "object", "properties": { "id": { "type": "integer" }, "cloud_account_id": { "type": "string" }, "account_id": { "type": "string" }, "transaction_id": { "type": "string" }, "event_type": { "type": "string" }, "region": { "type": "string" }, "category": { "type": "string" }, "status": { "type": "string" }, "created_at": { "type": "string", "example": "2023-07-14T00:59:00.619568Z" }, "updated_at": { "type": "string", "example": "2023-07-14T00:59:00.619568Z" }, "metadata": { "type": "object" }, "description": { "type": "string" } } }, "EventsChartsSuccessResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation is successful" }, "errors": { "type": "string", "description": "Specifies the error if the operation failed" }, "response": { "type": "object", "properties": { "total": { "type": "integer" }, "pages": { "type": "integer" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/ChartResponse" } } } } } }, "ChartResponse": { "type": "object", "properties": { "date": { "type": "string", "example": "2023-07-14T00:59:00.619568Z" }, "count": { "type": "integer" }, "event_type": { "type": "string" } } }, "RenewalEventsRequest": { "type": "object", "properties": { "cloud_account_ids": { "type": "array", "items": { "type": "string" }, "description": "When non-empty, only renewal events for these cloud accounts are returned" }, "start_date": { "type": "string", "format": "date", "description": "Start of filter range (YYYY-MM-DD). Defaults to 30 days before today (UTC) when omitted.", "example": "2025-01-01" }, "end_date": { "type": "string", "format": "date", "description": "End of filter range (YYYY-MM-DD). Defaults to today (UTC) when omitted.", "example": "2025-01-31" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "When non-empty, only events whose region matches one of these values" }, "service": { "type": "string", "description": "AWS service type; defaults to Amazon Elastic Compute Cloud - Compute when omitted", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service" ], "default": "Amazon Elastic Compute Cloud - Compute" } } }, "RenewalEvent": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Activity row identifier" }, "cloud_account_id": { "type": "string" }, "region": { "type": "string" }, "status": { "type": "string", "description": "Activity status (e.g. pending, complete)" }, "expiry_date": { "type": "string", "format": "date", "description": "Reservation expiry date from activity metadata (YYYY-MM-DD)" }, "renewal_scheduled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Present when status indicates renewal scheduling completed; mirrors last update time" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the activity was last updated" }, "description": { "type": "string", "description": "Human-readable activity description" } } }, "RenewalEventsSuccessResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation is successful" }, "errors": { "type": "string", "description": "Specifies the error if the operation failed", "nullable": true }, "response": { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/RenewalEvent" }, "description": "Auto-renewal events in the requested range and filters" } } } } }, "AutoCUDSetup": { "type": "object", "properties": { "account_id": { "type": "string" }, "cloud_account_id": { "type": "string" }, "enabled": { "type": "boolean" }, "config": { "type": "object", "items": { "$ref": "#/components/schemas/AutoCUDConfig" } } } }, "AutoCUDConfig": { "type": "object", "properties": { "exclusion_list": { "type": "array", "items": { "$ref": "#/components/schemas/ExclusionEntry" } }, "excluded_cloud_accounts": { "type": "array", "items": { "type": "string" } }, "total_coverage": { "type": "integer", "minimum": 0, "maximum": 1 }, "savings_plan_layering": { "type": "object", "description": "Savings Plan laddering configuration", "properties": { "enabled": { "type": "boolean", "description": "Whether Savings Plan laddering is enabled", "default": false }, "aggressiveness": { "type": "string", "description": "Ladder purchase pace. Maps to configurable purchase fractions (slow/balanced/aggressive). Balanced and omitted use autocud.sp_ladder_purchase_fraction; slow and aggressive use their own config keys. Defaults target ≈25%/50%/75% coverable demand in the first month.", "enum": [ "slow", "balanced", "aggressive" ] } } }, "max_sp_hourly_commitment": { "type": "number", "format": "double", "description": "Maximum hourly commitment for a net-new Savings Plan purchase in USD/hour; 0 or omitted means no ceiling", "minimum": 0 }, "preferred_commitment_mode": { "type": "string", "description": "Commitment type that receives the shared coverage budget first", "enum": [ "ri_preferred", "sp_preferred" ], "default": "ri_preferred" } }, "required": [ "total_coverage" ] }, "InstanceTypesPayload": { "type": "object", "properties": { "instance_families": { "type": "array", "items": { "type": "string" } }, "excluded_cloud_accounts": { "type": "array", "items": { "type": "string" } }, "regions": { "type": "array", "items": { "type": "string" } }, "service": { "type": "string", "enum": [ "Amazon Relational Database Service", "Amazon Elastic Compute Cloud - Compute" ], "default": "Amazon Elastic Compute Cloud - Compute", "description": "Service to fetch the details for." } } }, "ExclusionEntry": { "type": "object", "properties": { "instance_type": { "type": "string", "example": "t2.micro" }, "region": { "type": "string", "example": "us-east-1" } } }, "ApprovalPayload": { "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalAction" } } } }, "ApprovalAction": { "type": "object", "properties": { "id": { "type": "integer", "example": 13, "description": "ID of the event being approved or rejected" }, "status": { "type": "string", "example": "APPROVED", "enum": [ "APPROVED", "REJECTED" ] }, "term_seconds": { "type": "integer", "format": "int64", "example": 94608000, "description": "Selected Savings Plan term; omitted values keep the event's current term" }, "payment_option": { "type": "string", "example": "All Upfront", "enum": [ "No Upfront", "Partial Upfront", "All Upfront" ], "description": "Selected Savings Plan payment option; omitted values keep the event's current payment option" } } }, "ApprovalEvent": { "type": "object", "properties": { "id": { "type": "integer" }, "category": { "type": "string" }, "cloud_account_id": { "type": "string" }, "account_id": { "type": "string" }, "evaluated_at": { "type": "string" }, "metadata": { "type": "object", "description": "Map of key and value with data specific to the event type" } } }, "ApprovalEventSummary": { "type": "object", "properties": { "savings_potential": { "type": "number" }, "event_count": { "type": "integer" }, "event_type": { "type": "string" }, "event_status": { "type": "string" } } }, "SetupValidateSuccessResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation is successful" }, "errors": { "type": "string", "description": "Specifies the error if the operation failed" }, "response": { "type": "object", "properties": { "savings_plan_max_percentage": { "type": "integer", "maximum": 1, "minimum": 0 } } } } }, "SetupInstanceTypesSuccessResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation is successful" }, "errors": { "type": "string", "description": "Specifies the error if the operation failed" }, "response": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/ListInstanceTypesContent" } } } } } }, "ListInstanceTypesContent": { "type": "object", "properties": { "compute_spend": { "type": "number" }, "coverage_percentage": { "type": "number" }, "region": { "type": "string" }, "instance_type": { "type": "string" } } }, "ListMasterSuccessResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation is successful" }, "errors": { "type": "string", "description": "Specifies the error if the operation failed" }, "response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/ListMasterContent" } } } } } } } }, "ListMasterContent": { "type": "object", "properties": { "connector": { "$ref": "#/components/schemas/Connector" } } }, "Connector": { "type": "object", "properties": { "accountIdentifier": { "type": "string" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "spec": { "type": "object" } } }, "ListSetupsSuccessResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation is successful" }, "errors": { "type": "string", "description": "Specifies the error if the operation failed" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCUDSetup" } } } }, "GenericSuccessResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation is successful" }, "errors": { "type": "string", "description": "Specifies the error if the operation failed" } } }, "ApprovalEventsSuccessResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation is successful" }, "errors": { "type": "string", "description": "Specifies the error if the operation failed" }, "response": { "type": "object", "properties": { "total": { "type": "integer" }, "pages": { "type": "integer" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalEvent" } } } } } }, "ApprovalOverviewSuccessResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation is successful" }, "errors": { "type": "string", "description": "Specifies the error if the operation failed" }, "response": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalEventSummary" } } } } } }, "ListChildAccountsSuccessResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation is successful" }, "errors": { "type": "string", "description": "Specifies the error if the operation failed" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/KeyValuePair" } } } }, "KeyValuePair": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "SavingsOverviewResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation was successful" }, "errors": { "type": "string", "description": "Error message, if any" }, "response": { "type": "object", "properties": { "overall_savings": { "type": "number", "format": "double", "description": "Total savings amount" }, "managed_savings_total": { "type": "number", "format": "double", "description": "Total managed savings" }, "unmanaged_savings_total": { "type": "number", "format": "double", "description": "Total unmanaged savings" }, "savings_plans": { "type": "object", "properties": { "managed_savings": { "$ref": "#/components/schemas/SavingsDetails" }, "unmanaged_savings": { "$ref": "#/components/schemas/SavingsDetails" }, "sp_total": { "type": "number", "format": "double", "description": "Total savings plan amount" }, "sp_percentage": { "type": "number", "format": "double", "description": "Savings plan percentage" } } }, "reserved_instances": { "type": "object", "properties": { "managed_savings": { "$ref": "#/components/schemas/SavingsDetails" }, "unmanaged_savings": { "$ref": "#/components/schemas/SavingsDetails" }, "ri_total": { "type": "number", "format": "double", "description": "Total reserved instance savings" }, "ri_percentage": { "type": "number", "format": "double", "description": "Reserved instance savings percentage" } } } } } } }, "SavingsDetails": { "type": "object", "properties": { "total": { "type": "number", "format": "double", "description": "Total amount of savings" }, "percentage": { "type": "number", "format": "double", "description": "Percentage of savings" } } }, "SavingsDetailResponse": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64", "description": "Timestamp of the response" }, "success": { "type": "boolean", "description": "Indicates whether the request was successful" }, "errors": { "type": "string", "description": "Error message, if any" }, "response": { "type": "object", "additionalProperties": { "type": "object", "properties": { "table": { "type": "object", "properties": { "total": { "type": "number", "format": "double", "description": "Total savings amount" }, "percentage": { "type": "number", "format": "float", "description": "Percentage savings" }, "trend": { "type": "number", "format": "float", "description": "Trend in savings percentage", "nullable": true } } }, "chart": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "Date of the savings data" }, "savings": { "type": "number", "format": "double", "description": "Savings amount for the date" } } } } } } } } }, "SpendsDetailResponse": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64", "description": "Timestamp of the response" }, "success": { "type": "boolean", "description": "Indicates whether the request was successful" }, "errors": { "type": "string", "description": "Error message, if any" }, "response": { "type": "object", "additionalProperties": { "type": "object", "properties": { "table": { "type": "object", "properties": { "total_spend": { "type": "number", "format": "double", "description": "Total savings amount" }, "service": { "type": "string", "description": "AWS Service name" } } }, "chart": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "Date of the spend data" }, "spend_amount": { "type": "number", "format": "double", "description": "Spend amount for the date" } } } } } } } } }, "SavingsRateResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation was successful" }, "errors": { "type": "string", "description": "Error message, if any" }, "response": { "type": "object", "properties": { "effective_savings_rate": { "type": "number", "format": "double", "description": "Effective savings rate percentage." }, "total_spend_percentage": { "type": "number", "format": "double", "description": "Total spend percentage." } } } } }, "UtilizationOverviewResponse": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64", "description": "Timestamp of the response" }, "success": { "type": "boolean", "description": "Indicates if the request was successful" }, "errors": { "type": "object", "nullable": true, "description": "Error details, if any" }, "response": { "type": "object", "properties": { "overall_percentage": { "type": "number", "format": "float", "description": "Overall utilization percentage" }, "overall_managed_percentage": { "type": "number", "format": "float", "description": "Managed utilization percentage" }, "overall_unmanaged_percentage": { "type": "number", "format": "float", "description": "Unmanaged utilization percentage" }, "reservations": { "$ref": "#/components/schemas/ReservationsData" }, "savings_plans": { "$ref": "#/components/schemas/SavingsPlansData" } } } } }, "ReservationsData": { "type": "object", "properties": { "percentage": { "type": "number", "format": "float", "description": "Reservation utilization percentage" }, "managed": { "type": "object", "properties": { "utilization_percentage": { "type": "number", "format": "float", "description": "Managed reservation utilization percentage" } } }, "unmanaged": { "type": "object", "properties": { "utilization_percentage": { "type": "number", "format": "float", "description": "Unmanaged reservation utilization percentage" } } } } }, "SavingsPlansData": { "type": "object", "properties": { "percentage": { "type": "number", "format": "float", "description": "Savings plans utilization percentage" }, "managed": { "type": "object", "properties": { "utilization_percentage": { "type": "number", "format": "float", "description": "Managed savings plans utilization percentage" } } }, "unmanaged": { "type": "object", "properties": { "utilization_percentage": { "type": "number", "format": "float", "description": "Unmanaged savings plans utilization percentage" } } } } }, "UtilizationOverviewRequestFilters": { "type": "object", "properties": { "instance_families": { "type": "array", "items": { "type": "string" }, "description": "List of instance families" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "List of regions to filter by" }, "cloud_account_ids": { "type": "array", "items": { "type": "string" }, "description": "List of cloud account IDs to filter by" }, "service": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service", "VirtualMachines" ] } } }, "ApprovalsOverviewRequestFilters": { "type": "object", "properties": { "regions": { "type": "array", "items": { "type": "string" }, "description": "List of regions to filter by" }, "cloud_account_ids": { "type": "array", "items": { "type": "string" }, "description": "List of cloud account IDs to filter by" }, "service": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service" ] } } }, "SpendDetailed": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "description": "Cost value" }, "percentage": { "type": "number", "format": "double", "description": "Cost value as a percentage" } } }, "SpendBreakdownResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation was successful" }, "errors": { "type": "string", "description": "Error message, if any" }, "response": { "type": "object", "properties": { "total": { "type": "number", "format": "double", "description": "Total spend value in dollars." }, "trend": { "type": "number", "format": "double", "nullable": true, "description": "Trend in spend value compared to the previous period (in percentage)." }, "ondemand": { "$ref": "#/components/schemas/SpendDetailed" }, "savings_plans": { "$ref": "#/components/schemas/SpendDetailed" }, "reserved_instances": { "$ref": "#/components/schemas/SpendDetailed" }, "unused_commitments": { "$ref": "#/components/schemas/SpendDetailed" } } } } }, "SpendBreakdownFilter": { "type": "object", "properties": { "regions": { "type": "array", "items": { "type": "string" } }, "instance_types": { "type": "array", "items": { "type": "string" } }, "cloud_account_ids": { "type": "array", "items": { "type": "string" } }, "service": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service", "VirtualMachines" ] } } }, "CoverageDetailed": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "description": "Cost value" }, "percentage": { "type": "number", "format": "double", "description": "Cost value as a percentage" } } }, "ComputeCoverageResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Specifies if the operation was successful" }, "errors": { "type": "string", "description": "Error message, if any" }, "response": { "type": "object", "properties": { "total_spend": { "type": "number", "format": "double", "description": "Total spend value in dollars" }, "total_coverage_percentage": { "type": "number", "format": "double", "description": "Percentage of the total spend value in dollars" }, "average_coverage_percentage": { "type": "number", "format": "double", "description": "Average Percentage of the total spend value in dollars" }, "ondemand": { "$ref": "#/components/schemas/CoverageDetailed" }, "savings_plans": { "$ref": "#/components/schemas/CoverageDetailed" }, "reserved_instances": { "$ref": "#/components/schemas/CoverageDetailed" } } } } }, "CopmputeCoverageFilter": { "type": "object", "properties": { "regions": { "type": "array", "items": { "type": "string" } }, "instance_types": { "type": "array", "items": { "type": "string" } }, "cloud_account_ids": { "type": "array", "items": { "type": "string" } }, "service": { "type": "string", "enum": [ "Amazon Elastic Compute Cloud - Compute", "Amazon Relational Database Service", "VirtualMachines" ] }, "sort_by": { "type": "string", "description": "Field to sort by. SP: sp_covered_spend, on_demand_spend, coverage_percentage. RI: average_coverage, reservation_covered_hrs, on_demand_hrs, total_running_hrs, on_demand_cost." }, "sort_order": { "type": "string", "enum": [ "asc", "desc" ], "description": "Sort direction. Defaults to desc if not specified." } } }, "ComputeCoveragesDetailResponse": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64", "description": "Timestamp of the response" }, "success": { "type": "boolean", "description": "Indicates whether the request was successful" }, "errors": { "type": "string", "description": "Error message, if any" }, "response": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ComputeCoveragesDetail" } } } }, "SPCoverageDetailsResponse": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64", "description": "Timestamp of the response" }, "success": { "type": "boolean", "description": "Indicates whether the request was successful" }, "errors": { "type": "string", "nullable": true, "description": "Error message, if any" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/SPCoverageDetailRow" }, "description": "List of SP coverage detail rows grouped by service, instance family and region" } } }, "SPCoverageDetailRow": { "type": "object", "properties": { "service": { "type": "string", "description": "AWS service name (e.g. Amazon Elastic Compute Cloud - Compute)", "example": "Amazon Elastic Compute Cloud - Compute" }, "instance_family": { "type": "string", "description": "Instance family (e.g. t3, m5)", "example": "t3" }, "region": { "type": "string", "description": "AWS region", "example": "us-east-1" }, "sp_covered_spend": { "type": "number", "format": "double", "description": "Spend covered by savings plans" }, "on_demand_spend": { "type": "number", "format": "double", "description": "On-demand spend not covered by savings plans" }, "coverage_percentage": { "type": "number", "format": "double", "description": "Percentage of total spend covered by savings plans (0-100)" } } }, "RICoverageDetailsResponse": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64", "description": "Timestamp of the response" }, "success": { "type": "boolean", "description": "Indicates whether the request was successful" }, "errors": { "type": "string", "nullable": true, "description": "Error message, if any" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/RICoverageDetailRow" }, "description": "List of RI coverage detail rows grouped by instance type, platform, tenancy and region" } } }, "RICoverageDetailRow": { "type": "object", "properties": { "instance_type": { "type": "string", "description": "EC2 instance type (e.g. m5.2xlarge, t3.medium)", "example": "m5.2xlarge" }, "platform": { "type": "string", "description": "Operating system platform", "example": "Linux/UNIX" }, "tenancy": { "type": "string", "description": "Instance tenancy (Shared, Dedicated, Host)", "example": "Shared" }, "region": { "type": "string", "description": "AWS region", "example": "us-east-1" }, "average_coverage": { "type": "number", "format": "double", "description": "Average RI coverage percentage (0-100)" }, "reservation_covered_hrs": { "type": "number", "format": "double", "description": "Hours covered by reserved instances" }, "on_demand_hrs": { "type": "number", "format": "double", "description": "Hours billed at on-demand rates" }, "total_running_hrs": { "type": "number", "format": "double", "description": "Total running hours (reservation covered + on-demand)" }, "on_demand_cost": { "type": "number", "format": "double", "description": "Cost for on-demand hours" } } }, "ComputeCoveragesDetail": { "type": "object", "properties": { "table": { "$ref": "#/components/schemas/ComputeCoveragesDetailTable" }, "chart": { "type": "array", "items": { "$ref": "#/components/schemas/ComputeCoverageChart" } } } }, "ComputeCoveragesDetailTable": { "type": "object", "properties": { "reservation_cost": { "type": "number", "format": "double", "nullable": true, "description": "Total cost for reserved instances" }, "total_cost": { "type": "number", "format": "double", "nullable": true, "description": "Total cost including all coverage types" }, "on_demand_cost": { "type": "number", "format": "double", "nullable": true, "description": "Cost for on-demand instances" }, "total_hours": { "type": "number", "format": "double", "nullable": true, "description": "Total hours of usage" }, "total_covered_hours": { "type": "number", "format": "double", "nullable": true, "description": "Total hours covered by RI or SP" }, "on_demand_hours": { "type": "number", "format": "double", "nullable": true, "description": "Hours billed at on-demand rates" }, "savings_plan_hours": { "type": "number", "format": "double", "nullable": true, "description": "Hours covered by savings plans" }, "ri_coverage_hours": { "type": "number", "format": "double", "nullable": true, "description": "Hours covered by reserved instances" }, "coverage": { "type": "number", "format": "float", "nullable": true, "description": "Coverage percentage" }, "region": { "type": "string", "nullable": true, "description": "Region information when grouped by region" }, "machine_type": { "type": "string", "nullable": true, "description": "Machine type information when grouped by machine type" }, "trend": { "type": "number", "format": "float", "nullable": true, "description": "Trend in coverage percentage compared to previous period" }, "spot_cost": { "type": "number", "format": "double", "nullable": true, "description": "Cost for spot instances" }, "spot_hours": { "type": "number", "format": "double", "nullable": true, "description": "Hours covered by spot instances" } } }, "ComputeCoverageChart": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "Date for the chart data point" }, "coverage_cost": { "type": "number", "format": "double", "description": "Coverage cost for the date" } } }, "CommitmentUtilizationDetailResponse": { "type": "object", "properties": { "ts": { "type": "integer", "format": "int64", "description": "Timestamp of the response" }, "success": { "type": "boolean", "description": "Indicates whether the request was successful" }, "errors": { "type": "string", "description": "Error message, if any" }, "response": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommitmentUtlizationsDetail" }, "description": "Response object containing savings plans and reserved instances utilization details" } } }, "CommitmentUtlizationsDetail": { "type": "object", "properties": { "table": { "$ref": "#/components/schemas/CommitmentUtilizationsDetailTable" }, "chart": { "type": "array", "items": { "$ref": "#/components/schemas/CommitmentUtilizationChart" } } } }, "CommitmentUtilizationsDetailTable": { "type": "object", "properties": { "compute_spend": { "type": "number", "format": "double", "description": "Total compute spend amount" }, "utilization": { "type": "number", "format": "double", "description": "Utilization amount" }, "percentage": { "type": "number", "format": "double", "description": "Utilization percentage" }, "trend": { "type": "number", "format": "double", "nullable": true, "description": "Trend in utilization percentage compared to previous period" } } }, "CommitmentUtilizationChart": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "Date for the utilization data point" }, "utilization_percentage": { "type": "number", "format": "double", "description": "Utilization percentage for the date" } } }, "RIInventoryOverviewResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Indicates if the request was successful" }, "errors": { "type": "string", "nullable": true, "description": "Error details, if any" }, "response": { "$ref": "#/components/schemas/RIInventoryOverview" } } }, "RIInventoryOverview": { "type": "object", "properties": { "total": { "$ref": "#/components/schemas/TotalCount" }, "distribution": { "allOf": [ { "$ref": "#/components/schemas/RIDistribution" } ], "nullable": true, "description": "Standard/Convertible split. Null for VirtualMachines, since Azure reservations have no such split." }, "status": { "$ref": "#/components/schemas/StatusBreakdown" }, "actions": { "$ref": "#/components/schemas/ActionsBreakdown" } } }, "TotalCount": { "type": "object", "properties": { "purchased": { "type": "integer", "description": "Total number of purchased RIs" }, "managed": { "type": "integer", "description": "Total number of managed RIs" } } }, "RIDistribution": { "type": "object", "properties": { "reserved": { "$ref": "#/components/schemas/InstanceTypeDistribution" }, "managed": { "$ref": "#/components/schemas/InstanceTypeDistribution" } } }, "InstanceTypeDistribution": { "type": "object", "properties": { "standard": { "$ref": "#/components/schemas/TypeCount" }, "convertible": { "$ref": "#/components/schemas/TypeCount" } } }, "TypeCount": { "type": "object", "properties": { "count": { "type": "integer", "description": "Number of instances of this type" }, "percentage": { "type": "number", "format": "float", "description": "Percentage of total instances" } } }, "StatusBreakdown": { "type": "object", "properties": { "expired": { "$ref": "#/components/schemas/StatusCount" }, "expiring_soon": { "$ref": "#/components/schemas/StatusCount" }, "active": { "$ref": "#/components/schemas/StatusCount" } } }, "ActionsBreakdown": { "type": "object", "properties": { "pending_approval": { "$ref": "#/components/schemas/StatusCount" } } }, "StatusCount": { "type": "object", "properties": { "count": { "type": "integer", "description": "Count of items in this status" }, "label": { "type": "string", "description": "Display label for the status" } } }, "InventoryRIAPIFilter": { "type": "object", "properties": { "account_ids": { "type": "array", "items": { "type": "string" }, "description": "List of provider account IDs" }, "cloud_account_ids": { "type": "array", "items": { "type": "string" }, "description": "List of cloud account IDs" }, "instance_types": { "type": "array", "items": { "type": "string" }, "description": "List of instance types" }, "instance_families": { "type": "array", "items": { "type": "string" }, "description": "List of instance families" }, "platforms": { "type": "array", "items": { "type": "string" }, "description": "List of platforms" }, "tenancy": { "type": "array", "items": { "type": "string" }, "description": "List of tenancy options" }, "payment_options": { "type": "array", "items": { "type": "string", "enum": [ "No Upfront", "Partial Upfront", "All Upfront" ] }, "description": "List of payment options" }, "terms": { "type": "array", "items": { "type": "number", "format": "float64" }, "description": "List of term lengths in years" }, "plan_types": { "type": "array", "items": { "type": "string", "enum": [ "Standard", "Convertible" ] }, "description": "List of RI types" }, "status": { "type": "array", "items": { "type": "string", "enum": [ "active", "expired", "pending", "retired" ] }, "description": "List of statuses" }, "is_harness_managed": { "type": "boolean", "nullable": true, "description": "Filter by Harness managed status" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "List of regions" }, "service": { "type": "string", "enum": [ "Amazon Relational Database Service", "Amazon Elastic Compute Cloud - Compute", "VirtualMachines" ], "default": "Amazon Elastic Compute Cloud - Compute", "description": "Service to fetch the inventory for. VirtualMachines returns Azure reservations, whose scope is the applied scope (Billing, Subscription or Management Group) instead of the region." } } }, "InventorySPAPIFilter": { "type": "object", "properties": { "account_ids": { "type": "array", "items": { "type": "string" }, "description": "List of provider account IDs" }, "cloud_account_ids": { "type": "array", "items": { "type": "string" }, "description": "List of cloud account IDs" }, "instance_families": { "type": "array", "items": { "type": "string" }, "description": "List of instance families" }, "payment_options": { "type": "array", "items": { "type": "string", "enum": [ "No Upfront", "Partial Upfront", "All Upfront" ] }, "description": "List of payment options" }, "terms": { "type": "array", "items": { "type": "number", "format": "float64" }, "description": "List of term lengths in years" }, "plan_types": { "type": "array", "items": { "type": "string", "enum": [ "ComputeSavingsPlans", "EC2InstanceSavingsPlans", "SageMakerSavingsPlans", "AzureComputeSavingsPlans" ] }, "description": "List of Savings Plan types. AzureComputeSavingsPlans applies to the VirtualMachines service." }, "status": { "type": "array", "items": { "type": "string", "enum": [ "active", "expired", "pending", "retired" ] }, "description": "List of statuses" }, "is_harness_managed": { "type": "boolean", "nullable": true, "description": "Filter by Harness managed status" }, "service": { "type": "string", "enum": [ "Amazon Relational Database Service", "Amazon Elastic Compute Cloud - Compute", "VirtualMachines" ], "description": "Service to filter by. VirtualMachines returns Azure savings plans, whose plan type is AzureComputeSavingsPlans." }, "regions": { "type": "array", "items": { "type": "string" }, "description": "List of regions" } } }, "SPInventoryOverviewResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Indicates if the request was successful" }, "errors": { "type": "string", "nullable": true, "description": "Error details, if any" }, "response": { "$ref": "#/components/schemas/SPInventoryOverview" } } }, "SPInventoryOverview": { "type": "object", "properties": { "total": { "$ref": "#/components/schemas/TotalCount" }, "distribution": { "$ref": "#/components/schemas/SPDistribution" }, "status": { "$ref": "#/components/schemas/StatusBreakdown" }, "actions": { "$ref": "#/components/schemas/ActionsBreakdown" } } }, "SPDistribution": { "type": "object", "properties": { "purchased": { "$ref": "#/components/schemas/PlanTypeDistribution" }, "managed": { "$ref": "#/components/schemas/PlanTypeDistribution" } } }, "PlanTypeDistribution": { "type": "object", "properties": { "ec2_instance_savings_plans": { "$ref": "#/components/schemas/TypeCount" }, "compute_savings_plans": { "$ref": "#/components/schemas/TypeCount" }, "sage_maker_savings_plans": { "$ref": "#/components/schemas/TypeCount" }, "azure_compute_savings_plans": { "allOf": [ { "$ref": "#/components/schemas/TypeCount" } ], "description": "Azure savings plans. Only returned for the VirtualMachines service." } } }, "ListReservedInstancesRequest": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/PaginationInput" }, "filters": { "$ref": "#/components/schemas/InventoryRIAPIFilter" }, "sort_by": { "type": "string", "description": "Field to sort results by" }, "sort_order": { "type": "string", "enum": [ "asc", "desc" ], "description": "Sort order direction" } } }, "ListReservedInstancesResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Indicates if the request was successful" }, "errors": { "type": "string", "nullable": true, "description": "Error details, if any" }, "response": { "$ref": "#/components/schemas/ReservedInstancesData" } } }, "ReservedInstancesData": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64", "description": "Total number of Reserved Instances" }, "pages": { "type": "integer", "format": "int64", "description": "Total number of pages" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReservedInstance" } }, "pagination": { "$ref": "#/components/schemas/PaginationInput" } } }, "ReservedInstance": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the Reserved Instance" }, "type": { "type": "string", "description": "Type of Reserved Instance (e.g., Convertible)" }, "count": { "type": "integer", "description": "Number of instances in this reservation" }, "scope": { "type": "string", "description": "Scope of the reservation. AWS returns the region; Azure returns the applied scope (Billing, Subscription or Management Group)" }, "availability_zone": { "type": "string", "description": "Availability zone if applicable" }, "start_date": { "type": "string", "format": "date-time", "description": "Start date of the reservation" }, "expires_on": { "type": "string", "format": "date-time", "description": "Expiration date of the reservation" }, "term": { "type": "string", "description": "Term length of the reservation" }, "avg_utilization": { "type": "number", "format": "float", "description": "Average utilization percentage" }, "status": { "type": "string", "description": "Current status of the reservation" }, "is_harness_managed": { "type": "boolean", "description": "Indicates if the reservation is managed by Harness" }, "is_seed_ri": { "type": "boolean", "description": "Indicates if this is a seed reservation" } } }, "ListSavingsPlansRequest": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/PaginationInput" }, "filters": { "$ref": "#/components/schemas/InventorySPAPIFilter" }, "sort_by": { "type": "string", "description": "Field to sort results by" }, "sort_order": { "type": "string", "enum": [ "asc", "desc" ], "description": "Sort order direction" } } }, "ListSavingsPlansResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Indicates if the request was successful" }, "errors": { "type": "string", "nullable": true, "description": "Error details, if any" }, "response": { "$ref": "#/components/schemas/SavingsPlansDataResponse" } } }, "SavingsPlansDataResponse": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64", "description": "Total number of Savings Plans" }, "pages": { "type": "integer", "format": "int64", "description": "Total number of pages" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SavingsPlan" } }, "pagination": { "$ref": "#/components/schemas/PaginationInput" } } }, "SavingsPlan": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the Savings Plan" }, "type": { "type": "string", "description": "Type of Savings Plan" }, "instance_family": { "type": "string", "description": "Instance family if applicable" }, "region": { "type": "string", "description": "Region for the Savings Plan" }, "commitment": { "type": "number", "format": "double", "description": "Hourly commitment amount" }, "start_date": { "type": "string", "format": "date-time", "description": "Start date of the Savings Plan" }, "expires_on": { "type": "string", "format": "date-time", "description": "Expiration date of the Savings Plan" }, "term": { "type": "string", "description": "Term length of the Savings Plan" }, "avg_utilization": { "type": "number", "format": "float", "description": "Average utilization percentage" }, "status": { "type": "string", "description": "Current status of the Savings Plan" }, "is_harness_managed": { "type": "boolean", "description": "Indicates if the Savings Plan is managed by Harness" }, "payment_option": { "type": "string", "description": "Payment option for the Savings Plan" }, "plan_type": { "type": "string", "description": "Type of the Savings Plan" }, "upfront_fee": { "type": "number", "format": "double", "description": "Upfront fee amount if applicable" } } }, "ReservedInstanceDetailsResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Indicates if the request was successful" }, "errors": { "type": "string", "nullable": true, "description": "Error details, if any" }, "response": { "$ref": "#/components/schemas/ReservedInstanceDetail" } } }, "ReservedInstanceDetail": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the Reserved Instance" }, "instance_type": { "type": "string", "description": "Type of EC2 instance" }, "scope": { "type": "string", "description": "Scope of the reservation. AWS returns the region; Azure returns the applied scope (Billing, Subscription or Management Group)" }, "instance_count": { "type": "integer", "description": "Number of instances in this reservation" }, "availability_zone": { "type": "string", "description": "Availability zone if applicable" }, "platform": { "type": "string", "description": "Operating system platform" }, "tenancy": { "type": "string", "description": "Instance tenancy (e.g., Shared, Dedicated)" }, "type": { "type": "string", "description": "Type of Reserved Instance (e.g., Convertible)" }, "utilization": { "type": "number", "format": "float", "description": "Current utilization percentage" }, "status": { "type": "string", "description": "Current status of the reservation" }, "start_date": { "type": "string", "format": "date-time", "description": "Start date of the reservation" }, "expiry_date": { "type": "string", "format": "date-time", "description": "Expiration date of the reservation" }, "purchase_term_years": { "type": "string", "description": "Term length of the reservation" }, "payment_option": { "type": "string", "description": "Payment option selected" }, "upfront_fee": { "type": "number", "format": "double", "description": "Upfront payment amount" }, "usage_price": { "type": "number", "format": "double", "description": "Usage price per hour" }, "hourly_cost": { "type": "number", "format": "double", "description": "Total hourly cost" }, "purchase_date": { "type": "string", "format": "date-time", "description": "Date when the reservation was purchased" }, "previously_was": { "$ref": "#/components/schemas/PreviousStateInfo" }, "approval_info": { "$ref": "#/components/schemas/ApprovalInfo" }, "is_harness_managed": { "type": "boolean", "description": "Indicates if the reservation is managed by Harness" } } }, "PreviousStateInfo": { "type": "object", "properties": { "instance_type": { "type": "string", "description": "Previous instance type" }, "platform": { "type": "string", "description": "Previous platform" }, "tenancy": { "type": "string", "description": "Previous tenancy" } } }, "ApprovalInfo": { "type": "object", "properties": { "approved_by": { "type": "string", "description": "User who approved the change" }, "approved_at": { "type": "string", "format": "date-time", "description": "Timestamp of approval" }, "status": { "type": "string", "description": "Current approval status" } } }, "SavingsPlanDetailsResponse": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp" }, "success": { "type": "boolean", "description": "Indicates if the request was successful" }, "errors": { "type": "string", "nullable": true, "description": "Error details, if any" }, "response": { "$ref": "#/components/schemas/SavingsPlanDetail" } } }, "ApprovalsListRequestV2": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Number of items per page", "example": 15 }, "page": { "type": "integer", "description": "Page number (starting from 1)", "example": 1 } } }, "service": { "type": "string", "description": "Filter by service name", "example": "Amazon Elastic Compute Cloud - Compute" }, "statuses": { "type": "array", "description": "Filter by event statuses", "items": { "type": "string", "enum": [ "PENDING", "COMPLETED", "EXPIRED", "REJECTED", "QUEUED", "APPROVED", "APPROVAL_PENDING" ] }, "example": [ "COMPLETED", "APPROVED" ] }, "cloud_account_id": { "type": "string", "description": "Filter by cloud account ID", "example": "" }, "event_types": { "type": "array", "description": "Filter by event types", "items": { "type": "string", "enum": [ "Reserved Instance Exchange", "Atom RI Purchase", "Savings Plan Purchase", "RDS Reserved Instance Purchase", "Purchase ElastiCache Reserved Node", "Purchase OpenSearch Reserved Instance", "Database Savings Plan Purchase" ] }, "example": [] }, "regions": { "type": "array", "description": "Filter by regions", "items": { "type": "string" }, "example": [ "ap-southeast-1" ] } } }, "ApprovalsListResponseV2": { "type": "object", "properties": { "ts": { "type": "integer", "description": "Response timestamp", "example": 1755058271 }, "success": { "type": "boolean", "description": "Indicates if the request was successful", "example": true }, "errors": { "type": "array", "description": "List of errors if any", "items": { "type": "object" }, "nullable": true, "example": null }, "response": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total number of events matching the criteria", "example": 112 }, "pages": { "type": "integer", "description": "Total number of pages", "example": 2 }, "events": { "type": "array", "description": "List of approval events", "items": { "$ref": "#/components/schemas/ApprovalEventV2" } } } } } }, "ApprovalEventV2": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier for the event", "example": 786 }, "category": { "type": "string", "description": "Category of the event", "example": "ExpandSeedReservation" }, "cloud_account_id": { "type": "string", "description": "Cloud account identifier", "example": "DoNotDelete_aws_india_master" }, "cloud_account_name": { "type": "string", "description": "Cloud account name", "example": "DoNotDelete_aws_india_master_name" }, "account_id": { "type": "string", "description": "Harness account identifier", "example": "zEaak-FLS425IEO7OLzMUg" }, "evaluated_at": { "type": "string", "format": "date-time", "description": "Timestamp when the event was evaluated", "example": "2024-12-18T04:38:35.19815Z" }, "status": { "type": "string", "description": "Status of the event", "enum": [ "PENDING", "COMPLETED", "EXPIRED", "REJECTED" ], "example": "EXPIRED" }, "potential_savings": { "type": "number", "format": "float", "description": "Potential savings from the event", "example": 15.840000000000003 }, "potential_spend": { "type": "number", "format": "float", "description": "Potential spend from the event", "example": 70.56 }, "name": { "type": "string", "description": "Name of the event", "example": "Reserved Instance Exchange" }, "metadata": { "type": "object", "description": "Additional metadata for the event", "additionalProperties": true, "example": { "hourly spend": 0.076, "instances": 1, "payment option": "No Upfront", "platform": "Linux/UNIX", "source instance type": "t3.nano", "target instance type": "t2.nano", "tenancy": "Shared", "source_ri": { "instance_type": "t3.nano", "instances": 1, "platform": "Linux", "region": "ap-southeast-1", "tenancy": "Shared" }, "target_ri": { "expiry_date": "2024-12-21T06:53:31Z", "instance_type": "t2.nano", "instances": 1, "platform": "Linux/UNIX", "region": "ap-southeast-1", "tenancy": "Shared" } } } } }, "FilterResponse": { "type": "object", "properties": { "region": { "type": "array", "items": { "type": "string" }, "description": "List of available AWS regions", "example": [ "us-east-1", "us-west-2", "eu-west-1" ] }, "instance_family": { "type": "array", "items": { "type": "string" }, "description": "List of available instance families", "example": [ "m5", "c5", "r5", "db.t3", "db.r5" ] }, "account_id": { "type": "array", "items": { "type": "string" }, "description": "List of available cloud provider account IDs", "example": [ "123456789012", "987654321098" ] } }, "required": [ "region", "instance_family", "account_id" ] }, "SavingsPlanDetail": { "type": "object", "properties": { "account_info": { "$ref": "#/components/schemas/AccountInfo", "description": "Associated account information" }, "instance_family": { "type": "string", "description": "Instance family if applicable" }, "region": { "type": "string", "description": "Region for the Savings Plan" }, "platform": { "type": "string", "description": "Operating system platform" }, "type": { "type": "string", "description": "Type of Savings Plan" }, "mtd_utilization": { "type": "number", "format": "double", "description": "Month-to-date utilization percentage" }, "status": { "type": "string", "description": "Current status of the Savings Plan" }, "start_date": { "type": "string", "format": "date-time", "description": "Start date of the Savings Plan" }, "expiry_date": { "type": "string", "format": "date-time", "description": "End date of the Savings Plan" }, "purchase_term_years": { "type": "string", "description": "Term length of the Savings Plan" }, "payment_option": { "type": "string", "description": "Payment option selected" }, "commitment": { "type": "number", "format": "double", "description": "Hourly commitment amount" }, "mtd_commitment": { "type": "number", "format": "double", "description": "Month-to-date commitment amount" }, "upfront_fee": { "type": "number", "format": "double", "description": "Upfront payment amount" }, "hourly_cost": { "type": "number", "format": "double", "description": "Hourly cost amount" }, "mtd_net_savings": { "type": "number", "format": "double", "description": "Month-to-date net savings amount" }, "approval_info": { "$ref": "#/components/schemas/SPApprovalInfo", "description": "Approval information if applicable" }, "is_harness_managed": { "type": "boolean", "description": "Indicates if the Savings Plan is managed by Harness" } } }, "AccountInfo": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Account identifier" }, "account_name": { "type": "string", "description": "Name of the account" }, "id": { "type": "string", "description": "Unique identifier (ARN) of the Savings Plan" } } }, "SPApprovalInfo": { "type": "object", "properties": { "approved_by": { "type": "string", "description": "User who approved the Savings Plan" }, "approved_at": { "type": "string", "description": "Timestamp of approval" }, "status": { "type": "string", "description": "Current approval status" } } } } } }