Class: Aws::ComputeOptimizer::Types::ExportEBSVolumeRecommendationsRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_ids ⇒ Array<String>

The IDs of the Amazon Web Services accounts for which to export Amazon EBS 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 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>) 


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1379

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

#fields_to_export ⇒ Array<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>) 


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1379

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

#file_format ⇒ String

The format of the export file.

The only export file format currently supported is Csv.

Returns:

  • (String) 


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1379

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

#filters ⇒ Array<Types::EBSFilter>

An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.

Returns:



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1379

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

#include_member_accounts ⇒ Boolean

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.

This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

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

Returns:

  • (Boolean) 


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1379

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

#s3_destination_config ⇒ Types::S3DestinationConfig

Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations 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 permission 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 policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.

Returns:



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'gems/aws-sdk-computeoptimizer/lib/aws-sdk-computeoptimizer/types.rb', line 1379

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