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.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_instances :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithCriticalNonCompliantPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithFailedPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithInstalledOtherPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithInstalledPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithInstalledPendingRebootPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithInstalledRejectedPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithMissingPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithNotApplicablePatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithOtherNonCompliantPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithSecurityNonCompliantPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int)
describePatchGroupStateResponse_instancesWithUnreportedNotApplicablePatches :: 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

ToJSON DescribePatchGroupState Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState Methods toJSON :: DescribePatchGroupState -> Value # toEncoding :: DescribePatchGroupState -> Encoding # toJSONList :: [DescribePatchGroupState] -> Value # toEncodingList :: [DescribePatchGroupState] -> Encoding #
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 #
AWSRequest DescribePatchGroupState Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState Associated Types type AWSResponse DescribePatchGroupState # Methods request :: (Service -> Service) -> DescribePatchGroupState -> Request DescribePatchGroupState # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribePatchGroupState -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePatchGroupState))) #
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 #
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 #
NFData DescribePatchGroupState Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState Methods rnf :: DescribePatchGroupState -> () #
Eq DescribePatchGroupState Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState Methods (==) :: DescribePatchGroupState -> DescribePatchGroupState -> Bool # (/=) :: DescribePatchGroupState -> DescribePatchGroupState -> Bool #
Hashable DescribePatchGroupState Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState Methods hashWithSalt :: Int -> DescribePatchGroupState -> Int # hash :: DescribePatchGroupState -> Int #
type AWSResponse DescribePatchGroupState Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState type AWSResponse DescribePatchGroupState = DescribePatchGroupStateResponse
type Rep DescribePatchGroupState Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState type Rep DescribePatchGroupState = D1 ('MetaData "DescribePatchGroupState" "Amazonka.SSM.DescribePatchGroupState" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DescribePatchGroupState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribePatchGroupState Source #

Arguments

:: Text	`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:

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

instances :: Maybe Int
The number of managed nodes in the patch group.
instancesWithCriticalNonCompliantPatches :: Maybe Int
The number of managed nodes 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 managed node reboot. The status of these managed nodes is NON_COMPLIANT.
instancesWithFailedPatches :: Maybe Int
The number of managed nodes with patches from the patch baseline that failed to install.
instancesWithInstalledOtherPatches :: Maybe Int
The number of managed nodes with patches installed that aren't defined in the patch baseline.
instancesWithInstalledPatches :: Maybe Int
The number of managed nodes with installed patches.
instancesWithInstalledPendingRebootPatches :: Maybe Int
The number of managed nodes with patches installed by Patch Manager that haven't been rebooted after the patch installation. The status of these managed nodes is NON_COMPLIANT.
instancesWithInstalledRejectedPatches :: Maybe Int
The number of managed nodes 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).
instancesWithMissingPatches :: Maybe Int
The number of managed nodes with missing patches from the patch baseline.
instancesWithNotApplicablePatches :: Maybe Int
The number of managed nodes with patches that aren't applicable.
instancesWithOtherNonCompliantPatches :: Maybe Int
The number of managed nodes with patches installed that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these managed nodes is NON_COMPLIANT.
instancesWithSecurityNonCompliantPatches :: Maybe Int
The number of managed nodes 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 managed node reboot. The status of these managed nodes is NON_COMPLIANT.
instancesWithUnreportedNotApplicablePatches :: Maybe Int
The number of managed nodes 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData DescribePatchGroupStateResponse Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState Methods rnf :: DescribePatchGroupStateResponse -> () #
Eq DescribePatchGroupStateResponse Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState Methods (==) :: DescribePatchGroupStateResponse -> DescribePatchGroupStateResponse -> Bool # (/=) :: DescribePatchGroupStateResponse -> DescribePatchGroupStateResponse -> Bool #
type Rep DescribePatchGroupStateResponse Source #
Instance details Defined in Amazonka.SSM.DescribePatchGroupState type Rep DescribePatchGroupStateResponse = D1 ('MetaData "DescribePatchGroupStateResponse" "Amazonka.SSM.DescribePatchGroupState" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DescribePatchGroupStateResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "instancesWithCriticalNonCompliantPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "instancesWithFailedPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "instancesWithInstalledOtherPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "instancesWithInstalledPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "instancesWithInstalledPendingRebootPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "instancesWithInstalledRejectedPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "instancesWithMissingPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "instancesWithNotApplicablePatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "instancesWithOtherNonCompliantPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "instancesWithSecurityNonCompliantPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "instancesWithUnreportedNotApplicablePatches") '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:instances:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instances - The number of managed nodes in the patch group.

$sel:instancesWithCriticalNonCompliantPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithCriticalNonCompliantPatches - The number of managed nodes 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 managed node reboot. The status of these managed nodes is NON_COMPLIANT.

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

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

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

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

$sel:instancesWithInstalledRejectedPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithInstalledRejectedPatches - The number of managed nodes 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:instancesWithMissingPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithMissingPatches - The number of managed nodes with missing patches from the patch baseline.

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

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

$sel:instancesWithSecurityNonCompliantPatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithSecurityNonCompliantPatches - The number of managed nodes 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 managed node reboot. The status of these managed nodes is NON_COMPLIANT.

$sel:instancesWithUnreportedNotApplicablePatches:DescribePatchGroupStateResponse', describePatchGroupStateResponse_instancesWithUnreportedNotApplicablePatches - The number of managed nodes 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:httpStatus:DescribePatchGroupStateResponse', describePatchGroupStateResponse_httpStatus - The response's http status code.

Response Lenses

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

The number of managed nodes in the patch group.

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

The number of managed nodes 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 managed node reboot. The status of these managed nodes is NON_COMPLIANT.

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

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

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

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

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

The number of managed nodes with installed patches.

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

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

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

The number of managed nodes 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_instancesWithMissingPatches :: Lens' DescribePatchGroupStateResponse (Maybe Int) Source #

The number of managed nodes with missing patches from the patch baseline.

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

The number of managed nodes with patches that aren't applicable.

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

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

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

The number of managed nodes 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 managed node reboot. The status of these managed nodes is NON_COMPLIANT.

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

The number of managed nodes 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_httpStatus :: Lens' DescribePatchGroupStateResponse Int Source #

The response's http status code.