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.WorkDocs.DescribeResourcePermissions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the permissions of a specified resource.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeResourcePermissions Source #

See: newDescribeResourcePermissions smart constructor.

Constructors

DescribeResourcePermissions'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
limit :: Maybe Natural
The maximum number of items to return with this call.
marker :: Maybe Text
The marker for the next set of results. (You received this marker from a previous call)
principalId :: Maybe Text
The ID of the principal to filter permissions by.
resourceId :: Text
The ID of the resource.

Instances

Instances details

ToHeaders DescribeResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.DescribeResourcePermissions Methods toHeaders :: DescribeResourcePermissions -> [Header] #
ToPath DescribeResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.DescribeResourcePermissions Methods toPath :: DescribeResourcePermissions -> ByteString #
ToQuery DescribeResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.DescribeResourcePermissions Methods toQuery :: DescribeResourcePermissions -> QueryString #
AWSPager DescribeResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.DescribeResourcePermissions Methods page :: DescribeResourcePermissions -> AWSResponse DescribeResourcePermissions -> Maybe DescribeResourcePermissions #
AWSRequest DescribeResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.DescribeResourcePermissions Associated Types type AWSResponse DescribeResourcePermissions # Methods request :: (Service -> Service) -> DescribeResourcePermissions -> Request DescribeResourcePermissions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeResourcePermissions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeResourcePermissions))) #
Generic DescribeResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.DescribeResourcePermissions Associated Types type Rep DescribeResourcePermissions :: Type -> Type # Methods from :: DescribeResourcePermissions -> Rep DescribeResourcePermissions x # to :: Rep DescribeResourcePermissions x -> DescribeResourcePermissions #
Show DescribeResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.DescribeResourcePermissions Methods showsPrec :: Int -> DescribeResourcePermissions -> ShowS # show :: DescribeResourcePermissions -> String # showList :: [DescribeResourcePermissions] -> ShowS #
NFData DescribeResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.DescribeResourcePermissions Methods rnf :: DescribeResourcePermissions -> () #
Eq DescribeResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.DescribeResourcePermissions Methods (==) :: DescribeResourcePermissions -> DescribeResourcePermissions -> Bool # (/=) :: DescribeResourcePermissions -> DescribeResourcePermissions -> Bool #
Hashable DescribeResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.DescribeResourcePermissions Methods hashWithSalt :: Int -> DescribeResourcePermissions -> Int # hash :: DescribeResourcePermissions -> Int #
type AWSResponse DescribeResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.DescribeResourcePermissions type AWSResponse DescribeResourcePermissions = DescribeResourcePermissionsResponse
type Rep DescribeResourcePermissions Source #
Instance details Defined in Amazonka.WorkDocs.DescribeResourcePermissions type Rep DescribeResourcePermissions = D1 ('MetaData "DescribeResourcePermissions" "Amazonka.WorkDocs.DescribeResourcePermissions" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DescribeResourcePermissions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "principalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeResourcePermissions Source #

Arguments

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

Create a value of DescribeResourcePermissions 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:DescribeResourcePermissions', describeResourcePermissions_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:limit:DescribeResourcePermissions', describeResourcePermissions_limit - The maximum number of items to return with this call.

DescribeResourcePermissions, describeResourcePermissions_marker - The marker for the next set of results. (You received this marker from a previous call)

DescribeResourcePermissions, describeResourcePermissions_principalId - The ID of the principal to filter permissions by.

$sel:resourceId:DescribeResourcePermissions', describeResourcePermissions_resourceId - The ID of the resource.

Request Lenses

describeResourcePermissions_authenticationToken :: Lens' DescribeResourcePermissions (Maybe Text) Source #

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

describeResourcePermissions_limit :: Lens' DescribeResourcePermissions (Maybe Natural) Source #

The maximum number of items to return with this call.

describeResourcePermissions_marker :: Lens' DescribeResourcePermissions (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call)

describeResourcePermissions_principalId :: Lens' DescribeResourcePermissions (Maybe Text) Source #

The ID of the principal to filter permissions by.

describeResourcePermissions_resourceId :: Lens' DescribeResourcePermissions Text Source #

The ID of the resource.

Destructuring the Response

data DescribeResourcePermissionsResponse Source #

See: newDescribeResourcePermissionsResponse smart constructor.

Constructors

DescribeResourcePermissionsResponse'
Fields marker :: Maybe Text The marker to use when requesting the next set of results. If there are no additional results, the string is empty. principals :: Maybe [Principal] The principals. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeResourcePermissionsResponse Source #

Arguments

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

Create a value of DescribeResourcePermissionsResponse 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:

DescribeResourcePermissions, describeResourcePermissionsResponse_marker - The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

$sel:principals:DescribeResourcePermissionsResponse', describeResourcePermissionsResponse_principals - The principals.

$sel:httpStatus:DescribeResourcePermissionsResponse', describeResourcePermissionsResponse_httpStatus - The response's http status code.

Response Lenses

describeResourcePermissionsResponse_marker :: Lens' DescribeResourcePermissionsResponse (Maybe Text) Source #

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

describeResourcePermissionsResponse_principals :: Lens' DescribeResourcePermissionsResponse (Maybe [Principal]) Source #

The principals.

describeResourcePermissionsResponse_httpStatus :: Lens' DescribeResourcePermissionsResponse Int Source #

The response's http status code.