From b6f5165a5bce6d4463b8565302ea92360ef78135 Mon Sep 17 00:00:00 2001 From: gregburek Date: Wed, 4 Sep 2013 18:05:39 -0700 Subject: [PATCH] Add minimal documentation in GetFederationToken request --- .../aws/requests/sts/get_federation_token.rb | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/lib/fog/aws/requests/sts/get_federation_token.rb b/lib/fog/aws/requests/sts/get_federation_token.rb index a161630f6..05d1a6748 100644 --- a/lib/fog/aws/requests/sts/get_federation_token.rb +++ b/lib/fog/aws/requests/sts/get_federation_token.rb @@ -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',