NAME

Paws::STS::GetSessionToken - Arguments for method GetSessionToken on Paws::STS

DESCRIPTION

This class represents the parameters used for calling the method GetSessionToken on the AWS Security Token Service service. Use the attributes of this class as arguments to method GetSessionToken.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSessionToken.

SYNOPSIS

    my $sts = Paws->service('STS');
    # To get temporary credentials for an IAM user or an AWS account
    my $GetSessionTokenResponse = $sts->GetSessionToken(
      'DurationSeconds' => 3600,
      'SerialNumber'    => 'YourMFASerialNumber',
      'TokenCode'       => 123456
    );

    # Results:
    my $Credentials = $GetSessionTokenResponse->Credentials;

    # Returns a L<Paws::STS::GetSessionTokenResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/sts/GetSessionToken

ATTRIBUTES

DurationSeconds => Int

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

SerialNumber => Str

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 validate 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 => Str

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, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives 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.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetSessionToken in Paws::STS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues