amazonka-ssm-1.6.0: Amazon Simple Systems Manager (SSM) SDK.

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

Network.AWS.SSM.ModifyDocumentPermission

Contents

Description

Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

Synopsis

Creating a Request

modifyDocumentPermission #

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

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

  • mdpAccountIdsToAdd - The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All .
  • mdpAccountIdsToRemove - The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All . This action has a higher priority than AccountIdsToAdd . If you specify an account ID to add and the same ID to remove, the system removes access to the document.
  • mdpName - The name of the document that you want to share.
  • mdpPermissionType - The permission type for the document. The permission type can be Share .

data ModifyDocumentPermission #

See: modifyDocumentPermission smart constructor.

Instances
Eq ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

Data ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyDocumentPermission -> c ModifyDocumentPermission #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyDocumentPermission #

toConstr :: ModifyDocumentPermission -> Constr #

dataTypeOf :: ModifyDocumentPermission -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModifyDocumentPermission) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyDocumentPermission) #

gmapT :: (forall b. Data b => b -> b) -> ModifyDocumentPermission -> ModifyDocumentPermission #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyDocumentPermission -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyDocumentPermission -> r #

gmapQ :: (forall d. Data d => d -> u) -> ModifyDocumentPermission -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyDocumentPermission -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyDocumentPermission -> m ModifyDocumentPermission #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyDocumentPermission -> m ModifyDocumentPermission #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyDocumentPermission -> m ModifyDocumentPermission #

Read ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

Show ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

Generic ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

Associated Types

type Rep ModifyDocumentPermission :: * -> * #

Hashable ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

ToJSON ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

AWSRequest ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

Associated Types

type Rs ModifyDocumentPermission :: * #

ToHeaders ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

ToPath ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

ToQuery ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

NFData ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

type Rep ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

type Rep ModifyDocumentPermission = D1 (MetaData "ModifyDocumentPermission" "Network.AWS.SSM.ModifyDocumentPermission" "amazonka-ssm-1.6.0-6ymLhp3p3ub3EVj8bPf5ZJ" False) (C1 (MetaCons "ModifyDocumentPermission'" PrefixI True) ((S1 (MetaSel (Just "_mdpAccountIdsToAdd") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_mdpAccountIdsToRemove") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_mdpName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_mdpPermissionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DocumentPermissionType))))
type Rs ModifyDocumentPermission # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

Request Lenses

mdpAccountIdsToAdd :: Lens' ModifyDocumentPermission [Text] #

The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All .

mdpAccountIdsToRemove :: Lens' ModifyDocumentPermission [Text] #

The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All . This action has a higher priority than AccountIdsToAdd . If you specify an account ID to add and the same ID to remove, the system removes access to the document.

mdpName :: Lens' ModifyDocumentPermission Text #

The name of the document that you want to share.

mdpPermissionType :: Lens' ModifyDocumentPermission DocumentPermissionType #

The permission type for the document. The permission type can be Share .

Destructuring the Response

modifyDocumentPermissionResponse #

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

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

data ModifyDocumentPermissionResponse #

See: modifyDocumentPermissionResponse smart constructor.

Instances
Eq ModifyDocumentPermissionResponse # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

Data ModifyDocumentPermissionResponse # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyDocumentPermissionResponse -> c ModifyDocumentPermissionResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyDocumentPermissionResponse #

toConstr :: ModifyDocumentPermissionResponse -> Constr #

dataTypeOf :: ModifyDocumentPermissionResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModifyDocumentPermissionResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyDocumentPermissionResponse) #

gmapT :: (forall b. Data b => b -> b) -> ModifyDocumentPermissionResponse -> ModifyDocumentPermissionResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyDocumentPermissionResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyDocumentPermissionResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ModifyDocumentPermissionResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyDocumentPermissionResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyDocumentPermissionResponse -> m ModifyDocumentPermissionResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyDocumentPermissionResponse -> m ModifyDocumentPermissionResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyDocumentPermissionResponse -> m ModifyDocumentPermissionResponse #

Read ModifyDocumentPermissionResponse # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

Show ModifyDocumentPermissionResponse # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

Generic ModifyDocumentPermissionResponse # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

Associated Types

type Rep ModifyDocumentPermissionResponse :: * -> * #

NFData ModifyDocumentPermissionResponse # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

type Rep ModifyDocumentPermissionResponse # 
Instance details

Defined in Network.AWS.SSM.ModifyDocumentPermission

type Rep ModifyDocumentPermissionResponse = D1 (MetaData "ModifyDocumentPermissionResponse" "Network.AWS.SSM.ModifyDocumentPermission" "amazonka-ssm-1.6.0-6ymLhp3p3ub3EVj8bPf5ZJ" True) (C1 (MetaCons "ModifyDocumentPermissionResponse'" PrefixI True) (S1 (MetaSel (Just "_mdprsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses