Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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

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 <value>]
[--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>]

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_LF_TAG
  ASSOCIATE
  GRANT_WITH_LF_TAG_EXPRESSION

--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
  NESTED_PERMISSION
  NESTED_CELL_PERMISSION

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

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.