Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically, and you can’t return their refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses
operation. If you call this operation for these checks, you might see an InvalidParameterValue
error.
Note
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-trusted-advisor-check-refresh-statuses
--check-ids <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--check-ids
(list)
The IDs of the Trusted Advisor checks to get the status.
Note
If you specify the check ID of a check that is automatically refreshed, you might see an
InvalidParameterValue
error.(string)
Syntax:
"string" "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
.
--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.
See ‘aws help’ for descriptions of global parameters.
To list the refresh statuses of AWS Trusted Advisor checks
The following describe-trusted-advisor-check-refresh-statuses
example lists the refresh statuses for two Trusted Advisor checks: Amazon S3 Bucket Permissions and IAM Use.
aws support describe-trusted-advisor-check-refresh-statuses \
--check-id "Pfx0RwqBli" "zXCkfM1nI3"
Output:
{
"statuses": [
{
"checkId": "Pfx0RwqBli",
"status": "none",
"millisUntilNextRefreshable": 0
},
{
"checkId": "zXCkfM1nI3",
"status": "none",
"millisUntilNextRefreshable": 0
}
]
}
For more information, see AWS Trusted Advisor in the AWS Support User Guide.
statuses -> (list)
The refresh status of the specified Trusted Advisor checks.
(structure)
The refresh status of a Trusted Advisor check.
checkId -> (string)
The unique identifier for the Trusted Advisor check.
status -> (string)
The status of the Trusted Advisor check for which a refresh has been requested:
none
- The check is not refreshed or the non-success status exceeds the timeout
enqueued
- The check refresh requests has entered the refresh queue
processing
- The check refresh request is picked up by the rule processing engine
success
- The check is successfully refreshed
abandoned
- The check refresh has failedmillisUntilNextRefreshable -> (long)
The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.