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.LakeFormation.ListPermissions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.

This operation returns only those permissions that have been explicitly granted.

For information about permissions, see Security and Access Control to Metadata and Data.

Synopsis

data ListPermissions = ListPermissions' {
- catalogId :: Maybe Text
- includeRelated :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- principal :: Maybe DataLakePrincipal
- resource :: Maybe Resource
- resourceType :: Maybe DataLakeResourceType
}
newListPermissions :: ListPermissions
listPermissions_catalogId :: Lens' ListPermissions (Maybe Text)
listPermissions_includeRelated :: Lens' ListPermissions (Maybe Text)
listPermissions_maxResults :: Lens' ListPermissions (Maybe Natural)
listPermissions_nextToken :: Lens' ListPermissions (Maybe Text)
listPermissions_principal :: Lens' ListPermissions (Maybe DataLakePrincipal)
listPermissions_resource :: Lens' ListPermissions (Maybe Resource)
listPermissions_resourceType :: Lens' ListPermissions (Maybe DataLakeResourceType)
data ListPermissionsResponse = ListPermissionsResponse' {
- nextToken :: Maybe Text
- principalResourcePermissions :: Maybe [PrincipalResourcePermissions]
- httpStatus :: Int
}
newListPermissionsResponse :: Int -> ListPermissionsResponse
listPermissionsResponse_nextToken :: Lens' ListPermissionsResponse (Maybe Text)
listPermissionsResponse_principalResourcePermissions :: Lens' ListPermissionsResponse (Maybe [PrincipalResourcePermissions])
listPermissionsResponse_httpStatus :: Lens' ListPermissionsResponse Int

Creating a Request

data ListPermissions Source #

See: newListPermissions smart constructor.

Constructors

ListPermissions'

Fields

catalogId :: Maybe Text
The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
includeRelated :: Maybe Text
Indicates that related permissions should be included in the results.
maxResults :: Maybe Natural
The maximum number of results to return.
nextToken :: Maybe Text
A continuation token, if this is not the first call to retrieve this list.
principal :: Maybe DataLakePrincipal
Specifies a principal to filter the permissions returned.
resource :: Maybe Resource
A resource where you will get a list of the principal permissions.
This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.
resourceType :: Maybe DataLakeResourceType
Specifies a resource type to filter the permissions returned.

Instances

Instances details

ToJSON ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions Methods toJSON :: ListPermissions -> Value # toEncoding :: ListPermissions -> Encoding # toJSONList :: [ListPermissions] -> Value # toEncodingList :: [ListPermissions] -> Encoding #
ToHeaders ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions Methods toHeaders :: ListPermissions -> [Header] #
ToPath ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions Methods toPath :: ListPermissions -> ByteString #
ToQuery ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions Methods toQuery :: ListPermissions -> QueryString #
AWSRequest ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions Associated Types type AWSResponse ListPermissions # Methods request :: (Service -> Service) -> ListPermissions -> Request ListPermissions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListPermissions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPermissions))) #
Generic ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions Associated Types type Rep ListPermissions :: Type -> Type # Methods from :: ListPermissions -> Rep ListPermissions x # to :: Rep ListPermissions x -> ListPermissions #
Read ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions Methods readsPrec :: Int -> ReadS ListPermissions # readList :: ReadS [ListPermissions] # readPrec :: ReadPrec ListPermissions # readListPrec :: ReadPrec [ListPermissions] #
Show ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions Methods showsPrec :: Int -> ListPermissions -> ShowS # show :: ListPermissions -> String # showList :: [ListPermissions] -> ShowS #
NFData ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions Methods rnf :: ListPermissions -> () #
Eq ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions Methods (==) :: ListPermissions -> ListPermissions -> Bool # (/=) :: ListPermissions -> ListPermissions -> Bool #
Hashable ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions Methods hashWithSalt :: Int -> ListPermissions -> Int # hash :: ListPermissions -> Int #
type AWSResponse ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions type AWSResponse ListPermissions = ListPermissionsResponse
type Rep ListPermissions Source #
Instance details Defined in Amazonka.LakeFormation.ListPermissions type Rep ListPermissions = D1 ('MetaData "ListPermissions" "Amazonka.LakeFormation.ListPermissions" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "ListPermissions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "catalogId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "includeRelated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "principal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataLakePrincipal))) :: (S1 ('MetaSel ('Just "resource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Resource)) :: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataLakeResourceType))))))

newListPermissions :: ListPermissions Source #

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

ListPermissions, listPermissions_catalogId - The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

$sel:includeRelated:ListPermissions', listPermissions_includeRelated - Indicates that related permissions should be included in the results.

$sel:maxResults:ListPermissions', listPermissions_maxResults - The maximum number of results to return.

ListPermissions, listPermissions_nextToken - A continuation token, if this is not the first call to retrieve this list.

ListPermissions, listPermissions_principal - Specifies a principal to filter the permissions returned.

ListPermissions, listPermissions_resource - A resource where you will get a list of the principal permissions.

This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.

ListPermissions, listPermissions_resourceType - Specifies a resource type to filter the permissions returned.

Request Lenses

listPermissions_catalogId :: Lens' ListPermissions (Maybe Text) Source #

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

listPermissions_includeRelated :: Lens' ListPermissions (Maybe Text) Source #

Indicates that related permissions should be included in the results.

listPermissions_maxResults :: Lens' ListPermissions (Maybe Natural) Source #

The maximum number of results to return.

listPermissions_nextToken :: Lens' ListPermissions (Maybe Text) Source #

A continuation token, if this is not the first call to retrieve this list.

listPermissions_principal :: Lens' ListPermissions (Maybe DataLakePrincipal) Source #

Specifies a principal to filter the permissions returned.

listPermissions_resource :: Lens' ListPermissions (Maybe Resource) Source #

A resource where you will get a list of the principal permissions.

This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.

listPermissions_resourceType :: Lens' ListPermissions (Maybe DataLakeResourceType) Source #

Specifies a resource type to filter the permissions returned.

Destructuring the Response

data ListPermissionsResponse Source #

See: newListPermissionsResponse smart constructor.

Constructors

ListPermissionsResponse'
Fields nextToken :: Maybe Text A continuation token, if this is not the first call to retrieve this list. principalResourcePermissions :: Maybe [PrincipalResourcePermissions] A list of principals and their permissions on the resource for the specified principal and resource types. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListPermissionsResponse Source #

Arguments

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

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

ListPermissions, listPermissionsResponse_nextToken - A continuation token, if this is not the first call to retrieve this list.

$sel:principalResourcePermissions:ListPermissionsResponse', listPermissionsResponse_principalResourcePermissions - A list of principals and their permissions on the resource for the specified principal and resource types.

$sel:httpStatus:ListPermissionsResponse', listPermissionsResponse_httpStatus - The response's http status code.

Response Lenses

listPermissionsResponse_nextToken :: Lens' ListPermissionsResponse (Maybe Text) Source #

A continuation token, if this is not the first call to retrieve this list.

listPermissionsResponse_principalResourcePermissions :: Lens' ListPermissionsResponse (Maybe [PrincipalResourcePermissions]) Source #

A list of principals and their permissions on the resource for the specified principal and resource types.

listPermissionsResponse_httpStatus :: Lens' ListPermissionsResponse Int Source #

The response's http status code.