Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetLicenseRecommendations

Returns license recommendations for Amazon EC2 instances that run on a specific license.

AWS Compute Optimizer generates recommendations for licenses that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.

Request Syntax


{
   "accountIds": [ "string" ],
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "resourceArns": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

accountIds

The ID of the AWS account for which to return license recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return license recommendations.

Only one account ID can be specified per request.

Type: Array of strings

Required: No

filters

An array of objects to specify a filter that returns a more specific list of license recommendations.

Type: Array of LicenseRecommendationFilter objects

Required: No

maxResults

The maximum number of license recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000.

Required: No

nextToken

The token to advance to the next page of license recommendations.

Type: String

Required: No

resourceArns

The ARN that identifies the Amazon EC2 instance.

The following is the format of the ARN:

arn:aws:ec2:region:aws_account_id:instance/instance-id

Type: Array of strings

Required: No

Response Syntax


{
   "errors": [ 
      { 
         "code": "string",
         "identifier": "string",
         "message": "string"
      }
   ],
   "licenseRecommendations": [ 
      { 
         "accountId": "string",
         "currentLicenseConfiguration": { 
            "instanceType": "string",
            "licenseEdition": "string",
            "licenseModel": "string",
            "licenseName": "string",
            "licenseVersion": "string",
            "metricsSource": [ 
               { 
                  "provider": "string",
                  "providerArn": "string"
               }
            ],
            "numberOfCores": number,
            "operatingSystem": "string"
         },
         "finding": "string",
         "findingReasonCodes": [ "string" ],
         "lastRefreshTimestamp": number,
         "licenseRecommendationOptions": [ 
            { 
               "licenseEdition": "string",
               "licenseModel": "string",
               "operatingSystem": "string",
               "rank": number,
               "savingsOpportunity": { 
                  "estimatedMonthlySavings": { 
                     "currency": "string",
                     "value": number
                  },
                  "savingsOpportunityPercentage": number
               }
            }
         ],
         "lookbackPeriodInDays": number,
         "resourceArn": "string",
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ]
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

errors

An array of objects that describe errors of the request.

Type: Array of GetRecommendationError objects

licenseRecommendations

An array of objects that describe license recommendations.

Type: Array of LicenseRecommendation objects

nextToken

The token to use to advance to the next page of license recommendations.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

An internal error has occurred. Try your call again.

HTTP Status Code: 500

InvalidParameterValueException

The value supplied for the input parameter is out of range or not valid.

HTTP Status Code: 400

MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 400

OptInRequiredException

The account is not opted in to AWS Compute Optimizer.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed due to a temporary failure of the server.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400