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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-core/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.

Instance Attribute Summary collapse

Instance Attribute Details

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



833
834
835
836
837
838
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 833

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

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



833
834
835
836
837
838
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 833

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

#packed_policy_sizeInteger

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)


833
834
835
836
837
838
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 833

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