amazonka-ssm-2.0: Amazon Simple Systems Manager (SSM) SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSM.UpdatePatchBaseline

Description

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter.

Synopsis

Creating a Request

data UpdatePatchBaseline Source #

See: newUpdatePatchBaseline smart constructor.

Constructors

UpdatePatchBaseline' 

Fields

  • approvalRules :: Maybe PatchRuleGroup

    A set of rules used to include patches in the baseline.

  • approvedPatches :: Maybe [Text]

    A list of explicitly approved patches for the baseline.

    For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

  • approvedPatchesComplianceLevel :: Maybe PatchComplianceLevel

    Assigns a new compliance severity level to an existing patch baseline.

  • approvedPatchesEnableNonSecurity :: Maybe Bool

    Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.

  • description :: Maybe Text

    A description of the patch baseline.

  • globalFilters :: Maybe PatchFilterGroup

    A set of global filters used to include patches in the baseline.

  • name :: Maybe Text

    The name of the patch baseline.

  • rejectedPatches :: Maybe [Text]

    A list of explicitly rejected patches for the baseline.

    For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

  • rejectedPatchesAction :: Maybe PatchAction

    The action for Patch Manager to take on patches included in the RejectedPackages list.

    • ALLOW_AS_DEPENDENCY : A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified.
    • BLOCK : Packages in the RejectedPatches list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.
  • replace :: Maybe Bool

    If True, then all fields that are required by the CreatePatchBaseline operation are also required for this API request. Optional fields that aren't specified are set to null.

  • sources :: Maybe [PatchSource]

    Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

  • baselineId :: Text

    The ID of the patch baseline to update.

Instances

Instances details
ToJSON UpdatePatchBaseline Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

ToHeaders UpdatePatchBaseline Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

ToPath UpdatePatchBaseline Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

ToQuery UpdatePatchBaseline Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

AWSRequest UpdatePatchBaseline Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

Associated Types

type AWSResponse UpdatePatchBaseline #

Generic UpdatePatchBaseline Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

Associated Types

type Rep UpdatePatchBaseline :: Type -> Type #

Show UpdatePatchBaseline Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

NFData UpdatePatchBaseline Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

Methods

rnf :: UpdatePatchBaseline -> () #

Eq UpdatePatchBaseline Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

Hashable UpdatePatchBaseline Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

type AWSResponse UpdatePatchBaseline Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

type Rep UpdatePatchBaseline Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

type Rep UpdatePatchBaseline = D1 ('MetaData "UpdatePatchBaseline" "Amazonka.SSM.UpdatePatchBaseline" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "UpdatePatchBaseline'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "approvalRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PatchRuleGroup)) :*: (S1 ('MetaSel ('Just "approvedPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "approvedPatchesComplianceLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PatchComplianceLevel)))) :*: (S1 ('MetaSel ('Just "approvedPatchesEnableNonSecurity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "globalFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PatchFilterGroup))))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "rejectedPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "rejectedPatchesAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PatchAction)))) :*: (S1 ('MetaSel ('Just "replace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "sources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchSource])) :*: S1 ('MetaSel ('Just "baselineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdatePatchBaseline Source #

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

UpdatePatchBaseline, updatePatchBaseline_approvalRules - A set of rules used to include patches in the baseline.

UpdatePatchBaseline, updatePatchBaseline_approvedPatches - A list of explicitly approved patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

UpdatePatchBaseline, updatePatchBaseline_approvedPatchesComplianceLevel - Assigns a new compliance severity level to an existing patch baseline.

UpdatePatchBaseline, updatePatchBaseline_approvedPatchesEnableNonSecurity - Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.

UpdatePatchBaseline, updatePatchBaseline_description - A description of the patch baseline.

UpdatePatchBaseline, updatePatchBaseline_globalFilters - A set of global filters used to include patches in the baseline.

UpdatePatchBaseline, updatePatchBaseline_name - The name of the patch baseline.

UpdatePatchBaseline, updatePatchBaseline_rejectedPatches - A list of explicitly rejected patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

UpdatePatchBaseline, updatePatchBaseline_rejectedPatchesAction - The action for Patch Manager to take on patches included in the RejectedPackages list.

  • ALLOW_AS_DEPENDENCY : A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified.
  • BLOCK : Packages in the RejectedPatches list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.

$sel:replace:UpdatePatchBaseline', updatePatchBaseline_replace - If True, then all fields that are required by the CreatePatchBaseline operation are also required for this API request. Optional fields that aren't specified are set to null.

UpdatePatchBaseline, updatePatchBaseline_sources - Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

UpdatePatchBaseline, updatePatchBaseline_baselineId - The ID of the patch baseline to update.

Request Lenses

updatePatchBaseline_approvalRules :: Lens' UpdatePatchBaseline (Maybe PatchRuleGroup) Source #

A set of rules used to include patches in the baseline.

updatePatchBaseline_approvedPatches :: Lens' UpdatePatchBaseline (Maybe [Text]) Source #

A list of explicitly approved patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

updatePatchBaseline_approvedPatchesComplianceLevel :: Lens' UpdatePatchBaseline (Maybe PatchComplianceLevel) Source #

Assigns a new compliance severity level to an existing patch baseline.

updatePatchBaseline_approvedPatchesEnableNonSecurity :: Lens' UpdatePatchBaseline (Maybe Bool) Source #

Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.

updatePatchBaseline_globalFilters :: Lens' UpdatePatchBaseline (Maybe PatchFilterGroup) Source #

A set of global filters used to include patches in the baseline.

updatePatchBaseline_rejectedPatches :: Lens' UpdatePatchBaseline (Maybe [Text]) Source #

A list of explicitly rejected patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

updatePatchBaseline_rejectedPatchesAction :: Lens' UpdatePatchBaseline (Maybe PatchAction) Source #

The action for Patch Manager to take on patches included in the RejectedPackages list.

  • ALLOW_AS_DEPENDENCY : A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified.
  • BLOCK : Packages in the RejectedPatches list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.

updatePatchBaseline_replace :: Lens' UpdatePatchBaseline (Maybe Bool) Source #

If True, then all fields that are required by the CreatePatchBaseline operation are also required for this API request. Optional fields that aren't specified are set to null.

updatePatchBaseline_sources :: Lens' UpdatePatchBaseline (Maybe [PatchSource]) Source #

Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

updatePatchBaseline_baselineId :: Lens' UpdatePatchBaseline Text Source #

The ID of the patch baseline to update.

Destructuring the Response

data UpdatePatchBaselineResponse Source #

See: newUpdatePatchBaselineResponse smart constructor.

Constructors

UpdatePatchBaselineResponse' 

Fields

Instances

Instances details
Generic UpdatePatchBaselineResponse Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

Associated Types

type Rep UpdatePatchBaselineResponse :: Type -> Type #

Show UpdatePatchBaselineResponse Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

NFData UpdatePatchBaselineResponse Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

Eq UpdatePatchBaselineResponse Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

type Rep UpdatePatchBaselineResponse Source # 
Instance details

Defined in Amazonka.SSM.UpdatePatchBaseline

type Rep UpdatePatchBaselineResponse = D1 ('MetaData "UpdatePatchBaselineResponse" "Amazonka.SSM.UpdatePatchBaseline" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "UpdatePatchBaselineResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "approvalRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PatchRuleGroup)) :*: (S1 ('MetaSel ('Just "approvedPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "approvedPatchesComplianceLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PatchComplianceLevel)))) :*: ((S1 ('MetaSel ('Just "approvedPatchesEnableNonSecurity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "baselineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "globalFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PatchFilterGroup)) :*: S1 ('MetaSel ('Just "modifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "operatingSystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OperatingSystem)))) :*: ((S1 ('MetaSel ('Just "rejectedPatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "rejectedPatchesAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PatchAction))) :*: (S1 ('MetaSel ('Just "sources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchSource])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newUpdatePatchBaselineResponse Source #

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

UpdatePatchBaseline, updatePatchBaselineResponse_approvalRules - A set of rules used to include patches in the baseline.

UpdatePatchBaseline, updatePatchBaselineResponse_approvedPatches - A list of explicitly approved patches for the baseline.

UpdatePatchBaseline, updatePatchBaselineResponse_approvedPatchesComplianceLevel - The compliance severity level assigned to the patch baseline after the update completed.

UpdatePatchBaseline, updatePatchBaselineResponse_approvedPatchesEnableNonSecurity - Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.

UpdatePatchBaseline, updatePatchBaselineResponse_baselineId - The ID of the deleted patch baseline.

UpdatePatchBaselineResponse, updatePatchBaselineResponse_createdDate - The date when the patch baseline was created.

UpdatePatchBaseline, updatePatchBaselineResponse_description - A description of the patch baseline.

UpdatePatchBaseline, updatePatchBaselineResponse_globalFilters - A set of global filters used to exclude patches from the baseline.

$sel:modifiedDate:UpdatePatchBaselineResponse', updatePatchBaselineResponse_modifiedDate - The date when the patch baseline was last modified.

UpdatePatchBaseline, updatePatchBaselineResponse_name - The name of the patch baseline.

UpdatePatchBaselineResponse, updatePatchBaselineResponse_operatingSystem - The operating system rule used by the updated patch baseline.

UpdatePatchBaseline, updatePatchBaselineResponse_rejectedPatches - A list of explicitly rejected patches for the baseline.

UpdatePatchBaseline, updatePatchBaselineResponse_rejectedPatchesAction - The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.

UpdatePatchBaseline, updatePatchBaselineResponse_sources - Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

$sel:httpStatus:UpdatePatchBaselineResponse', updatePatchBaselineResponse_httpStatus - The response's http status code.

Response Lenses

updatePatchBaselineResponse_approvalRules :: Lens' UpdatePatchBaselineResponse (Maybe PatchRuleGroup) Source #

A set of rules used to include patches in the baseline.

updatePatchBaselineResponse_approvedPatches :: Lens' UpdatePatchBaselineResponse (Maybe [Text]) Source #

A list of explicitly approved patches for the baseline.

updatePatchBaselineResponse_approvedPatchesComplianceLevel :: Lens' UpdatePatchBaselineResponse (Maybe PatchComplianceLevel) Source #

The compliance severity level assigned to the patch baseline after the update completed.

updatePatchBaselineResponse_approvedPatchesEnableNonSecurity :: Lens' UpdatePatchBaselineResponse (Maybe Bool) Source #

Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.

updatePatchBaselineResponse_globalFilters :: Lens' UpdatePatchBaselineResponse (Maybe PatchFilterGroup) Source #

A set of global filters used to exclude patches from the baseline.

updatePatchBaselineResponse_modifiedDate :: Lens' UpdatePatchBaselineResponse (Maybe UTCTime) Source #

The date when the patch baseline was last modified.

updatePatchBaselineResponse_operatingSystem :: Lens' UpdatePatchBaselineResponse (Maybe OperatingSystem) Source #

The operating system rule used by the updated patch baseline.

updatePatchBaselineResponse_rejectedPatches :: Lens' UpdatePatchBaselineResponse (Maybe [Text]) Source #

A list of explicitly rejected patches for the baseline.

updatePatchBaselineResponse_rejectedPatchesAction :: Lens' UpdatePatchBaselineResponse (Maybe PatchAction) Source #

The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.

updatePatchBaselineResponse_sources :: Lens' UpdatePatchBaselineResponse (Maybe [PatchSource]) Source #

Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.