libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.PutComplianceItems

Description

Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

ComplianceType can be one of the following:

  • ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
  • ExecutionType: Specify patch, association, or Custom:string.
  • ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.
  • Id: The patch, association, or custom compliance ID.
  • Title: A title.
  • Status: The status of the compliance item. For example, approved for patches, or Failed for associations.
  • Severity: A patch severity. For example, critical.
  • DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.
  • DocumentVersion: An SSM document version number. For example, 4.
  • Classification: A patch classification. For example, security updates.
  • PatchBaselineId: A patch baseline ID.
  • PatchSeverity: A patch severity. For example, Critical.
  • PatchState: A patch state. For example, InstancesWithFailedPatches.
  • PatchGroup: The name of a patch group.
  • InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
Synopsis

Creating a Request

data PutComplianceItems Source #

See: newPutComplianceItems smart constructor.

Constructors

PutComplianceItems' 

Fields

  • uploadType :: Maybe ComplianceUploadType

    The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.

    In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode.

    This attribute is only valid for association compliance.

  • itemContentHash :: Maybe Text

    MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.

  • resourceId :: Text

    Specify an ID for this resource. For a managed instance, this is the instance ID.

  • resourceType :: Text

    Specify the type of resource. ManagedInstance is currently the only supported resource type.

  • complianceType :: Text

    Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.

  • executionSummary :: ComplianceExecutionSummary

    A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

  • items :: [ComplianceItemEntry]

    Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, and so on.

Instances

Instances details
Eq PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

Read PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

Show PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

Generic PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

Associated Types

type Rep PutComplianceItems :: Type -> Type #

NFData PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

Methods

rnf :: PutComplianceItems -> () #

Hashable PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

ToJSON PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

AWSRequest PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

Associated Types

type AWSResponse PutComplianceItems #

ToHeaders PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

ToPath PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

ToQuery PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

type Rep PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

type AWSResponse PutComplianceItems Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

newPutComplianceItems Source #

Create a value of PutComplianceItems 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:uploadType:PutComplianceItems', putComplianceItems_uploadType - The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.

In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode.

This attribute is only valid for association compliance.

$sel:itemContentHash:PutComplianceItems', putComplianceItems_itemContentHash - MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.

$sel:resourceId:PutComplianceItems', putComplianceItems_resourceId - Specify an ID for this resource. For a managed instance, this is the instance ID.

$sel:resourceType:PutComplianceItems', putComplianceItems_resourceType - Specify the type of resource. ManagedInstance is currently the only supported resource type.

$sel:complianceType:PutComplianceItems', putComplianceItems_complianceType - Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.

$sel:executionSummary:PutComplianceItems', putComplianceItems_executionSummary - A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

$sel:items:PutComplianceItems', putComplianceItems_items - Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, and so on.

Request Lenses

putComplianceItems_uploadType :: Lens' PutComplianceItems (Maybe ComplianceUploadType) Source #

The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.

In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode.

This attribute is only valid for association compliance.

putComplianceItems_itemContentHash :: Lens' PutComplianceItems (Maybe Text) Source #

MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.

putComplianceItems_resourceId :: Lens' PutComplianceItems Text Source #

Specify an ID for this resource. For a managed instance, this is the instance ID.

putComplianceItems_resourceType :: Lens' PutComplianceItems Text Source #

Specify the type of resource. ManagedInstance is currently the only supported resource type.

putComplianceItems_complianceType :: Lens' PutComplianceItems Text Source #

Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.

putComplianceItems_executionSummary :: Lens' PutComplianceItems ComplianceExecutionSummary Source #

A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

putComplianceItems_items :: Lens' PutComplianceItems [ComplianceItemEntry] Source #

Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, and so on.

Destructuring the Response

data PutComplianceItemsResponse Source #

See: newPutComplianceItemsResponse smart constructor.

Constructors

PutComplianceItemsResponse' 

Fields

Instances

Instances details
Eq PutComplianceItemsResponse Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

Read PutComplianceItemsResponse Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

Show PutComplianceItemsResponse Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

Generic PutComplianceItemsResponse Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

Associated Types

type Rep PutComplianceItemsResponse :: Type -> Type #

NFData PutComplianceItemsResponse Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

type Rep PutComplianceItemsResponse Source # 
Instance details

Defined in Amazonka.SSM.PutComplianceItems

type Rep PutComplianceItemsResponse = D1 ('MetaData "PutComplianceItemsResponse" "Amazonka.SSM.PutComplianceItems" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "PutComplianceItemsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutComplianceItemsResponse Source #

Create a value of PutComplianceItemsResponse 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:httpStatus:PutComplianceItemsResponse', putComplianceItemsResponse_httpStatus - The response's http status code.

Response Lenses