[ aws . lakeformation ]

get-temporary-glue-partition-credentials

Description

This API is identical to GetTemporaryTableCredentials except that this is used when the target Data Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the same scope down policy which restricts access to a single Amazon S3 prefix.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-temporary-glue-partition-credentials
--table-arn <value>
--partition <value>
[--permissions <value>]
[--duration-seconds <value>]
[--audit-context <value>]
--supported-permission-types <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--table-arn (string)

The ARN of the partitions’ table.

--partition (structure)

A list of partition values identifying a single partition.

Values -> (list)

The list of partition values.

(string)

Shorthand Syntax:

Values=string,string

JSON Syntax:

{
  "Values": ["string", ...]
}

--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_TAG
  ASSOCIATE

--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 partition. Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION .

(string)

Syntax:

"string" "string" ...

Where valid values are:
  COLUMN_PERMISSION
  CELL_FILTER_PERMISSION

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

See ‘aws help’ for descriptions of global 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.