Network.AWS.Config.DescribeComplianceByResource

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

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

If AWS 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:

• AWS 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 AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the 'config:PutEvaluations' permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the 'config:PutEvaluations' permission.
• The rule's AWS 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.

Creating a Request

describeComplianceByResource :: DescribeComplianceByResource

Creates a value of DescribeComplianceByResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcbrResourceId
• dcbrResourceType
• dcbrComplianceTypes
• dcbrNextToken
• dcbrLimit

data DescribeComplianceByResource

See: describeComplianceByResource smart constructor.

Instances

Eq DescribeComplianceByResource

Methods

(==) :: DescribeComplianceByResource -> DescribeComplianceByResource -> Bool

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

Data DescribeComplianceByResource

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeComplianceByResource -> c DescribeComplianceByResource

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeComplianceByResource

toConstr :: DescribeComplianceByResource -> Constr

dataTypeOf :: DescribeComplianceByResource -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeComplianceByResource)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeComplianceByResource)

gmapT :: (forall b. Data b => b -> b) -> DescribeComplianceByResource -> DescribeComplianceByResource

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeComplianceByResource -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeComplianceByResource -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeComplianceByResource -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeComplianceByResource -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeComplianceByResource -> m DescribeComplianceByResource

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeComplianceByResource -> m DescribeComplianceByResource

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeComplianceByResource -> m DescribeComplianceByResource

Read DescribeComplianceByResource

Methods

readsPrec :: Int -> ReadS DescribeComplianceByResource

readList :: ReadS [DescribeComplianceByResource]

readPrec :: ReadPrec DescribeComplianceByResource

readListPrec :: ReadPrec [DescribeComplianceByResource]

Show DescribeComplianceByResource

Methods

showsPrec :: Int -> DescribeComplianceByResource -> ShowS

show :: DescribeComplianceByResource -> String

showList :: [DescribeComplianceByResource] -> ShowS

Generic DescribeComplianceByResource

Associated Types

type Rep DescribeComplianceByResource :: * -> *

Methods

from :: DescribeComplianceByResource -> Rep DescribeComplianceByResource x

to :: Rep DescribeComplianceByResource x -> DescribeComplianceByResource

ToJSON DescribeComplianceByResource

Methods

toJSON :: DescribeComplianceByResource -> Value

toEncoding :: DescribeComplianceByResource -> Encoding

Hashable DescribeComplianceByResource

Methods

hashWithSalt :: Int -> DescribeComplianceByResource -> Int

hash :: DescribeComplianceByResource -> Int

NFData DescribeComplianceByResource

Methods

rnf :: DescribeComplianceByResource -> ()

AWSRequest DescribeComplianceByResource

Associated Types

type Rs DescribeComplianceByResource :: *

Methods

request :: DescribeComplianceByResource -> Request DescribeComplianceByResource

response :: MonadResource m => Logger -> Service -> Proxy * DescribeComplianceByResource -> ClientResponse -> m (Response DescribeComplianceByResource)

ToPath DescribeComplianceByResource

Methods

toPath :: DescribeComplianceByResource -> ByteString

ToHeaders DescribeComplianceByResource

Methods

toHeaders :: DescribeComplianceByResource -> [Header]

ToQuery DescribeComplianceByResource

Methods

toQuery :: DescribeComplianceByResource -> QueryString

type Rep DescribeComplianceByResource

type Rep DescribeComplianceByResource = D1 (MetaData "DescribeComplianceByResource" "Network.AWS.Config.DescribeComplianceByResource" "amazonka-config-1.4.3-6dEKTXSzLg81CPzXP0Z06u" False) (C1 (MetaCons "DescribeComplianceByResource'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dcbrResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dcbrResourceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dcbrComplianceTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ComplianceType]))) ((:*:) (S1 (MetaSel (Just Symbol "_dcbrNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dcbrLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))))

type Rs DescribeComplianceByResource

type Rs DescribeComplianceByResource = DescribeComplianceByResourceResponse

Request Lenses

dcbrResourceId :: Lens' DescribeComplianceByResource (Maybe Text)

The ID of the AWS 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.

dcbrResourceType :: Lens' DescribeComplianceByResource (Maybe Text)

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

dcbrComplianceTypes :: Lens' DescribeComplianceByResource [ComplianceType]

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

dcbrNextToken :: Lens' DescribeComplianceByResource (Maybe Text)

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

dcbrLimit :: Lens' DescribeComplianceByResource (Maybe Natural)

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

Destructuring the Response

describeComplianceByResourceResponse

Arguments

:: Int

dcbrrsResponseStatus

-> DescribeComplianceByResourceResponse

Creates a value of DescribeComplianceByResourceResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcbrrsComplianceByResources
• dcbrrsNextToken
• dcbrrsResponseStatus

data DescribeComplianceByResourceResponse

See: describeComplianceByResourceResponse smart constructor.

Instances

Eq DescribeComplianceByResourceResponse

Methods

(==) :: DescribeComplianceByResourceResponse -> DescribeComplianceByResourceResponse -> Bool

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

Data DescribeComplianceByResourceResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeComplianceByResourceResponse -> c DescribeComplianceByResourceResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeComplianceByResourceResponse

toConstr :: DescribeComplianceByResourceResponse -> Constr

dataTypeOf :: DescribeComplianceByResourceResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeComplianceByResourceResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeComplianceByResourceResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeComplianceByResourceResponse -> DescribeComplianceByResourceResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeComplianceByResourceResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeComplianceByResourceResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeComplianceByResourceResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeComplianceByResourceResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeComplianceByResourceResponse -> m DescribeComplianceByResourceResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeComplianceByResourceResponse -> m DescribeComplianceByResourceResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeComplianceByResourceResponse -> m DescribeComplianceByResourceResponse

Read DescribeComplianceByResourceResponse

Methods

readsPrec :: Int -> ReadS DescribeComplianceByResourceResponse

readList :: ReadS [DescribeComplianceByResourceResponse]

readPrec :: ReadPrec DescribeComplianceByResourceResponse

readListPrec :: ReadPrec [DescribeComplianceByResourceResponse]

Show DescribeComplianceByResourceResponse

Methods

showsPrec :: Int -> DescribeComplianceByResourceResponse -> ShowS

show :: DescribeComplianceByResourceResponse -> String

showList :: [DescribeComplianceByResourceResponse] -> ShowS

Generic DescribeComplianceByResourceResponse

Associated Types

type Rep DescribeComplianceByResourceResponse :: * -> *

Methods

from :: DescribeComplianceByResourceResponse -> Rep DescribeComplianceByResourceResponse x

to :: Rep DescribeComplianceByResourceResponse x -> DescribeComplianceByResourceResponse

NFData DescribeComplianceByResourceResponse

Methods

rnf :: DescribeComplianceByResourceResponse -> ()

type Rep DescribeComplianceByResourceResponse

type Rep DescribeComplianceByResourceResponse = D1 (MetaData "DescribeComplianceByResourceResponse" "Network.AWS.Config.DescribeComplianceByResource" "amazonka-config-1.4.3-6dEKTXSzLg81CPzXP0Z06u" False) (C1 (MetaCons "DescribeComplianceByResourceResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dcbrrsComplianceByResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ComplianceByResource]))) ((:*:) (S1 (MetaSel (Just Symbol "_dcbrrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dcbrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

dcbrrsComplianceByResources :: Lens' DescribeComplianceByResourceResponse [ComplianceByResource]

Indicates whether the specified AWS resource complies with all of the AWS Config rules that evaluate it.

dcbrrsNextToken :: Lens' DescribeComplianceByResourceResponse (Maybe Text)

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

dcbrrsResponseStatus :: Lens' DescribeComplianceByResourceResponse Int

The response status code.