amazonka-lakeformation-2.0: Amazon Lake Formation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LakeFormation.GetEffectivePermissionsForPath

Description

Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.

Synopsis

Creating a Request

data GetEffectivePermissionsForPath Source #

See: newGetEffectivePermissionsForPath smart constructor.

Constructors

GetEffectivePermissionsForPath' 

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.

  • 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.

  • resourceArn :: Text

    The Amazon Resource Name (ARN) of the resource for which you want to get permissions.

Instances

Instances details
ToJSON GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

toJSON :: GetEffectivePermissionsForPath -> Value #

toEncoding :: GetEffectivePermissionsForPath -> Encoding #

toJSONList :: [GetEffectivePermissionsForPath] -> Value #

toEncodingList :: [GetEffectivePermissionsForPath] -> Encoding #

ToHeaders GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

toHeaders :: GetEffectivePermissionsForPath -> [Header] #

ToPath GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

toPath :: GetEffectivePermissionsForPath -> ByteString #

ToQuery GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

toQuery :: GetEffectivePermissionsForPath -> QueryString #

AWSRequest GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Associated Types

type AWSResponse GetEffectivePermissionsForPath #

Methods

request :: (Service -> Service) -> GetEffectivePermissionsForPath -> Request GetEffectivePermissionsForPath #

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

Generic GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Associated Types

type Rep GetEffectivePermissionsForPath :: Type -> Type #

Methods

from :: GetEffectivePermissionsForPath -> Rep GetEffectivePermissionsForPath x #

to :: Rep GetEffectivePermissionsForPath x -> GetEffectivePermissionsForPath #

Read GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

readsPrec :: Int -> ReadS GetEffectivePermissionsForPath #

readList :: ReadS [GetEffectivePermissionsForPath] #

readPrec :: ReadPrec GetEffectivePermissionsForPath #

readListPrec :: ReadPrec [GetEffectivePermissionsForPath] #

Show GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

showsPrec :: Int -> GetEffectivePermissionsForPath -> ShowS #

show :: GetEffectivePermissionsForPath -> String #

showList :: [GetEffectivePermissionsForPath] -> ShowS #

NFData GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

rnf :: GetEffectivePermissionsForPath -> () #

Eq GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

(==) :: GetEffectivePermissionsForPath -> GetEffectivePermissionsForPath -> Bool #

(/=) :: GetEffectivePermissionsForPath -> GetEffectivePermissionsForPath -> Bool #

Hashable GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

hashWithSalt :: Int -> GetEffectivePermissionsForPath -> Int #

hash :: GetEffectivePermissionsForPath -> Int #

type AWSResponse GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

type AWSResponse GetEffectivePermissionsForPath = GetEffectivePermissionsForPathResponse
type Rep GetEffectivePermissionsForPath Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

type Rep GetEffectivePermissionsForPath = D1 ('MetaData "GetEffectivePermissionsForPath" "Amazonka.LakeFormation.GetEffectivePermissionsForPath" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "GetEffectivePermissionsForPath'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "catalogId") '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 "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetEffectivePermissionsForPath Source #

Arguments

:: Text

GetEffectivePermissionsForPath

-> GetEffectivePermissionsForPath 

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

GetEffectivePermissionsForPath, getEffectivePermissionsForPath_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:maxResults:GetEffectivePermissionsForPath', getEffectivePermissionsForPath_maxResults - The maximum number of results to return.

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

GetEffectivePermissionsForPath, getEffectivePermissionsForPath_resourceArn - The Amazon Resource Name (ARN) of the resource for which you want to get permissions.

Request Lenses

getEffectivePermissionsForPath_catalogId :: Lens' GetEffectivePermissionsForPath (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.

getEffectivePermissionsForPath_maxResults :: Lens' GetEffectivePermissionsForPath (Maybe Natural) Source #

The maximum number of results to return.

getEffectivePermissionsForPath_nextToken :: Lens' GetEffectivePermissionsForPath (Maybe Text) Source #

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

getEffectivePermissionsForPath_resourceArn :: Lens' GetEffectivePermissionsForPath Text Source #

The Amazon Resource Name (ARN) of the resource for which you want to get permissions.

Destructuring the Response

data GetEffectivePermissionsForPathResponse Source #

See: newGetEffectivePermissionsForPathResponse smart constructor.

Constructors

GetEffectivePermissionsForPathResponse' 

Fields

Instances

Instances details
Generic GetEffectivePermissionsForPathResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Associated Types

type Rep GetEffectivePermissionsForPathResponse :: Type -> Type #

Methods

from :: GetEffectivePermissionsForPathResponse -> Rep GetEffectivePermissionsForPathResponse x #

to :: Rep GetEffectivePermissionsForPathResponse x -> GetEffectivePermissionsForPathResponse #

Read GetEffectivePermissionsForPathResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

readsPrec :: Int -> ReadS GetEffectivePermissionsForPathResponse #

readList :: ReadS [GetEffectivePermissionsForPathResponse] #

readPrec :: ReadPrec GetEffectivePermissionsForPathResponse #

readListPrec :: ReadPrec [GetEffectivePermissionsForPathResponse] #

Show GetEffectivePermissionsForPathResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

showsPrec :: Int -> GetEffectivePermissionsForPathResponse -> ShowS #

show :: GetEffectivePermissionsForPathResponse -> String #

showList :: [GetEffectivePermissionsForPathResponse] -> ShowS #

NFData GetEffectivePermissionsForPathResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

rnf :: GetEffectivePermissionsForPathResponse -> () #

Eq GetEffectivePermissionsForPathResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

Methods

(==) :: GetEffectivePermissionsForPathResponse -> GetEffectivePermissionsForPathResponse -> Bool #

(/=) :: GetEffectivePermissionsForPathResponse -> GetEffectivePermissionsForPathResponse -> Bool #

type Rep GetEffectivePermissionsForPathResponse Source # 
Instance details

Defined in Amazonka.LakeFormation.GetEffectivePermissionsForPath

type Rep GetEffectivePermissionsForPathResponse = D1 ('MetaData "GetEffectivePermissionsForPathResponse" "Amazonka.LakeFormation.GetEffectivePermissionsForPath" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "GetEffectivePermissionsForPathResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PrincipalResourcePermissions])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetEffectivePermissionsForPathResponse Source #

Arguments

:: Int

$sel:httpStatus:GetEffectivePermissionsForPathResponse'

-> GetEffectivePermissionsForPathResponse 

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

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

GetEffectivePermissionsForPathResponse, getEffectivePermissionsForPathResponse_permissions - A list of the permissions for the specified table or database resource located at the path in Amazon S3.

$sel:httpStatus:GetEffectivePermissionsForPathResponse', getEffectivePermissionsForPathResponse_httpStatus - The response's http status code.

Response Lenses

getEffectivePermissionsForPathResponse_nextToken :: Lens' GetEffectivePermissionsForPathResponse (Maybe Text) Source #

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

getEffectivePermissionsForPathResponse_permissions :: Lens' GetEffectivePermissionsForPathResponse (Maybe [PrincipalResourcePermissions]) Source #

A list of the permissions for the specified table or database resource located at the path in Amazon S3.

getEffectivePermissionsForPathResponse_httpStatus :: Lens' GetEffectivePermissionsForPathResponse Int Source #

The response's http status code.