Skip to content

Get Temporary Data Location Credentials

lakeformation_get_temporary_data_location_credentials R Documentation

Allows a user or application in a secure environment to access data in a specific Amazon S3 location registered with Lake Formation by providing temporary scoped credentials that are limited to the requested data location and the caller's authorized access level

Description

Allows a user or application in a secure environment to access data in a specific Amazon S3 location registered with Lake Formation by providing temporary scoped credentials that are limited to the requested data location and the caller's authorized access level.

GetDataAccess is logged in CloudTrail whenever a principal requests temporary data location credentials to access data in a data lake location that is registered with Lake Formation.

The API operation returns an error in the following scenarios:

  • The data location is not registered with Lake Formation.

  • No Glue table is associated with the data location.

  • The caller doesn't have required permissions on the associated table. The caller must have SELECT or SUPER permissions on the associated table, and credential vending for full table access must be enabled in the data lake settings.

For more information, see Application integration for full table access.

  • The data location is in a different Amazon Web Services Region. Lake Formation doesn't support cross-Region access when vending credentials for a data location. Lake Formation only supports Amazon S3 paths registered within the same Region as the API call.

Usage

lakeformation_get_temporary_data_location_credentials(DurationSeconds,
  AuditContext, DataLocations, CredentialsScope)

Arguments

DurationSeconds

The time period, between 900 and 43,200 seconds, for the timeout of the temporary credentials.
AuditContext

A structure used to include auditing information on the privileged API.
DataLocations

The Amazon S3 data location that you want to access.
CredentialsScope

The credential scope is determined by the caller's Lake Formation permission on the associated table. Credential scope can be either:

  • READ - Provides read-only access to the data location.

  • READ_WRITE - Provides both read and write access to the data location.

Value

A list with the following syntax:

list(
  Credentials = list(
    AccessKeyId = "string",
    SecretAccessKey = "string",
    SessionToken = "string",
    Expiration = as.POSIXct(
      "2015-01-01"
    )
  ),
  AccessibleDataLocations = list(
    "string"
  ),
  CredentialsScope = "READ"|"READWRITE"
)

Request syntax

svc$get_temporary_data_location_credentials(
  DurationSeconds = 123,
  AuditContext = list(
    AdditionalAuditContext = "string"
  ),
  DataLocations = list(
    "string"
  ),
  CredentialsScope = "READ"|"READWRITE"
)