AWS SDK for C++  1.9.107
AWS SDK for C++
Public Member Functions | List of all members
Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest Class Reference

#include <ExportEC2InstanceRecommendationsRequest.h>

+ Inheritance diagram for Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest:

Public Member Functions

 ExportEC2InstanceRecommendationsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< Aws::String > & GetAccountIds () const
 
bool AccountIdsHasBeenSet () const
 
void SetAccountIds (const Aws::Vector< Aws::String > &value)
 
void SetAccountIds (Aws::Vector< Aws::String > &&value)
 
ExportEC2InstanceRecommendationsRequestWithAccountIds (const Aws::Vector< Aws::String > &value)
 
ExportEC2InstanceRecommendationsRequestWithAccountIds (Aws::Vector< Aws::String > &&value)
 
ExportEC2InstanceRecommendationsRequestAddAccountIds (const Aws::String &value)
 
ExportEC2InstanceRecommendationsRequestAddAccountIds (Aws::String &&value)
 
ExportEC2InstanceRecommendationsRequestAddAccountIds (const char *value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
ExportEC2InstanceRecommendationsRequestWithFilters (const Aws::Vector< Filter > &value)
 
ExportEC2InstanceRecommendationsRequestWithFilters (Aws::Vector< Filter > &&value)
 
ExportEC2InstanceRecommendationsRequestAddFilters (const Filter &value)
 
ExportEC2InstanceRecommendationsRequestAddFilters (Filter &&value)
 
const Aws::Vector< ExportableInstanceField > & GetFieldsToExport () const
 
bool FieldsToExportHasBeenSet () const
 
void SetFieldsToExport (const Aws::Vector< ExportableInstanceField > &value)
 
void SetFieldsToExport (Aws::Vector< ExportableInstanceField > &&value)
 
ExportEC2InstanceRecommendationsRequestWithFieldsToExport (const Aws::Vector< ExportableInstanceField > &value)
 
ExportEC2InstanceRecommendationsRequestWithFieldsToExport (Aws::Vector< ExportableInstanceField > &&value)
 
ExportEC2InstanceRecommendationsRequestAddFieldsToExport (const ExportableInstanceField &value)
 
ExportEC2InstanceRecommendationsRequestAddFieldsToExport (ExportableInstanceField &&value)
 
const S3DestinationConfigGetS3DestinationConfig () const
 
bool S3DestinationConfigHasBeenSet () const
 
void SetS3DestinationConfig (const S3DestinationConfig &value)
 
void SetS3DestinationConfig (S3DestinationConfig &&value)
 
ExportEC2InstanceRecommendationsRequestWithS3DestinationConfig (const S3DestinationConfig &value)
 
ExportEC2InstanceRecommendationsRequestWithS3DestinationConfig (S3DestinationConfig &&value)
 
const FileFormatGetFileFormat () const
 
bool FileFormatHasBeenSet () const
 
void SetFileFormat (const FileFormat &value)
 
void SetFileFormat (FileFormat &&value)
 
ExportEC2InstanceRecommendationsRequestWithFileFormat (const FileFormat &value)
 
ExportEC2InstanceRecommendationsRequestWithFileFormat (FileFormat &&value)
 
bool GetIncludeMemberAccounts () const
 
bool IncludeMemberAccountsHasBeenSet () const
 
void SetIncludeMemberAccounts (bool value)
 
ExportEC2InstanceRecommendationsRequestWithIncludeMemberAccounts (bool value)
 
const RecommendationPreferencesGetRecommendationPreferences () const
 
bool RecommendationPreferencesHasBeenSet () const
 
void SetRecommendationPreferences (const RecommendationPreferences &value)
 
void SetRecommendationPreferences (RecommendationPreferences &&value)
 
ExportEC2InstanceRecommendationsRequestWithRecommendationPreferences (const RecommendationPreferences &value)
 
ExportEC2InstanceRecommendationsRequestWithRecommendationPreferences (RecommendationPreferences &&value)
 
- Public Member Functions inherited from Aws::ComputeOptimizer::ComputeOptimizerRequest
virtual ~ComputeOptimizerRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file ExportEC2InstanceRecommendationsRequest.h.

Constructor & Destructor Documentation

◆ ExportEC2InstanceRecommendationsRequest()

Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::ExportEC2InstanceRecommendationsRequest ( )

Member Function Documentation

◆ AccountIdsHasBeenSet()

bool Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::AccountIdsHasBeenSet ( ) const
inline

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.

Definition at line 65 of file ExportEC2InstanceRecommendationsRequest.h.

◆ AddAccountIds() [1/3]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::AddAccountIds ( Aws::String &&  value)
inline

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.

Definition at line 137 of file ExportEC2InstanceRecommendationsRequest.h.

◆ AddAccountIds() [2/3]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::AddAccountIds ( const Aws::String value)
inline

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.

Definition at line 125 of file ExportEC2InstanceRecommendationsRequest.h.

◆ AddAccountIds() [3/3]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::AddAccountIds ( const char *  value)
inline

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.

Definition at line 149 of file ExportEC2InstanceRecommendationsRequest.h.

◆ AddFieldsToExport() [1/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::AddFieldsToExport ( const ExportableInstanceField value)
inline

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.

Definition at line 255 of file ExportEC2InstanceRecommendationsRequest.h.

◆ AddFieldsToExport() [2/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::AddFieldsToExport ( ExportableInstanceField &&  value)
inline

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.

Definition at line 263 of file ExportEC2InstanceRecommendationsRequest.h.

◆ AddFilters() [1/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::AddFilters ( const Filter value)
inline

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

Definition at line 192 of file ExportEC2InstanceRecommendationsRequest.h.

◆ AddFilters() [2/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::AddFilters ( Filter &&  value)
inline

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

Definition at line 198 of file ExportEC2InstanceRecommendationsRequest.h.

◆ FieldsToExportHasBeenSet()

bool Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::FieldsToExportHasBeenSet ( ) const
inline

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.

Definition at line 215 of file ExportEC2InstanceRecommendationsRequest.h.

◆ FileFormatHasBeenSet()

bool Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::FileFormatHasBeenSet ( ) const
inline

The format of the export file.

The only export file format currently supported is Csv.

Definition at line 367 of file ExportEC2InstanceRecommendationsRequest.h.

◆ FiltersHasBeenSet()

bool Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::FiltersHasBeenSet ( ) const
inline

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

Definition at line 162 of file ExportEC2InstanceRecommendationsRequest.h.

◆ GetAccountIds()

const Aws::Vector<Aws::String>& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::GetAccountIds ( ) const
inline

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.

Definition at line 53 of file ExportEC2InstanceRecommendationsRequest.h.

◆ GetFieldsToExport()

const Aws::Vector<ExportableInstanceField>& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::GetFieldsToExport ( ) const
inline

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.

Definition at line 207 of file ExportEC2InstanceRecommendationsRequest.h.

◆ GetFileFormat()

const FileFormat& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::GetFileFormat ( ) const
inline

The format of the export file.

The only export file format currently supported is Csv.

Definition at line 361 of file ExportEC2InstanceRecommendationsRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::GetFilters ( ) const
inline

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

Definition at line 156 of file ExportEC2InstanceRecommendationsRequest.h.

◆ GetIncludeMemberAccounts()

bool Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::GetIncludeMemberAccounts ( ) const
inline

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.

Definition at line 407 of file ExportEC2InstanceRecommendationsRequest.h.

◆ GetRecommendationPreferences()

const RecommendationPreferences& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::GetRecommendationPreferences ( ) const
inline

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

Definition at line 459 of file ExportEC2InstanceRecommendationsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetS3DestinationConfig()

const S3DestinationConfig& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::GetS3DestinationConfig ( ) const
inline

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.

Definition at line 279 of file ExportEC2InstanceRecommendationsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ IncludeMemberAccountsHasBeenSet()

bool Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::IncludeMemberAccountsHasBeenSet ( ) const
inline

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.

Definition at line 422 of file ExportEC2InstanceRecommendationsRequest.h.

◆ RecommendationPreferencesHasBeenSet()

bool Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::RecommendationPreferencesHasBeenSet ( ) const
inline

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

Definition at line 465 of file ExportEC2InstanceRecommendationsRequest.h.

◆ S3DestinationConfigHasBeenSet()

bool Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::S3DestinationConfigHasBeenSet ( ) const
inline

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.

Definition at line 294 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SerializePayload()

Aws::String Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccountIds() [1/2]

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetAccountIds ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 89 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SetAccountIds() [2/2]

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetAccountIds ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 77 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SetFieldsToExport() [1/2]

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetFieldsToExport ( Aws::Vector< ExportableInstanceField > &&  value)
inline

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.

Definition at line 231 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SetFieldsToExport() [2/2]

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetFieldsToExport ( const Aws::Vector< ExportableInstanceField > &  value)
inline

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.

Definition at line 223 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SetFileFormat() [1/2]

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetFileFormat ( const FileFormat value)
inline

The format of the export file.

The only export file format currently supported is Csv.

Definition at line 373 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SetFileFormat() [2/2]

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetFileFormat ( FileFormat &&  value)
inline

The format of the export file.

The only export file format currently supported is Csv.

Definition at line 379 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SetFilters() [1/2]

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

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

Definition at line 174 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SetFilters() [2/2]

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

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

Definition at line 168 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SetIncludeMemberAccounts()

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetIncludeMemberAccounts ( bool  value)
inline

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.

Definition at line 437 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SetRecommendationPreferences() [1/2]

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetRecommendationPreferences ( const RecommendationPreferences value)
inline

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

Definition at line 471 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SetRecommendationPreferences() [2/2]

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetRecommendationPreferences ( RecommendationPreferences &&  value)
inline

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

Definition at line 477 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SetS3DestinationConfig() [1/2]

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetS3DestinationConfig ( const S3DestinationConfig value)
inline

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.

Definition at line 309 of file ExportEC2InstanceRecommendationsRequest.h.

◆ SetS3DestinationConfig() [2/2]

void Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::SetS3DestinationConfig ( S3DestinationConfig &&  value)
inline

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.

Definition at line 324 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithAccountIds() [1/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithAccountIds ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 113 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithAccountIds() [2/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithAccountIds ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 101 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithFieldsToExport() [1/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithFieldsToExport ( Aws::Vector< ExportableInstanceField > &&  value)
inline

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.

Definition at line 247 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithFieldsToExport() [2/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithFieldsToExport ( const Aws::Vector< ExportableInstanceField > &  value)
inline

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.

Definition at line 239 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithFileFormat() [1/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithFileFormat ( const FileFormat value)
inline

The format of the export file.

The only export file format currently supported is Csv.

Definition at line 385 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithFileFormat() [2/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithFileFormat ( FileFormat &&  value)
inline

The format of the export file.

The only export file format currently supported is Csv.

Definition at line 391 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithFilters() [1/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

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

Definition at line 186 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithFilters() [2/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

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

Definition at line 180 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithIncludeMemberAccounts()

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithIncludeMemberAccounts ( bool  value)
inline

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.

Definition at line 452 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithRecommendationPreferences() [1/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithRecommendationPreferences ( const RecommendationPreferences value)
inline

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

Definition at line 483 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithRecommendationPreferences() [2/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithRecommendationPreferences ( RecommendationPreferences &&  value)
inline

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

Definition at line 489 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithS3DestinationConfig() [1/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithS3DestinationConfig ( const S3DestinationConfig value)
inline

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.

Definition at line 339 of file ExportEC2InstanceRecommendationsRequest.h.

◆ WithS3DestinationConfig() [2/2]

ExportEC2InstanceRecommendationsRequest& Aws::ComputeOptimizer::Model::ExportEC2InstanceRecommendationsRequest::WithS3DestinationConfig ( S3DestinationConfig &&  value)
inline

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.

Definition at line 354 of file ExportEC2InstanceRecommendationsRequest.h.


The documentation for this class was generated from the following file: