Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.SSM.PutComplianceItems

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Registers a compliance type and other compliance details on a designated resource. This action 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: A 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'

Creating a Request

putComplianceItems #

Arguments

:: Text	`pciResourceId`
-> Text	`pciResourceType`
-> Text	`pciComplianceType`
-> ComplianceExecutionSummary	`pciExecutionSummary`
-> PutComplianceItems

Creates a value of PutComplianceItems with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pciItemContentHash - 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.
pciResourceId - Specify an ID for this resource. For a managed instance, this is the instance ID.
pciResourceType - Specify the type of resource. ManagedInstance is currently the only supported resource type.
pciComplianceType - Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string .
pciExecutionSummary - 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'.
pciItems - Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, etc.

data PutComplianceItems #

See: putComplianceItems smart constructor.

Instances

Eq PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods (==) :: PutComplianceItems -> PutComplianceItems -> Bool # (/=) :: PutComplianceItems -> PutComplianceItems -> Bool #
Data PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutComplianceItems -> c PutComplianceItems # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutComplianceItems # toConstr :: PutComplianceItems -> Constr # dataTypeOf :: PutComplianceItems -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PutComplianceItems) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutComplianceItems) # gmapT :: (forall b. Data b => b -> b) -> PutComplianceItems -> PutComplianceItems # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutComplianceItems -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutComplianceItems -> r # gmapQ :: (forall d. Data d => d -> u) -> PutComplianceItems -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PutComplianceItems -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutComplianceItems -> m PutComplianceItems # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutComplianceItems -> m PutComplianceItems # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutComplianceItems -> m PutComplianceItems #
Read PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods readsPrec :: Int -> ReadS PutComplianceItems # readList :: ReadS [PutComplianceItems] # readPrec :: ReadPrec PutComplianceItems # readListPrec :: ReadPrec [PutComplianceItems] #
Show PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods showsPrec :: Int -> PutComplianceItems -> ShowS # show :: PutComplianceItems -> String # showList :: [PutComplianceItems] -> ShowS #
Generic PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Associated Types type Rep PutComplianceItems :: Type -> Type # Methods from :: PutComplianceItems -> Rep PutComplianceItems x # to :: Rep PutComplianceItems x -> PutComplianceItems #
Hashable PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods hashWithSalt :: Int -> PutComplianceItems -> Int # hash :: PutComplianceItems -> Int #
ToJSON PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods toJSON :: PutComplianceItems -> Value # toEncoding :: PutComplianceItems -> Encoding # toJSONList :: [PutComplianceItems] -> Value # toEncodingList :: [PutComplianceItems] -> Encoding #
AWSRequest PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Associated Types type Rs PutComplianceItems :: Type # Methods request :: PutComplianceItems -> Request PutComplianceItems # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy PutComplianceItems -> ClientResponse -> m (Response PutComplianceItems) #
ToHeaders PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods toHeaders :: PutComplianceItems -> [Header] #
ToPath PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods toPath :: PutComplianceItems -> ByteString #
ToQuery PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods toQuery :: PutComplianceItems -> QueryString #
NFData PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods rnf :: PutComplianceItems -> () #
type Rep PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems type Rep PutComplianceItems = D1 (MetaData "PutComplianceItems" "Network.AWS.SSM.PutComplianceItems" "amazonka-ssm-1.6.1-5VYTKHfOwGYABArhWaVnbJ" False) (C1 (MetaCons "PutComplianceItems'" PrefixI True) ((S1 (MetaSel (Just "_pciItemContentHash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_pciResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_pciResourceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :: (S1 (MetaSel (Just "_pciComplianceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_pciExecutionSummary") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ComplianceExecutionSummary) :*: S1 (MetaSel (Just "_pciItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [ComplianceItemEntry])))))
type Rs PutComplianceItems #
Instance details Defined in Network.AWS.SSM.PutComplianceItems type Rs PutComplianceItems = PutComplianceItemsResponse

Request Lenses

pciItemContentHash :: Lens' PutComplianceItems (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.

pciResourceId :: Lens' PutComplianceItems Text #

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

pciResourceType :: Lens' PutComplianceItems Text #

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

pciComplianceType :: Lens' PutComplianceItems Text #

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

pciExecutionSummary :: Lens' PutComplianceItems 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'.

pciItems :: Lens' PutComplianceItems [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, etc.

Destructuring the Response

putComplianceItemsResponse #

Arguments

:: Int	`pcirsResponseStatus`
-> PutComplianceItemsResponse

Creates a value of PutComplianceItemsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pcirsResponseStatus - -- | The response status code.

data PutComplianceItemsResponse #

See: putComplianceItemsResponse smart constructor.

Instances

Eq PutComplianceItemsResponse #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods (==) :: PutComplianceItemsResponse -> PutComplianceItemsResponse -> Bool # (/=) :: PutComplianceItemsResponse -> PutComplianceItemsResponse -> Bool #
Data PutComplianceItemsResponse #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutComplianceItemsResponse -> c PutComplianceItemsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutComplianceItemsResponse # toConstr :: PutComplianceItemsResponse -> Constr # dataTypeOf :: PutComplianceItemsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PutComplianceItemsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutComplianceItemsResponse) # gmapT :: (forall b. Data b => b -> b) -> PutComplianceItemsResponse -> PutComplianceItemsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutComplianceItemsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutComplianceItemsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> PutComplianceItemsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PutComplianceItemsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutComplianceItemsResponse -> m PutComplianceItemsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutComplianceItemsResponse -> m PutComplianceItemsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutComplianceItemsResponse -> m PutComplianceItemsResponse #
Read PutComplianceItemsResponse #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods readsPrec :: Int -> ReadS PutComplianceItemsResponse # readList :: ReadS [PutComplianceItemsResponse] # readPrec :: ReadPrec PutComplianceItemsResponse # readListPrec :: ReadPrec [PutComplianceItemsResponse] #
Show PutComplianceItemsResponse #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods showsPrec :: Int -> PutComplianceItemsResponse -> ShowS # show :: PutComplianceItemsResponse -> String # showList :: [PutComplianceItemsResponse] -> ShowS #
Generic PutComplianceItemsResponse #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Associated Types type Rep PutComplianceItemsResponse :: Type -> Type # Methods from :: PutComplianceItemsResponse -> Rep PutComplianceItemsResponse x # to :: Rep PutComplianceItemsResponse x -> PutComplianceItemsResponse #
NFData PutComplianceItemsResponse #
Instance details Defined in Network.AWS.SSM.PutComplianceItems Methods rnf :: PutComplianceItemsResponse -> () #
type Rep PutComplianceItemsResponse #
Instance details Defined in Network.AWS.SSM.PutComplianceItems type Rep PutComplianceItemsResponse = D1 (MetaData "PutComplianceItemsResponse" "Network.AWS.SSM.PutComplianceItems" "amazonka-ssm-1.6.1-5VYTKHfOwGYABArhWaVnbJ" True) (C1 (MetaCons "PutComplianceItemsResponse'" PrefixI True) (S1 (MetaSel (Just "_pcirsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

pcirsResponseStatus :: Lens' PutComplianceItemsResponse Int #

- | The response status code.