Assume Role
| sts_assume_role | R Documentation |
Returns a set of temporary security credentials that you can use to access Amazon Web Services resources¶
Description¶
Returns a set of temporary security credentials that you can use to
access Amazon Web Services resources. These temporary credentials
consist of an access key ID, a secret access key, and a security token.
Typically, you use assume_role within your account or for
cross-account access. For a comparison of assume_role with other API
operations that produce temporary credentials, see Requesting Temporary
Security
Credentials
and Compare STS
credentials
in the IAM User Guide.
Permissions
The temporary security credentials created by assume_role can be used
to make API calls to any Amazon Web Services service with the following
exception: You cannot call the Amazon Web Services STS
get_federation_token or get_session_token API operations.
(Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
When you create a role, you create two policies: a role trust policy that specifies who can assume the role, and a permissions policy that specifies what can be done with the role. You specify the trusted principal that is allowed to assume the role in the role trust policy.
To assume a role from a different account, your Amazon Web Services account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate that access to users in the account.
A user who wants to access a role in a different account must also have
permissions that are delegated from the account administrator. The
administrator must attach a policy that allows the user to call
assume_role for the ARN of the role in the other account.
To allow a user to assume a role in the same account, you can do either of the following:
-
Attach a policy to the user that allows the user to call
assume_role(as long as the role's trust policy trusts the account). -
Add the user as a principal directly in the role's trust policy.
You can do either because the role’s trust policy acts as an IAM resource-based policy. When a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information about trust policies and resource-based policies, see IAM Policies in the IAM User Guide.
Tags
(Optional) You can pass tag key-value pairs to your session. These tags are called session tags. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.
You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide.
Using MFA with AssumeRole
(Optional) You can include multi-factor authentication (MFA) information
when you call assume_role. This is useful for cross-account scenarios
to ensure that the user that assumes the role has been authenticated
with an Amazon Web Services MFA device. In that scenario, the trust
policy of the role being assumed includes a condition that tests for MFA
authentication. If the caller does not include valid MFA information,
the request to assume the role is denied. The condition in a trust
policy that tests for MFA authentication might look like the following
example.
"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}
For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide.
To use MFA with assume_role, you pass values for the SerialNumber
and TokenCode parameters. The SerialNumber value identifies the
user's hardware or virtual MFA device. The TokenCode is the time-based
one-time password (TOTP) that the MFA device produces.
Usage¶
sts_assume_role(RoleArn, RoleSessionName, PolicyArns, Policy,
DurationSeconds, Tags, TransitiveTagKeys, ExternalId, SerialNumber,
TokenCode, SourceIdentity, ProvidedContexts)
Arguments¶
RoleArn |
[required] The Amazon Resource Name (ARN) of the role to assume. |
RoleSessionName |
[required] An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests that use the temporary security credentials will expose the role session name to the external account in their CloudTrail logs. For security purposes, administrators can view this field in CloudTrail
logs to help identify who performed an action in Amazon Web
Services. Your administrator might require that you specify your user
name as the session name when you assume the role. For more information,
see The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- |
PolicyArns |
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role. This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference. An Amazon Web Services conversion compresses the passed inline
session policy, managed policy ARNs, and session tags into a packed
binary format that has a separate limit. Your request can fail for this
limit even if your plaintext meets the other requirements. The
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. |
Policy |
An IAM policy in JSON format that you want to use as an inline session policy. This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide. The plaintext that you use for both inline and managed session
policies can't exceed 2,048 characters. The JSON policy characters can
be any ASCII character from the space character to the end of the valid
character list ( An Amazon Web Services conversion compresses the passed inline
session policy, managed policy ARNs, and session tags into a packed
binary format that has a separate limit. Your request can fail for this
limit even if your plaintext meets the other requirements. The
For more information about role session permissions, see Session policies. |
DurationSeconds |
The duration, in seconds, of the role session. The value specified can range from 900 seconds (15 minutes) up to the maximum session duration set for the role. The maximum session duration setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting or the administrator setting (whichever is lower), the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. Role chaining limits your Amazon Web Services CLI or Amazon Web
Services API role session to a maximum of one hour. When you use the
By default, the value is set to The |
Tags |
A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging Amazon Web Services STS Sessions in the IAM User Guide. This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide. An Amazon Web Services conversion compresses the passed inline
session policy, managed policy ARNs, and session tags into a packed
binary format that has a separate limit. Your request can fail for this
limit even if your plaintext meets the other requirements. The
You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key. Tag key–value pairs are not case sensitive, but case is preserved.
This means that you cannot have separate Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the IAM User Guide. |
TransitiveTagKeys |
A list of keys for session tags that you want to set as transitive. If you set a tag key as transitive, the corresponding key and value passes to subsequent sessions in a role chain. For more information, see Chaining Roles with Session Tags in the IAM User Guide. This parameter is optional. The transitive status of a session tag does not impact its packed binary size. If you choose not to specify a transitive tag key, then no tags are passed from this session to any subsequent sessions. |
ExternalId |
A unique identifier that might be required when you assume a role
in another account. If the administrator of the account to which the
role belongs provided you with an external ID, then provide that value
in the The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- |
SerialNumber |
The identification number of the MFA device that is associated
with the user who is making the The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- |
TokenCode |
The value provided by the MFA device, if the trust policy of the
role being assumed requires MFA. (In other words, if the policy includes
a condition that tests for MFA). If the role being assumed requires MFA
and if the The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. |
SourceIdentity |
The source identity specified by the principal that is calling
the You can require users to specify a source identity when they assume a
role. You do this by using the The regex used to validate this parameter is a string of characters
consisting of upper- and lower-case alphanumeric characters with no
spaces. You can also include underscores or any of the following
characters: +=,.@-. You cannot use a value that begins with the text
|
ProvidedContexts |
A list of previously acquired trusted context assertions in the format of a JSON array. The trusted context assertion is signed and encrypted by Amazon Web Services STS. The following is an example of a
|
Value¶
A list with the following syntax:
list(
Credentials = list(
AccessKeyId = "string",
SecretAccessKey = "string",
SessionToken = "string",
Expiration = as.POSIXct(
"2015-01-01"
)
),
AssumedRoleUser = list(
AssumedRoleId = "string",
Arn = "string"
),
PackedPolicySize = 123,
SourceIdentity = "string"
)
Request syntax¶
svc$assume_role(
RoleArn = "string",
RoleSessionName = "string",
PolicyArns = list(
list(
arn = "string"
)
),
Policy = "string",
DurationSeconds = 123,
Tags = list(
list(
Key = "string",
Value = "string"
)
),
TransitiveTagKeys = list(
"string"
),
ExternalId = "string",
SerialNumber = "string",
TokenCode = "string",
SourceIdentity = "string",
ProvidedContexts = list(
list(
ProviderArn = "string",
ContextAssertion = "string"
)
)
)
Examples¶
## Not run:
#
svc$assume_role(
ExternalId = "123ABC",
Policy = "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Stmt1\",\"Effect\":\"A...",
RoleArn = "arn:aws:iam::123456789012:role/demo",
RoleSessionName = "testAssumeRoleSession",
Tags = list(
list(
Key = "Project",
Value = "Unicorn"
),
list(
Key = "Team",
Value = "Automation"
),
list(
Key = "Cost-Center",
Value = "12345"
)
),
TransitiveTagKeys = list(
"Project",
"Cost-Center"
)
)
## End(Not run)