libZSservicesZSamazonka-configZSamazonka-config
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.Config.GetComplianceDetailsByResource

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

  • resourceType :: Text

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

  • resourceId :: Text

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

Instances

Instances details
Eq GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

Read GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

Show GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

Generic GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

Associated Types

type Rep GetComplianceDetailsByResource :: Type -> Type #

NFData GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

Hashable GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

ToJSON GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

AWSPager GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

AWSRequest GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

ToHeaders GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

ToPath GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

ToQuery GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

type Rep GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

type Rep GetComplianceDetailsByResource = D1 ('MetaData "GetComplianceDetailsByResource" "Amazonka.Config.GetComplianceDetailsByResource" "libZSservicesZSamazonka-configZSamazonka-config" '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 "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetComplianceDetailsByResource Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

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

$sel:nextToken: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.

$sel:resourceType:GetComplianceDetailsByResource', getComplianceDetailsByResource_resourceType - The type of the Amazon Web Services resource for which you want compliance information.

$sel:resourceId:GetComplianceDetailsByResource', getComplianceDetailsByResource_resourceId - The ID 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_resourceType :: Lens' GetComplianceDetailsByResource Text Source #

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

getComplianceDetailsByResource_resourceId :: Lens' GetComplianceDetailsByResource Text Source #

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

Destructuring the Response

data GetComplianceDetailsByResourceResponse Source #

Constructors

GetComplianceDetailsByResourceResponse' 

Fields

Instances

Instances details
Eq GetComplianceDetailsByResourceResponse Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

Read GetComplianceDetailsByResourceResponse Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

Show GetComplianceDetailsByResourceResponse Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

Generic GetComplianceDetailsByResourceResponse Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

NFData GetComplianceDetailsByResourceResponse Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

type Rep GetComplianceDetailsByResourceResponse Source # 
Instance details

Defined in Amazonka.Config.GetComplianceDetailsByResource

type Rep GetComplianceDetailsByResourceResponse = D1 ('MetaData "GetComplianceDetailsByResourceResponse" "Amazonka.Config.GetComplianceDetailsByResource" "libZSservicesZSamazonka-configZSamazonka-config" '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 #

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.

$sel:nextToken: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.