@aws-sdk/types 3.272.0 → 3.290.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,6 +2,8 @@ import { Endpoint } from "./http";
2
2
  import { FinalizeHandler, FinalizeHandlerArguments, FinalizeHandlerOutput } from "./middleware";
3
3
  import { MetadataBearer } from "./response";
4
4
  /**
5
+ * @public
6
+ *
5
7
  * A function that, given a TypedArray of bytes, can produce a string
6
8
  * representation thereof.
7
9
  *
@@ -13,6 +15,8 @@ export interface Encoder {
13
15
  (input: Uint8Array): string;
14
16
  }
15
17
  /**
18
+ * @public
19
+ *
16
20
  * A function that, given a string, can derive the bytes represented by that
17
21
  * string.
18
22
  *
@@ -24,6 +28,8 @@ export interface Decoder {
24
28
  (input: string): Uint8Array;
25
29
  }
26
30
  /**
31
+ * @public
32
+ *
27
33
  * A function that, when invoked, returns a promise that will be fulfilled with
28
34
  * a value of type T.
29
35
  *
@@ -34,6 +40,8 @@ export interface Provider<T> {
34
40
  (): Promise<T>;
35
41
  }
36
42
  /**
43
+ * @public
44
+ *
37
45
  * A function that, when invoked, returns a promise that will be fulfilled with
38
46
  * a value of type T. It memoizes the result from the previous invocation
39
47
  * instead of calling the underlying resources every time.
@@ -53,6 +61,8 @@ export interface MemoizedProvider<T> {
53
61
  }): Promise<T>;
54
62
  }
55
63
  /**
64
+ * @public
65
+ *
56
66
  * A function that, given a request body, determines the
57
67
  * length of the body. This is used to determine the Content-Length
58
68
  * that should be sent with a request.
@@ -64,6 +74,8 @@ export interface BodyLengthCalculator {
64
74
  (body: any): number | undefined;
65
75
  }
66
76
  /**
77
+ * @public
78
+ *
67
79
  * Interface that specifies the retry behavior
68
80
  */
69
81
  export interface RetryStrategy {
@@ -79,12 +91,16 @@ export interface RetryStrategy {
79
91
  retry: <Input extends object, Output extends MetadataBearer>(next: FinalizeHandler<Input, Output>, args: FinalizeHandlerArguments<Input>) => Promise<FinalizeHandlerOutput<Output>>;
80
92
  }
81
93
  /**
94
+ * @public
95
+ *
82
96
  * Parses a URL in string form into an Endpoint object.
83
97
  */
84
98
  export interface UrlParser {
85
99
  (url: string | URL): Endpoint;
86
100
  }
87
101
  /**
102
+ * @public
103
+ *
88
104
  * Object containing regionalization information of
89
105
  * AWS services.
90
106
  */
@@ -96,6 +112,8 @@ export interface RegionInfo {
96
112
  signingRegion?: string;
97
113
  }
98
114
  /**
115
+ * @public
116
+ *
99
117
  * Options to pass when calling {@link RegionInfoProvider}
100
118
  */
101
119
  export interface RegionInfoProviderOptions {
@@ -111,6 +129,8 @@ export interface RegionInfoProviderOptions {
111
129
  useFipsEndpoint: boolean;
112
130
  }
113
131
  /**
132
+ * @public
133
+ *
114
134
  * Function returns designated service's regionalization
115
135
  * information from given region. Each service client
116
136
  * comes with its regionalization provider. it serves
@@ -120,11 +140,15 @@ export interface RegionInfoProvider {
120
140
  (region: string, options?: RegionInfoProviderOptions): Promise<RegionInfo | undefined>;
121
141
  }
122
142
  /**
143
+ * @public
144
+ *
123
145
  * A tuple that represents an API name and optional version
124
146
  * of a library built using the AWS SDK.
125
147
  */
126
148
  export declare type UserAgentPair = [name: string, version?: string];
127
149
  /**
150
+ * @public
151
+ *
128
152
  * User agent data that to be put into the request's user
129
153
  * agent.
130
154
  */
@@ -1,4 +1,7 @@
1
1
  import { AbortController } from "./abort";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface WaiterConfiguration<Client> {
3
6
  /**
4
7
  * Required service client
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aws-sdk/types",
3
- "version": "3.272.0",
3
+ "version": "3.290.0",
4
4
  "main": "./dist-cjs/index.js",
5
5
  "module": "./dist-es/index.js",
6
6
  "types": "./dist-types/index.d.ts",