RefreshTrustedAdvisorCheck
Refreshes the Amazon Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically. If you call the
RefreshTrustedAdvisorCheck
operation to refresh them, you might see
the InvalidParameterValue
error.
The response contains a TrustedAdvisorCheckRefreshStatus object.
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 doesn't 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.
To call the Amazon Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
Request Syntax
{
"checkId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- checkId
-
The unique identifier for the Trusted Advisor check to refresh.
Note
Specifying the check ID of a check that is automatically refreshed causes an
InvalidParameterValue
error.Type: String
Response Syntax
{
"status": {
"checkId": "string",
"millisUntilNextRefreshable": number,
"status": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- status
-
The current refresh status for a check, including the amount of time until the check is eligible for refresh.
Type: TrustedAdvisorCheckRefreshStatus object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An internal server error occurred.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: