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 . trustedadvisor ]
get-recommendation
--recommendation-identifier <value>
[--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>]
--recommendation-identifier
(string)
The Recommendation identifier
--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.
--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.
--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.
--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.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To get a recommendation
The following get-recommendation
example gets a recommendation by its identifier.
aws trustedadvisor get-recommendation \
--recommendation-identifier arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578
Output:
{
"recommendation": {
"arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578",
"name": "MFA Recommendation",
"description": "Enable multi-factor authentication",
"awsServices": [
"iam"
],
"checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos",
"id": "55fa4d2e-bbb7-491a-833b-5773e9589578",
"lastUpdatedAt": "2023-11-01T15:57:58.673Z",
"pillarSpecificAggregates": {
"costOptimizing": {
"estimatedMonthlySavings": 0.0,
"estimatedPercentMonthlySavings": 0.0
}
},
"pillars": [
"security"
],
"resourcesAggregates": {
"errorCount": 1,
"okCount": 0,
"warningCount": 0
},
"source": "ta_check",
"status": "error",
"type": "standard"
}
}
For more information, see Get started with the Trusted Advisor API in the AWS Trusted Advisor User Guide.
recommendation -> (structure)
The Recommendation
arn -> (string)
The ARN of the RecommendationawsServices -> (list)
The AWS Services that the Recommendation applies to
(string)
checkArn -> (string)
The AWS Trusted Advisor Check ARN that relates to the RecommendationcreatedAt -> (timestamp)
When the Recommendation was created, if created by AWS Trusted Advisor PrioritycreatedBy -> (string)
The creator, if created by AWS Trusted Advisor Prioritydescription -> (string)
A description for AWS Trusted Advisor recommendationsid -> (string)
The ID which identifies where the Recommendation was producedlastUpdatedAt -> (timestamp)
When the Recommendation was last updatedlifecycleStage -> (string)
The lifecycle stage from AWS Trusted Advisor Priorityname -> (string)
The name of the AWS Trusted Advisor RecommendationpillarSpecificAggregates -> (structure)
The pillar aggregations for cost savings
costOptimizing -> (structure)
Cost optimizing aggregates
estimatedMonthlySavings -> (double)
The estimated monthly savingsestimatedPercentMonthlySavings -> (double)
The estimated percently monthly savingspillars -> (list)
The Pillars that the Recommendation is optimizing
(string)
resolvedAt -> (timestamp)
When the Recommendation was resolvedresourcesAggregates -> (structure)
An aggregation of all resources
errorCount -> (long)
The number of AWS resources that were flagged to have errors according to the Trusted Advisor checkokCount -> (long)
The number of AWS resources that were flagged to be OK according to the Trusted Advisor checkwarningCount -> (long)
The number of AWS resources that were flagged to have warning according to the Trusted Advisor checksource -> (string)
The source of the Recommendationstatus -> (string)
The status of the Recommendationtype -> (string)
Whether the Recommendation was automated or generated by AWS Trusted Advisor PriorityupdateReason -> (string)
Reason for the lifecycle stage changeupdateReasonCode -> (string)
Reason code for the lifecycle state changeupdatedOnBehalfOf -> (string)
The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor PriorityupdatedOnBehalfOfJobTitle -> (string)
The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority