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.SSM.DescribePatchGroupState

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns high-level aggregated patch compliance state information for a patch group.

Synopsis

data DescribePatchGroupState = DescribePatchGroupState' {
- patchGroup :: Text
}
newDescribePatchGroupState :: Text -> DescribePatchGroupState
describePatchGroupState_patchGroup :: Lens' DescribePatchGroupState Text
data DescribePatchGroupStateResponse = DescribePatchGroupStateResponse' {
}
newDescribePatchGroupStateResponse :: Int -> DescribePatchGroupStateResponse
describePatchGroupStateResponse_instancesWithMissingPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithInstalledOtherPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithNotApplicablePatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithInstalledPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithCriticalNonCompliantPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithSecurityNonCompliantPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithInstalledRejectedPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithInstalledPendingRebootPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithOtherNonCompliantPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithUnreportedNotApplicablePatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instances :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithFailedPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_httpStatus :: Lens' DescribePatchGroupStateResponse Int

Creating a Request

data DescribePatchGroupState Source #

See: newDescribePatchGroupState smart constructor.

Constructors

DescribePatchGroupState'
Fields patchGroup :: Text The name of the patch group whose patch snapshot should be retrieved.

Instances

Instances details

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

newDescribePatchGroupState Source #

Arguments

:: Text	`$sel:patchGroup:DescribePatchGroupState'`
-> DescribePatchGroupState

Create a value of DescribePatchGroupState 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:patchGroup:DescribePatchGroupState', describePatchGroupState_patchGroup - The name of the patch group whose patch snapshot should be retrieved.

Request Lenses

describePatchGroupState_patchGroup :: Lens' DescribePatchGroupState Text Source #

The name of the patch group whose patch snapshot should be retrieved.

Destructuring the Response

data DescribePatchGroupStateResponse Source #

See: newDescribePatchGroupStateResponse smart constructor.

Constructors

DescribePatchGroupStateResponse'

Fields

instancesWithMissingPatches :: Maybe Int
The number of instances with missing patches from the patch baseline.
instancesWithInstalledOtherPatches :: Maybe Int
The number of instances with patches installed that aren't defined in the patch baseline.
instancesWithNotApplicablePatches :: Maybe Int
The number of instances with patches that aren't applicable.
instancesWithInstalledPatches :: Maybe Int
The number of instances with installed patches.
instancesWithCriticalNonCompliantPatches :: Maybe Int
The number of instances where patches that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.
instancesWithSecurityNonCompliantPatches :: Maybe Int
The number of instances where patches that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.
instancesWithInstalledRejectedPatches :: Maybe Int
The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list.
If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).
instancesWithInstalledPendingRebootPatches :: Maybe Int
The number of instances with patches installed by Patch Manager that haven't been rebooted after the patch installation. The status of these instances is NON_COMPLIANT.
instancesWithOtherNonCompliantPatches :: Maybe Int
The number of instances with patches installed that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these instances is NON_COMPLIANT.
instancesWithUnreportedNotApplicablePatches :: Maybe Int
The number of instances with NotApplicable patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.
instances :: Maybe Int
The number of instances in the patch group.
instancesWithFailedPatches :: Maybe Int
The number of instances with patches from the patch baseline that failed to install.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribePatchGroupStateResponse Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState Methods (==) :: DescribePatchGroupStateResponse -> DescribePatchGroupStateResponse -> Bool # (/=) :: DescribePatchGroupStateResponse -> DescribePatchGroupStateResponse -> Bool #
Read DescribePatchGroupStateResponse Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState Methods readsPrec :: Int -> ReadS DescribePatchGroupStateResponse # readList :: ReadS [DescribePatchGroupStateResponse] # readPrec :: ReadPrec DescribePatchGroupStateResponse # readListPrec :: ReadPrec [DescribePatchGroupStateResponse] #
Show DescribePatchGroupStateResponse Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState Methods showsPrec :: Int -> DescribePatchGroupStateResponse -> ShowS # show :: DescribePatchGroupStateResponse -> String # showList :: [DescribePatchGroupStateResponse] -> ShowS #
Generic DescribePatchGroupStateResponse Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState Associated Types type Rep DescribePatchGroupStateResponse :: Type -> Type # Methods from :: DescribePatchGroupStateResponse -> Rep DescribePatchGroupStateResponse x # to :: Rep DescribePatchGroupStateResponse x -> DescribePatchGroupStateResponse #
NFData DescribePatchGroupStateResponse Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState Methods rnf :: DescribePatchGroupStateResponse -> () #
type Rep DescribePatchGroupStateResponse Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState type Rep DescribePatchGroupStateResponse = D1 ('MetaData "DescribePatchGroupStateResponse" "Amazonka.SSM.DescribePatchGroupState" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DescribePatchGroupStateResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "instancesWithMissingPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "instancesWithInstalledOtherPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "instancesWithNotApplicablePatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "instancesWithInstalledPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "instancesWithCriticalNonCompliantPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "instancesWithSecurityNonCompliantPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "instancesWithInstalledRejectedPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "instancesWithInstalledPendingRebootPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "instancesWithOtherNonCompliantPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "instancesWithUnreportedNotApplicablePatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "instancesWithFailedPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribePatchGroupStateResponse Source #

Arguments

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

Create a value of DescribePatchGroupStateResponse 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:instancesWithMissingPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithMissingPatches - The number of instances with missing patches from the patch baseline.

$sel:instancesWithInstalledOtherPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithInstalledOtherPatches - The number of instances with patches installed that aren't defined in the patch baseline.

$sel:instancesWithNotApplicablePatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithNotApplicablePatches - The number of instances with patches that aren't applicable.

$sel:instancesWithInstalledPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithInstalledPatches - The number of instances with installed patches.

$sel:instancesWithCriticalNonCompliantPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithCriticalNonCompliantPatches - The number of instances where patches that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.

$sel:instancesWithSecurityNonCompliantPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithSecurityNonCompliantPatches - The number of instances where patches that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.

$sel:instancesWithInstalledRejectedPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithInstalledRejectedPatches - The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list.

If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).

$sel:instancesWithInstalledPendingRebootPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithInstalledPendingRebootPatches - The number of instances with patches installed by Patch Manager that haven't been rebooted after the patch installation. The status of these instances is NON_COMPLIANT.

$sel:instancesWithOtherNonCompliantPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithOtherNonCompliantPatches - The number of instances with patches installed that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these instances is NON_COMPLIANT.

$sel:instancesWithUnreportedNotApplicablePatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithUnreportedNotApplicablePatches - The number of instances with NotApplicable patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

$sel:instances:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instances - The number of instances in the patch group.

$sel:instancesWithFailedPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithFailedPatches - The number of instances with patches from the patch baseline that failed to install.

$sel:httpStatus:DescribePatchGroupStateResponse', describePatchGroupStateResponse_httpStatus - The response's http status code.

Response Lenses

describePatchGroupStateResponse_instancesWithMissingPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of instances with missing patches from the patch baseline.

describePatchGroupStateResponse_instancesWithInstalledOtherPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of instances with patches installed that aren't defined in the patch baseline.

describePatchGroupStateResponse_instancesWithNotApplicablePatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of instances with patches that aren't applicable.

describePatchGroupStateResponse_instancesWithInstalledPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of instances with installed patches.

describePatchGroupStateResponse_instancesWithCriticalNonCompliantPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of instances where patches that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.

describePatchGroupStateResponse_instancesWithSecurityNonCompliantPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of instances where patches that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is NON_COMPLIANT.

describePatchGroupStateResponse_instancesWithInstalledRejectedPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list.

If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).

describePatchGroupStateResponse_instancesWithInstalledPendingRebootPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of instances with patches installed by Patch Manager that haven't been rebooted after the patch installation. The status of these instances is NON_COMPLIANT.

describePatchGroupStateResponse_instancesWithOtherNonCompliantPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of instances with patches installed that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these instances is NON_COMPLIANT.

describePatchGroupStateResponse_instancesWithUnreportedNotApplicablePatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of instances with NotApplicable patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

describePatchGroupStateResponse_instances :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of instances in the patch group.

describePatchGroupStateResponse_instancesWithFailedPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of instances with patches from the patch baseline that failed to install.

describePatchGroupStateResponse_httpStatus :: Lens' DescribePatchGroupStateResponse Int Source #

The response's http status code.