class Aws::STS::Types::AssumeRoleWithSAMLRequest

@see docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithSAMLRequest AWS API Documentation
@return [Integer]<br>: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html<br>[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session<br><br><br><br></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.
Guide*.
Maximum Session Duration Setting for a Role] in the *IAM User
To learn how to view the maximum value for your role, see [View the
set the maximum session duration to 6 hours, your operation fails.
you specify a session duration of 12 hours, but your administrator
value higher than this setting, the operation fails. For example, if
setting can have a value from 1 hour to 12 hours. If you specify a
up to the maximum session duration setting for the role. This
can provide a `DurationSeconds` value from 900 seconds (15 minutes)
response’s ‘SessionNotOnOrAfter` value, whichever is shorter. You
parameter, or until the time specified in the SAML authentication
lasts for the duration that you specify for the `DurationSeconds`
The duration, in seconds, of the role session. Your role session
@!attribute [rw] duration_seconds
@return [String]<br>: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html<br><br><br><br></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
and AssumeRoleWithWebIdentity] in the *IAM User Guide*.
more information, [Permissions for AssumeRole, AssumeRoleWithSAML,
allowed by the access policy of the role that is being assumed. For
passed policy to grant permissions that are in excess of those
for the resulting temporary security credentials. You cannot use the
you pass. This gives you a way to further restrict the permissions
the role that is being assumed, and the policy that
have the permissions that are allowed by both the access policy of
temporary security credentials that are returned by the operation
The policy parameter is optional. If you pass a policy, the
An IAM policy in JSON format.
@!attribute [rw] policy
@return [String]<br>: docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html<br><br><br><br>Claims][1] in the *Using IAM* guide.
For more information, see [Configuring a Relying Party and Adding
IdP.
The base-64 encoded SAML authentication response provided by the
@!attribute [rw] saml_assertion
@return [String]
describes the IdP.
The Amazon Resource Name (ARN) of the SAML provider in IAM that
@!attribute [rw] principal_arn
@return [String]
assuming.
The Amazon Resource Name (ARN) of the role that the caller is
@!attribute [rw] role_arn
}
duration_seconds: 1,
policy: “sessionPolicyDocumentType”,
saml_assertion: “SAMLAssertionType”, # required
principal_arn: “arnType”, # required
role_arn: “arnType”, # required
{
data as a hash:
@note When making an API call, you may pass AssumeRoleWithSAMLRequest