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.

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.

Inheritance Hierarchy

Amazon.Runtime.IClientConfig

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

Syntax

C#
public interface IClientConfig

The IClientConfig type exposes the following members

Properties

NameTypeDescription
Public Property AllowAutoRedirect System.Boolean

This flag controls if .NET HTTP infrastructure should follow redirection responses (e.g. HTTP 307 - temporary redirect).

Public Property AuthenticationRegion System.String

Gets the AuthenticationRegion property. Used in AWS4 request signing, this is an optional property; change it only if the region cannot be determined from the service endpoint.

Public Property AuthenticationServiceName System.String

Gets the AuthenticationServiceName property. Used in AWS4 request signing, this is the short-form name of the service being called.

Public Property BufferSize System.Int32

Gets the BufferSize property. The BufferSize controls the buffer used to read in from input streams and write out to the request.

Public Property ConnectionLimit System.Int32

Gets the connection limit set on the ServicePoint for the WebRequest. Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in which case ServicePointManager.DefaultConnectionLimit will be used as the default.

Public Property DisableLogging System.Boolean

Gets the DisableLogging. If true logging for this client will be disabled.

Public Property LogMetrics System.Boolean

Flag on whether to log metrics for service calls. This can be set in the application's configs, as below:



    
        
    

            

Public Property LogResponse System.Boolean

Gets the LogResponse property. If this property is set to true, the service response is read in its entirety and logged.

Public Property MaxErrorRetry System.Int32

Gets the MaxErrorRetry property.

Public Property MaxIdleTime System.Int32

Gets the max idle time set on the ServicePoint for the WebRequest. Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, in which case ServicePointManager.MaxServicePointIdleTime will be used as the default.

Public Property ProgressUpdateInterval System.Int64

Gets the interval at which progress update events are raised for upload operations. By default, the progress update events are raised at every 100KB of data transferred.

Public Property ProxyCredentials System.Net.ICredentials

Credentials to use with a proxy.

Public Property ProxyHost System.String

Gets the ProxyHost property.

Public Property ProxyPort System.Int32

Gets the ProxyPort property.

Public Property ReadEntireResponse System.Boolean

Gets the ReadEntireResponse. If this property is set to true, the service response is read in its entirety before being processed.

Public Property ReadWriteTimeout System.Nullable<System.TimeSpan>

Gets the default read-write timeout value.

Public Property RegionEndpoint Amazon.RegionEndpoint

Gets the RegionEndpoint property. The region constant to use that determines the endpoint to use. If this is not set then the client will fallback to the value of ServiceURL.

Public Property RegionEndpointServiceName System.String

The constant used to lookup in the region hash the endpoint.

Public Property ResignRetries System.Boolean

Flag on whether to resign requests on retry or not.

Public Property ServiceURL System.String

Gets and sets of the ServiceURL property. This is an optional property if you need to set a specific service URL instead setting the region with the RegionEndpoint property.

Public Property ServiceVersion System.String

Gets Service Version

Public Property SignatureMethod Amazon.Runtime.SigningAlgorithm

Gets the signatureMethod property.

Public Property SignatureVersion System.String

Gets the SignatureVersion property. Note: This property exists for backward compatibility but is no longer used by any service other than S3.

Public Property ThrottleRetries System.Boolean

Configures a flag enabling to either opt in or opt out of the retry throttling service. Note: set value to true to enable retry throttling feature. The Default value for this flag is false.

Public Property Timeout System.Nullable<System.TimeSpan>

Gets the default request timeout value.

Public Property UseDualstackEndpoint System.Boolean

Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint for the configured region.

Public Property UseHttp System.Boolean

Gets the UseHttp property. If this property is set to true, the client attempts to use HTTP protocol. By default, this property is set to false.

Public Property UseNagleAlgorithm System.Boolean

Gets whether the Nagle algorithm is used on connections managed by the ServicePoint object used for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite default than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images.

Public Property UserAgent System.String

Gets the UserAgent property.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method DetermineServiceURL()

Using either the RegionEndpoint or the ServiceURL determine what the URL to the service is.

Public Method GetWebProxy()

Returns a WebProxy instance configured to match the proxy settings in the client configuration.

Public Method Validate()

Performs validation on this config object. Throws exception if any of the required values are missing/invalid.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone