File Coverage

blib/lib/Paws/STS/GetSessionToken.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::STS::GetSessionToken;
3 1     1   273 use Moose;
  1     1   2  
  1         7  
  1         448  
  1         3  
  1         8  
4             has DurationSeconds => (is => 'ro', isa => 'Int');
5             has SerialNumber => (is => 'ro', isa => 'Str');
6             has TokenCode => (is => 'ro', isa => 'Str');
7              
8 1     1   5351 use MooseX::ClassAttribute;
  1     1   2  
  1         6  
  1         5883  
  1         2  
  1         5  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetSessionToken');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::STS::GetSessionTokenResponse');
12             class_has _result_key => (isa => 'Str', is => 'ro', default => 'GetSessionTokenResult');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::STS::GetSessionToken - Arguments for method GetSessionToken on Paws::STS
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method GetSessionToken on the
24             AWS Security Token Service service. Use the attributes of this class
25             as arguments to method GetSessionToken.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSessionToken.
28              
29             As an example:
30              
31             $service_obj->GetSessionToken(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 DurationSeconds => Int
39              
40             The duration, in seconds, that the credentials should remain valid.
41             Acceptable durations for IAM user sessions range from 900 seconds (15
42             minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as
43             the default. Sessions for AWS account owners are restricted to a
44             maximum of 3600 seconds (one hour). If the duration is longer than one
45             hour, the session for AWS account owners defaults to one hour.
46              
47              
48              
49             =head2 SerialNumber => Str
50              
51             The identification number of the MFA device that is associated with the
52             IAM user who is making the C<GetSessionToken> call. Specify this value
53             if the IAM user has a policy that requires MFA authentication. The
54             value is either the serial number for a hardware device (such as
55             C<GAHT12345678>) or an Amazon Resource Name (ARN) for a virtual device
56             (such as C<arn:aws:iam::123456789012:mfa/user>). You can find the
57             device for an IAM user by going to the AWS Management Console and
58             viewing the user's security credentials.
59              
60             The regex used to validated this parameter is a string of characters
61             consisting of upper- and lower-case alphanumeric characters with no
62             spaces. You can also include underscores or any of the following
63             characters: =,.@:/-
64              
65              
66              
67             =head2 TokenCode => Str
68              
69             The value provided by the MFA device, if MFA is required. If any policy
70             requires the IAM user to submit an MFA code, specify this value. If MFA
71             authentication is required, and the user does not provide a code when
72             requesting a set of temporary security credentials, the user will
73             receive an "access denied" response when requesting resources that
74             require MFA authentication.
75              
76             The format for this parameter, as described by its regex pattern, is a
77             sequence of six numeric digits.
78              
79              
80              
81              
82             =head1 SEE ALSO
83              
84             This class forms part of L<Paws>, documenting arguments for method GetSessionToken in L<Paws::STS>
85              
86             =head1 BUGS and CONTRIBUTIONS
87              
88             The source code is located here: https://github.com/pplu/aws-sdk-perl
89              
90             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
91              
92             =cut
93