list-recommended-actions¶

Description¶

Returns a list of recommended actions that match the filter criteria.

Synopsis¶

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

Options¶

--filter (structure)

The criteria that you want all returned recommended actions to match.

actions -> (list)

A list of action filters that define criteria for filtering results. Each filter specifies a key, match option, and corresponding values to filter on.

(structure)

Describes a filter that returns a more specific list of recommended actions.

key -> (string) [required]

The category to filter on. Valid values are FEATURE for feature type, SEVERITY for severity level, and TYPE for recommendation type.

Possible values:

FEATURE

SEVERITY

TYPE

matchOption -> (string) [required]

Specifies how to apply the filter. Use EQUALS to include matching results or NOT_EQUALS to exclude matching results.

Possible values:

EQUALS

NOT_EQUALS

values -> (list) [required]

One or more values to match against the specified key.

Constraints:

min: 1

(string)

Constraints:

min: 1

max: 1024

pattern: .*[\S\s]*.*

JSON Syntax:

{
  "actions": [
    {
      "key": "FEATURE"|"SEVERITY"|"TYPE",
      "matchOption": "EQUALS"|"NOT_EQUALS",
      "values": ["string", ...]
    }
    ...
  ]
}

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

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

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

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

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

Output¶

recommendedActions -> (list)

The list of recommended actions that satisfy the filter criteria.

(structure)

Describes a specific recommended action.

id -> (string)

The ID for the recommended action.

type -> (string)

The type of action you can take by adopting the recommended action.

Possible values:

ADD_ALTERNATE_BILLING_CONTACT

CREATE_ANOMALY_MONITOR

CREATE_BUDGET

ENABLE_COST_OPTIMIZATION_HUB

MIGRATE_TO_GRANULAR_PERMISSIONS

PAYMENTS_DUE

PAYMENTS_PAST_DUE

REVIEW_ANOMALIES

REVIEW_BUDGET_ALERTS

REVIEW_BUDGETS_EXCEEDED

REVIEW_EXPIRING_RI

REVIEW_EXPIRING_SP

REVIEW_FREETIER_USAGE_ALERTS

REVIEW_SAVINGS_OPPORTUNITY_RECOMMENDATIONS

UPDATE_EXPIRED_PAYMENT_METHOD

UPDATE_INVALID_PAYMENT_METHOD

UPDATE_TAX_EXEMPTION_CERTIFICATE

UPDATE_TAX_REGISTRATION_NUMBER

accountId -> (string)

The account that the recommended action is for.

Constraints:

min: 12

max: 12

pattern: [0-9]{12}

severity -> (string)

The severity associated with the recommended action.

Possible values:

INFO

WARNING

CRITICAL

feature -> (string)

The feature associated with the recommended action.

Possible values:

ACCOUNT

BUDGETS

COST_ANOMALY_DETECTION

COST_OPTIMIZATION_HUB

FREE_TIER

IAM

PAYMENTS

RESERVATIONS

SAVINGS_PLANS

TAX_SETTINGS

context -> (map)

Context that applies to the recommended action.

key -> (string)

value -> (string)

nextSteps -> (list)

The possible next steps to execute the recommended action.

(string)

lastUpdatedTimeStamp -> (string)

The time when the recommended action status was last updated.

nextToken -> (string)

The pagination token that indicates the next set of results that you want to retrieve.

Constraints:

min: 1

max: 8192

pattern: [\S\s]*

Table of Contents

Feedback

User Guide