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.

Immutable representation of AWS credentials obtained as a result of authenticating against a SAML-supporting federated identity provider.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.ImmutableCredentials
    Amazon.Runtime.SAMLImmutableCredentials

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

Syntax

C# 
public class SAMLImmutableCredentials : ImmutableCredentials

The SAMLImmutableCredentials type exposes the following members

Constructors

NameDescription
Public Method SAMLImmutableCredentials(string, string, string, DateTime, string)

Constructs an instance with supplied keys and SAML assertion data.

Public Method SAMLImmutableCredentials(string, string, string, DateTime, string, string)

Constructs an instance with supplied keys SAML assertion data, and an account id. When the account id is set and the service supports account id based endpoints, AWS will send the request using the account-based endpoint rather than the regional endpount. Account-based endpoints take the form https://accountId.ddb.region.amazonaws.com

Public Method SAMLImmutableCredentials(ImmutableCredentials, DateTime, string, string)

Constructs an instance with supplied keys and SAML assertion data and an account id. When the account id is set and the service supports account id based endpoints, AWS will send the request using the account-based endpoint rather than the regional endpount. Account-based endpoints take the form https://accountId.ddb.region.amazonaws.com

Public Method SAMLImmutableCredentials(ImmutableCredentials, DateTime, string)

Constructs an instance with supplied keys and SAML assertion data.

Properties

NameTypeDescription
Public Property AccessKey System.String Inherited from Amazon.Runtime.ImmutableCredentials.
Public Property AccountId System.String Inherited from Amazon.Runtime.ImmutableCredentials.
Public Property Expires System.DateTime

The expiry time of the credentials, obtained from the AssumeRoleWithSAML response.

Public Property SecretKey System.String Inherited from Amazon.Runtime.ImmutableCredentials.
Public Property Subject System.String

The value of the NameID element in the Subject element of the SAML assertion, as returned in the AssumeRoleWithSAML response from the Security Token Service.

Public Property Token System.String Inherited from Amazon.Runtime.ImmutableCredentials.
Public Property UseToken System.Boolean Inherited from Amazon.Runtime.ImmutableCredentials.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.7.2 or higher.

NameDescription
Public Method Copy()

Returns a copy of the current credentials.

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