Class: Aws::STS::Types::GetFederationTokenRequest

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 GetFederationTokenRequest data as a hash:

{
  name: "userNameType", # 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, #to_s

Instance Attribute Details

#duration_seconds ⇒ Integer

The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.

Returns:

  • (Integer) 


821
822
823
824
825
826
 
# File 'lib/aws-sdk-sts/types.rb', line 821

class GetFederationTokenRequest < Struct.new(
  :name,
  :policy,
  :duration_seconds)
  include Aws::Structure
end

#name ⇒ String

The name of the federated user. The name is used as an identifier for the temporary security credentials (such as ‘Bob`). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

Returns:

  • (String) 


821
822
823
824
825
826
 
# File 'lib/aws-sdk-sts/types.rb', line 821

class GetFederationTokenRequest < Struct.new(
  :name,
  :policy,
  :duration_seconds)
  include Aws::Structure
end

#policy ⇒ String

An IAM policy in JSON format that is passed with the ‘GetFederationToken` call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call `GetFederationToken`. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.

If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.

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>

For more information about how permissions work, see [Permissions for GetFederationToken].

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

Returns:

  • (String) 


821
822
823
824
825
826
 
# File 'lib/aws-sdk-sts/types.rb', line 821

class GetFederationTokenRequest < Struct.new(
  :name,
  :policy,
  :duration_seconds)
  include Aws::Structure
end