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.

AWS Credentials that are resolved using AWS Signin. The initial Amazon.Runtime.Credentials.Internal.LoginToken is generated by tooling like AWS CLI or AWS Tools for PowerShell. The Login Token is refreshed using RefreshToken if it's AccessToken is nearing expiry or has already expired.

To use LoginAWSCredentials, AWSSDK.Signin package for Signin service must be added as a dependency in the application.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.Identity.BaseIdentity
    Amazon.Runtime.AWSCredentials
      Amazon.Runtime.RefreshingAWSCredentials
        Amazon.Runtime.LoginAWSCredentials

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

Syntax

C#
public class LoginAWSCredentials : RefreshingAWSCredentials
         IDisposable

The LoginAWSCredentials type exposes the following members

Constructors

NameDescription
Public Method LoginAWSCredentials(LoginAWSCredentialsOptions)

Constructs an LoginAWSCredentials object.

Properties

NameTypeDescription
Public Property Expiration System.Nullable<System.DateTime> Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Property ExpirationBuffer System.TimeSpan Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Property Options Amazon.Runtime.LoginAWSCredentialsOptions

Options to be used in the Login flow to resolve credentials.

Public Property PreemptExpiryTime System.TimeSpan Inherited from Amazon.Runtime.RefreshingAWSCredentials.

Methods

Note:

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

NameDescription
Public Method ClearCredentials() Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Method Dispose() Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Method GetCredentials() Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Method GetCredentialsAsync() Inherited from Amazon.Runtime.RefreshingAWSCredentials.

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