Help Center/ DataArts Lake Formation/ API Reference/ Appendix/ APIs That Support Enterprise Project Authentication
Updated on 2025-11-07 GMT+08:00
View PDF
Share

APIs That Support Enterprise Project Authentication

Prerequisites for a successful enterprise project authentication are as follows:

  • The URI must contain resource information related to the enterprise project. For example, if the LakeFormation resource is an instance, enterprise project authentication can be performed only when the URI contains the instance ID.
  • Currently, enterprise project authentication only supports IAM 3.0 policies.

The following lists the management plane APIs that support enterprise project authentication:

Table 1 Management plane APIs that support enterprise project authentication

API

Description

Permission

URI

CreateAccessClient

Creates a client for service access.

lakeformation:instance:createAccessClient

/v1/{project_id}/instances/{instance_id}/access-clients

ListAccessClientInfos

Obtains the list of access clients related to a LakeFormation instance by instance name.

lakeformation:instance:listAccessClient

/v1/{project_id}/instances/{instance_id}/access-clients

ShowAccessClient

Obtains service access client details by ID.

lakeformation:instance:describeAccessClient

/v1/{project_id}/instances/{instance_id}/access-clients/{client_id}

DeleteAccessClient

Deletes service access clients by ID.

lakeformation:instance:deleteAccessClient

/v1/{project_id}/instances/{instance_id}/access-clients/{client_id}

UpdateAccessClient

Updates service access clients by ID.

lakeformation:instance:alterAccessClient

/v1/{project_id}/instances/{instance_id}/access-clients/{client_id}

CreateJobByInstance

Creates a job.

lakeformation:instance:createJob

/v1/{project_id}/instances/{instance_id}/lf-jobs

ShowJobByInstance

Queries details about a job.

lakeformation:instance:showJob

/v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}

UpdateJobByInstance

Modifies job information.

lakeformation:instance:alterJob

/v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}

ListJobsByInstance

Lists job information by page based on conditions.

lakeformation:instance:listJob

/v1/{project_id}/instances/{instance_id}/lf-jobs

StartJobByInstance

Runs a job.

lakeformation:instance:startJob

/v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}/start?mode={mode}&cascade={cascade}

StopJobByInstance

Stops a job.

lakeformation:instance:stopJob

/v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}/stop

ShowJobLogByInstance

Checks job logs by job ID.

lakeformation:instance:showJob

/v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}/log

ShowJobHistoryByInstance

Views the historical job specified by the job ID.

lakeformation:instance:showJob

/v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}/history

DeleteJobByInstance

Deletes jobs. A job that has been submitted or is running needs to be stopped before being deleted.

lakeformation:instance:dropJob

/v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}

ListInstanceLifecycle

Obtains the lifecycle rule of an instance.

lakeformation:instance:listLifecycle

/v1/{project_id}/instances/{instance_id}/lifecycle

UpdateInstanceLifecycle

Modifies the lifecycle rule of an instance.

lakeformation:instance:alterLifecycle

/v1/{project_id}/instances/{instance_id}/lifecycle

CreateLakeFormationInstance

Creates a LakeFormation instance.

lakeformation:instance:createInstance

/v1/{project_id}/instances/{instance_id}

UpdateLakeFormationInstanceDefault

Sets a non-default instance as the default.

lakeformation:instance:update

/v1/{project_id}/instances/{instance_id}/default

ShowLakeFormationInstance

Queries the details of LakeFormation instances by ID.

lakeformation:instance:show

/v1/{project_id}/instances/{instance_id}

UpdateLakeFormationInstance

Modifies LakeFormation instance information.

lakeformation:instance:update

/v1/{project_id}/instances/{instance_id}

BatchUpdateLakeFormationInstanceTags

Batch updates tags of a specified instance.

lakeformation:instance:updateTag

/rest/v1/{project_id}/instances/{instance_id}/tags

MoveLakeFormationInstanceOutRecycleBin

Restores a LakeFormation instance from the recycle bin.

lakeformation:instance:recover

/v1/{project_id}/instances/{instance_id}/recover

DeleteLakeFormationInstance

Deletes a LakeFormation instance by ID.

lakeformation:instance:drop

/v1/{project_id}/instances/{instance_id}

UpdateLakeFormationInstanceScale

Modifies LakeFormation instance specifications.

lakeformation:instance:update

/v1/{project_id}/instances/{instance_id}/scale
Parent topic: Appendix