Class: Aws::ComputeOptimizer::Types::GetEBSVolumeRecommendationsRequest

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 GetEBSVolumeRecommendationsRequest data as a hash:

{
  volume_arns: ["VolumeArn"],
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      name: "Finding", # accepts Finding
      values: ["FilterValue"],
    },
  ],
  account_ids: ["AccountId"],
}

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 volume 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 volume recommendations.

Only one account ID can be specified per request.

Returns:

  • (Array<String>)


1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1316

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

#filtersArray<Types::EBSFilter>

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

Returns:



1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1316

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

#max_resultsInteger

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

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

Returns:

  • (Integer)


1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1316

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

#next_tokenString

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

Returns:

  • (String)


1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1316

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

#volume_arnsArray<String>

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

Returns:

  • (Array<String>)


1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1316

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