[ aws . lakeformation ]

get-temporary-glue-table-credentials

Description

Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.

To call this API, the role that the service assumes must have lakeformation:GetDataAccess permission on the resource.

See also: AWS API Documentation

Synopsis

  get-temporary-glue-table-credentials
--table-arn <value>
[--permissions <value>]
[--duration-seconds <value>]
[--audit-context <value>]
[--supported-permission-types <value>]
[--s3-path <value>]
[--query-session-context <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--table-arn (string)

The ARN identifying a table in the Data Catalog for the temporary credentials request.

--permissions (list)

Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).

(string)

Syntax:

"string" "string" ...

Where valid values are:
  ALL
  SELECT
  ALTER
  DROP
  DELETE
  INSERT
  DESCRIBE
  CREATE_DATABASE
  CREATE_TABLE
  DATA_LOCATION_ACCESS
  CREATE_LF_TAG
  ASSOCIATE
  GRANT_WITH_LF_TAG_EXPRESSION
  CREATE_LF_TAG_EXPRESSION
  CREATE_CATALOG
  SUPER_USER

--duration-seconds (integer)

The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.

--audit-context (structure)

A structure representing context to access a resource (column names, query ID, etc).

AdditionalAuditContext -> (string)

The filter engine can populate the ‘AdditionalAuditContext’ information with the request ID for you to track. This information will be displayed in CloudTrail log in your account.

Shorthand Syntax:

AdditionalAuditContext=string

JSON Syntax:

{
  "AdditionalAuditContext": "string"
}

--supported-permission-types (list)

A list of supported permission types for the table. Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION .

(string)

Syntax:

"string" "string" ...

Where valid values are:
  COLUMN_PERMISSION
  CELL_FILTER_PERMISSION
  NESTED_PERMISSION
  NESTED_CELL_PERMISSION

--s3-path (string)

The Amazon S3 path for the table.

--query-session-context (structure)

A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request’s authorization context.

QueryId -> (string)

A unique identifier generated by the query engine for the query.

QueryStartTime -> (timestamp)

A timestamp provided by the query engine for when the query started.

ClusterId -> (string)

An identifier string for the consumer cluster.

QueryAuthorizationId -> (string)

A cryptographically generated query identifier generated by Glue or Lake Formation.

AdditionalContext -> (map)

An opaque string-string map passed by the query engine.

key -> (string)

value -> (string)

Shorthand Syntax:

QueryId=string,QueryStartTime=timestamp,ClusterId=string,QueryAuthorizationId=string,AdditionalContext={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "QueryId": "string",
  "QueryStartTime": timestamp,
  "ClusterId": "string",
  "QueryAuthorizationId": "string",
  "AdditionalContext": {"string": "string"
    ...}
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

AccessKeyId -> (string)

The access key ID for the temporary credentials.

SecretAccessKey -> (string)

The secret key for the temporary credentials.

SessionToken -> (string)

The session token for the temporary credentials.

Expiration -> (timestamp)

The date and time when the temporary credentials expire.

VendedS3Path -> (list)

The Amazon S3 path for the temporary credentials.

(string)