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.

Configuration for accessing Amazon SQS service

Inheritance Hierarchy

System.Object
  Amazon.Runtime.ClientConfig
    Amazon.SQS.AmazonSQSConfig

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

Syntax

C# 
public class AmazonSQSConfig : ClientConfig
         IClientConfig

The AmazonSQSConfig type exposes the following members

Constructors

NameDescription
Public Method AmazonSQSConfig()

Default constructor

Properties

NameTypeDescription
Public Property AccountIdEndpointMode Amazon.Runtime.AccountIdEndpointMode Inherited from Amazon.Runtime.ClientConfig.
Public Property AllowAutoRedirect System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property AuthenticationRegion System.String Inherited from Amazon.Runtime.ClientConfig.
Public Property AuthenticationServiceName System.String Inherited from Amazon.Runtime.ClientConfig.
Public Property AuthSchemePreference System.Collections.Generic.List<System.String> Inherited from Amazon.Runtime.ClientConfig.
Public Property AWSTokenProvider Amazon.Runtime.IAWSTokenProvider Inherited from Amazon.Runtime.ClientConfig.
Public Property BufferSize System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property ClientAppId System.String Inherited from Amazon.Runtime.ClientConfig.
Public Property ConnectionLimit System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property DefaultAWSCredentials Amazon.Runtime.AWSCredentials Inherited from Amazon.Runtime.ClientConfig.
Public Property DefaultConfigurationMode Amazon.Runtime.DefaultConfigurationMode Inherited from Amazon.Runtime.ClientConfig.
Public Property DisableHostPrefixInjection System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property DisableLogging System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property DisableRequestCompression System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property EndpointDiscoveryCacheLimit System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property EndpointDiscoveryEnabled System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property EndpointProvider Amazon.Runtime.Endpoints.IEndpointProvider Inherited from Amazon.Runtime.ClientConfig.
Public Property FastFailRequests System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property IdentityResolverConfiguration Amazon.Runtime.Identity.IIdentityResolverConfiguration Inherited from Amazon.Runtime.ClientConfig.
Public Property IgnoreConfiguredEndpointUrls System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property IsMaxErrorRetrySet System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property LogMetrics System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property LogResponse System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property MaxErrorRetry System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property MaxIdleTime System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property MaxStaleConnectionRetries System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property Profile Amazon.Profile Inherited from Amazon.Runtime.ClientConfig.
Public Property ProgressUpdateInterval System.Int64 Inherited from Amazon.Runtime.ClientConfig.
Public Property ProxyBypassList System.Collections.Generic.List<System.String> Inherited from Amazon.Runtime.ClientConfig.
Public Property ProxyBypassOnLocal System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property ProxyCredentials System.Net.ICredentials Inherited from Amazon.Runtime.ClientConfig.
Public Property ProxyHost System.String Inherited from Amazon.Runtime.ClientConfig.
Public Property ProxyPort System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property ReadWriteTimeout System.Nullable<System.TimeSpan> Inherited from Amazon.Runtime.ClientConfig.
Public Property RegionEndpoint Amazon.RegionEndpoint Inherited from Amazon.Runtime.ClientConfig.
Public Property RegionEndpointServiceName System.String

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

Public Property RequestChecksumCalculation Amazon.Runtime.RequestChecksumCalculation Inherited from Amazon.Runtime.ClientConfig.
Public Property RequestMinCompressionSizeBytes System.Int64 Inherited from Amazon.Runtime.ClientConfig.
Public Property ResignRetries System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property ResponseChecksumValidation Amazon.Runtime.ResponseChecksumValidation Inherited from Amazon.Runtime.ClientConfig.
Public Property RetryMode Amazon.Runtime.RequestRetryMode Inherited from Amazon.Runtime.ClientConfig.
Public Property Static Property ServiceId System.String

The ServiceId, which is the unique identifier for a service.

Public Property ServiceId System.String Inherited from Amazon.Runtime.ClientConfig.
Public Property ServiceURL System.String Inherited from Amazon.Runtime.ClientConfig.
Public Property ServiceVersion System.String

Gets the ServiceVersion property.

Public Property SignatureMethod Amazon.Runtime.SigningAlgorithm Inherited from Amazon.Runtime.ClientConfig.
Public Property SigV4aSigningRegionSet System.Collections.Generic.List<System.String> Inherited from Amazon.Runtime.ClientConfig.
Public Property TcpKeepAlive Amazon.Runtime.TcpKeepAlive Inherited from Amazon.Runtime.ClientConfig.
Public Property TelemetryProvider Amazon.Runtime.Telemetry.TelemetryProvider Inherited from Amazon.Runtime.ClientConfig.
Public Property ThrottleRetries System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property Timeout System.Nullable<System.TimeSpan> Inherited from Amazon.Runtime.ClientConfig.
Public Property UseAlternateUserAgentHeader System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property UseDualstackEndpoint System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property UseFIPSEndpoint System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property UseHttp System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property UseNagleAlgorithm System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property UserAgent System.String

Gets the value of UserAgent property.

Methods

Note:

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

NameDescription
Public Method DetermineServiceOperationEndpoint(ServiceOperationEndpointParameters)

Returns the endpoint that will be used for a particular request.

Public Method GetHttpProxy() Inherited from Amazon.Runtime.ClientConfig.
Public Method GetHttpsProxy() Inherited from Amazon.Runtime.ClientConfig.
Public Method GetWebProxy() Inherited from Amazon.Runtime.ClientConfig.
Public Method SetUseNagleIfAvailable(bool) Inherited from Amazon.Runtime.ClientConfig.
Public Method SetWebProxy(WebProxy) Inherited from Amazon.Runtime.ClientConfig.
Public Method Validate() Inherited from Amazon.Runtime.ClientConfig.

Code Examples

Explore code examples in the AWS SDK Code Examples Code Library.

Api

Scenarios

Serverless examples

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