@aws-sdk/client-cloudwatch-events 3.529.1 → 3.535.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.
- package/dist-types/CloudWatchEvents.d.ts +11 -1
- package/dist-types/CloudWatchEventsClient.d.ts +1 -1
- package/dist-types/commands/ActivateEventSourceCommand.d.ts +2 -1
- package/dist-types/commands/CancelReplayCommand.d.ts +2 -1
- package/dist-types/commands/CreateApiDestinationCommand.d.ts +2 -1
- package/dist-types/commands/CreateArchiveCommand.d.ts +2 -1
- package/dist-types/commands/CreateConnectionCommand.d.ts +2 -1
- package/dist-types/commands/CreateEventBusCommand.d.ts +2 -1
- package/dist-types/commands/CreatePartnerEventSourceCommand.d.ts +2 -1
- package/dist-types/commands/DeactivateEventSourceCommand.d.ts +2 -1
- package/dist-types/commands/DeauthorizeConnectionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteApiDestinationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteArchiveCommand.d.ts +2 -1
- package/dist-types/commands/DeleteConnectionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteEventBusCommand.d.ts +2 -1
- package/dist-types/commands/DeletePartnerEventSourceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteRuleCommand.d.ts +2 -1
- package/dist-types/commands/DescribeApiDestinationCommand.d.ts +2 -1
- package/dist-types/commands/DescribeArchiveCommand.d.ts +2 -1
- package/dist-types/commands/DescribeConnectionCommand.d.ts +2 -1
- package/dist-types/commands/DescribeEventBusCommand.d.ts +2 -1
- package/dist-types/commands/DescribeEventSourceCommand.d.ts +2 -1
- package/dist-types/commands/DescribePartnerEventSourceCommand.d.ts +2 -1
- package/dist-types/commands/DescribeReplayCommand.d.ts +2 -1
- package/dist-types/commands/DescribeRuleCommand.d.ts +2 -1
- package/dist-types/commands/DisableRuleCommand.d.ts +2 -1
- package/dist-types/commands/EnableRuleCommand.d.ts +2 -1
- package/dist-types/commands/ListApiDestinationsCommand.d.ts +2 -1
- package/dist-types/commands/ListArchivesCommand.d.ts +2 -1
- package/dist-types/commands/ListConnectionsCommand.d.ts +2 -1
- package/dist-types/commands/ListEventBusesCommand.d.ts +2 -1
- package/dist-types/commands/ListEventSourcesCommand.d.ts +2 -1
- package/dist-types/commands/ListPartnerEventSourceAccountsCommand.d.ts +2 -1
- package/dist-types/commands/ListPartnerEventSourcesCommand.d.ts +2 -1
- package/dist-types/commands/ListReplaysCommand.d.ts +2 -1
- package/dist-types/commands/ListRuleNamesByTargetCommand.d.ts +2 -1
- package/dist-types/commands/ListRulesCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListTargetsByRuleCommand.d.ts +2 -1
- package/dist-types/commands/PutEventsCommand.d.ts +2 -1
- package/dist-types/commands/PutPartnerEventsCommand.d.ts +2 -1
- package/dist-types/commands/PutPermissionCommand.d.ts +2 -1
- package/dist-types/commands/PutRuleCommand.d.ts +2 -1
- package/dist-types/commands/PutTargetsCommand.d.ts +2 -1
- package/dist-types/commands/RemovePermissionCommand.d.ts +2 -1
- package/dist-types/commands/RemoveTargetsCommand.d.ts +2 -1
- package/dist-types/commands/StartReplayCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/TestEventPatternCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateApiDestinationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateArchiveCommand.d.ts +2 -1
- package/dist-types/commands/UpdateConnectionCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +561 -561
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/CloudWatchEvents.d.ts +10 -0
- package/dist-types/ts3.4/commands/ActivateEventSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CancelReplayCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateApiDestinationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateArchiveCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateConnectionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateEventBusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreatePartnerEventSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeactivateEventSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeauthorizeConnectionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteApiDestinationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteArchiveCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteConnectionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteEventBusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeletePartnerEventSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeApiDestinationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeArchiveCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeConnectionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeEventBusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeEventSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribePartnerEventSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeReplayCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisableRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/EnableRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListApiDestinationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListArchivesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListConnectionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListEventBusesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListEventSourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPartnerEventSourceAccountsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPartnerEventSourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListReplaysCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListRuleNamesByTargetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListRulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTargetsByRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutEventsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutPartnerEventsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutPermissionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutRuleCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/PutTargetsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RemovePermissionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RemoveTargetsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartReplayCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TestEventPatternCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateApiDestinationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateArchiveCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateConnectionCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -5,14 +5,14 @@ import { CloudWatchEventsServiceException as __BaseException } from "./CloudWatc
|
|
|
5
5
|
*/
|
|
6
6
|
export interface ActivateEventSourceRequest {
|
|
7
7
|
/**
|
|
8
|
-
* @public
|
|
9
8
|
* <p>The name of the partner event source to activate.</p>
|
|
9
|
+
* @public
|
|
10
10
|
*/
|
|
11
11
|
Name: string | undefined;
|
|
12
12
|
}
|
|
13
13
|
/**
|
|
14
|
-
* @public
|
|
15
14
|
* <p>There is concurrent modification on a rule, target, archive, or replay.</p>
|
|
15
|
+
* @public
|
|
16
16
|
*/
|
|
17
17
|
export declare class ConcurrentModificationException extends __BaseException {
|
|
18
18
|
readonly name: "ConcurrentModificationException";
|
|
@@ -23,8 +23,8 @@ export declare class ConcurrentModificationException extends __BaseException {
|
|
|
23
23
|
constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
|
-
* @public
|
|
27
26
|
* <p>This exception occurs due to unexpected causes.</p>
|
|
27
|
+
* @public
|
|
28
28
|
*/
|
|
29
29
|
export declare class InternalException extends __BaseException {
|
|
30
30
|
readonly name: "InternalException";
|
|
@@ -35,8 +35,8 @@ export declare class InternalException extends __BaseException {
|
|
|
35
35
|
constructor(opts: __ExceptionOptionType<InternalException, __BaseException>);
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
* @public
|
|
39
38
|
* <p>The specified state is not a valid state for an event source.</p>
|
|
39
|
+
* @public
|
|
40
40
|
*/
|
|
41
41
|
export declare class InvalidStateException extends __BaseException {
|
|
42
42
|
readonly name: "InvalidStateException";
|
|
@@ -47,8 +47,8 @@ export declare class InvalidStateException extends __BaseException {
|
|
|
47
47
|
constructor(opts: __ExceptionOptionType<InvalidStateException, __BaseException>);
|
|
48
48
|
}
|
|
49
49
|
/**
|
|
50
|
-
* @public
|
|
51
50
|
* <p>The operation you are attempting is not available in this region.</p>
|
|
51
|
+
* @public
|
|
52
52
|
*/
|
|
53
53
|
export declare class OperationDisabledException extends __BaseException {
|
|
54
54
|
readonly name: "OperationDisabledException";
|
|
@@ -59,8 +59,8 @@ export declare class OperationDisabledException extends __BaseException {
|
|
|
59
59
|
constructor(opts: __ExceptionOptionType<OperationDisabledException, __BaseException>);
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
|
-
* @public
|
|
63
62
|
* <p>An entity that you specified does not exist.</p>
|
|
63
|
+
* @public
|
|
64
64
|
*/
|
|
65
65
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
66
66
|
readonly name: "ResourceNotFoundException";
|
|
@@ -100,53 +100,53 @@ export declare const ApiDestinationHttpMethod: {
|
|
|
100
100
|
*/
|
|
101
101
|
export type ApiDestinationHttpMethod = (typeof ApiDestinationHttpMethod)[keyof typeof ApiDestinationHttpMethod];
|
|
102
102
|
/**
|
|
103
|
-
* @public
|
|
104
103
|
* <p>Contains details about an API destination.</p>
|
|
104
|
+
* @public
|
|
105
105
|
*/
|
|
106
106
|
export interface ApiDestination {
|
|
107
107
|
/**
|
|
108
|
-
* @public
|
|
109
108
|
* <p>The ARN of the API destination.</p>
|
|
109
|
+
* @public
|
|
110
110
|
*/
|
|
111
111
|
ApiDestinationArn?: string;
|
|
112
112
|
/**
|
|
113
|
-
* @public
|
|
114
113
|
* <p>The name of the API destination.</p>
|
|
114
|
+
* @public
|
|
115
115
|
*/
|
|
116
116
|
Name?: string;
|
|
117
117
|
/**
|
|
118
|
-
* @public
|
|
119
118
|
* <p>The state of the API destination.</p>
|
|
119
|
+
* @public
|
|
120
120
|
*/
|
|
121
121
|
ApiDestinationState?: ApiDestinationState;
|
|
122
122
|
/**
|
|
123
|
-
* @public
|
|
124
123
|
* <p>The ARN of the connection specified for the API destination.</p>
|
|
124
|
+
* @public
|
|
125
125
|
*/
|
|
126
126
|
ConnectionArn?: string;
|
|
127
127
|
/**
|
|
128
|
-
* @public
|
|
129
128
|
* <p>The URL to the endpoint for the API destination.</p>
|
|
129
|
+
* @public
|
|
130
130
|
*/
|
|
131
131
|
InvocationEndpoint?: string;
|
|
132
132
|
/**
|
|
133
|
-
* @public
|
|
134
133
|
* <p>The method to use to connect to the HTTP endpoint.</p>
|
|
134
|
+
* @public
|
|
135
135
|
*/
|
|
136
136
|
HttpMethod?: ApiDestinationHttpMethod;
|
|
137
137
|
/**
|
|
138
|
-
* @public
|
|
139
138
|
* <p>The maximum number of invocations per second to send to the HTTP endpoint.</p>
|
|
139
|
+
* @public
|
|
140
140
|
*/
|
|
141
141
|
InvocationRateLimitPerSecond?: number;
|
|
142
142
|
/**
|
|
143
|
-
* @public
|
|
144
143
|
* <p>A time stamp for the time that the API destination was created.</p>
|
|
144
|
+
* @public
|
|
145
145
|
*/
|
|
146
146
|
CreationTime?: Date;
|
|
147
147
|
/**
|
|
148
|
-
* @public
|
|
149
148
|
* <p>A time stamp for the time that the API destination was last modified.</p>
|
|
149
|
+
* @public
|
|
150
150
|
*/
|
|
151
151
|
LastModifiedTime?: Date;
|
|
152
152
|
}
|
|
@@ -167,49 +167,49 @@ export declare const ArchiveState: {
|
|
|
167
167
|
*/
|
|
168
168
|
export type ArchiveState = (typeof ArchiveState)[keyof typeof ArchiveState];
|
|
169
169
|
/**
|
|
170
|
-
* @public
|
|
171
170
|
* <p>An <code>Archive</code> object that contains details about an archive.</p>
|
|
171
|
+
* @public
|
|
172
172
|
*/
|
|
173
173
|
export interface Archive {
|
|
174
174
|
/**
|
|
175
|
-
* @public
|
|
176
175
|
* <p>The name of the archive.</p>
|
|
176
|
+
* @public
|
|
177
177
|
*/
|
|
178
178
|
ArchiveName?: string;
|
|
179
179
|
/**
|
|
180
|
-
* @public
|
|
181
180
|
* <p>The ARN of the event bus associated with the archive. Only events from this event bus are
|
|
182
181
|
* sent to the archive.</p>
|
|
182
|
+
* @public
|
|
183
183
|
*/
|
|
184
184
|
EventSourceArn?: string;
|
|
185
185
|
/**
|
|
186
|
-
* @public
|
|
187
186
|
* <p>The current state of the archive.</p>
|
|
187
|
+
* @public
|
|
188
188
|
*/
|
|
189
189
|
State?: ArchiveState;
|
|
190
190
|
/**
|
|
191
|
-
* @public
|
|
192
191
|
* <p>A description for the reason that the archive is in the current state.</p>
|
|
192
|
+
* @public
|
|
193
193
|
*/
|
|
194
194
|
StateReason?: string;
|
|
195
195
|
/**
|
|
196
|
-
* @public
|
|
197
196
|
* <p>The number of days to retain events in the archive before they are deleted.</p>
|
|
197
|
+
* @public
|
|
198
198
|
*/
|
|
199
199
|
RetentionDays?: number;
|
|
200
200
|
/**
|
|
201
|
-
* @public
|
|
202
201
|
* <p>The size of the archive, in bytes.</p>
|
|
202
|
+
* @public
|
|
203
203
|
*/
|
|
204
204
|
SizeBytes?: number;
|
|
205
205
|
/**
|
|
206
|
-
* @public
|
|
207
206
|
* <p>The number of events in the archive.</p>
|
|
207
|
+
* @public
|
|
208
208
|
*/
|
|
209
209
|
EventCount?: number;
|
|
210
210
|
/**
|
|
211
|
-
* @public
|
|
212
211
|
* <p>The time stamp for the time that the archive was created.</p>
|
|
212
|
+
* @public
|
|
213
213
|
*/
|
|
214
214
|
CreationTime?: Date;
|
|
215
215
|
}
|
|
@@ -230,8 +230,8 @@ export type AssignPublicIp = (typeof AssignPublicIp)[keyof typeof AssignPublicIp
|
|
|
230
230
|
*/
|
|
231
231
|
export interface CancelReplayRequest {
|
|
232
232
|
/**
|
|
233
|
-
* @public
|
|
234
233
|
* <p>The name of the replay to cancel.</p>
|
|
234
|
+
* @public
|
|
235
235
|
*/
|
|
236
236
|
ReplayName: string | undefined;
|
|
237
237
|
}
|
|
@@ -256,25 +256,25 @@ export type ReplayState = (typeof ReplayState)[keyof typeof ReplayState];
|
|
|
256
256
|
*/
|
|
257
257
|
export interface CancelReplayResponse {
|
|
258
258
|
/**
|
|
259
|
-
* @public
|
|
260
259
|
* <p>The ARN of the replay to cancel.</p>
|
|
260
|
+
* @public
|
|
261
261
|
*/
|
|
262
262
|
ReplayArn?: string;
|
|
263
263
|
/**
|
|
264
|
-
* @public
|
|
265
264
|
* <p>The current state of the replay.</p>
|
|
265
|
+
* @public
|
|
266
266
|
*/
|
|
267
267
|
State?: ReplayState;
|
|
268
268
|
/**
|
|
269
|
-
* @public
|
|
270
269
|
* <p>The reason that the replay is in the current state.</p>
|
|
270
|
+
* @public
|
|
271
271
|
*/
|
|
272
272
|
StateReason?: string;
|
|
273
273
|
}
|
|
274
274
|
/**
|
|
275
|
-
* @public
|
|
276
275
|
* <p>An error occurred because a replay can be canceled only when the state is Running or
|
|
277
276
|
* Starting.</p>
|
|
277
|
+
* @public
|
|
278
278
|
*/
|
|
279
279
|
export declare class IllegalStatusException extends __BaseException {
|
|
280
280
|
readonly name: "IllegalStatusException";
|
|
@@ -289,34 +289,34 @@ export declare class IllegalStatusException extends __BaseException {
|
|
|
289
289
|
*/
|
|
290
290
|
export interface CreateApiDestinationRequest {
|
|
291
291
|
/**
|
|
292
|
-
* @public
|
|
293
292
|
* <p>The name for the API destination to create.</p>
|
|
293
|
+
* @public
|
|
294
294
|
*/
|
|
295
295
|
Name: string | undefined;
|
|
296
296
|
/**
|
|
297
|
-
* @public
|
|
298
297
|
* <p>A description for the API destination to create.</p>
|
|
298
|
+
* @public
|
|
299
299
|
*/
|
|
300
300
|
Description?: string;
|
|
301
301
|
/**
|
|
302
|
-
* @public
|
|
303
302
|
* <p>The ARN of the connection to use for the API destination. The destination endpoint must
|
|
304
303
|
* support the authorization type specified for the connection.</p>
|
|
304
|
+
* @public
|
|
305
305
|
*/
|
|
306
306
|
ConnectionArn: string | undefined;
|
|
307
307
|
/**
|
|
308
|
-
* @public
|
|
309
308
|
* <p>The URL to the HTTP invocation endpoint for the API destination.</p>
|
|
309
|
+
* @public
|
|
310
310
|
*/
|
|
311
311
|
InvocationEndpoint: string | undefined;
|
|
312
312
|
/**
|
|
313
|
-
* @public
|
|
314
313
|
* <p>The method to use for the request to the HTTP invocation endpoint.</p>
|
|
314
|
+
* @public
|
|
315
315
|
*/
|
|
316
316
|
HttpMethod: ApiDestinationHttpMethod | undefined;
|
|
317
317
|
/**
|
|
318
|
-
* @public
|
|
319
318
|
* <p>The maximum number of requests per second to send to the HTTP invocation endpoint.</p>
|
|
319
|
+
* @public
|
|
320
320
|
*/
|
|
321
321
|
InvocationRateLimitPerSecond?: number;
|
|
322
322
|
}
|
|
@@ -325,30 +325,30 @@ export interface CreateApiDestinationRequest {
|
|
|
325
325
|
*/
|
|
326
326
|
export interface CreateApiDestinationResponse {
|
|
327
327
|
/**
|
|
328
|
-
* @public
|
|
329
328
|
* <p>The ARN of the API destination that was created by the request.</p>
|
|
329
|
+
* @public
|
|
330
330
|
*/
|
|
331
331
|
ApiDestinationArn?: string;
|
|
332
332
|
/**
|
|
333
|
-
* @public
|
|
334
333
|
* <p>The state of the API destination that was created by the request.</p>
|
|
334
|
+
* @public
|
|
335
335
|
*/
|
|
336
336
|
ApiDestinationState?: ApiDestinationState;
|
|
337
337
|
/**
|
|
338
|
-
* @public
|
|
339
338
|
* <p>A time stamp indicating the time that the API destination was created.</p>
|
|
339
|
+
* @public
|
|
340
340
|
*/
|
|
341
341
|
CreationTime?: Date;
|
|
342
342
|
/**
|
|
343
|
-
* @public
|
|
344
343
|
* <p>A time stamp indicating the time that the API destination was last modified.</p>
|
|
344
|
+
* @public
|
|
345
345
|
*/
|
|
346
346
|
LastModifiedTime?: Date;
|
|
347
347
|
}
|
|
348
348
|
/**
|
|
349
|
-
* @public
|
|
350
349
|
* <p>The request failed because it attempted to create resource beyond the allowed service
|
|
351
350
|
* quota.</p>
|
|
351
|
+
* @public
|
|
352
352
|
*/
|
|
353
353
|
export declare class LimitExceededException extends __BaseException {
|
|
354
354
|
readonly name: "LimitExceededException";
|
|
@@ -359,8 +359,8 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
359
359
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
360
360
|
}
|
|
361
361
|
/**
|
|
362
|
-
* @public
|
|
363
362
|
* <p>The resource you are trying to create already exists.</p>
|
|
363
|
+
* @public
|
|
364
364
|
*/
|
|
365
365
|
export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
366
366
|
readonly name: "ResourceAlreadyExistsException";
|
|
@@ -375,29 +375,29 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
375
375
|
*/
|
|
376
376
|
export interface CreateArchiveRequest {
|
|
377
377
|
/**
|
|
378
|
-
* @public
|
|
379
378
|
* <p>The name for the archive to create.</p>
|
|
379
|
+
* @public
|
|
380
380
|
*/
|
|
381
381
|
ArchiveName: string | undefined;
|
|
382
382
|
/**
|
|
383
|
-
* @public
|
|
384
383
|
* <p>The ARN of the event bus that sends events to the archive.</p>
|
|
384
|
+
* @public
|
|
385
385
|
*/
|
|
386
386
|
EventSourceArn: string | undefined;
|
|
387
387
|
/**
|
|
388
|
-
* @public
|
|
389
388
|
* <p>A description for the archive.</p>
|
|
389
|
+
* @public
|
|
390
390
|
*/
|
|
391
391
|
Description?: string;
|
|
392
392
|
/**
|
|
393
|
-
* @public
|
|
394
393
|
* <p>An event pattern to use to filter events sent to the archive.</p>
|
|
394
|
+
* @public
|
|
395
395
|
*/
|
|
396
396
|
EventPattern?: string;
|
|
397
397
|
/**
|
|
398
|
-
* @public
|
|
399
398
|
* <p>The number of days to retain events for. Default value is 0. If set to 0, events are
|
|
400
399
|
* retained indefinitely</p>
|
|
400
|
+
* @public
|
|
401
401
|
*/
|
|
402
402
|
RetentionDays?: number;
|
|
403
403
|
}
|
|
@@ -406,29 +406,29 @@ export interface CreateArchiveRequest {
|
|
|
406
406
|
*/
|
|
407
407
|
export interface CreateArchiveResponse {
|
|
408
408
|
/**
|
|
409
|
-
* @public
|
|
410
409
|
* <p>The ARN of the archive that was created.</p>
|
|
410
|
+
* @public
|
|
411
411
|
*/
|
|
412
412
|
ArchiveArn?: string;
|
|
413
413
|
/**
|
|
414
|
-
* @public
|
|
415
414
|
* <p>The state of the archive that was created.</p>
|
|
415
|
+
* @public
|
|
416
416
|
*/
|
|
417
417
|
State?: ArchiveState;
|
|
418
418
|
/**
|
|
419
|
-
* @public
|
|
420
419
|
* <p>The reason that the archive is in the state.</p>
|
|
420
|
+
* @public
|
|
421
421
|
*/
|
|
422
422
|
StateReason?: string;
|
|
423
423
|
/**
|
|
424
|
-
* @public
|
|
425
424
|
* <p>The time at which the archive was created.</p>
|
|
425
|
+
* @public
|
|
426
426
|
*/
|
|
427
427
|
CreationTime?: Date;
|
|
428
428
|
}
|
|
429
429
|
/**
|
|
430
|
-
* @public
|
|
431
430
|
* <p>The event pattern is not valid.</p>
|
|
431
|
+
* @public
|
|
432
432
|
*/
|
|
433
433
|
export declare class InvalidEventPatternException extends __BaseException {
|
|
434
434
|
readonly name: "InvalidEventPatternException";
|
|
@@ -452,139 +452,139 @@ export declare const ConnectionAuthorizationType: {
|
|
|
452
452
|
*/
|
|
453
453
|
export type ConnectionAuthorizationType = (typeof ConnectionAuthorizationType)[keyof typeof ConnectionAuthorizationType];
|
|
454
454
|
/**
|
|
455
|
-
* @public
|
|
456
455
|
* <p>Contains the API key authorization parameters for the connection.</p>
|
|
456
|
+
* @public
|
|
457
457
|
*/
|
|
458
458
|
export interface CreateConnectionApiKeyAuthRequestParameters {
|
|
459
459
|
/**
|
|
460
|
-
* @public
|
|
461
460
|
* <p>The name of the API key to use for authorization.</p>
|
|
461
|
+
* @public
|
|
462
462
|
*/
|
|
463
463
|
ApiKeyName: string | undefined;
|
|
464
464
|
/**
|
|
465
|
-
* @public
|
|
466
465
|
* <p>The value for the API key to use for authorization.</p>
|
|
466
|
+
* @public
|
|
467
467
|
*/
|
|
468
468
|
ApiKeyValue: string | undefined;
|
|
469
469
|
}
|
|
470
470
|
/**
|
|
471
|
-
* @public
|
|
472
471
|
* <p>Contains the Basic authorization parameters to use for the connection.</p>
|
|
472
|
+
* @public
|
|
473
473
|
*/
|
|
474
474
|
export interface CreateConnectionBasicAuthRequestParameters {
|
|
475
475
|
/**
|
|
476
|
-
* @public
|
|
477
476
|
* <p>The user name to use for Basic authorization.</p>
|
|
477
|
+
* @public
|
|
478
478
|
*/
|
|
479
479
|
Username: string | undefined;
|
|
480
480
|
/**
|
|
481
|
-
* @public
|
|
482
481
|
* <p>The password associated with the user name to use for Basic authorization.</p>
|
|
482
|
+
* @public
|
|
483
483
|
*/
|
|
484
484
|
Password: string | undefined;
|
|
485
485
|
}
|
|
486
486
|
/**
|
|
487
|
-
* @public
|
|
488
487
|
* <p>Additional parameter included in the body. You can include up to 100 additional body
|
|
489
488
|
* parameters per request. An event payload cannot exceed 64 KB.</p>
|
|
489
|
+
* @public
|
|
490
490
|
*/
|
|
491
491
|
export interface ConnectionBodyParameter {
|
|
492
492
|
/**
|
|
493
|
-
* @public
|
|
494
493
|
* <p>The key for the parameter.</p>
|
|
494
|
+
* @public
|
|
495
495
|
*/
|
|
496
496
|
Key?: string;
|
|
497
497
|
/**
|
|
498
|
-
* @public
|
|
499
498
|
* <p>The value associated with the key.</p>
|
|
499
|
+
* @public
|
|
500
500
|
*/
|
|
501
501
|
Value?: string;
|
|
502
502
|
/**
|
|
503
|
-
* @public
|
|
504
503
|
* <p>Specified whether the value is secret.</p>
|
|
504
|
+
* @public
|
|
505
505
|
*/
|
|
506
506
|
IsValueSecret?: boolean;
|
|
507
507
|
}
|
|
508
508
|
/**
|
|
509
|
-
* @public
|
|
510
509
|
* <p>Additional parameter included in the header. You can include up to 100 additional header
|
|
511
510
|
* parameters per request. An event payload cannot exceed 64 KB.</p>
|
|
511
|
+
* @public
|
|
512
512
|
*/
|
|
513
513
|
export interface ConnectionHeaderParameter {
|
|
514
514
|
/**
|
|
515
|
-
* @public
|
|
516
515
|
* <p>The key for the parameter.</p>
|
|
516
|
+
* @public
|
|
517
517
|
*/
|
|
518
518
|
Key?: string;
|
|
519
519
|
/**
|
|
520
|
-
* @public
|
|
521
520
|
* <p>The value associated with the key.</p>
|
|
521
|
+
* @public
|
|
522
522
|
*/
|
|
523
523
|
Value?: string;
|
|
524
524
|
/**
|
|
525
|
-
* @public
|
|
526
525
|
* <p>Specified whether the value is a secret.</p>
|
|
526
|
+
* @public
|
|
527
527
|
*/
|
|
528
528
|
IsValueSecret?: boolean;
|
|
529
529
|
}
|
|
530
530
|
/**
|
|
531
|
-
* @public
|
|
532
531
|
* <p>Additional query string parameter for the connection. You can include up to 100 additional
|
|
533
532
|
* query string parameters per request. Each additional parameter counts towards the event
|
|
534
533
|
* payload size, which cannot exceed 64 KB.</p>
|
|
534
|
+
* @public
|
|
535
535
|
*/
|
|
536
536
|
export interface ConnectionQueryStringParameter {
|
|
537
537
|
/**
|
|
538
|
-
* @public
|
|
539
538
|
* <p>The key for a query string parameter.</p>
|
|
539
|
+
* @public
|
|
540
540
|
*/
|
|
541
541
|
Key?: string;
|
|
542
542
|
/**
|
|
543
|
-
* @public
|
|
544
543
|
* <p>The value associated with the key for the query string parameter.</p>
|
|
544
|
+
* @public
|
|
545
545
|
*/
|
|
546
546
|
Value?: string;
|
|
547
547
|
/**
|
|
548
|
-
* @public
|
|
549
548
|
* <p>Specifies whether the value is secret.</p>
|
|
549
|
+
* @public
|
|
550
550
|
*/
|
|
551
551
|
IsValueSecret?: boolean;
|
|
552
552
|
}
|
|
553
553
|
/**
|
|
554
|
-
* @public
|
|
555
554
|
* <p>Contains additional parameters for the connection.</p>
|
|
555
|
+
* @public
|
|
556
556
|
*/
|
|
557
557
|
export interface ConnectionHttpParameters {
|
|
558
558
|
/**
|
|
559
|
-
* @public
|
|
560
559
|
* <p>Contains additional header parameters for the connection.</p>
|
|
560
|
+
* @public
|
|
561
561
|
*/
|
|
562
562
|
HeaderParameters?: ConnectionHeaderParameter[];
|
|
563
563
|
/**
|
|
564
|
-
* @public
|
|
565
564
|
* <p>Contains additional query string parameters for the connection.</p>
|
|
565
|
+
* @public
|
|
566
566
|
*/
|
|
567
567
|
QueryStringParameters?: ConnectionQueryStringParameter[];
|
|
568
568
|
/**
|
|
569
|
-
* @public
|
|
570
569
|
* <p>Contains additional body string parameters for the connection.</p>
|
|
570
|
+
* @public
|
|
571
571
|
*/
|
|
572
572
|
BodyParameters?: ConnectionBodyParameter[];
|
|
573
573
|
}
|
|
574
574
|
/**
|
|
575
|
-
* @public
|
|
576
575
|
* <p>Contains the Basic authorization parameters to use for the connection.</p>
|
|
576
|
+
* @public
|
|
577
577
|
*/
|
|
578
578
|
export interface CreateConnectionOAuthClientRequestParameters {
|
|
579
579
|
/**
|
|
580
|
-
* @public
|
|
581
580
|
* <p>The client ID to use for OAuth authorization for the connection.</p>
|
|
581
|
+
* @public
|
|
582
582
|
*/
|
|
583
583
|
ClientID: string | undefined;
|
|
584
584
|
/**
|
|
585
|
-
* @public
|
|
586
585
|
* <p>The client secret associated with the client ID to use for OAuth authorization for the
|
|
587
586
|
* connection.</p>
|
|
587
|
+
* @public
|
|
588
588
|
*/
|
|
589
589
|
ClientSecret: string | undefined;
|
|
590
590
|
}
|
|
@@ -602,63 +602,63 @@ export declare const ConnectionOAuthHttpMethod: {
|
|
|
602
602
|
*/
|
|
603
603
|
export type ConnectionOAuthHttpMethod = (typeof ConnectionOAuthHttpMethod)[keyof typeof ConnectionOAuthHttpMethod];
|
|
604
604
|
/**
|
|
605
|
-
* @public
|
|
606
605
|
* <p>Contains the OAuth authorization parameters to use for the connection.</p>
|
|
606
|
+
* @public
|
|
607
607
|
*/
|
|
608
608
|
export interface CreateConnectionOAuthRequestParameters {
|
|
609
609
|
/**
|
|
610
|
-
* @public
|
|
611
610
|
* <p>A <code>CreateConnectionOAuthClientRequestParameters</code> object that contains the
|
|
612
611
|
* client parameters for OAuth authorization.</p>
|
|
612
|
+
* @public
|
|
613
613
|
*/
|
|
614
614
|
ClientParameters: CreateConnectionOAuthClientRequestParameters | undefined;
|
|
615
615
|
/**
|
|
616
|
-
* @public
|
|
617
616
|
* <p>The URL to the authorization endpoint when OAuth is specified as the authorization
|
|
618
617
|
* type.</p>
|
|
618
|
+
* @public
|
|
619
619
|
*/
|
|
620
620
|
AuthorizationEndpoint: string | undefined;
|
|
621
621
|
/**
|
|
622
|
-
* @public
|
|
623
622
|
* <p>The method to use for the authorization request.</p>
|
|
623
|
+
* @public
|
|
624
624
|
*/
|
|
625
625
|
HttpMethod: ConnectionOAuthHttpMethod | undefined;
|
|
626
626
|
/**
|
|
627
|
-
* @public
|
|
628
627
|
* <p>A <code>ConnectionHttpParameters</code> object that contains details about the additional
|
|
629
628
|
* parameters to use for the connection.</p>
|
|
629
|
+
* @public
|
|
630
630
|
*/
|
|
631
631
|
OAuthHttpParameters?: ConnectionHttpParameters;
|
|
632
632
|
}
|
|
633
633
|
/**
|
|
634
|
-
* @public
|
|
635
634
|
* <p>Contains the authorization parameters for the connection.</p>
|
|
635
|
+
* @public
|
|
636
636
|
*/
|
|
637
637
|
export interface CreateConnectionAuthRequestParameters {
|
|
638
638
|
/**
|
|
639
|
-
* @public
|
|
640
639
|
* <p>A <code>CreateConnectionBasicAuthRequestParameters</code> object that contains the Basic
|
|
641
640
|
* authorization parameters to use for the connection.</p>
|
|
641
|
+
* @public
|
|
642
642
|
*/
|
|
643
643
|
BasicAuthParameters?: CreateConnectionBasicAuthRequestParameters;
|
|
644
644
|
/**
|
|
645
|
-
* @public
|
|
646
645
|
* <p>A <code>CreateConnectionOAuthRequestParameters</code> object that contains the OAuth
|
|
647
646
|
* authorization parameters to use for the connection.</p>
|
|
647
|
+
* @public
|
|
648
648
|
*/
|
|
649
649
|
OAuthParameters?: CreateConnectionOAuthRequestParameters;
|
|
650
650
|
/**
|
|
651
|
-
* @public
|
|
652
651
|
* <p>A <code>CreateConnectionApiKeyAuthRequestParameters</code> object that contains the API
|
|
653
652
|
* key authorization parameters to use for the connection.</p>
|
|
653
|
+
* @public
|
|
654
654
|
*/
|
|
655
655
|
ApiKeyAuthParameters?: CreateConnectionApiKeyAuthRequestParameters;
|
|
656
656
|
/**
|
|
657
|
-
* @public
|
|
658
657
|
* <p>A <code>ConnectionHttpParameters</code> object that contains the API key authorization
|
|
659
658
|
* parameters to use for the connection. Note that if you include additional parameters for the
|
|
660
659
|
* target of a rule via <code>HttpParameters</code>, including query strings, the parameters
|
|
661
660
|
* added for the connection take precedence.</p>
|
|
661
|
+
* @public
|
|
662
662
|
*/
|
|
663
663
|
InvocationHttpParameters?: ConnectionHttpParameters;
|
|
664
664
|
}
|
|
@@ -667,24 +667,24 @@ export interface CreateConnectionAuthRequestParameters {
|
|
|
667
667
|
*/
|
|
668
668
|
export interface CreateConnectionRequest {
|
|
669
669
|
/**
|
|
670
|
-
* @public
|
|
671
670
|
* <p>The name for the connection to create.</p>
|
|
671
|
+
* @public
|
|
672
672
|
*/
|
|
673
673
|
Name: string | undefined;
|
|
674
674
|
/**
|
|
675
|
-
* @public
|
|
676
675
|
* <p>A description for the connection to create.</p>
|
|
676
|
+
* @public
|
|
677
677
|
*/
|
|
678
678
|
Description?: string;
|
|
679
679
|
/**
|
|
680
|
-
* @public
|
|
681
680
|
* <p>The type of authorization to use for the connection.</p>
|
|
681
|
+
* @public
|
|
682
682
|
*/
|
|
683
683
|
AuthorizationType: ConnectionAuthorizationType | undefined;
|
|
684
684
|
/**
|
|
685
|
-
* @public
|
|
686
685
|
* <p>A <code>CreateConnectionAuthRequestParameters</code> object that contains the
|
|
687
686
|
* authorization parameters to use to authorize with the endpoint. </p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
AuthParameters: CreateConnectionAuthRequestParameters | undefined;
|
|
690
690
|
}
|
|
@@ -710,41 +710,41 @@ export type ConnectionState = (typeof ConnectionState)[keyof typeof ConnectionSt
|
|
|
710
710
|
*/
|
|
711
711
|
export interface CreateConnectionResponse {
|
|
712
712
|
/**
|
|
713
|
-
* @public
|
|
714
713
|
* <p>The ARN of the connection that was created by the request.</p>
|
|
714
|
+
* @public
|
|
715
715
|
*/
|
|
716
716
|
ConnectionArn?: string;
|
|
717
717
|
/**
|
|
718
|
-
* @public
|
|
719
718
|
* <p>The state of the connection that was created by the request.</p>
|
|
719
|
+
* @public
|
|
720
720
|
*/
|
|
721
721
|
ConnectionState?: ConnectionState;
|
|
722
722
|
/**
|
|
723
|
-
* @public
|
|
724
723
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
724
|
+
* @public
|
|
725
725
|
*/
|
|
726
726
|
CreationTime?: Date;
|
|
727
727
|
/**
|
|
728
|
-
* @public
|
|
729
728
|
* <p>A time stamp for the time that the connection was last updated.</p>
|
|
729
|
+
* @public
|
|
730
730
|
*/
|
|
731
731
|
LastModifiedTime?: Date;
|
|
732
732
|
}
|
|
733
733
|
/**
|
|
734
|
-
* @public
|
|
735
734
|
* <p>A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses
|
|
736
735
|
* support tagging.</p>
|
|
736
|
+
* @public
|
|
737
737
|
*/
|
|
738
738
|
export interface Tag {
|
|
739
739
|
/**
|
|
740
|
-
* @public
|
|
741
740
|
* <p>A string you can use to assign a value. The combination of tag keys and values can help
|
|
742
741
|
* you organize and categorize your resources.</p>
|
|
742
|
+
* @public
|
|
743
743
|
*/
|
|
744
744
|
Key: string | undefined;
|
|
745
745
|
/**
|
|
746
|
-
* @public
|
|
747
746
|
* <p>The value for the specified tag key.</p>
|
|
747
|
+
* @public
|
|
748
748
|
*/
|
|
749
749
|
Value: string | undefined;
|
|
750
750
|
}
|
|
@@ -753,24 +753,24 @@ export interface Tag {
|
|
|
753
753
|
*/
|
|
754
754
|
export interface CreateEventBusRequest {
|
|
755
755
|
/**
|
|
756
|
-
* @public
|
|
757
756
|
* <p>The name of the new event bus. </p>
|
|
758
757
|
* <p>Event bus names cannot contain the / character. You can't use the name
|
|
759
758
|
* <code>default</code> for a custom event bus, as this name is already used for your account's
|
|
760
759
|
* default event bus.</p>
|
|
761
760
|
* <p>If this is a partner event bus, the name must exactly match the name of the partner event
|
|
762
761
|
* source that this event bus is matched to.</p>
|
|
762
|
+
* @public
|
|
763
763
|
*/
|
|
764
764
|
Name: string | undefined;
|
|
765
765
|
/**
|
|
766
|
-
* @public
|
|
767
766
|
* <p>If you are creating a partner event bus, this specifies the partner event source that the
|
|
768
767
|
* new event bus will be matched with.</p>
|
|
768
|
+
* @public
|
|
769
769
|
*/
|
|
770
770
|
EventSourceName?: string;
|
|
771
771
|
/**
|
|
772
|
-
* @public
|
|
773
772
|
* <p>Tags to associate with the event bus.</p>
|
|
773
|
+
* @public
|
|
774
774
|
*/
|
|
775
775
|
Tags?: Tag[];
|
|
776
776
|
}
|
|
@@ -779,8 +779,8 @@ export interface CreateEventBusRequest {
|
|
|
779
779
|
*/
|
|
780
780
|
export interface CreateEventBusResponse {
|
|
781
781
|
/**
|
|
782
|
-
* @public
|
|
783
782
|
* <p>The ARN of the new event bus.</p>
|
|
783
|
+
* @public
|
|
784
784
|
*/
|
|
785
785
|
EventBusArn?: string;
|
|
786
786
|
}
|
|
@@ -789,19 +789,19 @@ export interface CreateEventBusResponse {
|
|
|
789
789
|
*/
|
|
790
790
|
export interface CreatePartnerEventSourceRequest {
|
|
791
791
|
/**
|
|
792
|
-
* @public
|
|
793
792
|
* <p>The name of the partner event source. This name must be unique and must be in the format
|
|
794
793
|
* <code>
|
|
795
794
|
* <i>partner_name</i>/<i>event_namespace</i>/<i>event_name</i>
|
|
796
795
|
* </code>.
|
|
797
796
|
* The Amazon Web Services account that wants to use this partner event source must create a partner event bus
|
|
798
797
|
* with a name that matches the name of the partner event source.</p>
|
|
798
|
+
* @public
|
|
799
799
|
*/
|
|
800
800
|
Name: string | undefined;
|
|
801
801
|
/**
|
|
802
|
-
* @public
|
|
803
802
|
* <p>The Amazon Web Services account ID that is permitted to create a matching partner event bus for this
|
|
804
803
|
* partner event source.</p>
|
|
804
|
+
* @public
|
|
805
805
|
*/
|
|
806
806
|
Account: string | undefined;
|
|
807
807
|
}
|
|
@@ -810,8 +810,8 @@ export interface CreatePartnerEventSourceRequest {
|
|
|
810
810
|
*/
|
|
811
811
|
export interface CreatePartnerEventSourceResponse {
|
|
812
812
|
/**
|
|
813
|
-
* @public
|
|
814
813
|
* <p>The ARN of the partner event source.</p>
|
|
814
|
+
* @public
|
|
815
815
|
*/
|
|
816
816
|
EventSourceArn?: string;
|
|
817
817
|
}
|
|
@@ -820,8 +820,8 @@ export interface CreatePartnerEventSourceResponse {
|
|
|
820
820
|
*/
|
|
821
821
|
export interface DeactivateEventSourceRequest {
|
|
822
822
|
/**
|
|
823
|
-
* @public
|
|
824
823
|
* <p>The name of the partner event source to deactivate.</p>
|
|
824
|
+
* @public
|
|
825
825
|
*/
|
|
826
826
|
Name: string | undefined;
|
|
827
827
|
}
|
|
@@ -830,8 +830,8 @@ export interface DeactivateEventSourceRequest {
|
|
|
830
830
|
*/
|
|
831
831
|
export interface DeauthorizeConnectionRequest {
|
|
832
832
|
/**
|
|
833
|
-
* @public
|
|
834
833
|
* <p>The name of the connection to remove authorization from.</p>
|
|
834
|
+
* @public
|
|
835
835
|
*/
|
|
836
836
|
Name: string | undefined;
|
|
837
837
|
}
|
|
@@ -840,28 +840,28 @@ export interface DeauthorizeConnectionRequest {
|
|
|
840
840
|
*/
|
|
841
841
|
export interface DeauthorizeConnectionResponse {
|
|
842
842
|
/**
|
|
843
|
-
* @public
|
|
844
843
|
* <p>The ARN of the connection that authorization was removed from.</p>
|
|
844
|
+
* @public
|
|
845
845
|
*/
|
|
846
846
|
ConnectionArn?: string;
|
|
847
847
|
/**
|
|
848
|
-
* @public
|
|
849
848
|
* <p>The state of the connection.</p>
|
|
849
|
+
* @public
|
|
850
850
|
*/
|
|
851
851
|
ConnectionState?: ConnectionState;
|
|
852
852
|
/**
|
|
853
|
-
* @public
|
|
854
853
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
854
|
+
* @public
|
|
855
855
|
*/
|
|
856
856
|
CreationTime?: Date;
|
|
857
857
|
/**
|
|
858
|
-
* @public
|
|
859
858
|
* <p>A time stamp for the time that the connection was last updated.</p>
|
|
859
|
+
* @public
|
|
860
860
|
*/
|
|
861
861
|
LastModifiedTime?: Date;
|
|
862
862
|
/**
|
|
863
|
-
* @public
|
|
864
863
|
* <p>A time stamp for the time that the connection was last authorized.</p>
|
|
864
|
+
* @public
|
|
865
865
|
*/
|
|
866
866
|
LastAuthorizedTime?: Date;
|
|
867
867
|
}
|
|
@@ -870,8 +870,8 @@ export interface DeauthorizeConnectionResponse {
|
|
|
870
870
|
*/
|
|
871
871
|
export interface DeleteApiDestinationRequest {
|
|
872
872
|
/**
|
|
873
|
-
* @public
|
|
874
873
|
* <p>The name of the destination to delete.</p>
|
|
874
|
+
* @public
|
|
875
875
|
*/
|
|
876
876
|
Name: string | undefined;
|
|
877
877
|
}
|
|
@@ -885,8 +885,8 @@ export interface DeleteApiDestinationResponse {
|
|
|
885
885
|
*/
|
|
886
886
|
export interface DeleteArchiveRequest {
|
|
887
887
|
/**
|
|
888
|
-
* @public
|
|
889
888
|
* <p>The name of the archive to delete.</p>
|
|
889
|
+
* @public
|
|
890
890
|
*/
|
|
891
891
|
ArchiveName: string | undefined;
|
|
892
892
|
}
|
|
@@ -900,8 +900,8 @@ export interface DeleteArchiveResponse {
|
|
|
900
900
|
*/
|
|
901
901
|
export interface DeleteConnectionRequest {
|
|
902
902
|
/**
|
|
903
|
-
* @public
|
|
904
903
|
* <p>The name of the connection to delete.</p>
|
|
904
|
+
* @public
|
|
905
905
|
*/
|
|
906
906
|
Name: string | undefined;
|
|
907
907
|
}
|
|
@@ -910,30 +910,30 @@ export interface DeleteConnectionRequest {
|
|
|
910
910
|
*/
|
|
911
911
|
export interface DeleteConnectionResponse {
|
|
912
912
|
/**
|
|
913
|
-
* @public
|
|
914
913
|
* <p>The ARN of the connection that was deleted.</p>
|
|
914
|
+
* @public
|
|
915
915
|
*/
|
|
916
916
|
ConnectionArn?: string;
|
|
917
917
|
/**
|
|
918
|
-
* @public
|
|
919
918
|
* <p>The state of the connection before it was deleted.</p>
|
|
919
|
+
* @public
|
|
920
920
|
*/
|
|
921
921
|
ConnectionState?: ConnectionState;
|
|
922
922
|
/**
|
|
923
|
-
* @public
|
|
924
923
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
924
|
+
* @public
|
|
925
925
|
*/
|
|
926
926
|
CreationTime?: Date;
|
|
927
927
|
/**
|
|
928
|
-
* @public
|
|
929
928
|
* <p>A time stamp for the time that the connection was last modified before it was
|
|
930
929
|
* deleted.</p>
|
|
930
|
+
* @public
|
|
931
931
|
*/
|
|
932
932
|
LastModifiedTime?: Date;
|
|
933
933
|
/**
|
|
934
|
-
* @public
|
|
935
934
|
* <p>A time stamp for the time that the connection was last authorized before it wa
|
|
936
935
|
* deleted.</p>
|
|
936
|
+
* @public
|
|
937
937
|
*/
|
|
938
938
|
LastAuthorizedTime?: Date;
|
|
939
939
|
}
|
|
@@ -942,8 +942,8 @@ export interface DeleteConnectionResponse {
|
|
|
942
942
|
*/
|
|
943
943
|
export interface DeleteEventBusRequest {
|
|
944
944
|
/**
|
|
945
|
-
* @public
|
|
946
945
|
* <p>The name of the event bus to delete.</p>
|
|
946
|
+
* @public
|
|
947
947
|
*/
|
|
948
948
|
Name: string | undefined;
|
|
949
949
|
}
|
|
@@ -952,13 +952,13 @@ export interface DeleteEventBusRequest {
|
|
|
952
952
|
*/
|
|
953
953
|
export interface DeletePartnerEventSourceRequest {
|
|
954
954
|
/**
|
|
955
|
-
* @public
|
|
956
955
|
* <p>The name of the event source to delete.</p>
|
|
956
|
+
* @public
|
|
957
957
|
*/
|
|
958
958
|
Name: string | undefined;
|
|
959
959
|
/**
|
|
960
|
-
* @public
|
|
961
960
|
* <p>The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.</p>
|
|
961
|
+
* @public
|
|
962
962
|
*/
|
|
963
963
|
Account: string | undefined;
|
|
964
964
|
}
|
|
@@ -967,34 +967,34 @@ export interface DeletePartnerEventSourceRequest {
|
|
|
967
967
|
*/
|
|
968
968
|
export interface DeleteRuleRequest {
|
|
969
969
|
/**
|
|
970
|
-
* @public
|
|
971
970
|
* <p>The name of the rule.</p>
|
|
971
|
+
* @public
|
|
972
972
|
*/
|
|
973
973
|
Name: string | undefined;
|
|
974
974
|
/**
|
|
975
|
-
* @public
|
|
976
975
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
977
976
|
* event bus is used.</p>
|
|
977
|
+
* @public
|
|
978
978
|
*/
|
|
979
979
|
EventBusName?: string;
|
|
980
980
|
/**
|
|
981
|
-
* @public
|
|
982
981
|
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
|
|
983
982
|
* <code>Force</code> as <code>True</code> to delete the rule. This parameter is ignored for
|
|
984
983
|
* rules that are not managed rules. You can check whether a rule is a managed rule by using
|
|
985
984
|
* <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code>
|
|
986
985
|
* field of the response.</p>
|
|
986
|
+
* @public
|
|
987
987
|
*/
|
|
988
988
|
Force?: boolean;
|
|
989
989
|
}
|
|
990
990
|
/**
|
|
991
|
-
* @public
|
|
992
991
|
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that
|
|
993
992
|
* service. If you see this error in response to <code>DeleteRule</code> or
|
|
994
993
|
* <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to
|
|
995
994
|
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
|
|
996
995
|
* using <code>DisableRule</code>, <code>EnableRule</code>, <code>PutTargets</code>,
|
|
997
996
|
* <code>PutRule</code>, <code>TagResource</code>, or <code>UntagResource</code>. </p>
|
|
997
|
+
* @public
|
|
998
998
|
*/
|
|
999
999
|
export declare class ManagedRuleException extends __BaseException {
|
|
1000
1000
|
readonly name: "ManagedRuleException";
|
|
@@ -1009,8 +1009,8 @@ export declare class ManagedRuleException extends __BaseException {
|
|
|
1009
1009
|
*/
|
|
1010
1010
|
export interface DescribeApiDestinationRequest {
|
|
1011
1011
|
/**
|
|
1012
|
-
* @public
|
|
1013
1012
|
* <p>The name of the API destination to retrieve.</p>
|
|
1013
|
+
* @public
|
|
1014
1014
|
*/
|
|
1015
1015
|
Name: string | undefined;
|
|
1016
1016
|
}
|
|
@@ -1019,58 +1019,58 @@ export interface DescribeApiDestinationRequest {
|
|
|
1019
1019
|
*/
|
|
1020
1020
|
export interface DescribeApiDestinationResponse {
|
|
1021
1021
|
/**
|
|
1022
|
-
* @public
|
|
1023
1022
|
* <p>The ARN of the API destination retrieved.</p>
|
|
1023
|
+
* @public
|
|
1024
1024
|
*/
|
|
1025
1025
|
ApiDestinationArn?: string;
|
|
1026
1026
|
/**
|
|
1027
|
-
* @public
|
|
1028
1027
|
* <p>The name of the API destination retrieved.</p>
|
|
1028
|
+
* @public
|
|
1029
1029
|
*/
|
|
1030
1030
|
Name?: string;
|
|
1031
1031
|
/**
|
|
1032
|
-
* @public
|
|
1033
1032
|
* <p>The description for the API destination retrieved.</p>
|
|
1033
|
+
* @public
|
|
1034
1034
|
*/
|
|
1035
1035
|
Description?: string;
|
|
1036
1036
|
/**
|
|
1037
|
-
* @public
|
|
1038
1037
|
* <p>The state of the API destination retrieved.</p>
|
|
1038
|
+
* @public
|
|
1039
1039
|
*/
|
|
1040
1040
|
ApiDestinationState?: ApiDestinationState;
|
|
1041
1041
|
/**
|
|
1042
|
-
* @public
|
|
1043
1042
|
* <p>The ARN of the connection specified for the API destination retrieved.</p>
|
|
1043
|
+
* @public
|
|
1044
1044
|
*/
|
|
1045
1045
|
ConnectionArn?: string;
|
|
1046
1046
|
/**
|
|
1047
|
-
* @public
|
|
1048
1047
|
* <p>The URL to use to connect to the HTTP endpoint.</p>
|
|
1048
|
+
* @public
|
|
1049
1049
|
*/
|
|
1050
1050
|
InvocationEndpoint?: string;
|
|
1051
1051
|
/**
|
|
1052
|
-
* @public
|
|
1053
1052
|
* <p>The method to use to connect to the HTTP endpoint.</p>
|
|
1053
|
+
* @public
|
|
1054
1054
|
*/
|
|
1055
1055
|
HttpMethod?: ApiDestinationHttpMethod;
|
|
1056
1056
|
/**
|
|
1057
|
-
* @public
|
|
1058
1057
|
* <p>The maximum number of invocations per second to specified for the API destination. Note
|
|
1059
1058
|
* that if you set the invocation rate maximum to a value lower the rate necessary to send all
|
|
1060
1059
|
* events received on to the destination HTTP endpoint, some events may not be delivered within
|
|
1061
1060
|
* the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver
|
|
1062
1061
|
* all events, consider using a dead-letter queue to catch events that are not delivered within
|
|
1063
1062
|
* 24 hours.</p>
|
|
1063
|
+
* @public
|
|
1064
1064
|
*/
|
|
1065
1065
|
InvocationRateLimitPerSecond?: number;
|
|
1066
1066
|
/**
|
|
1067
|
-
* @public
|
|
1068
1067
|
* <p>A time stamp for the time that the API destination was created.</p>
|
|
1068
|
+
* @public
|
|
1069
1069
|
*/
|
|
1070
1070
|
CreationTime?: Date;
|
|
1071
1071
|
/**
|
|
1072
|
-
* @public
|
|
1073
1072
|
* <p>A time stamp for the time that the API destination was last modified.</p>
|
|
1073
|
+
* @public
|
|
1074
1074
|
*/
|
|
1075
1075
|
LastModifiedTime?: Date;
|
|
1076
1076
|
}
|
|
@@ -1079,8 +1079,8 @@ export interface DescribeApiDestinationResponse {
|
|
|
1079
1079
|
*/
|
|
1080
1080
|
export interface DescribeArchiveRequest {
|
|
1081
1081
|
/**
|
|
1082
|
-
* @public
|
|
1083
1082
|
* <p>The name of the archive to retrieve.</p>
|
|
1083
|
+
* @public
|
|
1084
1084
|
*/
|
|
1085
1085
|
ArchiveName: string | undefined;
|
|
1086
1086
|
}
|
|
@@ -1089,58 +1089,58 @@ export interface DescribeArchiveRequest {
|
|
|
1089
1089
|
*/
|
|
1090
1090
|
export interface DescribeArchiveResponse {
|
|
1091
1091
|
/**
|
|
1092
|
-
* @public
|
|
1093
1092
|
* <p>The ARN of the archive.</p>
|
|
1093
|
+
* @public
|
|
1094
1094
|
*/
|
|
1095
1095
|
ArchiveArn?: string;
|
|
1096
1096
|
/**
|
|
1097
|
-
* @public
|
|
1098
1097
|
* <p>The name of the archive.</p>
|
|
1098
|
+
* @public
|
|
1099
1099
|
*/
|
|
1100
1100
|
ArchiveName?: string;
|
|
1101
1101
|
/**
|
|
1102
|
-
* @public
|
|
1103
1102
|
* <p>The ARN of the event source associated with the archive.</p>
|
|
1103
|
+
* @public
|
|
1104
1104
|
*/
|
|
1105
1105
|
EventSourceArn?: string;
|
|
1106
1106
|
/**
|
|
1107
|
-
* @public
|
|
1108
1107
|
* <p>The description of the archive.</p>
|
|
1108
|
+
* @public
|
|
1109
1109
|
*/
|
|
1110
1110
|
Description?: string;
|
|
1111
1111
|
/**
|
|
1112
|
-
* @public
|
|
1113
1112
|
* <p>The event pattern used to filter events sent to the archive.</p>
|
|
1113
|
+
* @public
|
|
1114
1114
|
*/
|
|
1115
1115
|
EventPattern?: string;
|
|
1116
1116
|
/**
|
|
1117
|
-
* @public
|
|
1118
1117
|
* <p>The state of the archive.</p>
|
|
1118
|
+
* @public
|
|
1119
1119
|
*/
|
|
1120
1120
|
State?: ArchiveState;
|
|
1121
1121
|
/**
|
|
1122
|
-
* @public
|
|
1123
1122
|
* <p>The reason that the archive is in the state.</p>
|
|
1123
|
+
* @public
|
|
1124
1124
|
*/
|
|
1125
1125
|
StateReason?: string;
|
|
1126
1126
|
/**
|
|
1127
|
-
* @public
|
|
1128
1127
|
* <p>The number of days to retain events for in the archive.</p>
|
|
1128
|
+
* @public
|
|
1129
1129
|
*/
|
|
1130
1130
|
RetentionDays?: number;
|
|
1131
1131
|
/**
|
|
1132
|
-
* @public
|
|
1133
1132
|
* <p>The size of the archive in bytes.</p>
|
|
1133
|
+
* @public
|
|
1134
1134
|
*/
|
|
1135
1135
|
SizeBytes?: number;
|
|
1136
1136
|
/**
|
|
1137
|
-
* @public
|
|
1138
1137
|
* <p>The number of events in the archive.</p>
|
|
1138
|
+
* @public
|
|
1139
1139
|
*/
|
|
1140
1140
|
EventCount?: number;
|
|
1141
1141
|
/**
|
|
1142
|
-
* @public
|
|
1143
1142
|
* <p>The time at which the archive was created.</p>
|
|
1143
|
+
* @public
|
|
1144
1144
|
*/
|
|
1145
1145
|
CreationTime?: Date;
|
|
1146
1146
|
}
|
|
@@ -1149,99 +1149,99 @@ export interface DescribeArchiveResponse {
|
|
|
1149
1149
|
*/
|
|
1150
1150
|
export interface DescribeConnectionRequest {
|
|
1151
1151
|
/**
|
|
1152
|
-
* @public
|
|
1153
1152
|
* <p>The name of the connection to retrieve.</p>
|
|
1153
|
+
* @public
|
|
1154
1154
|
*/
|
|
1155
1155
|
Name: string | undefined;
|
|
1156
1156
|
}
|
|
1157
1157
|
/**
|
|
1158
|
-
* @public
|
|
1159
1158
|
* <p>Contains the authorization parameters for the connection if API Key is specified as the
|
|
1160
1159
|
* authorization type.</p>
|
|
1160
|
+
* @public
|
|
1161
1161
|
*/
|
|
1162
1162
|
export interface ConnectionApiKeyAuthResponseParameters {
|
|
1163
1163
|
/**
|
|
1164
|
-
* @public
|
|
1165
1164
|
* <p>The name of the header to use for the <code>APIKeyValue</code> used for
|
|
1166
1165
|
* authorization.</p>
|
|
1166
|
+
* @public
|
|
1167
1167
|
*/
|
|
1168
1168
|
ApiKeyName?: string;
|
|
1169
1169
|
}
|
|
1170
1170
|
/**
|
|
1171
|
-
* @public
|
|
1172
1171
|
* <p>Contains the authorization parameters for the connection if Basic is specified as the
|
|
1173
1172
|
* authorization type.</p>
|
|
1173
|
+
* @public
|
|
1174
1174
|
*/
|
|
1175
1175
|
export interface ConnectionBasicAuthResponseParameters {
|
|
1176
1176
|
/**
|
|
1177
|
-
* @public
|
|
1178
1177
|
* <p>The user name to use for Basic authorization.</p>
|
|
1178
|
+
* @public
|
|
1179
1179
|
*/
|
|
1180
1180
|
Username?: string;
|
|
1181
1181
|
}
|
|
1182
1182
|
/**
|
|
1183
|
-
* @public
|
|
1184
1183
|
* <p>Contains the client response parameters for the connection when OAuth is specified as the
|
|
1185
1184
|
* authorization type.</p>
|
|
1185
|
+
* @public
|
|
1186
1186
|
*/
|
|
1187
1187
|
export interface ConnectionOAuthClientResponseParameters {
|
|
1188
1188
|
/**
|
|
1189
|
-
* @public
|
|
1190
1189
|
* <p>The client ID associated with the response to the connection request.</p>
|
|
1190
|
+
* @public
|
|
1191
1191
|
*/
|
|
1192
1192
|
ClientID?: string;
|
|
1193
1193
|
}
|
|
1194
1194
|
/**
|
|
1195
|
-
* @public
|
|
1196
1195
|
* <p>Contains the response parameters when OAuth is specified as the authorization type.</p>
|
|
1196
|
+
* @public
|
|
1197
1197
|
*/
|
|
1198
1198
|
export interface ConnectionOAuthResponseParameters {
|
|
1199
1199
|
/**
|
|
1200
|
-
* @public
|
|
1201
1200
|
* <p>A <code>ConnectionOAuthClientResponseParameters</code> object that contains details about
|
|
1202
1201
|
* the client parameters returned when OAuth is specified as the authorization type.</p>
|
|
1202
|
+
* @public
|
|
1203
1203
|
*/
|
|
1204
1204
|
ClientParameters?: ConnectionOAuthClientResponseParameters;
|
|
1205
1205
|
/**
|
|
1206
|
-
* @public
|
|
1207
1206
|
* <p>The URL to the HTTP endpoint that authorized the request.</p>
|
|
1207
|
+
* @public
|
|
1208
1208
|
*/
|
|
1209
1209
|
AuthorizationEndpoint?: string;
|
|
1210
1210
|
/**
|
|
1211
|
-
* @public
|
|
1212
1211
|
* <p>The method used to connect to the HTTP endpoint.</p>
|
|
1212
|
+
* @public
|
|
1213
1213
|
*/
|
|
1214
1214
|
HttpMethod?: ConnectionOAuthHttpMethod;
|
|
1215
1215
|
/**
|
|
1216
|
-
* @public
|
|
1217
1216
|
* <p>The additional HTTP parameters used for the OAuth authorization request.</p>
|
|
1217
|
+
* @public
|
|
1218
1218
|
*/
|
|
1219
1219
|
OAuthHttpParameters?: ConnectionHttpParameters;
|
|
1220
1220
|
}
|
|
1221
1221
|
/**
|
|
1222
|
-
* @public
|
|
1223
1222
|
* <p>Contains the authorization parameters to use for the connection.</p>
|
|
1223
|
+
* @public
|
|
1224
1224
|
*/
|
|
1225
1225
|
export interface ConnectionAuthResponseParameters {
|
|
1226
1226
|
/**
|
|
1227
|
-
* @public
|
|
1228
1227
|
* <p>The authorization parameters for Basic authorization.</p>
|
|
1228
|
+
* @public
|
|
1229
1229
|
*/
|
|
1230
1230
|
BasicAuthParameters?: ConnectionBasicAuthResponseParameters;
|
|
1231
1231
|
/**
|
|
1232
|
-
* @public
|
|
1233
1232
|
* <p>The OAuth parameters to use for authorization.</p>
|
|
1233
|
+
* @public
|
|
1234
1234
|
*/
|
|
1235
1235
|
OAuthParameters?: ConnectionOAuthResponseParameters;
|
|
1236
1236
|
/**
|
|
1237
|
-
* @public
|
|
1238
1237
|
* <p>The API Key parameters to use for authorization.</p>
|
|
1238
|
+
* @public
|
|
1239
1239
|
*/
|
|
1240
1240
|
ApiKeyAuthParameters?: ConnectionApiKeyAuthResponseParameters;
|
|
1241
1241
|
/**
|
|
1242
|
-
* @public
|
|
1243
1242
|
* <p>Additional parameters for the connection that are passed through with every invocation to
|
|
1244
1243
|
* the HTTP endpoint.</p>
|
|
1244
|
+
* @public
|
|
1245
1245
|
*/
|
|
1246
1246
|
InvocationHttpParameters?: ConnectionHttpParameters;
|
|
1247
1247
|
}
|
|
@@ -1250,59 +1250,59 @@ export interface ConnectionAuthResponseParameters {
|
|
|
1250
1250
|
*/
|
|
1251
1251
|
export interface DescribeConnectionResponse {
|
|
1252
1252
|
/**
|
|
1253
|
-
* @public
|
|
1254
1253
|
* <p>The ARN of the connection retrieved.</p>
|
|
1254
|
+
* @public
|
|
1255
1255
|
*/
|
|
1256
1256
|
ConnectionArn?: string;
|
|
1257
1257
|
/**
|
|
1258
|
-
* @public
|
|
1259
1258
|
* <p>The name of the connection retrieved.</p>
|
|
1259
|
+
* @public
|
|
1260
1260
|
*/
|
|
1261
1261
|
Name?: string;
|
|
1262
1262
|
/**
|
|
1263
|
-
* @public
|
|
1264
1263
|
* <p>The description for the connection retrieved.</p>
|
|
1264
|
+
* @public
|
|
1265
1265
|
*/
|
|
1266
1266
|
Description?: string;
|
|
1267
1267
|
/**
|
|
1268
|
-
* @public
|
|
1269
1268
|
* <p>The state of the connection retrieved.</p>
|
|
1269
|
+
* @public
|
|
1270
1270
|
*/
|
|
1271
1271
|
ConnectionState?: ConnectionState;
|
|
1272
1272
|
/**
|
|
1273
|
-
* @public
|
|
1274
1273
|
* <p>The reason that the connection is in the current connection state.</p>
|
|
1274
|
+
* @public
|
|
1275
1275
|
*/
|
|
1276
1276
|
StateReason?: string;
|
|
1277
1277
|
/**
|
|
1278
|
-
* @public
|
|
1279
1278
|
* <p>The type of authorization specified for the connection.</p>
|
|
1279
|
+
* @public
|
|
1280
1280
|
*/
|
|
1281
1281
|
AuthorizationType?: ConnectionAuthorizationType;
|
|
1282
1282
|
/**
|
|
1283
|
-
* @public
|
|
1284
1283
|
* <p>The ARN of the secret created from the authorization parameters specified for the
|
|
1285
1284
|
* connection.</p>
|
|
1285
|
+
* @public
|
|
1286
1286
|
*/
|
|
1287
1287
|
SecretArn?: string;
|
|
1288
1288
|
/**
|
|
1289
|
-
* @public
|
|
1290
1289
|
* <p>The parameters to use for authorization for the connection.</p>
|
|
1290
|
+
* @public
|
|
1291
1291
|
*/
|
|
1292
1292
|
AuthParameters?: ConnectionAuthResponseParameters;
|
|
1293
1293
|
/**
|
|
1294
|
-
* @public
|
|
1295
1294
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
1295
|
+
* @public
|
|
1296
1296
|
*/
|
|
1297
1297
|
CreationTime?: Date;
|
|
1298
1298
|
/**
|
|
1299
|
-
* @public
|
|
1300
1299
|
* <p>A time stamp for the time that the connection was last modified.</p>
|
|
1300
|
+
* @public
|
|
1301
1301
|
*/
|
|
1302
1302
|
LastModifiedTime?: Date;
|
|
1303
1303
|
/**
|
|
1304
|
-
* @public
|
|
1305
1304
|
* <p>A time stamp for the time that the connection was last authorized.</p>
|
|
1305
|
+
* @public
|
|
1306
1306
|
*/
|
|
1307
1307
|
LastAuthorizedTime?: Date;
|
|
1308
1308
|
}
|
|
@@ -1311,9 +1311,9 @@ export interface DescribeConnectionResponse {
|
|
|
1311
1311
|
*/
|
|
1312
1312
|
export interface DescribeEventBusRequest {
|
|
1313
1313
|
/**
|
|
1314
|
-
* @public
|
|
1315
1314
|
* <p>The name or ARN of the event bus to show details for. If you omit this, the default event
|
|
1316
1315
|
* bus is displayed.</p>
|
|
1316
|
+
* @public
|
|
1317
1317
|
*/
|
|
1318
1318
|
Name?: string;
|
|
1319
1319
|
}
|
|
@@ -1322,19 +1322,19 @@ export interface DescribeEventBusRequest {
|
|
|
1322
1322
|
*/
|
|
1323
1323
|
export interface DescribeEventBusResponse {
|
|
1324
1324
|
/**
|
|
1325
|
-
* @public
|
|
1326
1325
|
* <p>The name of the event bus. Currently, this is always <code>default</code>.</p>
|
|
1326
|
+
* @public
|
|
1327
1327
|
*/
|
|
1328
1328
|
Name?: string;
|
|
1329
1329
|
/**
|
|
1330
|
-
* @public
|
|
1331
1330
|
* <p>The Amazon Resource Name (ARN) of the account permitted to write events to the current
|
|
1332
1331
|
* account.</p>
|
|
1332
|
+
* @public
|
|
1333
1333
|
*/
|
|
1334
1334
|
Arn?: string;
|
|
1335
1335
|
/**
|
|
1336
|
-
* @public
|
|
1337
1336
|
* <p>The policy that enables the external account to send events to your account.</p>
|
|
1337
|
+
* @public
|
|
1338
1338
|
*/
|
|
1339
1339
|
Policy?: string;
|
|
1340
1340
|
}
|
|
@@ -1343,8 +1343,8 @@ export interface DescribeEventBusResponse {
|
|
|
1343
1343
|
*/
|
|
1344
1344
|
export interface DescribeEventSourceRequest {
|
|
1345
1345
|
/**
|
|
1346
|
-
* @public
|
|
1347
1346
|
* <p>The name of the partner event source to display the details of.</p>
|
|
1347
|
+
* @public
|
|
1348
1348
|
*/
|
|
1349
1349
|
Name: string | undefined;
|
|
1350
1350
|
}
|
|
@@ -1366,37 +1366,37 @@ export type EventSourceState = (typeof EventSourceState)[keyof typeof EventSourc
|
|
|
1366
1366
|
*/
|
|
1367
1367
|
export interface DescribeEventSourceResponse {
|
|
1368
1368
|
/**
|
|
1369
|
-
* @public
|
|
1370
1369
|
* <p>The ARN of the partner event source.</p>
|
|
1370
|
+
* @public
|
|
1371
1371
|
*/
|
|
1372
1372
|
Arn?: string;
|
|
1373
1373
|
/**
|
|
1374
|
-
* @public
|
|
1375
1374
|
* <p>The name of the SaaS partner that created the event source.</p>
|
|
1375
|
+
* @public
|
|
1376
1376
|
*/
|
|
1377
1377
|
CreatedBy?: string;
|
|
1378
1378
|
/**
|
|
1379
|
-
* @public
|
|
1380
1379
|
* <p>The date and time that the event source was created.</p>
|
|
1380
|
+
* @public
|
|
1381
1381
|
*/
|
|
1382
1382
|
CreationTime?: Date;
|
|
1383
1383
|
/**
|
|
1384
|
-
* @public
|
|
1385
1384
|
* <p>The date and time that the event source will expire if you do not create a matching event
|
|
1386
1385
|
* bus.</p>
|
|
1386
|
+
* @public
|
|
1387
1387
|
*/
|
|
1388
1388
|
ExpirationTime?: Date;
|
|
1389
1389
|
/**
|
|
1390
|
-
* @public
|
|
1391
1390
|
* <p>The name of the partner event source.</p>
|
|
1391
|
+
* @public
|
|
1392
1392
|
*/
|
|
1393
1393
|
Name?: string;
|
|
1394
1394
|
/**
|
|
1395
|
-
* @public
|
|
1396
1395
|
* <p>The state of the event source. If it is ACTIVE, you have already created a matching event
|
|
1397
1396
|
* bus for this event source, and that event bus is active. If it is PENDING, either you haven't
|
|
1398
1397
|
* yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have
|
|
1399
1398
|
* created a matching event bus, but the event source has since been deleted.</p>
|
|
1399
|
+
* @public
|
|
1400
1400
|
*/
|
|
1401
1401
|
State?: EventSourceState;
|
|
1402
1402
|
}
|
|
@@ -1405,8 +1405,8 @@ export interface DescribeEventSourceResponse {
|
|
|
1405
1405
|
*/
|
|
1406
1406
|
export interface DescribePartnerEventSourceRequest {
|
|
1407
1407
|
/**
|
|
1408
|
-
* @public
|
|
1409
1408
|
* <p>The name of the event source to display.</p>
|
|
1409
|
+
* @public
|
|
1410
1410
|
*/
|
|
1411
1411
|
Name: string | undefined;
|
|
1412
1412
|
}
|
|
@@ -1415,13 +1415,13 @@ export interface DescribePartnerEventSourceRequest {
|
|
|
1415
1415
|
*/
|
|
1416
1416
|
export interface DescribePartnerEventSourceResponse {
|
|
1417
1417
|
/**
|
|
1418
|
-
* @public
|
|
1419
1418
|
* <p>The ARN of the event source.</p>
|
|
1419
|
+
* @public
|
|
1420
1420
|
*/
|
|
1421
1421
|
Arn?: string;
|
|
1422
1422
|
/**
|
|
1423
|
-
* @public
|
|
1424
1423
|
* <p>The name of the event source.</p>
|
|
1424
|
+
* @public
|
|
1425
1425
|
*/
|
|
1426
1426
|
Name?: string;
|
|
1427
1427
|
}
|
|
@@ -1430,25 +1430,25 @@ export interface DescribePartnerEventSourceResponse {
|
|
|
1430
1430
|
*/
|
|
1431
1431
|
export interface DescribeReplayRequest {
|
|
1432
1432
|
/**
|
|
1433
|
-
* @public
|
|
1434
1433
|
* <p>The name of the replay to retrieve.</p>
|
|
1434
|
+
* @public
|
|
1435
1435
|
*/
|
|
1436
1436
|
ReplayName: string | undefined;
|
|
1437
1437
|
}
|
|
1438
1438
|
/**
|
|
1439
|
-
* @public
|
|
1440
1439
|
* <p>A <code>ReplayDestination</code> object that contains details about a replay.</p>
|
|
1440
|
+
* @public
|
|
1441
1441
|
*/
|
|
1442
1442
|
export interface ReplayDestination {
|
|
1443
1443
|
/**
|
|
1444
|
-
* @public
|
|
1445
1444
|
* <p>The ARN of the event bus to replay event to. You can replay events only to the event bus
|
|
1446
1445
|
* specified to create the archive.</p>
|
|
1446
|
+
* @public
|
|
1447
1447
|
*/
|
|
1448
1448
|
Arn: string | undefined;
|
|
1449
1449
|
/**
|
|
1450
|
-
* @public
|
|
1451
1450
|
* <p>A list of ARNs for rules to replay events to.</p>
|
|
1451
|
+
* @public
|
|
1452
1452
|
*/
|
|
1453
1453
|
FilterArns?: string[];
|
|
1454
1454
|
}
|
|
@@ -1457,63 +1457,63 @@ export interface ReplayDestination {
|
|
|
1457
1457
|
*/
|
|
1458
1458
|
export interface DescribeReplayResponse {
|
|
1459
1459
|
/**
|
|
1460
|
-
* @public
|
|
1461
1460
|
* <p>The name of the replay.</p>
|
|
1461
|
+
* @public
|
|
1462
1462
|
*/
|
|
1463
1463
|
ReplayName?: string;
|
|
1464
1464
|
/**
|
|
1465
|
-
* @public
|
|
1466
1465
|
* <p>The ARN of the replay.</p>
|
|
1466
|
+
* @public
|
|
1467
1467
|
*/
|
|
1468
1468
|
ReplayArn?: string;
|
|
1469
1469
|
/**
|
|
1470
|
-
* @public
|
|
1471
1470
|
* <p>The description of the replay.</p>
|
|
1471
|
+
* @public
|
|
1472
1472
|
*/
|
|
1473
1473
|
Description?: string;
|
|
1474
1474
|
/**
|
|
1475
|
-
* @public
|
|
1476
1475
|
* <p>The current state of the replay.</p>
|
|
1476
|
+
* @public
|
|
1477
1477
|
*/
|
|
1478
1478
|
State?: ReplayState;
|
|
1479
1479
|
/**
|
|
1480
|
-
* @public
|
|
1481
1480
|
* <p>The reason that the replay is in the current state.</p>
|
|
1481
|
+
* @public
|
|
1482
1482
|
*/
|
|
1483
1483
|
StateReason?: string;
|
|
1484
1484
|
/**
|
|
1485
|
-
* @public
|
|
1486
1485
|
* <p>The ARN of the archive events were replayed from.</p>
|
|
1486
|
+
* @public
|
|
1487
1487
|
*/
|
|
1488
1488
|
EventSourceArn?: string;
|
|
1489
1489
|
/**
|
|
1490
|
-
* @public
|
|
1491
1490
|
* <p>A <code>ReplayDestination</code> object that contains details about the replay.</p>
|
|
1491
|
+
* @public
|
|
1492
1492
|
*/
|
|
1493
1493
|
Destination?: ReplayDestination;
|
|
1494
1494
|
/**
|
|
1495
|
-
* @public
|
|
1496
1495
|
* <p>The time stamp of the first event that was last replayed from the archive.</p>
|
|
1496
|
+
* @public
|
|
1497
1497
|
*/
|
|
1498
1498
|
EventStartTime?: Date;
|
|
1499
1499
|
/**
|
|
1500
|
-
* @public
|
|
1501
1500
|
* <p>The time stamp for the last event that was replayed from the archive.</p>
|
|
1501
|
+
* @public
|
|
1502
1502
|
*/
|
|
1503
1503
|
EventEndTime?: Date;
|
|
1504
1504
|
/**
|
|
1505
|
-
* @public
|
|
1506
1505
|
* <p>The time that the event was last replayed.</p>
|
|
1506
|
+
* @public
|
|
1507
1507
|
*/
|
|
1508
1508
|
EventLastReplayedTime?: Date;
|
|
1509
1509
|
/**
|
|
1510
|
-
* @public
|
|
1511
1510
|
* <p>A time stamp for the time that the replay started.</p>
|
|
1511
|
+
* @public
|
|
1512
1512
|
*/
|
|
1513
1513
|
ReplayStartTime?: Date;
|
|
1514
1514
|
/**
|
|
1515
|
-
* @public
|
|
1516
1515
|
* <p>A time stamp for the time that the replay stopped.</p>
|
|
1516
|
+
* @public
|
|
1517
1517
|
*/
|
|
1518
1518
|
ReplayEndTime?: Date;
|
|
1519
1519
|
}
|
|
@@ -1522,14 +1522,14 @@ export interface DescribeReplayResponse {
|
|
|
1522
1522
|
*/
|
|
1523
1523
|
export interface DescribeRuleRequest {
|
|
1524
1524
|
/**
|
|
1525
|
-
* @public
|
|
1526
1525
|
* <p>The name of the rule.</p>
|
|
1526
|
+
* @public
|
|
1527
1527
|
*/
|
|
1528
1528
|
Name: string | undefined;
|
|
1529
1529
|
/**
|
|
1530
|
-
* @public
|
|
1531
1530
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
1532
1531
|
* event bus is used.</p>
|
|
1532
|
+
* @public
|
|
1533
1533
|
*/
|
|
1534
1534
|
EventBusName?: string;
|
|
1535
1535
|
}
|
|
@@ -1550,59 +1550,59 @@ export type RuleState = (typeof RuleState)[keyof typeof RuleState];
|
|
|
1550
1550
|
*/
|
|
1551
1551
|
export interface DescribeRuleResponse {
|
|
1552
1552
|
/**
|
|
1553
|
-
* @public
|
|
1554
1553
|
* <p>The name of the rule.</p>
|
|
1554
|
+
* @public
|
|
1555
1555
|
*/
|
|
1556
1556
|
Name?: string;
|
|
1557
1557
|
/**
|
|
1558
|
-
* @public
|
|
1559
1558
|
* <p>The Amazon Resource Name (ARN) of the rule.</p>
|
|
1559
|
+
* @public
|
|
1560
1560
|
*/
|
|
1561
1561
|
Arn?: string;
|
|
1562
1562
|
/**
|
|
1563
|
-
* @public
|
|
1564
1563
|
* <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
1565
1564
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1565
|
+
* @public
|
|
1566
1566
|
*/
|
|
1567
1567
|
EventPattern?: string;
|
|
1568
1568
|
/**
|
|
1569
|
-
* @public
|
|
1570
1569
|
* <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".</p>
|
|
1570
|
+
* @public
|
|
1571
1571
|
*/
|
|
1572
1572
|
ScheduleExpression?: string;
|
|
1573
1573
|
/**
|
|
1574
|
-
* @public
|
|
1575
1574
|
* <p>Specifies whether the rule is enabled or disabled.</p>
|
|
1575
|
+
* @public
|
|
1576
1576
|
*/
|
|
1577
1577
|
State?: RuleState;
|
|
1578
1578
|
/**
|
|
1579
|
-
* @public
|
|
1580
1579
|
* <p>The description of the rule.</p>
|
|
1580
|
+
* @public
|
|
1581
1581
|
*/
|
|
1582
1582
|
Description?: string;
|
|
1583
1583
|
/**
|
|
1584
|
-
* @public
|
|
1585
1584
|
* <p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
|
|
1585
|
+
* @public
|
|
1586
1586
|
*/
|
|
1587
1587
|
RoleArn?: string;
|
|
1588
1588
|
/**
|
|
1589
|
-
* @public
|
|
1590
1589
|
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays
|
|
1591
1590
|
* the principal name of the Amazon Web Services service that created the rule.</p>
|
|
1591
|
+
* @public
|
|
1592
1592
|
*/
|
|
1593
1593
|
ManagedBy?: string;
|
|
1594
1594
|
/**
|
|
1595
|
-
* @public
|
|
1596
1595
|
* <p>The name of the event bus associated with the rule.</p>
|
|
1596
|
+
* @public
|
|
1597
1597
|
*/
|
|
1598
1598
|
EventBusName?: string;
|
|
1599
1599
|
/**
|
|
1600
|
-
* @public
|
|
1601
1600
|
* <p>The account ID of the user that created the rule. If you use <code>PutRule</code> to put a
|
|
1602
1601
|
* rule on an event bus in another account, the other account is the owner of the rule, and the
|
|
1603
1602
|
* rule ARN includes the account ID for that account. However, the value for
|
|
1604
1603
|
* <code>CreatedBy</code> is the account ID as the account that created the rule in the other
|
|
1605
1604
|
* account.</p>
|
|
1605
|
+
* @public
|
|
1606
1606
|
*/
|
|
1607
1607
|
CreatedBy?: string;
|
|
1608
1608
|
}
|
|
@@ -1611,14 +1611,14 @@ export interface DescribeRuleResponse {
|
|
|
1611
1611
|
*/
|
|
1612
1612
|
export interface DisableRuleRequest {
|
|
1613
1613
|
/**
|
|
1614
|
-
* @public
|
|
1615
1614
|
* <p>The name of the rule.</p>
|
|
1615
|
+
* @public
|
|
1616
1616
|
*/
|
|
1617
1617
|
Name: string | undefined;
|
|
1618
1618
|
/**
|
|
1619
|
-
* @public
|
|
1620
1619
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
1621
1620
|
* event bus is used.</p>
|
|
1621
|
+
* @public
|
|
1622
1622
|
*/
|
|
1623
1623
|
EventBusName?: string;
|
|
1624
1624
|
}
|
|
@@ -1627,14 +1627,14 @@ export interface DisableRuleRequest {
|
|
|
1627
1627
|
*/
|
|
1628
1628
|
export interface EnableRuleRequest {
|
|
1629
1629
|
/**
|
|
1630
|
-
* @public
|
|
1631
1630
|
* <p>The name of the rule.</p>
|
|
1631
|
+
* @public
|
|
1632
1632
|
*/
|
|
1633
1633
|
Name: string | undefined;
|
|
1634
1634
|
/**
|
|
1635
|
-
* @public
|
|
1636
1635
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
1637
1636
|
* event bus is used.</p>
|
|
1637
|
+
* @public
|
|
1638
1638
|
*/
|
|
1639
1639
|
EventBusName?: string;
|
|
1640
1640
|
}
|
|
@@ -1643,24 +1643,24 @@ export interface EnableRuleRequest {
|
|
|
1643
1643
|
*/
|
|
1644
1644
|
export interface ListApiDestinationsRequest {
|
|
1645
1645
|
/**
|
|
1646
|
-
* @public
|
|
1647
1646
|
* <p>A name prefix to filter results returned. Only API destinations with a name that starts
|
|
1648
1647
|
* with the prefix are returned.</p>
|
|
1648
|
+
* @public
|
|
1649
1649
|
*/
|
|
1650
1650
|
NamePrefix?: string;
|
|
1651
1651
|
/**
|
|
1652
|
-
* @public
|
|
1653
1652
|
* <p>The ARN of the connection specified for the API destination.</p>
|
|
1653
|
+
* @public
|
|
1654
1654
|
*/
|
|
1655
1655
|
ConnectionArn?: string;
|
|
1656
1656
|
/**
|
|
1657
|
-
* @public
|
|
1658
1657
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1658
|
+
* @public
|
|
1659
1659
|
*/
|
|
1660
1660
|
NextToken?: string;
|
|
1661
1661
|
/**
|
|
1662
|
-
* @public
|
|
1663
1662
|
* <p>The maximum number of API destinations to include in the response.</p>
|
|
1663
|
+
* @public
|
|
1664
1664
|
*/
|
|
1665
1665
|
Limit?: number;
|
|
1666
1666
|
}
|
|
@@ -1669,14 +1669,14 @@ export interface ListApiDestinationsRequest {
|
|
|
1669
1669
|
*/
|
|
1670
1670
|
export interface ListApiDestinationsResponse {
|
|
1671
1671
|
/**
|
|
1672
|
-
* @public
|
|
1673
1672
|
* <p>An array of <code>ApiDestination</code> objects that include information about an API
|
|
1674
1673
|
* destination.</p>
|
|
1674
|
+
* @public
|
|
1675
1675
|
*/
|
|
1676
1676
|
ApiDestinations?: ApiDestination[];
|
|
1677
1677
|
/**
|
|
1678
|
-
* @public
|
|
1679
1678
|
* <p>A token you can use in a subsequent request to retrieve the next set of results.</p>
|
|
1679
|
+
* @public
|
|
1680
1680
|
*/
|
|
1681
1681
|
NextToken?: string;
|
|
1682
1682
|
}
|
|
@@ -1685,29 +1685,29 @@ export interface ListApiDestinationsResponse {
|
|
|
1685
1685
|
*/
|
|
1686
1686
|
export interface ListArchivesRequest {
|
|
1687
1687
|
/**
|
|
1688
|
-
* @public
|
|
1689
1688
|
* <p>A name prefix to filter the archives returned. Only archives with name that match the
|
|
1690
1689
|
* prefix are returned.</p>
|
|
1690
|
+
* @public
|
|
1691
1691
|
*/
|
|
1692
1692
|
NamePrefix?: string;
|
|
1693
1693
|
/**
|
|
1694
|
-
* @public
|
|
1695
1694
|
* <p>The ARN of the event source associated with the archive.</p>
|
|
1695
|
+
* @public
|
|
1696
1696
|
*/
|
|
1697
1697
|
EventSourceArn?: string;
|
|
1698
1698
|
/**
|
|
1699
|
-
* @public
|
|
1700
1699
|
* <p>The state of the archive.</p>
|
|
1700
|
+
* @public
|
|
1701
1701
|
*/
|
|
1702
1702
|
State?: ArchiveState;
|
|
1703
1703
|
/**
|
|
1704
|
-
* @public
|
|
1705
1704
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1705
|
+
* @public
|
|
1706
1706
|
*/
|
|
1707
1707
|
NextToken?: string;
|
|
1708
1708
|
/**
|
|
1709
|
-
* @public
|
|
1710
1709
|
* <p>The maximum number of results to return.</p>
|
|
1710
|
+
* @public
|
|
1711
1711
|
*/
|
|
1712
1712
|
Limit?: number;
|
|
1713
1713
|
}
|
|
@@ -1716,13 +1716,13 @@ export interface ListArchivesRequest {
|
|
|
1716
1716
|
*/
|
|
1717
1717
|
export interface ListArchivesResponse {
|
|
1718
1718
|
/**
|
|
1719
|
-
* @public
|
|
1720
1719
|
* <p>An array of <code>Archive</code> objects that include details about an archive.</p>
|
|
1720
|
+
* @public
|
|
1721
1721
|
*/
|
|
1722
1722
|
Archives?: Archive[];
|
|
1723
1723
|
/**
|
|
1724
|
-
* @public
|
|
1725
1724
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1725
|
+
* @public
|
|
1726
1726
|
*/
|
|
1727
1727
|
NextToken?: string;
|
|
1728
1728
|
}
|
|
@@ -1731,70 +1731,70 @@ export interface ListArchivesResponse {
|
|
|
1731
1731
|
*/
|
|
1732
1732
|
export interface ListConnectionsRequest {
|
|
1733
1733
|
/**
|
|
1734
|
-
* @public
|
|
1735
1734
|
* <p>A name prefix to filter results returned. Only connections with a name that starts with
|
|
1736
1735
|
* the prefix are returned.</p>
|
|
1736
|
+
* @public
|
|
1737
1737
|
*/
|
|
1738
1738
|
NamePrefix?: string;
|
|
1739
1739
|
/**
|
|
1740
|
-
* @public
|
|
1741
1740
|
* <p>The state of the connection.</p>
|
|
1741
|
+
* @public
|
|
1742
1742
|
*/
|
|
1743
1743
|
ConnectionState?: ConnectionState;
|
|
1744
1744
|
/**
|
|
1745
|
-
* @public
|
|
1746
1745
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1746
|
+
* @public
|
|
1747
1747
|
*/
|
|
1748
1748
|
NextToken?: string;
|
|
1749
1749
|
/**
|
|
1750
|
-
* @public
|
|
1751
1750
|
* <p>The maximum number of connections to return.</p>
|
|
1751
|
+
* @public
|
|
1752
1752
|
*/
|
|
1753
1753
|
Limit?: number;
|
|
1754
1754
|
}
|
|
1755
1755
|
/**
|
|
1756
|
-
* @public
|
|
1757
1756
|
* <p>Contains information about a connection.</p>
|
|
1757
|
+
* @public
|
|
1758
1758
|
*/
|
|
1759
1759
|
export interface Connection {
|
|
1760
1760
|
/**
|
|
1761
|
-
* @public
|
|
1762
1761
|
* <p>The ARN of the connection.</p>
|
|
1762
|
+
* @public
|
|
1763
1763
|
*/
|
|
1764
1764
|
ConnectionArn?: string;
|
|
1765
1765
|
/**
|
|
1766
|
-
* @public
|
|
1767
1766
|
* <p>The name of the connection.</p>
|
|
1767
|
+
* @public
|
|
1768
1768
|
*/
|
|
1769
1769
|
Name?: string;
|
|
1770
1770
|
/**
|
|
1771
|
-
* @public
|
|
1772
1771
|
* <p>The state of the connection.</p>
|
|
1772
|
+
* @public
|
|
1773
1773
|
*/
|
|
1774
1774
|
ConnectionState?: ConnectionState;
|
|
1775
1775
|
/**
|
|
1776
|
-
* @public
|
|
1777
1776
|
* <p>The reason that the connection is in the connection state.</p>
|
|
1777
|
+
* @public
|
|
1778
1778
|
*/
|
|
1779
1779
|
StateReason?: string;
|
|
1780
1780
|
/**
|
|
1781
|
-
* @public
|
|
1782
1781
|
* <p>The authorization type specified for the connection.</p>
|
|
1782
|
+
* @public
|
|
1783
1783
|
*/
|
|
1784
1784
|
AuthorizationType?: ConnectionAuthorizationType;
|
|
1785
1785
|
/**
|
|
1786
|
-
* @public
|
|
1787
1786
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
1787
|
+
* @public
|
|
1788
1788
|
*/
|
|
1789
1789
|
CreationTime?: Date;
|
|
1790
1790
|
/**
|
|
1791
|
-
* @public
|
|
1792
1791
|
* <p>A time stamp for the time that the connection was last modified.</p>
|
|
1792
|
+
* @public
|
|
1793
1793
|
*/
|
|
1794
1794
|
LastModifiedTime?: Date;
|
|
1795
1795
|
/**
|
|
1796
|
-
* @public
|
|
1797
1796
|
* <p>A time stamp for the time that the connection was last authorized.</p>
|
|
1797
|
+
* @public
|
|
1798
1798
|
*/
|
|
1799
1799
|
LastAuthorizedTime?: Date;
|
|
1800
1800
|
}
|
|
@@ -1803,13 +1803,13 @@ export interface Connection {
|
|
|
1803
1803
|
*/
|
|
1804
1804
|
export interface ListConnectionsResponse {
|
|
1805
1805
|
/**
|
|
1806
|
-
* @public
|
|
1807
1806
|
* <p>An array of connections objects that include details about the connections.</p>
|
|
1807
|
+
* @public
|
|
1808
1808
|
*/
|
|
1809
1809
|
Connections?: Connection[];
|
|
1810
1810
|
/**
|
|
1811
|
-
* @public
|
|
1812
1811
|
* <p>A token you can use in a subsequent request to retrieve the next set of results.</p>
|
|
1812
|
+
* @public
|
|
1813
1813
|
*/
|
|
1814
1814
|
NextToken?: string;
|
|
1815
1815
|
}
|
|
@@ -1818,47 +1818,47 @@ export interface ListConnectionsResponse {
|
|
|
1818
1818
|
*/
|
|
1819
1819
|
export interface ListEventBusesRequest {
|
|
1820
1820
|
/**
|
|
1821
|
-
* @public
|
|
1822
1821
|
* <p>Specifying this limits the results to only those event buses with names that start with
|
|
1823
1822
|
* the specified prefix.</p>
|
|
1823
|
+
* @public
|
|
1824
1824
|
*/
|
|
1825
1825
|
NamePrefix?: string;
|
|
1826
1826
|
/**
|
|
1827
|
-
* @public
|
|
1828
1827
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1828
|
+
* @public
|
|
1829
1829
|
*/
|
|
1830
1830
|
NextToken?: string;
|
|
1831
1831
|
/**
|
|
1832
|
-
* @public
|
|
1833
1832
|
* <p>Specifying this limits the number of results returned by this operation. The operation
|
|
1834
1833
|
* also returns a NextToken which you can use in a subsequent operation to retrieve the next set
|
|
1835
1834
|
* of results.</p>
|
|
1835
|
+
* @public
|
|
1836
1836
|
*/
|
|
1837
1837
|
Limit?: number;
|
|
1838
1838
|
}
|
|
1839
1839
|
/**
|
|
1840
|
-
* @public
|
|
1841
1840
|
* <p>An event bus receives events from a source and routes them to rules associated with that
|
|
1842
1841
|
* event bus. Your account's default event bus receives events from Amazon Web Services services. A custom event
|
|
1843
1842
|
* bus can receive events from your custom applications and services. A partner event bus
|
|
1844
1843
|
* receives events from an event source created by an SaaS partner. These events come from the
|
|
1845
1844
|
* partners services or applications.</p>
|
|
1845
|
+
* @public
|
|
1846
1846
|
*/
|
|
1847
1847
|
export interface EventBus {
|
|
1848
1848
|
/**
|
|
1849
|
-
* @public
|
|
1850
1849
|
* <p>The name of the event bus.</p>
|
|
1850
|
+
* @public
|
|
1851
1851
|
*/
|
|
1852
1852
|
Name?: string;
|
|
1853
1853
|
/**
|
|
1854
|
-
* @public
|
|
1855
1854
|
* <p>The ARN of the event bus.</p>
|
|
1855
|
+
* @public
|
|
1856
1856
|
*/
|
|
1857
1857
|
Arn?: string;
|
|
1858
1858
|
/**
|
|
1859
|
-
* @public
|
|
1860
1859
|
* <p>The permissions policy of the event bus, describing which other Amazon Web Services accounts can write
|
|
1861
1860
|
* events to this event bus.</p>
|
|
1861
|
+
* @public
|
|
1862
1862
|
*/
|
|
1863
1863
|
Policy?: string;
|
|
1864
1864
|
}
|
|
@@ -1867,13 +1867,13 @@ export interface EventBus {
|
|
|
1867
1867
|
*/
|
|
1868
1868
|
export interface ListEventBusesResponse {
|
|
1869
1869
|
/**
|
|
1870
|
-
* @public
|
|
1871
1870
|
* <p>This list of event buses.</p>
|
|
1871
|
+
* @public
|
|
1872
1872
|
*/
|
|
1873
1873
|
EventBuses?: EventBus[];
|
|
1874
1874
|
/**
|
|
1875
|
-
* @public
|
|
1876
1875
|
* <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
1876
|
+
* @public
|
|
1877
1877
|
*/
|
|
1878
1878
|
NextToken?: string;
|
|
1879
1879
|
}
|
|
@@ -1882,63 +1882,63 @@ export interface ListEventBusesResponse {
|
|
|
1882
1882
|
*/
|
|
1883
1883
|
export interface ListEventSourcesRequest {
|
|
1884
1884
|
/**
|
|
1885
|
-
* @public
|
|
1886
1885
|
* <p>Specifying this limits the results to only those partner event sources with names that
|
|
1887
1886
|
* start with the specified prefix.</p>
|
|
1887
|
+
* @public
|
|
1888
1888
|
*/
|
|
1889
1889
|
NamePrefix?: string;
|
|
1890
1890
|
/**
|
|
1891
|
-
* @public
|
|
1892
1891
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1892
|
+
* @public
|
|
1893
1893
|
*/
|
|
1894
1894
|
NextToken?: string;
|
|
1895
1895
|
/**
|
|
1896
|
-
* @public
|
|
1897
1896
|
* <p>Specifying this limits the number of results returned by this operation. The operation
|
|
1898
1897
|
* also returns a NextToken which you can use in a subsequent operation to retrieve the next set
|
|
1899
1898
|
* of results.</p>
|
|
1899
|
+
* @public
|
|
1900
1900
|
*/
|
|
1901
1901
|
Limit?: number;
|
|
1902
1902
|
}
|
|
1903
1903
|
/**
|
|
1904
|
-
* @public
|
|
1905
1904
|
* <p>A partner event source is created by an SaaS partner. If a customer creates a partner
|
|
1906
1905
|
* event bus that matches this event source, that Amazon Web Services account can receive events from the
|
|
1907
1906
|
* partner's applications or services.</p>
|
|
1907
|
+
* @public
|
|
1908
1908
|
*/
|
|
1909
1909
|
export interface EventSource {
|
|
1910
1910
|
/**
|
|
1911
|
-
* @public
|
|
1912
1911
|
* <p>The ARN of the event source.</p>
|
|
1912
|
+
* @public
|
|
1913
1913
|
*/
|
|
1914
1914
|
Arn?: string;
|
|
1915
1915
|
/**
|
|
1916
|
-
* @public
|
|
1917
1916
|
* <p>The name of the partner that created the event source.</p>
|
|
1917
|
+
* @public
|
|
1918
1918
|
*/
|
|
1919
1919
|
CreatedBy?: string;
|
|
1920
1920
|
/**
|
|
1921
|
-
* @public
|
|
1922
1921
|
* <p>The date and time the event source was created.</p>
|
|
1922
|
+
* @public
|
|
1923
1923
|
*/
|
|
1924
1924
|
CreationTime?: Date;
|
|
1925
1925
|
/**
|
|
1926
|
-
* @public
|
|
1927
1926
|
* <p>The date and time that the event source will expire, if the Amazon Web Services account doesn't create a
|
|
1928
1927
|
* matching event bus for it.</p>
|
|
1928
|
+
* @public
|
|
1929
1929
|
*/
|
|
1930
1930
|
ExpirationTime?: Date;
|
|
1931
1931
|
/**
|
|
1932
|
-
* @public
|
|
1933
1932
|
* <p>The name of the event source.</p>
|
|
1933
|
+
* @public
|
|
1934
1934
|
*/
|
|
1935
1935
|
Name?: string;
|
|
1936
1936
|
/**
|
|
1937
|
-
* @public
|
|
1938
1937
|
* <p>The state of the event source. If it is ACTIVE, you have already created a matching event
|
|
1939
1938
|
* bus for this event source, and that event bus is active. If it is PENDING, either you haven't
|
|
1940
1939
|
* yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have
|
|
1941
1940
|
* created a matching event bus, but the event source has since been deleted.</p>
|
|
1941
|
+
* @public
|
|
1942
1942
|
*/
|
|
1943
1943
|
State?: EventSourceState;
|
|
1944
1944
|
}
|
|
@@ -1947,13 +1947,13 @@ export interface EventSource {
|
|
|
1947
1947
|
*/
|
|
1948
1948
|
export interface ListEventSourcesResponse {
|
|
1949
1949
|
/**
|
|
1950
|
-
* @public
|
|
1951
1950
|
* <p>The list of event sources.</p>
|
|
1951
|
+
* @public
|
|
1952
1952
|
*/
|
|
1953
1953
|
EventSources?: EventSource[];
|
|
1954
1954
|
/**
|
|
1955
|
-
* @public
|
|
1956
1955
|
* <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
1956
|
+
* @public
|
|
1957
1957
|
*/
|
|
1958
1958
|
NextToken?: string;
|
|
1959
1959
|
}
|
|
@@ -1962,51 +1962,51 @@ export interface ListEventSourcesResponse {
|
|
|
1962
1962
|
*/
|
|
1963
1963
|
export interface ListPartnerEventSourceAccountsRequest {
|
|
1964
1964
|
/**
|
|
1965
|
-
* @public
|
|
1966
1965
|
* <p>The name of the partner event source to display account information about.</p>
|
|
1966
|
+
* @public
|
|
1967
1967
|
*/
|
|
1968
1968
|
EventSourceName: string | undefined;
|
|
1969
1969
|
/**
|
|
1970
|
-
* @public
|
|
1971
1970
|
* <p>The token returned by a previous call to this operation. Specifying this retrieves the
|
|
1972
1971
|
* next set of results.</p>
|
|
1972
|
+
* @public
|
|
1973
1973
|
*/
|
|
1974
1974
|
NextToken?: string;
|
|
1975
1975
|
/**
|
|
1976
|
-
* @public
|
|
1977
1976
|
* <p>Specifying this limits the number of results returned by this operation. The operation
|
|
1978
1977
|
* also returns a NextToken which you can use in a subsequent operation to retrieve the next set
|
|
1979
1978
|
* of results.</p>
|
|
1979
|
+
* @public
|
|
1980
1980
|
*/
|
|
1981
1981
|
Limit?: number;
|
|
1982
1982
|
}
|
|
1983
1983
|
/**
|
|
1984
|
-
* @public
|
|
1985
1984
|
* <p>The Amazon Web Services account that a partner event source has been offered to.</p>
|
|
1985
|
+
* @public
|
|
1986
1986
|
*/
|
|
1987
1987
|
export interface PartnerEventSourceAccount {
|
|
1988
1988
|
/**
|
|
1989
|
-
* @public
|
|
1990
1989
|
* <p>The Amazon Web Services account ID that the partner event source was offered to.</p>
|
|
1990
|
+
* @public
|
|
1991
1991
|
*/
|
|
1992
1992
|
Account?: string;
|
|
1993
1993
|
/**
|
|
1994
|
-
* @public
|
|
1995
1994
|
* <p>The date and time the event source was created.</p>
|
|
1995
|
+
* @public
|
|
1996
1996
|
*/
|
|
1997
1997
|
CreationTime?: Date;
|
|
1998
1998
|
/**
|
|
1999
|
-
* @public
|
|
2000
1999
|
* <p>The date and time that the event source will expire, if the Amazon Web Services account doesn't create a
|
|
2001
2000
|
* matching event bus for it.</p>
|
|
2001
|
+
* @public
|
|
2002
2002
|
*/
|
|
2003
2003
|
ExpirationTime?: Date;
|
|
2004
2004
|
/**
|
|
2005
|
-
* @public
|
|
2006
2005
|
* <p>The state of the event source. If it is ACTIVE, you have already created a matching event
|
|
2007
2006
|
* bus for this event source, and that event bus is active. If it is PENDING, either you haven't
|
|
2008
2007
|
* yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have
|
|
2009
2008
|
* created a matching event bus, but the event source has since been deleted.</p>
|
|
2009
|
+
* @public
|
|
2010
2010
|
*/
|
|
2011
2011
|
State?: EventSourceState;
|
|
2012
2012
|
}
|
|
@@ -2015,13 +2015,13 @@ export interface PartnerEventSourceAccount {
|
|
|
2015
2015
|
*/
|
|
2016
2016
|
export interface ListPartnerEventSourceAccountsResponse {
|
|
2017
2017
|
/**
|
|
2018
|
-
* @public
|
|
2019
2018
|
* <p>The list of partner event sources returned by the operation.</p>
|
|
2019
|
+
* @public
|
|
2020
2020
|
*/
|
|
2021
2021
|
PartnerEventSourceAccounts?: PartnerEventSourceAccount[];
|
|
2022
2022
|
/**
|
|
2023
|
-
* @public
|
|
2024
2023
|
* <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
2024
|
+
* @public
|
|
2025
2025
|
*/
|
|
2026
2026
|
NextToken?: string;
|
|
2027
2027
|
}
|
|
@@ -2030,40 +2030,40 @@ export interface ListPartnerEventSourceAccountsResponse {
|
|
|
2030
2030
|
*/
|
|
2031
2031
|
export interface ListPartnerEventSourcesRequest {
|
|
2032
2032
|
/**
|
|
2033
|
-
* @public
|
|
2034
2033
|
* <p>If you specify this, the results are limited to only those partner event sources that
|
|
2035
2034
|
* start with the string you specify.</p>
|
|
2035
|
+
* @public
|
|
2036
2036
|
*/
|
|
2037
2037
|
NamePrefix: string | undefined;
|
|
2038
2038
|
/**
|
|
2039
|
-
* @public
|
|
2040
2039
|
* <p>The token returned by a previous call to this operation. Specifying this retrieves the
|
|
2041
2040
|
* next set of results.</p>
|
|
2041
|
+
* @public
|
|
2042
2042
|
*/
|
|
2043
2043
|
NextToken?: string;
|
|
2044
2044
|
/**
|
|
2045
|
-
* @public
|
|
2046
2045
|
* <p>pecifying this limits the number of results returned by this operation. The operation also
|
|
2047
2046
|
* returns a NextToken which you can use in a subsequent operation to retrieve the next set of
|
|
2048
2047
|
* results.</p>
|
|
2048
|
+
* @public
|
|
2049
2049
|
*/
|
|
2050
2050
|
Limit?: number;
|
|
2051
2051
|
}
|
|
2052
2052
|
/**
|
|
2053
|
-
* @public
|
|
2054
2053
|
* <p>A partner event source is created by an SaaS partner. If a customer creates a partner
|
|
2055
2054
|
* event bus that matches this event source, that Amazon Web Services account can receive events from the
|
|
2056
2055
|
* partner's applications or services.</p>
|
|
2056
|
+
* @public
|
|
2057
2057
|
*/
|
|
2058
2058
|
export interface PartnerEventSource {
|
|
2059
2059
|
/**
|
|
2060
|
-
* @public
|
|
2061
2060
|
* <p>The ARN of the partner event source.</p>
|
|
2061
|
+
* @public
|
|
2062
2062
|
*/
|
|
2063
2063
|
Arn?: string;
|
|
2064
2064
|
/**
|
|
2065
|
-
* @public
|
|
2066
2065
|
* <p>The name of the partner event source.</p>
|
|
2066
|
+
* @public
|
|
2067
2067
|
*/
|
|
2068
2068
|
Name?: string;
|
|
2069
2069
|
}
|
|
@@ -2072,13 +2072,13 @@ export interface PartnerEventSource {
|
|
|
2072
2072
|
*/
|
|
2073
2073
|
export interface ListPartnerEventSourcesResponse {
|
|
2074
2074
|
/**
|
|
2075
|
-
* @public
|
|
2076
2075
|
* <p>The list of partner event sources returned by the operation.</p>
|
|
2076
|
+
* @public
|
|
2077
2077
|
*/
|
|
2078
2078
|
PartnerEventSources?: PartnerEventSource[];
|
|
2079
2079
|
/**
|
|
2080
|
-
* @public
|
|
2081
2080
|
* <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
2081
|
+
* @public
|
|
2082
2082
|
*/
|
|
2083
2083
|
NextToken?: string;
|
|
2084
2084
|
}
|
|
@@ -2087,82 +2087,82 @@ export interface ListPartnerEventSourcesResponse {
|
|
|
2087
2087
|
*/
|
|
2088
2088
|
export interface ListReplaysRequest {
|
|
2089
2089
|
/**
|
|
2090
|
-
* @public
|
|
2091
2090
|
* <p>A name prefix to filter the replays returned. Only replays with name that match the prefix
|
|
2092
2091
|
* are returned.</p>
|
|
2092
|
+
* @public
|
|
2093
2093
|
*/
|
|
2094
2094
|
NamePrefix?: string;
|
|
2095
2095
|
/**
|
|
2096
|
-
* @public
|
|
2097
2096
|
* <p>The state of the replay.</p>
|
|
2097
|
+
* @public
|
|
2098
2098
|
*/
|
|
2099
2099
|
State?: ReplayState;
|
|
2100
2100
|
/**
|
|
2101
|
-
* @public
|
|
2102
2101
|
* <p>The ARN of the archive from which the events are replayed.</p>
|
|
2102
|
+
* @public
|
|
2103
2103
|
*/
|
|
2104
2104
|
EventSourceArn?: string;
|
|
2105
2105
|
/**
|
|
2106
|
-
* @public
|
|
2107
2106
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2107
|
+
* @public
|
|
2108
2108
|
*/
|
|
2109
2109
|
NextToken?: string;
|
|
2110
2110
|
/**
|
|
2111
|
-
* @public
|
|
2112
2111
|
* <p>The maximum number of replays to retrieve.</p>
|
|
2112
|
+
* @public
|
|
2113
2113
|
*/
|
|
2114
2114
|
Limit?: number;
|
|
2115
2115
|
}
|
|
2116
2116
|
/**
|
|
2117
|
-
* @public
|
|
2118
2117
|
* <p>A <code>Replay</code> object that contains details about a replay.</p>
|
|
2118
|
+
* @public
|
|
2119
2119
|
*/
|
|
2120
2120
|
export interface Replay {
|
|
2121
2121
|
/**
|
|
2122
|
-
* @public
|
|
2123
2122
|
* <p>The name of the replay.</p>
|
|
2123
|
+
* @public
|
|
2124
2124
|
*/
|
|
2125
2125
|
ReplayName?: string;
|
|
2126
2126
|
/**
|
|
2127
|
-
* @public
|
|
2128
2127
|
* <p>The ARN of the archive to replay event from.</p>
|
|
2128
|
+
* @public
|
|
2129
2129
|
*/
|
|
2130
2130
|
EventSourceArn?: string;
|
|
2131
2131
|
/**
|
|
2132
|
-
* @public
|
|
2133
2132
|
* <p>The current state of the replay.</p>
|
|
2133
|
+
* @public
|
|
2134
2134
|
*/
|
|
2135
2135
|
State?: ReplayState;
|
|
2136
2136
|
/**
|
|
2137
|
-
* @public
|
|
2138
2137
|
* <p>A description of why the replay is in the current state.</p>
|
|
2138
|
+
* @public
|
|
2139
2139
|
*/
|
|
2140
2140
|
StateReason?: string;
|
|
2141
2141
|
/**
|
|
2142
|
-
* @public
|
|
2143
2142
|
* <p>A time stamp for the time to start replaying events. This is determined by the time in the
|
|
2144
2143
|
* event as described in <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time">Time</a>.</p>
|
|
2144
|
+
* @public
|
|
2145
2145
|
*/
|
|
2146
2146
|
EventStartTime?: Date;
|
|
2147
2147
|
/**
|
|
2148
|
-
* @public
|
|
2149
2148
|
* <p>A time stamp for the time to start replaying events. Any event with a creation time prior
|
|
2150
2149
|
* to the <code>EventEndTime</code> specified is replayed.</p>
|
|
2150
|
+
* @public
|
|
2151
2151
|
*/
|
|
2152
2152
|
EventEndTime?: Date;
|
|
2153
2153
|
/**
|
|
2154
|
-
* @public
|
|
2155
2154
|
* <p>A time stamp for the time that the last event was replayed.</p>
|
|
2155
|
+
* @public
|
|
2156
2156
|
*/
|
|
2157
2157
|
EventLastReplayedTime?: Date;
|
|
2158
2158
|
/**
|
|
2159
|
-
* @public
|
|
2160
2159
|
* <p>A time stamp for the time that the replay started.</p>
|
|
2160
|
+
* @public
|
|
2161
2161
|
*/
|
|
2162
2162
|
ReplayStartTime?: Date;
|
|
2163
2163
|
/**
|
|
2164
|
-
* @public
|
|
2165
2164
|
* <p>A time stamp for the time that the replay completed.</p>
|
|
2165
|
+
* @public
|
|
2166
2166
|
*/
|
|
2167
2167
|
ReplayEndTime?: Date;
|
|
2168
2168
|
}
|
|
@@ -2171,13 +2171,13 @@ export interface Replay {
|
|
|
2171
2171
|
*/
|
|
2172
2172
|
export interface ListReplaysResponse {
|
|
2173
2173
|
/**
|
|
2174
|
-
* @public
|
|
2175
2174
|
* <p>An array of <code>Replay</code> objects that contain information about the replay.</p>
|
|
2175
|
+
* @public
|
|
2176
2176
|
*/
|
|
2177
2177
|
Replays?: Replay[];
|
|
2178
2178
|
/**
|
|
2179
|
-
* @public
|
|
2180
2179
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2180
|
+
* @public
|
|
2181
2181
|
*/
|
|
2182
2182
|
NextToken?: string;
|
|
2183
2183
|
}
|
|
@@ -2186,24 +2186,24 @@ export interface ListReplaysResponse {
|
|
|
2186
2186
|
*/
|
|
2187
2187
|
export interface ListRuleNamesByTargetRequest {
|
|
2188
2188
|
/**
|
|
2189
|
-
* @public
|
|
2190
2189
|
* <p>The Amazon Resource Name (ARN) of the target resource.</p>
|
|
2190
|
+
* @public
|
|
2191
2191
|
*/
|
|
2192
2192
|
TargetArn: string | undefined;
|
|
2193
2193
|
/**
|
|
2194
|
-
* @public
|
|
2195
2194
|
* <p>The name or ARN of the event bus to list rules for. If you omit this, the default event
|
|
2196
2195
|
* bus is used.</p>
|
|
2196
|
+
* @public
|
|
2197
2197
|
*/
|
|
2198
2198
|
EventBusName?: string;
|
|
2199
2199
|
/**
|
|
2200
|
-
* @public
|
|
2201
2200
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2201
|
+
* @public
|
|
2202
2202
|
*/
|
|
2203
2203
|
NextToken?: string;
|
|
2204
2204
|
/**
|
|
2205
|
-
* @public
|
|
2206
2205
|
* <p>The maximum number of results to return.</p>
|
|
2206
|
+
* @public
|
|
2207
2207
|
*/
|
|
2208
2208
|
Limit?: number;
|
|
2209
2209
|
}
|
|
@@ -2212,14 +2212,14 @@ export interface ListRuleNamesByTargetRequest {
|
|
|
2212
2212
|
*/
|
|
2213
2213
|
export interface ListRuleNamesByTargetResponse {
|
|
2214
2214
|
/**
|
|
2215
|
-
* @public
|
|
2216
2215
|
* <p>The names of the rules that can invoke the given target.</p>
|
|
2216
|
+
* @public
|
|
2217
2217
|
*/
|
|
2218
2218
|
RuleNames?: string[];
|
|
2219
2219
|
/**
|
|
2220
|
-
* @public
|
|
2221
2220
|
* <p>Indicates whether there are additional results to retrieve. If there are no more results,
|
|
2222
2221
|
* the value is null.</p>
|
|
2222
|
+
* @public
|
|
2223
2223
|
*/
|
|
2224
2224
|
NextToken?: string;
|
|
2225
2225
|
}
|
|
@@ -2228,82 +2228,82 @@ export interface ListRuleNamesByTargetResponse {
|
|
|
2228
2228
|
*/
|
|
2229
2229
|
export interface ListRulesRequest {
|
|
2230
2230
|
/**
|
|
2231
|
-
* @public
|
|
2232
2231
|
* <p>The prefix matching the rule name.</p>
|
|
2232
|
+
* @public
|
|
2233
2233
|
*/
|
|
2234
2234
|
NamePrefix?: string;
|
|
2235
2235
|
/**
|
|
2236
|
-
* @public
|
|
2237
2236
|
* <p>The name or ARN of the event bus to list the rules for. If you omit this, the default
|
|
2238
2237
|
* event bus is used.</p>
|
|
2238
|
+
* @public
|
|
2239
2239
|
*/
|
|
2240
2240
|
EventBusName?: string;
|
|
2241
2241
|
/**
|
|
2242
|
-
* @public
|
|
2243
2242
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2243
|
+
* @public
|
|
2244
2244
|
*/
|
|
2245
2245
|
NextToken?: string;
|
|
2246
2246
|
/**
|
|
2247
|
-
* @public
|
|
2248
2247
|
* <p>The maximum number of results to return.</p>
|
|
2248
|
+
* @public
|
|
2249
2249
|
*/
|
|
2250
2250
|
Limit?: number;
|
|
2251
2251
|
}
|
|
2252
2252
|
/**
|
|
2253
|
-
* @public
|
|
2254
2253
|
* <p>Contains information about a rule in Amazon EventBridge.</p>
|
|
2254
|
+
* @public
|
|
2255
2255
|
*/
|
|
2256
2256
|
export interface Rule {
|
|
2257
2257
|
/**
|
|
2258
|
-
* @public
|
|
2259
2258
|
* <p>The name of the rule.</p>
|
|
2259
|
+
* @public
|
|
2260
2260
|
*/
|
|
2261
2261
|
Name?: string;
|
|
2262
2262
|
/**
|
|
2263
|
-
* @public
|
|
2264
2263
|
* <p>The Amazon Resource Name (ARN) of the rule.</p>
|
|
2264
|
+
* @public
|
|
2265
2265
|
*/
|
|
2266
2266
|
Arn?: string;
|
|
2267
2267
|
/**
|
|
2268
|
-
* @public
|
|
2269
2268
|
* <p>The event pattern of the rule. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
2270
2269
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
2270
|
+
* @public
|
|
2271
2271
|
*/
|
|
2272
2272
|
EventPattern?: string;
|
|
2273
2273
|
/**
|
|
2274
|
-
* @public
|
|
2275
2274
|
* <p>The state of the rule.</p>
|
|
2275
|
+
* @public
|
|
2276
2276
|
*/
|
|
2277
2277
|
State?: RuleState;
|
|
2278
2278
|
/**
|
|
2279
|
-
* @public
|
|
2280
2279
|
* <p>The description of the rule.</p>
|
|
2280
|
+
* @public
|
|
2281
2281
|
*/
|
|
2282
2282
|
Description?: string;
|
|
2283
2283
|
/**
|
|
2284
|
-
* @public
|
|
2285
2284
|
* <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html">Creating an Amazon EventBridge rule that runs on a schedule</a>.</p>
|
|
2285
|
+
* @public
|
|
2286
2286
|
*/
|
|
2287
2287
|
ScheduleExpression?: string;
|
|
2288
2288
|
/**
|
|
2289
|
-
* @public
|
|
2290
2289
|
* <p>The Amazon Resource Name (ARN) of the role that is used for target invocation.</p>
|
|
2291
2290
|
* <p>If you're setting an event bus in another account as the target and that account granted
|
|
2292
2291
|
* permission to your account through an organization instead of directly by the account ID, you
|
|
2293
2292
|
* must specify a <code>RoleArn</code> with proper permissions in the <code>Target</code>
|
|
2294
2293
|
* structure, instead of here in this parameter.</p>
|
|
2294
|
+
* @public
|
|
2295
2295
|
*/
|
|
2296
2296
|
RoleArn?: string;
|
|
2297
2297
|
/**
|
|
2298
|
-
* @public
|
|
2299
2298
|
* <p>If the rule was created on behalf of your account by an Amazon Web Services service, this field displays
|
|
2300
2299
|
* the principal name of the service that created the rule.</p>
|
|
2300
|
+
* @public
|
|
2301
2301
|
*/
|
|
2302
2302
|
ManagedBy?: string;
|
|
2303
2303
|
/**
|
|
2304
|
-
* @public
|
|
2305
2304
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
2306
2305
|
* event bus is used.</p>
|
|
2306
|
+
* @public
|
|
2307
2307
|
*/
|
|
2308
2308
|
EventBusName?: string;
|
|
2309
2309
|
}
|
|
@@ -2312,14 +2312,14 @@ export interface Rule {
|
|
|
2312
2312
|
*/
|
|
2313
2313
|
export interface ListRulesResponse {
|
|
2314
2314
|
/**
|
|
2315
|
-
* @public
|
|
2316
2315
|
* <p>The rules that match the specified criteria.</p>
|
|
2316
|
+
* @public
|
|
2317
2317
|
*/
|
|
2318
2318
|
Rules?: Rule[];
|
|
2319
2319
|
/**
|
|
2320
|
-
* @public
|
|
2321
2320
|
* <p>Indicates whether there are additional results to retrieve. If there are no more results,
|
|
2322
2321
|
* the value is null.</p>
|
|
2322
|
+
* @public
|
|
2323
2323
|
*/
|
|
2324
2324
|
NextToken?: string;
|
|
2325
2325
|
}
|
|
@@ -2328,8 +2328,8 @@ export interface ListRulesResponse {
|
|
|
2328
2328
|
*/
|
|
2329
2329
|
export interface ListTagsForResourceRequest {
|
|
2330
2330
|
/**
|
|
2331
|
-
* @public
|
|
2332
2331
|
* <p>The ARN of the EventBridge resource for which you want to view tags.</p>
|
|
2332
|
+
* @public
|
|
2333
2333
|
*/
|
|
2334
2334
|
ResourceARN: string | undefined;
|
|
2335
2335
|
}
|
|
@@ -2338,8 +2338,8 @@ export interface ListTagsForResourceRequest {
|
|
|
2338
2338
|
*/
|
|
2339
2339
|
export interface ListTagsForResourceResponse {
|
|
2340
2340
|
/**
|
|
2341
|
-
* @public
|
|
2342
2341
|
* <p>The list of tag keys and values associated with the resource you specified</p>
|
|
2342
|
+
* @public
|
|
2343
2343
|
*/
|
|
2344
2344
|
Tags?: Tag[];
|
|
2345
2345
|
}
|
|
@@ -2348,120 +2348,120 @@ export interface ListTagsForResourceResponse {
|
|
|
2348
2348
|
*/
|
|
2349
2349
|
export interface ListTargetsByRuleRequest {
|
|
2350
2350
|
/**
|
|
2351
|
-
* @public
|
|
2352
2351
|
* <p>The name of the rule.</p>
|
|
2352
|
+
* @public
|
|
2353
2353
|
*/
|
|
2354
2354
|
Rule: string | undefined;
|
|
2355
2355
|
/**
|
|
2356
|
-
* @public
|
|
2357
2356
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
2358
2357
|
* event bus is used.</p>
|
|
2358
|
+
* @public
|
|
2359
2359
|
*/
|
|
2360
2360
|
EventBusName?: string;
|
|
2361
2361
|
/**
|
|
2362
|
-
* @public
|
|
2363
2362
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2363
|
+
* @public
|
|
2364
2364
|
*/
|
|
2365
2365
|
NextToken?: string;
|
|
2366
2366
|
/**
|
|
2367
|
-
* @public
|
|
2368
2367
|
* <p>The maximum number of results to return.</p>
|
|
2368
|
+
* @public
|
|
2369
2369
|
*/
|
|
2370
2370
|
Limit?: number;
|
|
2371
2371
|
}
|
|
2372
2372
|
/**
|
|
2373
|
-
* @public
|
|
2374
2373
|
* <p>The array properties for the submitted job, such as the size of the array. The array size
|
|
2375
2374
|
* can be between 2 and 10,000. If you specify array properties for a job, it becomes an array
|
|
2376
2375
|
* job. This parameter is used only if the target is an Batch job.</p>
|
|
2376
|
+
* @public
|
|
2377
2377
|
*/
|
|
2378
2378
|
export interface BatchArrayProperties {
|
|
2379
2379
|
/**
|
|
2380
|
-
* @public
|
|
2381
2380
|
* <p>The size of the array, if this is an array batch job. Valid values are integers between 2
|
|
2382
2381
|
* and 10,000.</p>
|
|
2382
|
+
* @public
|
|
2383
2383
|
*/
|
|
2384
2384
|
Size?: number;
|
|
2385
2385
|
}
|
|
2386
2386
|
/**
|
|
2387
|
-
* @public
|
|
2388
2387
|
* <p>The retry strategy to use for failed jobs, if the target is an Batch job. If you
|
|
2389
2388
|
* specify a retry strategy here, it overrides the retry strategy defined in the job
|
|
2390
2389
|
* definition.</p>
|
|
2390
|
+
* @public
|
|
2391
2391
|
*/
|
|
2392
2392
|
export interface BatchRetryStrategy {
|
|
2393
2393
|
/**
|
|
2394
|
-
* @public
|
|
2395
2394
|
* <p>The number of times to attempt to retry, if the job fails. Valid values are 1–10.</p>
|
|
2395
|
+
* @public
|
|
2396
2396
|
*/
|
|
2397
2397
|
Attempts?: number;
|
|
2398
2398
|
}
|
|
2399
2399
|
/**
|
|
2400
|
-
* @public
|
|
2401
2400
|
* <p>The custom parameters to be used when the target is an Batch job.</p>
|
|
2401
|
+
* @public
|
|
2402
2402
|
*/
|
|
2403
2403
|
export interface BatchParameters {
|
|
2404
2404
|
/**
|
|
2405
|
-
* @public
|
|
2406
2405
|
* <p>The ARN or name of the job definition to use if the event target is an Batch job. This
|
|
2407
2406
|
* job definition must already exist.</p>
|
|
2407
|
+
* @public
|
|
2408
2408
|
*/
|
|
2409
2409
|
JobDefinition: string | undefined;
|
|
2410
2410
|
/**
|
|
2411
|
-
* @public
|
|
2412
2411
|
* <p>The name to use for this execution of the job, if the target is an Batch job.</p>
|
|
2412
|
+
* @public
|
|
2413
2413
|
*/
|
|
2414
2414
|
JobName: string | undefined;
|
|
2415
2415
|
/**
|
|
2416
|
-
* @public
|
|
2417
2416
|
* <p>The array properties for the submitted job, such as the size of the array. The array size
|
|
2418
2417
|
* can be between 2 and 10,000. If you specify array properties for a job, it becomes an array
|
|
2419
2418
|
* job. This parameter is used only if the target is an Batch job.</p>
|
|
2419
|
+
* @public
|
|
2420
2420
|
*/
|
|
2421
2421
|
ArrayProperties?: BatchArrayProperties;
|
|
2422
2422
|
/**
|
|
2423
|
-
* @public
|
|
2424
2423
|
* <p>The retry strategy to use for failed jobs, if the target is an Batch job. The retry
|
|
2425
2424
|
* strategy is the number of times to retry the failed job execution. Valid values are 1–10. When
|
|
2426
2425
|
* you specify a retry strategy here, it overrides the retry strategy defined in the job
|
|
2427
2426
|
* definition.</p>
|
|
2427
|
+
* @public
|
|
2428
2428
|
*/
|
|
2429
2429
|
RetryStrategy?: BatchRetryStrategy;
|
|
2430
2430
|
}
|
|
2431
2431
|
/**
|
|
2432
|
-
* @public
|
|
2433
2432
|
* <p>A <code>DeadLetterConfig</code> object that contains information about a dead-letter queue
|
|
2434
2433
|
* configuration.</p>
|
|
2434
|
+
* @public
|
|
2435
2435
|
*/
|
|
2436
2436
|
export interface DeadLetterConfig {
|
|
2437
2437
|
/**
|
|
2438
|
-
* @public
|
|
2439
2438
|
* <p>The ARN of the SQS queue specified as the target for the dead-letter queue.</p>
|
|
2439
|
+
* @public
|
|
2440
2440
|
*/
|
|
2441
2441
|
Arn?: string;
|
|
2442
2442
|
}
|
|
2443
2443
|
/**
|
|
2444
|
-
* @public
|
|
2445
2444
|
* <p>The details of a capacity provider strategy. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html">CapacityProviderStrategyItem</a> in the Amazon ECS API Reference.</p>
|
|
2445
|
+
* @public
|
|
2446
2446
|
*/
|
|
2447
2447
|
export interface CapacityProviderStrategyItem {
|
|
2448
2448
|
/**
|
|
2449
|
-
* @public
|
|
2450
2449
|
* <p>The short name of the capacity provider.</p>
|
|
2450
|
+
* @public
|
|
2451
2451
|
*/
|
|
2452
2452
|
capacityProvider: string | undefined;
|
|
2453
2453
|
/**
|
|
2454
|
-
* @public
|
|
2455
2454
|
* <p>The weight value designates the relative percentage of the total number of tasks launched
|
|
2456
2455
|
* that should use the specified capacity provider. The weight value is taken into consideration
|
|
2457
2456
|
* after the base value, if defined, is satisfied.</p>
|
|
2457
|
+
* @public
|
|
2458
2458
|
*/
|
|
2459
2459
|
weight?: number;
|
|
2460
2460
|
/**
|
|
2461
|
-
* @public
|
|
2462
2461
|
* <p>The base value designates how many tasks, at a minimum, to run on the specified capacity
|
|
2463
2462
|
* provider. Only one capacity provider in a capacity provider strategy can have a base defined.
|
|
2464
2463
|
* If no value is specified, the default value of 0 is used. </p>
|
|
2464
|
+
* @public
|
|
2465
2465
|
*/
|
|
2466
2466
|
base?: number;
|
|
2467
2467
|
}
|
|
@@ -2479,43 +2479,43 @@ export declare const LaunchType: {
|
|
|
2479
2479
|
*/
|
|
2480
2480
|
export type LaunchType = (typeof LaunchType)[keyof typeof LaunchType];
|
|
2481
2481
|
/**
|
|
2482
|
-
* @public
|
|
2483
2482
|
* <p>This structure specifies the VPC subnets and security groups for the task, and whether a
|
|
2484
2483
|
* public IP address is to be used. This structure is relevant only for ECS tasks that use the
|
|
2485
2484
|
* <code>awsvpc</code> network mode.</p>
|
|
2485
|
+
* @public
|
|
2486
2486
|
*/
|
|
2487
2487
|
export interface AwsVpcConfiguration {
|
|
2488
2488
|
/**
|
|
2489
|
-
* @public
|
|
2490
2489
|
* <p>Specifies the subnets associated with the task. These subnets must all be in the same VPC.
|
|
2491
2490
|
* You can specify as many as 16 subnets.</p>
|
|
2491
|
+
* @public
|
|
2492
2492
|
*/
|
|
2493
2493
|
Subnets: string[] | undefined;
|
|
2494
2494
|
/**
|
|
2495
|
-
* @public
|
|
2496
2495
|
* <p>Specifies the security groups associated with the task. These security groups must all be
|
|
2497
2496
|
* in the same VPC. You can specify as many as five security groups. If you do not specify a
|
|
2498
2497
|
* security group, the default security group for the VPC is used.</p>
|
|
2498
|
+
* @public
|
|
2499
2499
|
*/
|
|
2500
2500
|
SecurityGroups?: string[];
|
|
2501
2501
|
/**
|
|
2502
|
-
* @public
|
|
2503
2502
|
* <p>Specifies whether the task's elastic network interface receives a public IP address. You
|
|
2504
2503
|
* can specify <code>ENABLED</code> only when <code>LaunchType</code> in
|
|
2505
2504
|
* <code>EcsParameters</code> is set to <code>FARGATE</code>.</p>
|
|
2505
|
+
* @public
|
|
2506
2506
|
*/
|
|
2507
2507
|
AssignPublicIp?: AssignPublicIp;
|
|
2508
2508
|
}
|
|
2509
2509
|
/**
|
|
2510
|
-
* @public
|
|
2511
2510
|
* <p>This structure specifies the network configuration for an ECS task.</p>
|
|
2511
|
+
* @public
|
|
2512
2512
|
*/
|
|
2513
2513
|
export interface NetworkConfiguration {
|
|
2514
2514
|
/**
|
|
2515
|
-
* @public
|
|
2516
2515
|
* <p>Use this structure to specify the VPC subnets and security groups for the task, and
|
|
2517
2516
|
* whether a public IP address is to be used. This structure is relevant only for ECS tasks that
|
|
2518
2517
|
* use the <code>awsvpc</code> network mode.</p>
|
|
2518
|
+
* @public
|
|
2519
2519
|
*/
|
|
2520
2520
|
awsvpcConfiguration?: AwsVpcConfiguration;
|
|
2521
2521
|
}
|
|
@@ -2532,23 +2532,23 @@ export declare const PlacementConstraintType: {
|
|
|
2532
2532
|
*/
|
|
2533
2533
|
export type PlacementConstraintType = (typeof PlacementConstraintType)[keyof typeof PlacementConstraintType];
|
|
2534
2534
|
/**
|
|
2535
|
-
* @public
|
|
2536
2535
|
* <p>An object representing a constraint on task placement. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html">Task Placement Constraints</a> in the Amazon Elastic Container Service Developer
|
|
2537
2536
|
* Guide.</p>
|
|
2537
|
+
* @public
|
|
2538
2538
|
*/
|
|
2539
2539
|
export interface PlacementConstraint {
|
|
2540
2540
|
/**
|
|
2541
|
-
* @public
|
|
2542
2541
|
* <p>The type of constraint. Use distinctInstance to ensure that each task in a particular
|
|
2543
2542
|
* group is running on a different container instance. Use memberOf to restrict the selection to
|
|
2544
2543
|
* a group of valid candidates. </p>
|
|
2544
|
+
* @public
|
|
2545
2545
|
*/
|
|
2546
2546
|
type?: PlacementConstraintType;
|
|
2547
2547
|
/**
|
|
2548
|
-
* @public
|
|
2549
2548
|
* <p>A cluster query language expression to apply to the constraint. You cannot specify an
|
|
2550
2549
|
* expression if the constraint type is <code>distinctInstance</code>. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the Amazon Elastic Container Service Developer Guide.
|
|
2551
2550
|
* </p>
|
|
2551
|
+
* @public
|
|
2552
2552
|
*/
|
|
2553
2553
|
expression?: string;
|
|
2554
2554
|
}
|
|
@@ -2566,28 +2566,28 @@ export declare const PlacementStrategyType: {
|
|
|
2566
2566
|
*/
|
|
2567
2567
|
export type PlacementStrategyType = (typeof PlacementStrategyType)[keyof typeof PlacementStrategyType];
|
|
2568
2568
|
/**
|
|
2569
|
-
* @public
|
|
2570
2569
|
* <p>The task placement strategy for a task or service. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html">Task Placement Strategies</a> in the Amazon Elastic Container Service Service Developer
|
|
2571
2570
|
* Guide.</p>
|
|
2571
|
+
* @public
|
|
2572
2572
|
*/
|
|
2573
2573
|
export interface PlacementStrategy {
|
|
2574
2574
|
/**
|
|
2575
|
-
* @public
|
|
2576
2575
|
* <p>The type of placement strategy. The random placement strategy randomly places tasks on
|
|
2577
2576
|
* available candidates. The spread placement strategy spreads placement across available
|
|
2578
2577
|
* candidates evenly based on the field parameter. The binpack strategy places tasks on available
|
|
2579
2578
|
* candidates that have the least available amount of the resource that is specified with the
|
|
2580
2579
|
* field parameter. For example, if you binpack on memory, a task is placed on the instance with
|
|
2581
2580
|
* the least amount of remaining memory (but still enough to run the task). </p>
|
|
2581
|
+
* @public
|
|
2582
2582
|
*/
|
|
2583
2583
|
type?: PlacementStrategyType;
|
|
2584
2584
|
/**
|
|
2585
|
-
* @public
|
|
2586
2585
|
* <p>The field to apply the placement strategy against. For the spread placement strategy,
|
|
2587
2586
|
* valid values are instanceId (or host, which has the same effect), or any platform or custom
|
|
2588
2587
|
* attribute that is applied to a container instance, such as attribute:ecs.availability-zone.
|
|
2589
2588
|
* For the binpack placement strategy, valid values are cpu and memory. For the random placement
|
|
2590
2589
|
* strategy, this field is not used. </p>
|
|
2590
|
+
* @public
|
|
2591
2591
|
*/
|
|
2592
2592
|
field?: string;
|
|
2593
2593
|
}
|
|
@@ -2603,32 +2603,31 @@ export declare const PropagateTags: {
|
|
|
2603
2603
|
*/
|
|
2604
2604
|
export type PropagateTags = (typeof PropagateTags)[keyof typeof PropagateTags];
|
|
2605
2605
|
/**
|
|
2606
|
-
* @public
|
|
2607
2606
|
* <p>The custom parameters to be used when the target is an Amazon ECS task.</p>
|
|
2607
|
+
* @public
|
|
2608
2608
|
*/
|
|
2609
2609
|
export interface EcsParameters {
|
|
2610
2610
|
/**
|
|
2611
|
-
* @public
|
|
2612
2611
|
* <p>The ARN of the task definition to use if the event target is an Amazon ECS task. </p>
|
|
2612
|
+
* @public
|
|
2613
2613
|
*/
|
|
2614
2614
|
TaskDefinitionArn: string | undefined;
|
|
2615
2615
|
/**
|
|
2616
|
-
* @public
|
|
2617
2616
|
* <p>The number of tasks to create based on <code>TaskDefinition</code>. The default is
|
|
2618
2617
|
* 1.</p>
|
|
2618
|
+
* @public
|
|
2619
2619
|
*/
|
|
2620
2620
|
TaskCount?: number;
|
|
2621
2621
|
/**
|
|
2622
|
-
* @public
|
|
2623
2622
|
* <p>Specifies the launch type on which your task is running. The launch type that you specify
|
|
2624
2623
|
* here must match one of the launch type (compatibilities) of the target task. The
|
|
2625
2624
|
* <code>FARGATE</code> value is supported only in the Regions where Fargate witt Amazon ECS
|
|
2626
2625
|
* is supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html">Fargate on Amazon ECS</a> in
|
|
2627
2626
|
* the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2627
|
+
* @public
|
|
2628
2628
|
*/
|
|
2629
2629
|
LaunchType?: LaunchType;
|
|
2630
2630
|
/**
|
|
2631
|
-
* @public
|
|
2632
2631
|
* <p>Use this structure if the Amazon ECS task uses the <code>awsvpc</code> network mode. This
|
|
2633
2632
|
* structure specifies the VPC subnets and security groups associated with the task, and whether
|
|
2634
2633
|
* a public IP address is to be used. This structure is required if <code>LaunchType</code> is
|
|
@@ -2636,112 +2635,112 @@ export interface EcsParameters {
|
|
|
2636
2635
|
* tasks.</p>
|
|
2637
2636
|
* <p>If you specify <code>NetworkConfiguration</code> when the target ECS task does not use the
|
|
2638
2637
|
* <code>awsvpc</code> network mode, the task fails.</p>
|
|
2638
|
+
* @public
|
|
2639
2639
|
*/
|
|
2640
2640
|
NetworkConfiguration?: NetworkConfiguration;
|
|
2641
2641
|
/**
|
|
2642
|
-
* @public
|
|
2643
2642
|
* <p>Specifies the platform version for the task. Specify only the numeric portion of the
|
|
2644
2643
|
* platform version, such as <code>1.1.0</code>.</p>
|
|
2645
2644
|
* <p>This structure is used only if <code>LaunchType</code> is <code>FARGATE</code>. For more
|
|
2646
2645
|
* information about valid platform versions, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform
|
|
2647
2646
|
* Versions</a> in the <i>Amazon Elastic Container Service Developer
|
|
2648
2647
|
* Guide</i>.</p>
|
|
2648
|
+
* @public
|
|
2649
2649
|
*/
|
|
2650
2650
|
PlatformVersion?: string;
|
|
2651
2651
|
/**
|
|
2652
|
-
* @public
|
|
2653
2652
|
* <p>Specifies an ECS task group for the task. The maximum length is 255 characters.</p>
|
|
2653
|
+
* @public
|
|
2654
2654
|
*/
|
|
2655
2655
|
Group?: string;
|
|
2656
2656
|
/**
|
|
2657
|
-
* @public
|
|
2658
2657
|
* <p>The capacity provider strategy to use for the task.</p>
|
|
2659
2658
|
* <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>
|
|
2660
2659
|
* parameter must be omitted. If no <code>capacityProviderStrategy</code> or launchType is
|
|
2661
2660
|
* specified, the <code>defaultCapacityProviderStrategy</code> for the cluster is used. </p>
|
|
2661
|
+
* @public
|
|
2662
2662
|
*/
|
|
2663
2663
|
CapacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
2664
2664
|
/**
|
|
2665
|
-
* @public
|
|
2666
2665
|
* <p>Specifies whether to enable Amazon ECS managed tags for the task. For more information,
|
|
2667
2666
|
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS Resources</a> in the Amazon Elastic Container Service Developer
|
|
2668
2667
|
* Guide. </p>
|
|
2668
|
+
* @public
|
|
2669
2669
|
*/
|
|
2670
2670
|
EnableECSManagedTags?: boolean;
|
|
2671
2671
|
/**
|
|
2672
|
-
* @public
|
|
2673
2672
|
* <p>Whether or not to enable the execute command functionality for the containers in this
|
|
2674
2673
|
* task. If true, this enables execute command functionality on all containers in the
|
|
2675
2674
|
* task.</p>
|
|
2675
|
+
* @public
|
|
2676
2676
|
*/
|
|
2677
2677
|
EnableExecuteCommand?: boolean;
|
|
2678
2678
|
/**
|
|
2679
|
-
* @public
|
|
2680
2679
|
* <p>An array of placement constraint objects to use for the task. You can specify up to 10
|
|
2681
2680
|
* constraints per task (including constraints in the task definition and those specified at
|
|
2682
2681
|
* runtime).</p>
|
|
2682
|
+
* @public
|
|
2683
2683
|
*/
|
|
2684
2684
|
PlacementConstraints?: PlacementConstraint[];
|
|
2685
2685
|
/**
|
|
2686
|
-
* @public
|
|
2687
2686
|
* <p>The placement strategy objects to use for the task. You can specify a maximum of five
|
|
2688
2687
|
* strategy rules per task. </p>
|
|
2688
|
+
* @public
|
|
2689
2689
|
*/
|
|
2690
2690
|
PlacementStrategy?: PlacementStrategy[];
|
|
2691
2691
|
/**
|
|
2692
|
-
* @public
|
|
2693
2692
|
* <p>Specifies whether to propagate the tags from the task definition to the task. If no value
|
|
2694
2693
|
* is specified, the tags are not propagated. Tags can only be propagated to the task during task
|
|
2695
2694
|
* creation. To add tags to a task after task creation, use the TagResource API action. </p>
|
|
2695
|
+
* @public
|
|
2696
2696
|
*/
|
|
2697
2697
|
PropagateTags?: PropagateTags;
|
|
2698
2698
|
/**
|
|
2699
|
-
* @public
|
|
2700
2699
|
* <p>The reference ID to use for the task.</p>
|
|
2700
|
+
* @public
|
|
2701
2701
|
*/
|
|
2702
2702
|
ReferenceId?: string;
|
|
2703
2703
|
/**
|
|
2704
|
-
* @public
|
|
2705
2704
|
* <p>The metadata that you apply to the task to help you categorize and organize them. Each tag
|
|
2706
2705
|
* consists of a key and an optional value, both of which you define. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags">RunTask</a> in the Amazon ECS API Reference.</p>
|
|
2706
|
+
* @public
|
|
2707
2707
|
*/
|
|
2708
2708
|
Tags?: Tag[];
|
|
2709
2709
|
}
|
|
2710
2710
|
/**
|
|
2711
|
-
* @public
|
|
2712
2711
|
* <p>These are custom parameter to be used when the target is an API Gateway REST APIs or
|
|
2713
2712
|
* EventBridge ApiDestinations. In the latter case, these are merged with any
|
|
2714
2713
|
* InvocationParameters specified on the Connection, with any values from the Connection taking
|
|
2715
2714
|
* precedence.</p>
|
|
2715
|
+
* @public
|
|
2716
2716
|
*/
|
|
2717
2717
|
export interface HttpParameters {
|
|
2718
2718
|
/**
|
|
2719
|
-
* @public
|
|
2720
2719
|
* <p>The path parameter values to be used to populate API Gateway REST API or EventBridge
|
|
2721
2720
|
* ApiDestination path wildcards ("*").</p>
|
|
2721
|
+
* @public
|
|
2722
2722
|
*/
|
|
2723
2723
|
PathParameterValues?: string[];
|
|
2724
2724
|
/**
|
|
2725
|
-
* @public
|
|
2726
2725
|
* <p>The headers that need to be sent as part of request invoking the API Gateway REST API or
|
|
2727
2726
|
* EventBridge ApiDestination.</p>
|
|
2727
|
+
* @public
|
|
2728
2728
|
*/
|
|
2729
2729
|
HeaderParameters?: Record<string, string>;
|
|
2730
2730
|
/**
|
|
2731
|
-
* @public
|
|
2732
2731
|
* <p>The query string keys/values that need to be sent as part of request invoking the API Gateway
|
|
2733
2732
|
* REST API or EventBridge ApiDestination.</p>
|
|
2733
|
+
* @public
|
|
2734
2734
|
*/
|
|
2735
2735
|
QueryStringParameters?: Record<string, string>;
|
|
2736
2736
|
}
|
|
2737
2737
|
/**
|
|
2738
|
-
* @public
|
|
2739
2738
|
* <p>Contains the parameters needed for you to provide custom input to a target based on one or
|
|
2740
2739
|
* more pieces of data extracted from the event.</p>
|
|
2740
|
+
* @public
|
|
2741
2741
|
*/
|
|
2742
2742
|
export interface InputTransformer {
|
|
2743
2743
|
/**
|
|
2744
|
-
* @public
|
|
2745
2744
|
* <p>Map of JSON paths to be extracted from the event. You can then insert these in the
|
|
2746
2745
|
* template in <code>InputTemplate</code> to produce the output you want to be sent to the
|
|
2747
2746
|
* target.</p>
|
|
@@ -2750,10 +2749,10 @@ export interface InputTransformer {
|
|
|
2750
2749
|
* path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket
|
|
2751
2750
|
* notation.</p>
|
|
2752
2751
|
* <p>The keys cannot start with "Amazon Web Services." </p>
|
|
2752
|
+
* @public
|
|
2753
2753
|
*/
|
|
2754
2754
|
InputPathsMap?: Record<string, string>;
|
|
2755
2755
|
/**
|
|
2756
|
-
* @public
|
|
2757
2756
|
* <p>Input template where you specify placeholders that will be filled with the values of the
|
|
2758
2757
|
* keys from <code>InputPathsMap</code> to customize the data sent to the target. Enclose each
|
|
2759
2758
|
* <code>InputPathsMaps</code> value in brackets: <<i>value</i>> The
|
|
@@ -2820,163 +2819,163 @@ export interface InputTransformer {
|
|
|
2820
2819
|
* <p>
|
|
2821
2820
|
* <code>\}</code>
|
|
2822
2821
|
* </p>
|
|
2822
|
+
* @public
|
|
2823
2823
|
*/
|
|
2824
2824
|
InputTemplate: string | undefined;
|
|
2825
2825
|
}
|
|
2826
2826
|
/**
|
|
2827
|
-
* @public
|
|
2828
2827
|
* <p>This object enables you to specify a JSON path to extract from the event and use as the
|
|
2829
2828
|
* partition key for the Amazon Kinesis data stream, so that you can control the shard to which
|
|
2830
2829
|
* the event goes. If you do not include this parameter, the default is to use the
|
|
2831
2830
|
* <code>eventId</code> as the partition key.</p>
|
|
2831
|
+
* @public
|
|
2832
2832
|
*/
|
|
2833
2833
|
export interface KinesisParameters {
|
|
2834
2834
|
/**
|
|
2835
|
-
* @public
|
|
2836
2835
|
* <p>The JSON path to be extracted from the event and used as the partition key. For more
|
|
2837
2836
|
* information, see <a href="https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key">Amazon Kinesis Streams Key
|
|
2838
2837
|
* Concepts</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p>
|
|
2838
|
+
* @public
|
|
2839
2839
|
*/
|
|
2840
2840
|
PartitionKeyPath: string | undefined;
|
|
2841
2841
|
}
|
|
2842
2842
|
/**
|
|
2843
|
-
* @public
|
|
2844
2843
|
* <p>These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the
|
|
2845
2844
|
* Amazon Redshift Data API ExecuteStatement based on EventBridge events.</p>
|
|
2845
|
+
* @public
|
|
2846
2846
|
*/
|
|
2847
2847
|
export interface RedshiftDataParameters {
|
|
2848
2848
|
/**
|
|
2849
|
-
* @public
|
|
2850
2849
|
* <p>The name or ARN of the secret that enables access to the database. Required when
|
|
2851
2850
|
* authenticating using Amazon Web Services Secrets Manager.</p>
|
|
2851
|
+
* @public
|
|
2852
2852
|
*/
|
|
2853
2853
|
SecretManagerArn?: string;
|
|
2854
2854
|
/**
|
|
2855
|
-
* @public
|
|
2856
2855
|
* <p>The name of the database. Required when authenticating using temporary credentials.</p>
|
|
2856
|
+
* @public
|
|
2857
2857
|
*/
|
|
2858
2858
|
Database: string | undefined;
|
|
2859
2859
|
/**
|
|
2860
|
-
* @public
|
|
2861
2860
|
* <p>The database user name. Required when authenticating using temporary credentials.</p>
|
|
2861
|
+
* @public
|
|
2862
2862
|
*/
|
|
2863
2863
|
DbUser?: string;
|
|
2864
2864
|
/**
|
|
2865
|
-
* @public
|
|
2866
2865
|
* <p>The SQL statement text to run.</p>
|
|
2866
|
+
* @public
|
|
2867
2867
|
*/
|
|
2868
2868
|
Sql: string | undefined;
|
|
2869
2869
|
/**
|
|
2870
|
-
* @public
|
|
2871
2870
|
* <p>The name of the SQL statement. You can name the SQL statement when you create it to
|
|
2872
2871
|
* identify the query.</p>
|
|
2872
|
+
* @public
|
|
2873
2873
|
*/
|
|
2874
2874
|
StatementName?: string;
|
|
2875
2875
|
/**
|
|
2876
|
-
* @public
|
|
2877
2876
|
* <p>Indicates whether to send an event back to EventBridge after the SQL statement
|
|
2878
2877
|
* runs.</p>
|
|
2878
|
+
* @public
|
|
2879
2879
|
*/
|
|
2880
2880
|
WithEvent?: boolean;
|
|
2881
2881
|
}
|
|
2882
2882
|
/**
|
|
2883
|
-
* @public
|
|
2884
2883
|
* <p>A <code>RetryPolicy</code> object that includes information about the retry policy
|
|
2885
2884
|
* settings.</p>
|
|
2885
|
+
* @public
|
|
2886
2886
|
*/
|
|
2887
2887
|
export interface RetryPolicy {
|
|
2888
2888
|
/**
|
|
2889
|
-
* @public
|
|
2890
2889
|
* <p>The maximum number of retry attempts to make before the request fails. Retry attempts
|
|
2891
2890
|
* continue until either the maximum number of attempts is made or until the duration of the
|
|
2892
2891
|
* <code>MaximumEventAgeInSeconds</code> is met.</p>
|
|
2892
|
+
* @public
|
|
2893
2893
|
*/
|
|
2894
2894
|
MaximumRetryAttempts?: number;
|
|
2895
2895
|
/**
|
|
2896
|
-
* @public
|
|
2897
2896
|
* <p>The maximum amount of time, in seconds, to continue to make retry attempts.</p>
|
|
2897
|
+
* @public
|
|
2898
2898
|
*/
|
|
2899
2899
|
MaximumEventAgeInSeconds?: number;
|
|
2900
2900
|
}
|
|
2901
2901
|
/**
|
|
2902
|
-
* @public
|
|
2903
2902
|
* <p>Information about the EC2 instances that are to be sent the command, specified as
|
|
2904
2903
|
* key-value pairs. Each <code>RunCommandTarget</code> block can include only one key, but this
|
|
2905
2904
|
* key may specify multiple values.</p>
|
|
2905
|
+
* @public
|
|
2906
2906
|
*/
|
|
2907
2907
|
export interface RunCommandTarget {
|
|
2908
2908
|
/**
|
|
2909
|
-
* @public
|
|
2910
2909
|
* <p>Can be either <code>tag:</code>
|
|
2911
2910
|
* <i>tag-key</i> or
|
|
2912
2911
|
* <code>InstanceIds</code>.</p>
|
|
2912
|
+
* @public
|
|
2913
2913
|
*/
|
|
2914
2914
|
Key: string | undefined;
|
|
2915
2915
|
/**
|
|
2916
|
-
* @public
|
|
2917
2916
|
* <p>If <code>Key</code> is <code>tag:</code>
|
|
2918
2917
|
* <i>tag-key</i>, <code>Values</code>
|
|
2919
2918
|
* is a list of tag values. If <code>Key</code> is <code>InstanceIds</code>, <code>Values</code>
|
|
2920
2919
|
* is a list of Amazon EC2 instance IDs.</p>
|
|
2920
|
+
* @public
|
|
2921
2921
|
*/
|
|
2922
2922
|
Values: string[] | undefined;
|
|
2923
2923
|
}
|
|
2924
2924
|
/**
|
|
2925
|
-
* @public
|
|
2926
2925
|
* <p>This parameter contains the criteria (either InstanceIds or a tag) used to specify which
|
|
2927
2926
|
* EC2 instances are to be sent the command. </p>
|
|
2927
|
+
* @public
|
|
2928
2928
|
*/
|
|
2929
2929
|
export interface RunCommandParameters {
|
|
2930
2930
|
/**
|
|
2931
|
-
* @public
|
|
2932
2931
|
* <p>Currently, we support including only one RunCommandTarget block, which specifies either an
|
|
2933
2932
|
* array of InstanceIds or a tag.</p>
|
|
2933
|
+
* @public
|
|
2934
2934
|
*/
|
|
2935
2935
|
RunCommandTargets: RunCommandTarget[] | undefined;
|
|
2936
2936
|
}
|
|
2937
2937
|
/**
|
|
2938
|
-
* @public
|
|
2939
2938
|
* <p>Name/Value pair of a parameter to start execution of a SageMaker Model Building
|
|
2940
2939
|
* Pipeline.</p>
|
|
2940
|
+
* @public
|
|
2941
2941
|
*/
|
|
2942
2942
|
export interface SageMakerPipelineParameter {
|
|
2943
2943
|
/**
|
|
2944
|
-
* @public
|
|
2945
2944
|
* <p>Name of parameter to start execution of a SageMaker Model Building Pipeline.</p>
|
|
2945
|
+
* @public
|
|
2946
2946
|
*/
|
|
2947
2947
|
Name: string | undefined;
|
|
2948
2948
|
/**
|
|
2949
|
-
* @public
|
|
2950
2949
|
* <p>Value of parameter to start execution of a SageMaker Model Building Pipeline.</p>
|
|
2950
|
+
* @public
|
|
2951
2951
|
*/
|
|
2952
2952
|
Value: string | undefined;
|
|
2953
2953
|
}
|
|
2954
2954
|
/**
|
|
2955
|
-
* @public
|
|
2956
2955
|
* <p>These are custom parameters to use when the target is a SageMaker Model Building Pipeline
|
|
2957
2956
|
* that starts based on EventBridge events.</p>
|
|
2957
|
+
* @public
|
|
2958
2958
|
*/
|
|
2959
2959
|
export interface SageMakerPipelineParameters {
|
|
2960
2960
|
/**
|
|
2961
|
-
* @public
|
|
2962
2961
|
* <p>List of Parameter names and values for SageMaker Model Building Pipeline execution.</p>
|
|
2962
|
+
* @public
|
|
2963
2963
|
*/
|
|
2964
2964
|
PipelineParameterList?: SageMakerPipelineParameter[];
|
|
2965
2965
|
}
|
|
2966
2966
|
/**
|
|
2967
|
-
* @public
|
|
2968
2967
|
* <p>This structure includes the custom parameter to be used when the target is an SQS FIFO
|
|
2969
2968
|
* queue.</p>
|
|
2969
|
+
* @public
|
|
2970
2970
|
*/
|
|
2971
2971
|
export interface SqsParameters {
|
|
2972
2972
|
/**
|
|
2973
|
-
* @public
|
|
2974
2973
|
* <p>The FIFO message group ID to use as the target.</p>
|
|
2974
|
+
* @public
|
|
2975
2975
|
*/
|
|
2976
2976
|
MessageGroupId?: string;
|
|
2977
2977
|
}
|
|
2978
2978
|
/**
|
|
2979
|
-
* @public
|
|
2980
2979
|
* <p>Targets are the resources to be invoked when a rule is triggered. For a complete list of
|
|
2981
2980
|
* services and resources that can be set as a target, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html">PutTargets</a>.</p>
|
|
2982
2981
|
* <p>If you are setting the event bus of another account as the target, and that account
|
|
@@ -2985,82 +2984,82 @@ export interface SqsParameters {
|
|
|
2985
2984
|
* <code>Target</code> structure. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html">Sending and
|
|
2986
2985
|
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
|
|
2987
2986
|
* Guide</i>.</p>
|
|
2987
|
+
* @public
|
|
2988
2988
|
*/
|
|
2989
2989
|
export interface Target {
|
|
2990
2990
|
/**
|
|
2991
|
-
* @public
|
|
2992
2991
|
* <p>The ID of the target. We recommend using a memorable and unique string.</p>
|
|
2992
|
+
* @public
|
|
2993
2993
|
*/
|
|
2994
2994
|
Id: string | undefined;
|
|
2995
2995
|
/**
|
|
2996
|
-
* @public
|
|
2997
2996
|
* <p>The Amazon Resource Name (ARN) of the target.</p>
|
|
2997
|
+
* @public
|
|
2998
2998
|
*/
|
|
2999
2999
|
Arn: string | undefined;
|
|
3000
3000
|
/**
|
|
3001
|
-
* @public
|
|
3002
3001
|
* <p>The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is
|
|
3003
3002
|
* triggered. If one rule triggers multiple targets, you can use a different IAM role for each
|
|
3004
3003
|
* target.</p>
|
|
3004
|
+
* @public
|
|
3005
3005
|
*/
|
|
3006
3006
|
RoleArn?: string;
|
|
3007
3007
|
/**
|
|
3008
|
-
* @public
|
|
3009
3008
|
* <p>Valid JSON text passed to the target. In this case, nothing from the event itself is
|
|
3010
3009
|
* passed to the target. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data
|
|
3011
3010
|
* Interchange Format</a>.</p>
|
|
3011
|
+
* @public
|
|
3012
3012
|
*/
|
|
3013
3013
|
Input?: string;
|
|
3014
3014
|
/**
|
|
3015
|
-
* @public
|
|
3016
3015
|
* <p>The value of the JSONPath that is used for extracting part of the matched event when
|
|
3017
3016
|
* passing it to the target. You must use JSON dot notation, not bracket notation. For more
|
|
3018
3017
|
* information about JSON paths, see <a href="http://goessner.net/articles/JsonPath/">JSONPath</a>.</p>
|
|
3018
|
+
* @public
|
|
3019
3019
|
*/
|
|
3020
3020
|
InputPath?: string;
|
|
3021
3021
|
/**
|
|
3022
|
-
* @public
|
|
3023
3022
|
* <p>Settings to enable you to provide custom input to a target based on certain event data.
|
|
3024
3023
|
* You can extract one or more key-value pairs from the event and then use that data to send
|
|
3025
3024
|
* customized input to the target.</p>
|
|
3025
|
+
* @public
|
|
3026
3026
|
*/
|
|
3027
3027
|
InputTransformer?: InputTransformer;
|
|
3028
3028
|
/**
|
|
3029
|
-
* @public
|
|
3030
3029
|
* <p>The custom parameter you can use to control the shard assignment, when the target is a
|
|
3031
3030
|
* Kinesis data stream. If you do not include this parameter, the default is to use the
|
|
3032
3031
|
* <code>eventId</code> as the partition key.</p>
|
|
3032
|
+
* @public
|
|
3033
3033
|
*/
|
|
3034
3034
|
KinesisParameters?: KinesisParameters;
|
|
3035
3035
|
/**
|
|
3036
|
-
* @public
|
|
3037
3036
|
* <p>Parameters used when you are using the rule to invoke Amazon EC2 Run Command.</p>
|
|
3037
|
+
* @public
|
|
3038
3038
|
*/
|
|
3039
3039
|
RunCommandParameters?: RunCommandParameters;
|
|
3040
3040
|
/**
|
|
3041
|
-
* @public
|
|
3042
3041
|
* <p>Contains the Amazon ECS task definition and task count to be used, if the event target is
|
|
3043
3042
|
* an Amazon ECS task. For more information about Amazon ECS tasks, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Task
|
|
3044
3043
|
* Definitions </a> in the <i>Amazon EC2 Container Service Developer
|
|
3045
3044
|
* Guide</i>.</p>
|
|
3045
|
+
* @public
|
|
3046
3046
|
*/
|
|
3047
3047
|
EcsParameters?: EcsParameters;
|
|
3048
3048
|
/**
|
|
3049
|
-
* @public
|
|
3050
3049
|
* <p>If the event target is an Batch job, this contains the job definition, job name, and
|
|
3051
3050
|
* other parameters. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/jobs.html">Jobs</a> in the <i>Batch User
|
|
3052
3051
|
* Guide</i>.</p>
|
|
3052
|
+
* @public
|
|
3053
3053
|
*/
|
|
3054
3054
|
BatchParameters?: BatchParameters;
|
|
3055
3055
|
/**
|
|
3056
|
-
* @public
|
|
3057
3056
|
* <p>Contains the message group ID to use when the target is a FIFO queue.</p>
|
|
3058
3057
|
* <p>If you specify an SQS FIFO queue as a target, the queue must have content-based
|
|
3059
3058
|
* deduplication enabled.</p>
|
|
3059
|
+
* @public
|
|
3060
3060
|
*/
|
|
3061
3061
|
SqsParameters?: SqsParameters;
|
|
3062
3062
|
/**
|
|
3063
|
-
* @public
|
|
3064
3063
|
* <p>Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or
|
|
3065
3064
|
* EventBridge ApiDestination.</p>
|
|
3066
3065
|
* <p>If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can
|
|
@@ -3068,34 +3067,35 @@ export interface Target {
|
|
|
3068
3067
|
* of your target invoking request. If you're using ApiDestinations, the corresponding Connection
|
|
3069
3068
|
* can also have these values configured. In case of any conflicting keys, values from the
|
|
3070
3069
|
* Connection take precedence.</p>
|
|
3070
|
+
* @public
|
|
3071
3071
|
*/
|
|
3072
3072
|
HttpParameters?: HttpParameters;
|
|
3073
3073
|
/**
|
|
3074
|
-
* @public
|
|
3075
3074
|
* <p>Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift
|
|
3076
3075
|
* cluster.</p>
|
|
3077
3076
|
* <p>If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to
|
|
3078
3077
|
* invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.</p>
|
|
3078
|
+
* @public
|
|
3079
3079
|
*/
|
|
3080
3080
|
RedshiftDataParameters?: RedshiftDataParameters;
|
|
3081
3081
|
/**
|
|
3082
|
-
* @public
|
|
3083
3082
|
* <p>Contains the SageMaker Model Building Pipeline parameters to start execution of a
|
|
3084
3083
|
* SageMaker Model Building Pipeline.</p>
|
|
3085
3084
|
* <p>If you specify a SageMaker Model Building Pipeline as a target, you can use this to
|
|
3086
3085
|
* specify parameters to start a pipeline execution based on EventBridge events.</p>
|
|
3086
|
+
* @public
|
|
3087
3087
|
*/
|
|
3088
3088
|
SageMakerPipelineParameters?: SageMakerPipelineParameters;
|
|
3089
3089
|
/**
|
|
3090
|
-
* @public
|
|
3091
3090
|
* <p>The <code>DeadLetterConfig</code> that defines the target queue to send dead-letter queue
|
|
3092
3091
|
* events to.</p>
|
|
3092
|
+
* @public
|
|
3093
3093
|
*/
|
|
3094
3094
|
DeadLetterConfig?: DeadLetterConfig;
|
|
3095
3095
|
/**
|
|
3096
|
-
* @public
|
|
3097
3096
|
* <p>The <code>RetryPolicy</code> object that contains the retry policy configuration to use
|
|
3098
3097
|
* for the dead-letter queue.</p>
|
|
3098
|
+
* @public
|
|
3099
3099
|
*/
|
|
3100
3100
|
RetryPolicy?: RetryPolicy;
|
|
3101
3101
|
}
|
|
@@ -3104,61 +3104,61 @@ export interface Target {
|
|
|
3104
3104
|
*/
|
|
3105
3105
|
export interface ListTargetsByRuleResponse {
|
|
3106
3106
|
/**
|
|
3107
|
-
* @public
|
|
3108
3107
|
* <p>The targets assigned to the rule.</p>
|
|
3108
|
+
* @public
|
|
3109
3109
|
*/
|
|
3110
3110
|
Targets?: Target[];
|
|
3111
3111
|
/**
|
|
3112
|
-
* @public
|
|
3113
3112
|
* <p>Indicates whether there are additional results to retrieve. If there are no more results,
|
|
3114
3113
|
* the value is null.</p>
|
|
3114
|
+
* @public
|
|
3115
3115
|
*/
|
|
3116
3116
|
NextToken?: string;
|
|
3117
3117
|
}
|
|
3118
3118
|
/**
|
|
3119
|
-
* @public
|
|
3120
3119
|
* <p>Represents an event to be submitted.</p>
|
|
3120
|
+
* @public
|
|
3121
3121
|
*/
|
|
3122
3122
|
export interface PutEventsRequestEntry {
|
|
3123
3123
|
/**
|
|
3124
|
-
* @public
|
|
3125
3124
|
* <p>The time stamp of the event, per <a href="https://www.rfc-editor.org/rfc/rfc3339.txt">RFC3339</a>. If no time stamp is provided, the time stamp of the <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html">PutEvents</a> call is used.</p>
|
|
3125
|
+
* @public
|
|
3126
3126
|
*/
|
|
3127
3127
|
Time?: Date;
|
|
3128
3128
|
/**
|
|
3129
|
-
* @public
|
|
3130
3129
|
* <p>The source of the event.</p>
|
|
3130
|
+
* @public
|
|
3131
3131
|
*/
|
|
3132
3132
|
Source?: string;
|
|
3133
3133
|
/**
|
|
3134
|
-
* @public
|
|
3135
3134
|
* <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
|
|
3136
3135
|
* concerns. Any number, including zero, may be present.</p>
|
|
3136
|
+
* @public
|
|
3137
3137
|
*/
|
|
3138
3138
|
Resources?: string[];
|
|
3139
3139
|
/**
|
|
3140
|
-
* @public
|
|
3141
3140
|
* <p>Free-form string used to decide what fields to expect in the event detail.</p>
|
|
3141
|
+
* @public
|
|
3142
3142
|
*/
|
|
3143
3143
|
DetailType?: string;
|
|
3144
3144
|
/**
|
|
3145
|
-
* @public
|
|
3146
3145
|
* <p>A valid JSON string. There is no other schema imposed. The JSON string may contain fields
|
|
3147
3146
|
* and nested subobjects.</p>
|
|
3147
|
+
* @public
|
|
3148
3148
|
*/
|
|
3149
3149
|
Detail?: string;
|
|
3150
3150
|
/**
|
|
3151
|
-
* @public
|
|
3152
3151
|
* <p>The name or ARN of the event bus to receive the event. Only the rules that are associated
|
|
3153
3152
|
* with this event bus are used to match the event. If you omit this, the default event bus is
|
|
3154
3153
|
* used.</p>
|
|
3154
|
+
* @public
|
|
3155
3155
|
*/
|
|
3156
3156
|
EventBusName?: string;
|
|
3157
3157
|
/**
|
|
3158
|
-
* @public
|
|
3159
3158
|
* <p>An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the
|
|
3160
3159
|
* trace-id associated with the event.</p>
|
|
3161
3160
|
* <p>To learn more about X-Ray trace headers, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader">Tracing header</a> in the X-Ray Developer Guide.</p>
|
|
3161
|
+
* @public
|
|
3162
3162
|
*/
|
|
3163
3163
|
TraceHeader?: string;
|
|
3164
3164
|
}
|
|
@@ -3167,31 +3167,31 @@ export interface PutEventsRequestEntry {
|
|
|
3167
3167
|
*/
|
|
3168
3168
|
export interface PutEventsRequest {
|
|
3169
3169
|
/**
|
|
3170
|
-
* @public
|
|
3171
3170
|
* <p>The entry that defines an event in your system. You can specify several parameters for the
|
|
3172
3171
|
* entry such as the source and type of the event, resources associated with the event, and so
|
|
3173
3172
|
* on.</p>
|
|
3173
|
+
* @public
|
|
3174
3174
|
*/
|
|
3175
3175
|
Entries: PutEventsRequestEntry[] | undefined;
|
|
3176
3176
|
}
|
|
3177
3177
|
/**
|
|
3178
|
-
* @public
|
|
3179
3178
|
* <p>Represents an event that failed to be submitted.</p>
|
|
3179
|
+
* @public
|
|
3180
3180
|
*/
|
|
3181
3181
|
export interface PutEventsResultEntry {
|
|
3182
3182
|
/**
|
|
3183
|
-
* @public
|
|
3184
3183
|
* <p>The ID of the event.</p>
|
|
3184
|
+
* @public
|
|
3185
3185
|
*/
|
|
3186
3186
|
EventId?: string;
|
|
3187
3187
|
/**
|
|
3188
|
-
* @public
|
|
3189
3188
|
* <p>The error code that indicates why the event submission failed.</p>
|
|
3189
|
+
* @public
|
|
3190
3190
|
*/
|
|
3191
3191
|
ErrorCode?: string;
|
|
3192
3192
|
/**
|
|
3193
|
-
* @public
|
|
3194
3193
|
* <p>The error message that explains why the event submission failed.</p>
|
|
3194
|
+
* @public
|
|
3195
3195
|
*/
|
|
3196
3196
|
ErrorMessage?: string;
|
|
3197
3197
|
}
|
|
@@ -3200,48 +3200,48 @@ export interface PutEventsResultEntry {
|
|
|
3200
3200
|
*/
|
|
3201
3201
|
export interface PutEventsResponse {
|
|
3202
3202
|
/**
|
|
3203
|
-
* @public
|
|
3204
3203
|
* <p>The number of failed entries.</p>
|
|
3204
|
+
* @public
|
|
3205
3205
|
*/
|
|
3206
3206
|
FailedEntryCount?: number;
|
|
3207
3207
|
/**
|
|
3208
|
-
* @public
|
|
3209
3208
|
* <p>The successfully and unsuccessfully ingested events results. If the ingestion was
|
|
3210
3209
|
* successful, the entry has the event ID in it. Otherwise, you can use the error code and error
|
|
3211
3210
|
* message to identify the problem with the entry.</p>
|
|
3211
|
+
* @public
|
|
3212
3212
|
*/
|
|
3213
3213
|
Entries?: PutEventsResultEntry[];
|
|
3214
3214
|
}
|
|
3215
3215
|
/**
|
|
3216
|
-
* @public
|
|
3217
3216
|
* <p>The details about an event generated by an SaaS partner.</p>
|
|
3217
|
+
* @public
|
|
3218
3218
|
*/
|
|
3219
3219
|
export interface PutPartnerEventsRequestEntry {
|
|
3220
3220
|
/**
|
|
3221
|
-
* @public
|
|
3222
3221
|
* <p>The date and time of the event.</p>
|
|
3222
|
+
* @public
|
|
3223
3223
|
*/
|
|
3224
3224
|
Time?: Date;
|
|
3225
3225
|
/**
|
|
3226
|
-
* @public
|
|
3227
3226
|
* <p>The event source that is generating the entry.</p>
|
|
3227
|
+
* @public
|
|
3228
3228
|
*/
|
|
3229
3229
|
Source?: string;
|
|
3230
3230
|
/**
|
|
3231
|
-
* @public
|
|
3232
3231
|
* <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
|
|
3233
3232
|
* concerns. Any number, including zero, may be present.</p>
|
|
3233
|
+
* @public
|
|
3234
3234
|
*/
|
|
3235
3235
|
Resources?: string[];
|
|
3236
3236
|
/**
|
|
3237
|
-
* @public
|
|
3238
3237
|
* <p>A free-form string used to decide what fields to expect in the event detail.</p>
|
|
3238
|
+
* @public
|
|
3239
3239
|
*/
|
|
3240
3240
|
DetailType?: string;
|
|
3241
3241
|
/**
|
|
3242
|
-
* @public
|
|
3243
3242
|
* <p>A valid JSON string. There is no other schema imposed. The JSON string may contain fields
|
|
3244
3243
|
* and nested subobjects.</p>
|
|
3244
|
+
* @public
|
|
3245
3245
|
*/
|
|
3246
3246
|
Detail?: string;
|
|
3247
3247
|
}
|
|
@@ -3250,29 +3250,29 @@ export interface PutPartnerEventsRequestEntry {
|
|
|
3250
3250
|
*/
|
|
3251
3251
|
export interface PutPartnerEventsRequest {
|
|
3252
3252
|
/**
|
|
3253
|
-
* @public
|
|
3254
3253
|
* <p>The list of events to write to the event bus.</p>
|
|
3254
|
+
* @public
|
|
3255
3255
|
*/
|
|
3256
3256
|
Entries: PutPartnerEventsRequestEntry[] | undefined;
|
|
3257
3257
|
}
|
|
3258
3258
|
/**
|
|
3259
|
-
* @public
|
|
3260
3259
|
* <p>Represents an event that a partner tried to generate, but failed.</p>
|
|
3260
|
+
* @public
|
|
3261
3261
|
*/
|
|
3262
3262
|
export interface PutPartnerEventsResultEntry {
|
|
3263
3263
|
/**
|
|
3264
|
-
* @public
|
|
3265
3264
|
* <p>The ID of the event.</p>
|
|
3265
|
+
* @public
|
|
3266
3266
|
*/
|
|
3267
3267
|
EventId?: string;
|
|
3268
3268
|
/**
|
|
3269
|
-
* @public
|
|
3270
3269
|
* <p>The error code that indicates why the event submission failed.</p>
|
|
3270
|
+
* @public
|
|
3271
3271
|
*/
|
|
3272
3272
|
ErrorCode?: string;
|
|
3273
3273
|
/**
|
|
3274
|
-
* @public
|
|
3275
3274
|
* <p>The error message that explains why the event submission failed.</p>
|
|
3275
|
+
* @public
|
|
3276
3276
|
*/
|
|
3277
3277
|
ErrorMessage?: string;
|
|
3278
3278
|
}
|
|
@@ -3281,21 +3281,21 @@ export interface PutPartnerEventsResultEntry {
|
|
|
3281
3281
|
*/
|
|
3282
3282
|
export interface PutPartnerEventsResponse {
|
|
3283
3283
|
/**
|
|
3284
|
-
* @public
|
|
3285
3284
|
* <p>The number of events from this operation that could not be written to the partner event
|
|
3286
3285
|
* bus.</p>
|
|
3286
|
+
* @public
|
|
3287
3287
|
*/
|
|
3288
3288
|
FailedEntryCount?: number;
|
|
3289
3289
|
/**
|
|
3290
|
-
* @public
|
|
3291
3290
|
* <p>The list of events from this operation that were successfully written to the partner event
|
|
3292
3291
|
* bus.</p>
|
|
3292
|
+
* @public
|
|
3293
3293
|
*/
|
|
3294
3294
|
Entries?: PutPartnerEventsResultEntry[];
|
|
3295
3295
|
}
|
|
3296
3296
|
/**
|
|
3297
|
-
* @public
|
|
3298
3297
|
* <p>The event bus policy is too long. For more information, see the limits.</p>
|
|
3298
|
+
* @public
|
|
3299
3299
|
*/
|
|
3300
3300
|
export declare class PolicyLengthExceededException extends __BaseException {
|
|
3301
3301
|
readonly name: "PolicyLengthExceededException";
|
|
@@ -3306,7 +3306,6 @@ export declare class PolicyLengthExceededException extends __BaseException {
|
|
|
3306
3306
|
constructor(opts: __ExceptionOptionType<PolicyLengthExceededException, __BaseException>);
|
|
3307
3307
|
}
|
|
3308
3308
|
/**
|
|
3309
|
-
* @public
|
|
3310
3309
|
* <p>A JSON string which you can use to limit the event bus permissions you are granting to
|
|
3311
3310
|
* only accounts that fulfill the condition. Currently, the only supported condition is
|
|
3312
3311
|
* membership in a certain Amazon Web Services organization. The string must contain <code>Type</code>,
|
|
@@ -3316,24 +3315,25 @@ export declare class PolicyLengthExceededException extends __BaseException {
|
|
|
3316
3315
|
* <code>'\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
|
|
3317
3316
|
* "o-1234567890"\}'</code>
|
|
3318
3317
|
* </p>
|
|
3318
|
+
* @public
|
|
3319
3319
|
*/
|
|
3320
3320
|
export interface Condition {
|
|
3321
3321
|
/**
|
|
3322
|
-
* @public
|
|
3323
3322
|
* <p>Specifies the type of condition. Currently the only supported value is
|
|
3324
3323
|
* <code>StringEquals</code>.</p>
|
|
3324
|
+
* @public
|
|
3325
3325
|
*/
|
|
3326
3326
|
Type: string | undefined;
|
|
3327
3327
|
/**
|
|
3328
|
-
* @public
|
|
3329
3328
|
* <p>Specifies the key for the condition. Currently the only supported key is
|
|
3330
3329
|
* <code>aws:PrincipalOrgID</code>.</p>
|
|
3330
|
+
* @public
|
|
3331
3331
|
*/
|
|
3332
3332
|
Key: string | undefined;
|
|
3333
3333
|
/**
|
|
3334
|
-
* @public
|
|
3335
3334
|
* <p>Specifies the value for the key. Currently, this must be the ID of the
|
|
3336
3335
|
* organization.</p>
|
|
3336
|
+
* @public
|
|
3337
3337
|
*/
|
|
3338
3338
|
Value: string | undefined;
|
|
3339
3339
|
}
|
|
@@ -3342,18 +3342,17 @@ export interface Condition {
|
|
|
3342
3342
|
*/
|
|
3343
3343
|
export interface PutPermissionRequest {
|
|
3344
3344
|
/**
|
|
3345
|
-
* @public
|
|
3346
3345
|
* <p>The name of the event bus associated with the rule. If you omit this, the default event
|
|
3347
3346
|
* bus is used.</p>
|
|
3347
|
+
* @public
|
|
3348
3348
|
*/
|
|
3349
3349
|
EventBusName?: string;
|
|
3350
3350
|
/**
|
|
3351
|
-
* @public
|
|
3352
3351
|
* <p>The action that you are enabling the other account to perform.</p>
|
|
3352
|
+
* @public
|
|
3353
3353
|
*/
|
|
3354
3354
|
Action?: string;
|
|
3355
3355
|
/**
|
|
3356
|
-
* @public
|
|
3357
3356
|
* <p>The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event
|
|
3358
3357
|
* bus. Specify "*" to permit any account to put events to your default event bus.</p>
|
|
3359
3358
|
* <p>If you specify "*" without specifying <code>Condition</code>, avoid creating rules that
|
|
@@ -3361,17 +3360,17 @@ export interface PutPermissionRequest {
|
|
|
3361
3360
|
* for each rule contains an <code>account</code> field with a specific account ID from which to
|
|
3362
3361
|
* receive events. Rules with an account field do not match any events sent from other
|
|
3363
3362
|
* accounts.</p>
|
|
3363
|
+
* @public
|
|
3364
3364
|
*/
|
|
3365
3365
|
Principal?: string;
|
|
3366
3366
|
/**
|
|
3367
|
-
* @public
|
|
3368
3367
|
* <p>An identifier string for the external account that you are granting permissions to. If you
|
|
3369
3368
|
* later want to revoke the permission for this external account, specify this
|
|
3370
3369
|
* <code>StatementId</code> when you run <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html">RemovePermission</a>.</p>
|
|
3370
|
+
* @public
|
|
3371
3371
|
*/
|
|
3372
3372
|
StatementId?: string;
|
|
3373
3373
|
/**
|
|
3374
|
-
* @public
|
|
3375
3374
|
* <p>This parameter enables you to limit the permission to accounts that fulfill a certain
|
|
3376
3375
|
* condition, such as being a member of a certain Amazon Web Services organization. For more information about
|
|
3377
3376
|
* Amazon Web Services Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What Is Amazon Web Services
|
|
@@ -3381,13 +3380,14 @@ export interface PutPermissionRequest {
|
|
|
3381
3380
|
* organization.</p>
|
|
3382
3381
|
* <p>The <code>Condition</code> is a JSON string which must contain <code>Type</code>,
|
|
3383
3382
|
* <code>Key</code>, and <code>Value</code> fields.</p>
|
|
3383
|
+
* @public
|
|
3384
3384
|
*/
|
|
3385
3385
|
Condition?: Condition;
|
|
3386
3386
|
/**
|
|
3387
|
-
* @public
|
|
3388
3387
|
* <p>A JSON string that describes the permission policy statement. You can include a
|
|
3389
3388
|
* <code>Policy</code> parameter in the request instead of using the <code>StatementId</code>,
|
|
3390
3389
|
* <code>Action</code>, <code>Principal</code>, or <code>Condition</code> parameters.</p>
|
|
3390
|
+
* @public
|
|
3391
3391
|
*/
|
|
3392
3392
|
Policy?: string;
|
|
3393
3393
|
}
|
|
@@ -3396,49 +3396,49 @@ export interface PutPermissionRequest {
|
|
|
3396
3396
|
*/
|
|
3397
3397
|
export interface PutRuleRequest {
|
|
3398
3398
|
/**
|
|
3399
|
-
* @public
|
|
3400
3399
|
* <p>The name of the rule that you are creating or updating.</p>
|
|
3400
|
+
* @public
|
|
3401
3401
|
*/
|
|
3402
3402
|
Name: string | undefined;
|
|
3403
3403
|
/**
|
|
3404
|
-
* @public
|
|
3405
3404
|
* <p>The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".</p>
|
|
3405
|
+
* @public
|
|
3406
3406
|
*/
|
|
3407
3407
|
ScheduleExpression?: string;
|
|
3408
3408
|
/**
|
|
3409
|
-
* @public
|
|
3410
3409
|
* <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
3411
3410
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
3411
|
+
* @public
|
|
3412
3412
|
*/
|
|
3413
3413
|
EventPattern?: string;
|
|
3414
3414
|
/**
|
|
3415
|
-
* @public
|
|
3416
3415
|
* <p>Indicates whether the rule is enabled or disabled.</p>
|
|
3416
|
+
* @public
|
|
3417
3417
|
*/
|
|
3418
3418
|
State?: RuleState;
|
|
3419
3419
|
/**
|
|
3420
|
-
* @public
|
|
3421
3420
|
* <p>A description of the rule.</p>
|
|
3421
|
+
* @public
|
|
3422
3422
|
*/
|
|
3423
3423
|
Description?: string;
|
|
3424
3424
|
/**
|
|
3425
|
-
* @public
|
|
3426
3425
|
* <p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
|
|
3427
3426
|
* <p>If you're setting an event bus in another account as the target and that account granted
|
|
3428
3427
|
* permission to your account through an organization instead of directly by the account ID, you
|
|
3429
3428
|
* must specify a <code>RoleArn</code> with proper permissions in the <code>Target</code>
|
|
3430
3429
|
* structure, instead of here in this parameter.</p>
|
|
3430
|
+
* @public
|
|
3431
3431
|
*/
|
|
3432
3432
|
RoleArn?: string;
|
|
3433
3433
|
/**
|
|
3434
|
-
* @public
|
|
3435
3434
|
* <p>The list of key-value pairs to associate with the rule.</p>
|
|
3435
|
+
* @public
|
|
3436
3436
|
*/
|
|
3437
3437
|
Tags?: Tag[];
|
|
3438
3438
|
/**
|
|
3439
|
-
* @public
|
|
3440
3439
|
* <p>The name or ARN of the event bus to associate with this rule. If you omit this, the
|
|
3441
3440
|
* default event bus is used.</p>
|
|
3441
|
+
* @public
|
|
3442
3442
|
*/
|
|
3443
3443
|
EventBusName?: string;
|
|
3444
3444
|
}
|
|
@@ -3447,8 +3447,8 @@ export interface PutRuleRequest {
|
|
|
3447
3447
|
*/
|
|
3448
3448
|
export interface PutRuleResponse {
|
|
3449
3449
|
/**
|
|
3450
|
-
* @public
|
|
3451
3450
|
* <p>The Amazon Resource Name (ARN) of the rule.</p>
|
|
3451
|
+
* @public
|
|
3452
3452
|
*/
|
|
3453
3453
|
RuleArn?: string;
|
|
3454
3454
|
}
|
|
@@ -3457,42 +3457,42 @@ export interface PutRuleResponse {
|
|
|
3457
3457
|
*/
|
|
3458
3458
|
export interface PutTargetsRequest {
|
|
3459
3459
|
/**
|
|
3460
|
-
* @public
|
|
3461
3460
|
* <p>The name of the rule.</p>
|
|
3461
|
+
* @public
|
|
3462
3462
|
*/
|
|
3463
3463
|
Rule: string | undefined;
|
|
3464
3464
|
/**
|
|
3465
|
-
* @public
|
|
3466
3465
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
3467
3466
|
* event bus is used.</p>
|
|
3467
|
+
* @public
|
|
3468
3468
|
*/
|
|
3469
3469
|
EventBusName?: string;
|
|
3470
3470
|
/**
|
|
3471
|
-
* @public
|
|
3472
3471
|
* <p>The targets to update or add to the rule.</p>
|
|
3472
|
+
* @public
|
|
3473
3473
|
*/
|
|
3474
3474
|
Targets: Target[] | undefined;
|
|
3475
3475
|
}
|
|
3476
3476
|
/**
|
|
3477
|
-
* @public
|
|
3478
3477
|
* <p>Represents a target that failed to be added to a rule.</p>
|
|
3478
|
+
* @public
|
|
3479
3479
|
*/
|
|
3480
3480
|
export interface PutTargetsResultEntry {
|
|
3481
3481
|
/**
|
|
3482
|
-
* @public
|
|
3483
3482
|
* <p>The ID of the target.</p>
|
|
3483
|
+
* @public
|
|
3484
3484
|
*/
|
|
3485
3485
|
TargetId?: string;
|
|
3486
3486
|
/**
|
|
3487
|
-
* @public
|
|
3488
3487
|
* <p>The error code that indicates why the target addition failed. If the value is
|
|
3489
3488
|
* <code>ConcurrentModificationException</code>, too many requests were made at the same
|
|
3490
3489
|
* time.</p>
|
|
3490
|
+
* @public
|
|
3491
3491
|
*/
|
|
3492
3492
|
ErrorCode?: string;
|
|
3493
3493
|
/**
|
|
3494
|
-
* @public
|
|
3495
3494
|
* <p>The error message that explains why the target addition failed.</p>
|
|
3495
|
+
* @public
|
|
3496
3496
|
*/
|
|
3497
3497
|
ErrorMessage?: string;
|
|
3498
3498
|
}
|
|
@@ -3501,13 +3501,13 @@ export interface PutTargetsResultEntry {
|
|
|
3501
3501
|
*/
|
|
3502
3502
|
export interface PutTargetsResponse {
|
|
3503
3503
|
/**
|
|
3504
|
-
* @public
|
|
3505
3504
|
* <p>The number of failed entries.</p>
|
|
3505
|
+
* @public
|
|
3506
3506
|
*/
|
|
3507
3507
|
FailedEntryCount?: number;
|
|
3508
3508
|
/**
|
|
3509
|
-
* @public
|
|
3510
3509
|
* <p>The failed target entries.</p>
|
|
3510
|
+
* @public
|
|
3511
3511
|
*/
|
|
3512
3512
|
FailedEntries?: PutTargetsResultEntry[];
|
|
3513
3513
|
}
|
|
@@ -3516,20 +3516,20 @@ export interface PutTargetsResponse {
|
|
|
3516
3516
|
*/
|
|
3517
3517
|
export interface RemovePermissionRequest {
|
|
3518
3518
|
/**
|
|
3519
|
-
* @public
|
|
3520
3519
|
* <p>The statement ID corresponding to the account that is no longer allowed to put events to
|
|
3521
3520
|
* the default event bus.</p>
|
|
3521
|
+
* @public
|
|
3522
3522
|
*/
|
|
3523
3523
|
StatementId?: string;
|
|
3524
3524
|
/**
|
|
3525
|
-
* @public
|
|
3526
3525
|
* <p>Specifies whether to remove all permissions.</p>
|
|
3526
|
+
* @public
|
|
3527
3527
|
*/
|
|
3528
3528
|
RemoveAllPermissions?: boolean;
|
|
3529
3529
|
/**
|
|
3530
|
-
* @public
|
|
3531
3530
|
* <p>The name of the event bus to revoke permissions for. If you omit this, the default event
|
|
3532
3531
|
* bus is used.</p>
|
|
3532
|
+
* @public
|
|
3533
3533
|
*/
|
|
3534
3534
|
EventBusName?: string;
|
|
3535
3535
|
}
|
|
@@ -3538,51 +3538,51 @@ export interface RemovePermissionRequest {
|
|
|
3538
3538
|
*/
|
|
3539
3539
|
export interface RemoveTargetsRequest {
|
|
3540
3540
|
/**
|
|
3541
|
-
* @public
|
|
3542
3541
|
* <p>The name of the rule.</p>
|
|
3542
|
+
* @public
|
|
3543
3543
|
*/
|
|
3544
3544
|
Rule: string | undefined;
|
|
3545
3545
|
/**
|
|
3546
|
-
* @public
|
|
3547
3546
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
3548
3547
|
* event bus is used.</p>
|
|
3548
|
+
* @public
|
|
3549
3549
|
*/
|
|
3550
3550
|
EventBusName?: string;
|
|
3551
3551
|
/**
|
|
3552
|
-
* @public
|
|
3553
3552
|
* <p>The IDs of the targets to remove from the rule.</p>
|
|
3553
|
+
* @public
|
|
3554
3554
|
*/
|
|
3555
3555
|
Ids: string[] | undefined;
|
|
3556
3556
|
/**
|
|
3557
|
-
* @public
|
|
3558
3557
|
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
|
|
3559
3558
|
* <code>Force</code> as <code>True</code> to remove targets. This parameter is ignored for
|
|
3560
3559
|
* rules that are not managed rules. You can check whether a rule is a managed rule by using
|
|
3561
3560
|
* <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code>
|
|
3562
3561
|
* field of the response.</p>
|
|
3562
|
+
* @public
|
|
3563
3563
|
*/
|
|
3564
3564
|
Force?: boolean;
|
|
3565
3565
|
}
|
|
3566
3566
|
/**
|
|
3567
|
-
* @public
|
|
3568
3567
|
* <p>Represents a target that failed to be removed from a rule.</p>
|
|
3568
|
+
* @public
|
|
3569
3569
|
*/
|
|
3570
3570
|
export interface RemoveTargetsResultEntry {
|
|
3571
3571
|
/**
|
|
3572
|
-
* @public
|
|
3573
3572
|
* <p>The ID of the target.</p>
|
|
3573
|
+
* @public
|
|
3574
3574
|
*/
|
|
3575
3575
|
TargetId?: string;
|
|
3576
3576
|
/**
|
|
3577
|
-
* @public
|
|
3578
3577
|
* <p>The error code that indicates why the target removal failed. If the value is
|
|
3579
3578
|
* <code>ConcurrentModificationException</code>, too many requests were made at the same
|
|
3580
3579
|
* time.</p>
|
|
3580
|
+
* @public
|
|
3581
3581
|
*/
|
|
3582
3582
|
ErrorCode?: string;
|
|
3583
3583
|
/**
|
|
3584
|
-
* @public
|
|
3585
3584
|
* <p>The error message that explains why the target removal failed.</p>
|
|
3585
|
+
* @public
|
|
3586
3586
|
*/
|
|
3587
3587
|
ErrorMessage?: string;
|
|
3588
3588
|
}
|
|
@@ -3591,13 +3591,13 @@ export interface RemoveTargetsResultEntry {
|
|
|
3591
3591
|
*/
|
|
3592
3592
|
export interface RemoveTargetsResponse {
|
|
3593
3593
|
/**
|
|
3594
|
-
* @public
|
|
3595
3594
|
* <p>The number of failed entries.</p>
|
|
3595
|
+
* @public
|
|
3596
3596
|
*/
|
|
3597
3597
|
FailedEntryCount?: number;
|
|
3598
3598
|
/**
|
|
3599
|
-
* @public
|
|
3600
3599
|
* <p>The failed target entries.</p>
|
|
3600
|
+
* @public
|
|
3601
3601
|
*/
|
|
3602
3602
|
FailedEntries?: RemoveTargetsResultEntry[];
|
|
3603
3603
|
}
|
|
@@ -3606,36 +3606,36 @@ export interface RemoveTargetsResponse {
|
|
|
3606
3606
|
*/
|
|
3607
3607
|
export interface StartReplayRequest {
|
|
3608
3608
|
/**
|
|
3609
|
-
* @public
|
|
3610
3609
|
* <p>The name of the replay to start.</p>
|
|
3610
|
+
* @public
|
|
3611
3611
|
*/
|
|
3612
3612
|
ReplayName: string | undefined;
|
|
3613
3613
|
/**
|
|
3614
|
-
* @public
|
|
3615
3614
|
* <p>A description for the replay to start.</p>
|
|
3615
|
+
* @public
|
|
3616
3616
|
*/
|
|
3617
3617
|
Description?: string;
|
|
3618
3618
|
/**
|
|
3619
|
-
* @public
|
|
3620
3619
|
* <p>The ARN of the archive to replay events from.</p>
|
|
3620
|
+
* @public
|
|
3621
3621
|
*/
|
|
3622
3622
|
EventSourceArn: string | undefined;
|
|
3623
3623
|
/**
|
|
3624
|
-
* @public
|
|
3625
3624
|
* <p>A time stamp for the time to start replaying events. Only events that occurred between the
|
|
3626
3625
|
* <code>EventStartTime</code> and <code>EventEndTime</code> are replayed.</p>
|
|
3626
|
+
* @public
|
|
3627
3627
|
*/
|
|
3628
3628
|
EventStartTime: Date | undefined;
|
|
3629
3629
|
/**
|
|
3630
|
-
* @public
|
|
3631
3630
|
* <p>A time stamp for the time to stop replaying events. Only events that occurred between the
|
|
3632
3631
|
* <code>EventStartTime</code> and <code>EventEndTime</code> are replayed.</p>
|
|
3632
|
+
* @public
|
|
3633
3633
|
*/
|
|
3634
3634
|
EventEndTime: Date | undefined;
|
|
3635
3635
|
/**
|
|
3636
|
-
* @public
|
|
3637
3636
|
* <p>A <code>ReplayDestination</code> object that includes details about the destination for
|
|
3638
3637
|
* the replay.</p>
|
|
3638
|
+
* @public
|
|
3639
3639
|
*/
|
|
3640
3640
|
Destination: ReplayDestination | undefined;
|
|
3641
3641
|
}
|
|
@@ -3644,23 +3644,23 @@ export interface StartReplayRequest {
|
|
|
3644
3644
|
*/
|
|
3645
3645
|
export interface StartReplayResponse {
|
|
3646
3646
|
/**
|
|
3647
|
-
* @public
|
|
3648
3647
|
* <p>The ARN of the replay.</p>
|
|
3648
|
+
* @public
|
|
3649
3649
|
*/
|
|
3650
3650
|
ReplayArn?: string;
|
|
3651
3651
|
/**
|
|
3652
|
-
* @public
|
|
3653
3652
|
* <p>The state of the replay.</p>
|
|
3653
|
+
* @public
|
|
3654
3654
|
*/
|
|
3655
3655
|
State?: ReplayState;
|
|
3656
3656
|
/**
|
|
3657
|
-
* @public
|
|
3658
3657
|
* <p>The reason that the replay is in the state.</p>
|
|
3658
|
+
* @public
|
|
3659
3659
|
*/
|
|
3660
3660
|
StateReason?: string;
|
|
3661
3661
|
/**
|
|
3662
|
-
* @public
|
|
3663
3662
|
* <p>The time at which the replay started.</p>
|
|
3663
|
+
* @public
|
|
3664
3664
|
*/
|
|
3665
3665
|
ReplayStartTime?: Date;
|
|
3666
3666
|
}
|
|
@@ -3669,13 +3669,13 @@ export interface StartReplayResponse {
|
|
|
3669
3669
|
*/
|
|
3670
3670
|
export interface TagResourceRequest {
|
|
3671
3671
|
/**
|
|
3672
|
-
* @public
|
|
3673
3672
|
* <p>The ARN of the EventBridge resource that you're adding tags to.</p>
|
|
3673
|
+
* @public
|
|
3674
3674
|
*/
|
|
3675
3675
|
ResourceARN: string | undefined;
|
|
3676
3676
|
/**
|
|
3677
|
-
* @public
|
|
3678
3677
|
* <p>The list of key-value pairs to associate with the resource.</p>
|
|
3678
|
+
* @public
|
|
3679
3679
|
*/
|
|
3680
3680
|
Tags: Tag[] | undefined;
|
|
3681
3681
|
}
|
|
@@ -3689,13 +3689,12 @@ export interface TagResourceResponse {
|
|
|
3689
3689
|
*/
|
|
3690
3690
|
export interface TestEventPatternRequest {
|
|
3691
3691
|
/**
|
|
3692
|
-
* @public
|
|
3693
3692
|
* <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
3694
3693
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
3694
|
+
* @public
|
|
3695
3695
|
*/
|
|
3696
3696
|
EventPattern: string | undefined;
|
|
3697
3697
|
/**
|
|
3698
|
-
* @public
|
|
3699
3698
|
* <p>The event, in JSON format, to test against the event pattern. The JSON must follow the
|
|
3700
3699
|
* format specified in <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html">Amazon Web Services Events</a>, and the following
|
|
3701
3700
|
* fields are mandatory:</p>
|
|
@@ -3736,6 +3735,7 @@ export interface TestEventPatternRequest {
|
|
|
3736
3735
|
* </p>
|
|
3737
3736
|
* </li>
|
|
3738
3737
|
* </ul>
|
|
3738
|
+
* @public
|
|
3739
3739
|
*/
|
|
3740
3740
|
Event: string | undefined;
|
|
3741
3741
|
}
|
|
@@ -3744,8 +3744,8 @@ export interface TestEventPatternRequest {
|
|
|
3744
3744
|
*/
|
|
3745
3745
|
export interface TestEventPatternResponse {
|
|
3746
3746
|
/**
|
|
3747
|
-
* @public
|
|
3748
3747
|
* <p>Indicates whether the event matches the event pattern.</p>
|
|
3748
|
+
* @public
|
|
3749
3749
|
*/
|
|
3750
3750
|
Result?: boolean;
|
|
3751
3751
|
}
|
|
@@ -3754,13 +3754,13 @@ export interface TestEventPatternResponse {
|
|
|
3754
3754
|
*/
|
|
3755
3755
|
export interface UntagResourceRequest {
|
|
3756
3756
|
/**
|
|
3757
|
-
* @public
|
|
3758
3757
|
* <p>The ARN of the EventBridge resource from which you are removing tags.</p>
|
|
3758
|
+
* @public
|
|
3759
3759
|
*/
|
|
3760
3760
|
ResourceARN: string | undefined;
|
|
3761
3761
|
/**
|
|
3762
|
-
* @public
|
|
3763
3762
|
* <p>The list of tag keys to remove from the resource.</p>
|
|
3763
|
+
* @public
|
|
3764
3764
|
*/
|
|
3765
3765
|
TagKeys: string[] | undefined;
|
|
3766
3766
|
}
|
|
@@ -3774,33 +3774,33 @@ export interface UntagResourceResponse {
|
|
|
3774
3774
|
*/
|
|
3775
3775
|
export interface UpdateApiDestinationRequest {
|
|
3776
3776
|
/**
|
|
3777
|
-
* @public
|
|
3778
3777
|
* <p>The name of the API destination to update.</p>
|
|
3778
|
+
* @public
|
|
3779
3779
|
*/
|
|
3780
3780
|
Name: string | undefined;
|
|
3781
3781
|
/**
|
|
3782
|
-
* @public
|
|
3783
3782
|
* <p>The name of the API destination to update.</p>
|
|
3783
|
+
* @public
|
|
3784
3784
|
*/
|
|
3785
3785
|
Description?: string;
|
|
3786
3786
|
/**
|
|
3787
|
-
* @public
|
|
3788
3787
|
* <p>The ARN of the connection to use for the API destination.</p>
|
|
3788
|
+
* @public
|
|
3789
3789
|
*/
|
|
3790
3790
|
ConnectionArn?: string;
|
|
3791
3791
|
/**
|
|
3792
|
-
* @public
|
|
3793
3792
|
* <p>The URL to the endpoint to use for the API destination.</p>
|
|
3793
|
+
* @public
|
|
3794
3794
|
*/
|
|
3795
3795
|
InvocationEndpoint?: string;
|
|
3796
3796
|
/**
|
|
3797
|
-
* @public
|
|
3798
3797
|
* <p>The method to use for the API destination.</p>
|
|
3798
|
+
* @public
|
|
3799
3799
|
*/
|
|
3800
3800
|
HttpMethod?: ApiDestinationHttpMethod;
|
|
3801
3801
|
/**
|
|
3802
|
-
* @public
|
|
3803
3802
|
* <p>The maximum number of invocations per second to send to the API destination.</p>
|
|
3803
|
+
* @public
|
|
3804
3804
|
*/
|
|
3805
3805
|
InvocationRateLimitPerSecond?: number;
|
|
3806
3806
|
}
|
|
@@ -3809,23 +3809,23 @@ export interface UpdateApiDestinationRequest {
|
|
|
3809
3809
|
*/
|
|
3810
3810
|
export interface UpdateApiDestinationResponse {
|
|
3811
3811
|
/**
|
|
3812
|
-
* @public
|
|
3813
3812
|
* <p>The ARN of the API destination that was updated.</p>
|
|
3813
|
+
* @public
|
|
3814
3814
|
*/
|
|
3815
3815
|
ApiDestinationArn?: string;
|
|
3816
3816
|
/**
|
|
3817
|
-
* @public
|
|
3818
3817
|
* <p>The state of the API destination that was updated.</p>
|
|
3818
|
+
* @public
|
|
3819
3819
|
*/
|
|
3820
3820
|
ApiDestinationState?: ApiDestinationState;
|
|
3821
3821
|
/**
|
|
3822
|
-
* @public
|
|
3823
3822
|
* <p>A time stamp for the time that the API destination was created.</p>
|
|
3823
|
+
* @public
|
|
3824
3824
|
*/
|
|
3825
3825
|
CreationTime?: Date;
|
|
3826
3826
|
/**
|
|
3827
|
-
* @public
|
|
3828
3827
|
* <p>A time stamp for the time that the API destination was last modified.</p>
|
|
3828
|
+
* @public
|
|
3829
3829
|
*/
|
|
3830
3830
|
LastModifiedTime?: Date;
|
|
3831
3831
|
}
|
|
@@ -3834,23 +3834,23 @@ export interface UpdateApiDestinationResponse {
|
|
|
3834
3834
|
*/
|
|
3835
3835
|
export interface UpdateArchiveRequest {
|
|
3836
3836
|
/**
|
|
3837
|
-
* @public
|
|
3838
3837
|
* <p>The name of the archive to update.</p>
|
|
3838
|
+
* @public
|
|
3839
3839
|
*/
|
|
3840
3840
|
ArchiveName: string | undefined;
|
|
3841
3841
|
/**
|
|
3842
|
-
* @public
|
|
3843
3842
|
* <p>The description for the archive.</p>
|
|
3843
|
+
* @public
|
|
3844
3844
|
*/
|
|
3845
3845
|
Description?: string;
|
|
3846
3846
|
/**
|
|
3847
|
-
* @public
|
|
3848
3847
|
* <p>The event pattern to use to filter events sent to the archive.</p>
|
|
3848
|
+
* @public
|
|
3849
3849
|
*/
|
|
3850
3850
|
EventPattern?: string;
|
|
3851
3851
|
/**
|
|
3852
|
-
* @public
|
|
3853
3852
|
* <p>The number of days to retain events in the archive.</p>
|
|
3853
|
+
* @public
|
|
3854
3854
|
*/
|
|
3855
3855
|
RetentionDays?: number;
|
|
3856
3856
|
}
|
|
@@ -3859,130 +3859,130 @@ export interface UpdateArchiveRequest {
|
|
|
3859
3859
|
*/
|
|
3860
3860
|
export interface UpdateArchiveResponse {
|
|
3861
3861
|
/**
|
|
3862
|
-
* @public
|
|
3863
3862
|
* <p>The ARN of the archive.</p>
|
|
3863
|
+
* @public
|
|
3864
3864
|
*/
|
|
3865
3865
|
ArchiveArn?: string;
|
|
3866
3866
|
/**
|
|
3867
|
-
* @public
|
|
3868
3867
|
* <p>The state of the archive.</p>
|
|
3868
|
+
* @public
|
|
3869
3869
|
*/
|
|
3870
3870
|
State?: ArchiveState;
|
|
3871
3871
|
/**
|
|
3872
|
-
* @public
|
|
3873
3872
|
* <p>The reason that the archive is in the current state.</p>
|
|
3873
|
+
* @public
|
|
3874
3874
|
*/
|
|
3875
3875
|
StateReason?: string;
|
|
3876
3876
|
/**
|
|
3877
|
-
* @public
|
|
3878
3877
|
* <p>The time at which the archive was updated.</p>
|
|
3878
|
+
* @public
|
|
3879
3879
|
*/
|
|
3880
3880
|
CreationTime?: Date;
|
|
3881
3881
|
}
|
|
3882
3882
|
/**
|
|
3883
|
-
* @public
|
|
3884
3883
|
* <p>Contains the API key authorization parameters to use to update the connection.</p>
|
|
3884
|
+
* @public
|
|
3885
3885
|
*/
|
|
3886
3886
|
export interface UpdateConnectionApiKeyAuthRequestParameters {
|
|
3887
3887
|
/**
|
|
3888
|
-
* @public
|
|
3889
3888
|
* <p>The name of the API key to use for authorization.</p>
|
|
3889
|
+
* @public
|
|
3890
3890
|
*/
|
|
3891
3891
|
ApiKeyName?: string;
|
|
3892
3892
|
/**
|
|
3893
|
-
* @public
|
|
3894
3893
|
* <p>The value associated with teh API key to use for authorization.</p>
|
|
3894
|
+
* @public
|
|
3895
3895
|
*/
|
|
3896
3896
|
ApiKeyValue?: string;
|
|
3897
3897
|
}
|
|
3898
3898
|
/**
|
|
3899
|
-
* @public
|
|
3900
3899
|
* <p>Contains the Basic authorization parameters for the connection.</p>
|
|
3900
|
+
* @public
|
|
3901
3901
|
*/
|
|
3902
3902
|
export interface UpdateConnectionBasicAuthRequestParameters {
|
|
3903
3903
|
/**
|
|
3904
|
-
* @public
|
|
3905
3904
|
* <p>The user name to use for Basic authorization.</p>
|
|
3905
|
+
* @public
|
|
3906
3906
|
*/
|
|
3907
3907
|
Username?: string;
|
|
3908
3908
|
/**
|
|
3909
|
-
* @public
|
|
3910
3909
|
* <p>The password associated with the user name to use for Basic authorization.</p>
|
|
3910
|
+
* @public
|
|
3911
3911
|
*/
|
|
3912
3912
|
Password?: string;
|
|
3913
3913
|
}
|
|
3914
3914
|
/**
|
|
3915
|
-
* @public
|
|
3916
3915
|
* <p>Contains the OAuth authorization parameters to use for the connection.</p>
|
|
3916
|
+
* @public
|
|
3917
3917
|
*/
|
|
3918
3918
|
export interface UpdateConnectionOAuthClientRequestParameters {
|
|
3919
3919
|
/**
|
|
3920
|
-
* @public
|
|
3921
3920
|
* <p>The client ID to use for OAuth authorization.</p>
|
|
3921
|
+
* @public
|
|
3922
3922
|
*/
|
|
3923
3923
|
ClientID?: string;
|
|
3924
3924
|
/**
|
|
3925
|
-
* @public
|
|
3926
3925
|
* <p>The client secret assciated with the client ID to use for OAuth authorization.</p>
|
|
3926
|
+
* @public
|
|
3927
3927
|
*/
|
|
3928
3928
|
ClientSecret?: string;
|
|
3929
3929
|
}
|
|
3930
3930
|
/**
|
|
3931
|
-
* @public
|
|
3932
3931
|
* <p>Contains the OAuth request parameters to use for the connection.</p>
|
|
3932
|
+
* @public
|
|
3933
3933
|
*/
|
|
3934
3934
|
export interface UpdateConnectionOAuthRequestParameters {
|
|
3935
3935
|
/**
|
|
3936
|
-
* @public
|
|
3937
3936
|
* <p>A <code>UpdateConnectionOAuthClientRequestParameters</code> object that contains the
|
|
3938
3937
|
* client parameters to use for the connection when OAuth is specified as the authorization
|
|
3939
3938
|
* type.</p>
|
|
3939
|
+
* @public
|
|
3940
3940
|
*/
|
|
3941
3941
|
ClientParameters?: UpdateConnectionOAuthClientRequestParameters;
|
|
3942
3942
|
/**
|
|
3943
|
-
* @public
|
|
3944
3943
|
* <p>The URL to the authorization endpoint when OAuth is specified as the authorization
|
|
3945
3944
|
* type.</p>
|
|
3945
|
+
* @public
|
|
3946
3946
|
*/
|
|
3947
3947
|
AuthorizationEndpoint?: string;
|
|
3948
3948
|
/**
|
|
3949
|
-
* @public
|
|
3950
3949
|
* <p>The method used to connect to the HTTP endpoint.</p>
|
|
3950
|
+
* @public
|
|
3951
3951
|
*/
|
|
3952
3952
|
HttpMethod?: ConnectionOAuthHttpMethod;
|
|
3953
3953
|
/**
|
|
3954
|
-
* @public
|
|
3955
3954
|
* <p>The additional HTTP parameters used for the OAuth authorization request.</p>
|
|
3955
|
+
* @public
|
|
3956
3956
|
*/
|
|
3957
3957
|
OAuthHttpParameters?: ConnectionHttpParameters;
|
|
3958
3958
|
}
|
|
3959
3959
|
/**
|
|
3960
|
-
* @public
|
|
3961
3960
|
* <p>Contains the additional parameters to use for the connection.</p>
|
|
3961
|
+
* @public
|
|
3962
3962
|
*/
|
|
3963
3963
|
export interface UpdateConnectionAuthRequestParameters {
|
|
3964
3964
|
/**
|
|
3965
|
-
* @public
|
|
3966
3965
|
* <p>A <code>UpdateConnectionBasicAuthRequestParameters</code> object that contains the
|
|
3967
3966
|
* authorization parameters for Basic authorization.</p>
|
|
3967
|
+
* @public
|
|
3968
3968
|
*/
|
|
3969
3969
|
BasicAuthParameters?: UpdateConnectionBasicAuthRequestParameters;
|
|
3970
3970
|
/**
|
|
3971
|
-
* @public
|
|
3972
3971
|
* <p>A <code>UpdateConnectionOAuthRequestParameters</code> object that contains the
|
|
3973
3972
|
* authorization parameters for OAuth authorization.</p>
|
|
3973
|
+
* @public
|
|
3974
3974
|
*/
|
|
3975
3975
|
OAuthParameters?: UpdateConnectionOAuthRequestParameters;
|
|
3976
3976
|
/**
|
|
3977
|
-
* @public
|
|
3978
3977
|
* <p>A <code>UpdateConnectionApiKeyAuthRequestParameters</code> object that contains the
|
|
3979
3978
|
* authorization parameters for API key authorization.</p>
|
|
3979
|
+
* @public
|
|
3980
3980
|
*/
|
|
3981
3981
|
ApiKeyAuthParameters?: UpdateConnectionApiKeyAuthRequestParameters;
|
|
3982
3982
|
/**
|
|
3983
|
-
* @public
|
|
3984
3983
|
* <p>A <code>ConnectionHttpParameters</code> object that contains the additional parameters to
|
|
3985
3984
|
* use for the connection.</p>
|
|
3985
|
+
* @public
|
|
3986
3986
|
*/
|
|
3987
3987
|
InvocationHttpParameters?: ConnectionHttpParameters;
|
|
3988
3988
|
}
|
|
@@ -3991,23 +3991,23 @@ export interface UpdateConnectionAuthRequestParameters {
|
|
|
3991
3991
|
*/
|
|
3992
3992
|
export interface UpdateConnectionRequest {
|
|
3993
3993
|
/**
|
|
3994
|
-
* @public
|
|
3995
3994
|
* <p>The name of the connection to update.</p>
|
|
3995
|
+
* @public
|
|
3996
3996
|
*/
|
|
3997
3997
|
Name: string | undefined;
|
|
3998
3998
|
/**
|
|
3999
|
-
* @public
|
|
4000
3999
|
* <p>A description for the connection.</p>
|
|
4000
|
+
* @public
|
|
4001
4001
|
*/
|
|
4002
4002
|
Description?: string;
|
|
4003
4003
|
/**
|
|
4004
|
-
* @public
|
|
4005
4004
|
* <p>The type of authorization to use for the connection.</p>
|
|
4005
|
+
* @public
|
|
4006
4006
|
*/
|
|
4007
4007
|
AuthorizationType?: ConnectionAuthorizationType;
|
|
4008
4008
|
/**
|
|
4009
|
-
* @public
|
|
4010
4009
|
* <p>The authorization parameters to use for the connection.</p>
|
|
4010
|
+
* @public
|
|
4011
4011
|
*/
|
|
4012
4012
|
AuthParameters?: UpdateConnectionAuthRequestParameters;
|
|
4013
4013
|
}
|
|
@@ -4016,28 +4016,28 @@ export interface UpdateConnectionRequest {
|
|
|
4016
4016
|
*/
|
|
4017
4017
|
export interface UpdateConnectionResponse {
|
|
4018
4018
|
/**
|
|
4019
|
-
* @public
|
|
4020
4019
|
* <p>The ARN of the connection that was updated.</p>
|
|
4020
|
+
* @public
|
|
4021
4021
|
*/
|
|
4022
4022
|
ConnectionArn?: string;
|
|
4023
4023
|
/**
|
|
4024
|
-
* @public
|
|
4025
4024
|
* <p>The state of the connection that was updated.</p>
|
|
4025
|
+
* @public
|
|
4026
4026
|
*/
|
|
4027
4027
|
ConnectionState?: ConnectionState;
|
|
4028
4028
|
/**
|
|
4029
|
-
* @public
|
|
4030
4029
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
4030
|
+
* @public
|
|
4031
4031
|
*/
|
|
4032
4032
|
CreationTime?: Date;
|
|
4033
4033
|
/**
|
|
4034
|
-
* @public
|
|
4035
4034
|
* <p>A time stamp for the time that the connection was last modified.</p>
|
|
4035
|
+
* @public
|
|
4036
4036
|
*/
|
|
4037
4037
|
LastModifiedTime?: Date;
|
|
4038
4038
|
/**
|
|
4039
|
-
* @public
|
|
4040
4039
|
* <p>A time stamp for the time that the connection was last authorized.</p>
|
|
4040
|
+
* @public
|
|
4041
4041
|
*/
|
|
4042
4042
|
LastAuthorizedTime?: Date;
|
|
4043
4043
|
}
|