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 Amazon Web Services credentials that can be used to make Amazon Web Services requests.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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:



1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1605

class GetFederationTokenResponse < Struct.new(
  :credentials,
  :federated_user,
  :packed_policy_size,
  :session_token_utilization,
  :session_token_size)
  SENSITIVE = []
  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:



1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1605

class GetFederationTokenResponse < Struct.new(
  :credentials,
  :federated_user,
  :packed_policy_size,
  :session_token_utilization,
  :session_token_size)
  SENSITIVE = []
  include Aws::Structure
end

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


1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1605

class GetFederationTokenResponse < Struct.new(
  :credentials,
  :federated_user,
  :packed_policy_size,
  :session_token_utilization,
  :session_token_size)
  SENSITIVE = []
  include Aws::Structure
end

#session_token_size ⇒ Integer

The size, in bytes, of the session token returned in the Credentials for this response.

Returns:

  • (Integer) 


1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1605

class GetFederationTokenResponse < Struct.new(
  :credentials,
  :federated_user,
  :packed_policy_size,
  :session_token_utilization,
  :session_token_size)
  SENSITIVE = []
  include Aws::Structure
end

#session_token_utilization ⇒ Integer

The percentage (0-100) of the maximum allowed session token size that the returned session token consumes.

Returns:

  • (Integer) 


1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1605

class GetFederationTokenResponse < Struct.new(
  :credentials,
  :federated_user,
  :packed_policy_size,
  :session_token_utilization,
  :session_token_size)
  SENSITIVE = []
  include Aws::Structure
end