Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Config.DescribeComplianceByResource

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.

A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.

If Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:

Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.
The rule's Lambda function is failing to send evaluation results to Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations permission.
The rule's Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeComplianceByResource Source #

See: newDescribeComplianceByResource smart constructor.

Constructors

DescribeComplianceByResource'

Fields

resourceId :: Maybe Text
The ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.
resourceType :: Maybe Text
The types of Amazon Web Services resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.
complianceTypes :: Maybe [ComplianceType]
Filters the results by compliance.
The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.
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.
limit :: Maybe Natural
The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

Instances

Instances details

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

newDescribeComplianceByResource :: DescribeComplianceByResource Source #

Create a value of DescribeComplianceByResource 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:resourceId:DescribeComplianceByResource', describeComplianceByResource_resourceId - The ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.

$sel:resourceType:DescribeComplianceByResource', describeComplianceByResource_resourceType - The types of Amazon Web Services resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

$sel:complianceTypes:DescribeComplianceByResource', describeComplianceByResource_complianceTypes - Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

$sel:nextToken:DescribeComplianceByResource', describeComplianceByResource_nextToken - The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

$sel:limit:DescribeComplianceByResource', describeComplianceByResource_limit - The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

Request Lenses

describeComplianceByResource_resourceId :: Lens' DescribeComplianceByResource (Maybe Text) Source #

The ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.

describeComplianceByResource_resourceType :: Lens' DescribeComplianceByResource (Maybe Text) Source #

The types of Amazon Web Services resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

describeComplianceByResource_complianceTypes :: Lens' DescribeComplianceByResource (Maybe [ComplianceType]) Source #

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

describeComplianceByResource_nextToken :: Lens' DescribeComplianceByResource (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.

describeComplianceByResource_limit :: Lens' DescribeComplianceByResource (Maybe Natural) Source #

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

Destructuring the Response

data DescribeComplianceByResourceResponse Source #

See: newDescribeComplianceByResourceResponse smart constructor.

Constructors

DescribeComplianceByResourceResponse'
Fields complianceByResources :: Maybe [ComplianceByResource] Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it. 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

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

newDescribeComplianceByResourceResponse Source #

Arguments

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

Create a value of DescribeComplianceByResourceResponse 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:complianceByResources:DescribeComplianceByResourceResponse', describeComplianceByResourceResponse_complianceByResources - Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.

$sel:nextToken:DescribeComplianceByResource', describeComplianceByResourceResponse_nextToken - The string that you use in a subsequent request to get the next page of results in a paginated response.

$sel:httpStatus:DescribeComplianceByResourceResponse', describeComplianceByResourceResponse_httpStatus - The response's http status code.

Response Lenses

describeComplianceByResourceResponse_complianceByResources :: Lens' DescribeComplianceByResourceResponse (Maybe [ComplianceByResource]) Source #

Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.

describeComplianceByResourceResponse_nextToken :: Lens' DescribeComplianceByResourceResponse (Maybe Text) Source #

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

describeComplianceByResourceResponse_httpStatus :: Lens' DescribeComplianceByResourceResponse Int Source #

The response's http status code.