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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sts/types.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Method Summary

Methods included from Aws::Structure

#empty?, included, #initialize, #key?, new, #to_h, #to_s

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.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

Returns:



858
859
860
861
862
863
 
# File 'lib/aws-sdk-sts/types.rb', line 858

class GetFederationTokenResponse < Struct.new(
  :credentials,
  :federated_user,
  :packed_policy_size)
  include Aws::Structure
end

#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:



858
859
860
861
862
863
 
# File 'lib/aws-sdk-sts/types.rb', line 858

class GetFederationTokenResponse < Struct.new(
  :credentials,
  :federated_user,
  :packed_policy_size)
  include Aws::Structure
end

#packed_policy_size ⇒ Integer

A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.

Returns:

  • (Integer) 


858
859
860
861
862
863
 
# File 'lib/aws-sdk-sts/types.rb', line 858

class GetFederationTokenResponse < Struct.new(
  :credentials,
  :federated_user,
  :packed_policy_size)
  include Aws::Structure
end