Class AmazonServiceClient

Namespace

Amazon.Runtime

Assembly

AWSSDK.Core.dll

public abstract class AmazonServiceClient : IDisposable

Inheritance

object

AmazonServiceClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AmazonServiceClient(AWSCredentials, ClientConfig)

protected AmazonServiceClient(AWSCredentials credentials, ClientConfig config)

Parameters

credentials AWSCredentials

config ClientConfig

AmazonServiceClient(string, string, ClientConfig)

protected AmazonServiceClient(string awsAccessKeyId, string awsSecretAccessKey, ClientConfig config)

Parameters

awsAccessKeyId string

awsSecretAccessKey string

config ClientConfig

AmazonServiceClient(string, string, string, ClientConfig)

protected AmazonServiceClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, ClientConfig config)

Parameters

awsAccessKeyId string

awsSecretAccessKey string

awsSessionToken string

config ClientConfig

Properties

Config

public IClientConfig Config { get; }

Property Value

IClientConfig

Credentials

protected AWSCredentials Credentials { get; }

Property Value

AWSCredentials

EndpointDiscoveryResolver

protected EndpointDiscoveryResolverBase EndpointDiscoveryResolver { get; }

Property Value

EndpointDiscoveryResolverBase

RuntimePipeline

protected RuntimePipeline RuntimePipeline { get; set; }

Property Value

RuntimePipeline

ServiceMetadata

protected virtual IServiceMetadata ServiceMetadata { get; }

Property Value

IServiceMetadata

Signer

protected AbstractAWSSigner Signer { get; }

Property Value

AbstractAWSSigner

SupportResponseLogging

protected virtual bool SupportResponseLogging { get; }

Property Value

bool

Methods

ComposeUrl(IRequest)

Assembles the Uri for a given SDK request

public static Uri ComposeUrl(IRequest iRequest)

Parameters

iRequest IRequest

Request to compute Uri for

Returns

Uri

Uri for the given SDK request

ComposeUrl(IRequest, bool)

Assembles the Uri for a given SDK request

public static Uri ComposeUrl(IRequest internalRequest, bool skipEncodingValidPathChars)

Parameters

internalRequest IRequest

Request to compute Uri for

skipEncodingValidPathChars bool

If true the accepted path characters {/+:} are not encoded.

Returns

Uri

Uri for the given SDK request

CreateSigner()

protected abstract AbstractAWSSigner CreateSigner()

Returns

AbstractAWSSigner

CustomizeRuntimePipeline(RuntimePipeline)

protected virtual void CustomizeRuntimePipeline(RuntimePipeline pipeline)

Parameters

pipeline RuntimePipeline

Dispose()

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

EndpointOperation(EndpointOperationContextBase)

protected virtual IEnumerable<DiscoveryEndpointBase> EndpointOperation(EndpointOperationContextBase context)

Parameters

context EndpointOperationContextBase

Returns

IEnumerable<DiscoveryEndpointBase>

Initialize()

protected virtual void Initialize()

InvokeAsync<TResponse>(AmazonWebServiceRequest, InvokeOptionsBase, CancellationToken)

protected Task<TResponse> InvokeAsync<TResponse>(AmazonWebServiceRequest request, InvokeOptionsBase options, CancellationToken cancellationToken) where TResponse : AmazonWebServiceResponse, new()

Parameters

request AmazonWebServiceRequest

options InvokeOptionsBase

cancellationToken CancellationToken

Returns

Task<TResponse>

Type Parameters

TResponse

InvokeAsync<TRequest, TResponse>(TRequest, IMarshaller<IRequest, AmazonWebServiceRequest>, ResponseUnmarshaller, CancellationToken)

[Obsolete("InvokeAsync taking marshallers is obsolete. Use InvokeAsync taking InvokeOptionsBase instead.")]
protected Task<TResponse> InvokeAsync<TRequest, TResponse>(TRequest request, IMarshaller<IRequest, AmazonWebServiceRequest> marshaller, ResponseUnmarshaller unmarshaller, CancellationToken cancellationToken) where TRequest : AmazonWebServiceRequest where TResponse : AmazonWebServiceResponse, new()

Parameters

request TRequest

marshaller IMarshaller<IRequest, AmazonWebServiceRequest>

unmarshaller ResponseUnmarshaller

cancellationToken CancellationToken

Returns

Task<TResponse>

Type Parameters

TRequest

TResponse

Invoke<TResponse>(AmazonWebServiceRequest, InvokeOptionsBase)

protected TResponse Invoke<TResponse>(AmazonWebServiceRequest request, InvokeOptionsBase options) where TResponse : AmazonWebServiceResponse

Parameters

request AmazonWebServiceRequest

options InvokeOptionsBase

Returns

TResponse

Type Parameters

TResponse

Invoke<TRequest, TResponse>(TRequest, IMarshaller<IRequest, AmazonWebServiceRequest>, ResponseUnmarshaller)

[Obsolete("Invoke taking marshallers is obsolete. Use Invoke taking InvokeOptionsBase instead.")]
protected TResponse Invoke<TRequest, TResponse>(TRequest request, IMarshaller<IRequest, AmazonWebServiceRequest> marshaller, ResponseUnmarshaller unmarshaller) where TRequest : AmazonWebServiceRequest where TResponse : AmazonWebServiceResponse

Parameters

request TRequest

marshaller IMarshaller<IRequest, AmazonWebServiceRequest>

unmarshaller ResponseUnmarshaller

Returns

TResponse

Type Parameters

TRequest

TResponse

ProcessExceptionHandlers(IExecutionContext, Exception)

protected virtual void ProcessExceptionHandlers(IExecutionContext executionContext, Exception exception)

Parameters

executionContext IExecutionContext

exception Exception

ProcessPreRequestHandlers(IExecutionContext)

protected void ProcessPreRequestHandlers(IExecutionContext executionContext)

Parameters

executionContext IExecutionContext

ProcessRequestHandlers(IExecutionContext)

protected void ProcessRequestHandlers(IExecutionContext executionContext)

Parameters

executionContext IExecutionContext

ProcessResponseHandlers(IExecutionContext)

protected void ProcessResponseHandlers(IExecutionContext executionContext)

Parameters

executionContext IExecutionContext

Events

AfterResponseEvent

Occurs after a response is received from the service.

public event ResponseEventHandler AfterResponseEvent

Event Type

ResponseEventHandler

BeforeRequestEvent

Occurs before a request is issued against the service.

public event RequestEventHandler BeforeRequestEvent

Event Type

RequestEventHandler

ExceptionEvent

Occurs after an exception is encountered.

public event ExceptionEventHandler ExceptionEvent

Event Type

ExceptionEventHandler