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 AmazonClientException

Exception thrown by the SDK for errors that occur within the SDK.

Class AmazonDateTimeUnmarshallingException

This exception is thrown when there is a parse error on the response back from AWS.

Class AmazonServiceClient
Class AmazonServiceException

A base exception for some Amazon Web Services.

Most exceptions thrown to client code will be service-specific exceptions, though some services may throw this exception if there is a problem which is caught in the core client code.

Class AmazonUnmarshallingException

This exception is thrown when there is a parse error on the response back from AWS.

Class AmazonWebServiceRequest

Base class for request used by some of the services.

Class AmazonWebServiceResponse

Abstract class for Response objects, contains only metadata, and no result information.

Class AnonymousAWSCredentials

Anonymous credentials. Using these credentials, the client does not sign the request.

Class AppConfigAWSCredentials

Obtains credentials from access key/secret key or AWSProfileName settings in the application's app.config or web.config file.

Class AppConfigAWSRegion

Determines region based on application configuration settings. If the configuration does not contain the region setting key an InvalidOperationException is thrown.

Class AssumeRoleAWSCredentials

AWS Credentials that automatically refresh by calling AssumeRole on the Amazon Security Token Service.

Class AssumeRoleAWSCredentialsOptions
Class AssumeRoleImmutableCredentials

Immutable representation of AWS credentials obtained as a result of authenticating with the AssumeRole method of the Security Token Service.

Class AWSCredentials

Abstract class that represents a credentials object for AWS services.

Class AWSRegion

Base class for determining region based on inspection.

Class BasicAWSCredentials

Basic set of credentials consisting of an AccessKey and SecretKey

Class ClientConfig

This class is the base class of all the configurations settings to connect to a service.

Class ConstantClass

Base class for constant class that holds the value that will be sent to AWS for the static constants.

Class CredentialRequestCallbackArgs

State class passed on callback to demand user credentials when authentication needs to be performed using a non-default identity.

Class CredentialRequestCallbackRequiredException

Exception thrown on validation of a StoredProfileFederatedCredentials instance if the role profile is configured to use a non-default user identity and the QueryUserCredentialCallback on the instance has not been set.

Class ECSTaskCredentials

When running in an ECS container and AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set, use the given end point to retrieve the credentials.

Class EnvironmentAWSCredentials

Credentials that are retrieved from ConfigurationManager.AppSettings

Class EnvironmentVariableAWSRegion

Determines region based on an environment variable. If the environment does not contain the region setting key an InvalidOperationException is thrown.

Class EnvironmentVariablesAWSCredentials

Uses aws credentials stored in environment variables to construct the credentials object. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used for the access key id and secret key. If the variable AWS_SESSION_TOKEN exists then it will be used to create temporary session credentials.

Class ExceptionEventArgs
Class ExceptionEventHandler
Class FallbackCredentialsFactory
Class FallbackCredentialsFactory.CredentialsGenerator
Class FallbackRegionFactory

Probing mechanism to determine region from various sources.

Class FederatedAuthenticationCancelledException

Custom exception type thrown when a role profile with user identity is used in conjunction with a credential request callback. This exception is thrown if the callback returns null, indicating the user declined to supply credentials.

Class FederatedAuthenticationFailureException

Custom exception type thrown when authentication for a user fails due to invalid credentials.

Class FederatedAWSCredentials

Temporary credentials that are created following successful authentication with a federated endpoint supporting SAML.

Class FederatedAWSCredentialsOptions

Options that control the behavior of Amazon.Runtime.FederatedAWSCredentials.

Class HeadersRequestEventArgs
Class ImmutableCredentials

Immutable representation of AWS credentials.

Class InstanceProfileAWSCredentials

Credentials that are retrieved from the Instance Profile service on an EC2 instance

Class InstanceProfileAWSRegion

Determines region based on inspection of the instance metadata if running on an EC2 instance. If instance metadata cannot be read or does not contain region information an InvalidOperationException is thrown.

Class ParameterValue

Abstract parameter value.

Class PreRequestEventArgs
Class PreRequestEventHandler
Class ProfileAWSRegion

Determines region based on a Amazon.Runtime.CredentialManagement.CredentialProfile stored in an Amazon.Runtime.CredentialManagement.ICredentialProfileSource. If the profile doesn't exist or there is no region information an InvalidOperationException is thrown.

Class RefreshingAWSCredentials

Abstract class for automatically refreshing AWS credentials

Class RefreshingAWSCredentials.CredentialsRefreshState

Refresh state container consisting of credentials and the date of the their expiration

Class RequestEventArgs
Class RequestEventHandler
Class ResponseEventArgs
Class ResponseEventHandler
Class ResponseMetadata

Information about the request.

Class RetryPolicy

A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries.

Class SAMLImmutableCredentials

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

Class SessionAWSCredentials

Session credentials consisting of AccessKey, SecretKey and Token

Class SignatureException

This exception is thrown if there are problems signing the request.

Class StoredProfileAWSCredentials

Credentials that are retrieved using a stored profile.

Unless otherwise specified priority is given to loading credentials from the SDK credential store file which is shared between the SDK, PowerShell CLI and Toolkit. Credentials in profiles in this file are encrypted and can only be used by the user account on the current machine that stored the profile. Credentials can also be loaded from the plain-text ini-format credential file which is shared with other AWS SDKs. This file is expected to exist in a '.aws' folder in the user's home directory but alternate locations can be specified using either the AWSProfilesLocation setting in the application configuration file, or by using the AWS_SHARED_CREDENTIALS_FILE environment variable.

The profile name can be specified in the App.config using the AWSProfileName setting.

Class StoredProfileCredentials

Helper routiners for AWS and Federated credential profiles. Probes the profile type for the supplied profile name and returns the appropriate profile instance.

Class StoredProfileFederatedCredentials

Temporary credentials that are created following successful authentication with a federated endpoint supporting SAML.

Class StoredProfileFederatedCredentials.RequestUserCredential

Callback signature for obtaining user credentials that may be needed for authentication.

Class StreamTransferProgressArgs
Class StringListParameterValue

String list parameter value.

Class StringParameterValue

String parameter value.

Class URIBasedRefreshingCredentialHelper
Class WebServiceExceptionEventArgs
Class WebServiceRequestEventArgs
Class WebServiceResponseEventArgs

Interfaces

NameDescription
Interface IAmazonService

All Amazon service interfaces like IAmazonS3 extend from this interface. This allows all the Amazon service interfaces be identified by this base interface and helps with generic constraints.

Interface IAsyncExecutionContext
Interface IAsyncRequestContext
Interface IAsyncResponseContext
Interface IClientConfig

This interface is the read only access to the ClientConfig object used when setting up service clients. Once service clients are initiated the config object should not be changed to avoid issues with using a service client in a multi threaded environment.

Interface IExceptionHandler

The interface for an exception handler.

Interface IExceptionHandler<>

The interface for an exception handler with a generic parameter for the exception type.

Interface IExecutionContext
Interface IHttpRequest<>

The interface for an HTTP request that is agnostic of the underlying HTTP API.

Interface IHttpRequestFactory<>

The interface for a HTTP request factory.

Interface ILogMessage

Interface for a single logged message.

Interface IMetricsFormatter

User supplied type to perform metrics formatting.

Interface IMetricsTiming

Represents how long a phase of an SDK request took.

Interface IPipelineHandler

Interface for a handler in a pipeline.

Interface IRequestContext
Interface IRequestMetrics

Metrics collected by the SDK on a per-request basis.

Interface IResponseContext

Enums

NameDescription
Enum ErrorType

Which end of a request was responsible for a service error response.

Enum Metric

Predefined request metrics that are collected by the SDK.

Enum SigningAlgorithm

The valid hashing algorithm supported by the sdk for request signing.