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

Class: Aws::STS::Types::GetSessionTokenRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-core/lib/aws-sdk-sts/types.rb

Overview

Note:

When making an API call, you may pass GetSessionTokenRequest data as a hash:

{
  duration_seconds: 1,
  serial_number: "serialNumberType",
  token_code: "tokenCodeType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#duration_secondsInteger

The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.

Returns:

  • (Integer)


889
890
891
892
893
894
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 889

class GetSessionTokenRequest < Struct.new(
  :duration_seconds,
  :serial_number,
  :token_code)
  include Aws::Structure
end

#serial_numberString

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

The regex used to validated this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Returns:

  • (String)


889
890
891
892
893
894
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 889

class GetSessionTokenRequest < Struct.new(
  :duration_seconds,
  :serial_number,
  :token_code)
  include Aws::Structure
end

#token_codeString

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an "access denied" response when requesting resources that require MFA authentication.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

Returns:

  • (String)


889
890
891
892
893
894
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 889

class GetSessionTokenRequest < Struct.new(
  :duration_seconds,
  :serial_number,
  :token_code)
  include Aws::Structure
end