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 validate this parameter is a string of characters Party] in the *IAM User Guide*.
an External ID When Granting Access to Your AWS Resources to a Third
account. For more information about the external ID, see [How to Use
with the ID can assume the role, rather than everyone in the
the administrator of the trusted account. That way, only someone
administrator of the trusting account might send an external ID to
usually set up to trust everyone in an account. Therefore, the
such as a passphrase or account number. A cross-account role is
value in the `ExternalId` parameter. This value can be any string,
role belongs provided you with an external ID, then provide that
another account. If the administrator of the account to which the
A unique identifier that might be required when you assume a role in
@!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/access_policies.html#policies_session </note>
size limit.
element indicates by percentage how close the policy is to the upper
limit. This is the enforced limit. The `PackedPolicySize` response
session policies into a packed binary format that has a separate
session policy guideline. However, an AWS conversion compresses the
<note markdown=“1”> The characters in this parameter count towards the 2048 character
return (\u000D) characters.
can also include the tab (\u0009), linefeed (\u000A), and carriage
the end of the valid character list (\u0020 through \u00FF). It
characters can be any ASCII character from the space character to
policies shouldn’t exceed 2048 characters. The JSON policy
The plain text that you use for both inline and managed session Policies] in the *IAM User Guide*.
the role that is being assumed. For more information, see [Session
more permissions than those allowed by the identity-based policy of
account that owns the role. You cannot use session policies to grant
credentials in subsequent AWS API calls to access resources in the
policy and the session policies. You can use the role’s temporary
permissions are the intersection of the role’s identity-based
returns new temporary credentials. The resulting session’s
This parameter is optional. Passing policies to this operation
session policy.
An IAM policy in JSON format that you want to use as an inline
@!attribute [rw] policy
@return [Array<Types::PolicyDescriptorType>] : docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Policies][2] in the *IAM User Guide*.
role that is being assumed. For more information, see [Session
permissions than those allowed by the identity-based policy of the
owns the role. You cannot use session policies to grant more
subsequent AWS API calls to access resources in the account that
policies. You can use the role’s temporary credentials in
intersection of the role’s identity-based policy and the session
credentials. The resulting session’s permissions are the
Passing policies to this operation returns new temporary
</note>
size limit.
element indicates by percentage how close the policy is to the upper
limit. This is the enforced limit. The ‘PackedPolicySize` response
session policies into a packed binary format that has a separate
session policy guideline. However, an AWS conversion compresses the
<note markdown=“1”> The characters in this parameter count towards the 2048 character
Service Namespaces] in the AWS General Reference.
information about ARNs, see [Amazon Resource Names (ARNs) and AWS
managed session policies shouldn’t exceed 2048 characters. For more
ARNs. However, the plain text that you use for both inline and
This parameter is optional. You can provide up to 10 managed policy
in the same account as the role.
you want to use as managed session policies. The policies must exist
The Amazon Resource Names (ARNs) of the IAM managed policies that
@!attribute [rw] policy_arns
@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 AWS CloudTrail logs.
that use 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”,
],
},
arn: “arnType”,
{
policy_arns: [
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