AWS SDK Version 3 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.

Classes

NameDescription
Class AWSCredentialsFactory

Factory to construct different types of AWSCredentials based on a profile.

Class CredentialProfile

A named group of options that are persisted and used to obtain AWSCredentials.

Class CredentialProfileOptions

The options that are available for creating AWSCredentials with the AWSCredentialsFactory. The type of AWSCredentials that are created depends on which Options are set. Below are the different types of credentials returned, along with the options that are used to obtain them. ([] denotes options that are not required) BasicAWSCredentials AccessKey SecretKey SessionAWSCredentials AccessKey SecretKey Token AssmeRoleAWSCredentials SourceProfile RoleArn [ExternalID] [MfaSerial] FederatedAWSCredentials EndpointName RoleArn [UserIdentity]

Class CredentialProfileStoreChain

Class to abstract the combined use of NetSDKCredentialsFile and SharedCredentialsFile where possible.

Class NetSDKCredentialsFile

This class allows profiles supporting AWSCredentials to be registered with the SDK so that they can later be reference by a profile name. The credential profiles will be available for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell.

The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API.

This class is not threadsafe.

Class SAMLEndpoint

Representation of a SAML Endpoint.

Class SAMLEndpointManager

Manages endpoints to be used in conjunction with SAML role profiles. The role profiles reference the endpoint to obtain the actual endpoint and any customization settings needed to perform authentication.

Class SharedCredentialsFile

Provides access to read and write to the shared credentials INI file. The file is read, parsed, and validated at construction time. Changes can be made using the RegisterProfile() and UnregisterProfile() methods. This class is not threadsafe.

Interfaces

NameDescription
Interface ICredentialProfileSource

Interface to define the necessary operations for a CredentialProfile lookup mechanism.

Interface ICredentialProfileStore

Interface to define the necessary operations for a CredentialProfile storage mechanism.

Enums

NameDescription
Enum SAMLAuthenticationType

Represents the different types of authentication available for SAML endpoints.