/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace ComputeOptimizer { namespace Model { /** */ class ExportEC2InstanceRecommendationsRequest : public ComputeOptimizerRequest { public: AWS_COMPUTEOPTIMIZER_API ExportEC2InstanceRecommendationsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ExportEC2InstanceRecommendations"; } AWS_COMPUTEOPTIMIZER_API Aws::String SerializePayload() const override; AWS_COMPUTEOPTIMIZER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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.

*/ inline const Aws::Vector& GetAccountIds() const{ return m_accountIds; } /** *

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.

*/ inline bool AccountIdsHasBeenSet() const { return m_accountIdsHasBeenSet; } /** *

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.

*/ inline void SetAccountIds(const Aws::Vector& value) { m_accountIdsHasBeenSet = true; m_accountIds = value; } /** *

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.

*/ inline void SetAccountIds(Aws::Vector&& value) { m_accountIdsHasBeenSet = true; m_accountIds = std::move(value); } /** *

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.

*/ inline ExportEC2InstanceRecommendationsRequest& WithAccountIds(const Aws::Vector& value) { SetAccountIds(value); return *this;} /** *

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.

*/ inline ExportEC2InstanceRecommendationsRequest& WithAccountIds(Aws::Vector&& value) { SetAccountIds(std::move(value)); return *this;} /** *

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.

*/ inline ExportEC2InstanceRecommendationsRequest& AddAccountIds(const Aws::String& value) { m_accountIdsHasBeenSet = true; m_accountIds.push_back(value); return *this; } /** *

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.

*/ inline ExportEC2InstanceRecommendationsRequest& AddAccountIds(Aws::String&& value) { m_accountIdsHasBeenSet = true; m_accountIds.push_back(std::move(value)); return *this; } /** *

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.

*/ inline ExportEC2InstanceRecommendationsRequest& AddAccountIds(const char* value) { m_accountIdsHasBeenSet = true; m_accountIds.push_back(value); return *this; } /** *

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

*/ inline const Aws::Vector& GetFilters() const{ return m_filters; } /** *

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

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

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

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

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

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

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

*/ inline ExportEC2InstanceRecommendationsRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

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

*/ inline ExportEC2InstanceRecommendationsRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

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

*/ inline ExportEC2InstanceRecommendationsRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

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

*/ inline ExportEC2InstanceRecommendationsRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } /** *

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.

*/ inline const Aws::Vector& GetFieldsToExport() const{ return m_fieldsToExport; } /** *

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.

*/ inline bool FieldsToExportHasBeenSet() const { return m_fieldsToExportHasBeenSet; } /** *

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.

*/ inline void SetFieldsToExport(const Aws::Vector& value) { m_fieldsToExportHasBeenSet = true; m_fieldsToExport = value; } /** *

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.

*/ inline void SetFieldsToExport(Aws::Vector&& value) { m_fieldsToExportHasBeenSet = true; m_fieldsToExport = std::move(value); } /** *

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.

*/ inline ExportEC2InstanceRecommendationsRequest& WithFieldsToExport(const Aws::Vector& value) { SetFieldsToExport(value); return *this;} /** *

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.

*/ inline ExportEC2InstanceRecommendationsRequest& WithFieldsToExport(Aws::Vector&& value) { SetFieldsToExport(std::move(value)); return *this;} /** *

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.

*/ inline ExportEC2InstanceRecommendationsRequest& AddFieldsToExport(const ExportableInstanceField& value) { m_fieldsToExportHasBeenSet = true; m_fieldsToExport.push_back(value); return *this; } /** *

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.

*/ inline ExportEC2InstanceRecommendationsRequest& AddFieldsToExport(ExportableInstanceField&& value) { m_fieldsToExportHasBeenSet = true; m_fieldsToExport.push_back(std::move(value)); return *this; } /** *

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

*/ inline const S3DestinationConfig& GetS3DestinationConfig() const{ return m_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 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.

*/ inline bool S3DestinationConfigHasBeenSet() const { return m_s3DestinationConfigHasBeenSet; } /** *

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

*/ inline void SetS3DestinationConfig(const S3DestinationConfig& value) { m_s3DestinationConfigHasBeenSet = true; m_s3DestinationConfig = value; } /** *

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

*/ inline void SetS3DestinationConfig(S3DestinationConfig&& value) { m_s3DestinationConfigHasBeenSet = true; m_s3DestinationConfig = std::move(value); } /** *

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

*/ inline ExportEC2InstanceRecommendationsRequest& WithS3DestinationConfig(const S3DestinationConfig& value) { SetS3DestinationConfig(value); return *this;} /** *

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

*/ inline ExportEC2InstanceRecommendationsRequest& WithS3DestinationConfig(S3DestinationConfig&& value) { SetS3DestinationConfig(std::move(value)); return *this;} /** *

The format of the export file.

The only export file format currently * supported is Csv.

*/ inline const FileFormat& GetFileFormat() const{ return m_fileFormat; } /** *

The format of the export file.

The only export file format currently * supported is Csv.

*/ inline bool FileFormatHasBeenSet() const { return m_fileFormatHasBeenSet; } /** *

The format of the export file.

The only export file format currently * supported is Csv.

*/ inline void SetFileFormat(const FileFormat& value) { m_fileFormatHasBeenSet = true; m_fileFormat = value; } /** *

The format of the export file.

The only export file format currently * supported is Csv.

*/ inline void SetFileFormat(FileFormat&& value) { m_fileFormatHasBeenSet = true; m_fileFormat = std::move(value); } /** *

The format of the export file.

The only export file format currently * supported is Csv.

*/ inline ExportEC2InstanceRecommendationsRequest& WithFileFormat(const FileFormat& value) { SetFileFormat(value); return *this;} /** *

The format of the export file.

The only export file format currently * supported is Csv.

*/ inline ExportEC2InstanceRecommendationsRequest& WithFileFormat(FileFormat&& value) { SetFileFormat(std::move(value)); return *this;} /** *

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.

*/ inline bool GetIncludeMemberAccounts() const{ return m_includeMemberAccounts; } /** *

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.

*/ inline bool IncludeMemberAccountsHasBeenSet() const { return m_includeMemberAccountsHasBeenSet; } /** *

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.

*/ inline void SetIncludeMemberAccounts(bool value) { m_includeMemberAccountsHasBeenSet = true; m_includeMemberAccounts = value; } /** *

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.

*/ inline ExportEC2InstanceRecommendationsRequest& WithIncludeMemberAccounts(bool value) { SetIncludeMemberAccounts(value); return *this;} /** *

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

*/ inline const RecommendationPreferences& GetRecommendationPreferences() const{ return m_recommendationPreferences; } /** *

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

*/ inline bool RecommendationPreferencesHasBeenSet() const { return m_recommendationPreferencesHasBeenSet; } /** *

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

*/ inline void SetRecommendationPreferences(const RecommendationPreferences& value) { m_recommendationPreferencesHasBeenSet = true; m_recommendationPreferences = value; } /** *

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

*/ inline void SetRecommendationPreferences(RecommendationPreferences&& value) { m_recommendationPreferencesHasBeenSet = true; m_recommendationPreferences = std::move(value); } /** *

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

*/ inline ExportEC2InstanceRecommendationsRequest& WithRecommendationPreferences(const RecommendationPreferences& value) { SetRecommendationPreferences(value); return *this;} /** *

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

*/ inline ExportEC2InstanceRecommendationsRequest& WithRecommendationPreferences(RecommendationPreferences&& value) { SetRecommendationPreferences(std::move(value)); return *this;} private: Aws::Vector m_accountIds; bool m_accountIdsHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; Aws::Vector m_fieldsToExport; bool m_fieldsToExportHasBeenSet = false; S3DestinationConfig m_s3DestinationConfig; bool m_s3DestinationConfigHasBeenSet = false; FileFormat m_fileFormat; bool m_fileFormatHasBeenSet = false; bool m_includeMemberAccounts; bool m_includeMemberAccountsHasBeenSet = false; RecommendationPreferences m_recommendationPreferences; bool m_recommendationPreferencesHasBeenSet = false; }; } // namespace Model } // namespace ComputeOptimizer } // namespace Aws