libZSservicesZSamazonka-supportZSamazonka-support
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Support.RefreshTrustedAdvisorCheck

Description

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

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

Creating a Request

data RefreshTrustedAdvisorCheck Source #

See: newRefreshTrustedAdvisorCheck smart constructor.

Constructors

RefreshTrustedAdvisorCheck' 

Fields

  • checkId :: Text

    The unique identifier for the Trusted Advisor check to refresh.

    Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

Instances

Instances details
Eq RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

Read RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

Show RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

Generic RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

Associated Types

type Rep RefreshTrustedAdvisorCheck :: Type -> Type #

NFData RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

Hashable RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

ToJSON RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

AWSRequest RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

ToHeaders RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

ToPath RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

ToQuery RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

type Rep RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

type Rep RefreshTrustedAdvisorCheck = D1 ('MetaData "RefreshTrustedAdvisorCheck" "Amazonka.Support.RefreshTrustedAdvisorCheck" "libZSservicesZSamazonka-supportZSamazonka-support" 'False) (C1 ('MetaCons "RefreshTrustedAdvisorCheck'" 'PrefixI 'True) (S1 ('MetaSel ('Just "checkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse RefreshTrustedAdvisorCheck Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

newRefreshTrustedAdvisorCheck Source #

Create a value of RefreshTrustedAdvisorCheck with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:checkId:RefreshTrustedAdvisorCheck', refreshTrustedAdvisorCheck_checkId - The unique identifier for the Trusted Advisor check to refresh.

Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

Request Lenses

refreshTrustedAdvisorCheck_checkId :: Lens' RefreshTrustedAdvisorCheck Text Source #

The unique identifier for the Trusted Advisor check to refresh.

Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

Destructuring the Response

data RefreshTrustedAdvisorCheckResponse Source #

The current refresh status of a Trusted Advisor check.

See: newRefreshTrustedAdvisorCheckResponse smart constructor.

Constructors

RefreshTrustedAdvisorCheckResponse' 

Fields

Instances

Instances details
Eq RefreshTrustedAdvisorCheckResponse Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

Read RefreshTrustedAdvisorCheckResponse Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

Show RefreshTrustedAdvisorCheckResponse Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

Generic RefreshTrustedAdvisorCheckResponse Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

Associated Types

type Rep RefreshTrustedAdvisorCheckResponse :: Type -> Type #

NFData RefreshTrustedAdvisorCheckResponse Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

type Rep RefreshTrustedAdvisorCheckResponse Source # 
Instance details

Defined in Amazonka.Support.RefreshTrustedAdvisorCheck

type Rep RefreshTrustedAdvisorCheckResponse = D1 ('MetaData "RefreshTrustedAdvisorCheckResponse" "Amazonka.Support.RefreshTrustedAdvisorCheck" "libZSservicesZSamazonka-supportZSamazonka-support" 'False) (C1 ('MetaCons "RefreshTrustedAdvisorCheckResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TrustedAdvisorCheckRefreshStatus)))

newRefreshTrustedAdvisorCheckResponse Source #

Create a value of RefreshTrustedAdvisorCheckResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:RefreshTrustedAdvisorCheckResponse', refreshTrustedAdvisorCheckResponse_httpStatus - The response's http status code.

$sel:status:RefreshTrustedAdvisorCheckResponse', refreshTrustedAdvisorCheckResponse_status - The current refresh status for a check, including the amount of time until the check is eligible for refresh.

Response Lenses

refreshTrustedAdvisorCheckResponse_status :: Lens' RefreshTrustedAdvisorCheckResponse TrustedAdvisorCheckRefreshStatus Source #

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