Support / Client / refresh_trusted_advisor_check

refresh_trusted_advisor_check#

Support.Client.refresh_trusted_advisor_check(**kwargs)#

Refreshes the 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 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.

See also: AWS API Documentation

Request Syntax

response = client.refresh_trusted_advisor_check(
    checkId='string'
)
Parameters:

checkId (string) –

[REQUIRED]

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.

Return type:

dict

Returns:

Response Syntax

{
    'status': {
        'checkId': 'string',
        'status': 'string',
        'millisUntilNextRefreshable': 123
    }
}

Response Structure

  • (dict) –

    The current refresh status of a Trusted Advisor check.

    • status (dict) –

      The current refresh status for a check, including the amount of time until the check is eligible for refresh.

      • 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 failed

      • millisUntilNextRefreshable (integer) –

        The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

Exceptions

  • Support.Client.exceptions.InternalServerError