Network.AWS.STS.AssumeRole

Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use AssumeRole for cross-account access or federation.

Important: You cannot call AssumeRole by using AWS account credentials; access will be denied. You must use IAM user credentials or temporary security credentials to call AssumeRole.

For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see IAM Roles (Delegation and Federation) in Using IAM.

For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call AssumeRole (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see Scenarios for Granting Temporary Access in Using Temporary Security Credentials.

The temporary security credentials are valid for the duration that you specified when calling AssumeRole, which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). The default is 1 hour.

Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in Using Temporary Security Credentials.

To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. You must also have a policy that allows you to call 'sts:AssumeRole'.

Using MFA with AssumeRole

You can optionally include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS 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 Using IAM guide.

To use MFA with AssumeRole, 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 devices produces.

See: AWS API Reference for AssumeRole.

Creating a Request

assumeRole

Arguments

:: Text

arRoleARN

-> Text

arRoleSessionName

-> AssumeRole

Creates a value of AssumeRole with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• arTokenCode
• arDurationSeconds
• arPolicy
• arExternalId
• arSerialNumber
• arRoleARN
• arRoleSessionName

data AssumeRole

See: assumeRole smart constructor.

Instances

Eq AssumeRole

Data AssumeRole

Read AssumeRole

Show AssumeRole

Generic AssumeRole

AWSRequest AssumeRole

ToPath AssumeRole

ToHeaders AssumeRole

ToQuery AssumeRole

Typeable * AssumeRole

type Rep AssumeRole

type Rs AssumeRole = AssumeRoleResponse

Request Lenses

arTokenCode :: Lens' AssumeRole (Maybe Text)

The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the TokenCode value is missing or expired, the AssumeRole call returns an "access denied" error.

arDurationSeconds :: Lens' AssumeRole (Maybe Natural)

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

arPolicy :: Lens' AssumeRole (Maybe Text)

An IAM policy in JSON format.

This parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both (the intersection of) the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in Using Temporary Security Credentials.

The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

arExternalId :: Lens' AssumeRole (Maybe Text)

A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use External ID When Granting Access to Your AWS Resources in Using Temporary Security Credentials.

arSerialNumber :: Lens' AssumeRole (Maybe Text)

The identification number of the MFA device that is associated with the user who is making the AssumeRole call. Specify this value if the trust policy of the role being assumed includes a condition 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').

arRoleARN :: Lens' AssumeRole Text

The Amazon Resource Name (ARN) of the role to assume.

arRoleSessionName :: Lens' AssumeRole Text

An identifier for the assumed role session.

Use the role session name to uniquely identity 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 using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.

Destructuring the Response

assumeRoleResponse

Arguments

:: Int

arrsResponseStatus

-> AssumeRoleResponse

Creates a value of AssumeRoleResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• arrsPackedPolicySize
• arrsCredentials
• arrsAssumedRoleUser
• arrsResponseStatus

data AssumeRoleResponse

Contains the response to a successful AssumeRole request, including temporary AWS credentials that can be used to make AWS requests.

See: assumeRoleResponse smart constructor.

Instances

Eq AssumeRoleResponse

Data AssumeRoleResponse

Read AssumeRoleResponse

Show AssumeRoleResponse

Generic AssumeRoleResponse

Typeable * AssumeRoleResponse

type Rep AssumeRoleResponse

Response Lenses

arrsPackedPolicySize :: Lens' AssumeRoleResponse (Maybe Natural)

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

arrsCredentials :: Lens' AssumeRoleResponse (Maybe Credentials)

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

arrsAssumedRoleUser :: Lens' AssumeRoleResponse (Maybe AssumedRoleUser)

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

arrsResponseStatus :: Lens' AssumeRoleResponse Int

The response status code.