Interface $ClientProtocol<Request, Response>

A client protocol defines how to convert a message (e.g. HTTP request/response) to and from a data object.

interface $ClientProtocol<Request, Response> {
    deserializeResponse<Output>(operationSchema, context, response): Promise<Output>;
    getPayloadCodec(): $Codec<any, any>;
    getRequestType(): (new (...args) => Request);
    getResponseType(): (new (...args) => Response);
    getShapeId(): string;
    serializeRequest<Input>(operationSchema, input, context): Promise<Request>;
    setSerdeContext(serdeContext): void;
    updateServiceEndpoint(request, endpoint): Request;
}

Type Parameters

  • Request

  • Response

Hierarchy (view full)

Methods

deserializeResponse getPayloadCodec getRequestType getResponseType getShapeId serializeRequest setSerdeContext updateServiceEndpoint

Methods

deserializeResponse

getPayloadCodec

  • getPayloadCodec(): $Codec<any, any>

  • Returns $Codec<any, any>

    the payload codec if the requests/responses have a symmetric format. It otherwise may return null.

getRequestType

  • getRequestType(): (new (...args) => Request)

  • Returns (new (...args) => Request)

getResponseType

getShapeId

  • getShapeId(): string

  • Returns string

    the Smithy qualified shape id.

serializeRequest

setSerdeContext

updateServiceEndpoint

Settings

Member Visibility

Theme

On This Page