list-recommended-actions¶

Description¶

Lists the recommended actions based that match specified filters.

Note

Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using AssociateAccounts .

Synopsis¶

  list-recommended-actions
[--filters <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--filters (list)

The filters to apply to the list of recommended actions.

(structure)

A filter used to narrow down recommended action results based on specific criteria.

name -> (string) [required]

The name of the filter field to apply.

Possible values:

ResourceType

RecommendedActionType

ResourceId

LookBackPeriodInDays

CurrentResourceDetailsEbsVolumeType

ResourceTagsKey

ResourceTagsValue

AccountId

RestartNeeded

values -> (list) [required]

List of filter values to match against the specified filter name. Used to narrow down recommended actions based on specific criteria.

(string)

Constraints:

min: 1

max: 255

pattern: [a-zA-Z0-9\-_\.\*\?\s]+

Shorthand Syntax:

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

JSON Syntax:

[
  {
    "name": "ResourceType"|"RecommendedActionType"|"ResourceId"|"LookBackPeriodInDays"|"CurrentResourceDetailsEbsVolumeType"|"ResourceTagsKey"|"ResourceTagsValue"|"AccountId"|"RestartNeeded",
    "values": ["string", ...]
  }
  ...
]

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

recommendedActions -> (list)

The list of recommended actions that match the specified criteria.

(structure)

Contains information about a recommended action that can be applied to optimize an Amazon Web Services resource.

recommendedActionId -> (string)

The unique identifier of the recommended action.

Constraints:

pattern: [0-9A-Za-z]{16}

resourceArn -> (string)

The Amazon Resource Name (ARN) of the resource that the recommendation applies to.

Constraints:

pattern: arn:aws[a-z0-9-]*:[a-z0-9-]+:[a-z0-9-]*:[0-9]{0,12}:[a-zA-Z0-9/_.-]+

resourceId -> (string)

The ID of the resource that the recommendation applies to.

Constraints:

min: 1

max: 100

pattern: [a-zA-Z0-9_.-]+

accountId -> (string)

The Amazon Web Services account ID that owns the resource.

Constraints:

pattern: [0-9]{12}

region -> (string)

The Amazon Web Services Region where the resource is located.

resourceType -> (string)

The type of resource being evaluated.

Possible values:

EbsVolume

lookBackPeriodInDays -> (integer)

The number of days of historical data used to generate the recommendation.

recommendedActionType -> (string)

The type of action being recommended.

Possible values:

SnapshotAndDeleteUnattachedEbsVolume

UpgradeEbsVolumeType

currentResourceSummary -> (string)

A summary of the resource’s current configuration.

currentResourceDetails -> (tagged union structure)

Detailed configuration information for a specific Amazon Web Services resource, with type-specific details.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ebsVolume.

ebsVolume -> (structure)

Detailed configuration information specific to EBS volumes, including volume type, size, IOPS, and throughput settings.

configuration -> (structure)

The configuration details of the EBS volume, including type, size, IOPS, and throughput.

type -> (string)

The EBS volume type, such as gp2, gp3, io1, io2, st1, or sc1.

sizeInGib -> (integer)

The size of the EBS volume in gibibytes (GiB).

iops -> (integer)

The number of I/O operations per second (IOPS) provisioned for the volume.

throughput -> (integer)

The throughput in MiB/s provisioned for the volume (applicable to gp3, io1, and io2bx volumes).

recommendedResourceSummary -> (string)

A summary of the resource’s recommended configuration.

recommendedResourceDetails -> (tagged union structure)

Detailed configuration information for a specific Amazon Web Services resource, with type-specific details.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ebsVolume.

ebsVolume -> (structure)

Detailed configuration information specific to EBS volumes, including volume type, size, IOPS, and throughput settings.

configuration -> (structure)

The configuration details of the EBS volume, including type, size, IOPS, and throughput.

type -> (string)

The EBS volume type, such as gp2, gp3, io1, io2, st1, or sc1.

sizeInGib -> (integer)

The size of the EBS volume in gibibytes (GiB).

iops -> (integer)

The number of I/O operations per second (IOPS) provisioned for the volume.

throughput -> (integer)

The throughput in MiB/s provisioned for the volume (applicable to gp3, io1, and io2bx volumes).

restartNeeded -> (boolean)

Indicates whether implementing the recommended action requires a resource restart.

estimatedMonthlySavings -> (structure)

Contains information about estimated monthly cost savings.

currency -> (string) [required]

The currency of the estimated savings.

beforeDiscountSavings -> (double) [required]

The estimated monthly savings before applying any discounts.

afterDiscountSavings -> (double) [required]

The estimated monthly savings after applying any discounts.

savingsEstimationMode -> (string) [required]

The mode used to calculate savings, either BeforeDiscount or AfterDiscount.

Possible values:

BeforeDiscount

AfterDiscount

resourceTags -> (list)

The tags associated with the resource.

Constraints:

min: 0

max: 200

(structure)

A key-value pair used to categorize and organize Amazon Web Services resources and automation rules.

key -> (string) [required]

The tag key, which can be up to 128 characters long.

Constraints:

min: 1

max: 128

pattern: [\w\s\.\-\:\/\=\+\@]+

value -> (string) [required]

The tag value, which can be up to 256 characters long.

Constraints:

min: 0

max: 256

pattern: [\w\s\.\-\:\/\=\+\@]*

nextToken -> (string)

A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.

Constraints:

pattern: [A-Za-z0-9+/=]+

Table of Contents

Feedback

User Guide

list-recommended-actions¶

Description¶

Note

Synopsis¶

Options¶

Global Options¶

Output¶

Note

Note