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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sts/types.rb

Overview

Note:

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: "sessionPolicyDocumentType",
  duration_seconds: 1,
}

See Also:

Instance Attribute Summary collapse

Method Summary

Methods included from Aws::Structure

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

Instance Attribute Details

#duration_seconds ⇒ Integer

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response’s ‘SessionNotOnOrAfter` value. The actual expiration time is whichever value is shorter.

<note markdown=“1”> This 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, separately from the `DurationSeconds` parameter on this API. For more information, see [Enabling SAML 2.0 Federated Users to Access the AWS Management Console] in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html

Returns:

  • (Integer) 


294
295
296
297
298
299
300
301
 
# File 'lib/aws-sdk-sts/types.rb', line 294

class AssumeRoleWithSAMLRequest < Struct.new(
  :role_arn,
  :principal_arn,
  :saml_assertion,
  :policy,
  :duration_seconds)
  include Aws::Structure
end

#policy ⇒ String

An IAM policy in JSON format.

The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, [Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity] in the *IAM User Guide*.

The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.

<note markdown=“1”> The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html

Returns:

  • (String) 


294
295
296
297
298
299
300
301
 
# File 'lib/aws-sdk-sts/types.rb', line 294

class AssumeRoleWithSAMLRequest < Struct.new(
  :role_arn,
  :principal_arn,
  :saml_assertion,
  :policy,
  :duration_seconds)
  include Aws::Structure
end

#principal_arn ⇒ String

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

Returns:

  • (String) 


294
295
296
297
298
299
300
301
 
# File 'lib/aws-sdk-sts/types.rb', line 294

class AssumeRoleWithSAMLRequest < Struct.new(
  :role_arn,
  :principal_arn,
  :saml_assertion,
  :policy,
  :duration_seconds)
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

  • (String) 


294
295
296
297
298
299
300
301
 
# File 'lib/aws-sdk-sts/types.rb', line 294

class AssumeRoleWithSAMLRequest < Struct.new(
  :role_arn,
  :principal_arn,
  :saml_assertion,
  :policy,
  :duration_seconds)
  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 *Using IAM* guide.

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

Returns:

  • (String) 


294
295
296
297
298
299
300
301
 
# File 'lib/aws-sdk-sts/types.rb', line 294

class AssumeRoleWithSAMLRequest < Struct.new(
  :role_arn,
  :principal_arn,
  :saml_assertion,
  :policy,
  :duration_seconds)
  include Aws::Structure
end