line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
|
2
|
|
|
|
|
|
|
package Paws::STS::AssumeRoleWithSAML; |
3
|
1
|
|
|
1
|
|
278
|
use Moose; |
|
1
|
|
|
|
|
2
|
|
|
1
|
|
|
|
|
8
|
|
4
|
|
|
|
|
|
|
has DurationSeconds => (is => 'ro', isa => 'Int'); |
5
|
|
|
|
|
|
|
has Policy => (is => 'ro', isa => 'Str'); |
6
|
|
|
|
|
|
|
has PrincipalArn => (is => 'ro', isa => 'Str', required => 1); |
7
|
|
|
|
|
|
|
has RoleArn => (is => 'ro', isa => 'Str', required => 1); |
8
|
|
|
|
|
|
|
has SAMLAssertion => (is => 'ro', isa => 'Str', required => 1); |
9
|
|
|
|
|
|
|
|
10
|
1
|
|
|
1
|
|
5384
|
use MooseX::ClassAttribute; |
|
1
|
|
|
|
|
2
|
|
|
1
|
|
|
|
|
8
|
|
11
|
|
|
|
|
|
|
|
12
|
|
|
|
|
|
|
class_has _api_call => (isa => 'Str', is => 'ro', default => 'AssumeRoleWithSAML'); |
13
|
|
|
|
|
|
|
class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::STS::AssumeRoleWithSAMLResponse'); |
14
|
|
|
|
|
|
|
class_has _result_key => (isa => 'Str', is => 'ro', default => 'AssumeRoleWithSAMLResult'); |
15
|
|
|
|
|
|
|
1; |
16
|
|
|
|
|
|
|
|
17
|
|
|
|
|
|
|
### main pod documentation begin ### |
18
|
|
|
|
|
|
|
|
19
|
|
|
|
|
|
|
=head1 NAME |
20
|
|
|
|
|
|
|
|
21
|
|
|
|
|
|
|
Paws::STS::AssumeRoleWithSAML - Arguments for method AssumeRoleWithSAML on Paws::STS |
22
|
|
|
|
|
|
|
|
23
|
|
|
|
|
|
|
=head1 DESCRIPTION |
24
|
|
|
|
|
|
|
|
25
|
|
|
|
|
|
|
This class represents the parameters used for calling the method AssumeRoleWithSAML on the |
26
|
|
|
|
|
|
|
AWS Security Token Service service. Use the attributes of this class |
27
|
|
|
|
|
|
|
as arguments to method AssumeRoleWithSAML. |
28
|
|
|
|
|
|
|
|
29
|
|
|
|
|
|
|
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AssumeRoleWithSAML. |
30
|
|
|
|
|
|
|
|
31
|
|
|
|
|
|
|
As an example: |
32
|
|
|
|
|
|
|
|
33
|
|
|
|
|
|
|
$service_obj->AssumeRoleWithSAML(Att1 => $value1, Att2 => $value2, ...); |
34
|
|
|
|
|
|
|
|
35
|
|
|
|
|
|
|
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. |
36
|
|
|
|
|
|
|
|
37
|
|
|
|
|
|
|
=head1 ATTRIBUTES |
38
|
|
|
|
|
|
|
|
39
|
|
|
|
|
|
|
|
40
|
|
|
|
|
|
|
=head2 DurationSeconds => Int |
41
|
|
|
|
|
|
|
|
42
|
|
|
|
|
|
|
The duration, in seconds, of the role session. The value can range from |
43
|
|
|
|
|
|
|
900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the |
44
|
|
|
|
|
|
|
value is set to 3600 seconds. An expiration can also be specified in |
45
|
|
|
|
|
|
|
the SAML authentication response's C<SessionNotOnOrAfter> value. The |
46
|
|
|
|
|
|
|
actual expiration time is whichever value is shorter. |
47
|
|
|
|
|
|
|
|
48
|
|
|
|
|
|
|
This is separate from the duration of a console session that you might |
49
|
|
|
|
|
|
|
request using the returned credentials. The request to the federation |
50
|
|
|
|
|
|
|
endpoint for a console sign-in token takes a C<SessionDuration> |
51
|
|
|
|
|
|
|
parameter that specifies the maximum length of the console session, |
52
|
|
|
|
|
|
|
separately from the C<DurationSeconds> parameter on this API. For more |
53
|
|
|
|
|
|
|
information, see Enabling SAML 2.0 Federated Users to Access the AWS |
54
|
|
|
|
|
|
|
Management Console in the I<IAM User Guide>. |
55
|
|
|
|
|
|
|
|
56
|
|
|
|
|
|
|
|
57
|
|
|
|
|
|
|
|
58
|
|
|
|
|
|
|
=head2 Policy => Str |
59
|
|
|
|
|
|
|
|
60
|
|
|
|
|
|
|
An IAM policy in JSON format. |
61
|
|
|
|
|
|
|
|
62
|
|
|
|
|
|
|
The policy parameter is optional. If you pass a policy, the temporary |
63
|
|
|
|
|
|
|
security credentials that are returned by the operation have the |
64
|
|
|
|
|
|
|
permissions that are allowed by both the access policy of the role that |
65
|
|
|
|
|
|
|
is being assumed, I< B<and> > the policy that you pass. This gives you |
66
|
|
|
|
|
|
|
a way to further restrict the permissions for the resulting temporary |
67
|
|
|
|
|
|
|
security credentials. You cannot use the passed policy to grant |
68
|
|
|
|
|
|
|
permissions that are in excess of those allowed by the access policy of |
69
|
|
|
|
|
|
|
the role that is being assumed. For more information, Permissions for |
70
|
|
|
|
|
|
|
AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the |
71
|
|
|
|
|
|
|
I<IAM User Guide>. |
72
|
|
|
|
|
|
|
|
73
|
|
|
|
|
|
|
The format for this parameter, as described by its regex pattern, is a |
74
|
|
|
|
|
|
|
string of characters up to 2048 characters in length. The characters |
75
|
|
|
|
|
|
|
can be any ASCII character from the space character to the end of the |
76
|
|
|
|
|
|
|
valid character list (\u0020-\u00FF). It can also include the tab |
77
|
|
|
|
|
|
|
(\u0009), linefeed (\u000A), and carriage return (\u000D) characters. |
78
|
|
|
|
|
|
|
|
79
|
|
|
|
|
|
|
The policy plain text must be 2048 bytes or shorter. However, an |
80
|
|
|
|
|
|
|
internal conversion compresses it into a packed binary format with a |
81
|
|
|
|
|
|
|
separate limit. The PackedPolicySize response element indicates by |
82
|
|
|
|
|
|
|
percentage how close to the upper size limit the policy is, with 100% |
83
|
|
|
|
|
|
|
equaling the maximum allowed size. |
84
|
|
|
|
|
|
|
|
85
|
|
|
|
|
|
|
|
86
|
|
|
|
|
|
|
|
87
|
|
|
|
|
|
|
=head2 B<REQUIRED> PrincipalArn => Str |
88
|
|
|
|
|
|
|
|
89
|
|
|
|
|
|
|
The Amazon Resource Name (ARN) of the SAML provider in IAM that |
90
|
|
|
|
|
|
|
describes the IdP. |
91
|
|
|
|
|
|
|
|
92
|
|
|
|
|
|
|
|
93
|
|
|
|
|
|
|
|
94
|
|
|
|
|
|
|
=head2 B<REQUIRED> RoleArn => Str |
95
|
|
|
|
|
|
|
|
96
|
|
|
|
|
|
|
The Amazon Resource Name (ARN) of the role that the caller is assuming. |
97
|
|
|
|
|
|
|
|
98
|
|
|
|
|
|
|
|
99
|
|
|
|
|
|
|
|
100
|
|
|
|
|
|
|
=head2 B<REQUIRED> SAMLAssertion => Str |
101
|
|
|
|
|
|
|
|
102
|
|
|
|
|
|
|
The base-64 encoded SAML authentication response provided by the IdP. |
103
|
|
|
|
|
|
|
|
104
|
|
|
|
|
|
|
For more information, see Configuring a Relying Party and Adding Claims |
105
|
|
|
|
|
|
|
in the I<Using IAM> guide. |
106
|
|
|
|
|
|
|
|
107
|
|
|
|
|
|
|
|
108
|
|
|
|
|
|
|
|
109
|
|
|
|
|
|
|
|
110
|
|
|
|
|
|
|
=head1 SEE ALSO |
111
|
|
|
|
|
|
|
|
112
|
|
|
|
|
|
|
This class forms part of L<Paws>, documenting arguments for method AssumeRoleWithSAML in L<Paws::STS> |
113
|
|
|
|
|
|
|
|
114
|
|
|
|
|
|
|
=head1 BUGS and CONTRIBUTIONS |
115
|
|
|
|
|
|
|
|
116
|
|
|
|
|
|
|
The source code is located here: https://github.com/pplu/aws-sdk-perl |
117
|
|
|
|
|
|
|
|
118
|
|
|
|
|
|
|
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues |
119
|
|
|
|
|
|
|
|
120
|
|
|
|
|
|
|
=cut |
121
|
|
|
|
|
|
|
|