Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeTrustedAdvisorCheckRefreshStatuses

Returns the refresh status of the AWS 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 an AWS Business Support+, AWS Enterprise Support, or AWS Unified Operations plan to use the AWS Support API. If you're in an AWS Region that doesn't offer one of these AWS Support plans, or if you haven't transitioned to one of these plans, you can use the AWS Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
If you call the AWS Support API from an account that doesn't have an AWS Business Support+, AWS Enterprise Support, or AWS Unified Operations plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

To call the AWS Trusted Advisor operations in the AWS 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 AWS Support API in the AWS Support User Guide.

Request Syntax


{
   "checkIds": [ "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.

checkIds

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.

Type: Array of strings

Response Syntax


{
   "statuses": [ 
      { 
         "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.

statuses

The refresh status of the specified Trusted Advisor checks.

Type: Array of TrustedAdvisorCheckRefreshStatus objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServerError

An internal server error occurred.

message: An internal server error occurred.

HTTP Status Code: 500

ThrottlingException

You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.

HTTP Status Code: 400