Class: Aws::ComputeOptimizer::Types::ExportIdleRecommendationsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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 Amazon Web Services account IDs for the export idle resource recommendations.

If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.

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

If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren’t included in the export.

You can specify multiple account IDs per request.

Returns:

  • (Array<String>) 


2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 2092

class ExportIdleRecommendationsRequest < 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*.

[1]: docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files

Returns:

  • (Array<String>) 


2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 2092

class ExportIdleRecommendationsRequest < 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 CSV file is the only export file format currently supported.

Returns:

  • (String) 


2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 2092

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

#filters ⇒ Array<Types::IdleRecommendationFilter>

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

Returns:



2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 2092

class ExportIdleRecommendationsRequest < 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

If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the 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*.

If this parameter is omitted, recommendations for member accounts of the organization aren’t included in the export file.

If this parameter or the account ID parameter is omitted, recommendations for member accounts aren’t included in the export.

[1]: docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access

Returns:

  • (Boolean) 


2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 2092

class ExportIdleRecommendationsRequest < 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*.

[1]: docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html

Returns:



2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 2092

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