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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all patches eligible to be included in a patch baseline.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeAvailablePatches Source #

See: newDescribeAvailablePatches smart constructor.

Constructors

DescribeAvailablePatches'

Fields

filters :: Maybe [PatchOrchestratorFilter]
Each element in the array is a structure containing a key-value pair.
Windows Server
Supported keys for Windows Server instance patches include the following:
- PATCH_SET
  Sample values: OS | APPLICATION
- PRODUCT
  Sample values: WindowsServer2012 | Office 2010 | MicrosoftDefenderAntivirus
- PRODUCT_FAMILY
  Sample values: Windows | Office
- MSRC_SEVERITY
  Sample values: ServicePacks | Important | Moderate
- CLASSIFICATION
  Sample values: ServicePacks | SecurityUpdates | DefinitionUpdates
- PATCH_ID
  Sample values: KB123456 | KB4516046
Linux
When specifying filters for Linux patches, you must specify a key-pair for PRODUCT. For example, using the Command Line Interface (CLI), the following command fails:
```
aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615
```
However, the following command succeeds:
```
aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615
```
Supported keys for Linux instance patches include the following:
- PRODUCT
  Sample values: AmazonLinux2018.03 | AmazonLinux2.0
- NAME
  Sample values: kernel-headers | samba-python | php
- SEVERITY
  Sample values: Critical | Important | Medium | Low
- EPOCH
  Sample values: 0 | 1
- VERSION
  Sample values: 78.6.1 | 4.10.16
- RELEASE
  Sample values: 9.56.amzn1 | 1.amzn2
- ARCH
  Sample values: i686 | x86_64
- REPOSITORY
  Sample values: Core | Updates
- ADVISORY_ID
  Sample values: ALAS-2018-1058 | ALAS2-2021-1594
- CVE_ID
  Sample values: CVE-2018-3615 | CVE-2020-1472
- BUGZILLA_ID
  Sample values: 1463241
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
maxResults :: Maybe Natural
The maximum number of patches to return (per page).

Instances

Instances details

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

newDescribeAvailablePatches :: DescribeAvailablePatches Source #

Create a value of DescribeAvailablePatches 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:filters:DescribeAvailablePatches', describeAvailablePatches_filters - Each element in the array is a structure containing a key-value pair.

Windows Server

Supported keys for Windows Server instance patches include the following:

PATCH_SET
Sample values: OS | APPLICATION
PRODUCT
Sample values: WindowsServer2012 | Office 2010 | MicrosoftDefenderAntivirus
PRODUCT_FAMILY
Sample values: Windows | Office
MSRC_SEVERITY
Sample values: ServicePacks | Important | Moderate
CLASSIFICATION
Sample values: ServicePacks | SecurityUpdates | DefinitionUpdates
PATCH_ID
Sample values: KB123456 | KB4516046

Linux

When specifying filters for Linux patches, you must specify a key-pair for PRODUCT. For example, using the Command Line Interface (CLI), the following command fails:

aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615

However, the following command succeeds:

aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615

Supported keys for Linux instance patches include the following:

PRODUCT
Sample values: AmazonLinux2018.03 | AmazonLinux2.0
NAME
Sample values: kernel-headers | samba-python | php
SEVERITY
Sample values: Critical | Important | Medium | Low
EPOCH
Sample values: 0 | 1
VERSION
Sample values: 78.6.1 | 4.10.16
RELEASE
Sample values: 9.56.amzn1 | 1.amzn2
ARCH
Sample values: i686 | x86_64
REPOSITORY
Sample values: Core | Updates
ADVISORY_ID
Sample values: ALAS-2018-1058 | ALAS2-2021-1594
CVE_ID
Sample values: CVE-2018-3615 | CVE-2020-1472
BUGZILLA_ID
Sample values: 1463241

$sel:nextToken:DescribeAvailablePatches', describeAvailablePatches_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

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

Request Lenses

describeAvailablePatches_filters :: Lens' DescribeAvailablePatches (Maybe [PatchOrchestratorFilter]) Source #

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

Windows Server

Supported keys for Windows Server instance patches include the following:

PATCH_SET
Sample values: OS | APPLICATION
PRODUCT
Sample values: WindowsServer2012 | Office 2010 | MicrosoftDefenderAntivirus
PRODUCT_FAMILY
Sample values: Windows | Office
MSRC_SEVERITY
Sample values: ServicePacks | Important | Moderate
CLASSIFICATION
Sample values: ServicePacks | SecurityUpdates | DefinitionUpdates
PATCH_ID
Sample values: KB123456 | KB4516046

Linux

When specifying filters for Linux patches, you must specify a key-pair for PRODUCT. For example, using the Command Line Interface (CLI), the following command fails:

aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615

However, the following command succeeds:

aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615

Supported keys for Linux instance patches include the following:

PRODUCT
Sample values: AmazonLinux2018.03 | AmazonLinux2.0
NAME
Sample values: kernel-headers | samba-python | php
SEVERITY
Sample values: Critical | Important | Medium | Low
EPOCH
Sample values: 0 | 1
VERSION
Sample values: 78.6.1 | 4.10.16
RELEASE
Sample values: 9.56.amzn1 | 1.amzn2
ARCH
Sample values: i686 | x86_64
REPOSITORY
Sample values: Core | Updates
ADVISORY_ID
Sample values: ALAS-2018-1058 | ALAS2-2021-1594
CVE_ID
Sample values: CVE-2018-3615 | CVE-2020-1472
BUGZILLA_ID
Sample values: 1463241

describeAvailablePatches_nextToken :: Lens' DescribeAvailablePatches (Maybe Text) Source #

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

describeAvailablePatches_maxResults :: Lens' DescribeAvailablePatches (Maybe Natural) Source #

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

Destructuring the Response

data DescribeAvailablePatchesResponse Source #

See: newDescribeAvailablePatchesResponse smart constructor.

Constructors

DescribeAvailablePatchesResponse'
Fields patches :: Maybe [Patch] An array of patches. Each entry in the array is a patch structure. 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. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeAvailablePatchesResponse Source #

Arguments

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

Create a value of DescribeAvailablePatchesResponse 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:patches:DescribeAvailablePatchesResponse', describeAvailablePatchesResponse_patches - An array of patches. Each entry in the array is a patch structure.

$sel:nextToken:DescribeAvailablePatches', describeAvailablePatchesResponse_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:httpStatus:DescribeAvailablePatchesResponse', describeAvailablePatchesResponse_httpStatus - The response's http status code.

Response Lenses

describeAvailablePatchesResponse_patches :: Lens' DescribeAvailablePatchesResponse (Maybe [Patch]) Source #

An array of patches. Each entry in the array is a patch structure.

describeAvailablePatchesResponse_nextToken :: Lens' DescribeAvailablePatchesResponse (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.

describeAvailablePatchesResponse_httpStatus :: Lens' DescribeAvailablePatchesResponse Int Source #

The response's http status code.