LakeFormation / Client / assume_decorated_role_with_saml

assume_decorated_role_with_saml#

LakeFormation.Client.assume_decorated_role_with_saml(**kwargs)#

Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.

This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API GetDataAccess. Therefore, all SAML roles that can be assumed via AssumeDecoratedRoleWithSAML must at a minimum include lakeformation:GetDataAccess in their role policies. A typical IAM policy attached to such a role would look as follows:

See also: AWS API Documentation

Request Syntax

response = client.assume_decorated_role_with_saml(
    SAMLAssertion='string',
    RoleArn='string',
    PrincipalArn='string',
    DurationSeconds=123
)
Parameters:

  • SAMLAssertion (string) –

    [REQUIRED]

    A SAML assertion consisting of an assertion statement for the user who needs temporary credentials. This must match the SAML assertion that was issued to IAM. This must be Base64 encoded.

  • RoleArn (string) –

    [REQUIRED]

    The role that represents an IAM principal whose scope down policy allows it to call credential vending APIs such as GetTemporaryTableCredentials. The caller must also have iam:PassRole permission on this role.

  • PrincipalArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

  • DurationSeconds (integer) – The time period, between 900 and 43,200 seconds, for the timeout of the temporary credentials.

Return type:

dict

Returns:

Response Syntax

{
    'AccessKeyId': 'string',
    'SecretAccessKey': 'string',
    'SessionToken': 'string',
    'Expiration': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • AccessKeyId (string) –

      The access key ID for the temporary credentials. (The access key consists of an access key ID and a secret key).

    • SecretAccessKey (string) –

      The secret key for the temporary credentials. (The access key consists of an access key ID and a secret key).

    • SessionToken (string) –

      The session token for the temporary credentials.

    • Expiration (datetime) –

      The date and time when the temporary credentials expire.

Exceptions