[ aws . support ]

refresh-trusted-advisor-check

Description

Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

Note

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

Synopsis

  refresh-trusted-advisor-check
--check-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--check-id (string)

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.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To refresh an AWS Trusted Advisor check

The following refresh-trusted-advisor-check example refreshes the Amazon S3 Bucket Permissions Trusted Advisor check in your AWS account.

aws support refresh-trusted-advisor-check \
    --check-id "Pfx0RwqBli"

Output:

{
    "status": {
        "checkId": "Pfx0RwqBli",
        "status": "enqueued",
        "millisUntilNextRefreshable": 3599992
    }
}

For more information, see AWS Trusted Advisor in the AWS Support User Guide.

Output

status -> (structure)

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 -> (long)

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