[ aws . compute-optimizer ]

export-auto-scaling-group-recommendations

Description

Exports optimization recommendations for Auto Scaling groups.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide .

You can have only one Auto Scaling group export job in progress per AWS Region.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  export-auto-scaling-group-recommendations
[--account-ids <value>]
[--filters <value>]
[--fields-to-export <value>]
--s3-destination-config <value>
[--file-format <value>]
[--include-member-accounts | --no-include-member-accounts]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--account-ids (list)

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.

(string)

Syntax:

"string" "string" ...

--filters (list)

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

(structure)

Describes a filter that returns a more specific list of recommendations.

name -> (string)

The name of the filter.

Specify Finding to return recommendations with a specific findings classification (e.g., Overprovisioned ).

Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., AutoScalingGroup ).

values -> (list)

The value of the filter.

If you specify the name parameter as Finding , and you request recommendations for an instance , then the valid values are Underprovisioned , Overprovisioned , NotOptimized , or Optimized .

If you specify the name parameter as Finding , and you request recommendations for an Auto Scaling group , then the valid values are Optimized , or NotOptimized .

If you specify the name parameter as RecommendationSourceType , then the valid values are Ec2Instance , or AutoScalingGroup .

(string)

Shorthand Syntax:

name=string,values=string,string ...

JSON Syntax:

[
  {
    "name": "Finding"|"RecommendationSourceType",
    "values": ["string", ...]
  }
  ...
]

--fields-to-export (list)

The recommendations data to include in the export file.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  AccountId
  AutoScalingGroupArn
  AutoScalingGroupName
  Finding
  UtilizationMetricsCpuMaximum
  UtilizationMetricsMemoryMaximum
  LookbackPeriodInDays
  CurrentConfigurationInstanceType
  CurrentConfigurationDesiredCapacity
  CurrentConfigurationMinSize
  CurrentConfigurationMaxSize
  CurrentOnDemandPrice
  CurrentStandardOneYearNoUpfrontReservedPrice
  CurrentStandardThreeYearNoUpfrontReservedPrice
  CurrentVCpus
  CurrentMemory
  CurrentStorage
  CurrentNetwork
  RecommendationOptionsConfigurationInstanceType
  RecommendationOptionsConfigurationDesiredCapacity
  RecommendationOptionsConfigurationMinSize
  RecommendationOptionsConfigurationMaxSize
  RecommendationOptionsProjectedUtilizationMetricsCpuMaximum
  RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum
  RecommendationOptionsPerformanceRisk
  RecommendationOptionsOnDemandPrice
  RecommendationOptionsStandardOneYearNoUpfrontReservedPrice
  RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice
  RecommendationOptionsVcpus
  RecommendationOptionsMemory
  RecommendationOptionsStorage
  RecommendationOptionsNetwork
  LastRefreshTimestamp

--s3-destination-config (structure)

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 .

bucket -> (string)

The name of the Amazon S3 bucket to use as the destination for an export job.

keyPrefix -> (string)

The Amazon S3 bucket prefix for an export job.

Shorthand Syntax:

bucket=string,keyPrefix=string

JSON Syntax:

{
  "bucket": "string",
  "keyPrefix": "string"
}

--file-format (string)

The format of the export file.

The only export file format currently supported is Csv .

Possible values:

• Csv

--include-member-accounts | --no-include-member-accounts (boolean)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

jobId -> (string)

The identification number of the export job.

Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

s3Destination -> (structure)

An object that describes the destination Amazon S3 bucket of a recommendations export file.

bucket -> (string)

The name of the Amazon S3 bucket used as the destination of an export file.

key -> (string)

The Amazon S3 bucket key of an export file.

The key uniquely identifies the object, or export file, in the S3 bucket.

metadataKey -> (string)

The Amazon S3 bucket key of a metadata file.

The key uniquely identifies the object, or metadata file, in the S3 bucket.