Class: Aws::ComputeOptimizer::Types::ExportEC2InstanceRecommendationsRequest

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

{
  account_ids: ["AccountId"],
  filters: [
    {
      name: "Finding", # accepts Finding, FindingReasonCodes, RecommendationSourceType
      values: ["FilterValue"],
    },
  ],
  fields_to_export: ["AccountId"], # accepts AccountId, InstanceArn, InstanceName, Finding, FindingReasonCodes, LookbackPeriodInDays, CurrentInstanceType, UtilizationMetricsCpuMaximum, UtilizationMetricsMemoryMaximum, UtilizationMetricsEbsReadOpsPerSecondMaximum, UtilizationMetricsEbsWriteOpsPerSecondMaximum, UtilizationMetricsEbsReadBytesPerSecondMaximum, UtilizationMetricsEbsWriteBytesPerSecondMaximum, UtilizationMetricsDiskReadOpsPerSecondMaximum, UtilizationMetricsDiskWriteOpsPerSecondMaximum, UtilizationMetricsDiskReadBytesPerSecondMaximum, UtilizationMetricsDiskWriteBytesPerSecondMaximum, UtilizationMetricsNetworkInBytesPerSecondMaximum, UtilizationMetricsNetworkOutBytesPerSecondMaximum, UtilizationMetricsNetworkPacketsInPerSecondMaximum, UtilizationMetricsNetworkPacketsOutPerSecondMaximum, CurrentOnDemandPrice, CurrentStandardOneYearNoUpfrontReservedPrice, CurrentStandardThreeYearNoUpfrontReservedPrice, CurrentVCpus, CurrentMemory, CurrentStorage, CurrentNetwork, RecommendationOptionsInstanceType, RecommendationOptionsProjectedUtilizationMetricsCpuMaximum, RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum, RecommendationOptionsPlatformDifferences, RecommendationOptionsPerformanceRisk, RecommendationOptionsVcpus, RecommendationOptionsMemory, RecommendationOptionsStorage, RecommendationOptionsNetwork, RecommendationOptionsOnDemandPrice, RecommendationOptionsStandardOneYearNoUpfrontReservedPrice, RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice, RecommendationsSourcesRecommendationSourceArn, RecommendationsSourcesRecommendationSourceType, LastRefreshTimestamp
  s3_destination_config: { # required
    bucket: "DestinationBucket",
    key_prefix: "DestinationKeyPrefix",
  },
  file_format: "Csv", # accepts Csv
  include_member_accounts: false,
  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 IDs of the Amazon Web Services accounts for which to export 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 export recommendations.

This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

You can specify multiple account IDs per request.

Returns:

  • (Array<String>)


852
853
854
855
856
857
858
859
860
861
862
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 852

class ExportEC2InstanceRecommendationsRequest < Struct.new(
  :account_ids,
  :filters,
  :fields_to_export,
  :s3_destination_config,
  :file_format,
  :include_member_accounts,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end

#fields_to_exportArray<String>

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

Returns:

  • (Array<String>)


852
853
854
855
856
857
858
859
860
861
862
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 852

class ExportEC2InstanceRecommendationsRequest < Struct.new(
  :account_ids,
  :filters,
  :fields_to_export,
  :s3_destination_config,
  :file_format,
  :include_member_accounts,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end

#file_formatString

The format of the export file.

The only export file format currently supported is Csv.

Returns:

  • (String)


852
853
854
855
856
857
858
859
860
861
862
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 852

class ExportEC2InstanceRecommendationsRequest < Struct.new(
  :account_ids,
  :filters,
  :fields_to_export,
  :s3_destination_config,
  :file_format,
  :include_member_accounts,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

An array of objects to specify a filter that exports a more specific set of instance recommendations.

Returns:



852
853
854
855
856
857
858
859
860
861
862
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 852

class ExportEC2InstanceRecommendationsRequest < Struct.new(
  :account_ids,
  :filters,
  :fields_to_export,
  :s3_destination_config,
  :file_format,
  :include_member_accounts,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end

#include_member_accountsBoolean

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.

The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

Returns:

  • (Boolean)


852
853
854
855
856
857
858
859
860
861
862
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 852

class ExportEC2InstanceRecommendationsRequest < Struct.new(
  :account_ids,
  :filters,
  :fields_to_export,
  :s3_destination_config,
  :file_format,
  :include_member_accounts,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end

#recommendation_preferencesTypes::RecommendationPreferences

An object to specify the preferences for the Amazon EC2 instance recommendations to export.



852
853
854
855
856
857
858
859
860
861
862
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 852

class ExportEC2InstanceRecommendationsRequest < Struct.new(
  :account_ids,
  :filters,
  :fields_to_export,
  :s3_destination_config,
  :file_format,
  :include_member_accounts,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end

#s3_destination_configTypes::S3DestinationConfig

An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.

You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permissions policy policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.



852
853
854
855
856
857
858
859
860
861
862
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 852

class ExportEC2InstanceRecommendationsRequest < Struct.new(
  :account_ids,
  :filters,
  :fields_to_export,
  :s3_destination_config,
  :file_format,
  :include_member_accounts,
  :recommendation_preferences)
  SENSITIVE = []
  include Aws::Structure
end