Network.AWS.SSM.ModifyDocumentPermission

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.

Creating a Request

modifyDocumentPermission

Arguments

:: Text

mdpName

-> DocumentPermissionType

mdpPermissionType

-> 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

Methods

(==) :: ModifyDocumentPermission -> ModifyDocumentPermission -> Bool

(/=) :: ModifyDocumentPermission -> ModifyDocumentPermission -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS ModifyDocumentPermission

readList :: ReadS [ModifyDocumentPermission]

readPrec :: ReadPrec ModifyDocumentPermission

readListPrec :: ReadPrec [ModifyDocumentPermission]

Show ModifyDocumentPermission

Methods

showsPrec :: Int -> ModifyDocumentPermission -> ShowS

show :: ModifyDocumentPermission -> String

showList :: [ModifyDocumentPermission] -> ShowS

Generic ModifyDocumentPermission

Associated Types

type Rep ModifyDocumentPermission :: * -> *

Methods

from :: ModifyDocumentPermission -> Rep ModifyDocumentPermission x

to :: Rep ModifyDocumentPermission x -> ModifyDocumentPermission

Hashable ModifyDocumentPermission

Methods

hashWithSalt :: Int -> ModifyDocumentPermission -> Int

hash :: ModifyDocumentPermission -> Int

ToJSON ModifyDocumentPermission

Methods

toJSON :: ModifyDocumentPermission -> Value

toEncoding :: ModifyDocumentPermission -> Encoding

toJSONList :: [ModifyDocumentPermission] -> Value

toEncodingList :: [ModifyDocumentPermission] -> Encoding

NFData ModifyDocumentPermission

Methods

rnf :: ModifyDocumentPermission -> ()

AWSRequest ModifyDocumentPermission

Associated Types

type Rs ModifyDocumentPermission :: *

Methods

request :: ModifyDocumentPermission -> Request ModifyDocumentPermission

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ModifyDocumentPermission -> ClientResponse -> m (Response ModifyDocumentPermission)

ToHeaders ModifyDocumentPermission

Methods

toHeaders :: ModifyDocumentPermission -> [Header]

ToPath ModifyDocumentPermission

Methods

toPath :: ModifyDocumentPermission -> ByteString

ToQuery ModifyDocumentPermission

Methods

toQuery :: ModifyDocumentPermission -> QueryString

type Rep ModifyDocumentPermission

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

type Rs ModifyDocumentPermission

type Rs ModifyDocumentPermission = ModifyDocumentPermissionResponse

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

Arguments

:: Int

mdprsResponseStatus

-> 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:

• mdprsResponseStatus - -- | The response status code.

data ModifyDocumentPermissionResponse

See: modifyDocumentPermissionResponse smart constructor.

Instances

Eq ModifyDocumentPermissionResponse

Methods

(==) :: ModifyDocumentPermissionResponse -> ModifyDocumentPermissionResponse -> Bool

(/=) :: ModifyDocumentPermissionResponse -> ModifyDocumentPermissionResponse -> Bool

Data ModifyDocumentPermissionResponse

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

Methods

readsPrec :: Int -> ReadS ModifyDocumentPermissionResponse

readList :: ReadS [ModifyDocumentPermissionResponse]

readPrec :: ReadPrec ModifyDocumentPermissionResponse

readListPrec :: ReadPrec [ModifyDocumentPermissionResponse]

Show ModifyDocumentPermissionResponse

Methods

showsPrec :: Int -> ModifyDocumentPermissionResponse -> ShowS

show :: ModifyDocumentPermissionResponse -> String

showList :: [ModifyDocumentPermissionResponse] -> ShowS

Generic ModifyDocumentPermissionResponse

Associated Types

type Rep ModifyDocumentPermissionResponse :: * -> *

Methods

from :: ModifyDocumentPermissionResponse -> Rep ModifyDocumentPermissionResponse x

to :: Rep ModifyDocumentPermissionResponse x -> ModifyDocumentPermissionResponse

NFData ModifyDocumentPermissionResponse

Methods

rnf :: ModifyDocumentPermissionResponse -> ()

type Rep ModifyDocumentPermissionResponse

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

Response Lenses

mdprsResponseStatus :: Lens' ModifyDocumentPermissionResponse Int

• - | The response status code.