Class: Aws::ComputeOptimizer::Types::ExportLicenseRecommendationsRequest

Inherits:

Struct

• Object
• Struct
• Aws::ComputeOptimizer::Types::ExportLicenseRecommendationsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-computeoptimizer/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_ids ⇒ Array<String>

  The IDs of the Amazon Web Services accounts for which to export license recommendations.

• #fields_to_export ⇒ Array<String>

  The recommendations data to include in the export file.

• #file_format ⇒ String

  The format of the export file.

• #filters ⇒ Array<Types::LicenseRecommendationFilter>

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

• #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.

• #s3_destination_config ⇒ Types::S3DestinationConfig

  Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.

Instance Attribute Details

#account_ids ⇒ Array<String>

The IDs of the Amazon Web Services accounts for which to export license 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 can’t be specified together with the include member accounts parameter. The parameters are mutually exclusive.

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

You can specify multiple account IDs per request.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 2209

class ExportLicenseRecommendationsRequest < 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>)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 2209

class ExportLicenseRecommendationsRequest < 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.

A CSV file is the only export format currently supported.

Returns:

• (String)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 2209

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

#filters ⇒ Array<Types::LicenseRecommendationFilter>

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

Returns:

• (Array<Types::LicenseRecommendationFilter>)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 2209

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

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

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

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 2209

class ExportLicenseRecommendationsRequest < 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:

• (Types::S3DestinationConfig)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 2209

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