Skip to main content
GET
/
analysis
/
cloud
/
aws
/
{analysisId}
/
results
AWS recommendations using analysisId
curl --request GET \
  --url https://{host}/api/v2/analysis/cloud/aws/{analysisId}/results
[
  {
    "entityId": "49fb3629-1f2b-4039-b146-918eb8009184",
    "resourceId": "i-06d390ca1a0c59d95",
    "accountIdRef": "209726931496",
    "region": "us-east-1",
    "currentType": "t3.micro",
    "recommendationType": "Upsize",
    "recommendedType": "t3.small",
    "implementationMethod": "Manual",
    "predictedUptime": 92.29,
    "totalHoursRunning": 1329,
    "name": "SQL Express",
    "rptHref": "/systems/49fb3629-1f2b-4039-b146-918eb8009184/analysis-report",
    "approvalType": "na",
    "densifyPolicy": "Initial Assessment",
    "savingsEstimate": -5.4850235,
    "effortEstimate": "Very Low",
    "powerState": "Running",
    "recommendedHostEntityId": "9a67bfc4-7d30-4e75-9c4d-1ca501b0c4fd",
    "serviceType": "EC2",
    "currentCost": 14.31,
    "recommendedCost": 28.62,
    "currentHourlyRate": 0.02,
    "recommendedHourlyRate": 0.04,
    "currentRiCoverage": 0,
    "recommFirstSeen": 1579680587657,
    "recommLastSeen": 1589008760293,
    "recommSeenCount": 24,
    "auditInfo": {
      "dataCollection": {
        "dateFirstAudited": 1571949272133,
        "dateLastAudited": 1588997132907,
        "auditCount": 103
      },
      "workloadDataLast30": {
        "firstDate": 1687009600000,
        "lastDate": 1688910400000,
        "totalDays": 23,
        "seenDays": 7
      }
    },
    "dataQuality": [
      {
        "workloadName": "CPU Utilization",
        "firstSeen": 1666705600000,
        "lastSeen": 1688910400000,
        "completeDays": 161,
        "partialDays": 0
      }
    ]
  }
]

Path Parameters

​
analysisId
string
required

Unique reference ID of the AWS analysis.

Query Parameters

​
entityId
string

Filter by Kubex entity ID.

​
resourceId
string

Filter by cloud resource identifier (e.g., EC2/RDS ID).

​
accountIdRef
string

Filter by AWS account ID.

​
region
string

Filter by AWS region (e.g., us-east-1).

​
recommendationType
enum<string>

Filter by recommended action.

Available options:
Just Right,
Upsize - Optimal Family,
Upsize,
Terminate,
Downsize - Optimal Family,
Downsize,
Modernize - Optimal Family,
Modernize,
Not Analyzed,
Upscale,
Downscale
​
recommendedType
string

Filter by recommended instance type.

​
implementationMethod
enum<string>

Filter by implementation method.

Available options:
Self Optimization,
Manual,
N/A
​
name
string

Filter by system name (usually the "Provisioning Id" tag).

​
powerState
string

Filter by power state.

​
serviceType
enum<string>

Filter by AWS service type.

Available options:
EC2,
RDS,
ASG,
SPOT
​
approvalType
string

Filter by approval setting ("na", "all", or a specific instance type).

​
densifyPolicy
string

Filter by the Kubex policy used for analysis.

​
effortEstimate
enum<string>

Filter by effort estimate.

Available options:
Moderate,
Low,
Very Low,
None,
Impossible
​
recommendedHostEntityId
string

Filter by catalog entity ID of the recommended instance type.

​
includeAttributes
boolean
default:false

Return system attributes when true.

​
dataQuality
string

Comma-separated list of workload type names to include (quote the value in raw HTTP). Example: "CPU Utilization,Disk I/O Operations".

Response

Recommendations returned

​
entityId
string

Kubex entity ID of the system

​
resourceId
string

Cloud resource ID

​
accountIdRef
string
​
region
string
​
currentType
string
​
recommendationType
string

Recommended action (see enums in parameter definition)

​
recommendedType
string
​
implementationMethod
enum<string>
Available options:
Self Optimization,
Manual,
N/A
​
predictedUptime
number<float>

Percent (0-100)

​
totalHoursRunning
number
​
name
string

System name or "Provisioning Id"

​
rptHref
string

Link to download the Impact Analysis and Recommendation Report PDF for this system; set Accept: application/octet-stream when calling it.

​
approvalType
string
​
densifyPolicy
string
​
savingsEstimate
number

Current minus recommended catalog cost (see docs for details)

​
effortEstimate
enum<string>
Available options:
Moderate,
Low,
Very Low,
None,
Impossible
​
powerState
string
​
recommendedHostEntityId
string
​
currentCost
number
​
recommendedCost
number
​
serviceType
enum<string>
Available options:
EC2,
RDS,
ASG,
SPOT
​
currentHourlyRate
number
​
recommendedHourlyRate
number
​
currentRiCoverage
integer
​
recommFirstSeen
integer<int64>
​
recommLastSeen
integer<int64>
​
recommSeenCount
integer
​
minGroupCurrent
integer
​
minGroupRecommended
integer
​
maxGroupCurrent
integer
​
maxGroupRecommended
integer
​
currentDesiredCapacity
integer
​
auditInfo
object
​
dataQuality
object[]
​
attributes
object[]