kotovalexarian-likes-github/fog--fog
1
0
Fork 0
mirror of https://github.com/fog/fog.git synced 2022-11-09 13:51:43 -05:00
Code Releases Activity

Add minimal documentation in GetFederationToken request

Browse source
This commit is contained in:
gregburek 2013-09-04 18:05:39 -07:00
parent 98a72c018b
commit b6f5165a5b
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
lib/fog/aws/requests/sts/get_federation_token.rb
View file

@ -5,6 +5,31 @@ module Fog
require 'fog/aws/parsers/sts/get_session_token'
# Get federation token
#
# ==== Parameters
# * name<~String>: The name of the federated user.
# Minimum length of 2. Maximum length of 32.
# * policy<~String>: Optional policy that specifies the permissions
# that are granted to the federated user
# Minimum length of 1. Maximum length of 2048.
# * duration<~Integer>: Optional duration, in seconds, that the session
# should last.
# ==== Returns
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'SessionToken'<~String> -
# * 'SecretAccessKey'<~String> -
# * 'Expiration'<~String> -
# * 'AccessKeyId'<~String> -
# * 'Arn'<~String> -
# * 'FederatedUserId'<~String> -
# * 'PackedPolicySize'<~String> -
# * 'RequestId'<~String> - Id of the request
#
# ==== See Also
# http://docs.aws.amazon.com/STS/latest/APIReference/API_GetFederationToken.html
def get_federation_token(name, policy, duration=43200)
request({
'Action' => 'GetFederationToken',