| 1 | import { HttpResponse } from "./http";
|
| 2 | import { MetadataBearer } from "./response";
|
| 3 | /**
|
| 4 | * A document type represents an untyped JSON-like value.
|
| 5 | *
|
| 6 | * Not all protocols support document types, and the serialization format of a
|
| 7 | * document type is protocol specific. All JSON protocols SHOULD support
|
| 8 | * document types and they SHOULD serialize document types inline as normal
|
| 9 | * JSON values.
|
| 10 | */
|
| 11 | export declare type DocumentType = null | boolean | number | string | DocumentType[] | {
|
| 12 | [prop: string]: DocumentType;
|
| 13 | };
|
| 14 | /**
|
| 15 | * A structure shape with the error trait.
|
| 16 | * https://awslabs.github.io/smithy/spec/core.html#retryable-trait
|
| 17 | */
|
| 18 | export interface RetryableTrait {
|
| 19 | /**
|
| 20 | * Indicates that the error is a retryable throttling error.
|
| 21 | */
|
| 22 | readonly throttling?: boolean;
|
| 23 | }
|
| 24 | /**
|
| 25 | * Type that is implemented by all Smithy shapes marked with the
|
| 26 | * error trait.
|
| 27 | * @deprecated
|
| 28 | */
|
| 29 | export interface SmithyException {
|
| 30 | /**
|
| 31 | * The shape ID name of the exception.
|
| 32 | */
|
| 33 | readonly name: string;
|
| 34 | /**
|
| 35 | * Whether the client or server are at fault.
|
| 36 | */
|
| 37 | readonly $fault: "client" | "server";
|
| 38 | /**
|
| 39 | * The service that encountered the exception.
|
| 40 | */
|
| 41 | readonly $service?: string;
|
| 42 | /**
|
| 43 | * Indicates that an error MAY be retried by the client.
|
| 44 | */
|
| 45 | readonly $retryable?: RetryableTrait;
|
| 46 | /**
|
| 47 | * Reference to low-level HTTP response object.
|
| 48 | */
|
| 49 | readonly $response?: HttpResponse;
|
| 50 | }
|
| 51 | /**
|
| 52 | * @deprecated
|
| 53 | */
|
| 54 | export declare type SdkError = Error & Partial<SmithyException> & Partial<MetadataBearer>;
|