Class: Aws::STS::Types::AssumeRoleWithSAMLRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::STS::Types::AssumeRoleWithSAMLRequest
- Defined in:
- gems/aws-sdk-core/lib/aws-sdk-sts/types.rb
Overview
When making an API call, you may pass AssumeRoleWithSAMLRequest data as a hash:
{
role_arn: "arnType", # required
principal_arn: "arnType", # required
saml_assertion: "SAMLAssertionType", # required
policy_arns: [
{
arn: "arnType",
},
],
policy: "sessionPolicyDocumentType",
duration_seconds: 1,
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#duration_seconds ⇒ Integer
The duration, in seconds, of the role session.
-
#policy ⇒ String
An IAM policy in JSON format that you want to use as an inline session policy.
-
#policy_arns ⇒ Array<Types::PolicyDescriptorType>
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.
-
#principal_arn ⇒ String
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the role that the caller is assuming.
-
#saml_assertion ⇒ String
The base-64 encoded SAML authentication response provided by the IdP.
Instance Attribute Details
#duration_seconds ⇒ Integer
The duration, in seconds, of the role session. Your role session
lasts for the duration that you specify for the DurationSeconds
parameter, or until the time specified in the SAML authentication
response's SessionNotOnOrAfter
value, whichever is shorter. You
can provide a DurationSeconds
value from 900 seconds (15 minutes)
up to the maximum session duration setting for the role. This
setting can have a value from 1 hour to 12 hours. If you specify a
value higher than this setting, the operation fails. For example, if
you specify a session duration of 12 hours, but your administrator
set the maximum session duration to 6 hours, your operation fails.
To learn how to view the maximum value for your role, see View the
Maximum Session Duration Setting for a Role in the IAM User
Guide.
By default, the value is set to 3600
seconds.
DurationSeconds
parameter is separate from the duration of a
console session that you might request using the returned
credentials. The request to the federation endpoint for a console
sign-in token takes a SessionDuration
parameter that specifies the
maximum length of the console session. For more information, see
Creating a URL that Enables Federated Users to Access the AWS
Management Console in the IAM User Guide.
475 476 477 478 479 480 481 482 483 484 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 475 class AssumeRoleWithSAMLRequest < Struct.new( :role_arn, :principal_arn, :saml_assertion, :policy_arns, :policy, :duration_seconds) SENSITIVE = [] include Aws::Structure end |
#policy ⇒ String
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plain text that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
PackedPolicySize
response element
indicates by percentage how close the policies and tags for your
request are to the upper size limit.
475 476 477 478 479 480 481 482 483 484 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 475 class AssumeRoleWithSAMLRequest < Struct.new( :role_arn, :principal_arn, :saml_assertion, :policy_arns, :policy, :duration_seconds) SENSITIVE = [] include Aws::Structure end |
#policy_arns ⇒ Array<Types::PolicyDescriptorType>
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
PackedPolicySize
response element
indicates by percentage how close the policies and tags for your
request are to the upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
475 476 477 478 479 480 481 482 483 484 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 475 class AssumeRoleWithSAMLRequest < Struct.new( :role_arn, :principal_arn, :saml_assertion, :policy_arns, :policy, :duration_seconds) SENSITIVE = [] include Aws::Structure end |
#principal_arn ⇒ String
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
475 476 477 478 479 480 481 482 483 484 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 475 class AssumeRoleWithSAMLRequest < Struct.new( :role_arn, :principal_arn, :saml_assertion, :policy_arns, :policy, :duration_seconds) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the role that the caller is assuming.
475 476 477 478 479 480 481 482 483 484 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 475 class AssumeRoleWithSAMLRequest < Struct.new( :role_arn, :principal_arn, :saml_assertion, :policy_arns, :policy, :duration_seconds) SENSITIVE = [] include Aws::Structure end |
#saml_assertion ⇒ String
The base-64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
475 476 477 478 479 480 481 482 483 484 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 475 class AssumeRoleWithSAMLRequest < Struct.new( :role_arn, :principal_arn, :saml_assertion, :policy_arns, :policy, :duration_seconds) SENSITIVE = [] include Aws::Structure end |