Skip to content

aws.compute_optimizer.get_license_recommendations

Example SQL Queries

SELECT * FROM
aws.compute_optimizer.get_license_recommendations;

Description

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

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

Table Definition

Column NameColumn Data Type
account_ids Input Column

The ID of the Amazon Web Services 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.

VARCHAR[]
Show child fields
account_ids[]
filters Input Column

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

STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter.

Specify Finding to return recommendations with a specific finding classification.

Specify FindingReasonCode to return recommendations with a specific finding reason code.

You can filter your license recommendations by tag:key and tag-key tags.

A tag:key is a key and value combination of a tag assigned to your license recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all license recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

A tag-key is the key of a tag assigned to your license recommendations. Use this filter to find all of your license recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your license recommendations with a tag key value of Owner or without any tag keys assigned.

filters[].values[]
max_results Input Column

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.

BIGINT
next_token Input Column

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

VARCHAR
resource_arns Input Column

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

VARCHAR[]
Show child fields
resource_arns[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
errors

An array of objects that describe errors of the request.

STRUCT(
"identifier" VARCHAR,
"code" VARCHAR,
"message" VARCHAR
)[]
Show child fields
errors[]
Show child fields
errors[].code

The error code.

errors[].identifier

The ID of the error.

errors[].message

The message, or reason, for the error.

license_recommendations

An array of objects that describe license recommendations.

STRUCT(
"resource_arn" VARCHAR,
"account_id" VARCHAR,
"current_license_configuration" STRUCT(
"number_of_cores" BIGINT,
"instance_type" VARCHAR,
"operating_system" VARCHAR,
"license_edition" VARCHAR,
"license_name" VARCHAR,
"license_model" VARCHAR,
"license_version" VARCHAR,
"metrics_source" STRUCT(
"provider" VARCHAR,
"provider_arn" VARCHAR
)[]
),
"lookback_period_in_days" DOUBLE,
"last_refresh_timestamp" TIMESTAMP_S,
"finding" VARCHAR,
"finding_reason_codes" VARCHAR[],
"license_recommendation_options" STRUCT(
"rank" BIGINT,
"operating_system" VARCHAR,
"license_edition" VARCHAR,
"license_model" VARCHAR,
"savings_opportunity" STRUCT(
"savings_opportunity_percentage" DOUBLE,
"estimated_monthly_savings" STRUCT(
"currency" VARCHAR,
"value" DOUBLE
)
)
)[],
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
Show child fields
license_recommendations[]
Show child fields
license_recommendations[].account_id

The Amazon Web Services account ID of the license.

license_recommendations[].current_license_configuration

An object that describes the current configuration of an instance that runs on a license.

Show child fields
license_recommendations[].current_license_configuration.instance_type

The instance type used in the license.

license_recommendations[].current_license_configuration.license_edition

The edition of the license for the application that runs on the instance.

license_recommendations[].current_license_configuration.license_model

The license type associated with the instance.

license_recommendations[].current_license_configuration.license_name

The name of the license for the application that runs on the instance.

license_recommendations[].current_license_configuration.license_version

The version of the license for the application that runs on the instance.

license_recommendations[].current_license_configuration.metrics_source[]
Show child fields
license_recommendations[].current_license_configuration.metrics_source[].provider

The name of the metric source provider.

license_recommendations[].current_license_configuration.metrics_source[].provider_arn

The ARN of the metric source provider.

license_recommendations[].current_license_configuration.number_of_cores

The current number of cores associated with the instance.

license_recommendations[].current_license_configuration.operating_system

The operating system of the instance.

license_recommendations[].finding

The finding classification for an instance that runs on a license.

Findings include:

  • InsufficentMetrics — When Compute Optimizer detects that your CloudWatch Application Insights isn't enabled or is enabled with insufficient permissions.

  • NotOptimized — When Compute Optimizer detects that your EC2 infrastructure isn't using any of the SQL server license features you're paying for, a license is considered not optimized.

  • Optimized — When Compute Optimizer detects that all specifications of your license meet the performance requirements of your workload.

license_recommendations[].finding_reason_codes[]
license_recommendations[].last_refresh_timestamp

The timestamp of when the license recommendation was last generated.

license_recommendations[].license_recommendation_options[]
Show child fields
license_recommendations[].license_recommendation_options[].license_edition

The recommended edition of the license for the application that runs on the instance.

license_recommendations[].license_recommendation_options[].license_model

The recommended license type associated with the instance.

license_recommendations[].license_recommendation_options[].operating_system

The operating system of a license recommendation option.

license_recommendations[].license_recommendation_options[].rank

The rank of the license recommendation option.

The top recommendation option is ranked as 1.

license_recommendations[].license_recommendation_options[].savings_opportunity

Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.

Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.

Savings opportunity data requires that you opt in to Cost Explorer, as well as activate Receive Amazon EC2 resource recommendations in the Cost Explorer preferences page. That creates a connection between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer generates savings estimates considering the price of existing resources, the price of recommended resources, and historical usage data. Estimated monthly savings reflects the projected dollar savings associated with each of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost with Rightsizing Recommendations in the Cost Management User Guide.

Show child fields
license_recommendations[].license_recommendation_options[].savings_opportunity.estimated_monthly_savings

An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..

Show child fields
license_recommendations[].license_recommendation_options[].savings_opportunity.estimated_monthly_savings.currency

The currency of the estimated monthly savings.

license_recommendations[].license_recommendation_options[].savings_opportunity.estimated_monthly_savings.value

The value of the estimated monthly savings.

license_recommendations[].license_recommendation_options[].savings_opportunity.savings_opportunity_percentage

The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.

license_recommendations[].lookback_period_in_days

The number of days for which utilization metrics were analyzed for an instance that runs on a license.

license_recommendations[].resource_arn

The ARN that identifies the Amazon EC2 instance.

license_recommendations[].tags[]
Show child fields
license_recommendations[].tags[].key

One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

license_recommendations[].tags[].value

One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.