DescribeTrustedAdvisorCheckRefreshStatuses - AWS Support

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 a Business or Enterprise support plan to use the AWS Support API.

  • If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

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

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 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 AWS SDKs, see the following: