Amazonka.Config.GetResourceEvaluationSummary

Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.

Creating a Request

data GetResourceEvaluationSummary

See: newGetResourceEvaluationSummary smart constructor.

Constructors

GetResourceEvaluationSummary'

Fields

• resourceEvaluationId :: Text

  The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

Instances

ToJSON GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

toJSON :: GetResourceEvaluationSummary -> Value

toEncoding :: GetResourceEvaluationSummary -> Encoding

toJSONList :: [GetResourceEvaluationSummary] -> Value

toEncodingList :: [GetResourceEvaluationSummary] -> Encoding

ToHeaders GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

toHeaders :: GetResourceEvaluationSummary -> [Header]

ToPath GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

toPath :: GetResourceEvaluationSummary -> ByteString

ToQuery GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

toQuery :: GetResourceEvaluationSummary -> QueryString

AWSRequest GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

Associated Types

type AWSResponse GetResourceEvaluationSummary

Methods

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

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

Generic GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

Associated Types

type Rep GetResourceEvaluationSummary :: Type -> Type

Methods

from :: GetResourceEvaluationSummary -> Rep GetResourceEvaluationSummary x

to :: Rep GetResourceEvaluationSummary x -> GetResourceEvaluationSummary

Read GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

readsPrec :: Int -> ReadS GetResourceEvaluationSummary

readList :: ReadS [GetResourceEvaluationSummary]

readPrec :: ReadPrec GetResourceEvaluationSummary

readListPrec :: ReadPrec [GetResourceEvaluationSummary]

Show GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

showsPrec :: Int -> GetResourceEvaluationSummary -> ShowS

show :: GetResourceEvaluationSummary -> String

showList :: [GetResourceEvaluationSummary] -> ShowS

NFData GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

rnf :: GetResourceEvaluationSummary -> ()

Eq GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

(==) :: GetResourceEvaluationSummary -> GetResourceEvaluationSummary -> Bool

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

Hashable GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

hashWithSalt :: Int -> GetResourceEvaluationSummary -> Int

hash :: GetResourceEvaluationSummary -> Int

type AWSResponse GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

type AWSResponse GetResourceEvaluationSummary = GetResourceEvaluationSummaryResponse

type Rep GetResourceEvaluationSummary

Defined in Amazonka.Config.GetResourceEvaluationSummary

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

newGetResourceEvaluationSummary

Arguments

:: Text

GetResourceEvaluationSummary

-> GetResourceEvaluationSummary

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

GetResourceEvaluationSummary, getResourceEvaluationSummary_resourceEvaluationId - The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

Request Lenses

getResourceEvaluationSummary_resourceEvaluationId :: Lens' GetResourceEvaluationSummary Text

The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

Destructuring the Response

data GetResourceEvaluationSummaryResponse

See: newGetResourceEvaluationSummaryResponse smart constructor.

Constructors

GetResourceEvaluationSummaryResponse'

Fields

• compliance :: Maybe ComplianceType

  The compliance status of the resource evaluation summary.

• evaluationContext :: Maybe EvaluationContext

  Returns an EvaluationContext object.

• evaluationMode :: Maybe EvaluationMode

  Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive.

• evaluationStartTimestamp :: Maybe POSIX

  The start timestamp when Config rule starts evaluating compliance for the provided resource details.

• evaluationStatus :: Maybe EvaluationStatus

  Returns an EvaluationStatus object.

• resourceDetails :: Maybe ResourceDetails

  Returns a ResourceDetails object.

• resourceEvaluationId :: Maybe Text

  The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetResourceEvaluationSummaryResponse

Defined in Amazonka.Config.GetResourceEvaluationSummary

Associated Types

type Rep GetResourceEvaluationSummaryResponse :: Type -> Type

Methods

from :: GetResourceEvaluationSummaryResponse -> Rep GetResourceEvaluationSummaryResponse x

to :: Rep GetResourceEvaluationSummaryResponse x -> GetResourceEvaluationSummaryResponse

Read GetResourceEvaluationSummaryResponse

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

readsPrec :: Int -> ReadS GetResourceEvaluationSummaryResponse

readList :: ReadS [GetResourceEvaluationSummaryResponse]

readPrec :: ReadPrec GetResourceEvaluationSummaryResponse

readListPrec :: ReadPrec [GetResourceEvaluationSummaryResponse]

Show GetResourceEvaluationSummaryResponse

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

showsPrec :: Int -> GetResourceEvaluationSummaryResponse -> ShowS

show :: GetResourceEvaluationSummaryResponse -> String

showList :: [GetResourceEvaluationSummaryResponse] -> ShowS

NFData GetResourceEvaluationSummaryResponse

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

rnf :: GetResourceEvaluationSummaryResponse -> ()

Eq GetResourceEvaluationSummaryResponse

Defined in Amazonka.Config.GetResourceEvaluationSummary

Methods

(==) :: GetResourceEvaluationSummaryResponse -> GetResourceEvaluationSummaryResponse -> Bool

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

type Rep GetResourceEvaluationSummaryResponse

Defined in Amazonka.Config.GetResourceEvaluationSummary

type Rep GetResourceEvaluationSummaryResponse = D1 ('MetaData "GetResourceEvaluationSummaryResponse" "Amazonka.Config.GetResourceEvaluationSummary" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "GetResourceEvaluationSummaryResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "compliance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComplianceType)) :*: S1 ('MetaSel ('Just "evaluationContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EvaluationContext))) :*: (S1 ('MetaSel ('Just "evaluationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EvaluationMode)) :*: S1 ('MetaSel ('Just "evaluationStartTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "evaluationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EvaluationStatus)) :*: S1 ('MetaSel ('Just "resourceDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceDetails))) :*: (S1 ('MetaSel ('Just "resourceEvaluationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetResourceEvaluationSummaryResponse

Arguments

:: Int

$sel:httpStatus:GetResourceEvaluationSummaryResponse'

-> GetResourceEvaluationSummaryResponse

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

GetResourceEvaluationSummaryResponse, getResourceEvaluationSummaryResponse_compliance - The compliance status of the resource evaluation summary.

$sel:evaluationContext:GetResourceEvaluationSummaryResponse', getResourceEvaluationSummaryResponse_evaluationContext - Returns an EvaluationContext object.

GetResourceEvaluationSummaryResponse, getResourceEvaluationSummaryResponse_evaluationMode - Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive.

GetResourceEvaluationSummaryResponse, getResourceEvaluationSummaryResponse_evaluationStartTimestamp - The start timestamp when Config rule starts evaluating compliance for the provided resource details.

$sel:evaluationStatus:GetResourceEvaluationSummaryResponse', getResourceEvaluationSummaryResponse_evaluationStatus - Returns an EvaluationStatus object.

$sel:resourceDetails:GetResourceEvaluationSummaryResponse', getResourceEvaluationSummaryResponse_resourceDetails - Returns a ResourceDetails object.

GetResourceEvaluationSummary, getResourceEvaluationSummaryResponse_resourceEvaluationId - The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

$sel:httpStatus:GetResourceEvaluationSummaryResponse', getResourceEvaluationSummaryResponse_httpStatus - The response's http status code.

Response Lenses

getResourceEvaluationSummaryResponse_compliance :: Lens' GetResourceEvaluationSummaryResponse (Maybe ComplianceType)

The compliance status of the resource evaluation summary.

getResourceEvaluationSummaryResponse_evaluationContext :: Lens' GetResourceEvaluationSummaryResponse (Maybe EvaluationContext)

Returns an EvaluationContext object.

getResourceEvaluationSummaryResponse_evaluationMode :: Lens' GetResourceEvaluationSummaryResponse (Maybe EvaluationMode)

Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive.

getResourceEvaluationSummaryResponse_evaluationStartTimestamp :: Lens' GetResourceEvaluationSummaryResponse (Maybe UTCTime)

The start timestamp when Config rule starts evaluating compliance for the provided resource details.

getResourceEvaluationSummaryResponse_evaluationStatus :: Lens' GetResourceEvaluationSummaryResponse (Maybe EvaluationStatus)

Returns an EvaluationStatus object.

getResourceEvaluationSummaryResponse_resourceDetails :: Lens' GetResourceEvaluationSummaryResponse (Maybe ResourceDetails)

Returns a ResourceDetails object.

getResourceEvaluationSummaryResponse_resourceEvaluationId :: Lens' GetResourceEvaluationSummaryResponse (Maybe Text)

The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

getResourceEvaluationSummaryResponse_httpStatus :: Lens' GetResourceEvaluationSummaryResponse Int

The response's http status code.