Class: Aws::STS::Types::AssumeRoleWithSAMLRequest

Inherits:

Struct

• Object
• Struct
• Aws::STS::Types::AssumeRoleWithSAMLRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sts/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:saml_assertion]

Instance Attribute Summary

• #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 base64 encoded SAML authentication response provided by the IdP.

Method Summary

Methods included from Aws::Structure

#empty?, included, #initialize, #key?, new, #to_h, #to_s

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.

<note markdown=“1”> The ‘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 Amazon Web Services Management Console] in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html

Returns:

• (Integer)

# File 'lib/aws-sdk-sts/types.rb', line 504

class AssumeRoleWithSAMLRequest < Struct.new(
  :role_arn,
  :principal_arn,
  :saml_assertion,
  :policy_arns,
  :policy,
  :duration_seconds)
  SENSITIVE = [:saml_assertion]
  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 Amazon Web Services 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 plaintext 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.

<note markdown=“1”> An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The ‘PackedPolicySize` response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session

Returns:

• (String)

# File 'lib/aws-sdk-sts/types.rb', line 504

class AssumeRoleWithSAMLRequest < Struct.new(
  :role_arn,
  :principal_arn,
  :saml_assertion,
  :policy_arns,
  :policy,
  :duration_seconds)
  SENSITIVE = [:saml_assertion]
  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 plaintext 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 Amazon Web Services Service Namespaces] in the Amazon Web Services General Reference.

<note markdown=“1”> An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The ‘PackedPolicySize` response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

</note>

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 Amazon Web Services 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*.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session

Returns:

• (Array<Types::PolicyDescriptorType>)

# File 'lib/aws-sdk-sts/types.rb', line 504

class AssumeRoleWithSAMLRequest < Struct.new(
  :role_arn,
  :principal_arn,
  :saml_assertion,
  :policy_arns,
  :policy,
  :duration_seconds)
  SENSITIVE = [:saml_assertion]
  include Aws::Structure
end

#principal_arn ⇒ String

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Returns:

• (String)

# File 'lib/aws-sdk-sts/types.rb', line 504

class AssumeRoleWithSAMLRequest < Struct.new(
  :role_arn,
  :principal_arn,
  :saml_assertion,
  :policy_arns,
  :policy,
  :duration_seconds)
  SENSITIVE = [:saml_assertion]
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Returns:

• (String)

# File 'lib/aws-sdk-sts/types.rb', line 504

class AssumeRoleWithSAMLRequest < Struct.new(
  :role_arn,
  :principal_arn,
  :saml_assertion,
  :policy_arns,
  :policy,
  :duration_seconds)
  SENSITIVE = [:saml_assertion]
  include Aws::Structure
end

#saml_assertion ⇒ String

The base64 encoded SAML authentication response provided by the IdP.

For more information, see [Configuring a Relying Party and Adding Claims] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html

Returns:

• (String)

# File 'lib/aws-sdk-sts/types.rb', line 504

class AssumeRoleWithSAMLRequest < Struct.new(
  :role_arn,
  :principal_arn,
  :saml_assertion,
  :policy_arns,
  :policy,
  :duration_seconds)
  SENSITIVE = [:saml_assertion]
  include Aws::Structure
end