AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This method is used internally to access the Amazon Security Token service within other service assemblies. Please use AmazonSecurityTokenServiceClient to access the Amazon Security Token service instead.

Use Amazon Security Token Service to assume a role. Proxy settings that are required for the HTTPS and STS calls made during the authentication/credential generation process are supported and should have been configured on the STS ClientConfig instance associated with the STS client instance exposing this interface.

Namespace: Amazon.Runtime.SharedInterfaces
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z

Syntax

C# 
public abstract AssumeRoleImmutableCredentials CredentialsFromAssumeRoleWithWebIdentityAuthentication(
         String webIdentityToken,
         String roleArn,
         String roleSessionName,
         AssumeRoleWithWebIdentityCredentialsOptions options
)

Parameters

webIdentityToken
Type: System.String

The web identity token used to assume the role.

roleArn
Type: System.String

The Amazon Resource Name (ARN) of the role to assume.

roleSessionName
Type: System.String

An identifier for the assumed role session.

options
Type: Amazon.Runtime.AssumeRoleWithWebIdentityCredentialsOptions

Options to be used in the call to AssumeRoleWithWebIdentity

Return Value


Type: AssumeRoleImmutableCredentials

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer