Returns a set of temporary credentials for an AWS account or IAM user (link).
get_session_token(
profile_name = NULL,
region_name = NULL,
serial_number = NULL,
token_code = NULL,
duration_seconds = 3600L,
set_env = FALSE
)
The name of a profile to use. If not given, then the default profile is used. To set profile name, the AWS Command Line Interface (AWS CLI) will need to be configured. To configure AWS CLI please refer to: Configuring the AWS CLI.
Default region when creating new connections. Please refer to link for
AWS region codes (region code example: Region = EU (Ireland) region_name = "eu-west-1"
)
The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as `GAHT12345678`) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).
The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.
The duration, in seconds, that the credentials should remain valid. Acceptable duration for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 3,600 seconds (1 hour) as the default.
If set to TRUE
environmental variables AWS_ACCESS_KEY_ID
, AWS_SECRET_ACCESS_KEY
and AWS_SESSION_TOKEN
will be set.
get_session_token()
returns a list containing: "AccessKeyId"
, "SecretAccessKey"
, "SessionToken"
and "Expiration"
if (FALSE) {
# Note:
# - Require AWS Account to run below example.
library(RAthena)
library(DBI)
# Create Temporary Credentials duration 1 hour
get_session_token("YOUR_PROFILE_NAME",
serial_number='arn:aws:iam::123456789012:mfa/user',
token_code = "531602",
set_env = TRUE)
# Connect to Athena using temporary credentials
con <- dbConnect(athena())
}