Amazonka.WorkDocs.AddResourcePermissions

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

Creating a Request

data AddResourcePermissions

See: newAddResourcePermissions smart constructor.

Constructors

AddResourcePermissions'

Fields

• authenticationToken :: Maybe (Sensitive Text)

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

• notificationOptions :: Maybe NotificationOptions

  The notification options.

• resourceId :: Text

  The ID of the resource.

• principals :: [SharePrincipal]

  The users, groups, or organization being granted permission.

Instances

ToJSON AddResourcePermissions

Defined in Amazonka.WorkDocs.AddResourcePermissions

Methods

toJSON :: AddResourcePermissions -> Value

toEncoding :: AddResourcePermissions -> Encoding

toJSONList :: [AddResourcePermissions] -> Value

toEncodingList :: [AddResourcePermissions] -> Encoding

ToHeaders AddResourcePermissions

Defined in Amazonka.WorkDocs.AddResourcePermissions

Methods

toHeaders :: AddResourcePermissions -> [Header]

ToPath AddResourcePermissions

Defined in Amazonka.WorkDocs.AddResourcePermissions

Methods

toPath :: AddResourcePermissions -> ByteString

ToQuery AddResourcePermissions

Defined in Amazonka.WorkDocs.AddResourcePermissions

Methods

toQuery :: AddResourcePermissions -> QueryString

AWSRequest AddResourcePermissions

Defined in Amazonka.WorkDocs.AddResourcePermissions

Associated Types

type AWSResponse AddResourcePermissions

Methods

request :: (Service -> Service) -> AddResourcePermissions -> Request AddResourcePermissions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AddResourcePermissions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AddResourcePermissions)))

Generic AddResourcePermissions

Defined in Amazonka.WorkDocs.AddResourcePermissions

Associated Types

type Rep AddResourcePermissions :: Type -> Type

Methods

from :: AddResourcePermissions -> Rep AddResourcePermissions x

to :: Rep AddResourcePermissions x -> AddResourcePermissions

Show AddResourcePermissions

Defined in Amazonka.WorkDocs.AddResourcePermissions

Methods

showsPrec :: Int -> AddResourcePermissions -> ShowS

show :: AddResourcePermissions -> String

showList :: [AddResourcePermissions] -> ShowS

NFData AddResourcePermissions

Defined in Amazonka.WorkDocs.AddResourcePermissions

Methods

rnf :: AddResourcePermissions -> ()

Eq AddResourcePermissions

Defined in Amazonka.WorkDocs.AddResourcePermissions

Methods

(==) :: AddResourcePermissions -> AddResourcePermissions -> Bool

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

Hashable AddResourcePermissions

Defined in Amazonka.WorkDocs.AddResourcePermissions

Methods

hashWithSalt :: Int -> AddResourcePermissions -> Int

hash :: AddResourcePermissions -> Int

type AWSResponse AddResourcePermissions

Defined in Amazonka.WorkDocs.AddResourcePermissions

type AWSResponse AddResourcePermissions = AddResourcePermissionsResponse

type Rep AddResourcePermissions

Defined in Amazonka.WorkDocs.AddResourcePermissions

type Rep AddResourcePermissions = D1 ('MetaData "AddResourcePermissions" "Amazonka.WorkDocs.AddResourcePermissions" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "AddResourcePermissions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "notificationOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationOptions))) :*: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "principals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SharePrincipal]))))

newAddResourcePermissions

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:authenticationToken:AddResourcePermissions', addResourcePermissions_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:notificationOptions:AddResourcePermissions', addResourcePermissions_notificationOptions - The notification options.

$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_authenticationToken :: Lens' AddResourcePermissions (Maybe Text)

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

addResourcePermissions_notificationOptions :: Lens' AddResourcePermissions (Maybe NotificationOptions)

The notification options.

addResourcePermissions_resourceId :: Lens' AddResourcePermissions Text

The ID of the resource.

addResourcePermissions_principals :: Lens' AddResourcePermissions [SharePrincipal]

The users, groups, or organization being granted permission.

Destructuring the Response

data AddResourcePermissionsResponse

See: newAddResourcePermissionsResponse smart constructor.

Constructors

AddResourcePermissionsResponse'

Fields

• shareResults :: Maybe [ShareResult]

  The share results.

• httpStatus :: Int

  The response's http status code.

Instances

Generic AddResourcePermissionsResponse

Defined in Amazonka.WorkDocs.AddResourcePermissions

Associated Types

type Rep AddResourcePermissionsResponse :: Type -> Type

Methods

from :: AddResourcePermissionsResponse -> Rep AddResourcePermissionsResponse x

to :: Rep AddResourcePermissionsResponse x -> AddResourcePermissionsResponse

Show AddResourcePermissionsResponse

Defined in Amazonka.WorkDocs.AddResourcePermissions

Methods

showsPrec :: Int -> AddResourcePermissionsResponse -> ShowS

show :: AddResourcePermissionsResponse -> String

showList :: [AddResourcePermissionsResponse] -> ShowS

NFData AddResourcePermissionsResponse

Defined in Amazonka.WorkDocs.AddResourcePermissions

Methods

rnf :: AddResourcePermissionsResponse -> ()

Eq AddResourcePermissionsResponse

Defined in Amazonka.WorkDocs.AddResourcePermissions

Methods

(==) :: AddResourcePermissionsResponse -> AddResourcePermissionsResponse -> Bool

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

type Rep AddResourcePermissionsResponse

Defined in Amazonka.WorkDocs.AddResourcePermissions

type Rep AddResourcePermissionsResponse = D1 ('MetaData "AddResourcePermissionsResponse" "Amazonka.WorkDocs.AddResourcePermissions" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" '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

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

The share results.

addResourcePermissionsResponse_httpStatus :: Lens' AddResourcePermissionsResponse Int

The response's http status code.