com.amazonaws.services.computeoptimizer.model

Class ExportAutoScalingGroupRecommendationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.computeoptimizer.model.ExportAutoScalingGroupRecommendationsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExportAutoScalingGroupRecommendationsRequest
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
ExportAutoScalingGroupRecommendationsRequest()

Method Summary

Modifier and Type	Method and Description
ExportAutoScalingGroupRecommendationsRequest	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 AWS accounts for which to export Auto Scaling group recommendations.
List<String>	getFieldsToExport() The recommendations data to include in the export file.
String	getFileFormat() The format of the export file.
List<Filter>	getFilters() An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.
Boolean	getIncludeMemberAccounts() Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master account of an organization.
S3DestinationConfig	getS3DestinationConfig() An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
int	hashCode()
Boolean	isIncludeMemberAccounts() Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master account of an organization.
void	setAccountIds(Collection<String> accountIds) The IDs of the AWS accounts for which to export Auto Scaling group 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<Filter> filters) An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.
void	setIncludeMemberAccounts(Boolean includeMemberAccounts) Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master account of an organization.
void	setS3DestinationConfig(S3DestinationConfig s3DestinationConfig) An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
String	toString() Returns a string representation of this object.
ExportAutoScalingGroupRecommendationsRequest	withAccountIds(Collection<String> accountIds) The IDs of the AWS accounts for which to export Auto Scaling group recommendations.
ExportAutoScalingGroupRecommendationsRequest	withAccountIds(String... accountIds) The IDs of the AWS accounts for which to export Auto Scaling group recommendations.
ExportAutoScalingGroupRecommendationsRequest	withFieldsToExport(Collection<String> fieldsToExport) The recommendations data to include in the export file.
ExportAutoScalingGroupRecommendationsRequest	withFieldsToExport(ExportableAutoScalingGroupField... fieldsToExport) The recommendations data to include in the export file.
ExportAutoScalingGroupRecommendationsRequest	withFieldsToExport(String... fieldsToExport) The recommendations data to include in the export file.
ExportAutoScalingGroupRecommendationsRequest	withFileFormat(FileFormat fileFormat) The format of the export file.
ExportAutoScalingGroupRecommendationsRequest	withFileFormat(String fileFormat) The format of the export file.
ExportAutoScalingGroupRecommendationsRequest	withFilters(Collection<Filter> filters) An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.
ExportAutoScalingGroupRecommendationsRequest	withFilters(Filter... filters) An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.
ExportAutoScalingGroupRecommendationsRequest	withIncludeMemberAccounts(Boolean includeMemberAccounts) Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master account of an organization.
ExportAutoScalingGroupRecommendationsRequest	withS3DestinationConfig(S3DestinationConfig s3DestinationConfig) An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.

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

ExportAutoScalingGroupRecommendationsRequest

public ExportAutoScalingGroupRecommendationsRequest()

Method Detail

getAccountIds

public List<String> getAccountIds()

The IDs of the AWS accounts for which to export Auto Scaling group recommendations.

If your account is the master account of an organization, use this parameter to specify the member accounts 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 AWS accounts for which to export Auto Scaling group recommendations.

If your account is the master account of an organization, use this parameter to specify the member accounts 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 AWS accounts for which to export Auto Scaling group recommendations.

If your account is the master account of an organization, use this parameter to specify the member accounts 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 AWS accounts for which to export Auto Scaling group recommendations.

If your account is the master account of an organization, use this parameter to specify the member accounts 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 ExportAutoScalingGroupRecommendationsRequest withAccountIds(String... accountIds)

The IDs of the AWS accounts for which to export Auto Scaling group recommendations.

If your account is the master account of an organization, use this parameter to specify the member accounts 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 AWS accounts for which to export Auto Scaling group recommendations.

If your account is the master account of an organization, use this parameter to specify the member accounts 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 ExportAutoScalingGroupRecommendationsRequest withAccountIds(Collection<String> accountIds)

The IDs of the AWS accounts for which to export Auto Scaling group recommendations.

If your account is the master account of an organization, use this parameter to specify the member accounts 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 AWS accounts for which to export Auto Scaling group recommendations.

If your account is the master account of an organization, use this parameter to specify the member accounts 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<Filter> getFilters()

An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.

Returns:

An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.

setFilters

public void setFilters(Collection<Filter> filters)

An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.

Parameters:

filters - An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.

withFilters

public ExportAutoScalingGroupRecommendationsRequest withFilters(Filter... filters)

An array of objects that describe a filter to export a more specific set of Auto Scaling group 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 that describe a filter to export a more specific set of Auto Scaling group recommendations.

Returns:

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

withFilters

public ExportAutoScalingGroupRecommendationsRequest withFilters(Collection<Filter> filters)

An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.

Parameters:

filters - An array of objects that describe a filter to export a more specific set of Auto Scaling group 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.

Returns:

The recommendations data to include in the export file.

See Also:

ExportableAutoScalingGroupField

setFieldsToExport

public void setFieldsToExport(Collection<String> fieldsToExport)

The recommendations data to include in the export file.

Parameters:

fieldsToExport - The recommendations data to include in the export file.

See Also:

ExportableAutoScalingGroupField

withFieldsToExport

public ExportAutoScalingGroupRecommendationsRequest withFieldsToExport(String... fieldsToExport)

The recommendations data to include in the export file.

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.

Returns:

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

See Also:

ExportableAutoScalingGroupField

withFieldsToExport

public ExportAutoScalingGroupRecommendationsRequest withFieldsToExport(Collection<String> fieldsToExport)

The recommendations data to include in the export file.

Parameters:

fieldsToExport - The recommendations data to include in the export file.

Returns:

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

See Also:

ExportableAutoScalingGroupField

withFieldsToExport

public ExportAutoScalingGroupRecommendationsRequest withFieldsToExport(ExportableAutoScalingGroupField... fieldsToExport)

The recommendations data to include in the export file.

Parameters:

fieldsToExport - The recommendations data to include in the export file.

Returns:

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

See Also:

ExportableAutoScalingGroupField

setS3DestinationConfig

public void setS3DestinationConfig(S3DestinationConfig 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 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.

Parameters:

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

getS3DestinationConfig

public S3DestinationConfig getS3DestinationConfig()

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

Returns:

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

withS3DestinationConfig

public ExportAutoScalingGroupRecommendationsRequest withS3DestinationConfig(S3DestinationConfig 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 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.

Parameters:

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

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 ExportAutoScalingGroupRecommendationsRequest 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 ExportAutoScalingGroupRecommendationsRequest 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 master account of an organization.

The member accounts must also be opted in to Compute Optimizer.

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 master account of an organization.

The member accounts must also be opted in to Compute Optimizer.

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 master account of an organization.

The member accounts must also be opted in to Compute Optimizer.

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 master account of an organization.

The member accounts must also be opted in to Compute Optimizer.

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 ExportAutoScalingGroupRecommendationsRequest withIncludeMemberAccounts(Boolean includeMemberAccounts)

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master account of an organization.

The member accounts must also be opted in to Compute Optimizer.

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 master account of an organization.

The member accounts must also be opted in to Compute Optimizer.

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 master account of an organization.

The member accounts must also be opted in to Compute Optimizer.

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 master account of an organization.

The member accounts must also be opted in to Compute Optimizer.

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 ExportAutoScalingGroupRecommendationsRequest 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()