Copyright	(c) 2013-2021 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

Amazonka.WorkDocs.AddResourcePermissions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

Synopsis

Creating a Request

data AddResourcePermissions Source #

See: newAddResourcePermissions smart constructor.

Constructors

AddResourcePermissions'
Fields notificationOptions :: Maybe NotificationOptions The notification options. authenticationToken :: Maybe (Sensitive Text) Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. resourceId :: Text The ID of the resource. principals :: [SharePrincipal] The users, groups, or organization being granted permission.

Instances

Instances details

Eq AddResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Methods (==) :: AddResourcePermissions -> AddResourcePermissions -> Bool # (/=) :: AddResourcePermissions -> AddResourcePermissions -> Bool #
Show AddResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Methods showsPrec :: Int -> AddResourcePermissions -> ShowS # show :: AddResourcePermissions -> String # showList :: [AddResourcePermissions] -> ShowS #
Generic AddResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Associated Types type Rep AddResourcePermissions :: Type -> Type # Methods from :: AddResourcePermissions -> Rep AddResourcePermissions x # to :: Rep AddResourcePermissions x -> AddResourcePermissions #
NFData AddResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Methods rnf :: AddResourcePermissions -> () #
Hashable AddResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Methods hashWithSalt :: Int -> AddResourcePermissions -> Int # hash :: AddResourcePermissions -> Int #
ToJSON AddResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Methods toJSON :: AddResourcePermissions -> Value # toEncoding :: AddResourcePermissions -> Encoding # toJSONList :: [AddResourcePermissions] -> Value # toEncodingList :: [AddResourcePermissions] -> Encoding #
AWSRequest AddResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Associated Types type AWSResponse AddResourcePermissions # Methods request :: AddResourcePermissions -> Request AddResourcePermissions # response :: MonadResource m => Logger -> Service -> Proxy AddResourcePermissions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AddResourcePermissions))) #
ToHeaders AddResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Methods toHeaders :: AddResourcePermissions -> [Header] #
ToPath AddResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Methods toPath :: AddResourcePermissions -> ByteString #
ToQuery AddResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Methods toQuery :: AddResourcePermissions -> QueryString #
type Rep AddResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions type Rep AddResourcePermissions = D1 ('MetaData "AddResourcePermissions" "Amazonka.WorkDocs.AddResourcePermissions" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "AddResourcePermissions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "notificationOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationOptions)) :: S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "principals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SharePrincipal]))))
type AWSResponse AddResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions type AWSResponse AddResourcePermissions = AddResourcePermissionsResponse

newAddResourcePermissions Source #

Arguments

:: Text	`$sel:resourceId:AddResourcePermissions'`
-> AddResourcePermissions

Create a value of AddResourcePermissions 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:notificationOptions:AddResourcePermissions', addResourcePermissions_notificationOptions - The notification options.

$sel:authenticationToken:AddResourcePermissions', addResourcePermissions_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:resourceId:AddResourcePermissions', addResourcePermissions_resourceId - The ID of the resource.

$sel:principals:AddResourcePermissions', addResourcePermissions_principals - The users, groups, or organization being granted permission.

Request Lenses

addResourcePermissions_notificationOptions :: Lens' AddResourcePermissions (Maybe NotificationOptions) Source #

The notification options.

addResourcePermissions_authenticationToken :: Lens' AddResourcePermissions (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

addResourcePermissions_resourceId :: Lens' AddResourcePermissions Text Source #

The ID of the resource.

addResourcePermissions_principals :: Lens' AddResourcePermissions [SharePrincipal] Source #

The users, groups, or organization being granted permission.

Destructuring the Response

data AddResourcePermissionsResponse Source #

See: newAddResourcePermissionsResponse smart constructor.

Constructors

AddResourcePermissionsResponse'
Fields shareResults :: Maybe [ShareResult] The share results. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq AddResourcePermissionsResponse Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Methods (==) :: AddResourcePermissionsResponse -> AddResourcePermissionsResponse -> Bool # (/=) :: AddResourcePermissionsResponse -> AddResourcePermissionsResponse -> Bool #
Show AddResourcePermissionsResponse Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Methods showsPrec :: Int -> AddResourcePermissionsResponse -> ShowS # show :: AddResourcePermissionsResponse -> String # showList :: [AddResourcePermissionsResponse] -> ShowS #
Generic AddResourcePermissionsResponse Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Associated Types type Rep AddResourcePermissionsResponse :: Type -> Type # Methods from :: AddResourcePermissionsResponse -> Rep AddResourcePermissionsResponse x # to :: Rep AddResourcePermissionsResponse x -> AddResourcePermissionsResponse #
NFData AddResourcePermissionsResponse Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions Methods rnf :: AddResourcePermissionsResponse -> () #
type Rep AddResourcePermissionsResponse Source #
Instance details Defined in Amazonka.WorkDocs.AddResourcePermissions type Rep AddResourcePermissionsResponse = D1 ('MetaData "AddResourcePermissionsResponse" "Amazonka.WorkDocs.AddResourcePermissions" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "AddResourcePermissionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "shareResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ShareResult])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAddResourcePermissionsResponse Source #

Arguments

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

Create a value of AddResourcePermissionsResponse 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:shareResults:AddResourcePermissionsResponse', addResourcePermissionsResponse_shareResults - The share results.

$sel:httpStatus:AddResourcePermissionsResponse', addResourcePermissionsResponse_httpStatus - The response's http status code.

Response Lenses

addResourcePermissionsResponse_shareResults :: Lens' AddResourcePermissionsResponse (Maybe [ShareResult]) Source #

The share results.

addResourcePermissionsResponse_httpStatus :: Lens' AddResourcePermissionsResponse Int Source #

The response's http status code.