| 1 | package Paws::STS; | ||||||||||||||||||||||||||||
| 2 | 3 | ▶ | use Moose; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 3 | 14 | ▶ | sub service { 'sts' } | ||||||||||||||||||||||||||
|
Subroutine
service: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||||||||||||||||||||
| 4 | 1 | ▶ | sub signing_name { 'sts' } | ||||||||||||||||||||||||||
|
Subroutine
signing_name: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||||||||||||||||||||
| 5 | 1 | ▶ | sub version { '2011-06-15' } | ||||||||||||||||||||||||||
|
Subroutine
version: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||||||||||||||||||||
| 6 | 0 | ▶ | sub flattened_arrays { 0 } | ||||||||||||||||||||||||||
|
Subroutine
flattened_arrays: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||||||||||||||||||||
| 7 | 3 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | |||||||||||||||||||||||||||
| 8 | 14 | ▶ | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||||||||||||||||||||||||||
|
Subroutine
__ANON__: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 9 | 14 | { base => 'rand', type => 'exponential', growth_factor => 2 } | |||||||||||||||||||||||||||
| 10 | 3 | }); | |||||||||||||||||||||||||||
| 11 | 14 | ▶ | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||||||||||||||||||||||||||
|
Subroutine
__ANON__: called CC=1 SCAR=3.5
| |||||||||||||||||||||||||||||
| 12 | 0 | ▶ | sub { defined $_[0]->http_status and $_[0]->http_status == 400 and $_[0]->code eq 'IDPCommunicationError' }, | ||||||||||||||||||||||||||
|
Subroutine
__ANON__: not called CC=3 SCAR=24.8
Branch: 1 branch
Condition0%0/3
defined $_[0]->http_status and $_[0]->http_status == 400
MC/DC0%0/2
defined $_[0]->http_status and $_[0]->http_status == 400
defined $_[0]->http_status
$_[0]->http_status == 400
Truth table0%0/3
A and B
A= defined $_[0]->http_statusB= $_[0]->http_status == 400
| |||||||||||||||||||||||||||||
| 13 | 14 | ] }); | |||||||||||||||||||||||||||
| 14 | |||||||||||||||||||||||||||||
| 15 | 3 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::QueryCaller'; | |||||||||||||||||||||||||||
| 16 | |||||||||||||||||||||||||||||
| 17 | 14 | ▶ | has '+region_rules' => (default => sub { | ||||||||||||||||||||||||||
|
Subroutine
__ANON__: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 18 | 14 | my $regioninfo; | |||||||||||||||||||||||||||
| 19 | 14 | $regioninfo = [ | |||||||||||||||||||||||||||
| 20 | { | ||||||||||||||||||||||||||||
| 21 | constraints => [ | ||||||||||||||||||||||||||||
| 22 | [ | ||||||||||||||||||||||||||||
| 23 | 'region', | ||||||||||||||||||||||||||||
| 24 | 'startsWith', | ||||||||||||||||||||||||||||
| 25 | 'cn-' | ||||||||||||||||||||||||||||
| 26 | ] | ||||||||||||||||||||||||||||
| 27 | ], | ||||||||||||||||||||||||||||
| 28 | uri => '{scheme}://{service}.{region}.amazonaws.com.cn' | ||||||||||||||||||||||||||||
| 29 | }, | ||||||||||||||||||||||||||||
| 30 | { | ||||||||||||||||||||||||||||
| 31 | constraints => [ | ||||||||||||||||||||||||||||
| 32 | [ | ||||||||||||||||||||||||||||
| 33 | 'region', | ||||||||||||||||||||||||||||
| 34 | 'startsWith', | ||||||||||||||||||||||||||||
| 35 | 'us-gov' | ||||||||||||||||||||||||||||
| 36 | ] | ||||||||||||||||||||||||||||
| 37 | ], | ||||||||||||||||||||||||||||
| 38 | uri => 'https://{service}.{region}.amazonaws.com' | ||||||||||||||||||||||||||||
| 39 | }, | ||||||||||||||||||||||||||||
| 40 | { | ||||||||||||||||||||||||||||
| 41 | constraints => [ | ||||||||||||||||||||||||||||
| 42 | [ | ||||||||||||||||||||||||||||
| 43 | 'region', | ||||||||||||||||||||||||||||
| 44 | 'equals', | ||||||||||||||||||||||||||||
| 45 | undef | ||||||||||||||||||||||||||||
| 46 | ] | ||||||||||||||||||||||||||||
| 47 | ], | ||||||||||||||||||||||||||||
| 48 | properties => { | ||||||||||||||||||||||||||||
| 49 | credentialScope => { | ||||||||||||||||||||||||||||
| 50 | region => 'us-east-1' | ||||||||||||||||||||||||||||
| 51 | } | ||||||||||||||||||||||||||||
| 52 | }, | ||||||||||||||||||||||||||||
| 53 | uri => 'https://sts.amazonaws.com' | ||||||||||||||||||||||||||||
| 54 | }, | ||||||||||||||||||||||||||||
| 55 | { | ||||||||||||||||||||||||||||
| 56 | uri => 'https://{service}.{region}.amazonaws.com' | ||||||||||||||||||||||||||||
| 57 | } | ||||||||||||||||||||||||||||
| 58 | ]; | ||||||||||||||||||||||||||||
| 59 | |||||||||||||||||||||||||||||
| 60 | 14 | return $regioninfo; | |||||||||||||||||||||||||||
| 61 | 3 | }); | |||||||||||||||||||||||||||
| 62 | |||||||||||||||||||||||||||||
| 63 | |||||||||||||||||||||||||||||
| 64 | 0 | ▶ | sub AssumeRole { | ||||||||||||||||||||||||||
|
Subroutine
AssumeRole: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 65 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 66 | 0 | my $call_object = $self->new_with_coercions('Paws::STS::AssumeRole', @_); | |||||||||||||||||||||||||||
| 67 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 68 | } | ||||||||||||||||||||||||||||
| 69 | 0 | ▶ | sub AssumeRoleWithSAML { | ||||||||||||||||||||||||||
|
Subroutine
AssumeRoleWithSAML: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 70 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 71 | 0 | my $call_object = $self->new_with_coercions('Paws::STS::AssumeRoleWithSAML', @_); | |||||||||||||||||||||||||||
| 72 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 73 | } | ||||||||||||||||||||||||||||
| 74 | 0 | ▶ | sub AssumeRoleWithWebIdentity { | ||||||||||||||||||||||||||
|
Subroutine
AssumeRoleWithWebIdentity: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 75 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 76 | 0 | my $call_object = $self->new_with_coercions('Paws::STS::AssumeRoleWithWebIdentity', @_); | |||||||||||||||||||||||||||
| 77 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 78 | } | ||||||||||||||||||||||||||||
| 79 | 0 | ▶ | sub DecodeAuthorizationMessage { | ||||||||||||||||||||||||||
|
Subroutine
DecodeAuthorizationMessage: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 80 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 81 | 0 | my $call_object = $self->new_with_coercions('Paws::STS::DecodeAuthorizationMessage', @_); | |||||||||||||||||||||||||||
| 82 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 83 | } | ||||||||||||||||||||||||||||
| 84 | 0 | ▶ | sub GetAccessKeyInfo { | ||||||||||||||||||||||||||
|
Subroutine
GetAccessKeyInfo: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 85 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 86 | 0 | my $call_object = $self->new_with_coercions('Paws::STS::GetAccessKeyInfo', @_); | |||||||||||||||||||||||||||
| 87 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 88 | } | ||||||||||||||||||||||||||||
| 89 | 0 | ▶ | sub GetCallerIdentity { | ||||||||||||||||||||||||||
|
Subroutine
GetCallerIdentity: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 90 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 91 | 0 | my $call_object = $self->new_with_coercions('Paws::STS::GetCallerIdentity', @_); | |||||||||||||||||||||||||||
| 92 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 93 | } | ||||||||||||||||||||||||||||
| 94 | 1 | ▶ | sub GetFederationToken { | ||||||||||||||||||||||||||
|
Subroutine
GetFederationToken: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 95 | 1 | my $self = shift; | |||||||||||||||||||||||||||
| 96 | 1 | my $call_object = $self->new_with_coercions('Paws::STS::GetFederationToken', @_); | |||||||||||||||||||||||||||
| 97 | 1 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 98 | } | ||||||||||||||||||||||||||||
| 99 | 1 | ▶ | sub GetSessionToken { | ||||||||||||||||||||||||||
|
Subroutine
GetSessionToken: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 100 | 1 | my $self = shift; | |||||||||||||||||||||||||||
| 101 | 1 | my $call_object = $self->new_with_coercions('Paws::STS::GetSessionToken', @_); | |||||||||||||||||||||||||||
| 102 | 1 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 103 | } | ||||||||||||||||||||||||||||
| 104 | |||||||||||||||||||||||||||||
| 105 | |||||||||||||||||||||||||||||
| 106 | |||||||||||||||||||||||||||||
| 107 | 0 | ▶ | sub operations { qw/AssumeRole AssumeRoleWithSAML AssumeRoleWithWebIdentity DecodeAuthorizationMessage GetAccessKeyInfo GetCallerIdentity GetFederationToken GetSessionToken / } | ||||||||||||||||||||||||||
|
Subroutine
operations: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||||||||||||||||||||
| 108 | |||||||||||||||||||||||||||||
| 109 | 3 | 1; | |||||||||||||||||||||||||||
| 110 | |||||||||||||||||||||||||||||
| 111 | ### main pod documentation begin ### | ||||||||||||||||||||||||||||
| 112 | |||||||||||||||||||||||||||||
| 113 | =head1 NAME | ||||||||||||||||||||||||||||
| 114 | |||||||||||||||||||||||||||||
| 115 | Paws::STS - Perl Interface to AWS AWS Security Token Service | ||||||||||||||||||||||||||||
| 116 | |||||||||||||||||||||||||||||
| 117 | =head1 SYNOPSIS | ||||||||||||||||||||||||||||
| 118 | |||||||||||||||||||||||||||||
| 119 | use Paws; | ||||||||||||||||||||||||||||
| 120 | |||||||||||||||||||||||||||||
| 121 | my $obj = Paws->service('STS'); | ||||||||||||||||||||||||||||
| 122 | my $res = $obj->Method( | ||||||||||||||||||||||||||||
| 123 | Arg1 => $val1, | ||||||||||||||||||||||||||||
| 124 | Arg2 => [ 'V1', 'V2' ], | ||||||||||||||||||||||||||||
| 125 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||||||||||||||||||||||||||||
| 126 | # of the arguments type | ||||||||||||||||||||||||||||
| 127 | Arg3 => { Att1 => 'Val1' }, | ||||||||||||||||||||||||||||
| 128 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||||||||||||||||||||||||||||
| 129 | # the constructor of the arguments type | ||||||||||||||||||||||||||||
| 130 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||||||||||||||||||||||||||||
| 131 | ); | ||||||||||||||||||||||||||||
| 132 | |||||||||||||||||||||||||||||
| 133 | =head1 DESCRIPTION | ||||||||||||||||||||||||||||
| 134 | |||||||||||||||||||||||||||||
| 135 | AWS Security Token Service | ||||||||||||||||||||||||||||
| 136 | |||||||||||||||||||||||||||||
| 137 | AWS Security Token Service (STS) enables you to request temporary, | ||||||||||||||||||||||||||||
| 138 | limited-privilege credentials for AWS Identity and Access Management | ||||||||||||||||||||||||||||
| 139 | (IAM) users or for users that you authenticate (federated users). This | ||||||||||||||||||||||||||||
| 140 | guide provides descriptions of the STS API. For more information about | ||||||||||||||||||||||||||||
| 141 | using this service, see Temporary Security Credentials | ||||||||||||||||||||||||||||
| 142 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html). | ||||||||||||||||||||||||||||
| 143 | |||||||||||||||||||||||||||||
| 144 | For the AWS API documentation, see L<https://docs.aws.amazon.com/iam/> | ||||||||||||||||||||||||||||
| 145 | |||||||||||||||||||||||||||||
| 146 | |||||||||||||||||||||||||||||
| 147 | =head1 METHODS | ||||||||||||||||||||||||||||
| 148 | |||||||||||||||||||||||||||||
| 149 | =head2 AssumeRole | ||||||||||||||||||||||||||||
| 150 | |||||||||||||||||||||||||||||
| 151 | =over | ||||||||||||||||||||||||||||
| 152 | |||||||||||||||||||||||||||||
| 153 | =item RoleArn => Str | ||||||||||||||||||||||||||||
| 154 | |||||||||||||||||||||||||||||
| 155 | =item RoleSessionName => Str | ||||||||||||||||||||||||||||
| 156 | |||||||||||||||||||||||||||||
| 157 | =item [DurationSeconds => Int] | ||||||||||||||||||||||||||||
| 158 | |||||||||||||||||||||||||||||
| 159 | =item [ExternalId => Str] | ||||||||||||||||||||||||||||
| 160 | |||||||||||||||||||||||||||||
| 161 | =item [Policy => Str] | ||||||||||||||||||||||||||||
| 162 | |||||||||||||||||||||||||||||
| 163 | =item [PolicyArns => ArrayRef[L<Paws::STS::PolicyDescriptorType>]] | ||||||||||||||||||||||||||||
| 164 | |||||||||||||||||||||||||||||
| 165 | =item [SerialNumber => Str] | ||||||||||||||||||||||||||||
| 166 | |||||||||||||||||||||||||||||
| 167 | =item [SourceIdentity => Str] | ||||||||||||||||||||||||||||
| 168 | |||||||||||||||||||||||||||||
| 169 | =item [Tags => ArrayRef[L<Paws::STS::Tag>]] | ||||||||||||||||||||||||||||
| 170 | |||||||||||||||||||||||||||||
| 171 | =item [TokenCode => Str] | ||||||||||||||||||||||||||||
| 172 | |||||||||||||||||||||||||||||
| 173 | =item [TransitiveTagKeys => ArrayRef[Str|Undef]] | ||||||||||||||||||||||||||||
| 174 | |||||||||||||||||||||||||||||
| 175 | |||||||||||||||||||||||||||||
| 176 | =back | ||||||||||||||||||||||||||||
| 177 | |||||||||||||||||||||||||||||
| 178 | Each argument is described in detail in: L<Paws::STS::AssumeRole> | ||||||||||||||||||||||||||||
| 179 | |||||||||||||||||||||||||||||
| 180 | Returns: a L<Paws::STS::AssumeRoleResponse> instance | ||||||||||||||||||||||||||||
| 181 | |||||||||||||||||||||||||||||
| 182 | Returns a set of temporary security credentials that you can use to | ||||||||||||||||||||||||||||
| 183 | access AWS resources that you might not normally have access to. These | ||||||||||||||||||||||||||||
| 184 | temporary credentials consist of an access key ID, a secret access key, | ||||||||||||||||||||||||||||
| 185 | and a security token. Typically, you use C<AssumeRole> within your | ||||||||||||||||||||||||||||
| 186 | account or for cross-account access. For a comparison of C<AssumeRole> | ||||||||||||||||||||||||||||
| 187 | with other API operations that produce temporary credentials, see | ||||||||||||||||||||||||||||
| 188 | Requesting Temporary Security Credentials | ||||||||||||||||||||||||||||
| 189 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) | ||||||||||||||||||||||||||||
| 190 | and Comparing the AWS STS API operations | ||||||||||||||||||||||||||||
| 191 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) | ||||||||||||||||||||||||||||
| 192 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 193 | |||||||||||||||||||||||||||||
| 194 | B<Permissions> | ||||||||||||||||||||||||||||
| 195 | |||||||||||||||||||||||||||||
| 196 | The temporary security credentials created by C<AssumeRole> can be used | ||||||||||||||||||||||||||||
| 197 | to make API calls to any AWS service with the following exception: You | ||||||||||||||||||||||||||||
| 198 | cannot call the AWS STS C<GetFederationToken> or C<GetSessionToken> API | ||||||||||||||||||||||||||||
| 199 | operations. | ||||||||||||||||||||||||||||
| 200 | |||||||||||||||||||||||||||||
| 201 | (Optional) You can pass inline or managed session policies | ||||||||||||||||||||||||||||
| 202 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) | ||||||||||||||||||||||||||||
| 203 | to this operation. You can pass a single JSON policy document to use as | ||||||||||||||||||||||||||||
| 204 | an inline session policy. You can also specify up to 10 managed | ||||||||||||||||||||||||||||
| 205 | policies to use as managed session policies. The plaintext that you use | ||||||||||||||||||||||||||||
| 206 | for both inline and managed session policies can't exceed 2,048 | ||||||||||||||||||||||||||||
| 207 | characters. Passing policies to this operation returns new temporary | ||||||||||||||||||||||||||||
| 208 | credentials. The resulting session's permissions are the intersection | ||||||||||||||||||||||||||||
| 209 | of the role's identity-based policy and the session policies. You can | ||||||||||||||||||||||||||||
| 210 | use the role's temporary credentials in subsequent AWS API calls to | ||||||||||||||||||||||||||||
| 211 | access resources in the account that owns the role. You cannot use | ||||||||||||||||||||||||||||
| 212 | session policies to grant more permissions than those allowed by the | ||||||||||||||||||||||||||||
| 213 | identity-based policy of the role that is being assumed. For more | ||||||||||||||||||||||||||||
| 214 | information, see Session Policies | ||||||||||||||||||||||||||||
| 215 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) | ||||||||||||||||||||||||||||
| 216 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 217 | |||||||||||||||||||||||||||||
| 218 | To assume a role from a different account, your AWS account must be | ||||||||||||||||||||||||||||
| 219 | trusted by the role. The trust relationship is defined in the role's | ||||||||||||||||||||||||||||
| 220 | trust policy when the role is created. That trust policy states which | ||||||||||||||||||||||||||||
| 221 | accounts are allowed to delegate that access to users in the account. | ||||||||||||||||||||||||||||
| 222 | |||||||||||||||||||||||||||||
| 223 | A user who wants to access a role in a different account must also have | ||||||||||||||||||||||||||||
| 224 | permissions that are delegated from the user account administrator. The | ||||||||||||||||||||||||||||
| 225 | administrator must attach a policy that allows the user to call | ||||||||||||||||||||||||||||
| 226 | C<AssumeRole> for the ARN of the role in the other account. If the user | ||||||||||||||||||||||||||||
| 227 | is in the same account as the role, then you can do either of the | ||||||||||||||||||||||||||||
| 228 | following: | ||||||||||||||||||||||||||||
| 229 | |||||||||||||||||||||||||||||
| 230 | =over | ||||||||||||||||||||||||||||
| 231 | |||||||||||||||||||||||||||||
| 232 | =item * | ||||||||||||||||||||||||||||
| 233 | |||||||||||||||||||||||||||||
| 234 | Attach a policy to the user (identical to the previous user in a | ||||||||||||||||||||||||||||
| 235 | different account). | ||||||||||||||||||||||||||||
| 236 | |||||||||||||||||||||||||||||
| 237 | =item * | ||||||||||||||||||||||||||||
| 238 | |||||||||||||||||||||||||||||
| 239 | Add the user as a principal directly in the role's trust policy. | ||||||||||||||||||||||||||||
| 240 | |||||||||||||||||||||||||||||
| 241 | =back | ||||||||||||||||||||||||||||
| 242 | |||||||||||||||||||||||||||||
| 243 | In this case, the trust policy acts as an IAM resource-based policy. | ||||||||||||||||||||||||||||
| 244 | Users in the same account as the role do not need explicit permission | ||||||||||||||||||||||||||||
| 245 | to assume the role. For more information about trust policies and | ||||||||||||||||||||||||||||
| 246 | resource-based policies, see IAM Policies | ||||||||||||||||||||||||||||
| 247 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) | ||||||||||||||||||||||||||||
| 248 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 249 | |||||||||||||||||||||||||||||
| 250 | B<Tags> | ||||||||||||||||||||||||||||
| 251 | |||||||||||||||||||||||||||||
| 252 | (Optional) You can pass tag key-value pairs to your session. These tags | ||||||||||||||||||||||||||||
| 253 | are called session tags. For more information about session tags, see | ||||||||||||||||||||||||||||
| 254 | Passing Session Tags in STS | ||||||||||||||||||||||||||||
| 255 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) | ||||||||||||||||||||||||||||
| 256 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 257 | |||||||||||||||||||||||||||||
| 258 | An administrator must grant you the permissions necessary to pass | ||||||||||||||||||||||||||||
| 259 | session tags. The administrator can also create granular permissions to | ||||||||||||||||||||||||||||
| 260 | allow you to pass only specific session tags. For more information, see | ||||||||||||||||||||||||||||
| 261 | Tutorial: Using Tags for Attribute-Based Access Control | ||||||||||||||||||||||||||||
| 262 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) | ||||||||||||||||||||||||||||
| 263 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 264 | |||||||||||||||||||||||||||||
| 265 | You can set the session tags as transitive. Transitive tags persist | ||||||||||||||||||||||||||||
| 266 | during role chaining. For more information, see Chaining Roles with | ||||||||||||||||||||||||||||
| 267 | Session Tags | ||||||||||||||||||||||||||||
| 268 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) | ||||||||||||||||||||||||||||
| 269 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 270 | |||||||||||||||||||||||||||||
| 271 | B<Using MFA with AssumeRole> | ||||||||||||||||||||||||||||
| 272 | |||||||||||||||||||||||||||||
| 273 | (Optional) You can include multi-factor authentication (MFA) | ||||||||||||||||||||||||||||
| 274 | information when you call C<AssumeRole>. This is useful for | ||||||||||||||||||||||||||||
| 275 | cross-account scenarios to ensure that the user that assumes the role | ||||||||||||||||||||||||||||
| 276 | has been authenticated with an AWS MFA device. In that scenario, the | ||||||||||||||||||||||||||||
| 277 | trust policy of the role being assumed includes a condition that tests | ||||||||||||||||||||||||||||
| 278 | for MFA authentication. If the caller does not include valid MFA | ||||||||||||||||||||||||||||
| 279 | information, the request to assume the role is denied. The condition in | ||||||||||||||||||||||||||||
| 280 | a trust policy that tests for MFA authentication might look like the | ||||||||||||||||||||||||||||
| 281 | following example. | ||||||||||||||||||||||||||||
| 282 | |||||||||||||||||||||||||||||
| 283 | C<"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}> | ||||||||||||||||||||||||||||
| 284 | |||||||||||||||||||||||||||||
| 285 | For more information, see Configuring MFA-Protected API Access | ||||||||||||||||||||||||||||
| 286 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html) | ||||||||||||||||||||||||||||
| 287 | in the I<IAM User Guide> guide. | ||||||||||||||||||||||||||||
| 288 | |||||||||||||||||||||||||||||
| 289 | To use MFA with C<AssumeRole>, you pass values for the C<SerialNumber> | ||||||||||||||||||||||||||||
| 290 | and C<TokenCode> parameters. The C<SerialNumber> value identifies the | ||||||||||||||||||||||||||||
| 291 | user's hardware or virtual MFA device. The C<TokenCode> is the | ||||||||||||||||||||||||||||
| 292 | time-based one-time password (TOTP) that the MFA device produces. | ||||||||||||||||||||||||||||
| 293 | |||||||||||||||||||||||||||||
| 294 | |||||||||||||||||||||||||||||
| 295 | =head2 AssumeRoleWithSAML | ||||||||||||||||||||||||||||
| 296 | |||||||||||||||||||||||||||||
| 297 | =over | ||||||||||||||||||||||||||||
| 298 | |||||||||||||||||||||||||||||
| 299 | =item PrincipalArn => Str | ||||||||||||||||||||||||||||
| 300 | |||||||||||||||||||||||||||||
| 301 | =item RoleArn => Str | ||||||||||||||||||||||||||||
| 302 | |||||||||||||||||||||||||||||
| 303 | =item SAMLAssertion => Str | ||||||||||||||||||||||||||||
| 304 | |||||||||||||||||||||||||||||
| 305 | =item [DurationSeconds => Int] | ||||||||||||||||||||||||||||
| 306 | |||||||||||||||||||||||||||||
| 307 | =item [Policy => Str] | ||||||||||||||||||||||||||||
| 308 | |||||||||||||||||||||||||||||
| 309 | =item [PolicyArns => ArrayRef[L<Paws::STS::PolicyDescriptorType>]] | ||||||||||||||||||||||||||||
| 310 | |||||||||||||||||||||||||||||
| 311 | |||||||||||||||||||||||||||||
| 312 | =back | ||||||||||||||||||||||||||||
| 313 | |||||||||||||||||||||||||||||
| 314 | Each argument is described in detail in: L<Paws::STS::AssumeRoleWithSAML> | ||||||||||||||||||||||||||||
| 315 | |||||||||||||||||||||||||||||
| 316 | Returns: a L<Paws::STS::AssumeRoleWithSAMLResponse> instance | ||||||||||||||||||||||||||||
| 317 | |||||||||||||||||||||||||||||
| 318 | Returns a set of temporary security credentials for users who have been | ||||||||||||||||||||||||||||
| 319 | authenticated via a SAML authentication response. This operation | ||||||||||||||||||||||||||||
| 320 | provides a mechanism for tying an enterprise identity store or | ||||||||||||||||||||||||||||
| 321 | directory to role-based AWS access without user-specific credentials or | ||||||||||||||||||||||||||||
| 322 | configuration. For a comparison of C<AssumeRoleWithSAML> with the other | ||||||||||||||||||||||||||||
| 323 | API operations that produce temporary credentials, see Requesting | ||||||||||||||||||||||||||||
| 324 | Temporary Security Credentials | ||||||||||||||||||||||||||||
| 325 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) | ||||||||||||||||||||||||||||
| 326 | and Comparing the AWS STS API operations | ||||||||||||||||||||||||||||
| 327 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) | ||||||||||||||||||||||||||||
| 328 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 329 | |||||||||||||||||||||||||||||
| 330 | The temporary security credentials returned by this operation consist | ||||||||||||||||||||||||||||
| 331 | of an access key ID, a secret access key, and a security token. | ||||||||||||||||||||||||||||
| 332 | Applications can use these temporary security credentials to sign calls | ||||||||||||||||||||||||||||
| 333 | to AWS services. | ||||||||||||||||||||||||||||
| 334 | |||||||||||||||||||||||||||||
| 335 | B<Session Duration> | ||||||||||||||||||||||||||||
| 336 | |||||||||||||||||||||||||||||
| 337 | By default, the temporary security credentials created by | ||||||||||||||||||||||||||||
| 338 | C<AssumeRoleWithSAML> last for one hour. However, you can use the | ||||||||||||||||||||||||||||
| 339 | optional C<DurationSeconds> parameter to specify the duration of your | ||||||||||||||||||||||||||||
| 340 | session. Your role session lasts for the duration that you specify, or | ||||||||||||||||||||||||||||
| 341 | until the time specified in the SAML authentication response's | ||||||||||||||||||||||||||||
| 342 | C<SessionNotOnOrAfter> value, whichever is shorter. You can provide a | ||||||||||||||||||||||||||||
| 343 | C<DurationSeconds> value from 900 seconds (15 minutes) up to the | ||||||||||||||||||||||||||||
| 344 | maximum session duration setting for the role. This setting can have a | ||||||||||||||||||||||||||||
| 345 | value from 1 hour to 12 hours. To learn how to view the maximum value | ||||||||||||||||||||||||||||
| 346 | for your role, see View the Maximum Session Duration Setting for a Role | ||||||||||||||||||||||||||||
| 347 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) | ||||||||||||||||||||||||||||
| 348 | in the I<IAM User Guide>. The maximum session duration limit applies | ||||||||||||||||||||||||||||
| 349 | when you use the C<AssumeRole*> API operations or the C<assume-role*> | ||||||||||||||||||||||||||||
| 350 | CLI commands. However the limit does not apply when you use those | ||||||||||||||||||||||||||||
| 351 | operations to create a console URL. For more information, see Using IAM | ||||||||||||||||||||||||||||
| 352 | Roles | ||||||||||||||||||||||||||||
| 353 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in | ||||||||||||||||||||||||||||
| 354 | the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 355 | |||||||||||||||||||||||||||||
| 356 | Role chaining | ||||||||||||||||||||||||||||
| 357 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-role-chaining) | ||||||||||||||||||||||||||||
| 358 | limits your AWS CLI or AWS API role session to a maximum of one hour. | ||||||||||||||||||||||||||||
| 359 | When you use the C<AssumeRole> API operation to assume a role, you can | ||||||||||||||||||||||||||||
| 360 | specify the duration of your role session with the C<DurationSeconds> | ||||||||||||||||||||||||||||
| 361 | parameter. You can specify a parameter value of up to 43200 seconds (12 | ||||||||||||||||||||||||||||
| 362 | hours), depending on the maximum session duration setting for your | ||||||||||||||||||||||||||||
| 363 | role. However, if you assume a role using role chaining and provide a | ||||||||||||||||||||||||||||
| 364 | C<DurationSeconds> parameter value greater than one hour, the operation | ||||||||||||||||||||||||||||
| 365 | fails. | ||||||||||||||||||||||||||||
| 366 | |||||||||||||||||||||||||||||
| 367 | B<Permissions> | ||||||||||||||||||||||||||||
| 368 | |||||||||||||||||||||||||||||
| 369 | The temporary security credentials created by C<AssumeRoleWithSAML> can | ||||||||||||||||||||||||||||
| 370 | be used to make API calls to any AWS service with the following | ||||||||||||||||||||||||||||
| 371 | exception: you cannot call the STS C<GetFederationToken> or | ||||||||||||||||||||||||||||
| 372 | C<GetSessionToken> API operations. | ||||||||||||||||||||||||||||
| 373 | |||||||||||||||||||||||||||||
| 374 | (Optional) You can pass inline or managed session policies | ||||||||||||||||||||||||||||
| 375 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) | ||||||||||||||||||||||||||||
| 376 | to this operation. You can pass a single JSON policy document to use as | ||||||||||||||||||||||||||||
| 377 | an inline session policy. You can also specify up to 10 managed | ||||||||||||||||||||||||||||
| 378 | policies to use as managed session policies. The plaintext that you use | ||||||||||||||||||||||||||||
| 379 | for both inline and managed session policies can't exceed 2,048 | ||||||||||||||||||||||||||||
| 380 | characters. Passing policies to this operation returns new temporary | ||||||||||||||||||||||||||||
| 381 | credentials. The resulting session's permissions are the intersection | ||||||||||||||||||||||||||||
| 382 | of the role's identity-based policy and the session policies. You can | ||||||||||||||||||||||||||||
| 383 | use the role's temporary credentials in subsequent AWS API calls to | ||||||||||||||||||||||||||||
| 384 | access resources in the account that owns the role. You cannot use | ||||||||||||||||||||||||||||
| 385 | session policies to grant more permissions than those allowed by the | ||||||||||||||||||||||||||||
| 386 | identity-based policy of the role that is being assumed. For more | ||||||||||||||||||||||||||||
| 387 | information, see Session Policies | ||||||||||||||||||||||||||||
| 388 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) | ||||||||||||||||||||||||||||
| 389 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 390 | |||||||||||||||||||||||||||||
| 391 | Calling C<AssumeRoleWithSAML> does not require the use of AWS security | ||||||||||||||||||||||||||||
| 392 | credentials. The identity of the caller is validated by using keys in | ||||||||||||||||||||||||||||
| 393 | the metadata document that is uploaded for the SAML provider entity for | ||||||||||||||||||||||||||||
| 394 | your identity provider. | ||||||||||||||||||||||||||||
| 395 | |||||||||||||||||||||||||||||
| 396 | Calling C<AssumeRoleWithSAML> can result in an entry in your AWS | ||||||||||||||||||||||||||||
| 397 | CloudTrail logs. The entry includes the value in the C<NameID> element | ||||||||||||||||||||||||||||
| 398 | of the SAML assertion. We recommend that you use a C<NameIDType> that | ||||||||||||||||||||||||||||
| 399 | is not associated with any personally identifiable information (PII). | ||||||||||||||||||||||||||||
| 400 | For example, you could instead use the persistent identifier | ||||||||||||||||||||||||||||
| 401 | (C<urn:oasis:names:tc:SAML:2.0:nameid-format:persistent>). | ||||||||||||||||||||||||||||
| 402 | |||||||||||||||||||||||||||||
| 403 | B<Tags> | ||||||||||||||||||||||||||||
| 404 | |||||||||||||||||||||||||||||
| 405 | (Optional) You can configure your IdP to pass attributes into your SAML | ||||||||||||||||||||||||||||
| 406 | assertion as session tags. Each session tag consists of a key name and | ||||||||||||||||||||||||||||
| 407 | an associated value. For more information about session tags, see | ||||||||||||||||||||||||||||
| 408 | Passing Session Tags in STS | ||||||||||||||||||||||||||||
| 409 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) | ||||||||||||||||||||||||||||
| 410 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 411 | |||||||||||||||||||||||||||||
| 412 | You can pass up to 50 session tags. The plaintext session tag keys | ||||||||||||||||||||||||||||
| 413 | canE<rsquo>t exceed 128 characters and the values canE<rsquo>t exceed | ||||||||||||||||||||||||||||
| 414 | 256 characters. For these and additional limits, see IAM and STS | ||||||||||||||||||||||||||||
| 415 | Character Limits | ||||||||||||||||||||||||||||
| 416 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) | ||||||||||||||||||||||||||||
| 417 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 418 | |||||||||||||||||||||||||||||
| 419 | An AWS conversion compresses the passed session policies and session | ||||||||||||||||||||||||||||
| 420 | tags into a packed binary format that has a separate limit. Your | ||||||||||||||||||||||||||||
| 421 | request can fail for this limit even if your plaintext meets the other | ||||||||||||||||||||||||||||
| 422 | requirements. The C<PackedPolicySize> response element indicates by | ||||||||||||||||||||||||||||
| 423 | percentage how close the policies and tags for your request are to the | ||||||||||||||||||||||||||||
| 424 | upper size limit. | ||||||||||||||||||||||||||||
| 425 | |||||||||||||||||||||||||||||
| 426 | You can pass a session tag with the same key as a tag that is attached | ||||||||||||||||||||||||||||
| 427 | to the role. When you do, session tags override the role's tags with | ||||||||||||||||||||||||||||
| 428 | the same key. | ||||||||||||||||||||||||||||
| 429 | |||||||||||||||||||||||||||||
| 430 | An administrator must grant you the permissions necessary to pass | ||||||||||||||||||||||||||||
| 431 | session tags. The administrator can also create granular permissions to | ||||||||||||||||||||||||||||
| 432 | allow you to pass only specific session tags. For more information, see | ||||||||||||||||||||||||||||
| 433 | Tutorial: Using Tags for Attribute-Based Access Control | ||||||||||||||||||||||||||||
| 434 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) | ||||||||||||||||||||||||||||
| 435 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 436 | |||||||||||||||||||||||||||||
| 437 | You can set the session tags as transitive. Transitive tags persist | ||||||||||||||||||||||||||||
| 438 | during role chaining. For more information, see Chaining Roles with | ||||||||||||||||||||||||||||
| 439 | Session Tags | ||||||||||||||||||||||||||||
| 440 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) | ||||||||||||||||||||||||||||
| 441 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 442 | |||||||||||||||||||||||||||||
| 443 | B<SAML Configuration> | ||||||||||||||||||||||||||||
| 444 | |||||||||||||||||||||||||||||
| 445 | Before your application can call C<AssumeRoleWithSAML>, you must | ||||||||||||||||||||||||||||
| 446 | configure your SAML identity provider (IdP) to issue the claims | ||||||||||||||||||||||||||||
| 447 | required by AWS. Additionally, you must use AWS Identity and Access | ||||||||||||||||||||||||||||
| 448 | Management (IAM) to create a SAML provider entity in your AWS account | ||||||||||||||||||||||||||||
| 449 | that represents your identity provider. You must also create an IAM | ||||||||||||||||||||||||||||
| 450 | role that specifies this SAML provider in its trust policy. | ||||||||||||||||||||||||||||
| 451 | |||||||||||||||||||||||||||||
| 452 | For more information, see the following resources: | ||||||||||||||||||||||||||||
| 453 | |||||||||||||||||||||||||||||
| 454 | =over | ||||||||||||||||||||||||||||
| 455 | |||||||||||||||||||||||||||||
| 456 | =item * | ||||||||||||||||||||||||||||
| 457 | |||||||||||||||||||||||||||||
| 458 | About SAML 2.0-based Federation | ||||||||||||||||||||||||||||
| 459 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) | ||||||||||||||||||||||||||||
| 460 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 461 | |||||||||||||||||||||||||||||
| 462 | =item * | ||||||||||||||||||||||||||||
| 463 | |||||||||||||||||||||||||||||
| 464 | Creating SAML Identity Providers | ||||||||||||||||||||||||||||
| 465 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html) | ||||||||||||||||||||||||||||
| 466 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 467 | |||||||||||||||||||||||||||||
| 468 | =item * | ||||||||||||||||||||||||||||
| 469 | |||||||||||||||||||||||||||||
| 470 | Configuring a Relying Party and Claims | ||||||||||||||||||||||||||||
| 471 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml_relying-party.html) | ||||||||||||||||||||||||||||
| 472 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 473 | |||||||||||||||||||||||||||||
| 474 | =item * | ||||||||||||||||||||||||||||
| 475 | |||||||||||||||||||||||||||||
| 476 | Creating a Role for SAML 2.0 Federation | ||||||||||||||||||||||||||||
| 477 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_saml.html) | ||||||||||||||||||||||||||||
| 478 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 479 | |||||||||||||||||||||||||||||
| 480 | =back | ||||||||||||||||||||||||||||
| 481 | |||||||||||||||||||||||||||||
| 482 | |||||||||||||||||||||||||||||
| 483 | |||||||||||||||||||||||||||||
| 484 | =head2 AssumeRoleWithWebIdentity | ||||||||||||||||||||||||||||
| 485 | |||||||||||||||||||||||||||||
| 486 | =over | ||||||||||||||||||||||||||||
| 487 | |||||||||||||||||||||||||||||
| 488 | =item RoleArn => Str | ||||||||||||||||||||||||||||
| 489 | |||||||||||||||||||||||||||||
| 490 | =item RoleSessionName => Str | ||||||||||||||||||||||||||||
| 491 | |||||||||||||||||||||||||||||
| 492 | =item WebIdentityToken => Str | ||||||||||||||||||||||||||||
| 493 | |||||||||||||||||||||||||||||
| 494 | =item [DurationSeconds => Int] | ||||||||||||||||||||||||||||
| 495 | |||||||||||||||||||||||||||||
| 496 | =item [Policy => Str] | ||||||||||||||||||||||||||||
| 497 | |||||||||||||||||||||||||||||
| 498 | =item [PolicyArns => ArrayRef[L<Paws::STS::PolicyDescriptorType>]] | ||||||||||||||||||||||||||||
| 499 | |||||||||||||||||||||||||||||
| 500 | =item [ProviderId => Str] | ||||||||||||||||||||||||||||
| 501 | |||||||||||||||||||||||||||||
| 502 | |||||||||||||||||||||||||||||
| 503 | =back | ||||||||||||||||||||||||||||
| 504 | |||||||||||||||||||||||||||||
| 505 | Each argument is described in detail in: L<Paws::STS::AssumeRoleWithWebIdentity> | ||||||||||||||||||||||||||||
| 506 | |||||||||||||||||||||||||||||
| 507 | Returns: a L<Paws::STS::AssumeRoleWithWebIdentityResponse> instance | ||||||||||||||||||||||||||||
| 508 | |||||||||||||||||||||||||||||
| 509 | Returns a set of temporary security credentials for users who have been | ||||||||||||||||||||||||||||
| 510 | authenticated in a mobile or web application with a web identity | ||||||||||||||||||||||||||||
| 511 | provider. Example providers include Amazon Cognito, Login with Amazon, | ||||||||||||||||||||||||||||
| 512 | Facebook, Google, or any OpenID Connect-compatible identity provider. | ||||||||||||||||||||||||||||
| 513 | |||||||||||||||||||||||||||||
| 514 | For mobile applications, we recommend that you use Amazon Cognito. You | ||||||||||||||||||||||||||||
| 515 | can use Amazon Cognito with the AWS SDK for iOS Developer Guide | ||||||||||||||||||||||||||||
| 516 | (http://aws.amazon.com/sdkforios/) and the AWS SDK for Android | ||||||||||||||||||||||||||||
| 517 | Developer Guide (http://aws.amazon.com/sdkforandroid/) to uniquely | ||||||||||||||||||||||||||||
| 518 | identify a user. You can also supply the user with a consistent | ||||||||||||||||||||||||||||
| 519 | identity throughout the lifetime of an application. | ||||||||||||||||||||||||||||
| 520 | |||||||||||||||||||||||||||||
| 521 | To learn more about Amazon Cognito, see Amazon Cognito Overview | ||||||||||||||||||||||||||||
| 522 | (https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840) | ||||||||||||||||||||||||||||
| 523 | in I<AWS SDK for Android Developer Guide> and Amazon Cognito Overview | ||||||||||||||||||||||||||||
| 524 | (https://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-auth.html#d0e664) | ||||||||||||||||||||||||||||
| 525 | in the I<AWS SDK for iOS Developer Guide>. | ||||||||||||||||||||||||||||
| 526 | |||||||||||||||||||||||||||||
| 527 | Calling C<AssumeRoleWithWebIdentity> does not require the use of AWS | ||||||||||||||||||||||||||||
| 528 | security credentials. Therefore, you can distribute an application (for | ||||||||||||||||||||||||||||
| 529 | example, on mobile devices) that requests temporary security | ||||||||||||||||||||||||||||
| 530 | credentials without including long-term AWS credentials in the | ||||||||||||||||||||||||||||
| 531 | application. You also don't need to deploy server-based proxy services | ||||||||||||||||||||||||||||
| 532 | that use long-term AWS credentials. Instead, the identity of the caller | ||||||||||||||||||||||||||||
| 533 | is validated by using a token from the web identity provider. For a | ||||||||||||||||||||||||||||
| 534 | comparison of C<AssumeRoleWithWebIdentity> with the other API | ||||||||||||||||||||||||||||
| 535 | operations that produce temporary credentials, see Requesting Temporary | ||||||||||||||||||||||||||||
| 536 | Security Credentials | ||||||||||||||||||||||||||||
| 537 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) | ||||||||||||||||||||||||||||
| 538 | and Comparing the AWS STS API operations | ||||||||||||||||||||||||||||
| 539 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) | ||||||||||||||||||||||||||||
| 540 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 541 | |||||||||||||||||||||||||||||
| 542 | The temporary security credentials returned by this API consist of an | ||||||||||||||||||||||||||||
| 543 | access key ID, a secret access key, and a security token. Applications | ||||||||||||||||||||||||||||
| 544 | can use these temporary security credentials to sign calls to AWS | ||||||||||||||||||||||||||||
| 545 | service API operations. | ||||||||||||||||||||||||||||
| 546 | |||||||||||||||||||||||||||||
| 547 | B<Session Duration> | ||||||||||||||||||||||||||||
| 548 | |||||||||||||||||||||||||||||
| 549 | By default, the temporary security credentials created by | ||||||||||||||||||||||||||||
| 550 | C<AssumeRoleWithWebIdentity> last for one hour. However, you can use | ||||||||||||||||||||||||||||
| 551 | the optional C<DurationSeconds> parameter to specify the duration of | ||||||||||||||||||||||||||||
| 552 | your session. You can provide a value from 900 seconds (15 minutes) up | ||||||||||||||||||||||||||||
| 553 | to the maximum session duration setting for the role. This setting can | ||||||||||||||||||||||||||||
| 554 | have a value from 1 hour to 12 hours. To learn how to view the maximum | ||||||||||||||||||||||||||||
| 555 | value for your role, see View the Maximum Session Duration Setting for | ||||||||||||||||||||||||||||
| 556 | a Role | ||||||||||||||||||||||||||||
| 557 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) | ||||||||||||||||||||||||||||
| 558 | in the I<IAM User Guide>. The maximum session duration limit applies | ||||||||||||||||||||||||||||
| 559 | when you use the C<AssumeRole*> API operations or the C<assume-role*> | ||||||||||||||||||||||||||||
| 560 | CLI commands. However the limit does not apply when you use those | ||||||||||||||||||||||||||||
| 561 | operations to create a console URL. For more information, see Using IAM | ||||||||||||||||||||||||||||
| 562 | Roles | ||||||||||||||||||||||||||||
| 563 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in | ||||||||||||||||||||||||||||
| 564 | the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 565 | |||||||||||||||||||||||||||||
| 566 | B<Permissions> | ||||||||||||||||||||||||||||
| 567 | |||||||||||||||||||||||||||||
| 568 | The temporary security credentials created by | ||||||||||||||||||||||||||||
| 569 | C<AssumeRoleWithWebIdentity> can be used to make API calls to any AWS | ||||||||||||||||||||||||||||
| 570 | service with the following exception: you cannot call the STS | ||||||||||||||||||||||||||||
| 571 | C<GetFederationToken> or C<GetSessionToken> API operations. | ||||||||||||||||||||||||||||
| 572 | |||||||||||||||||||||||||||||
| 573 | (Optional) You can pass inline or managed session policies | ||||||||||||||||||||||||||||
| 574 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) | ||||||||||||||||||||||||||||
| 575 | to this operation. You can pass a single JSON policy document to use as | ||||||||||||||||||||||||||||
| 576 | an inline session policy. You can also specify up to 10 managed | ||||||||||||||||||||||||||||
| 577 | policies to use as managed session policies. The plaintext that you use | ||||||||||||||||||||||||||||
| 578 | for both inline and managed session policies can't exceed 2,048 | ||||||||||||||||||||||||||||
| 579 | characters. Passing policies to this operation returns new temporary | ||||||||||||||||||||||||||||
| 580 | credentials. The resulting session's permissions are the intersection | ||||||||||||||||||||||||||||
| 581 | of the role's identity-based policy and the session policies. You can | ||||||||||||||||||||||||||||
| 582 | use the role's temporary credentials in subsequent AWS API calls to | ||||||||||||||||||||||||||||
| 583 | access resources in the account that owns the role. You cannot use | ||||||||||||||||||||||||||||
| 584 | session policies to grant more permissions than those allowed by the | ||||||||||||||||||||||||||||
| 585 | identity-based policy of the role that is being assumed. For more | ||||||||||||||||||||||||||||
| 586 | information, see Session Policies | ||||||||||||||||||||||||||||
| 587 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) | ||||||||||||||||||||||||||||
| 588 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 589 | |||||||||||||||||||||||||||||
| 590 | B<Tags> | ||||||||||||||||||||||||||||
| 591 | |||||||||||||||||||||||||||||
| 592 | (Optional) You can configure your IdP to pass attributes into your web | ||||||||||||||||||||||||||||
| 593 | identity token as session tags. Each session tag consists of a key name | ||||||||||||||||||||||||||||
| 594 | and an associated value. For more information about session tags, see | ||||||||||||||||||||||||||||
| 595 | Passing Session Tags in STS | ||||||||||||||||||||||||||||
| 596 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) | ||||||||||||||||||||||||||||
| 597 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 598 | |||||||||||||||||||||||||||||
| 599 | You can pass up to 50 session tags. The plaintext session tag keys | ||||||||||||||||||||||||||||
| 600 | canE<rsquo>t exceed 128 characters and the values canE<rsquo>t exceed | ||||||||||||||||||||||||||||
| 601 | 256 characters. For these and additional limits, see IAM and STS | ||||||||||||||||||||||||||||
| 602 | Character Limits | ||||||||||||||||||||||||||||
| 603 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) | ||||||||||||||||||||||||||||
| 604 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 605 | |||||||||||||||||||||||||||||
| 606 | An AWS conversion compresses the passed session policies and session | ||||||||||||||||||||||||||||
| 607 | tags into a packed binary format that has a separate limit. Your | ||||||||||||||||||||||||||||
| 608 | request can fail for this limit even if your plaintext meets the other | ||||||||||||||||||||||||||||
| 609 | requirements. The C<PackedPolicySize> response element indicates by | ||||||||||||||||||||||||||||
| 610 | percentage how close the policies and tags for your request are to the | ||||||||||||||||||||||||||||
| 611 | upper size limit. | ||||||||||||||||||||||||||||
| 612 | |||||||||||||||||||||||||||||
| 613 | You can pass a session tag with the same key as a tag that is attached | ||||||||||||||||||||||||||||
| 614 | to the role. When you do, the session tag overrides the role tag with | ||||||||||||||||||||||||||||
| 615 | the same key. | ||||||||||||||||||||||||||||
| 616 | |||||||||||||||||||||||||||||
| 617 | An administrator must grant you the permissions necessary to pass | ||||||||||||||||||||||||||||
| 618 | session tags. The administrator can also create granular permissions to | ||||||||||||||||||||||||||||
| 619 | allow you to pass only specific session tags. For more information, see | ||||||||||||||||||||||||||||
| 620 | Tutorial: Using Tags for Attribute-Based Access Control | ||||||||||||||||||||||||||||
| 621 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) | ||||||||||||||||||||||||||||
| 622 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 623 | |||||||||||||||||||||||||||||
| 624 | You can set the session tags as transitive. Transitive tags persist | ||||||||||||||||||||||||||||
| 625 | during role chaining. For more information, see Chaining Roles with | ||||||||||||||||||||||||||||
| 626 | Session Tags | ||||||||||||||||||||||||||||
| 627 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) | ||||||||||||||||||||||||||||
| 628 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 629 | |||||||||||||||||||||||||||||
| 630 | B<Identities> | ||||||||||||||||||||||||||||
| 631 | |||||||||||||||||||||||||||||
| 632 | Before your application can call C<AssumeRoleWithWebIdentity>, you must | ||||||||||||||||||||||||||||
| 633 | have an identity token from a supported identity provider and create a | ||||||||||||||||||||||||||||
| 634 | role that the application can assume. The role that your application | ||||||||||||||||||||||||||||
| 635 | assumes must trust the identity provider that is associated with the | ||||||||||||||||||||||||||||
| 636 | identity token. In other words, the identity provider must be specified | ||||||||||||||||||||||||||||
| 637 | in the role's trust policy. | ||||||||||||||||||||||||||||
| 638 | |||||||||||||||||||||||||||||
| 639 | Calling C<AssumeRoleWithWebIdentity> can result in an entry in your AWS | ||||||||||||||||||||||||||||
| 640 | CloudTrail logs. The entry includes the Subject | ||||||||||||||||||||||||||||
| 641 | (http://openid.net/specs/openid-connect-core-1_0.html#Claims) of the | ||||||||||||||||||||||||||||
| 642 | provided web identity token. We recommend that you avoid using any | ||||||||||||||||||||||||||||
| 643 | personally identifiable information (PII) in this field. For example, | ||||||||||||||||||||||||||||
| 644 | you could instead use a GUID or a pairwise identifier, as suggested in | ||||||||||||||||||||||||||||
| 645 | the OIDC specification | ||||||||||||||||||||||||||||
| 646 | (http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes). | ||||||||||||||||||||||||||||
| 647 | |||||||||||||||||||||||||||||
| 648 | For more information about how to use web identity federation and the | ||||||||||||||||||||||||||||
| 649 | C<AssumeRoleWithWebIdentity> API, see the following resources: | ||||||||||||||||||||||||||||
| 650 | |||||||||||||||||||||||||||||
| 651 | =over | ||||||||||||||||||||||||||||
| 652 | |||||||||||||||||||||||||||||
| 653 | =item * | ||||||||||||||||||||||||||||
| 654 | |||||||||||||||||||||||||||||
| 655 | Using Web Identity Federation API Operations for Mobile Apps | ||||||||||||||||||||||||||||
| 656 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html) | ||||||||||||||||||||||||||||
| 657 | and Federation Through a Web-based Identity Provider | ||||||||||||||||||||||||||||
| 658 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity). | ||||||||||||||||||||||||||||
| 659 | |||||||||||||||||||||||||||||
| 660 | =item * | ||||||||||||||||||||||||||||
| 661 | |||||||||||||||||||||||||||||
| 662 | Web Identity Federation Playground | ||||||||||||||||||||||||||||
| 663 | (https://aws.amazon.com/blogs/aws/the-aws-web-identity-federation-playground/). | ||||||||||||||||||||||||||||
| 664 | Walk through the process of authenticating through Login with Amazon, | ||||||||||||||||||||||||||||
| 665 | Facebook, or Google, getting temporary security credentials, and then | ||||||||||||||||||||||||||||
| 666 | using those credentials to make a request to AWS. | ||||||||||||||||||||||||||||
| 667 | |||||||||||||||||||||||||||||
| 668 | =item * | ||||||||||||||||||||||||||||
| 669 | |||||||||||||||||||||||||||||
| 670 | AWS SDK for iOS Developer Guide (http://aws.amazon.com/sdkforios/) and | ||||||||||||||||||||||||||||
| 671 | AWS SDK for Android Developer Guide | ||||||||||||||||||||||||||||
| 672 | (http://aws.amazon.com/sdkforandroid/). These toolkits contain sample | ||||||||||||||||||||||||||||
| 673 | apps that show how to invoke the identity providers. The toolkits then | ||||||||||||||||||||||||||||
| 674 | show how to use the information from these providers to get and use | ||||||||||||||||||||||||||||
| 675 | temporary security credentials. | ||||||||||||||||||||||||||||
| 676 | |||||||||||||||||||||||||||||
| 677 | =item * | ||||||||||||||||||||||||||||
| 678 | |||||||||||||||||||||||||||||
| 679 | Web Identity Federation with Mobile Applications | ||||||||||||||||||||||||||||
| 680 | (http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications). | ||||||||||||||||||||||||||||
| 681 | This article discusses web identity federation and shows an example of | ||||||||||||||||||||||||||||
| 682 | how to use web identity federation to get access to content in Amazon | ||||||||||||||||||||||||||||
| 683 | S3. | ||||||||||||||||||||||||||||
| 684 | |||||||||||||||||||||||||||||
| 685 | =back | ||||||||||||||||||||||||||||
| 686 | |||||||||||||||||||||||||||||
| 687 | |||||||||||||||||||||||||||||
| 688 | |||||||||||||||||||||||||||||
| 689 | =head2 DecodeAuthorizationMessage | ||||||||||||||||||||||||||||
| 690 | |||||||||||||||||||||||||||||
| 691 | =over | ||||||||||||||||||||||||||||
| 692 | |||||||||||||||||||||||||||||
| 693 | =item EncodedMessage => Str | ||||||||||||||||||||||||||||
| 694 | |||||||||||||||||||||||||||||
| 695 | |||||||||||||||||||||||||||||
| 696 | =back | ||||||||||||||||||||||||||||
| 697 | |||||||||||||||||||||||||||||
| 698 | Each argument is described in detail in: L<Paws::STS::DecodeAuthorizationMessage> | ||||||||||||||||||||||||||||
| 699 | |||||||||||||||||||||||||||||
| 700 | Returns: a L<Paws::STS::DecodeAuthorizationMessageResponse> instance | ||||||||||||||||||||||||||||
| 701 | |||||||||||||||||||||||||||||
| 702 | Decodes additional information about the authorization status of a | ||||||||||||||||||||||||||||
| 703 | request from an encoded message returned in response to an AWS request. | ||||||||||||||||||||||||||||
| 704 | |||||||||||||||||||||||||||||
| 705 | For example, if a user is not authorized to perform an operation that | ||||||||||||||||||||||||||||
| 706 | he or she has requested, the request returns a | ||||||||||||||||||||||||||||
| 707 | C<Client.UnauthorizedOperation> response (an HTTP 403 response). Some | ||||||||||||||||||||||||||||
| 708 | AWS operations additionally return an encoded message that can provide | ||||||||||||||||||||||||||||
| 709 | details about this authorization failure. | ||||||||||||||||||||||||||||
| 710 | |||||||||||||||||||||||||||||
| 711 | Only certain AWS operations return an encoded authorization message. | ||||||||||||||||||||||||||||
| 712 | The documentation for an individual operation indicates whether that | ||||||||||||||||||||||||||||
| 713 | operation returns an encoded message in addition to returning an HTTP | ||||||||||||||||||||||||||||
| 714 | code. | ||||||||||||||||||||||||||||
| 715 | |||||||||||||||||||||||||||||
| 716 | The message is encoded because the details of the authorization status | ||||||||||||||||||||||||||||
| 717 | can constitute privileged information that the user who requested the | ||||||||||||||||||||||||||||
| 718 | operation should not see. To decode an authorization status message, a | ||||||||||||||||||||||||||||
| 719 | user must be granted permissions via an IAM policy to request the | ||||||||||||||||||||||||||||
| 720 | C<DecodeAuthorizationMessage> (C<sts:DecodeAuthorizationMessage>) | ||||||||||||||||||||||||||||
| 721 | action. | ||||||||||||||||||||||||||||
| 722 | |||||||||||||||||||||||||||||
| 723 | The decoded message includes the following type of information: | ||||||||||||||||||||||||||||
| 724 | |||||||||||||||||||||||||||||
| 725 | =over | ||||||||||||||||||||||||||||
| 726 | |||||||||||||||||||||||||||||
| 727 | =item * | ||||||||||||||||||||||||||||
| 728 | |||||||||||||||||||||||||||||
| 729 | Whether the request was denied due to an explicit deny or due to the | ||||||||||||||||||||||||||||
| 730 | absence of an explicit allow. For more information, see Determining | ||||||||||||||||||||||||||||
| 731 | Whether a Request is Allowed or Denied | ||||||||||||||||||||||||||||
| 732 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow) | ||||||||||||||||||||||||||||
| 733 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 734 | |||||||||||||||||||||||||||||
| 735 | =item * | ||||||||||||||||||||||||||||
| 736 | |||||||||||||||||||||||||||||
| 737 | The principal who made the request. | ||||||||||||||||||||||||||||
| 738 | |||||||||||||||||||||||||||||
| 739 | =item * | ||||||||||||||||||||||||||||
| 740 | |||||||||||||||||||||||||||||
| 741 | The requested action. | ||||||||||||||||||||||||||||
| 742 | |||||||||||||||||||||||||||||
| 743 | =item * | ||||||||||||||||||||||||||||
| 744 | |||||||||||||||||||||||||||||
| 745 | The requested resource. | ||||||||||||||||||||||||||||
| 746 | |||||||||||||||||||||||||||||
| 747 | =item * | ||||||||||||||||||||||||||||
| 748 | |||||||||||||||||||||||||||||
| 749 | The values of condition keys in the context of the user's request. | ||||||||||||||||||||||||||||
| 750 | |||||||||||||||||||||||||||||
| 751 | =back | ||||||||||||||||||||||||||||
| 752 | |||||||||||||||||||||||||||||
| 753 | |||||||||||||||||||||||||||||
| 754 | |||||||||||||||||||||||||||||
| 755 | =head2 GetAccessKeyInfo | ||||||||||||||||||||||||||||
| 756 | |||||||||||||||||||||||||||||
| 757 | =over | ||||||||||||||||||||||||||||
| 758 | |||||||||||||||||||||||||||||
| 759 | =item AccessKeyId => Str | ||||||||||||||||||||||||||||
| 760 | |||||||||||||||||||||||||||||
| 761 | |||||||||||||||||||||||||||||
| 762 | =back | ||||||||||||||||||||||||||||
| 763 | |||||||||||||||||||||||||||||
| 764 | Each argument is described in detail in: L<Paws::STS::GetAccessKeyInfo> | ||||||||||||||||||||||||||||
| 765 | |||||||||||||||||||||||||||||
| 766 | Returns: a L<Paws::STS::GetAccessKeyInfoResponse> instance | ||||||||||||||||||||||||||||
| 767 | |||||||||||||||||||||||||||||
| 768 | Returns the account identifier for the specified access key ID. | ||||||||||||||||||||||||||||
| 769 | |||||||||||||||||||||||||||||
| 770 | Access keys consist of two parts: an access key ID (for example, | ||||||||||||||||||||||||||||
| 771 | C<AKIAIOSFODNN7EXAMPLE>) and a secret access key (for example, | ||||||||||||||||||||||||||||
| 772 | C<wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY>). For more information | ||||||||||||||||||||||||||||
| 773 | about access keys, see Managing Access Keys for IAM Users | ||||||||||||||||||||||||||||
| 774 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) | ||||||||||||||||||||||||||||
| 775 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 776 | |||||||||||||||||||||||||||||
| 777 | When you pass an access key ID to this operation, it returns the ID of | ||||||||||||||||||||||||||||
| 778 | the AWS account to which the keys belong. Access key IDs beginning with | ||||||||||||||||||||||||||||
| 779 | C<AKIA> are long-term credentials for an IAM user or the AWS account | ||||||||||||||||||||||||||||
| 780 | root user. Access key IDs beginning with C<ASIA> are temporary | ||||||||||||||||||||||||||||
| 781 | credentials that are created using STS operations. If the account in | ||||||||||||||||||||||||||||
| 782 | the response belongs to you, you can sign in as the root user and | ||||||||||||||||||||||||||||
| 783 | review your root user access keys. Then, you can pull a credentials | ||||||||||||||||||||||||||||
| 784 | report | ||||||||||||||||||||||||||||
| 785 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html) | ||||||||||||||||||||||||||||
| 786 | to learn which IAM user owns the keys. To learn who requested the | ||||||||||||||||||||||||||||
| 787 | temporary credentials for an C<ASIA> access key, view the STS events in | ||||||||||||||||||||||||||||
| 788 | your CloudTrail logs | ||||||||||||||||||||||||||||
| 789 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html) | ||||||||||||||||||||||||||||
| 790 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 791 | |||||||||||||||||||||||||||||
| 792 | This operation does not indicate the state of the access key. The key | ||||||||||||||||||||||||||||
| 793 | might be active, inactive, or deleted. Active keys might not have | ||||||||||||||||||||||||||||
| 794 | permissions to perform an operation. Providing a deleted access key | ||||||||||||||||||||||||||||
| 795 | might return an error that the key doesn't exist. | ||||||||||||||||||||||||||||
| 796 | |||||||||||||||||||||||||||||
| 797 | |||||||||||||||||||||||||||||
| 798 | =head2 GetCallerIdentity | ||||||||||||||||||||||||||||
| 799 | |||||||||||||||||||||||||||||
| 800 | |||||||||||||||||||||||||||||
| 801 | |||||||||||||||||||||||||||||
| 802 | |||||||||||||||||||||||||||||
| 803 | |||||||||||||||||||||||||||||
| 804 | |||||||||||||||||||||||||||||
| 805 | Each argument is described in detail in: L<Paws::STS::GetCallerIdentity> | ||||||||||||||||||||||||||||
| 806 | |||||||||||||||||||||||||||||
| 807 | Returns: a L<Paws::STS::GetCallerIdentityResponse> instance | ||||||||||||||||||||||||||||
| 808 | |||||||||||||||||||||||||||||
| 809 | Returns details about the IAM user or role whose credentials are used | ||||||||||||||||||||||||||||
| 810 | to call the operation. | ||||||||||||||||||||||||||||
| 811 | |||||||||||||||||||||||||||||
| 812 | No permissions are required to perform this operation. If an | ||||||||||||||||||||||||||||
| 813 | administrator adds a policy to your IAM user or role that explicitly | ||||||||||||||||||||||||||||
| 814 | denies access to the C<sts:GetCallerIdentity> action, you can still | ||||||||||||||||||||||||||||
| 815 | perform this operation. Permissions are not required because the same | ||||||||||||||||||||||||||||
| 816 | information is returned when an IAM user or role is denied access. To | ||||||||||||||||||||||||||||
| 817 | view an example response, see I Am Not Authorized to Perform: | ||||||||||||||||||||||||||||
| 818 | iam:DeleteVirtualMFADevice | ||||||||||||||||||||||||||||
| 819 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_access-denied-delete-mfa) | ||||||||||||||||||||||||||||
| 820 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 821 | |||||||||||||||||||||||||||||
| 822 | |||||||||||||||||||||||||||||
| 823 | =head2 GetFederationToken | ||||||||||||||||||||||||||||
| 824 | |||||||||||||||||||||||||||||
| 825 | =over | ||||||||||||||||||||||||||||
| 826 | |||||||||||||||||||||||||||||
| 827 | =item Name => Str | ||||||||||||||||||||||||||||
| 828 | |||||||||||||||||||||||||||||
| 829 | =item [DurationSeconds => Int] | ||||||||||||||||||||||||||||
| 830 | |||||||||||||||||||||||||||||
| 831 | =item [Policy => Str] | ||||||||||||||||||||||||||||
| 832 | |||||||||||||||||||||||||||||
| 833 | =item [PolicyArns => ArrayRef[L<Paws::STS::PolicyDescriptorType>]] | ||||||||||||||||||||||||||||
| 834 | |||||||||||||||||||||||||||||
| 835 | =item [Tags => ArrayRef[L<Paws::STS::Tag>]] | ||||||||||||||||||||||||||||
| 836 | |||||||||||||||||||||||||||||
| 837 | |||||||||||||||||||||||||||||
| 838 | =back | ||||||||||||||||||||||||||||
| 839 | |||||||||||||||||||||||||||||
| 840 | Each argument is described in detail in: L<Paws::STS::GetFederationToken> | ||||||||||||||||||||||||||||
| 841 | |||||||||||||||||||||||||||||
| 842 | Returns: a L<Paws::STS::GetFederationTokenResponse> instance | ||||||||||||||||||||||||||||
| 843 | |||||||||||||||||||||||||||||
| 844 | Returns a set of temporary security credentials (consisting of an | ||||||||||||||||||||||||||||
| 845 | access key ID, a secret access key, and a security token) for a | ||||||||||||||||||||||||||||
| 846 | federated user. A typical use is in a proxy application that gets | ||||||||||||||||||||||||||||
| 847 | temporary security credentials on behalf of distributed applications | ||||||||||||||||||||||||||||
| 848 | inside a corporate network. You must call the C<GetFederationToken> | ||||||||||||||||||||||||||||
| 849 | operation using the long-term security credentials of an IAM user. As a | ||||||||||||||||||||||||||||
| 850 | result, this call is appropriate in contexts where those credentials | ||||||||||||||||||||||||||||
| 851 | can be safely stored, usually in a server-based application. For a | ||||||||||||||||||||||||||||
| 852 | comparison of C<GetFederationToken> with the other API operations that | ||||||||||||||||||||||||||||
| 853 | produce temporary credentials, see Requesting Temporary Security | ||||||||||||||||||||||||||||
| 854 | Credentials | ||||||||||||||||||||||||||||
| 855 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) | ||||||||||||||||||||||||||||
| 856 | and Comparing the AWS STS API operations | ||||||||||||||||||||||||||||
| 857 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) | ||||||||||||||||||||||||||||
| 858 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 859 | |||||||||||||||||||||||||||||
| 860 | You can create a mobile-based or browser-based app that can | ||||||||||||||||||||||||||||
| 861 | authenticate users using a web identity provider like Login with | ||||||||||||||||||||||||||||
| 862 | Amazon, Facebook, Google, or an OpenID Connect-compatible identity | ||||||||||||||||||||||||||||
| 863 | provider. In this case, we recommend that you use Amazon Cognito | ||||||||||||||||||||||||||||
| 864 | (http://aws.amazon.com/cognito/) or C<AssumeRoleWithWebIdentity>. For | ||||||||||||||||||||||||||||
| 865 | more information, see Federation Through a Web-based Identity Provider | ||||||||||||||||||||||||||||
| 866 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity) | ||||||||||||||||||||||||||||
| 867 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 868 | |||||||||||||||||||||||||||||
| 869 | You can also call C<GetFederationToken> using the security credentials | ||||||||||||||||||||||||||||
| 870 | of an AWS account root user, but we do not recommend it. Instead, we | ||||||||||||||||||||||||||||
| 871 | recommend that you create an IAM user for the purpose of the proxy | ||||||||||||||||||||||||||||
| 872 | application. Then attach a policy to the IAM user that limits federated | ||||||||||||||||||||||||||||
| 873 | users to only the actions and resources that they need to access. For | ||||||||||||||||||||||||||||
| 874 | more information, see IAM Best Practices | ||||||||||||||||||||||||||||
| 875 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html) | ||||||||||||||||||||||||||||
| 876 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 877 | |||||||||||||||||||||||||||||
| 878 | B<Session duration> | ||||||||||||||||||||||||||||
| 879 | |||||||||||||||||||||||||||||
| 880 | The temporary credentials are valid for the specified duration, from | ||||||||||||||||||||||||||||
| 881 | 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). | ||||||||||||||||||||||||||||
| 882 | The default session duration is 43,200 seconds (12 hours). Temporary | ||||||||||||||||||||||||||||
| 883 | credentials that are obtained by using AWS account root user | ||||||||||||||||||||||||||||
| 884 | credentials have a maximum duration of 3,600 seconds (1 hour). | ||||||||||||||||||||||||||||
| 885 | |||||||||||||||||||||||||||||
| 886 | B<Permissions> | ||||||||||||||||||||||||||||
| 887 | |||||||||||||||||||||||||||||
| 888 | You can use the temporary credentials created by C<GetFederationToken> | ||||||||||||||||||||||||||||
| 889 | in any AWS service except the following: | ||||||||||||||||||||||||||||
| 890 | |||||||||||||||||||||||||||||
| 891 | =over | ||||||||||||||||||||||||||||
| 892 | |||||||||||||||||||||||||||||
| 893 | =item * | ||||||||||||||||||||||||||||
| 894 | |||||||||||||||||||||||||||||
| 895 | You cannot call any IAM operations using the AWS CLI or the AWS API. | ||||||||||||||||||||||||||||
| 896 | |||||||||||||||||||||||||||||
| 897 | =item * | ||||||||||||||||||||||||||||
| 898 | |||||||||||||||||||||||||||||
| 899 | You cannot call any STS operations except C<GetCallerIdentity>. | ||||||||||||||||||||||||||||
| 900 | |||||||||||||||||||||||||||||
| 901 | =back | ||||||||||||||||||||||||||||
| 902 | |||||||||||||||||||||||||||||
| 903 | You must pass an inline or managed session policy | ||||||||||||||||||||||||||||
| 904 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) | ||||||||||||||||||||||||||||
| 905 | to this operation. You can pass a single JSON policy document to use as | ||||||||||||||||||||||||||||
| 906 | an inline session policy. You can also specify up to 10 managed | ||||||||||||||||||||||||||||
| 907 | policies to use as managed session policies. The plaintext that you use | ||||||||||||||||||||||||||||
| 908 | for both inline and managed session policies can't exceed 2,048 | ||||||||||||||||||||||||||||
| 909 | characters. | ||||||||||||||||||||||||||||
| 910 | |||||||||||||||||||||||||||||
| 911 | Though the session policy parameters are optional, if you do not pass a | ||||||||||||||||||||||||||||
| 912 | policy, then the resulting federated user session has no permissions. | ||||||||||||||||||||||||||||
| 913 | When you pass session policies, the session permissions are the | ||||||||||||||||||||||||||||
| 914 | intersection of the IAM user policies and the session policies that you | ||||||||||||||||||||||||||||
| 915 | pass. This gives you a way to further restrict the permissions for a | ||||||||||||||||||||||||||||
| 916 | federated user. You cannot use session policies to grant more | ||||||||||||||||||||||||||||
| 917 | permissions than those that are defined in the permissions policy of | ||||||||||||||||||||||||||||
| 918 | the IAM user. For more information, see Session Policies | ||||||||||||||||||||||||||||
| 919 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) | ||||||||||||||||||||||||||||
| 920 | in the I<IAM User Guide>. For information about using | ||||||||||||||||||||||||||||
| 921 | C<GetFederationToken> to create temporary security credentials, see | ||||||||||||||||||||||||||||
| 922 | GetFederationTokenE<mdash>Federation Through a Custom Identity Broker | ||||||||||||||||||||||||||||
| 923 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken). | ||||||||||||||||||||||||||||
| 924 | |||||||||||||||||||||||||||||
| 925 | You can use the credentials to access a resource that has a | ||||||||||||||||||||||||||||
| 926 | resource-based policy. If that policy specifically references the | ||||||||||||||||||||||||||||
| 927 | federated user session in the C<Principal> element of the policy, the | ||||||||||||||||||||||||||||
| 928 | session has the permissions allowed by the policy. These permissions | ||||||||||||||||||||||||||||
| 929 | are granted in addition to the permissions granted by the session | ||||||||||||||||||||||||||||
| 930 | policies. | ||||||||||||||||||||||||||||
| 931 | |||||||||||||||||||||||||||||
| 932 | B<Tags> | ||||||||||||||||||||||||||||
| 933 | |||||||||||||||||||||||||||||
| 934 | (Optional) You can pass tag key-value pairs to your session. These are | ||||||||||||||||||||||||||||
| 935 | called session tags. For more information about session tags, see | ||||||||||||||||||||||||||||
| 936 | Passing Session Tags in STS | ||||||||||||||||||||||||||||
| 937 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) | ||||||||||||||||||||||||||||
| 938 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 939 | |||||||||||||||||||||||||||||
| 940 | You can create a mobile-based or browser-based app that can | ||||||||||||||||||||||||||||
| 941 | authenticate users using a web identity provider like Login with | ||||||||||||||||||||||||||||
| 942 | Amazon, Facebook, Google, or an OpenID Connect-compatible identity | ||||||||||||||||||||||||||||
| 943 | provider. In this case, we recommend that you use Amazon Cognito | ||||||||||||||||||||||||||||
| 944 | (http://aws.amazon.com/cognito/) or C<AssumeRoleWithWebIdentity>. For | ||||||||||||||||||||||||||||
| 945 | more information, see Federation Through a Web-based Identity Provider | ||||||||||||||||||||||||||||
| 946 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity) | ||||||||||||||||||||||||||||
| 947 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 948 | |||||||||||||||||||||||||||||
| 949 | You can also call C<GetFederationToken> using the security credentials | ||||||||||||||||||||||||||||
| 950 | of an AWS account root user, but we do not recommend it. Instead, we | ||||||||||||||||||||||||||||
| 951 | recommend that you create an IAM user for the purpose of the proxy | ||||||||||||||||||||||||||||
| 952 | application. Then attach a policy to the IAM user that limits federated | ||||||||||||||||||||||||||||
| 953 | users to only the actions and resources that they need to access. For | ||||||||||||||||||||||||||||
| 954 | more information, see IAM Best Practices | ||||||||||||||||||||||||||||
| 955 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html) | ||||||||||||||||||||||||||||
| 956 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 957 | |||||||||||||||||||||||||||||
| 958 | B<Session duration> | ||||||||||||||||||||||||||||
| 959 | |||||||||||||||||||||||||||||
| 960 | The temporary credentials are valid for the specified duration, from | ||||||||||||||||||||||||||||
| 961 | 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). | ||||||||||||||||||||||||||||
| 962 | The default session duration is 43,200 seconds (12 hours). Temporary | ||||||||||||||||||||||||||||
| 963 | credentials that are obtained by using AWS account root user | ||||||||||||||||||||||||||||
| 964 | credentials have a maximum duration of 3,600 seconds (1 hour). | ||||||||||||||||||||||||||||
| 965 | |||||||||||||||||||||||||||||
| 966 | B<Permissions> | ||||||||||||||||||||||||||||
| 967 | |||||||||||||||||||||||||||||
| 968 | You can use the temporary credentials created by C<GetFederationToken> | ||||||||||||||||||||||||||||
| 969 | in any AWS service except the following: | ||||||||||||||||||||||||||||
| 970 | |||||||||||||||||||||||||||||
| 971 | =over | ||||||||||||||||||||||||||||
| 972 | |||||||||||||||||||||||||||||
| 973 | =item * | ||||||||||||||||||||||||||||
| 974 | |||||||||||||||||||||||||||||
| 975 | You cannot call any IAM operations using the AWS CLI or the AWS API. | ||||||||||||||||||||||||||||
| 976 | |||||||||||||||||||||||||||||
| 977 | =item * | ||||||||||||||||||||||||||||
| 978 | |||||||||||||||||||||||||||||
| 979 | You cannot call any STS operations except C<GetCallerIdentity>. | ||||||||||||||||||||||||||||
| 980 | |||||||||||||||||||||||||||||
| 981 | =back | ||||||||||||||||||||||||||||
| 982 | |||||||||||||||||||||||||||||
| 983 | You must pass an inline or managed session policy | ||||||||||||||||||||||||||||
| 984 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) | ||||||||||||||||||||||||||||
| 985 | to this operation. You can pass a single JSON policy document to use as | ||||||||||||||||||||||||||||
| 986 | an inline session policy. You can also specify up to 10 managed | ||||||||||||||||||||||||||||
| 987 | policies to use as managed session policies. The plain text that you | ||||||||||||||||||||||||||||
| 988 | use for both inline and managed session policies can't exceed 2,048 | ||||||||||||||||||||||||||||
| 989 | characters. | ||||||||||||||||||||||||||||
| 990 | |||||||||||||||||||||||||||||
| 991 | Though the session policy parameters are optional, if you do not pass a | ||||||||||||||||||||||||||||
| 992 | policy, then the resulting federated user session has no permissions. | ||||||||||||||||||||||||||||
| 993 | When you pass session policies, the session permissions are the | ||||||||||||||||||||||||||||
| 994 | intersection of the IAM user policies and the session policies that you | ||||||||||||||||||||||||||||
| 995 | pass. This gives you a way to further restrict the permissions for a | ||||||||||||||||||||||||||||
| 996 | federated user. You cannot use session policies to grant more | ||||||||||||||||||||||||||||
| 997 | permissions than those that are defined in the permissions policy of | ||||||||||||||||||||||||||||
| 998 | the IAM user. For more information, see Session Policies | ||||||||||||||||||||||||||||
| 999 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) | ||||||||||||||||||||||||||||
| 1000 | in the I<IAM User Guide>. For information about using | ||||||||||||||||||||||||||||
| 1001 | C<GetFederationToken> to create temporary security credentials, see | ||||||||||||||||||||||||||||
| 1002 | GetFederationTokenE<mdash>Federation Through a Custom Identity Broker | ||||||||||||||||||||||||||||
| 1003 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken). | ||||||||||||||||||||||||||||
| 1004 | |||||||||||||||||||||||||||||
| 1005 | You can use the credentials to access a resource that has a | ||||||||||||||||||||||||||||
| 1006 | resource-based policy. If that policy specifically references the | ||||||||||||||||||||||||||||
| 1007 | federated user session in the C<Principal> element of the policy, the | ||||||||||||||||||||||||||||
| 1008 | session has the permissions allowed by the policy. These permissions | ||||||||||||||||||||||||||||
| 1009 | are granted in addition to the permissions granted by the session | ||||||||||||||||||||||||||||
| 1010 | policies. | ||||||||||||||||||||||||||||
| 1011 | |||||||||||||||||||||||||||||
| 1012 | B<Tags> | ||||||||||||||||||||||||||||
| 1013 | |||||||||||||||||||||||||||||
| 1014 | (Optional) You can pass tag key-value pairs to your session. These are | ||||||||||||||||||||||||||||
| 1015 | called session tags. For more information about session tags, see | ||||||||||||||||||||||||||||
| 1016 | Passing Session Tags in STS | ||||||||||||||||||||||||||||
| 1017 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) | ||||||||||||||||||||||||||||
| 1018 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 1019 | |||||||||||||||||||||||||||||
| 1020 | An administrator must grant you the permissions necessary to pass | ||||||||||||||||||||||||||||
| 1021 | session tags. The administrator can also create granular permissions to | ||||||||||||||||||||||||||||
| 1022 | allow you to pass only specific session tags. For more information, see | ||||||||||||||||||||||||||||
| 1023 | Tutorial: Using Tags for Attribute-Based Access Control | ||||||||||||||||||||||||||||
| 1024 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) | ||||||||||||||||||||||||||||
| 1025 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 1026 | |||||||||||||||||||||||||||||
| 1027 | Tag keyE<ndash>value pairs are not case sensitive, but case is | ||||||||||||||||||||||||||||
| 1028 | preserved. This means that you cannot have separate C<Department> and | ||||||||||||||||||||||||||||
| 1029 | C<department> tag keys. Assume that the user that you are federating | ||||||||||||||||||||||||||||
| 1030 | has the C<Department>=C<Marketing> tag and you pass the | ||||||||||||||||||||||||||||
| 1031 | C<department>=C<engineering> session tag. C<Department> and | ||||||||||||||||||||||||||||
| 1032 | C<department> are not saved as separate tags, and the session tag | ||||||||||||||||||||||||||||
| 1033 | passed in the request takes precedence over the user tag. | ||||||||||||||||||||||||||||
| 1034 | |||||||||||||||||||||||||||||
| 1035 | |||||||||||||||||||||||||||||
| 1036 | =head2 GetSessionToken | ||||||||||||||||||||||||||||
| 1037 | |||||||||||||||||||||||||||||
| 1038 | =over | ||||||||||||||||||||||||||||
| 1039 | |||||||||||||||||||||||||||||
| 1040 | =item [DurationSeconds => Int] | ||||||||||||||||||||||||||||
| 1041 | |||||||||||||||||||||||||||||
| 1042 | =item [SerialNumber => Str] | ||||||||||||||||||||||||||||
| 1043 | |||||||||||||||||||||||||||||
| 1044 | =item [TokenCode => Str] | ||||||||||||||||||||||||||||
| 1045 | |||||||||||||||||||||||||||||
| 1046 | |||||||||||||||||||||||||||||
| 1047 | =back | ||||||||||||||||||||||||||||
| 1048 | |||||||||||||||||||||||||||||
| 1049 | Each argument is described in detail in: L<Paws::STS::GetSessionToken> | ||||||||||||||||||||||||||||
| 1050 | |||||||||||||||||||||||||||||
| 1051 | Returns: a L<Paws::STS::GetSessionTokenResponse> instance | ||||||||||||||||||||||||||||
| 1052 | |||||||||||||||||||||||||||||
| 1053 | Returns a set of temporary credentials for an AWS account or IAM user. | ||||||||||||||||||||||||||||
| 1054 | The credentials consist of an access key ID, a secret access key, and a | ||||||||||||||||||||||||||||
| 1055 | security token. Typically, you use C<GetSessionToken> if you want to | ||||||||||||||||||||||||||||
| 1056 | use MFA to protect programmatic calls to specific AWS API operations | ||||||||||||||||||||||||||||
| 1057 | like Amazon EC2 C<StopInstances>. MFA-enabled IAM users would need to | ||||||||||||||||||||||||||||
| 1058 | call C<GetSessionToken> and submit an MFA code that is associated with | ||||||||||||||||||||||||||||
| 1059 | their MFA device. Using the temporary security credentials that are | ||||||||||||||||||||||||||||
| 1060 | returned from the call, IAM users can then make programmatic calls to | ||||||||||||||||||||||||||||
| 1061 | API operations that require MFA authentication. If you do not supply a | ||||||||||||||||||||||||||||
| 1062 | correct MFA code, then the API returns an access denied error. For a | ||||||||||||||||||||||||||||
| 1063 | comparison of C<GetSessionToken> with the other API operations that | ||||||||||||||||||||||||||||
| 1064 | produce temporary credentials, see Requesting Temporary Security | ||||||||||||||||||||||||||||
| 1065 | Credentials | ||||||||||||||||||||||||||||
| 1066 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) | ||||||||||||||||||||||||||||
| 1067 | and Comparing the AWS STS API operations | ||||||||||||||||||||||||||||
| 1068 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) | ||||||||||||||||||||||||||||
| 1069 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 1070 | |||||||||||||||||||||||||||||
| 1071 | B<Session Duration> | ||||||||||||||||||||||||||||
| 1072 | |||||||||||||||||||||||||||||
| 1073 | The C<GetSessionToken> operation must be called by using the long-term | ||||||||||||||||||||||||||||
| 1074 | AWS security credentials of the AWS account root user or an IAM user. | ||||||||||||||||||||||||||||
| 1075 | Credentials that are created by IAM users are valid for the duration | ||||||||||||||||||||||||||||
| 1076 | that you specify. This duration can range from 900 seconds (15 minutes) | ||||||||||||||||||||||||||||
| 1077 | up to a maximum of 129,600 seconds (36 hours), with a default of 43,200 | ||||||||||||||||||||||||||||
| 1078 | seconds (12 hours). Credentials based on account credentials can range | ||||||||||||||||||||||||||||
| 1079 | from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a | ||||||||||||||||||||||||||||
| 1080 | default of 1 hour. | ||||||||||||||||||||||||||||
| 1081 | |||||||||||||||||||||||||||||
| 1082 | B<Permissions> | ||||||||||||||||||||||||||||
| 1083 | |||||||||||||||||||||||||||||
| 1084 | The temporary security credentials created by C<GetSessionToken> can be | ||||||||||||||||||||||||||||
| 1085 | used to make API calls to any AWS service with the following | ||||||||||||||||||||||||||||
| 1086 | exceptions: | ||||||||||||||||||||||||||||
| 1087 | |||||||||||||||||||||||||||||
| 1088 | =over | ||||||||||||||||||||||||||||
| 1089 | |||||||||||||||||||||||||||||
| 1090 | =item * | ||||||||||||||||||||||||||||
| 1091 | |||||||||||||||||||||||||||||
| 1092 | You cannot call any IAM API operations unless MFA authentication | ||||||||||||||||||||||||||||
| 1093 | information is included in the request. | ||||||||||||||||||||||||||||
| 1094 | |||||||||||||||||||||||||||||
| 1095 | =item * | ||||||||||||||||||||||||||||
| 1096 | |||||||||||||||||||||||||||||
| 1097 | You cannot call any STS API I<except> C<AssumeRole> or | ||||||||||||||||||||||||||||
| 1098 | C<GetCallerIdentity>. | ||||||||||||||||||||||||||||
| 1099 | |||||||||||||||||||||||||||||
| 1100 | =back | ||||||||||||||||||||||||||||
| 1101 | |||||||||||||||||||||||||||||
| 1102 | We recommend that you do not call C<GetSessionToken> with AWS account | ||||||||||||||||||||||||||||
| 1103 | root user credentials. Instead, follow our best practices | ||||||||||||||||||||||||||||
| 1104 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users) | ||||||||||||||||||||||||||||
| 1105 | by creating one or more IAM users, giving them the necessary | ||||||||||||||||||||||||||||
| 1106 | permissions, and using IAM users for everyday interaction with AWS. | ||||||||||||||||||||||||||||
| 1107 | |||||||||||||||||||||||||||||
| 1108 | The credentials that are returned by C<GetSessionToken> are based on | ||||||||||||||||||||||||||||
| 1109 | permissions associated with the user whose credentials were used to | ||||||||||||||||||||||||||||
| 1110 | call the operation. If C<GetSessionToken> is called using AWS account | ||||||||||||||||||||||||||||
| 1111 | root user credentials, the temporary credentials have root user | ||||||||||||||||||||||||||||
| 1112 | permissions. Similarly, if C<GetSessionToken> is called using the | ||||||||||||||||||||||||||||
| 1113 | credentials of an IAM user, the temporary credentials have the same | ||||||||||||||||||||||||||||
| 1114 | permissions as the IAM user. | ||||||||||||||||||||||||||||
| 1115 | |||||||||||||||||||||||||||||
| 1116 | For more information about using C<GetSessionToken> to create temporary | ||||||||||||||||||||||||||||
| 1117 | credentials, go to Temporary Credentials for Users in Untrusted | ||||||||||||||||||||||||||||
| 1118 | Environments | ||||||||||||||||||||||||||||
| 1119 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken) | ||||||||||||||||||||||||||||
| 1120 | in the I<IAM User Guide>. | ||||||||||||||||||||||||||||
| 1121 | |||||||||||||||||||||||||||||
| 1122 | |||||||||||||||||||||||||||||
| 1123 | |||||||||||||||||||||||||||||
| 1124 | |||||||||||||||||||||||||||||
| 1125 | =head1 PAGINATORS | ||||||||||||||||||||||||||||
| 1126 | |||||||||||||||||||||||||||||
| 1127 | Paginator methods are helpers that repetively call methods that return partial results | ||||||||||||||||||||||||||||
| 1128 | |||||||||||||||||||||||||||||
| 1129 | |||||||||||||||||||||||||||||
| 1130 | |||||||||||||||||||||||||||||
| 1131 | |||||||||||||||||||||||||||||
| 1132 | =head1 SEE ALSO | ||||||||||||||||||||||||||||
| 1133 | |||||||||||||||||||||||||||||
| 1134 | This service class forms part of L<Paws> | ||||||||||||||||||||||||||||
| 1135 | |||||||||||||||||||||||||||||
| 1136 | =head1 BUGS and CONTRIBUTIONS | ||||||||||||||||||||||||||||
| 1137 | |||||||||||||||||||||||||||||
| 1138 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||||||||||||||||||||||||||||
| 1139 | |||||||||||||||||||||||||||||
| 1140 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||||||||||||||||||||||||||||
| 1141 | |||||||||||||||||||||||||||||
| 1142 | =cut | ||||||||||||||||||||||||||||
| 1143 | |||||||||||||||||||||||||||||