class Aws::STS::Types::AssumeRoleRequest

@see docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleRequest AWS API Documentation
@return [String]
a sequence of six numeric digits.
The format for this parameter, as described by its regex pattern, is
`AssumeRole` call returns an “access denied” error.
MFA and if the ‘TokenCode` value is missing or expired, the
condition that tests for MFA). If the role being assumed requires
role being assumed requires MFA (that is, if the policy includes a
The value provided by the MFA device, if the trust policy of the
@!attribute [rw] token_code
@return [String]
characters: =,.@-
spaces. You can also include underscores or any of the following
consisting of upper- and lower-case alphanumeric characters with no
The regex used to validate this parameter is a string of characters
`arn:aws:iam::123456789012:mfa/user`).
Name (ARN) for a virtual device (such as
for a hardware device (such as `GAHT12345678`) or an Amazon Resource
requires MFA authentication. The value is either the serial number
the trust policy of the role being assumed includes a condition that
the user who is making the `AssumeRole` call. Specify this value if
The identification number of the MFA device that is associated with
@!attribute [rw] serial_number
@return [String] : docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html characters: =,.@:/-
spaces. You can also include underscores or any of the following
consisting of upper- and lower-case alphanumeric characters with no
The regex used to validated this parameter is a string of characters Party] in the *IAM User Guide*.
External ID When Granting Access to Your AWS Resources to a Third
For more information about the external ID, see [How to Use an
to help third parties bind a role to the customer who created it.
pass the customer’s external ID. The external ID is useful in order
generated. Each time the third party assumes the role, they should
role’s trust policy checks for the external ID that the third party
party can assume, they should instruct their customers to ensure the
roles in their customers’ accounts. For each role that the third
A unique identifier that is used by third parties when assuming
@!attribute [rw] external_id
@return [Integer] : docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session </note>
Management Console] in the *IAM User Guide*.
[Creating a URL that Enables Federated Users to Access the AWS
maximum length of the console session. For more information, see
sign-in token takes a ‘SessionDuration` parameter that specifies the
credentials. The request to the federation endpoint for a console
console session that you might request using the returned
<note markdown=“1”> The `DurationSeconds` parameter is separate from the duration of a
By default, the value is set to 3600 seconds.
for a Role] in the *IAM User Guide*.
value for your role, see [View the Maximum Session Duration Setting
6 hours, your operation fails. To learn how to view the maximum
12 hours, but your administrator set the maximum session duration to
operation fails. For example, if you specify a session duration of
12 hours. If you specify a value higher than this setting, the
setting for the role. This setting can have a value from 1 hour to
from 900 seconds (15 minutes) up to the maximum session duration
The duration, in seconds, of the role session. The value can range
@!attribute [rw] duration_seconds
@return [String] : docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html </note>
100% equaling the maximum allowed size.
percentage how close to the upper size limit the policy is, with
separate limit. The PackedPolicySize response element indicates by
internal conversion compresses it into a packed binary format with a
<note markdown=“1”> The policy plain text must be 2048 bytes or shorter. However, an
(\u000D) characters.
include the tab (\u0009), linefeed (\u000A), and carriage return
the end of the valid character list (\u0020-\u00FF). It can also
characters can be any ASCII character from the space character to
a string of characters up to 2048 characters in length. The
The format for this parameter, as described by its regex pattern, is
User Guide*.
AssumeRoleWithSAML, and AssumeRoleWithWebIdentity] in the *IAM
assumed. For more information, see [Permissions for AssumeRole,
of those allowed by the access policy of the role that is being
cannot use the passed policy to grant permissions that are in excess
permissions for the resulting temporary security credentials. You
that you pass. This gives you a way to further restrict the
access policy of the role that is being assumed, and the policy
permissions that are allowed by both (the intersection of) the
security credentials that are returned by the operation have the
This parameter is optional. If you pass a policy, the temporary
An IAM policy in JSON format.
@!attribute [rw] policy
@return [String]
characters: =,.@-
spaces. You can also include underscores or any of the following
consisting of upper- and lower-case alphanumeric characters with no
The regex used to validate this parameter is a string of characters
session name to the external account in their CloudTrail logs.
using the temporary security credentials will expose the role
principal. This means that subsequent cross-account API requests
role session name is also used in the ARN of the assumed role
visible to, and can be logged by the account that owns the role. The
reasons. In cross-account scenarios, the role session name is
same role is assumed by different principals or for different
Use the role session name to uniquely identify a session when the
An identifier for the assumed role session.
@!attribute [rw] role_session_name
@return [String]
The Amazon Resource Name (ARN) of the role to assume.
@!attribute [rw] role_arn
}
token_code: “tokenCodeType”,
serial_number: “serialNumberType”,
external_id: “externalIdType”,
duration_seconds: 1,
policy: “sessionPolicyDocumentType”,
role_session_name: “roleSessionNameType”, # required
role_arn: “arnType”, # required
{
data as a hash:
@note When making an API call, you may pass AssumeRoleRequest

class Aws::STS::Types::AssumeRoleRequest

Namespace

Included Modules

Defined in