@cdklabs/cdk-ecs-codedeploy 0.0.90 → 0.0.92

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.
Files changed (96) hide show
  1. package/.jsii +3 -3
  2. package/lib/api-canary/index.js +1 -1
  3. package/lib/ecs-appspec/index.js +1 -1
  4. package/lib/ecs-deployment/index.js +1 -1
  5. package/lib/ecs-patterns/application-load-balanced-codedeployed-fargate-service.js +1 -1
  6. package/node_modules/@aws-sdk/abort-controller/package.json +2 -2
  7. package/node_modules/@aws-sdk/client-codedeploy/package.json +30 -30
  8. package/node_modules/@aws-sdk/client-sso/package.json +26 -26
  9. package/node_modules/@aws-sdk/client-sso-oidc/package.json +26 -26
  10. package/node_modules/@aws-sdk/client-sts/dist-types/commands/AssumeRoleCommand.d.ts +47 -0
  11. package/node_modules/@aws-sdk/client-sts/dist-types/commands/AssumeRoleWithSAMLCommand.d.ts +34 -0
  12. package/node_modules/@aws-sdk/client-sts/dist-types/commands/AssumeRoleWithWebIdentityCommand.d.ts +34 -0
  13. package/node_modules/@aws-sdk/client-sts/dist-types/commands/DecodeAuthorizationMessageCommand.d.ts +16 -0
  14. package/node_modules/@aws-sdk/client-sts/dist-types/commands/GetCallerIdentityCommand.d.ts +48 -0
  15. package/node_modules/@aws-sdk/client-sts/dist-types/commands/GetFederationTokenCommand.d.ts +38 -0
  16. package/node_modules/@aws-sdk/client-sts/dist-types/commands/GetSessionTokenCommand.d.ts +23 -0
  17. package/node_modules/@aws-sdk/client-sts/package.json +29 -29
  18. package/node_modules/@aws-sdk/config-resolver/package.json +5 -5
  19. package/node_modules/@aws-sdk/credential-provider-env/package.json +3 -3
  20. package/node_modules/@aws-sdk/credential-provider-imds/package.json +5 -5
  21. package/node_modules/@aws-sdk/credential-provider-ini/package.json +9 -9
  22. package/node_modules/@aws-sdk/credential-provider-node/package.json +10 -10
  23. package/node_modules/@aws-sdk/credential-provider-process/package.json +4 -4
  24. package/node_modules/@aws-sdk/credential-provider-sso/package.json +6 -6
  25. package/node_modules/@aws-sdk/credential-provider-web-identity/package.json +3 -3
  26. package/node_modules/@aws-sdk/fetch-http-handler/package.json +5 -5
  27. package/node_modules/@aws-sdk/hash-node/package.json +2 -2
  28. package/node_modules/@aws-sdk/invalid-dependency/package.json +2 -2
  29. package/node_modules/@aws-sdk/middleware-content-length/package.json +3 -3
  30. package/node_modules/@aws-sdk/middleware-endpoint/package.json +7 -7
  31. package/node_modules/@aws-sdk/middleware-host-header/package.json +3 -3
  32. package/node_modules/@aws-sdk/middleware-logger/dist-cjs/loggerMiddleware.js +7 -4
  33. package/node_modules/@aws-sdk/middleware-logger/dist-es/loggerMiddleware.js +7 -4
  34. package/node_modules/@aws-sdk/middleware-logger/package.json +2 -2
  35. package/node_modules/@aws-sdk/middleware-recursion-detection/package.json +3 -3
  36. package/node_modules/@aws-sdk/middleware-retry/package.json +7 -7
  37. package/node_modules/@aws-sdk/middleware-sdk-sts/package.json +6 -6
  38. package/node_modules/@aws-sdk/middleware-serde/package.json +2 -2
  39. package/node_modules/@aws-sdk/middleware-signing/package.json +6 -6
  40. package/node_modules/@aws-sdk/middleware-stack/package.json +2 -2
  41. package/node_modules/@aws-sdk/middleware-user-agent/package.json +4 -4
  42. package/node_modules/@aws-sdk/node-config-provider/package.json +4 -4
  43. package/node_modules/@aws-sdk/node-http-handler/package.json +5 -5
  44. package/node_modules/@aws-sdk/property-provider/package.json +2 -2
  45. package/node_modules/@aws-sdk/protocol-http/package.json +2 -2
  46. package/node_modules/@aws-sdk/querystring-builder/package.json +2 -2
  47. package/node_modules/@aws-sdk/querystring-parser/package.json +2 -2
  48. package/node_modules/@aws-sdk/service-error-classification/package.json +2 -2
  49. package/node_modules/@aws-sdk/shared-ini-file-loader/package.json +2 -2
  50. package/node_modules/@aws-sdk/signature-v4/package.json +4 -4
  51. package/node_modules/@aws-sdk/smithy-client/package.json +3 -3
  52. package/node_modules/@aws-sdk/token-providers/package.json +5 -5
  53. package/node_modules/@aws-sdk/types/dist-cjs/identity/Identity.js +0 -1
  54. package/node_modules/@aws-sdk/types/dist-es/identity/Identity.js +0 -1
  55. package/node_modules/@aws-sdk/types/dist-types/abort.d.ts +7 -0
  56. package/node_modules/@aws-sdk/types/dist-types/auth.d.ts +8 -0
  57. package/node_modules/@aws-sdk/types/dist-types/checksum.d.ts +4 -0
  58. package/node_modules/@aws-sdk/types/dist-types/client.d.ts +2 -0
  59. package/node_modules/@aws-sdk/types/dist-types/command.d.ts +3 -0
  60. package/node_modules/@aws-sdk/types/dist-types/credentials.d.ts +4 -0
  61. package/node_modules/@aws-sdk/types/dist-types/crypto.d.ts +11 -0
  62. package/node_modules/@aws-sdk/types/dist-types/dns.d.ts +10 -0
  63. package/node_modules/@aws-sdk/types/dist-types/endpoint.d.ts +21 -0
  64. package/node_modules/@aws-sdk/types/dist-types/eventStream.d.ts +61 -0
  65. package/node_modules/@aws-sdk/types/dist-types/http.d.ts +18 -0
  66. package/node_modules/@aws-sdk/types/dist-types/identity/AnonymousIdentity.d.ts +3 -0
  67. package/node_modules/@aws-sdk/types/dist-types/identity/AwsCredentialIdentity.d.ts +6 -0
  68. package/node_modules/@aws-sdk/types/dist-types/identity/Identity.d.ts +6 -0
  69. package/node_modules/@aws-sdk/types/dist-types/identity/LoginIdentity.d.ts +6 -0
  70. package/node_modules/@aws-sdk/types/dist-types/identity/TokenIdentity.d.ts +6 -0
  71. package/node_modules/@aws-sdk/types/dist-types/logger.d.ts +6 -0
  72. package/node_modules/@aws-sdk/types/dist-types/middleware.d.ts +108 -0
  73. package/node_modules/@aws-sdk/types/dist-types/pagination.d.ts +4 -0
  74. package/node_modules/@aws-sdk/types/dist-types/profile.d.ts +11 -0
  75. package/node_modules/@aws-sdk/types/dist-types/request.d.ts +3 -0
  76. package/node_modules/@aws-sdk/types/dist-types/response.d.ts +9 -0
  77. package/node_modules/@aws-sdk/types/dist-types/retry.d.ts +30 -0
  78. package/node_modules/@aws-sdk/types/dist-types/serde.d.ts +25 -0
  79. package/node_modules/@aws-sdk/types/dist-types/shapes.d.ts +8 -0
  80. package/node_modules/@aws-sdk/types/dist-types/signature.d.ts +28 -0
  81. package/node_modules/@aws-sdk/types/dist-types/stream.d.ts +5 -0
  82. package/node_modules/@aws-sdk/types/dist-types/token.d.ts +4 -0
  83. package/node_modules/@aws-sdk/types/dist-types/transfer.d.ts +9 -0
  84. package/node_modules/@aws-sdk/types/dist-types/util.d.ts +24 -0
  85. package/node_modules/@aws-sdk/types/dist-types/waiter.d.ts +3 -0
  86. package/node_modules/@aws-sdk/types/package.json +1 -1
  87. package/node_modules/@aws-sdk/url-parser/package.json +3 -3
  88. package/node_modules/@aws-sdk/util-defaults-mode-browser/package.json +4 -4
  89. package/node_modules/@aws-sdk/util-defaults-mode-node/package.json +7 -7
  90. package/node_modules/@aws-sdk/util-endpoints/package.json +2 -2
  91. package/node_modules/@aws-sdk/util-middleware/package.json +2 -2
  92. package/node_modules/@aws-sdk/util-retry/package.json +3 -3
  93. package/node_modules/@aws-sdk/util-user-agent-browser/package.json +3 -3
  94. package/node_modules/@aws-sdk/util-user-agent-node/package.json +4 -4
  95. package/node_modules/@aws-sdk/util-waiter/package.json +3 -3
  96. package/package.json +5 -5
@@ -2,6 +2,8 @@ import { HttpRequest } from "./http";
2
2
  import { FinalizeHandler, FinalizeHandlerArguments, FinalizeHandlerOutput, HandlerExecutionContext } from "./middleware";
3
3
  import { MetadataBearer } from "./response";
4
4
  /**
5
+ * @public
6
+ *
5
7
  * An event stream message. The headers and body properties will always be
6
8
  * defined, with empty headers represented as an object with no keys and an
7
9
  * empty body represented as a zero-length Uint8Array.
@@ -10,68 +12,112 @@ export interface Message {
10
12
  headers: MessageHeaders;
11
13
  body: Uint8Array;
12
14
  }
15
+ /**
16
+ * @public
17
+ */
13
18
  export declare type MessageHeaders = Record<string, MessageHeaderValue>;
19
+ /**
20
+ * @public
21
+ */
14
22
  export interface BooleanHeaderValue {
15
23
  type: "boolean";
16
24
  value: boolean;
17
25
  }
26
+ /**
27
+ * @public
28
+ */
18
29
  export interface ByteHeaderValue {
19
30
  type: "byte";
20
31
  value: number;
21
32
  }
33
+ /**
34
+ * @public
35
+ */
22
36
  export interface ShortHeaderValue {
23
37
  type: "short";
24
38
  value: number;
25
39
  }
40
+ /**
41
+ * @public
42
+ */
26
43
  export interface IntegerHeaderValue {
27
44
  type: "integer";
28
45
  value: number;
29
46
  }
47
+ /**
48
+ * @public
49
+ */
30
50
  export interface LongHeaderValue {
31
51
  type: "long";
32
52
  value: Int64;
33
53
  }
54
+ /**
55
+ * @public
56
+ */
34
57
  export interface BinaryHeaderValue {
35
58
  type: "binary";
36
59
  value: Uint8Array;
37
60
  }
61
+ /**
62
+ * @public
63
+ */
38
64
  export interface StringHeaderValue {
39
65
  type: "string";
40
66
  value: string;
41
67
  }
68
+ /**
69
+ * @public
70
+ */
42
71
  export interface TimestampHeaderValue {
43
72
  type: "timestamp";
44
73
  value: Date;
45
74
  }
75
+ /**
76
+ * @public
77
+ */
46
78
  export interface UuidHeaderValue {
47
79
  type: "uuid";
48
80
  value: string;
49
81
  }
82
+ /**
83
+ * @public
84
+ */
50
85
  export declare type MessageHeaderValue = BooleanHeaderValue | ByteHeaderValue | ShortHeaderValue | IntegerHeaderValue | LongHeaderValue | BinaryHeaderValue | StringHeaderValue | TimestampHeaderValue | UuidHeaderValue;
86
+ /**
87
+ * @public
88
+ */
51
89
  export interface Int64 {
52
90
  readonly bytes: Uint8Array;
53
91
  valueOf: () => number;
54
92
  toString: () => string;
55
93
  }
56
94
  /**
95
+ * @public
96
+ *
57
97
  * Util functions for serializing or deserializing event stream
58
98
  */
59
99
  export interface EventStreamSerdeContext {
60
100
  eventStreamMarshaller: EventStreamMarshaller;
61
101
  }
62
102
  /**
103
+ * @public
104
+ *
63
105
  * A function which deserializes binary event stream message into modeled shape.
64
106
  */
65
107
  export interface EventStreamMarshallerDeserFn<StreamType> {
66
108
  <T>(body: StreamType, deserializer: (input: Record<string, Message>) => Promise<T>): AsyncIterable<T>;
67
109
  }
68
110
  /**
111
+ * @public
112
+ *
69
113
  * A function that serializes modeled shape into binary stream message.
70
114
  */
71
115
  export interface EventStreamMarshallerSerFn<StreamType> {
72
116
  <T>(input: AsyncIterable<T>, serializer: (event: T) => Message): StreamType;
73
117
  }
74
118
  /**
119
+ * @public
120
+ *
75
121
  * An interface which provides functions for serializing and deserializing binary event stream
76
122
  * to/from corresponsing modeled shape.
77
123
  */
@@ -79,18 +125,33 @@ export interface EventStreamMarshaller<StreamType = any> {
79
125
  deserialize: EventStreamMarshallerDeserFn<StreamType>;
80
126
  serialize: EventStreamMarshallerSerFn<StreamType>;
81
127
  }
128
+ /**
129
+ * @public
130
+ */
82
131
  export interface EventStreamRequestSigner {
83
132
  sign(request: HttpRequest): Promise<HttpRequest>;
84
133
  }
134
+ /**
135
+ * @public
136
+ */
85
137
  export interface EventStreamPayloadHandler {
86
138
  handle: <Input extends object, Output extends MetadataBearer>(next: FinalizeHandler<Input, Output>, args: FinalizeHandlerArguments<Input>, context?: HandlerExecutionContext) => Promise<FinalizeHandlerOutput<Output>>;
87
139
  }
140
+ /**
141
+ * @public
142
+ */
88
143
  export interface EventStreamPayloadHandlerProvider {
89
144
  (options: any): EventStreamPayloadHandler;
90
145
  }
146
+ /**
147
+ * @public
148
+ */
91
149
  export interface EventStreamSerdeProvider {
92
150
  (options: any): EventStreamMarshaller;
93
151
  }
152
+ /**
153
+ * @public
154
+ */
94
155
  export interface EventStreamSignerProvider {
95
156
  (options: any): EventStreamRequestSigner;
96
157
  }
@@ -1,5 +1,7 @@
1
1
  import { AbortSignal } from "./abort";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * A collection of key/value pairs with case-insensitive keys.
4
6
  */
5
7
  export interface Headers extends Map<string, string> {
@@ -20,6 +22,8 @@ export interface Headers extends Map<string, string> {
20
22
  withoutHeader(headerName: string): Headers;
21
23
  }
22
24
  /**
25
+ * @public
26
+ *
23
27
  * A mapping of header names to string values. Multiple values for the same
24
28
  * header should be represented as a single string with values separated by
25
29
  * `, `.
@@ -39,6 +43,8 @@ export interface Headers extends Map<string, string> {
39
43
  */
40
44
  export declare type HeaderBag = Record<string, string>;
41
45
  /**
46
+ * @public
47
+ *
42
48
  * Represents an HTTP message with headers and an optional static or streaming
43
49
  * body. bode: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream;
44
50
  */
@@ -47,12 +53,16 @@ export interface HttpMessage {
47
53
  body?: any;
48
54
  }
49
55
  /**
56
+ * @public
57
+ *
50
58
  * A mapping of query parameter names to strings or arrays of strings, with the
51
59
  * second being used when a parameter contains a list of values. Value can be set
52
60
  * to null when query is not in key-value pairs shape
53
61
  */
54
62
  export declare type QueryParameterBag = Record<string, string | Array<string> | null>;
55
63
  /**
64
+ * @public
65
+ *
56
66
  * @deprecated use EndpointV2 from @aws-sdk/types.
57
67
  */
58
68
  export interface Endpoint {
@@ -63,6 +73,8 @@ export interface Endpoint {
63
73
  query?: QueryParameterBag;
64
74
  }
65
75
  /**
76
+ * @public
77
+ *
66
78
  * Interface an HTTP request class. Contains
67
79
  * addressing information in addition to standard message properties.
68
80
  */
@@ -70,6 +82,8 @@ export interface HttpRequest extends HttpMessage, Endpoint {
70
82
  method: string;
71
83
  }
72
84
  /**
85
+ * @public
86
+ *
73
87
  * Represents an HTTP message as received in reply to a request. Contains a
74
88
  * numeric status code in addition to standard message properties.
75
89
  */
@@ -77,6 +91,8 @@ export interface HttpResponse extends HttpMessage {
77
91
  statusCode: number;
78
92
  }
79
93
  /**
94
+ * @public
95
+ *
80
96
  * Represents HTTP message whose body has been resolved to a string. This is
81
97
  * used in parsing http message.
82
98
  */
@@ -84,6 +100,8 @@ export interface ResolvedHttpResponse extends HttpResponse {
84
100
  body: string;
85
101
  }
86
102
  /**
103
+ * @public
104
+ *
87
105
  * Represents the options that may be passed to an Http Handler.
88
106
  */
89
107
  export interface HttpHandlerOptions {
@@ -1,3 +1,6 @@
1
1
  import { Identity } from "./Identity";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface AnonymousIdentity extends Identity {
3
6
  }
@@ -1,4 +1,7 @@
1
1
  import { Identity, IdentityProvider } from "./Identity";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface AwsCredentialIdentity extends Identity {
3
6
  /**
4
7
  * AWS access key ID
@@ -14,4 +17,7 @@ export interface AwsCredentialIdentity extends Identity {
14
17
  */
15
18
  readonly sessionToken?: string;
16
19
  }
20
+ /**
21
+ * @public
22
+ */
17
23
  export declare type AwsCredentialIdentityProvider = IdentityProvider<AwsCredentialIdentity>;
@@ -1,9 +1,15 @@
1
+ /**
2
+ * @public
3
+ */
1
4
  export interface Identity {
2
5
  /**
3
6
  * A {Date} when the identity or credential will no longer be accepted.
4
7
  */
5
8
  readonly expiration?: Date;
6
9
  }
10
+ /**
11
+ * @public
12
+ */
7
13
  export interface IdentityProvider<IdentityT extends Identity> {
8
14
  (identityProperties?: Record<string, any>): Promise<IdentityT>;
9
15
  }
@@ -1,4 +1,7 @@
1
1
  import { Identity, IdentityProvider } from "./Identity";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface LoginIdentity extends Identity {
3
6
  /**
4
7
  * Identity username
@@ -9,4 +12,7 @@ export interface LoginIdentity extends Identity {
9
12
  */
10
13
  readonly password: string;
11
14
  }
15
+ /**
16
+ * @public
17
+ */
12
18
  export declare type LoginIdentityProvider = IdentityProvider<LoginIdentity>;
@@ -1,8 +1,14 @@
1
1
  import { Identity, IdentityProvider } from "./Identity";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface TokenIdentity extends Identity {
3
6
  /**
4
7
  * The literal token string
5
8
  */
6
9
  readonly token: string;
7
10
  }
11
+ /**
12
+ * @public
13
+ */
8
14
  export declare type TokenIdentityProvider = IdentityProvider<TokenIdentity>;
@@ -1,4 +1,6 @@
1
1
  /**
2
+ * @public
3
+ *
2
4
  * A list of logger's log level. These levels are sorted in
3
5
  * order of increasing severity. Each log level includes itself and all
4
6
  * the levels behind itself.
@@ -8,6 +10,8 @@
8
10
  */
9
11
  export declare type LogLevel = "all" | "trace" | "debug" | "log" | "info" | "warn" | "error" | "off";
10
12
  /**
13
+ * @public
14
+ *
11
15
  * An object consumed by Logger constructor to initiate a logger object.
12
16
  */
13
17
  export interface LoggerOptions {
@@ -15,6 +19,8 @@ export interface LoggerOptions {
15
19
  logLevel?: LogLevel;
16
20
  }
17
21
  /**
22
+ * @public
23
+ *
18
24
  * Represents a logger object that is available in HandlerExecutionContext
19
25
  * throughout the middleware stack.
20
26
  */
@@ -2,6 +2,9 @@ import { AuthScheme, HttpAuthDefinition } from "./auth";
2
2
  import { EndpointV2 } from "./endpoint";
3
3
  import { Logger } from "./logger";
4
4
  import { UserAgent } from "./util";
5
+ /**
6
+ * @public
7
+ */
5
8
  export interface InitializeHandlerArguments<Input extends object> {
6
9
  /**
7
10
  * User input to a command. Reflects the userland representation of the
@@ -9,9 +12,15 @@ export interface InitializeHandlerArguments<Input extends object> {
9
12
  */
10
13
  input: Input;
11
14
  }
15
+ /**
16
+ * @public
17
+ */
12
18
  export interface InitializeHandlerOutput<Output extends object> extends DeserializeHandlerOutput<Output> {
13
19
  output: Output;
14
20
  }
21
+ /**
22
+ * @public
23
+ */
15
24
  export interface SerializeHandlerArguments<Input extends object> extends InitializeHandlerArguments<Input> {
16
25
  /**
17
26
  * The user input serialized as a request object. The request object is unknown,
@@ -23,22 +32,43 @@ export interface SerializeHandlerArguments<Input extends object> extends Initial
23
32
  */
24
33
  request?: unknown;
25
34
  }
35
+ /**
36
+ * @public
37
+ */
26
38
  export interface SerializeHandlerOutput<Output extends object> extends InitializeHandlerOutput<Output> {
27
39
  }
40
+ /**
41
+ * @public
42
+ */
28
43
  export interface BuildHandlerArguments<Input extends object> extends FinalizeHandlerArguments<Input> {
29
44
  }
45
+ /**
46
+ * @public
47
+ */
30
48
  export interface BuildHandlerOutput<Output extends object> extends InitializeHandlerOutput<Output> {
31
49
  }
50
+ /**
51
+ * @public
52
+ */
32
53
  export interface FinalizeHandlerArguments<Input extends object> extends SerializeHandlerArguments<Input> {
33
54
  /**
34
55
  * The user input serialized as a request.
35
56
  */
36
57
  request: unknown;
37
58
  }
59
+ /**
60
+ * @public
61
+ */
38
62
  export interface FinalizeHandlerOutput<Output extends object> extends InitializeHandlerOutput<Output> {
39
63
  }
64
+ /**
65
+ * @public
66
+ */
40
67
  export interface DeserializeHandlerArguments<Input extends object> extends FinalizeHandlerArguments<Input> {
41
68
  }
69
+ /**
70
+ * @public
71
+ */
42
72
  export interface DeserializeHandlerOutput<Output extends object> {
43
73
  /**
44
74
  * The raw response object from runtime is deserialized to structured output object.
@@ -51,6 +81,9 @@ export interface DeserializeHandlerOutput<Output extends object> {
51
81
  response: unknown;
52
82
  output?: Output;
53
83
  }
84
+ /**
85
+ * @public
86
+ */
54
87
  export interface InitializeHandler<Input extends object, Output extends object> {
55
88
  /**
56
89
  * Asynchronously converts an input object into an output object.
@@ -60,7 +93,13 @@ export interface InitializeHandler<Input extends object, Output extends object>
60
93
  */
61
94
  (args: InitializeHandlerArguments<Input>): Promise<InitializeHandlerOutput<Output>>;
62
95
  }
96
+ /**
97
+ * @public
98
+ */
63
99
  export declare type Handler<Input extends object, Output extends object> = InitializeHandler<Input, Output>;
100
+ /**
101
+ * @public
102
+ */
64
103
  export interface SerializeHandler<Input extends object, Output extends object> {
65
104
  /**
66
105
  * Asynchronously converts an input object into an output object.
@@ -70,6 +109,9 @@ export interface SerializeHandler<Input extends object, Output extends object> {
70
109
  */
71
110
  (args: SerializeHandlerArguments<Input>): Promise<SerializeHandlerOutput<Output>>;
72
111
  }
112
+ /**
113
+ * @public
114
+ */
73
115
  export interface FinalizeHandler<Input extends object, Output extends object> {
74
116
  /**
75
117
  * Asynchronously converts an input object into an output object.
@@ -79,13 +121,21 @@ export interface FinalizeHandler<Input extends object, Output extends object> {
79
121
  */
80
122
  (args: FinalizeHandlerArguments<Input>): Promise<FinalizeHandlerOutput<Output>>;
81
123
  }
124
+ /**
125
+ * @public
126
+ */
82
127
  export interface BuildHandler<Input extends object, Output extends object> {
83
128
  (args: BuildHandlerArguments<Input>): Promise<BuildHandlerOutput<Output>>;
84
129
  }
130
+ /**
131
+ * @public
132
+ */
85
133
  export interface DeserializeHandler<Input extends object, Output extends object> {
86
134
  (args: DeserializeHandlerArguments<Input>): Promise<DeserializeHandlerOutput<Output>>;
87
135
  }
88
136
  /**
137
+ * @public
138
+ *
89
139
  * A factory function that creates functions implementing the {Handler}
90
140
  * interface.
91
141
  */
@@ -99,6 +149,8 @@ export interface InitializeMiddleware<Input extends object, Output extends objec
99
149
  (next: InitializeHandler<Input, Output>, context: HandlerExecutionContext): InitializeHandler<Input, Output>;
100
150
  }
101
151
  /**
152
+ * @public
153
+ *
102
154
  * A factory function that creates functions implementing the {BuildHandler}
103
155
  * interface.
104
156
  */
@@ -112,6 +164,8 @@ export interface SerializeMiddleware<Input extends object, Output extends object
112
164
  (next: SerializeHandler<Input, Output>, context: HandlerExecutionContext): SerializeHandler<Input, Output>;
113
165
  }
114
166
  /**
167
+ * @public
168
+ *
115
169
  * A factory function that creates functions implementing the {FinalizeHandler}
116
170
  * interface.
117
171
  */
@@ -124,22 +178,42 @@ export interface FinalizeRequestMiddleware<Input extends object, Output extends
124
178
  */
125
179
  (next: FinalizeHandler<Input, Output>, context: HandlerExecutionContext): FinalizeHandler<Input, Output>;
126
180
  }
181
+ /**
182
+ * @public
183
+ */
127
184
  export interface BuildMiddleware<Input extends object, Output extends object> {
128
185
  (next: BuildHandler<Input, Output>, context: HandlerExecutionContext): BuildHandler<Input, Output>;
129
186
  }
187
+ /**
188
+ * @public
189
+ */
130
190
  export interface DeserializeMiddleware<Input extends object, Output extends object> {
131
191
  (next: DeserializeHandler<Input, Output>, context: HandlerExecutionContext): DeserializeHandler<Input, Output>;
132
192
  }
193
+ /**
194
+ * @public
195
+ */
133
196
  export declare type MiddlewareType<Input extends object, Output extends object> = InitializeMiddleware<Input, Output> | SerializeMiddleware<Input, Output> | BuildMiddleware<Input, Output> | FinalizeRequestMiddleware<Input, Output> | DeserializeMiddleware<Input, Output>;
134
197
  /**
198
+ * @public
199
+ *
135
200
  * A factory function that creates the terminal handler atop which a middleware
136
201
  * stack sits.
137
202
  */
138
203
  export interface Terminalware {
139
204
  <Input extends object, Output extends object>(context: HandlerExecutionContext): DeserializeHandler<Input, Output>;
140
205
  }
206
+ /**
207
+ * @public
208
+ */
141
209
  export declare type Step = "initialize" | "serialize" | "build" | "finalizeRequest" | "deserialize";
210
+ /**
211
+ * @public
212
+ */
142
213
  export declare type Priority = "high" | "normal" | "low";
214
+ /**
215
+ * @public
216
+ */
143
217
  export interface HandlerOptions {
144
218
  /**
145
219
  * Handlers are ordered using a "step" that describes the stage of command
@@ -187,6 +261,9 @@ export interface HandlerOptions {
187
261
  */
188
262
  override?: boolean;
189
263
  }
264
+ /**
265
+ * @public
266
+ */
190
267
  export interface AbsoluteLocation {
191
268
  /**
192
269
  * By default middleware will be added to individual step in un-guaranteed order.
@@ -196,7 +273,13 @@ export interface AbsoluteLocation {
196
273
  */
197
274
  priority?: Priority;
198
275
  }
276
+ /**
277
+ * @public
278
+ */
199
279
  export declare type Relation = "before" | "after";
280
+ /**
281
+ * @public
282
+ */
200
283
  export interface RelativeLocation {
201
284
  /**
202
285
  * Specify the relation to be before or after a know middleware.
@@ -207,23 +290,43 @@ export interface RelativeLocation {
207
290
  */
208
291
  toMiddleware: string;
209
292
  }
293
+ /**
294
+ * @public
295
+ */
210
296
  export declare type RelativeMiddlewareOptions = RelativeLocation & Omit<HandlerOptions, "step">;
297
+ /**
298
+ * @public
299
+ */
211
300
  export interface InitializeHandlerOptions extends HandlerOptions {
212
301
  step?: "initialize";
213
302
  }
303
+ /**
304
+ * @public
305
+ */
214
306
  export interface SerializeHandlerOptions extends HandlerOptions {
215
307
  step: "serialize";
216
308
  }
309
+ /**
310
+ * @public
311
+ */
217
312
  export interface BuildHandlerOptions extends HandlerOptions {
218
313
  step: "build";
219
314
  }
315
+ /**
316
+ * @public
317
+ */
220
318
  export interface FinalizeRequestHandlerOptions extends HandlerOptions {
221
319
  step: "finalizeRequest";
222
320
  }
321
+ /**
322
+ * @public
323
+ */
223
324
  export interface DeserializeHandlerOptions extends HandlerOptions {
224
325
  step: "deserialize";
225
326
  }
226
327
  /**
328
+ * @public
329
+ *
227
330
  * A stack storing middleware. It can be resolved into a handler. It supports 2
228
331
  * approaches for adding middleware:
229
332
  * 1. Adding middleware to specific step with `add()`. The order of middleware
@@ -319,6 +422,8 @@ export interface MiddlewareStack<Input extends object, Output extends object> ex
319
422
  resolve<InputType extends Input, OutputType extends Output>(handler: DeserializeHandler<InputType, OutputType>, context: HandlerExecutionContext): InitializeHandler<InputType, OutputType>;
320
423
  }
321
424
  /**
425
+ * @public
426
+ *
322
427
  * Data and helper objects that are not expected to change from one execution of
323
428
  * a composed handler to another.
324
429
  */
@@ -357,6 +462,9 @@ export interface HandlerExecutionContext {
357
462
  }>;
358
463
  [key: string]: any;
359
464
  }
465
+ /**
466
+ * @public
467
+ */
360
468
  export interface Pluggable<Input extends object, Output extends object> {
361
469
  /**
362
470
  * A function that mutate the passed in middleware stack. Functions implementing
@@ -1,9 +1,13 @@
1
1
  import { Client } from "./client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Expected type definition of a paginator.
4
6
  */
5
7
  export declare type Paginator<T> = AsyncGenerator<T, T, unknown>;
6
8
  /**
9
+ * @public
10
+ *
7
11
  * Expected paginator configuration passed to an operation. Services will extend
8
12
  * this interface definition and may type client further.
9
13
  */
@@ -1,10 +1,21 @@
1
+ /**
2
+ * @public
3
+ */
1
4
  export declare type IniSection = Record<string, string | undefined>;
2
5
  /**
6
+ * @public
7
+ *
3
8
  * @deprecated: Please use IniSection
4
9
  */
5
10
  export interface Profile extends IniSection {
6
11
  }
12
+ /**
13
+ * @public
14
+ */
7
15
  export declare type ParsedIniData = Record<string, IniSection>;
16
+ /**
17
+ * @public
18
+ */
8
19
  export interface SharedConfigFiles {
9
20
  credentialsFile: ParsedIniData;
10
21
  configFile: ParsedIniData;
@@ -1,3 +1,6 @@
1
+ /**
2
+ * @internal
3
+ */
1
4
  export interface Request {
2
5
  destination: URL;
3
6
  body?: any;
@@ -1,3 +1,6 @@
1
+ /**
2
+ * @internal
3
+ */
1
4
  export interface ResponseMetadata {
2
5
  /**
3
6
  * The status code of the last HTTP response received for this operation.
@@ -26,12 +29,18 @@ export interface ResponseMetadata {
26
29
  */
27
30
  totalRetryDelay?: number;
28
31
  }
32
+ /**
33
+ * @internal
34
+ */
29
35
  export interface MetadataBearer {
30
36
  /**
31
37
  * Metadata pertaining to this request.
32
38
  */
33
39
  $metadata: ResponseMetadata;
34
40
  }
41
+ /**
42
+ * @internal
43
+ */
35
44
  export interface Response {
36
45
  body: any;
37
46
  }