Container for the parameters to the GetFederationToken operation.

The GetFederationToken action returns a set of temporary credentials for a federated user with the user name and policy specified in the request. The credentials consist of an Access Key ID, a Secret Access Key, and a security token. The credentials are valid for the specified duration, between one and 36 hours.

The federated user who holds these credentials has any permissions allowed by the intersection of the specified policy and any resource or user policies that apply to the caller of the GetFederationToken API, and any resource policies that apply to the federated user's Amazon Resource Name (ARN). For more information about how token permissions work, see Controlling Permissions in Temporary Credentials in Using AWS Identity and Access Management . For information about using GetFederationToken to create temporary credentials, see Creating Temporary Credentials to Enable Access for Federated Users in Using AWS Identity and Access Management .

Namespace: Amazon.SecurityToken.Model
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public class GetFederationTokenRequest : AmazonWebServiceRequest
Public Class GetFederationTokenRequest _
	Inherits AmazonWebServiceRequest
public ref class GetFederationTokenRequest : public AmazonWebServiceRequest

Members

            
 All Members  Constructors   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
GetFederationTokenRequest()()()()
Initializes a new instance of the GetFederationTokenRequest class
DurationSeconds
The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 3600s (one hour) to 129600s (36 hours), with 43200s (12 hours) as the default.

Constraints:

Range
3600 - 129600

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
Name
The name of the federated user associated with the credentials. For information about limitations on user names, go to Limitations on IAM Entities in Using AWS Identity and Access Management.

Constraints:

Length
2 - 32
Pattern
[\w+=,.@-]*

Policy
A policy specifying the permissions to associate with the credentials. The caller can delegate their own permissions by specifying a policy, and both policies will be checked when a service call is made. For more information about how permissions work in the context of temporary credentials, see Controlling Permissions in Temporary Credentials in Using AWS Identity and Access Management.

Constraints:

Length
1 - 2048
Pattern
[\u0009\u000A\u000D\u0020-\u00FF]+

ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
WithDurationSeconds(Int32)
Sets the DurationSeconds property
WithName(String)
Sets the Name property
WithPolicy(String)
Sets the Policy property

Inheritance Hierarchy

System..::..Object
  Amazon.Runtime..::..AmazonWebServiceRequest
    Amazon.SecurityToken.Model..::..GetFederationTokenRequest

See Also