AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GetSessionTokenInput

import "github.com/aws/aws-sdk-go/service/sts"

type GetSessionTokenInput struct { DurationSeconds *int64 `min:"900" type:"integer"` SerialNumber *string `min:"9" type:"string"` TokenCode *string `min:"6" type:"string"` }

DurationSeconds

Type: *int64

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.

SerialNumber

Type: *string

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: =,.@:/-

TokenCode

Type: *string

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.

Method

GoString

func (s GetSessionTokenInput) GoString() string

GoString returns the string representation

SetDurationSeconds

func (s *GetSessionTokenInput) SetDurationSeconds(v int64) *GetSessionTokenInput

SetDurationSeconds sets the DurationSeconds field's value.

SetSerialNumber

func (s *GetSessionTokenInput) SetSerialNumber(v string) *GetSessionTokenInput

SetSerialNumber sets the SerialNumber field's value.

SetTokenCode

func (s *GetSessionTokenInput) SetTokenCode(v string) *GetSessionTokenInput

SetTokenCode sets the TokenCode field's value.

String

func (s GetSessionTokenInput) String() string

String returns the string representation

Validate

func (s *GetSessionTokenInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: