Class: Aws::ComputeOptimizer::Types::GetEC2InstanceRecommendationsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb

Overview

Note:

When making an API call, you may pass GetEC2InstanceRecommendationsRequest data as a hash:

{
  instance_arns: ["InstanceArn"],
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      name: "Finding", # accepts Finding, FindingReasonCodes, RecommendationSourceType
      values: ["FilterValue"],
    },
  ],
  account_ids: ["AccountId"],
  recommendation_preferences: {
    cpu_vendor_architectures: ["AWS_ARM64"], # accepts AWS_ARM64, CURRENT
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idsArray<String>

The ID of the Amazon Web Services account for which to return instance 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 instance recommendations.

Only one account ID can be specified per request.

Returns:

  • (Array<String>)


1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1414

class GetEC2InstanceRecommendationsRequest < Struct.new(
  :instance_arns,
  :next_token,
  :max_results,
  :filters,
  :account_ids,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

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

Returns:



1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1414

class GetEC2InstanceRecommendationsRequest < Struct.new(
  :instance_arns,
  :next_token,
  :max_results,
  :filters,
  :account_ids,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end

#instance_arnsArray<String>

The Amazon Resource Name (ARN) of the instances for which to return recommendations.

Returns:

  • (Array<String>)


1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1414

class GetEC2InstanceRecommendationsRequest < Struct.new(
  :instance_arns,
  :next_token,
  :max_results,
  :filters,
  :account_ids,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

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

Returns:

  • (Integer)


1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1414

class GetEC2InstanceRecommendationsRequest < Struct.new(
  :instance_arns,
  :next_token,
  :max_results,
  :filters,
  :account_ids,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1414

class GetEC2InstanceRecommendationsRequest < Struct.new(
  :instance_arns,
  :next_token,
  :max_results,
  :filters,
  :account_ids,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end

#recommendation_preferencesTypes::RecommendationPreferences

An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.



1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1414

class GetEC2InstanceRecommendationsRequest < Struct.new(
  :instance_arns,
  :next_token,
  :max_results,
  :filters,
  :account_ids,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end