class Aws::STS::Types::AssumeRoleRequest

@see docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleRequest AWS API Documentation
@return [Array<Types::ProvidedContext>] ‘`
generated.
context provider from which the trusted context assertion was
includes a single trusted context assertion and the ARN of the
The following is an example of a `ProvidedContext` value that
encrypted by Amazon Web Services STS.
format of a JSON array. The trusted context assertion is signed and
A list of previously acquired trusted context assertions in the
@!attribute [rw] provided_contexts
@return [String] : docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html use.
`aws:`. This prefix is reserved for Amazon Web Services internal
characters: =,.@-. You cannot use a value that begins with the text
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
*IAM User Guide*.
[Monitor and control actions taken with assumed roles] in the
identity. For more information about using source identity, see
to Amazon Web Services resources based on the value of source
use the `aws:SourceIdentity` condition key to further control access
CloudTrail logs to determine who took actions with a role. You can
in a role trust policy. You can use source identity information in
a role. You do this by using the `sts:SourceIdentity` condition key
You can require users to specify a source identity when they assume
`AssumeRole` operation.
The source identity specified by the principal that is calling the
@!attribute [rw] source_identity
@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.
requires MFA and if the `TokenCode` value is missing or expired, the
includes a condition that tests for MFA). If the role being assumed
role being assumed requires MFA. (In other words, if the policy
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
Resources to a Third Party] in the *IAM User Guide*.
an External ID When Granting Access to Your Amazon Web Services
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 [Array<String>] : docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining passed from this session to any subsequent sessions.
If you choose not to specify a transitive tag key, then no tags are
affected.
the session policy and session tags packed binary limit is not
This parameter is optional. When you set session tags as transitive,
see [Chaining Roles with Session Tags] in the *IAM User Guide*.
passes to subsequent sessions in a role chain. For more information,
If you set a tag key as transitive, the corresponding key and value
A list of keys for session tags that you want to set as transitive.
@!attribute [rw] transitive_tag_keys
@return [Array<Types::Tag>] : docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_ctlogs [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html [Viewing Session Tags in CloudTrail] in the *IAM User Guide*.
for a session, see the CloudTrail logs. For more information, see
an inherited tag, the operation fails. To view the inherited tags
the calling session. If you pass a session tag with the same key as
operation, the new session inherits any transitive session tags from
Additionally, if you used temporary credentials to perform this
passed in the request takes precedence over the role tag.
`department` are not saved as separate tags, and the session tag
`department`=`engineering` session tag. `Department` and
`Department`=`Marketing` tag and you pass the
`department` tag keys. Assume that the role has the
This means that you cannot have separate `Department` and
Tag key–value pairs are not case sensitive, but case is preserved.
role tag with the same key.
already attached to the role. When you do, session tags override a
You can pass a session tag with the same key as a tag that is
</note>
limit.
close the policies and tags for your request are to the upper size
`PackedPolicySize` response element indicates by percentage how
this limit even if your plaintext meets the other requirements. The
binary format that has a separate limit. Your request can fail for
session policy, managed policy ARNs, and session tags into a packed
<note markdown=“1”> An Amazon Web Services conversion compresses the passed inline
see [IAM and STS Character Limits] in the *IAM User Guide*.
values can’t exceed 256 characters. For these and additional limits,
plaintext session tag keys can’t exceed 128 characters, and the
This parameter is optional. You can pass up to 50 session tags. The Sessions] in the *IAM User Guide*.
about session tags, see [Tagging Amazon Web Services STS
consists of a key name and an associated value. For more information
A list of session tags that you want to pass. Each session tag
@!attribute [rw] tags
@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>
Web Services Management Console] in the *IAM User Guide*.
[Creating a URL that Enables Federated Users to Access the Amazon
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.
in the *IAM User Guide*.
role, see [View the Maximum Session Duration Setting for a Role][1]
operation fails. To learn how to view the maximum value for your
`DurationSeconds` parameter value greater than one hour, the
However, if you assume a role using role chaining and provide a
depending on the maximum session duration setting for your role.
You can specify a parameter value of up to 43200 seconds (12 hours),
duration of your role session with the `DurationSeconds` parameter.
`AssumeRole` API operation to assume a role, you can specify the
Services API role session to a maximum of one hour. When you use the
Role chaining limits your Amazon Web Services CLI or Amazon Web
to 6 hours, your operation fails.
of 12 hours, but your administrator set the maximum session duration
the operation fails. For example, if you specify a session duration
than this setting or the administrator setting (whichever is lower),
have a value from 1 hour to 12 hours. If you specify a value higher
duration set for the role. The maximum session duration setting can
can range from 900 seconds (15 minutes) up to the maximum session
The duration, in seconds, of the role session. The value specified
@!attribute [rw] duration_seconds
@return [String] : docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session </note>
limit.
close the policies and tags for your request are to the upper size
`PackedPolicySize` response element indicates by percentage how
this limit even if your plaintext meets the other requirements. The
binary format that has a separate limit. Your request can fail for
session policy, managed policy ARNs, and session tags into a packed
<note markdown=“1”> An Amazon Web Services conversion compresses the passed inline
(\u000D) characters.
include the tab (\u0009), linefeed (\u000A), and carriage return
the valid character list (\u0020 through \u00FF). It can also
can be any ASCII character from the space character to the end of
policies can’t exceed 2,048 characters. The JSON policy characters
The plaintext that you use for both inline and managed session
information, see [Session Policies] in the *IAM User Guide*.
identity-based policy of the role that is being assumed. For more
policies to grant more permissions than those allowed by the
resources in the account that owns the role. You cannot use session
credentials in subsequent Amazon Web Services API calls to access
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*.
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
subsequent Amazon Web Services API calls to access resources in the
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>
limit.
close the policies and tags for your request are to the upper size
`PackedPolicySize` response element indicates by percentage how
this limit even if your plaintext meets the other requirements. The
binary format that has a separate limit. Your request can fail for
session policy, managed policy ARNs, and session tags into a packed
<note markdown=“1”> An Amazon Web Services conversion compresses the passed inline
General Reference.
Web Services Service Namespaces] in the Amazon Web Services
information about ARNs, see [Amazon Resource Names (ARNs) and Amazon
managed session policies can’t exceed 2,048 characters. For more
ARNs. However, the plaintext 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 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

class Aws::STS::Types::AssumeRoleRequest

Namespace

Included Modules

Defined in