Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.ModifyDocumentPermission

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services 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

data ModifyDocumentPermission Source #

See: newModifyDocumentPermission smart constructor.

Constructors

ModifyDocumentPermission'

Fields

accountIdsToAdd :: Maybe [Text]
The Amazon Web Services user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
accountIdsToRemove :: Maybe [Text]
The Amazon Web Services user accounts that should no longer have access to the document. The Amazon Web Services 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.
sharedDocumentVersion :: Maybe Text
(Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.
name :: Text
The name of the document that you want to share.
permissionType :: DocumentPermissionType
The permission type for the document. The permission type can be Share.

Instances

Instances details

ToJSON ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods toJSON :: ModifyDocumentPermission -> Value # toEncoding :: ModifyDocumentPermission -> Encoding # toJSONList :: [ModifyDocumentPermission] -> Value # toEncodingList :: [ModifyDocumentPermission] -> Encoding #
ToHeaders ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods toHeaders :: ModifyDocumentPermission -> [Header] #
ToPath ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods toPath :: ModifyDocumentPermission -> ByteString #
ToQuery ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods toQuery :: ModifyDocumentPermission -> QueryString #
AWSRequest ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Associated Types type AWSResponse ModifyDocumentPermission # Methods request :: (Service -> Service) -> ModifyDocumentPermission -> Request ModifyDocumentPermission # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyDocumentPermission -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyDocumentPermission))) #
Generic ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Associated Types type Rep ModifyDocumentPermission :: Type -> Type # Methods from :: ModifyDocumentPermission -> Rep ModifyDocumentPermission x # to :: Rep ModifyDocumentPermission x -> ModifyDocumentPermission #
Read ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods readsPrec :: Int -> ReadS ModifyDocumentPermission # readList :: ReadS [ModifyDocumentPermission] # readPrec :: ReadPrec ModifyDocumentPermission # readListPrec :: ReadPrec [ModifyDocumentPermission] #
Show ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods showsPrec :: Int -> ModifyDocumentPermission -> ShowS # show :: ModifyDocumentPermission -> String # showList :: [ModifyDocumentPermission] -> ShowS #
NFData ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods rnf :: ModifyDocumentPermission -> () #
Eq ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods (==) :: ModifyDocumentPermission -> ModifyDocumentPermission -> Bool # (/=) :: ModifyDocumentPermission -> ModifyDocumentPermission -> Bool #
Hashable ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods hashWithSalt :: Int -> ModifyDocumentPermission -> Int # hash :: ModifyDocumentPermission -> Int #
type AWSResponse ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission type AWSResponse ModifyDocumentPermission = ModifyDocumentPermissionResponse
type Rep ModifyDocumentPermission Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission type Rep ModifyDocumentPermission = D1 ('MetaData "ModifyDocumentPermission" "Amazonka.SSM.ModifyDocumentPermission" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ModifyDocumentPermission'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountIdsToAdd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "accountIdsToRemove") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "sharedDocumentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "permissionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentPermissionType)))))

newModifyDocumentPermission Source #

Arguments

:: Text	`ModifyDocumentPermission`
-> DocumentPermissionType	`$sel:permissionType:ModifyDocumentPermission'`
-> ModifyDocumentPermission

Create a value of ModifyDocumentPermission 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:accountIdsToAdd:ModifyDocumentPermission', modifyDocumentPermission_accountIdsToAdd - The Amazon Web Services user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

$sel:accountIdsToRemove:ModifyDocumentPermission', modifyDocumentPermission_accountIdsToRemove - The Amazon Web Services user accounts that should no longer have access to the document. The Amazon Web Services 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.

ModifyDocumentPermission, modifyDocumentPermission_sharedDocumentVersion - (Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

ModifyDocumentPermission, modifyDocumentPermission_name - The name of the document that you want to share.

$sel:permissionType:ModifyDocumentPermission', modifyDocumentPermission_permissionType - The permission type for the document. The permission type can be Share.

Request Lenses

modifyDocumentPermission_accountIdsToAdd :: Lens' ModifyDocumentPermission (Maybe [Text]) Source #

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

modifyDocumentPermission_accountIdsToRemove :: Lens' ModifyDocumentPermission (Maybe [Text]) Source #

The Amazon Web Services user accounts that should no longer have access to the document. The Amazon Web Services 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.

modifyDocumentPermission_sharedDocumentVersion :: Lens' ModifyDocumentPermission (Maybe Text) Source #

(Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

modifyDocumentPermission_name :: Lens' ModifyDocumentPermission Text Source #

The name of the document that you want to share.

modifyDocumentPermission_permissionType :: Lens' ModifyDocumentPermission DocumentPermissionType Source #

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

Destructuring the Response

data ModifyDocumentPermissionResponse Source #

See: newModifyDocumentPermissionResponse smart constructor.

Constructors

ModifyDocumentPermissionResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ModifyDocumentPermissionResponse Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Associated Types type Rep ModifyDocumentPermissionResponse :: Type -> Type # Methods from :: ModifyDocumentPermissionResponse -> Rep ModifyDocumentPermissionResponse x # to :: Rep ModifyDocumentPermissionResponse x -> ModifyDocumentPermissionResponse #
Read ModifyDocumentPermissionResponse Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods readsPrec :: Int -> ReadS ModifyDocumentPermissionResponse # readList :: ReadS [ModifyDocumentPermissionResponse] # readPrec :: ReadPrec ModifyDocumentPermissionResponse # readListPrec :: ReadPrec [ModifyDocumentPermissionResponse] #
Show ModifyDocumentPermissionResponse Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods showsPrec :: Int -> ModifyDocumentPermissionResponse -> ShowS # show :: ModifyDocumentPermissionResponse -> String # showList :: [ModifyDocumentPermissionResponse] -> ShowS #
NFData ModifyDocumentPermissionResponse Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods rnf :: ModifyDocumentPermissionResponse -> () #
Eq ModifyDocumentPermissionResponse Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission Methods (==) :: ModifyDocumentPermissionResponse -> ModifyDocumentPermissionResponse -> Bool # (/=) :: ModifyDocumentPermissionResponse -> ModifyDocumentPermissionResponse -> Bool #
type Rep ModifyDocumentPermissionResponse Source #
Instance details Defined in Amazonka.SSM.ModifyDocumentPermission type Rep ModifyDocumentPermissionResponse = D1 ('MetaData "ModifyDocumentPermissionResponse" "Amazonka.SSM.ModifyDocumentPermission" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ModifyDocumentPermissionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyDocumentPermissionResponse Source #

Arguments

:: Int	`$sel:httpStatus:ModifyDocumentPermissionResponse'`
-> ModifyDocumentPermissionResponse

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

Response Lenses

modifyDocumentPermissionResponse_httpStatus :: Lens' ModifyDocumentPermissionResponse Int Source #

The response's http status code.