AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . compute-optimizer ]

export-ecs-service-recommendations

Description

Exports optimization recommendations for Amazon ECS services on Fargate.

Recommendations are exported in a CSV file, and its metadata in a 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 only have one Amazon ECS service export job in progress per Amazon Web Services Region.

See also: AWS API Documentation

Synopsis

  export-ecs-service-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 <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--account-ids (list)

The Amazon Web Services account IDs for the export Amazon ECS service recommendations.

If your account is the management account or the delegated administrator of an organization, use this parameter to specify the member account you want to export recommendations to.

This parameter can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.

If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts aren't included in the export.

You can specify multiple account IDs per request.

(string)

Syntax:

"string" "string" ...

--filters (list)

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

(structure)

Describes a filter that returns a more specific list of Amazon ECS service recommendations. Use this filter with the GetECSServiceRecommendations action.

name -> (string)

The name of the filter.

Specify Finding to return recommendations with a specific finding classification.

Specify FindingReasonCode to return recommendations with a specific finding reason code.

You can filter your Amazon ECS service recommendations by tag:key and tag-key tags.

A tag:key is a key and value combination of a tag assigned to your Amazon ECS service recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon ECS service recommendations that have a tag with the key of Owner and the value of TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

A tag-key is the key of a tag assigned to your Amazon ECS service recommendations. Use this filter to find all of your Amazon ECS service recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon ECS service recommendations with a tag key value of Owner or without any tag keys assigned.

values -> (list)

The value of the filter.

The valid values for this parameter are as follows:

  • If you specify the name parameter as Finding , specify Optimized , Underprovisioned , or Overprovisioned .
  • If you specify the name parameter as FindingReasonCode , specify CPUUnderprovisioned , CPUOverprovisioned , MemoryUnderprovisioned , or MemoryOverprovisioned .

(string)

Shorthand Syntax:

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

JSON Syntax:

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

--fields-to-export (list)

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 .

(string)

Syntax:

"string" "string" ...

Where valid values are:
  AccountId
  ServiceArn
  LookbackPeriodInDays
  LastRefreshTimestamp
  LaunchType
  CurrentPerformanceRisk
  CurrentServiceConfigurationMemory
  CurrentServiceConfigurationCpu
  CurrentServiceConfigurationTaskDefinitionArn
  CurrentServiceConfigurationAutoScalingConfiguration
  CurrentServiceContainerConfigurations
  UtilizationMetricsCpuMaximum
  UtilizationMetricsMemoryMaximum
  Finding
  FindingReasonCodes
  RecommendationOptionsMemory
  RecommendationOptionsCpu
  RecommendationOptionsSavingsOpportunityPercentage
  RecommendationOptionsEstimatedMonthlySavingsCurrency
  RecommendationOptionsEstimatedMonthlySavingsValue
  RecommendationOptionsContainerRecommendations
  RecommendationOptionsProjectedUtilizationMetricsCpuMaximum
  RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum
  Tags
  EffectiveRecommendationPreferencesSavingsEstimationMode
  RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage
  RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts
  RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts

--s3-destination-config (structure)

Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations 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 CSV file is the only export file format currently supported.

Possible values:

  • Csv

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

If your account is the management account or the delegated administrator of an organization, this parameter indicates whether to include recommendations for resources in all member accounts of the 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 .

If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file.

If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in the export.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

jobId -> (string)

The identification number of the export job.

To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.

s3Destination -> (structure)

Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata 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.