Namespace Amazon.Runtime
Classes
- AWSCredentials
Abstract class that represents a credentials object for AWS services.
- AWSRegion
Base class for determining region based on inspection.
- AmazonClientException
Exception thrown by the SDK for errors that occur within the SDK.
- AmazonDateTimeUnmarshallingException
This exception is thrown when there is a parse error on the response back from AWS.
- 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.
- AmazonUnmarshallingException
This exception is thrown when there is a parse error on the response back from AWS.
- AmazonWebServiceRequest
Base class for request used by some of the services.
- AmazonWebServiceResponse
Abstract class for Response objects, contains only metadata, and no result information.
- AnonymousAWSCredentials
Anonymous credentials. Using these credentials, the client does not sign the request.
- AppConfigAWSCredentials
Obtains credentials from access key/secret key or AWSProfileName settings in the application's app.config or web.config file.
- AppConfigAWSRegion
Determines region based on application configuration settings. If the configuration does not contain the region setting key an InvalidOperationException is thrown.
- AssumeRoleAWSCredentials
AWS Credentials that automatically refresh by calling AssumeRole on the Amazon Security Token Service.
- AssumeRoleImmutableCredentials
Immutable representation of AWS credentials obtained as a result of authenticating with the AssumeRole method of the Security Token Service.
- AssumeRoleWithWebIdentityCredentials
AWS Credentials that automatically refresh by calling AssumeRole on the Amazon Security Token Service.
- AssumeRoleWithWebIdentityCredentialsOptions
Options for using a credentials object to make AssumeRoleWithWebIdentity calls.
- BasicAWSCredentials
Basic set of credentials consisting of an AccessKey and SecretKey
- ClientConfig
This class is the base class of all the configurations settings to connect to a service.
- ConstantClass
Base class for constant class that holds the value that will be sent to AWS for the static constants.
- CorrectClockSkew
Utility class that stores clock skew information.
- CredentialRequestCallbackArgs
State class passed on callback to demand user credentials when authentication needs to be performed using a non-default identity.
- 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.
- ECSTaskCredentials
When running in an ECS container and AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set, use the given end point to retrieve the credentials.
- EnvironmentAWSCredentials
Credentials that are retrieved from ConfigurationManager.AppSettings
- EnvironmentVariableAWSEndpointDiscoveryEnabled
Determines the endpoint discovery enabled value based on an environment variable. If no value is found in the environment then an InvalidOperationException is thrown.
- EnvironmentVariableAWSRegion
Determines region based on an environment variable. If the environment does not contain the region setting key an InvalidOperationException is thrown.
- 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.
- FallbackEndpointDiscoveryEnabledFactory
Probing mechanism to determine the endpoint discovery enabled value from various sources.
- FallbackRegionFactory
Probing mechanism to determine region from various sources.
- FederatedAWSCredentials
Temporary credentials that are created following successful authentication with a federated endpoint supporting SAML.
- FederatedAWSCredentialsOptions
Options that control the behavior of FederatedAWSCredentials.
- 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.
- FederatedAuthenticationFailureException
Custom exception type thrown when authentication for a user fails due to invalid credentials.
- ImmutableCredentials
Immutable representation of AWS credentials.
- InstanceProfileAWSCredentials
Credentials that are retrieved from the Instance Profile service on an EC2 instance
- 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.
- ParameterValue
Abstract parameter value.
- ProcessAWSCredentialException
Exception class to capture all exceptions encountered when starting or executing the "credential_process" process. If the user has specified an executable and the SDK is unable to execute it, the exception should be surfaces to the user instead of moving on to the next credential provider.
- ProcessAWSCredentials
Process Credentials can retrieve credentials by running a process and reading its stdout. A new config option, "credential_process" is added to the shared config file that allows customers to specify which process to run. The credentials retrieved by running this process could be either Basic or Session credentials.
- ProfileAWSEndpointDiscoveryEnabled
Determines endpoint discovery enabled based on a CredentialProfile stored in an ICredentialProfileSource. If the profile doesn't exist or there is no endpoint discovery enabled information an InvalidOperationException is thrown.
- ProfileAWSRegion
Determines region based on a CredentialProfile stored in an ICredentialProfileSource. If the profile doesn't exist or there is no region information an InvalidOperationException is thrown.
- RefreshingAWSCredentials
Abstract class for automatically refreshing AWS credentials
- RefreshingAWSCredentials.CredentialsRefreshState
Refresh state container consisting of credentials and the date of the their expiration
- ResponseMetadata
Information about the request.
- 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.
- RetryableDetails
Class containing the retryable details for an AmazonServiceException
- SAMLImmutableCredentials
Immutable representation of AWS credentials obtained as a result of authenticating against a SAML-supporting federated identity provider.
- SessionAWSCredentials
Session credentials consisting of AccessKey, SecretKey and Token
- SignatureException
This exception is thrown if there are problems signing the request.
- 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.
- StoredProfileCredentials
Helper routiners for AWS and Federated credential profiles. Probes the profile type for the supplied profile name and returns the appropriate profile instance.
- StoredProfileFederatedCredentials
Temporary credentials that are created following successful authentication with a federated endpoint supporting SAML.
- StringListParameterValue
String list parameter value.
- StringParameterValue
String parameter value.
- TcpKeepAlive
TcpKeepAlive class used to group all the different properties used for working with TCP keep-alives.
Interfaces
- 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.
- 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.
- IExceptionHandler
The interface for an exception handler.
- IExceptionHandler<T>
The interface for an exception handler with a generic parameter for the exception type.
- IHttpRequestFactory<TRequestContent>
The interface for a HTTP request factory.
- IHttpRequest<TRequestContent>
The interface for an HTTP request that is agnostic of the underlying HTTP API.
- ILogMessage
Interface for a single logged message.
- IMetricsFormatter
User supplied type to perform metrics formatting.
- IMetricsTiming
Represents how long a phase of an SDK request took.
- IPipelineHandler
Interface for a handler in a pipeline.
- IRequestMetrics
Metrics collected by the SDK on a per-request basis.
Enums
- ErrorType
Which end of a request was responsible for a service error response.
- Metric
Predefined request metrics that are collected by the SDK.
- RequestRetryMode
RetryMode determines which request retry mode is used for requests that do not complete successfully.
- S3UsEast1RegionalEndpointValue
S3 US East 1 endpoint value determines wheter or not to send the us-east-1 s3 requests to the regional endpoint or to the legacy global endpoint
- SigningAlgorithm
The valid hashing algorithm supported by the sdk for request signing.
- StsRegionalEndpointsValue
Sts Regional Endpoints Value determines whether or not to send the sts request to the regional endpoint or to the global sts endpoint
Delegates
- StoredProfileFederatedCredentials.RequestUserCredential
Callback signature for obtaining user credentials that may be needed for authentication.