Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Config.GetComplianceDetailsByResource

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last invoked, and whether the resource complies with each rule.

This operation returns paginated results.

Synopsis

Creating a Request

data GetComplianceDetailsByResource Source #

See: newGetComplianceDetailsByResource smart constructor.

Constructors

GetComplianceDetailsByResource'

Fields

complianceTypes :: Maybe [ComplianceType]
Filters the results by compliance.
The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.
nextToken :: Maybe Text
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
resourceEvaluationId :: Maybe Text
The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results.
You need to only provide either a ResourceEvaluationID or a ResourceID and ResourceType.
resourceId :: Maybe Text
The ID of the Amazon Web Services resource for which you want compliance information.
resourceType :: Maybe Text
The type of the Amazon Web Services resource for which you want compliance information.

Instances

Instances details

ToJSON GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods toJSON :: GetComplianceDetailsByResource -> Value # toEncoding :: GetComplianceDetailsByResource -> Encoding # toJSONList :: [GetComplianceDetailsByResource] -> Value # toEncodingList :: [GetComplianceDetailsByResource] -> Encoding #
ToHeaders GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods toHeaders :: GetComplianceDetailsByResource -> [Header] #
ToPath GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods toPath :: GetComplianceDetailsByResource -> ByteString #
ToQuery GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods toQuery :: GetComplianceDetailsByResource -> QueryString #
AWSPager GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods page :: GetComplianceDetailsByResource -> AWSResponse GetComplianceDetailsByResource -> Maybe GetComplianceDetailsByResource #
AWSRequest GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Associated Types type AWSResponse GetComplianceDetailsByResource # Methods request :: (Service -> Service) -> GetComplianceDetailsByResource -> Request GetComplianceDetailsByResource # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetComplianceDetailsByResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetComplianceDetailsByResource))) #
Generic GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Associated Types type Rep GetComplianceDetailsByResource :: Type -> Type # Methods from :: GetComplianceDetailsByResource -> Rep GetComplianceDetailsByResource x # to :: Rep GetComplianceDetailsByResource x -> GetComplianceDetailsByResource #
Read GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods readsPrec :: Int -> ReadS GetComplianceDetailsByResource # readList :: ReadS [GetComplianceDetailsByResource] # readPrec :: ReadPrec GetComplianceDetailsByResource # readListPrec :: ReadPrec [GetComplianceDetailsByResource] #
Show GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods showsPrec :: Int -> GetComplianceDetailsByResource -> ShowS # show :: GetComplianceDetailsByResource -> String # showList :: [GetComplianceDetailsByResource] -> ShowS #
NFData GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods rnf :: GetComplianceDetailsByResource -> () #
Eq GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods (==) :: GetComplianceDetailsByResource -> GetComplianceDetailsByResource -> Bool # (/=) :: GetComplianceDetailsByResource -> GetComplianceDetailsByResource -> Bool #
Hashable GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods hashWithSalt :: Int -> GetComplianceDetailsByResource -> Int # hash :: GetComplianceDetailsByResource -> Int #
type AWSResponse GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource type AWSResponse GetComplianceDetailsByResource = GetComplianceDetailsByResourceResponse
type Rep GetComplianceDetailsByResource Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource type Rep GetComplianceDetailsByResource = D1 ('MetaData "GetComplianceDetailsByResource" "Amazonka.Config.GetComplianceDetailsByResource" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "GetComplianceDetailsByResource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "complianceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComplianceType])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "resourceEvaluationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newGetComplianceDetailsByResource :: GetComplianceDetailsByResource Source #

Create a value of GetComplianceDetailsByResource 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:complianceTypes:GetComplianceDetailsByResource', getComplianceDetailsByResource_complianceTypes - Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

GetComplianceDetailsByResource, getComplianceDetailsByResource_nextToken - The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

GetComplianceDetailsByResource, getComplianceDetailsByResource_resourceEvaluationId - The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results.

You need to only provide either a ResourceEvaluationID or a ResourceID and ResourceType.

GetComplianceDetailsByResource, getComplianceDetailsByResource_resourceId - The ID of the Amazon Web Services resource for which you want compliance information.

GetComplianceDetailsByResource, getComplianceDetailsByResource_resourceType - The type of the Amazon Web Services resource for which you want compliance information.

Request Lenses

getComplianceDetailsByResource_complianceTypes :: Lens' GetComplianceDetailsByResource (Maybe [ComplianceType]) Source #

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

getComplianceDetailsByResource_nextToken :: Lens' GetComplianceDetailsByResource (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getComplianceDetailsByResource_resourceEvaluationId :: Lens' GetComplianceDetailsByResource (Maybe Text) Source #

The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results.

You need to only provide either a ResourceEvaluationID or a ResourceID and ResourceType.

getComplianceDetailsByResource_resourceId :: Lens' GetComplianceDetailsByResource (Maybe Text) Source #

The ID of the Amazon Web Services resource for which you want compliance information.

getComplianceDetailsByResource_resourceType :: Lens' GetComplianceDetailsByResource (Maybe Text) Source #

The type of the Amazon Web Services resource for which you want compliance information.

Destructuring the Response

data GetComplianceDetailsByResourceResponse Source #

See: newGetComplianceDetailsByResourceResponse smart constructor.

Constructors

GetComplianceDetailsByResourceResponse'
Fields evaluationResults :: Maybe [EvaluationResult] Indicates whether the specified Amazon Web Services resource complies each Config rule. nextToken :: Maybe Text The string that you use in a subsequent request to get the next page of results in a paginated response. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetComplianceDetailsByResourceResponse Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Associated Types type Rep GetComplianceDetailsByResourceResponse :: Type -> Type # Methods from :: GetComplianceDetailsByResourceResponse -> Rep GetComplianceDetailsByResourceResponse x # to :: Rep GetComplianceDetailsByResourceResponse x -> GetComplianceDetailsByResourceResponse #
Read GetComplianceDetailsByResourceResponse Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods readsPrec :: Int -> ReadS GetComplianceDetailsByResourceResponse # readList :: ReadS [GetComplianceDetailsByResourceResponse] # readPrec :: ReadPrec GetComplianceDetailsByResourceResponse # readListPrec :: ReadPrec [GetComplianceDetailsByResourceResponse] #
Show GetComplianceDetailsByResourceResponse Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods showsPrec :: Int -> GetComplianceDetailsByResourceResponse -> ShowS # show :: GetComplianceDetailsByResourceResponse -> String # showList :: [GetComplianceDetailsByResourceResponse] -> ShowS #
NFData GetComplianceDetailsByResourceResponse Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods rnf :: GetComplianceDetailsByResourceResponse -> () #
Eq GetComplianceDetailsByResourceResponse Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource Methods (==) :: GetComplianceDetailsByResourceResponse -> GetComplianceDetailsByResourceResponse -> Bool # (/=) :: GetComplianceDetailsByResourceResponse -> GetComplianceDetailsByResourceResponse -> Bool #
type Rep GetComplianceDetailsByResourceResponse Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByResource type Rep GetComplianceDetailsByResourceResponse = D1 ('MetaData "GetComplianceDetailsByResourceResponse" "Amazonka.Config.GetComplianceDetailsByResource" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "GetComplianceDetailsByResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "evaluationResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EvaluationResult])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetComplianceDetailsByResourceResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetComplianceDetailsByResourceResponse'`
-> GetComplianceDetailsByResourceResponse

Create a value of GetComplianceDetailsByResourceResponse 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:evaluationResults:GetComplianceDetailsByResourceResponse', getComplianceDetailsByResourceResponse_evaluationResults - Indicates whether the specified Amazon Web Services resource complies each Config rule.

GetComplianceDetailsByResource, getComplianceDetailsByResourceResponse_nextToken - The string that you use in a subsequent request to get the next page of results in a paginated response.

$sel:httpStatus:GetComplianceDetailsByResourceResponse', getComplianceDetailsByResourceResponse_httpStatus - The response's http status code.

Response Lenses

getComplianceDetailsByResourceResponse_evaluationResults :: Lens' GetComplianceDetailsByResourceResponse (Maybe [EvaluationResult]) Source #

Indicates whether the specified Amazon Web Services resource complies each Config rule.

getComplianceDetailsByResourceResponse_nextToken :: Lens' GetComplianceDetailsByResourceResponse (Maybe Text) Source #

The string that you use in a subsequent request to get the next page of results in a paginated response.

getComplianceDetailsByResourceResponse_httpStatus :: Lens' GetComplianceDetailsByResourceResponse Int Source #

The response's http status code.