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/access_policies.html#policies_session<br><br><br><br></note>
request are to the upper size limit.
indicates by percentage how close the policies and tags for your
other requirements. The `PackedPolicySize` response element
request can fail for this limit even if your plain text meets the
tags into a packed binary format that has a separate limit. Your
<note markdown=“1”> An AWS conversion compresses the passed session policies and session
(\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 plain text that you use for both inline and managed session<br><br>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>]<br>: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session<br>[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html<br><br><br><br>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>
request are to the upper size limit.
indicates by percentage how close the policies and tags for your
other requirements. The ‘PackedPolicySize` response element
request can fail for this limit even if your plain text meets the
tags into a packed binary format that has a separate limit. Your
<note markdown=“1”> An AWS conversion compresses the passed session policies and session
Service Namespaces] in the AWS General Reference.
information about ARNs, see [Amazon Resource Names (ARNs) and AWS
managed session policies can’t exceed 2,048 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]<br>: docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html<br><br><br><br>Claims][1] in the *IAM User 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”,
],
},
arn: “arnType”,
{
policy_arns: [
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