Amazonka.Config.StartResourceEvaluation

Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type.

Ensure you have the cloudformation:DescribeType role setup to validate the resource type schema.

Creating a Request

data StartResourceEvaluation

See: newStartResourceEvaluation smart constructor.

Constructors

StartResourceEvaluation'

Fields

• clientToken :: Maybe Text

  A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.

  Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.

• evaluationContext :: Maybe EvaluationContext

  Returns an EvaluationContext object.

• evaluationTimeout :: Maybe Natural

  The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.

• resourceDetails :: ResourceDetails

  Returns a ResourceDetails object.

• evaluationMode :: EvaluationMode

  The mode of an evaluation. The valid value for this API is Proactive.

Instances

ToJSON StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

Methods

toJSON :: StartResourceEvaluation -> Value

toEncoding :: StartResourceEvaluation -> Encoding

toJSONList :: [StartResourceEvaluation] -> Value

toEncodingList :: [StartResourceEvaluation] -> Encoding

ToHeaders StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

Methods

toHeaders :: StartResourceEvaluation -> [Header]

ToPath StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

Methods

toPath :: StartResourceEvaluation -> ByteString

ToQuery StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

Methods

toQuery :: StartResourceEvaluation -> QueryString

AWSRequest StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

Associated Types

type AWSResponse StartResourceEvaluation

Methods

request :: (Service -> Service) -> StartResourceEvaluation -> Request StartResourceEvaluation

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartResourceEvaluation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartResourceEvaluation)))

Generic StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

Associated Types

type Rep StartResourceEvaluation :: Type -> Type

Methods

from :: StartResourceEvaluation -> Rep StartResourceEvaluation x

to :: Rep StartResourceEvaluation x -> StartResourceEvaluation

Read StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

Methods

readsPrec :: Int -> ReadS StartResourceEvaluation

readList :: ReadS [StartResourceEvaluation]

readPrec :: ReadPrec StartResourceEvaluation

readListPrec :: ReadPrec [StartResourceEvaluation]

Show StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

Methods

showsPrec :: Int -> StartResourceEvaluation -> ShowS

show :: StartResourceEvaluation -> String

showList :: [StartResourceEvaluation] -> ShowS

NFData StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

Methods

rnf :: StartResourceEvaluation -> ()

Eq StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

Methods

(==) :: StartResourceEvaluation -> StartResourceEvaluation -> Bool

(/=) :: StartResourceEvaluation -> StartResourceEvaluation -> Bool

Hashable StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

Methods

hashWithSalt :: Int -> StartResourceEvaluation -> Int

hash :: StartResourceEvaluation -> Int

type AWSResponse StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

type AWSResponse StartResourceEvaluation = StartResourceEvaluationResponse

type Rep StartResourceEvaluation

Defined in Amazonka.Config.StartResourceEvaluation

type Rep StartResourceEvaluation = D1 ('MetaData "StartResourceEvaluation" "Amazonka.Config.StartResourceEvaluation" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "StartResourceEvaluation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "evaluationContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EvaluationContext))) :*: (S1 ('MetaSel ('Just "evaluationTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "resourceDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceDetails) :*: S1 ('MetaSel ('Just "evaluationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EvaluationMode)))))

newStartResourceEvaluation

Arguments

:: ResourceDetails

$sel:resourceDetails:StartResourceEvaluation'

-> EvaluationMode

StartResourceEvaluation

-> StartResourceEvaluation

Create a value of StartResourceEvaluation 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:clientToken:StartResourceEvaluation', startResourceEvaluation_clientToken - A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.

Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.

$sel:evaluationContext:StartResourceEvaluation', startResourceEvaluation_evaluationContext - Returns an EvaluationContext object.

$sel:evaluationTimeout:StartResourceEvaluation', startResourceEvaluation_evaluationTimeout - The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.

$sel:resourceDetails:StartResourceEvaluation', startResourceEvaluation_resourceDetails - Returns a ResourceDetails object.

StartResourceEvaluation, startResourceEvaluation_evaluationMode - The mode of an evaluation. The valid value for this API is Proactive.

Request Lenses

startResourceEvaluation_clientToken :: Lens' StartResourceEvaluation (Maybe Text)

A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.

Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.

startResourceEvaluation_evaluationContext :: Lens' StartResourceEvaluation (Maybe EvaluationContext)

Returns an EvaluationContext object.

startResourceEvaluation_evaluationTimeout :: Lens' StartResourceEvaluation (Maybe Natural)

The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.

startResourceEvaluation_resourceDetails :: Lens' StartResourceEvaluation ResourceDetails

Returns a ResourceDetails object.

startResourceEvaluation_evaluationMode :: Lens' StartResourceEvaluation EvaluationMode

The mode of an evaluation. The valid value for this API is Proactive.

Destructuring the Response

data StartResourceEvaluationResponse

See: newStartResourceEvaluationResponse smart constructor.

Constructors

StartResourceEvaluationResponse'

Fields

• resourceEvaluationId :: Maybe Text

  A unique ResourceEvaluationId that is associated with a single execution.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartResourceEvaluationResponse

Defined in Amazonka.Config.StartResourceEvaluation

Associated Types

type Rep StartResourceEvaluationResponse :: Type -> Type

Methods

from :: StartResourceEvaluationResponse -> Rep StartResourceEvaluationResponse x

to :: Rep StartResourceEvaluationResponse x -> StartResourceEvaluationResponse

Read StartResourceEvaluationResponse

Defined in Amazonka.Config.StartResourceEvaluation

Methods

readsPrec :: Int -> ReadS StartResourceEvaluationResponse

readList :: ReadS [StartResourceEvaluationResponse]

readPrec :: ReadPrec StartResourceEvaluationResponse

readListPrec :: ReadPrec [StartResourceEvaluationResponse]

Show StartResourceEvaluationResponse

Defined in Amazonka.Config.StartResourceEvaluation

Methods

showsPrec :: Int -> StartResourceEvaluationResponse -> ShowS

show :: StartResourceEvaluationResponse -> String

showList :: [StartResourceEvaluationResponse] -> ShowS

NFData StartResourceEvaluationResponse

Defined in Amazonka.Config.StartResourceEvaluation

Methods

rnf :: StartResourceEvaluationResponse -> ()

Eq StartResourceEvaluationResponse

Defined in Amazonka.Config.StartResourceEvaluation

Methods

(==) :: StartResourceEvaluationResponse -> StartResourceEvaluationResponse -> Bool

(/=) :: StartResourceEvaluationResponse -> StartResourceEvaluationResponse -> Bool

type Rep StartResourceEvaluationResponse

Defined in Amazonka.Config.StartResourceEvaluation

type Rep StartResourceEvaluationResponse = D1 ('MetaData "StartResourceEvaluationResponse" "Amazonka.Config.StartResourceEvaluation" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "StartResourceEvaluationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceEvaluationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartResourceEvaluationResponse

Arguments

:: Int

$sel:httpStatus:StartResourceEvaluationResponse'

-> StartResourceEvaluationResponse

Create a value of StartResourceEvaluationResponse 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:

StartResourceEvaluationResponse, startResourceEvaluationResponse_resourceEvaluationId - A unique ResourceEvaluationId that is associated with a single execution.

$sel:httpStatus:StartResourceEvaluationResponse', startResourceEvaluationResponse_httpStatus - The response's http status code.

Response Lenses

startResourceEvaluationResponse_resourceEvaluationId :: Lens' StartResourceEvaluationResponse (Maybe Text)

A unique ResourceEvaluationId that is associated with a single execution.

startResourceEvaluationResponse_httpStatus :: Lens' StartResourceEvaluationResponse Int

The response's http status code.