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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeInstancePatches Source #

See: newDescribeInstancePatches smart constructor.

Constructors

DescribeInstancePatches'

Fields

filters :: Maybe [PatchOrchestratorFilter]
Each element in the array is a structure containing a key-value pair.
Supported keys for DescribeInstancePatchesinclude the following:
- Classification
  Sample values: Security | SecurityUpdates
- KBId
  Sample values: KB4480056 | java-1.7.0-openjdk.x86_64
- Severity
  Sample values: Important | Medium | Low
- State
  Sample values: Installed | InstalledOther | InstalledPendingReboot
maxResults :: Maybe Natural
The maximum number of patches to return (per page).
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
instanceId :: Text
The ID of the managed node whose patch state information should be retrieved.

Instances

Instances details

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

newDescribeInstancePatches Source #

Arguments

:: Text	`DescribeInstancePatches`
-> DescribeInstancePatches

Create a value of DescribeInstancePatches 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:

DescribeInstancePatches, describeInstancePatches_filters - Each element in the array is a structure containing a key-value pair.

Supported keys for DescribeInstancePatchesinclude the following:

Classification
Sample values: Security | SecurityUpdates
KBId
Sample values: KB4480056 | java-1.7.0-openjdk.x86_64
Severity
Sample values: Important | Medium | Low
State
Sample values: Installed | InstalledOther | InstalledPendingReboot

$sel:maxResults:DescribeInstancePatches', describeInstancePatches_maxResults - The maximum number of patches to return (per page).

DescribeInstancePatches, describeInstancePatches_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

DescribeInstancePatches, describeInstancePatches_instanceId - The ID of the managed node whose patch state information should be retrieved.

Request Lenses

describeInstancePatches_filters :: Lens' DescribeInstancePatches (Maybe [PatchOrchestratorFilter]) Source #

Each element in the array is a structure containing a key-value pair.

Supported keys for DescribeInstancePatchesinclude the following:

Classification
Sample values: Security | SecurityUpdates
KBId
Sample values: KB4480056 | java-1.7.0-openjdk.x86_64
Severity
Sample values: Important | Medium | Low
State
Sample values: Installed | InstalledOther | InstalledPendingReboot

describeInstancePatches_maxResults :: Lens' DescribeInstancePatches (Maybe Natural) Source #

The maximum number of patches to return (per page).

describeInstancePatches_nextToken :: Lens' DescribeInstancePatches (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeInstancePatches_instanceId :: Lens' DescribeInstancePatches Text Source #

The ID of the managed node whose patch state information should be retrieved.

Destructuring the Response

data DescribeInstancePatchesResponse Source #

See: newDescribeInstancePatchesResponse smart constructor.

Constructors

DescribeInstancePatchesResponse'

Fields

nextToken :: Maybe Text
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
patches :: Maybe [PatchComplianceData]
Each entry in the array is a structure containing:
- Title (string)
- KBId (string)
- Classification (string)
- Severity (string)
- State (string, such as "INSTALLED" or "FAILED")
- InstalledTime (DateTime)
- InstalledBy (string)
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeInstancePatchesResponse Source #
Instance details Defined in Amazonka.SSM.DescribeInstancePatches Associated Types type Rep DescribeInstancePatchesResponse :: Type -> Type # Methods from :: DescribeInstancePatchesResponse -> Rep DescribeInstancePatchesResponse x # to :: Rep DescribeInstancePatchesResponse x -> DescribeInstancePatchesResponse #
Read DescribeInstancePatchesResponse Source #
Instance details Defined in Amazonka.SSM.DescribeInstancePatches Methods readsPrec :: Int -> ReadS DescribeInstancePatchesResponse # readList :: ReadS [DescribeInstancePatchesResponse] # readPrec :: ReadPrec DescribeInstancePatchesResponse # readListPrec :: ReadPrec [DescribeInstancePatchesResponse] #
Show DescribeInstancePatchesResponse Source #
Instance details Defined in Amazonka.SSM.DescribeInstancePatches Methods showsPrec :: Int -> DescribeInstancePatchesResponse -> ShowS # show :: DescribeInstancePatchesResponse -> String # showList :: [DescribeInstancePatchesResponse] -> ShowS #
NFData DescribeInstancePatchesResponse Source #
Instance details Defined in Amazonka.SSM.DescribeInstancePatches Methods rnf :: DescribeInstancePatchesResponse -> () #
Eq DescribeInstancePatchesResponse Source #
Instance details Defined in Amazonka.SSM.DescribeInstancePatches Methods (==) :: DescribeInstancePatchesResponse -> DescribeInstancePatchesResponse -> Bool # (/=) :: DescribeInstancePatchesResponse -> DescribeInstancePatchesResponse -> Bool #
type Rep DescribeInstancePatchesResponse Source #
Instance details Defined in Amazonka.SSM.DescribeInstancePatches type Rep DescribeInstancePatchesResponse = D1 ('MetaData "DescribeInstancePatchesResponse" "Amazonka.SSM.DescribeInstancePatches" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DescribeInstancePatchesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "patches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchComplianceData])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeInstancePatchesResponse Source #

Arguments

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

Create a value of DescribeInstancePatchesResponse 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:

DescribeInstancePatches, describeInstancePatchesResponse_nextToken - The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

$sel:patches:DescribeInstancePatchesResponse', describeInstancePatchesResponse_patches - Each entry in the array is a structure containing:

Title (string)
KBId (string)
Classification (string)
Severity (string)
State (string, such as "INSTALLED" or "FAILED")
InstalledTime (DateTime)
InstalledBy (string)

$sel:httpStatus:DescribeInstancePatchesResponse', describeInstancePatchesResponse_httpStatus - The response's http status code.

Response Lenses

describeInstancePatchesResponse_nextToken :: Lens' DescribeInstancePatchesResponse (Maybe Text) Source #

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

describeInstancePatchesResponse_patches :: Lens' DescribeInstancePatchesResponse (Maybe [PatchComplianceData]) Source #

Each entry in the array is a structure containing:

Title (string)
KBId (string)
Classification (string)
Severity (string)
State (string, such as "INSTALLED" or "FAILED")
InstalledTime (DateTime)
InstalledBy (string)

describeInstancePatchesResponse_httpStatus :: Lens' DescribeInstancePatchesResponse Int Source #

The response's http status code.