com.amazonaws.services.computeoptimizer.model

Class ExportEBSVolumeRecommendationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.computeoptimizer.model.ExportEBSVolumeRecommendationsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExportEBSVolumeRecommendationsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ExportEBSVolumeRecommendationsRequest()

Method Summary

Modifier and Type	Method and Description
ExportEBSVolumeRecommendationsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAccountIds() The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.
List<String>	getFieldsToExport() The recommendations data to include in the export file.
String	getFileFormat() The format of the export file.
List<EBSFilter>	getFilters() An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
Boolean	getIncludeMemberAccounts() Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
S3DestinationConfig	getS3DestinationConfig()
int	hashCode()
Boolean	isIncludeMemberAccounts() Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
void	setAccountIds(Collection<String> accountIds) The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.
void	setFieldsToExport(Collection<String> fieldsToExport) The recommendations data to include in the export file.
void	setFileFormat(String fileFormat) The format of the export file.
void	setFilters(Collection<EBSFilter> filters) An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
void	setIncludeMemberAccounts(Boolean 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.
void	setS3DestinationConfig(S3DestinationConfig s3DestinationConfig)
String	toString() Returns a string representation of this object.
ExportEBSVolumeRecommendationsRequest	withAccountIds(Collection<String> accountIds) The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.
ExportEBSVolumeRecommendationsRequest	withAccountIds(String... accountIds) The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.
ExportEBSVolumeRecommendationsRequest	withFieldsToExport(Collection<String> fieldsToExport) The recommendations data to include in the export file.
ExportEBSVolumeRecommendationsRequest	withFieldsToExport(ExportableVolumeField... fieldsToExport) The recommendations data to include in the export file.
ExportEBSVolumeRecommendationsRequest	withFieldsToExport(String... fieldsToExport) The recommendations data to include in the export file.
ExportEBSVolumeRecommendationsRequest	withFileFormat(FileFormat fileFormat) The format of the export file.
ExportEBSVolumeRecommendationsRequest	withFileFormat(String fileFormat) The format of the export file.
ExportEBSVolumeRecommendationsRequest	withFilters(Collection<EBSFilter> filters) An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
ExportEBSVolumeRecommendationsRequest	withFilters(EBSFilter... filters) An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
ExportEBSVolumeRecommendationsRequest	withIncludeMemberAccounts(Boolean 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.
ExportEBSVolumeRecommendationsRequest	withS3DestinationConfig(S3DestinationConfig s3DestinationConfig)

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExportEBSVolumeRecommendationsRequest

public ExportEBSVolumeRecommendationsRequest()

Method Detail

getAccountIds

public List<String> getAccountIds()

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:

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.

setAccountIds

public void setAccountIds(Collection<String> accountIds)

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.

Parameters:

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

withAccountIds

public ExportEBSVolumeRecommendationsRequest withAccountIds(String... accountIds)

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.

NOTE: This method appends the values to the existing list (if any). Use setAccountIds(java.util.Collection) or withAccountIds(java.util.Collection) if you want to override the existing values.

Parameters:

accountIds - 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:

Returns a reference to this object so that method calls can be chained together.

withAccountIds

public ExportEBSVolumeRecommendationsRequest withAccountIds(Collection<String> accountIds)

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.

Parameters:

accountIds - 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:

Returns a reference to this object so that method calls can be chained together.

getFilters

public List<EBSFilter> getFilters()

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

Returns:

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

setFilters

public void setFilters(Collection<EBSFilter> filters)

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

Parameters:

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

withFilters

public ExportEBSVolumeRecommendationsRequest withFilters(EBSFilter... filters)

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

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withFilters

public ExportEBSVolumeRecommendationsRequest withFilters(Collection<EBSFilter> filters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getFieldsToExport

public List<String> getFieldsToExport()

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:

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.

See Also:

ExportableVolumeField

setFieldsToExport

public void setFieldsToExport(Collection<String> 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.

Parameters:

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.

See Also:

ExportableVolumeField

withFieldsToExport

public ExportEBSVolumeRecommendationsRequest withFieldsToExport(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setFieldsToExport(java.util.Collection) or withFieldsToExport(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExportableVolumeField

withFieldsToExport

public ExportEBSVolumeRecommendationsRequest withFieldsToExport(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExportableVolumeField

withFieldsToExport

public ExportEBSVolumeRecommendationsRequest withFieldsToExport(ExportableVolumeField... 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExportableVolumeField

setS3DestinationConfig

public void setS3DestinationConfig(S3DestinationConfig s3DestinationConfig)

Parameters:

s3DestinationConfig -

getS3DestinationConfig

public S3DestinationConfig getS3DestinationConfig()

Returns:

withS3DestinationConfig

public ExportEBSVolumeRecommendationsRequest withS3DestinationConfig(S3DestinationConfig s3DestinationConfig)

Parameters:

s3DestinationConfig -

Returns:

Returns a reference to this object so that method calls can be chained together.

setFileFormat

public void setFileFormat(String fileFormat)

The format of the export file.

The only export file format currently supported is Csv.

Parameters:

fileFormat - The format of the export file.

The only export file format currently supported is Csv.

See Also:

FileFormat

getFileFormat

public String getFileFormat()

The format of the export file.

The only export file format currently supported is Csv.

Returns:

The format of the export file.

The only export file format currently supported is Csv.

See Also:

FileFormat

withFileFormat

public ExportEBSVolumeRecommendationsRequest withFileFormat(String fileFormat)

The format of the export file.

The only export file format currently supported is Csv.

Parameters:

fileFormat - The format of the export file.

The only export file format currently supported is Csv.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FileFormat

withFileFormat

public ExportEBSVolumeRecommendationsRequest withFileFormat(FileFormat fileFormat)

The format of the export file.

The only export file format currently supported is Csv.

Parameters:

fileFormat - The format of the export file.

The only export file format currently supported is Csv.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FileFormat

setIncludeMemberAccounts

public void setIncludeMemberAccounts(Boolean 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.

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.

Parameters:

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.

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.

getIncludeMemberAccounts

public Boolean getIncludeMemberAccounts()

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:

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.

withIncludeMemberAccounts

public ExportEBSVolumeRecommendationsRequest withIncludeMemberAccounts(Boolean 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.

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.

Parameters:

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.

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:

Returns a reference to this object so that method calls can be chained together.

isIncludeMemberAccounts

public Boolean isIncludeMemberAccounts()

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:

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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ExportEBSVolumeRecommendationsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()