Interface DescribeAvailablePatchesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeAvailablePatchesRequest.Builder,DescribeAvailablePatchesRequest>, SdkBuilder<DescribeAvailablePatchesRequest.Builder,DescribeAvailablePatchesRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

DescribeAvailablePatchesRequest

public static interface DescribeAvailablePatchesRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<DescribeAvailablePatchesRequest.Builder,DescribeAvailablePatchesRequest>

Method Summary

Modifier and Type	Method	Description
DescribeAvailablePatchesRequest.Builder	filters(Collection<PatchOrchestratorFilter> filters)	Each element in the array is a structure containing a key-value pair.
DescribeAvailablePatchesRequest.Builder	filters(Consumer<PatchOrchestratorFilter.Builder>... filters)	Each element in the array is a structure containing a key-value pair.
DescribeAvailablePatchesRequest.Builder	filters(PatchOrchestratorFilter... filters)	Each element in the array is a structure containing a key-value pair.
DescribeAvailablePatchesRequest.Builder	maxResults(Integer maxResults)	The maximum number of patches to return (per page).
DescribeAvailablePatchesRequest.Builder	nextToken(String nextToken)	The token for the next set of items to return.
DescribeAvailablePatchesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DescribeAvailablePatchesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Method Details

filters

DescribeAvailablePatchesRequest.Builder filters(Collection<PatchOrchestratorFilter> filters)

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

Windows Server

Supported keys for Windows Server managed node 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 managed node 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

Parameters:

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

Windows Server

Supported keys for Windows Server managed node 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 managed node 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

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeAvailablePatchesRequest.Builder filters(PatchOrchestratorFilter... filters)

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

Windows Server

Supported keys for Windows Server managed node 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 managed node 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

Parameters:

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

Windows Server

Supported keys for Windows Server managed node 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 managed node 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

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeAvailablePatchesRequest.Builder filters(Consumer<PatchOrchestratorFilter.Builder>... filters)

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

Windows Server

Supported keys for Windows Server managed node 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 managed node 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

This is a convenience method that creates an instance of the PatchOrchestratorFilter.Builder avoiding the need to create one manually via PatchOrchestratorFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<PatchOrchestratorFilter>).

Parameters:

filters - a consumer that will call methods on PatchOrchestratorFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• filters(java.util.Collection<PatchOrchestratorFilter>)

maxResults

DescribeAvailablePatchesRequest.Builder maxResults(Integer maxResults)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

DescribeAvailablePatchesRequest.Builder nextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

DescribeAvailablePatchesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

DescribeAvailablePatchesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.