You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::STS::Types::GetFederationTokenResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains the response to a successful GetFederationToken request, including temporary AWS credentials that can be used to make AWS requests.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#credentials ⇒ Types::Credentials

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

Returns:

  • (Types::Credentials) —

    The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

#federated_user ⇒ Types::FederatedUser

Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user\'s ARN in your resource-based policies, such as an Amazon S3 bucket policy.

Returns:

  • (Types::FederatedUser) —

    Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob).

#packed_policy_size ⇒ Integer

A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

Returns:

  • (Integer) —

    A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.