Class: Aws::STS::Types::AssumeRoleResponse

Inherits:

Struct

• Object
• Struct
• Aws::STS::Types::AssumeRoleResponse

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sts/types.rb

Overview

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

See Also:

• AWS API Documentation

Instance Attribute Summary

• #assumed_role_user ⇒ Types::AssumedRoleUser

  The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials.

• #credentials ⇒ Types::Credentials

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

• #packed_policy_size ⇒ Integer

  A percentage value that indicates the size of the policy in packed form.

Method Summary

Methods included from Aws::Structure

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

Instance Attribute Details

#assumed_role_user ⇒ Types::AssumedRoleUser

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the ‘RoleSessionName` that you specified when you called `AssumeRole`.

Returns:

• (Types::AssumedRoleUser)

# File 'lib/aws-sdk-sts/types.rb', line 202

class AssumeRoleResponse < Struct.new(
  :credentials,
  :assumed_role_user,
  :packed_policy_size)
  include Aws::Structure
end

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

• (Types::Credentials)

# File 'lib/aws-sdk-sts/types.rb', line 202

class AssumeRoleResponse < Struct.new(
  :credentials,
  :assumed_role_user,
  :packed_policy_size)
  include Aws::Structure
end

#packed_policy_size ⇒ Integer

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

Returns:

• (Integer)

# File 'lib/aws-sdk-sts/types.rb', line 202

class AssumeRoleResponse < Struct.new(
  :credentials,
  :assumed_role_user,
  :packed_policy_size)
  include Aws::Structure
end