Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Paws::STS::GetFederatiUserkContributed Perl DoPaws::STS::GetFederationToken(3)

NAME
       Paws::STS::GetFederationToken - Arguments for method GetFederationToken
       on Paws::STS

DESCRIPTION
       This class represents the parameters used for calling the method
       GetFederationToken on the AWS Security Token Service service. Use the
       attributes of this class	as arguments to	method GetFederationToken.

       You shouln't make instances of this class. Each attribute should	be
       used as a named argument	in the call to GetFederationToken.

       As an example:

	 $service_obj->GetFederationToken(Att1 => $value1, Att2	=> $value2, ...);

       Values for attributes that are native types (Int, String, Float,	etc)
       can passed as-is	(scalar	values). Values	for complex Types (objects)
       can be passed as	a HashRef. The keys and	values of the hashref will be
       used to instance	the underlying object.

ATTRIBUTES
   DurationSeconds => Int
       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.

   REQUIRED Name => Str
       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.

   Policy => Str
       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 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.

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

SEE ALSO
       This class forms	part of	Paws, documenting arguments for	method
       GetFederationToken in Paws::STS

BUGS and CONTRIBUTIONS
       The source code is located here:	https://github.com/pplu/aws-sdk-perl

       Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

perl v5.24.1			  2015-08-06  Paws::STS::GetFederationToken(3)

NAME | DESCRIPTION | ATTRIBUTES | SEE ALSO | BUGS and CONTRIBUTIONS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Paws::STS::GetFederationToken&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help