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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

The following section lists the properties that can be used in filters for each major operating system type:

AMAZON_LINUX: Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
AMAZON_LINUX_2: Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
CENTOS: Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
DEBIAN: Valid properties: PRODUCT | PRIORITY
MACOS: Valid properties: PRODUCT | CLASSIFICATION
ORACLE_LINUX: Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
REDHAT_ENTERPRISE_LINUX: Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
SUSE: Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
UBUNTU: Valid properties: PRODUCT | PRIORITY
WINDOWS: Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY

This operation returns paginated results.

Synopsis

Creating a Request

data DescribePatchProperties Source #

See: newDescribePatchProperties smart constructor.

Constructors

DescribePatchProperties'

Fields

maxResults :: Maybe Natural
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
patchSet :: Maybe PatchSet
Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.
operatingSystem :: OperatingSystem
The operating system type for which to list patches.
property :: PatchProperty
The patch property for which you want to view patch details.

Instances

Instances details

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

newDescribePatchProperties Source #

Arguments

:: OperatingSystem	`DescribePatchProperties`
-> PatchProperty	`$sel:property:DescribePatchProperties'`
-> DescribePatchProperties

Create a value of DescribePatchProperties 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:maxResults:DescribePatchProperties', describePatchProperties_maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

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

$sel:patchSet:DescribePatchProperties', describePatchProperties_patchSet - Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.

DescribePatchProperties, describePatchProperties_operatingSystem - The operating system type for which to list patches.

$sel:property:DescribePatchProperties', describePatchProperties_property - The patch property for which you want to view patch details.

Request Lenses

describePatchProperties_maxResults :: Lens' DescribePatchProperties (Maybe Natural) Source #

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

describePatchProperties_nextToken :: Lens' DescribePatchProperties (Maybe Text) Source #

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

describePatchProperties_patchSet :: Lens' DescribePatchProperties (Maybe PatchSet) Source #

Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.

describePatchProperties_operatingSystem :: Lens' DescribePatchProperties OperatingSystem Source #

The operating system type for which to list patches.

describePatchProperties_property :: Lens' DescribePatchProperties PatchProperty Source #

The patch property for which you want to view patch details.

Destructuring the Response

data DescribePatchPropertiesResponse Source #

See: newDescribePatchPropertiesResponse smart constructor.

Constructors

DescribePatchPropertiesResponse'
Fields nextToken :: Maybe Text The token for the next set of items to return. (You use this token in the next call.) properties :: Maybe [HashMap Text Text] A list of the properties for patches matching the filter request parameters. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribePatchPropertiesResponse Source #

Arguments

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

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

DescribePatchProperties, describePatchPropertiesResponse_nextToken - The token for the next set of items to return. (You use this token in the next call.)

$sel:properties:DescribePatchPropertiesResponse', describePatchPropertiesResponse_properties - A list of the properties for patches matching the filter request parameters.

$sel:httpStatus:DescribePatchPropertiesResponse', describePatchPropertiesResponse_httpStatus - The response's http status code.

Response Lenses

describePatchPropertiesResponse_nextToken :: Lens' DescribePatchPropertiesResponse (Maybe Text) Source #

The token for the next set of items to return. (You use this token in the next call.)

describePatchPropertiesResponse_properties :: Lens' DescribePatchPropertiesResponse (Maybe [HashMap Text Text]) Source #

A list of the properties for patches matching the filter request parameters.

describePatchPropertiesResponse_httpStatus :: Lens' DescribePatchPropertiesResponse Int Source #

The response's http status code.