@aws-sdk/client-eventbridge 3.534.0 → 3.540.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-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/EventBridge.d.ts +12 -1
- package/dist-types/EventBridgeClient.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/CreateEndpointCommand.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/DeleteEndpointCommand.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/DescribeEndpointCommand.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/ListEndpointsCommand.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/commands/UpdateEndpointCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +643 -643
- package/dist-types/ts3.4/EventBridge.d.ts +11 -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/CreateEndpointCommand.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/DeleteEndpointCommand.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/DescribeEndpointCommand.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/ListEndpointsCommand.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/commands/UpdateEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +41 -41
|
@@ -5,14 +5,14 @@ import { EventBridgeServiceException as __BaseException } from "./EventBridgeSer
|
|
|
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,65 +100,65 @@ 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
|
}
|
|
153
153
|
/**
|
|
154
|
-
* @public
|
|
155
154
|
* <p>Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.</p>
|
|
155
|
+
* @public
|
|
156
156
|
*/
|
|
157
157
|
export interface AppSyncParameters {
|
|
158
158
|
/**
|
|
159
|
-
* @public
|
|
160
159
|
* <p>The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.</p>
|
|
161
160
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/appsync/latest/devguide/graphql-architecture.html#graphql-operations">Operations</a> in the <i>AppSync User Guide</i>.</p>
|
|
161
|
+
* @public
|
|
162
162
|
*/
|
|
163
163
|
GraphQLOperation?: string;
|
|
164
164
|
}
|
|
@@ -179,49 +179,49 @@ export declare const ArchiveState: {
|
|
|
179
179
|
*/
|
|
180
180
|
export type ArchiveState = (typeof ArchiveState)[keyof typeof ArchiveState];
|
|
181
181
|
/**
|
|
182
|
-
* @public
|
|
183
182
|
* <p>An <code>Archive</code> object that contains details about an archive.</p>
|
|
183
|
+
* @public
|
|
184
184
|
*/
|
|
185
185
|
export interface Archive {
|
|
186
186
|
/**
|
|
187
|
-
* @public
|
|
188
187
|
* <p>The name of the archive.</p>
|
|
188
|
+
* @public
|
|
189
189
|
*/
|
|
190
190
|
ArchiveName?: string;
|
|
191
191
|
/**
|
|
192
|
-
* @public
|
|
193
192
|
* <p>The ARN of the event bus associated with the archive. Only events from this event bus are
|
|
194
193
|
* sent to the archive.</p>
|
|
194
|
+
* @public
|
|
195
195
|
*/
|
|
196
196
|
EventSourceArn?: string;
|
|
197
197
|
/**
|
|
198
|
-
* @public
|
|
199
198
|
* <p>The current state of the archive.</p>
|
|
199
|
+
* @public
|
|
200
200
|
*/
|
|
201
201
|
State?: ArchiveState;
|
|
202
202
|
/**
|
|
203
|
-
* @public
|
|
204
203
|
* <p>A description for the reason that the archive is in the current state.</p>
|
|
204
|
+
* @public
|
|
205
205
|
*/
|
|
206
206
|
StateReason?: string;
|
|
207
207
|
/**
|
|
208
|
-
* @public
|
|
209
208
|
* <p>The number of days to retain events in the archive before they are deleted.</p>
|
|
209
|
+
* @public
|
|
210
210
|
*/
|
|
211
211
|
RetentionDays?: number;
|
|
212
212
|
/**
|
|
213
|
-
* @public
|
|
214
213
|
* <p>The size of the archive, in bytes.</p>
|
|
214
|
+
* @public
|
|
215
215
|
*/
|
|
216
216
|
SizeBytes?: number;
|
|
217
217
|
/**
|
|
218
|
-
* @public
|
|
219
218
|
* <p>The number of events in the archive.</p>
|
|
219
|
+
* @public
|
|
220
220
|
*/
|
|
221
221
|
EventCount?: number;
|
|
222
222
|
/**
|
|
223
|
-
* @public
|
|
224
223
|
* <p>The time stamp for the time that the archive was created.</p>
|
|
224
|
+
* @public
|
|
225
225
|
*/
|
|
226
226
|
CreationTime?: Date;
|
|
227
227
|
}
|
|
@@ -242,8 +242,8 @@ export type AssignPublicIp = (typeof AssignPublicIp)[keyof typeof AssignPublicIp
|
|
|
242
242
|
*/
|
|
243
243
|
export interface CancelReplayRequest {
|
|
244
244
|
/**
|
|
245
|
-
* @public
|
|
246
245
|
* <p>The name of the replay to cancel.</p>
|
|
246
|
+
* @public
|
|
247
247
|
*/
|
|
248
248
|
ReplayName: string | undefined;
|
|
249
249
|
}
|
|
@@ -268,25 +268,25 @@ export type ReplayState = (typeof ReplayState)[keyof typeof ReplayState];
|
|
|
268
268
|
*/
|
|
269
269
|
export interface CancelReplayResponse {
|
|
270
270
|
/**
|
|
271
|
-
* @public
|
|
272
271
|
* <p>The ARN of the replay to cancel.</p>
|
|
272
|
+
* @public
|
|
273
273
|
*/
|
|
274
274
|
ReplayArn?: string;
|
|
275
275
|
/**
|
|
276
|
-
* @public
|
|
277
276
|
* <p>The current state of the replay.</p>
|
|
277
|
+
* @public
|
|
278
278
|
*/
|
|
279
279
|
State?: ReplayState;
|
|
280
280
|
/**
|
|
281
|
-
* @public
|
|
282
281
|
* <p>The reason that the replay is in the current state.</p>
|
|
282
|
+
* @public
|
|
283
283
|
*/
|
|
284
284
|
StateReason?: string;
|
|
285
285
|
}
|
|
286
286
|
/**
|
|
287
|
-
* @public
|
|
288
287
|
* <p>An error occurred because a replay can be canceled only when the state is Running or
|
|
289
288
|
* Starting.</p>
|
|
289
|
+
* @public
|
|
290
290
|
*/
|
|
291
291
|
export declare class IllegalStatusException extends __BaseException {
|
|
292
292
|
readonly name: "IllegalStatusException";
|
|
@@ -301,34 +301,34 @@ export declare class IllegalStatusException extends __BaseException {
|
|
|
301
301
|
*/
|
|
302
302
|
export interface CreateApiDestinationRequest {
|
|
303
303
|
/**
|
|
304
|
-
* @public
|
|
305
304
|
* <p>The name for the API destination to create.</p>
|
|
305
|
+
* @public
|
|
306
306
|
*/
|
|
307
307
|
Name: string | undefined;
|
|
308
308
|
/**
|
|
309
|
-
* @public
|
|
310
309
|
* <p>A description for the API destination to create.</p>
|
|
310
|
+
* @public
|
|
311
311
|
*/
|
|
312
312
|
Description?: string;
|
|
313
313
|
/**
|
|
314
|
-
* @public
|
|
315
314
|
* <p>The ARN of the connection to use for the API destination. The destination endpoint must
|
|
316
315
|
* support the authorization type specified for the connection.</p>
|
|
316
|
+
* @public
|
|
317
317
|
*/
|
|
318
318
|
ConnectionArn: string | undefined;
|
|
319
319
|
/**
|
|
320
|
-
* @public
|
|
321
320
|
* <p>The URL to the HTTP invocation endpoint for the API destination.</p>
|
|
321
|
+
* @public
|
|
322
322
|
*/
|
|
323
323
|
InvocationEndpoint: string | undefined;
|
|
324
324
|
/**
|
|
325
|
-
* @public
|
|
326
325
|
* <p>The method to use for the request to the HTTP invocation endpoint.</p>
|
|
326
|
+
* @public
|
|
327
327
|
*/
|
|
328
328
|
HttpMethod: ApiDestinationHttpMethod | undefined;
|
|
329
329
|
/**
|
|
330
|
-
* @public
|
|
331
330
|
* <p>The maximum number of requests per second to send to the HTTP invocation endpoint.</p>
|
|
331
|
+
* @public
|
|
332
332
|
*/
|
|
333
333
|
InvocationRateLimitPerSecond?: number;
|
|
334
334
|
}
|
|
@@ -337,30 +337,30 @@ export interface CreateApiDestinationRequest {
|
|
|
337
337
|
*/
|
|
338
338
|
export interface CreateApiDestinationResponse {
|
|
339
339
|
/**
|
|
340
|
-
* @public
|
|
341
340
|
* <p>The ARN of the API destination that was created by the request.</p>
|
|
341
|
+
* @public
|
|
342
342
|
*/
|
|
343
343
|
ApiDestinationArn?: string;
|
|
344
344
|
/**
|
|
345
|
-
* @public
|
|
346
345
|
* <p>The state of the API destination that was created by the request.</p>
|
|
346
|
+
* @public
|
|
347
347
|
*/
|
|
348
348
|
ApiDestinationState?: ApiDestinationState;
|
|
349
349
|
/**
|
|
350
|
-
* @public
|
|
351
350
|
* <p>A time stamp indicating the time that the API destination was created.</p>
|
|
351
|
+
* @public
|
|
352
352
|
*/
|
|
353
353
|
CreationTime?: Date;
|
|
354
354
|
/**
|
|
355
|
-
* @public
|
|
356
355
|
* <p>A time stamp indicating the time that the API destination was last modified.</p>
|
|
356
|
+
* @public
|
|
357
357
|
*/
|
|
358
358
|
LastModifiedTime?: Date;
|
|
359
359
|
}
|
|
360
360
|
/**
|
|
361
|
-
* @public
|
|
362
361
|
* <p>The request failed because it attempted to create resource beyond the allowed service
|
|
363
362
|
* quota.</p>
|
|
363
|
+
* @public
|
|
364
364
|
*/
|
|
365
365
|
export declare class LimitExceededException extends __BaseException {
|
|
366
366
|
readonly name: "LimitExceededException";
|
|
@@ -371,8 +371,8 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
371
371
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
372
372
|
}
|
|
373
373
|
/**
|
|
374
|
-
* @public
|
|
375
374
|
* <p>The resource you are trying to create already exists.</p>
|
|
375
|
+
* @public
|
|
376
376
|
*/
|
|
377
377
|
export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
378
378
|
readonly name: "ResourceAlreadyExistsException";
|
|
@@ -387,29 +387,29 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
387
387
|
*/
|
|
388
388
|
export interface CreateArchiveRequest {
|
|
389
389
|
/**
|
|
390
|
-
* @public
|
|
391
390
|
* <p>The name for the archive to create.</p>
|
|
391
|
+
* @public
|
|
392
392
|
*/
|
|
393
393
|
ArchiveName: string | undefined;
|
|
394
394
|
/**
|
|
395
|
-
* @public
|
|
396
395
|
* <p>The ARN of the event bus that sends events to the archive.</p>
|
|
396
|
+
* @public
|
|
397
397
|
*/
|
|
398
398
|
EventSourceArn: string | undefined;
|
|
399
399
|
/**
|
|
400
|
-
* @public
|
|
401
400
|
* <p>A description for the archive.</p>
|
|
401
|
+
* @public
|
|
402
402
|
*/
|
|
403
403
|
Description?: string;
|
|
404
404
|
/**
|
|
405
|
-
* @public
|
|
406
405
|
* <p>An event pattern to use to filter events sent to the archive.</p>
|
|
406
|
+
* @public
|
|
407
407
|
*/
|
|
408
408
|
EventPattern?: string;
|
|
409
409
|
/**
|
|
410
|
-
* @public
|
|
411
410
|
* <p>The number of days to retain events for. Default value is 0. If set to 0, events are
|
|
412
411
|
* retained indefinitely</p>
|
|
412
|
+
* @public
|
|
413
413
|
*/
|
|
414
414
|
RetentionDays?: number;
|
|
415
415
|
}
|
|
@@ -418,29 +418,29 @@ export interface CreateArchiveRequest {
|
|
|
418
418
|
*/
|
|
419
419
|
export interface CreateArchiveResponse {
|
|
420
420
|
/**
|
|
421
|
-
* @public
|
|
422
421
|
* <p>The ARN of the archive that was created.</p>
|
|
422
|
+
* @public
|
|
423
423
|
*/
|
|
424
424
|
ArchiveArn?: string;
|
|
425
425
|
/**
|
|
426
|
-
* @public
|
|
427
426
|
* <p>The state of the archive that was created.</p>
|
|
427
|
+
* @public
|
|
428
428
|
*/
|
|
429
429
|
State?: ArchiveState;
|
|
430
430
|
/**
|
|
431
|
-
* @public
|
|
432
431
|
* <p>The reason that the archive is in the state.</p>
|
|
432
|
+
* @public
|
|
433
433
|
*/
|
|
434
434
|
StateReason?: string;
|
|
435
435
|
/**
|
|
436
|
-
* @public
|
|
437
436
|
* <p>The time at which the archive was created.</p>
|
|
437
|
+
* @public
|
|
438
438
|
*/
|
|
439
439
|
CreationTime?: Date;
|
|
440
440
|
}
|
|
441
441
|
/**
|
|
442
|
-
* @public
|
|
443
442
|
* <p>The event pattern is not valid.</p>
|
|
443
|
+
* @public
|
|
444
444
|
*/
|
|
445
445
|
export declare class InvalidEventPatternException extends __BaseException {
|
|
446
446
|
readonly name: "InvalidEventPatternException";
|
|
@@ -464,139 +464,139 @@ export declare const ConnectionAuthorizationType: {
|
|
|
464
464
|
*/
|
|
465
465
|
export type ConnectionAuthorizationType = (typeof ConnectionAuthorizationType)[keyof typeof ConnectionAuthorizationType];
|
|
466
466
|
/**
|
|
467
|
-
* @public
|
|
468
467
|
* <p>Contains the API key authorization parameters for the connection.</p>
|
|
468
|
+
* @public
|
|
469
469
|
*/
|
|
470
470
|
export interface CreateConnectionApiKeyAuthRequestParameters {
|
|
471
471
|
/**
|
|
472
|
-
* @public
|
|
473
472
|
* <p>The name of the API key to use for authorization.</p>
|
|
473
|
+
* @public
|
|
474
474
|
*/
|
|
475
475
|
ApiKeyName: string | undefined;
|
|
476
476
|
/**
|
|
477
|
-
* @public
|
|
478
477
|
* <p>The value for the API key to use for authorization.</p>
|
|
478
|
+
* @public
|
|
479
479
|
*/
|
|
480
480
|
ApiKeyValue: string | undefined;
|
|
481
481
|
}
|
|
482
482
|
/**
|
|
483
|
-
* @public
|
|
484
483
|
* <p>Contains the Basic authorization parameters to use for the connection.</p>
|
|
484
|
+
* @public
|
|
485
485
|
*/
|
|
486
486
|
export interface CreateConnectionBasicAuthRequestParameters {
|
|
487
487
|
/**
|
|
488
|
-
* @public
|
|
489
488
|
* <p>The user name to use for Basic authorization.</p>
|
|
489
|
+
* @public
|
|
490
490
|
*/
|
|
491
491
|
Username: string | undefined;
|
|
492
492
|
/**
|
|
493
|
-
* @public
|
|
494
493
|
* <p>The password associated with the user name to use for Basic authorization.</p>
|
|
494
|
+
* @public
|
|
495
495
|
*/
|
|
496
496
|
Password: string | undefined;
|
|
497
497
|
}
|
|
498
498
|
/**
|
|
499
|
-
* @public
|
|
500
499
|
* <p>Additional parameter included in the body. You can include up to 100 additional body
|
|
501
500
|
* parameters per request. An event payload cannot exceed 64 KB.</p>
|
|
501
|
+
* @public
|
|
502
502
|
*/
|
|
503
503
|
export interface ConnectionBodyParameter {
|
|
504
504
|
/**
|
|
505
|
-
* @public
|
|
506
505
|
* <p>The key for the parameter.</p>
|
|
506
|
+
* @public
|
|
507
507
|
*/
|
|
508
508
|
Key?: string;
|
|
509
509
|
/**
|
|
510
|
-
* @public
|
|
511
510
|
* <p>The value associated with the key.</p>
|
|
511
|
+
* @public
|
|
512
512
|
*/
|
|
513
513
|
Value?: string;
|
|
514
514
|
/**
|
|
515
|
-
* @public
|
|
516
515
|
* <p>Specified whether the value is secret.</p>
|
|
516
|
+
* @public
|
|
517
517
|
*/
|
|
518
518
|
IsValueSecret?: boolean;
|
|
519
519
|
}
|
|
520
520
|
/**
|
|
521
|
-
* @public
|
|
522
521
|
* <p>Additional parameter included in the header. You can include up to 100 additional header
|
|
523
522
|
* parameters per request. An event payload cannot exceed 64 KB.</p>
|
|
523
|
+
* @public
|
|
524
524
|
*/
|
|
525
525
|
export interface ConnectionHeaderParameter {
|
|
526
526
|
/**
|
|
527
|
-
* @public
|
|
528
527
|
* <p>The key for the parameter.</p>
|
|
528
|
+
* @public
|
|
529
529
|
*/
|
|
530
530
|
Key?: string;
|
|
531
531
|
/**
|
|
532
|
-
* @public
|
|
533
532
|
* <p>The value associated with the key.</p>
|
|
533
|
+
* @public
|
|
534
534
|
*/
|
|
535
535
|
Value?: string;
|
|
536
536
|
/**
|
|
537
|
-
* @public
|
|
538
537
|
* <p>Specified whether the value is a secret.</p>
|
|
538
|
+
* @public
|
|
539
539
|
*/
|
|
540
540
|
IsValueSecret?: boolean;
|
|
541
541
|
}
|
|
542
542
|
/**
|
|
543
|
-
* @public
|
|
544
543
|
* <p>Additional query string parameter for the connection. You can include up to 100 additional
|
|
545
544
|
* query string parameters per request. Each additional parameter counts towards the event
|
|
546
545
|
* payload size, which cannot exceed 64 KB.</p>
|
|
546
|
+
* @public
|
|
547
547
|
*/
|
|
548
548
|
export interface ConnectionQueryStringParameter {
|
|
549
549
|
/**
|
|
550
|
-
* @public
|
|
551
550
|
* <p>The key for a query string parameter.</p>
|
|
551
|
+
* @public
|
|
552
552
|
*/
|
|
553
553
|
Key?: string;
|
|
554
554
|
/**
|
|
555
|
-
* @public
|
|
556
555
|
* <p>The value associated with the key for the query string parameter.</p>
|
|
556
|
+
* @public
|
|
557
557
|
*/
|
|
558
558
|
Value?: string;
|
|
559
559
|
/**
|
|
560
|
-
* @public
|
|
561
560
|
* <p>Specifies whether the value is secret.</p>
|
|
561
|
+
* @public
|
|
562
562
|
*/
|
|
563
563
|
IsValueSecret?: boolean;
|
|
564
564
|
}
|
|
565
565
|
/**
|
|
566
|
-
* @public
|
|
567
566
|
* <p>Contains additional parameters for the connection.</p>
|
|
567
|
+
* @public
|
|
568
568
|
*/
|
|
569
569
|
export interface ConnectionHttpParameters {
|
|
570
570
|
/**
|
|
571
|
-
* @public
|
|
572
571
|
* <p>Contains additional header parameters for the connection.</p>
|
|
572
|
+
* @public
|
|
573
573
|
*/
|
|
574
574
|
HeaderParameters?: ConnectionHeaderParameter[];
|
|
575
575
|
/**
|
|
576
|
-
* @public
|
|
577
576
|
* <p>Contains additional query string parameters for the connection.</p>
|
|
577
|
+
* @public
|
|
578
578
|
*/
|
|
579
579
|
QueryStringParameters?: ConnectionQueryStringParameter[];
|
|
580
580
|
/**
|
|
581
|
-
* @public
|
|
582
581
|
* <p>Contains additional body string parameters for the connection.</p>
|
|
582
|
+
* @public
|
|
583
583
|
*/
|
|
584
584
|
BodyParameters?: ConnectionBodyParameter[];
|
|
585
585
|
}
|
|
586
586
|
/**
|
|
587
|
-
* @public
|
|
588
587
|
* <p>Contains the Basic authorization parameters to use for the connection.</p>
|
|
588
|
+
* @public
|
|
589
589
|
*/
|
|
590
590
|
export interface CreateConnectionOAuthClientRequestParameters {
|
|
591
591
|
/**
|
|
592
|
-
* @public
|
|
593
592
|
* <p>The client ID to use for OAuth authorization for the connection.</p>
|
|
593
|
+
* @public
|
|
594
594
|
*/
|
|
595
595
|
ClientID: string | undefined;
|
|
596
596
|
/**
|
|
597
|
-
* @public
|
|
598
597
|
* <p>The client secret associated with the client ID to use for OAuth authorization for the
|
|
599
598
|
* connection.</p>
|
|
599
|
+
* @public
|
|
600
600
|
*/
|
|
601
601
|
ClientSecret: string | undefined;
|
|
602
602
|
}
|
|
@@ -614,63 +614,63 @@ export declare const ConnectionOAuthHttpMethod: {
|
|
|
614
614
|
*/
|
|
615
615
|
export type ConnectionOAuthHttpMethod = (typeof ConnectionOAuthHttpMethod)[keyof typeof ConnectionOAuthHttpMethod];
|
|
616
616
|
/**
|
|
617
|
-
* @public
|
|
618
617
|
* <p>Contains the OAuth authorization parameters to use for the connection.</p>
|
|
618
|
+
* @public
|
|
619
619
|
*/
|
|
620
620
|
export interface CreateConnectionOAuthRequestParameters {
|
|
621
621
|
/**
|
|
622
|
-
* @public
|
|
623
622
|
* <p>A <code>CreateConnectionOAuthClientRequestParameters</code> object that contains the
|
|
624
623
|
* client parameters for OAuth authorization.</p>
|
|
624
|
+
* @public
|
|
625
625
|
*/
|
|
626
626
|
ClientParameters: CreateConnectionOAuthClientRequestParameters | undefined;
|
|
627
627
|
/**
|
|
628
|
-
* @public
|
|
629
628
|
* <p>The URL to the authorization endpoint when OAuth is specified as the authorization
|
|
630
629
|
* type.</p>
|
|
630
|
+
* @public
|
|
631
631
|
*/
|
|
632
632
|
AuthorizationEndpoint: string | undefined;
|
|
633
633
|
/**
|
|
634
|
-
* @public
|
|
635
634
|
* <p>The method to use for the authorization request.</p>
|
|
635
|
+
* @public
|
|
636
636
|
*/
|
|
637
637
|
HttpMethod: ConnectionOAuthHttpMethod | undefined;
|
|
638
638
|
/**
|
|
639
|
-
* @public
|
|
640
639
|
* <p>A <code>ConnectionHttpParameters</code> object that contains details about the additional
|
|
641
640
|
* parameters to use for the connection.</p>
|
|
641
|
+
* @public
|
|
642
642
|
*/
|
|
643
643
|
OAuthHttpParameters?: ConnectionHttpParameters;
|
|
644
644
|
}
|
|
645
645
|
/**
|
|
646
|
-
* @public
|
|
647
646
|
* <p>Contains the authorization parameters for the connection.</p>
|
|
647
|
+
* @public
|
|
648
648
|
*/
|
|
649
649
|
export interface CreateConnectionAuthRequestParameters {
|
|
650
650
|
/**
|
|
651
|
-
* @public
|
|
652
651
|
* <p>A <code>CreateConnectionBasicAuthRequestParameters</code> object that contains the Basic
|
|
653
652
|
* authorization parameters to use for the connection.</p>
|
|
653
|
+
* @public
|
|
654
654
|
*/
|
|
655
655
|
BasicAuthParameters?: CreateConnectionBasicAuthRequestParameters;
|
|
656
656
|
/**
|
|
657
|
-
* @public
|
|
658
657
|
* <p>A <code>CreateConnectionOAuthRequestParameters</code> object that contains the OAuth
|
|
659
658
|
* authorization parameters to use for the connection.</p>
|
|
659
|
+
* @public
|
|
660
660
|
*/
|
|
661
661
|
OAuthParameters?: CreateConnectionOAuthRequestParameters;
|
|
662
662
|
/**
|
|
663
|
-
* @public
|
|
664
663
|
* <p>A <code>CreateConnectionApiKeyAuthRequestParameters</code> object that contains the API
|
|
665
664
|
* key authorization parameters to use for the connection.</p>
|
|
665
|
+
* @public
|
|
666
666
|
*/
|
|
667
667
|
ApiKeyAuthParameters?: CreateConnectionApiKeyAuthRequestParameters;
|
|
668
668
|
/**
|
|
669
|
-
* @public
|
|
670
669
|
* <p>A <code>ConnectionHttpParameters</code> object that contains the API key authorization
|
|
671
670
|
* parameters to use for the connection. Note that if you include additional parameters for the
|
|
672
671
|
* target of a rule via <code>HttpParameters</code>, including query strings, the parameters
|
|
673
672
|
* added for the connection take precedence.</p>
|
|
673
|
+
* @public
|
|
674
674
|
*/
|
|
675
675
|
InvocationHttpParameters?: ConnectionHttpParameters;
|
|
676
676
|
}
|
|
@@ -679,27 +679,27 @@ export interface CreateConnectionAuthRequestParameters {
|
|
|
679
679
|
*/
|
|
680
680
|
export interface CreateConnectionRequest {
|
|
681
681
|
/**
|
|
682
|
-
* @public
|
|
683
682
|
* <p>The name for the connection to create.</p>
|
|
683
|
+
* @public
|
|
684
684
|
*/
|
|
685
685
|
Name: string | undefined;
|
|
686
686
|
/**
|
|
687
|
-
* @public
|
|
688
687
|
* <p>A description for the connection to create.</p>
|
|
688
|
+
* @public
|
|
689
689
|
*/
|
|
690
690
|
Description?: string;
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>The type of authorization to use for the connection.</p>
|
|
694
693
|
* <note>
|
|
695
694
|
* <p>OAUTH tokens are refreshed when a 401 or 407 response is returned.</p>
|
|
696
695
|
* </note>
|
|
696
|
+
* @public
|
|
697
697
|
*/
|
|
698
698
|
AuthorizationType: ConnectionAuthorizationType | undefined;
|
|
699
699
|
/**
|
|
700
|
-
* @public
|
|
701
700
|
* <p>A <code>CreateConnectionAuthRequestParameters</code> object that contains the
|
|
702
701
|
* authorization parameters to use to authorize with the endpoint. </p>
|
|
702
|
+
* @public
|
|
703
703
|
*/
|
|
704
704
|
AuthParameters: CreateConnectionAuthRequestParameters | undefined;
|
|
705
705
|
}
|
|
@@ -725,34 +725,34 @@ export type ConnectionState = (typeof ConnectionState)[keyof typeof ConnectionSt
|
|
|
725
725
|
*/
|
|
726
726
|
export interface CreateConnectionResponse {
|
|
727
727
|
/**
|
|
728
|
-
* @public
|
|
729
728
|
* <p>The ARN of the connection that was created by the request.</p>
|
|
729
|
+
* @public
|
|
730
730
|
*/
|
|
731
731
|
ConnectionArn?: string;
|
|
732
732
|
/**
|
|
733
|
-
* @public
|
|
734
733
|
* <p>The state of the connection that was created by the request.</p>
|
|
734
|
+
* @public
|
|
735
735
|
*/
|
|
736
736
|
ConnectionState?: ConnectionState;
|
|
737
737
|
/**
|
|
738
|
-
* @public
|
|
739
738
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
739
|
+
* @public
|
|
740
740
|
*/
|
|
741
741
|
CreationTime?: Date;
|
|
742
742
|
/**
|
|
743
|
-
* @public
|
|
744
743
|
* <p>A time stamp for the time that the connection was last updated.</p>
|
|
744
|
+
* @public
|
|
745
745
|
*/
|
|
746
746
|
LastModifiedTime?: Date;
|
|
747
747
|
}
|
|
748
748
|
/**
|
|
749
|
-
* @public
|
|
750
749
|
* <p>The event buses the endpoint is associated with.</p>
|
|
750
|
+
* @public
|
|
751
751
|
*/
|
|
752
752
|
export interface EndpointEventBus {
|
|
753
753
|
/**
|
|
754
|
-
* @public
|
|
755
754
|
* <p>The ARN of the event bus the endpoint is associated with.</p>
|
|
755
|
+
* @public
|
|
756
756
|
*/
|
|
757
757
|
EventBusArn: string | undefined;
|
|
758
758
|
}
|
|
@@ -769,62 +769,62 @@ export declare const ReplicationState: {
|
|
|
769
769
|
*/
|
|
770
770
|
export type ReplicationState = (typeof ReplicationState)[keyof typeof ReplicationState];
|
|
771
771
|
/**
|
|
772
|
-
* @public
|
|
773
772
|
* <p>Endpoints can replicate all events to the secondary Region.</p>
|
|
773
|
+
* @public
|
|
774
774
|
*/
|
|
775
775
|
export interface ReplicationConfig {
|
|
776
776
|
/**
|
|
777
|
-
* @public
|
|
778
777
|
* <p>The state of event replication.</p>
|
|
778
|
+
* @public
|
|
779
779
|
*/
|
|
780
780
|
State?: ReplicationState;
|
|
781
781
|
}
|
|
782
782
|
/**
|
|
783
|
-
* @public
|
|
784
783
|
* <p>The primary Region of the endpoint.</p>
|
|
784
|
+
* @public
|
|
785
785
|
*/
|
|
786
786
|
export interface Primary {
|
|
787
787
|
/**
|
|
788
|
-
* @public
|
|
789
788
|
* <p>The ARN of the health check used by the endpoint to determine whether failover is triggered.</p>
|
|
789
|
+
* @public
|
|
790
790
|
*/
|
|
791
791
|
HealthCheck: string | undefined;
|
|
792
792
|
}
|
|
793
793
|
/**
|
|
794
|
-
* @public
|
|
795
794
|
* <p>The secondary Region that processes events when failover is triggered or replication is enabled.</p>
|
|
795
|
+
* @public
|
|
796
796
|
*/
|
|
797
797
|
export interface Secondary {
|
|
798
798
|
/**
|
|
799
|
-
* @public
|
|
800
799
|
* <p>Defines the secondary Region.</p>
|
|
800
|
+
* @public
|
|
801
801
|
*/
|
|
802
802
|
Route: string | undefined;
|
|
803
803
|
}
|
|
804
804
|
/**
|
|
805
|
-
* @public
|
|
806
805
|
* <p>The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.</p>
|
|
806
|
+
* @public
|
|
807
807
|
*/
|
|
808
808
|
export interface FailoverConfig {
|
|
809
809
|
/**
|
|
810
|
-
* @public
|
|
811
810
|
* <p>The main Region of the endpoint.</p>
|
|
811
|
+
* @public
|
|
812
812
|
*/
|
|
813
813
|
Primary: Primary | undefined;
|
|
814
814
|
/**
|
|
815
|
-
* @public
|
|
816
815
|
* <p>The Region that events are routed to when failover is triggered or event replication is enabled.</p>
|
|
816
|
+
* @public
|
|
817
817
|
*/
|
|
818
818
|
Secondary: Secondary | undefined;
|
|
819
819
|
}
|
|
820
820
|
/**
|
|
821
|
-
* @public
|
|
822
821
|
* <p>The routing configuration of the endpoint.</p>
|
|
822
|
+
* @public
|
|
823
823
|
*/
|
|
824
824
|
export interface RoutingConfig {
|
|
825
825
|
/**
|
|
826
|
-
* @public
|
|
827
826
|
* <p>The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.</p>
|
|
827
|
+
* @public
|
|
828
828
|
*/
|
|
829
829
|
FailoverConfig: FailoverConfig | undefined;
|
|
830
830
|
}
|
|
@@ -833,37 +833,37 @@ export interface RoutingConfig {
|
|
|
833
833
|
*/
|
|
834
834
|
export interface CreateEndpointRequest {
|
|
835
835
|
/**
|
|
836
|
-
* @public
|
|
837
836
|
* <p>The name of the global endpoint. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.</p>
|
|
837
|
+
* @public
|
|
838
838
|
*/
|
|
839
839
|
Name: string | undefined;
|
|
840
840
|
/**
|
|
841
|
-
* @public
|
|
842
841
|
* <p>A description of the global endpoint.</p>
|
|
842
|
+
* @public
|
|
843
843
|
*/
|
|
844
844
|
Description?: string;
|
|
845
845
|
/**
|
|
846
|
-
* @public
|
|
847
846
|
* <p>Configure the routing policy, including the health check and secondary Region..</p>
|
|
847
|
+
* @public
|
|
848
848
|
*/
|
|
849
849
|
RoutingConfig: RoutingConfig | undefined;
|
|
850
850
|
/**
|
|
851
|
-
* @public
|
|
852
851
|
* <p>Enable or disable event replication. The default state is <code>ENABLED</code> which means you must supply a <code>RoleArn</code>. If you don't have a
|
|
853
852
|
* <code>RoleArn</code> or you don't want event replication enabled, set the state to <code>DISABLED</code>.</p>
|
|
853
|
+
* @public
|
|
854
854
|
*/
|
|
855
855
|
ReplicationConfig?: ReplicationConfig;
|
|
856
856
|
/**
|
|
857
|
-
* @public
|
|
858
857
|
* <p>Define the event buses used. </p>
|
|
859
858
|
* <important>
|
|
860
859
|
* <p>The names of the event buses must be identical in each Region.</p>
|
|
861
860
|
* </important>
|
|
861
|
+
* @public
|
|
862
862
|
*/
|
|
863
863
|
EventBuses: EndpointEventBus[] | undefined;
|
|
864
864
|
/**
|
|
865
|
-
* @public
|
|
866
865
|
* <p>The ARN of the role used for replication.</p>
|
|
866
|
+
* @public
|
|
867
867
|
*/
|
|
868
868
|
RoleArn?: string;
|
|
869
869
|
}
|
|
@@ -889,56 +889,56 @@ export type EndpointState = (typeof EndpointState)[keyof typeof EndpointState];
|
|
|
889
889
|
*/
|
|
890
890
|
export interface CreateEndpointResponse {
|
|
891
891
|
/**
|
|
892
|
-
* @public
|
|
893
892
|
* <p>The name of the endpoint that was created by this request.</p>
|
|
893
|
+
* @public
|
|
894
894
|
*/
|
|
895
895
|
Name?: string;
|
|
896
896
|
/**
|
|
897
|
-
* @public
|
|
898
897
|
* <p>The ARN of the endpoint that was created by this request.</p>
|
|
898
|
+
* @public
|
|
899
899
|
*/
|
|
900
900
|
Arn?: string;
|
|
901
901
|
/**
|
|
902
|
-
* @public
|
|
903
902
|
* <p>The routing configuration defined by this request.</p>
|
|
903
|
+
* @public
|
|
904
904
|
*/
|
|
905
905
|
RoutingConfig?: RoutingConfig;
|
|
906
906
|
/**
|
|
907
|
-
* @public
|
|
908
907
|
* <p>Whether event replication was enabled or disabled by this request.</p>
|
|
908
|
+
* @public
|
|
909
909
|
*/
|
|
910
910
|
ReplicationConfig?: ReplicationConfig;
|
|
911
911
|
/**
|
|
912
|
-
* @public
|
|
913
912
|
* <p>The event buses used by this request.</p>
|
|
913
|
+
* @public
|
|
914
914
|
*/
|
|
915
915
|
EventBuses?: EndpointEventBus[];
|
|
916
916
|
/**
|
|
917
|
-
* @public
|
|
918
917
|
* <p>The ARN of the role used by event replication for this request.</p>
|
|
918
|
+
* @public
|
|
919
919
|
*/
|
|
920
920
|
RoleArn?: string;
|
|
921
921
|
/**
|
|
922
|
-
* @public
|
|
923
922
|
* <p>The state of the endpoint that was created by this request.</p>
|
|
923
|
+
* @public
|
|
924
924
|
*/
|
|
925
925
|
State?: EndpointState;
|
|
926
926
|
}
|
|
927
927
|
/**
|
|
928
|
-
* @public
|
|
929
928
|
* <p>A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses
|
|
930
929
|
* support tagging.</p>
|
|
930
|
+
* @public
|
|
931
931
|
*/
|
|
932
932
|
export interface Tag {
|
|
933
933
|
/**
|
|
934
|
-
* @public
|
|
935
934
|
* <p>A string you can use to assign a value. The combination of tag keys and values can help
|
|
936
935
|
* you organize and categorize your resources.</p>
|
|
936
|
+
* @public
|
|
937
937
|
*/
|
|
938
938
|
Key: string | undefined;
|
|
939
939
|
/**
|
|
940
|
-
* @public
|
|
941
940
|
* <p>The value for the specified tag key.</p>
|
|
941
|
+
* @public
|
|
942
942
|
*/
|
|
943
943
|
Value: string | undefined;
|
|
944
944
|
}
|
|
@@ -947,23 +947,23 @@ export interface Tag {
|
|
|
947
947
|
*/
|
|
948
948
|
export interface CreateEventBusRequest {
|
|
949
949
|
/**
|
|
950
|
-
* @public
|
|
951
950
|
* <p>The name of the new event bus. </p>
|
|
952
951
|
* <p>Custom event bus names can't contain the <code>/</code> character, but you can use the <code>/</code> character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event
|
|
953
952
|
* source that this event bus is matched to.</p>
|
|
954
953
|
* <p>You can't use the name <code>default</code> for a custom event bus, as this name is already used for your account's
|
|
955
954
|
* default event bus.</p>
|
|
955
|
+
* @public
|
|
956
956
|
*/
|
|
957
957
|
Name: string | undefined;
|
|
958
958
|
/**
|
|
959
|
-
* @public
|
|
960
959
|
* <p>If you are creating a partner event bus, this specifies the partner event source that the
|
|
961
960
|
* new event bus will be matched with.</p>
|
|
961
|
+
* @public
|
|
962
962
|
*/
|
|
963
963
|
EventSourceName?: string;
|
|
964
964
|
/**
|
|
965
|
-
* @public
|
|
966
965
|
* <p>Tags to associate with the event bus.</p>
|
|
966
|
+
* @public
|
|
967
967
|
*/
|
|
968
968
|
Tags?: Tag[];
|
|
969
969
|
}
|
|
@@ -972,8 +972,8 @@ export interface CreateEventBusRequest {
|
|
|
972
972
|
*/
|
|
973
973
|
export interface CreateEventBusResponse {
|
|
974
974
|
/**
|
|
975
|
-
* @public
|
|
976
975
|
* <p>The ARN of the new event bus.</p>
|
|
976
|
+
* @public
|
|
977
977
|
*/
|
|
978
978
|
EventBusArn?: string;
|
|
979
979
|
}
|
|
@@ -982,19 +982,19 @@ export interface CreateEventBusResponse {
|
|
|
982
982
|
*/
|
|
983
983
|
export interface CreatePartnerEventSourceRequest {
|
|
984
984
|
/**
|
|
985
|
-
* @public
|
|
986
985
|
* <p>The name of the partner event source. This name must be unique and must be in the format
|
|
987
986
|
* <code>
|
|
988
987
|
* <i>partner_name</i>/<i>event_namespace</i>/<i>event_name</i>
|
|
989
988
|
* </code>.
|
|
990
989
|
* The Amazon Web Services account that wants to use this partner event source must create a partner event bus
|
|
991
990
|
* with a name that matches the name of the partner event source.</p>
|
|
991
|
+
* @public
|
|
992
992
|
*/
|
|
993
993
|
Name: string | undefined;
|
|
994
994
|
/**
|
|
995
|
-
* @public
|
|
996
995
|
* <p>The Amazon Web Services account ID that is permitted to create a matching partner event bus for this
|
|
997
996
|
* partner event source.</p>
|
|
997
|
+
* @public
|
|
998
998
|
*/
|
|
999
999
|
Account: string | undefined;
|
|
1000
1000
|
}
|
|
@@ -1003,8 +1003,8 @@ export interface CreatePartnerEventSourceRequest {
|
|
|
1003
1003
|
*/
|
|
1004
1004
|
export interface CreatePartnerEventSourceResponse {
|
|
1005
1005
|
/**
|
|
1006
|
-
* @public
|
|
1007
1006
|
* <p>The ARN of the partner event source.</p>
|
|
1007
|
+
* @public
|
|
1008
1008
|
*/
|
|
1009
1009
|
EventSourceArn?: string;
|
|
1010
1010
|
}
|
|
@@ -1013,8 +1013,8 @@ export interface CreatePartnerEventSourceResponse {
|
|
|
1013
1013
|
*/
|
|
1014
1014
|
export interface DeactivateEventSourceRequest {
|
|
1015
1015
|
/**
|
|
1016
|
-
* @public
|
|
1017
1016
|
* <p>The name of the partner event source to deactivate.</p>
|
|
1017
|
+
* @public
|
|
1018
1018
|
*/
|
|
1019
1019
|
Name: string | undefined;
|
|
1020
1020
|
}
|
|
@@ -1023,8 +1023,8 @@ export interface DeactivateEventSourceRequest {
|
|
|
1023
1023
|
*/
|
|
1024
1024
|
export interface DeauthorizeConnectionRequest {
|
|
1025
1025
|
/**
|
|
1026
|
-
* @public
|
|
1027
1026
|
* <p>The name of the connection to remove authorization from.</p>
|
|
1027
|
+
* @public
|
|
1028
1028
|
*/
|
|
1029
1029
|
Name: string | undefined;
|
|
1030
1030
|
}
|
|
@@ -1033,28 +1033,28 @@ export interface DeauthorizeConnectionRequest {
|
|
|
1033
1033
|
*/
|
|
1034
1034
|
export interface DeauthorizeConnectionResponse {
|
|
1035
1035
|
/**
|
|
1036
|
-
* @public
|
|
1037
1036
|
* <p>The ARN of the connection that authorization was removed from.</p>
|
|
1037
|
+
* @public
|
|
1038
1038
|
*/
|
|
1039
1039
|
ConnectionArn?: string;
|
|
1040
1040
|
/**
|
|
1041
|
-
* @public
|
|
1042
1041
|
* <p>The state of the connection.</p>
|
|
1042
|
+
* @public
|
|
1043
1043
|
*/
|
|
1044
1044
|
ConnectionState?: ConnectionState;
|
|
1045
1045
|
/**
|
|
1046
|
-
* @public
|
|
1047
1046
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
1047
|
+
* @public
|
|
1048
1048
|
*/
|
|
1049
1049
|
CreationTime?: Date;
|
|
1050
1050
|
/**
|
|
1051
|
-
* @public
|
|
1052
1051
|
* <p>A time stamp for the time that the connection was last updated.</p>
|
|
1052
|
+
* @public
|
|
1053
1053
|
*/
|
|
1054
1054
|
LastModifiedTime?: Date;
|
|
1055
1055
|
/**
|
|
1056
|
-
* @public
|
|
1057
1056
|
* <p>A time stamp for the time that the connection was last authorized.</p>
|
|
1057
|
+
* @public
|
|
1058
1058
|
*/
|
|
1059
1059
|
LastAuthorizedTime?: Date;
|
|
1060
1060
|
}
|
|
@@ -1063,8 +1063,8 @@ export interface DeauthorizeConnectionResponse {
|
|
|
1063
1063
|
*/
|
|
1064
1064
|
export interface DeleteApiDestinationRequest {
|
|
1065
1065
|
/**
|
|
1066
|
-
* @public
|
|
1067
1066
|
* <p>The name of the destination to delete.</p>
|
|
1067
|
+
* @public
|
|
1068
1068
|
*/
|
|
1069
1069
|
Name: string | undefined;
|
|
1070
1070
|
}
|
|
@@ -1078,8 +1078,8 @@ export interface DeleteApiDestinationResponse {
|
|
|
1078
1078
|
*/
|
|
1079
1079
|
export interface DeleteArchiveRequest {
|
|
1080
1080
|
/**
|
|
1081
|
-
* @public
|
|
1082
1081
|
* <p>The name of the archive to delete.</p>
|
|
1082
|
+
* @public
|
|
1083
1083
|
*/
|
|
1084
1084
|
ArchiveName: string | undefined;
|
|
1085
1085
|
}
|
|
@@ -1093,8 +1093,8 @@ export interface DeleteArchiveResponse {
|
|
|
1093
1093
|
*/
|
|
1094
1094
|
export interface DeleteConnectionRequest {
|
|
1095
1095
|
/**
|
|
1096
|
-
* @public
|
|
1097
1096
|
* <p>The name of the connection to delete.</p>
|
|
1097
|
+
* @public
|
|
1098
1098
|
*/
|
|
1099
1099
|
Name: string | undefined;
|
|
1100
1100
|
}
|
|
@@ -1103,30 +1103,30 @@ export interface DeleteConnectionRequest {
|
|
|
1103
1103
|
*/
|
|
1104
1104
|
export interface DeleteConnectionResponse {
|
|
1105
1105
|
/**
|
|
1106
|
-
* @public
|
|
1107
1106
|
* <p>The ARN of the connection that was deleted.</p>
|
|
1107
|
+
* @public
|
|
1108
1108
|
*/
|
|
1109
1109
|
ConnectionArn?: string;
|
|
1110
1110
|
/**
|
|
1111
|
-
* @public
|
|
1112
1111
|
* <p>The state of the connection before it was deleted.</p>
|
|
1112
|
+
* @public
|
|
1113
1113
|
*/
|
|
1114
1114
|
ConnectionState?: ConnectionState;
|
|
1115
1115
|
/**
|
|
1116
|
-
* @public
|
|
1117
1116
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
1117
|
+
* @public
|
|
1118
1118
|
*/
|
|
1119
1119
|
CreationTime?: Date;
|
|
1120
1120
|
/**
|
|
1121
|
-
* @public
|
|
1122
1121
|
* <p>A time stamp for the time that the connection was last modified before it was
|
|
1123
1122
|
* deleted.</p>
|
|
1123
|
+
* @public
|
|
1124
1124
|
*/
|
|
1125
1125
|
LastModifiedTime?: Date;
|
|
1126
1126
|
/**
|
|
1127
|
-
* @public
|
|
1128
1127
|
* <p>A time stamp for the time that the connection was last authorized before it wa
|
|
1129
1128
|
* deleted.</p>
|
|
1129
|
+
* @public
|
|
1130
1130
|
*/
|
|
1131
1131
|
LastAuthorizedTime?: Date;
|
|
1132
1132
|
}
|
|
@@ -1135,8 +1135,8 @@ export interface DeleteConnectionResponse {
|
|
|
1135
1135
|
*/
|
|
1136
1136
|
export interface DeleteEndpointRequest {
|
|
1137
1137
|
/**
|
|
1138
|
-
* @public
|
|
1139
1138
|
* <p>The name of the endpoint you want to delete. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>..</p>
|
|
1139
|
+
* @public
|
|
1140
1140
|
*/
|
|
1141
1141
|
Name: string | undefined;
|
|
1142
1142
|
}
|
|
@@ -1150,8 +1150,8 @@ export interface DeleteEndpointResponse {
|
|
|
1150
1150
|
*/
|
|
1151
1151
|
export interface DeleteEventBusRequest {
|
|
1152
1152
|
/**
|
|
1153
|
-
* @public
|
|
1154
1153
|
* <p>The name of the event bus to delete.</p>
|
|
1154
|
+
* @public
|
|
1155
1155
|
*/
|
|
1156
1156
|
Name: string | undefined;
|
|
1157
1157
|
}
|
|
@@ -1160,13 +1160,13 @@ export interface DeleteEventBusRequest {
|
|
|
1160
1160
|
*/
|
|
1161
1161
|
export interface DeletePartnerEventSourceRequest {
|
|
1162
1162
|
/**
|
|
1163
|
-
* @public
|
|
1164
1163
|
* <p>The name of the event source to delete.</p>
|
|
1164
|
+
* @public
|
|
1165
1165
|
*/
|
|
1166
1166
|
Name: string | undefined;
|
|
1167
1167
|
/**
|
|
1168
|
-
* @public
|
|
1169
1168
|
* <p>The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.</p>
|
|
1169
|
+
* @public
|
|
1170
1170
|
*/
|
|
1171
1171
|
Account: string | undefined;
|
|
1172
1172
|
}
|
|
@@ -1175,34 +1175,34 @@ export interface DeletePartnerEventSourceRequest {
|
|
|
1175
1175
|
*/
|
|
1176
1176
|
export interface DeleteRuleRequest {
|
|
1177
1177
|
/**
|
|
1178
|
-
* @public
|
|
1179
1178
|
* <p>The name of the rule.</p>
|
|
1179
|
+
* @public
|
|
1180
1180
|
*/
|
|
1181
1181
|
Name: string | undefined;
|
|
1182
1182
|
/**
|
|
1183
|
-
* @public
|
|
1184
1183
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
1185
1184
|
* event bus is used.</p>
|
|
1185
|
+
* @public
|
|
1186
1186
|
*/
|
|
1187
1187
|
EventBusName?: string;
|
|
1188
1188
|
/**
|
|
1189
|
-
* @public
|
|
1190
1189
|
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
|
|
1191
1190
|
* <code>Force</code> as <code>True</code> to delete the rule. This parameter is ignored for
|
|
1192
1191
|
* rules that are not managed rules. You can check whether a rule is a managed rule by using
|
|
1193
1192
|
* <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code>
|
|
1194
1193
|
* field of the response.</p>
|
|
1194
|
+
* @public
|
|
1195
1195
|
*/
|
|
1196
1196
|
Force?: boolean;
|
|
1197
1197
|
}
|
|
1198
1198
|
/**
|
|
1199
|
-
* @public
|
|
1200
1199
|
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that
|
|
1201
1200
|
* service. If you see this error in response to <code>DeleteRule</code> or
|
|
1202
1201
|
* <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to
|
|
1203
1202
|
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
|
|
1204
1203
|
* using <code>DisableRule</code>, <code>EnableRule</code>, <code>PutTargets</code>,
|
|
1205
1204
|
* <code>PutRule</code>, <code>TagResource</code>, or <code>UntagResource</code>. </p>
|
|
1205
|
+
* @public
|
|
1206
1206
|
*/
|
|
1207
1207
|
export declare class ManagedRuleException extends __BaseException {
|
|
1208
1208
|
readonly name: "ManagedRuleException";
|
|
@@ -1217,8 +1217,8 @@ export declare class ManagedRuleException extends __BaseException {
|
|
|
1217
1217
|
*/
|
|
1218
1218
|
export interface DescribeApiDestinationRequest {
|
|
1219
1219
|
/**
|
|
1220
|
-
* @public
|
|
1221
1220
|
* <p>The name of the API destination to retrieve.</p>
|
|
1221
|
+
* @public
|
|
1222
1222
|
*/
|
|
1223
1223
|
Name: string | undefined;
|
|
1224
1224
|
}
|
|
@@ -1227,58 +1227,58 @@ export interface DescribeApiDestinationRequest {
|
|
|
1227
1227
|
*/
|
|
1228
1228
|
export interface DescribeApiDestinationResponse {
|
|
1229
1229
|
/**
|
|
1230
|
-
* @public
|
|
1231
1230
|
* <p>The ARN of the API destination retrieved.</p>
|
|
1231
|
+
* @public
|
|
1232
1232
|
*/
|
|
1233
1233
|
ApiDestinationArn?: string;
|
|
1234
1234
|
/**
|
|
1235
|
-
* @public
|
|
1236
1235
|
* <p>The name of the API destination retrieved.</p>
|
|
1236
|
+
* @public
|
|
1237
1237
|
*/
|
|
1238
1238
|
Name?: string;
|
|
1239
1239
|
/**
|
|
1240
|
-
* @public
|
|
1241
1240
|
* <p>The description for the API destination retrieved.</p>
|
|
1241
|
+
* @public
|
|
1242
1242
|
*/
|
|
1243
1243
|
Description?: string;
|
|
1244
1244
|
/**
|
|
1245
|
-
* @public
|
|
1246
1245
|
* <p>The state of the API destination retrieved.</p>
|
|
1246
|
+
* @public
|
|
1247
1247
|
*/
|
|
1248
1248
|
ApiDestinationState?: ApiDestinationState;
|
|
1249
1249
|
/**
|
|
1250
|
-
* @public
|
|
1251
1250
|
* <p>The ARN of the connection specified for the API destination retrieved.</p>
|
|
1251
|
+
* @public
|
|
1252
1252
|
*/
|
|
1253
1253
|
ConnectionArn?: string;
|
|
1254
1254
|
/**
|
|
1255
|
-
* @public
|
|
1256
1255
|
* <p>The URL to use to connect to the HTTP endpoint.</p>
|
|
1256
|
+
* @public
|
|
1257
1257
|
*/
|
|
1258
1258
|
InvocationEndpoint?: string;
|
|
1259
1259
|
/**
|
|
1260
|
-
* @public
|
|
1261
1260
|
* <p>The method to use to connect to the HTTP endpoint.</p>
|
|
1261
|
+
* @public
|
|
1262
1262
|
*/
|
|
1263
1263
|
HttpMethod?: ApiDestinationHttpMethod;
|
|
1264
1264
|
/**
|
|
1265
|
-
* @public
|
|
1266
1265
|
* <p>The maximum number of invocations per second to specified for the API destination. Note
|
|
1267
1266
|
* that if you set the invocation rate maximum to a value lower the rate necessary to send all
|
|
1268
1267
|
* events received on to the destination HTTP endpoint, some events may not be delivered within
|
|
1269
1268
|
* the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver
|
|
1270
1269
|
* all events, consider using a dead-letter queue to catch events that are not delivered within
|
|
1271
1270
|
* 24 hours.</p>
|
|
1271
|
+
* @public
|
|
1272
1272
|
*/
|
|
1273
1273
|
InvocationRateLimitPerSecond?: number;
|
|
1274
1274
|
/**
|
|
1275
|
-
* @public
|
|
1276
1275
|
* <p>A time stamp for the time that the API destination was created.</p>
|
|
1276
|
+
* @public
|
|
1277
1277
|
*/
|
|
1278
1278
|
CreationTime?: Date;
|
|
1279
1279
|
/**
|
|
1280
|
-
* @public
|
|
1281
1280
|
* <p>A time stamp for the time that the API destination was last modified.</p>
|
|
1281
|
+
* @public
|
|
1282
1282
|
*/
|
|
1283
1283
|
LastModifiedTime?: Date;
|
|
1284
1284
|
}
|
|
@@ -1287,8 +1287,8 @@ export interface DescribeApiDestinationResponse {
|
|
|
1287
1287
|
*/
|
|
1288
1288
|
export interface DescribeArchiveRequest {
|
|
1289
1289
|
/**
|
|
1290
|
-
* @public
|
|
1291
1290
|
* <p>The name of the archive to retrieve.</p>
|
|
1291
|
+
* @public
|
|
1292
1292
|
*/
|
|
1293
1293
|
ArchiveName: string | undefined;
|
|
1294
1294
|
}
|
|
@@ -1297,58 +1297,58 @@ export interface DescribeArchiveRequest {
|
|
|
1297
1297
|
*/
|
|
1298
1298
|
export interface DescribeArchiveResponse {
|
|
1299
1299
|
/**
|
|
1300
|
-
* @public
|
|
1301
1300
|
* <p>The ARN of the archive.</p>
|
|
1301
|
+
* @public
|
|
1302
1302
|
*/
|
|
1303
1303
|
ArchiveArn?: string;
|
|
1304
1304
|
/**
|
|
1305
|
-
* @public
|
|
1306
1305
|
* <p>The name of the archive.</p>
|
|
1306
|
+
* @public
|
|
1307
1307
|
*/
|
|
1308
1308
|
ArchiveName?: string;
|
|
1309
1309
|
/**
|
|
1310
|
-
* @public
|
|
1311
1310
|
* <p>The ARN of the event source associated with the archive.</p>
|
|
1311
|
+
* @public
|
|
1312
1312
|
*/
|
|
1313
1313
|
EventSourceArn?: string;
|
|
1314
1314
|
/**
|
|
1315
|
-
* @public
|
|
1316
1315
|
* <p>The description of the archive.</p>
|
|
1316
|
+
* @public
|
|
1317
1317
|
*/
|
|
1318
1318
|
Description?: string;
|
|
1319
1319
|
/**
|
|
1320
|
-
* @public
|
|
1321
1320
|
* <p>The event pattern used to filter events sent to the archive.</p>
|
|
1321
|
+
* @public
|
|
1322
1322
|
*/
|
|
1323
1323
|
EventPattern?: string;
|
|
1324
1324
|
/**
|
|
1325
|
-
* @public
|
|
1326
1325
|
* <p>The state of the archive.</p>
|
|
1326
|
+
* @public
|
|
1327
1327
|
*/
|
|
1328
1328
|
State?: ArchiveState;
|
|
1329
1329
|
/**
|
|
1330
|
-
* @public
|
|
1331
1330
|
* <p>The reason that the archive is in the state.</p>
|
|
1331
|
+
* @public
|
|
1332
1332
|
*/
|
|
1333
1333
|
StateReason?: string;
|
|
1334
1334
|
/**
|
|
1335
|
-
* @public
|
|
1336
1335
|
* <p>The number of days to retain events for in the archive.</p>
|
|
1336
|
+
* @public
|
|
1337
1337
|
*/
|
|
1338
1338
|
RetentionDays?: number;
|
|
1339
1339
|
/**
|
|
1340
|
-
* @public
|
|
1341
1340
|
* <p>The size of the archive in bytes.</p>
|
|
1341
|
+
* @public
|
|
1342
1342
|
*/
|
|
1343
1343
|
SizeBytes?: number;
|
|
1344
1344
|
/**
|
|
1345
|
-
* @public
|
|
1346
1345
|
* <p>The number of events in the archive.</p>
|
|
1346
|
+
* @public
|
|
1347
1347
|
*/
|
|
1348
1348
|
EventCount?: number;
|
|
1349
1349
|
/**
|
|
1350
|
-
* @public
|
|
1351
1350
|
* <p>The time at which the archive was created.</p>
|
|
1351
|
+
* @public
|
|
1352
1352
|
*/
|
|
1353
1353
|
CreationTime?: Date;
|
|
1354
1354
|
}
|
|
@@ -1357,99 +1357,99 @@ export interface DescribeArchiveResponse {
|
|
|
1357
1357
|
*/
|
|
1358
1358
|
export interface DescribeConnectionRequest {
|
|
1359
1359
|
/**
|
|
1360
|
-
* @public
|
|
1361
1360
|
* <p>The name of the connection to retrieve.</p>
|
|
1361
|
+
* @public
|
|
1362
1362
|
*/
|
|
1363
1363
|
Name: string | undefined;
|
|
1364
1364
|
}
|
|
1365
1365
|
/**
|
|
1366
|
-
* @public
|
|
1367
1366
|
* <p>Contains the authorization parameters for the connection if API Key is specified as the
|
|
1368
1367
|
* authorization type.</p>
|
|
1368
|
+
* @public
|
|
1369
1369
|
*/
|
|
1370
1370
|
export interface ConnectionApiKeyAuthResponseParameters {
|
|
1371
1371
|
/**
|
|
1372
|
-
* @public
|
|
1373
1372
|
* <p>The name of the header to use for the <code>APIKeyValue</code> used for
|
|
1374
1373
|
* authorization.</p>
|
|
1374
|
+
* @public
|
|
1375
1375
|
*/
|
|
1376
1376
|
ApiKeyName?: string;
|
|
1377
1377
|
}
|
|
1378
1378
|
/**
|
|
1379
|
-
* @public
|
|
1380
1379
|
* <p>Contains the authorization parameters for the connection if Basic is specified as the
|
|
1381
1380
|
* authorization type.</p>
|
|
1381
|
+
* @public
|
|
1382
1382
|
*/
|
|
1383
1383
|
export interface ConnectionBasicAuthResponseParameters {
|
|
1384
1384
|
/**
|
|
1385
|
-
* @public
|
|
1386
1385
|
* <p>The user name to use for Basic authorization.</p>
|
|
1386
|
+
* @public
|
|
1387
1387
|
*/
|
|
1388
1388
|
Username?: string;
|
|
1389
1389
|
}
|
|
1390
1390
|
/**
|
|
1391
|
-
* @public
|
|
1392
1391
|
* <p>Contains the client response parameters for the connection when OAuth is specified as the
|
|
1393
1392
|
* authorization type.</p>
|
|
1393
|
+
* @public
|
|
1394
1394
|
*/
|
|
1395
1395
|
export interface ConnectionOAuthClientResponseParameters {
|
|
1396
1396
|
/**
|
|
1397
|
-
* @public
|
|
1398
1397
|
* <p>The client ID associated with the response to the connection request.</p>
|
|
1398
|
+
* @public
|
|
1399
1399
|
*/
|
|
1400
1400
|
ClientID?: string;
|
|
1401
1401
|
}
|
|
1402
1402
|
/**
|
|
1403
|
-
* @public
|
|
1404
1403
|
* <p>Contains the response parameters when OAuth is specified as the authorization type.</p>
|
|
1404
|
+
* @public
|
|
1405
1405
|
*/
|
|
1406
1406
|
export interface ConnectionOAuthResponseParameters {
|
|
1407
1407
|
/**
|
|
1408
|
-
* @public
|
|
1409
1408
|
* <p>A <code>ConnectionOAuthClientResponseParameters</code> object that contains details about
|
|
1410
1409
|
* the client parameters returned when OAuth is specified as the authorization type.</p>
|
|
1410
|
+
* @public
|
|
1411
1411
|
*/
|
|
1412
1412
|
ClientParameters?: ConnectionOAuthClientResponseParameters;
|
|
1413
1413
|
/**
|
|
1414
|
-
* @public
|
|
1415
1414
|
* <p>The URL to the HTTP endpoint that authorized the request.</p>
|
|
1415
|
+
* @public
|
|
1416
1416
|
*/
|
|
1417
1417
|
AuthorizationEndpoint?: string;
|
|
1418
1418
|
/**
|
|
1419
|
-
* @public
|
|
1420
1419
|
* <p>The method used to connect to the HTTP endpoint.</p>
|
|
1420
|
+
* @public
|
|
1421
1421
|
*/
|
|
1422
1422
|
HttpMethod?: ConnectionOAuthHttpMethod;
|
|
1423
1423
|
/**
|
|
1424
|
-
* @public
|
|
1425
1424
|
* <p>The additional HTTP parameters used for the OAuth authorization request.</p>
|
|
1425
|
+
* @public
|
|
1426
1426
|
*/
|
|
1427
1427
|
OAuthHttpParameters?: ConnectionHttpParameters;
|
|
1428
1428
|
}
|
|
1429
1429
|
/**
|
|
1430
|
-
* @public
|
|
1431
1430
|
* <p>Contains the authorization parameters to use for the connection.</p>
|
|
1431
|
+
* @public
|
|
1432
1432
|
*/
|
|
1433
1433
|
export interface ConnectionAuthResponseParameters {
|
|
1434
1434
|
/**
|
|
1435
|
-
* @public
|
|
1436
1435
|
* <p>The authorization parameters for Basic authorization.</p>
|
|
1436
|
+
* @public
|
|
1437
1437
|
*/
|
|
1438
1438
|
BasicAuthParameters?: ConnectionBasicAuthResponseParameters;
|
|
1439
1439
|
/**
|
|
1440
|
-
* @public
|
|
1441
1440
|
* <p>The OAuth parameters to use for authorization.</p>
|
|
1441
|
+
* @public
|
|
1442
1442
|
*/
|
|
1443
1443
|
OAuthParameters?: ConnectionOAuthResponseParameters;
|
|
1444
1444
|
/**
|
|
1445
|
-
* @public
|
|
1446
1445
|
* <p>The API Key parameters to use for authorization.</p>
|
|
1446
|
+
* @public
|
|
1447
1447
|
*/
|
|
1448
1448
|
ApiKeyAuthParameters?: ConnectionApiKeyAuthResponseParameters;
|
|
1449
1449
|
/**
|
|
1450
|
-
* @public
|
|
1451
1450
|
* <p>Additional parameters for the connection that are passed through with every invocation to
|
|
1452
1451
|
* the HTTP endpoint.</p>
|
|
1452
|
+
* @public
|
|
1453
1453
|
*/
|
|
1454
1454
|
InvocationHttpParameters?: ConnectionHttpParameters;
|
|
1455
1455
|
}
|
|
@@ -1458,59 +1458,59 @@ export interface ConnectionAuthResponseParameters {
|
|
|
1458
1458
|
*/
|
|
1459
1459
|
export interface DescribeConnectionResponse {
|
|
1460
1460
|
/**
|
|
1461
|
-
* @public
|
|
1462
1461
|
* <p>The ARN of the connection retrieved.</p>
|
|
1462
|
+
* @public
|
|
1463
1463
|
*/
|
|
1464
1464
|
ConnectionArn?: string;
|
|
1465
1465
|
/**
|
|
1466
|
-
* @public
|
|
1467
1466
|
* <p>The name of the connection retrieved.</p>
|
|
1467
|
+
* @public
|
|
1468
1468
|
*/
|
|
1469
1469
|
Name?: string;
|
|
1470
1470
|
/**
|
|
1471
|
-
* @public
|
|
1472
1471
|
* <p>The description for the connection retrieved.</p>
|
|
1472
|
+
* @public
|
|
1473
1473
|
*/
|
|
1474
1474
|
Description?: string;
|
|
1475
1475
|
/**
|
|
1476
|
-
* @public
|
|
1477
1476
|
* <p>The state of the connection retrieved.</p>
|
|
1477
|
+
* @public
|
|
1478
1478
|
*/
|
|
1479
1479
|
ConnectionState?: ConnectionState;
|
|
1480
1480
|
/**
|
|
1481
|
-
* @public
|
|
1482
1481
|
* <p>The reason that the connection is in the current connection state.</p>
|
|
1482
|
+
* @public
|
|
1483
1483
|
*/
|
|
1484
1484
|
StateReason?: string;
|
|
1485
1485
|
/**
|
|
1486
|
-
* @public
|
|
1487
1486
|
* <p>The type of authorization specified for the connection.</p>
|
|
1487
|
+
* @public
|
|
1488
1488
|
*/
|
|
1489
1489
|
AuthorizationType?: ConnectionAuthorizationType;
|
|
1490
1490
|
/**
|
|
1491
|
-
* @public
|
|
1492
1491
|
* <p>The ARN of the secret created from the authorization parameters specified for the
|
|
1493
1492
|
* connection.</p>
|
|
1493
|
+
* @public
|
|
1494
1494
|
*/
|
|
1495
1495
|
SecretArn?: string;
|
|
1496
1496
|
/**
|
|
1497
|
-
* @public
|
|
1498
1497
|
* <p>The parameters to use for authorization for the connection.</p>
|
|
1498
|
+
* @public
|
|
1499
1499
|
*/
|
|
1500
1500
|
AuthParameters?: ConnectionAuthResponseParameters;
|
|
1501
1501
|
/**
|
|
1502
|
-
* @public
|
|
1503
1502
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
1503
|
+
* @public
|
|
1504
1504
|
*/
|
|
1505
1505
|
CreationTime?: Date;
|
|
1506
1506
|
/**
|
|
1507
|
-
* @public
|
|
1508
1507
|
* <p>A time stamp for the time that the connection was last modified.</p>
|
|
1508
|
+
* @public
|
|
1509
1509
|
*/
|
|
1510
1510
|
LastModifiedTime?: Date;
|
|
1511
1511
|
/**
|
|
1512
|
-
* @public
|
|
1513
1512
|
* <p>A time stamp for the time that the connection was last authorized.</p>
|
|
1513
|
+
* @public
|
|
1514
1514
|
*/
|
|
1515
1515
|
LastAuthorizedTime?: Date;
|
|
1516
1516
|
}
|
|
@@ -1519,13 +1519,13 @@ export interface DescribeConnectionResponse {
|
|
|
1519
1519
|
*/
|
|
1520
1520
|
export interface DescribeEndpointRequest {
|
|
1521
1521
|
/**
|
|
1522
|
-
* @public
|
|
1523
1522
|
* <p>The name of the endpoint you want to get information about. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.</p>
|
|
1523
|
+
* @public
|
|
1524
1524
|
*/
|
|
1525
1525
|
Name: string | undefined;
|
|
1526
1526
|
/**
|
|
1527
|
-
* @public
|
|
1528
1527
|
* <p>The primary Region of the endpoint you want to get information about. For example <code>"HomeRegion": "us-east-1"</code>.</p>
|
|
1528
|
+
* @public
|
|
1529
1529
|
*/
|
|
1530
1530
|
HomeRegion?: string;
|
|
1531
1531
|
}
|
|
@@ -1534,68 +1534,68 @@ export interface DescribeEndpointRequest {
|
|
|
1534
1534
|
*/
|
|
1535
1535
|
export interface DescribeEndpointResponse {
|
|
1536
1536
|
/**
|
|
1537
|
-
* @public
|
|
1538
1537
|
* <p>The name of the endpoint you asked for information about.</p>
|
|
1538
|
+
* @public
|
|
1539
1539
|
*/
|
|
1540
1540
|
Name?: string;
|
|
1541
1541
|
/**
|
|
1542
|
-
* @public
|
|
1543
1542
|
* <p>The description of the endpoint you asked for information about.</p>
|
|
1543
|
+
* @public
|
|
1544
1544
|
*/
|
|
1545
1545
|
Description?: string;
|
|
1546
1546
|
/**
|
|
1547
|
-
* @public
|
|
1548
1547
|
* <p>The ARN of the endpoint you asked for information about.</p>
|
|
1548
|
+
* @public
|
|
1549
1549
|
*/
|
|
1550
1550
|
Arn?: string;
|
|
1551
1551
|
/**
|
|
1552
|
-
* @public
|
|
1553
1552
|
* <p>The routing configuration of the endpoint you asked for information about.</p>
|
|
1553
|
+
* @public
|
|
1554
1554
|
*/
|
|
1555
1555
|
RoutingConfig?: RoutingConfig;
|
|
1556
1556
|
/**
|
|
1557
|
-
* @public
|
|
1558
1557
|
* <p>Whether replication is enabled or disabled for the endpoint you asked for information about.</p>
|
|
1558
|
+
* @public
|
|
1559
1559
|
*/
|
|
1560
1560
|
ReplicationConfig?: ReplicationConfig;
|
|
1561
1561
|
/**
|
|
1562
|
-
* @public
|
|
1563
1562
|
* <p>The event buses being used by the endpoint you asked for information about.</p>
|
|
1563
|
+
* @public
|
|
1564
1564
|
*/
|
|
1565
1565
|
EventBuses?: EndpointEventBus[];
|
|
1566
1566
|
/**
|
|
1567
|
-
* @public
|
|
1568
1567
|
* <p>The ARN of the role used by the endpoint you asked for information about.</p>
|
|
1568
|
+
* @public
|
|
1569
1569
|
*/
|
|
1570
1570
|
RoleArn?: string;
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <p>The ID of the endpoint you asked for information about.</p>
|
|
1573
|
+
* @public
|
|
1574
1574
|
*/
|
|
1575
1575
|
EndpointId?: string;
|
|
1576
1576
|
/**
|
|
1577
|
-
* @public
|
|
1578
1577
|
* <p>The URL of the endpoint you asked for information about.</p>
|
|
1578
|
+
* @public
|
|
1579
1579
|
*/
|
|
1580
1580
|
EndpointUrl?: string;
|
|
1581
1581
|
/**
|
|
1582
|
-
* @public
|
|
1583
1582
|
* <p>The current state of the endpoint you asked for information about.</p>
|
|
1583
|
+
* @public
|
|
1584
1584
|
*/
|
|
1585
1585
|
State?: EndpointState;
|
|
1586
1586
|
/**
|
|
1587
|
-
* @public
|
|
1588
1587
|
* <p>The reason the endpoint you asked for information about is in its current state.</p>
|
|
1588
|
+
* @public
|
|
1589
1589
|
*/
|
|
1590
1590
|
StateReason?: string;
|
|
1591
1591
|
/**
|
|
1592
|
-
* @public
|
|
1593
1592
|
* <p>The time the endpoint you asked for information about was created.</p>
|
|
1593
|
+
* @public
|
|
1594
1594
|
*/
|
|
1595
1595
|
CreationTime?: Date;
|
|
1596
1596
|
/**
|
|
1597
|
-
* @public
|
|
1598
1597
|
* <p>The last time the endpoint you asked for information about was modified.</p>
|
|
1598
|
+
* @public
|
|
1599
1599
|
*/
|
|
1600
1600
|
LastModifiedTime?: Date;
|
|
1601
1601
|
}
|
|
@@ -1604,9 +1604,9 @@ export interface DescribeEndpointResponse {
|
|
|
1604
1604
|
*/
|
|
1605
1605
|
export interface DescribeEventBusRequest {
|
|
1606
1606
|
/**
|
|
1607
|
-
* @public
|
|
1608
1607
|
* <p>The name or ARN of the event bus to show details for. If you omit this, the default event
|
|
1609
1608
|
* bus is displayed.</p>
|
|
1609
|
+
* @public
|
|
1610
1610
|
*/
|
|
1611
1611
|
Name?: string;
|
|
1612
1612
|
}
|
|
@@ -1615,19 +1615,19 @@ export interface DescribeEventBusRequest {
|
|
|
1615
1615
|
*/
|
|
1616
1616
|
export interface DescribeEventBusResponse {
|
|
1617
1617
|
/**
|
|
1618
|
-
* @public
|
|
1619
1618
|
* <p>The name of the event bus. Currently, this is always <code>default</code>.</p>
|
|
1619
|
+
* @public
|
|
1620
1620
|
*/
|
|
1621
1621
|
Name?: string;
|
|
1622
1622
|
/**
|
|
1623
|
-
* @public
|
|
1624
1623
|
* <p>The Amazon Resource Name (ARN) of the account permitted to write events to the current
|
|
1625
1624
|
* account.</p>
|
|
1625
|
+
* @public
|
|
1626
1626
|
*/
|
|
1627
1627
|
Arn?: string;
|
|
1628
1628
|
/**
|
|
1629
|
-
* @public
|
|
1630
1629
|
* <p>The policy that enables the external account to send events to your account.</p>
|
|
1630
|
+
* @public
|
|
1631
1631
|
*/
|
|
1632
1632
|
Policy?: string;
|
|
1633
1633
|
}
|
|
@@ -1636,8 +1636,8 @@ export interface DescribeEventBusResponse {
|
|
|
1636
1636
|
*/
|
|
1637
1637
|
export interface DescribeEventSourceRequest {
|
|
1638
1638
|
/**
|
|
1639
|
-
* @public
|
|
1640
1639
|
* <p>The name of the partner event source to display the details of.</p>
|
|
1640
|
+
* @public
|
|
1641
1641
|
*/
|
|
1642
1642
|
Name: string | undefined;
|
|
1643
1643
|
}
|
|
@@ -1659,37 +1659,37 @@ export type EventSourceState = (typeof EventSourceState)[keyof typeof EventSourc
|
|
|
1659
1659
|
*/
|
|
1660
1660
|
export interface DescribeEventSourceResponse {
|
|
1661
1661
|
/**
|
|
1662
|
-
* @public
|
|
1663
1662
|
* <p>The ARN of the partner event source.</p>
|
|
1663
|
+
* @public
|
|
1664
1664
|
*/
|
|
1665
1665
|
Arn?: string;
|
|
1666
1666
|
/**
|
|
1667
|
-
* @public
|
|
1668
1667
|
* <p>The name of the SaaS partner that created the event source.</p>
|
|
1668
|
+
* @public
|
|
1669
1669
|
*/
|
|
1670
1670
|
CreatedBy?: string;
|
|
1671
1671
|
/**
|
|
1672
|
-
* @public
|
|
1673
1672
|
* <p>The date and time that the event source was created.</p>
|
|
1673
|
+
* @public
|
|
1674
1674
|
*/
|
|
1675
1675
|
CreationTime?: Date;
|
|
1676
1676
|
/**
|
|
1677
|
-
* @public
|
|
1678
1677
|
* <p>The date and time that the event source will expire if you do not create a matching event
|
|
1679
1678
|
* bus.</p>
|
|
1679
|
+
* @public
|
|
1680
1680
|
*/
|
|
1681
1681
|
ExpirationTime?: Date;
|
|
1682
1682
|
/**
|
|
1683
|
-
* @public
|
|
1684
1683
|
* <p>The name of the partner event source.</p>
|
|
1684
|
+
* @public
|
|
1685
1685
|
*/
|
|
1686
1686
|
Name?: string;
|
|
1687
1687
|
/**
|
|
1688
|
-
* @public
|
|
1689
1688
|
* <p>The state of the event source. If it is ACTIVE, you have already created a matching event
|
|
1690
1689
|
* bus for this event source, and that event bus is active. If it is PENDING, either you haven't
|
|
1691
1690
|
* yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have
|
|
1692
1691
|
* created a matching event bus, but the event source has since been deleted.</p>
|
|
1692
|
+
* @public
|
|
1693
1693
|
*/
|
|
1694
1694
|
State?: EventSourceState;
|
|
1695
1695
|
}
|
|
@@ -1698,8 +1698,8 @@ export interface DescribeEventSourceResponse {
|
|
|
1698
1698
|
*/
|
|
1699
1699
|
export interface DescribePartnerEventSourceRequest {
|
|
1700
1700
|
/**
|
|
1701
|
-
* @public
|
|
1702
1701
|
* <p>The name of the event source to display.</p>
|
|
1702
|
+
* @public
|
|
1703
1703
|
*/
|
|
1704
1704
|
Name: string | undefined;
|
|
1705
1705
|
}
|
|
@@ -1708,13 +1708,13 @@ export interface DescribePartnerEventSourceRequest {
|
|
|
1708
1708
|
*/
|
|
1709
1709
|
export interface DescribePartnerEventSourceResponse {
|
|
1710
1710
|
/**
|
|
1711
|
-
* @public
|
|
1712
1711
|
* <p>The ARN of the event source.</p>
|
|
1712
|
+
* @public
|
|
1713
1713
|
*/
|
|
1714
1714
|
Arn?: string;
|
|
1715
1715
|
/**
|
|
1716
|
-
* @public
|
|
1717
1716
|
* <p>The name of the event source.</p>
|
|
1717
|
+
* @public
|
|
1718
1718
|
*/
|
|
1719
1719
|
Name?: string;
|
|
1720
1720
|
}
|
|
@@ -1723,25 +1723,25 @@ export interface DescribePartnerEventSourceResponse {
|
|
|
1723
1723
|
*/
|
|
1724
1724
|
export interface DescribeReplayRequest {
|
|
1725
1725
|
/**
|
|
1726
|
-
* @public
|
|
1727
1726
|
* <p>The name of the replay to retrieve.</p>
|
|
1727
|
+
* @public
|
|
1728
1728
|
*/
|
|
1729
1729
|
ReplayName: string | undefined;
|
|
1730
1730
|
}
|
|
1731
1731
|
/**
|
|
1732
|
-
* @public
|
|
1733
1732
|
* <p>A <code>ReplayDestination</code> object that contains details about a replay.</p>
|
|
1733
|
+
* @public
|
|
1734
1734
|
*/
|
|
1735
1735
|
export interface ReplayDestination {
|
|
1736
1736
|
/**
|
|
1737
|
-
* @public
|
|
1738
1737
|
* <p>The ARN of the event bus to replay event to. You can replay events only to the event bus
|
|
1739
1738
|
* specified to create the archive.</p>
|
|
1739
|
+
* @public
|
|
1740
1740
|
*/
|
|
1741
1741
|
Arn: string | undefined;
|
|
1742
1742
|
/**
|
|
1743
|
-
* @public
|
|
1744
1743
|
* <p>A list of ARNs for rules to replay events to.</p>
|
|
1744
|
+
* @public
|
|
1745
1745
|
*/
|
|
1746
1746
|
FilterArns?: string[];
|
|
1747
1747
|
}
|
|
@@ -1750,63 +1750,63 @@ export interface ReplayDestination {
|
|
|
1750
1750
|
*/
|
|
1751
1751
|
export interface DescribeReplayResponse {
|
|
1752
1752
|
/**
|
|
1753
|
-
* @public
|
|
1754
1753
|
* <p>The name of the replay.</p>
|
|
1754
|
+
* @public
|
|
1755
1755
|
*/
|
|
1756
1756
|
ReplayName?: string;
|
|
1757
1757
|
/**
|
|
1758
|
-
* @public
|
|
1759
1758
|
* <p>The ARN of the replay.</p>
|
|
1759
|
+
* @public
|
|
1760
1760
|
*/
|
|
1761
1761
|
ReplayArn?: string;
|
|
1762
1762
|
/**
|
|
1763
|
-
* @public
|
|
1764
1763
|
* <p>The description of the replay.</p>
|
|
1764
|
+
* @public
|
|
1765
1765
|
*/
|
|
1766
1766
|
Description?: string;
|
|
1767
1767
|
/**
|
|
1768
|
-
* @public
|
|
1769
1768
|
* <p>The current state of the replay.</p>
|
|
1769
|
+
* @public
|
|
1770
1770
|
*/
|
|
1771
1771
|
State?: ReplayState;
|
|
1772
1772
|
/**
|
|
1773
|
-
* @public
|
|
1774
1773
|
* <p>The reason that the replay is in the current state.</p>
|
|
1774
|
+
* @public
|
|
1775
1775
|
*/
|
|
1776
1776
|
StateReason?: string;
|
|
1777
1777
|
/**
|
|
1778
|
-
* @public
|
|
1779
1778
|
* <p>The ARN of the archive events were replayed from.</p>
|
|
1779
|
+
* @public
|
|
1780
1780
|
*/
|
|
1781
1781
|
EventSourceArn?: string;
|
|
1782
1782
|
/**
|
|
1783
|
-
* @public
|
|
1784
1783
|
* <p>A <code>ReplayDestination</code> object that contains details about the replay.</p>
|
|
1784
|
+
* @public
|
|
1785
1785
|
*/
|
|
1786
1786
|
Destination?: ReplayDestination;
|
|
1787
1787
|
/**
|
|
1788
|
-
* @public
|
|
1789
1788
|
* <p>The time stamp of the first event that was last replayed from the archive.</p>
|
|
1789
|
+
* @public
|
|
1790
1790
|
*/
|
|
1791
1791
|
EventStartTime?: Date;
|
|
1792
1792
|
/**
|
|
1793
|
-
* @public
|
|
1794
1793
|
* <p>The time stamp for the last event that was replayed from the archive.</p>
|
|
1794
|
+
* @public
|
|
1795
1795
|
*/
|
|
1796
1796
|
EventEndTime?: Date;
|
|
1797
1797
|
/**
|
|
1798
|
-
* @public
|
|
1799
1798
|
* <p>The time that the event was last replayed.</p>
|
|
1799
|
+
* @public
|
|
1800
1800
|
*/
|
|
1801
1801
|
EventLastReplayedTime?: Date;
|
|
1802
1802
|
/**
|
|
1803
|
-
* @public
|
|
1804
1803
|
* <p>A time stamp for the time that the replay started.</p>
|
|
1804
|
+
* @public
|
|
1805
1805
|
*/
|
|
1806
1806
|
ReplayStartTime?: Date;
|
|
1807
1807
|
/**
|
|
1808
|
-
* @public
|
|
1809
1808
|
* <p>A time stamp for the time that the replay stopped.</p>
|
|
1809
|
+
* @public
|
|
1810
1810
|
*/
|
|
1811
1811
|
ReplayEndTime?: Date;
|
|
1812
1812
|
}
|
|
@@ -1815,14 +1815,14 @@ export interface DescribeReplayResponse {
|
|
|
1815
1815
|
*/
|
|
1816
1816
|
export interface DescribeRuleRequest {
|
|
1817
1817
|
/**
|
|
1818
|
-
* @public
|
|
1819
1818
|
* <p>The name of the rule.</p>
|
|
1819
|
+
* @public
|
|
1820
1820
|
*/
|
|
1821
1821
|
Name: string | undefined;
|
|
1822
1822
|
/**
|
|
1823
|
-
* @public
|
|
1824
1823
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
1825
1824
|
* event bus is used.</p>
|
|
1825
|
+
* @public
|
|
1826
1826
|
*/
|
|
1827
1827
|
EventBusName?: string;
|
|
1828
1828
|
}
|
|
@@ -1844,59 +1844,59 @@ export type RuleState = (typeof RuleState)[keyof typeof RuleState];
|
|
|
1844
1844
|
*/
|
|
1845
1845
|
export interface DescribeRuleResponse {
|
|
1846
1846
|
/**
|
|
1847
|
-
* @public
|
|
1848
1847
|
* <p>The name of the rule.</p>
|
|
1848
|
+
* @public
|
|
1849
1849
|
*/
|
|
1850
1850
|
Name?: string;
|
|
1851
1851
|
/**
|
|
1852
|
-
* @public
|
|
1853
1852
|
* <p>The Amazon Resource Name (ARN) of the rule.</p>
|
|
1853
|
+
* @public
|
|
1854
1854
|
*/
|
|
1855
1855
|
Arn?: string;
|
|
1856
1856
|
/**
|
|
1857
|
-
* @public
|
|
1858
1857
|
* <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
|
|
1859
1858
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1859
|
+
* @public
|
|
1860
1860
|
*/
|
|
1861
1861
|
EventPattern?: string;
|
|
1862
1862
|
/**
|
|
1863
|
-
* @public
|
|
1864
1863
|
* <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".</p>
|
|
1864
|
+
* @public
|
|
1865
1865
|
*/
|
|
1866
1866
|
ScheduleExpression?: string;
|
|
1867
1867
|
/**
|
|
1868
|
-
* @public
|
|
1869
1868
|
* <p>Specifies whether the rule is enabled or disabled.</p>
|
|
1869
|
+
* @public
|
|
1870
1870
|
*/
|
|
1871
1871
|
State?: RuleState;
|
|
1872
1872
|
/**
|
|
1873
|
-
* @public
|
|
1874
1873
|
* <p>The description of the rule.</p>
|
|
1874
|
+
* @public
|
|
1875
1875
|
*/
|
|
1876
1876
|
Description?: string;
|
|
1877
1877
|
/**
|
|
1878
|
-
* @public
|
|
1879
1878
|
* <p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
|
|
1879
|
+
* @public
|
|
1880
1880
|
*/
|
|
1881
1881
|
RoleArn?: string;
|
|
1882
1882
|
/**
|
|
1883
|
-
* @public
|
|
1884
1883
|
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays
|
|
1885
1884
|
* the principal name of the Amazon Web Services service that created the rule.</p>
|
|
1885
|
+
* @public
|
|
1886
1886
|
*/
|
|
1887
1887
|
ManagedBy?: string;
|
|
1888
1888
|
/**
|
|
1889
|
-
* @public
|
|
1890
1889
|
* <p>The name of the event bus associated with the rule.</p>
|
|
1890
|
+
* @public
|
|
1891
1891
|
*/
|
|
1892
1892
|
EventBusName?: string;
|
|
1893
1893
|
/**
|
|
1894
|
-
* @public
|
|
1895
1894
|
* <p>The account ID of the user that created the rule. If you use <code>PutRule</code> to put a
|
|
1896
1895
|
* rule on an event bus in another account, the other account is the owner of the rule, and the
|
|
1897
1896
|
* rule ARN includes the account ID for that account. However, the value for
|
|
1898
1897
|
* <code>CreatedBy</code> is the account ID as the account that created the rule in the other
|
|
1899
1898
|
* account.</p>
|
|
1899
|
+
* @public
|
|
1900
1900
|
*/
|
|
1901
1901
|
CreatedBy?: string;
|
|
1902
1902
|
}
|
|
@@ -1905,14 +1905,14 @@ export interface DescribeRuleResponse {
|
|
|
1905
1905
|
*/
|
|
1906
1906
|
export interface DisableRuleRequest {
|
|
1907
1907
|
/**
|
|
1908
|
-
* @public
|
|
1909
1908
|
* <p>The name of the rule.</p>
|
|
1909
|
+
* @public
|
|
1910
1910
|
*/
|
|
1911
1911
|
Name: string | undefined;
|
|
1912
1912
|
/**
|
|
1913
|
-
* @public
|
|
1914
1913
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
1915
1914
|
* event bus is used.</p>
|
|
1915
|
+
* @public
|
|
1916
1916
|
*/
|
|
1917
1917
|
EventBusName?: string;
|
|
1918
1918
|
}
|
|
@@ -1921,14 +1921,14 @@ export interface DisableRuleRequest {
|
|
|
1921
1921
|
*/
|
|
1922
1922
|
export interface EnableRuleRequest {
|
|
1923
1923
|
/**
|
|
1924
|
-
* @public
|
|
1925
1924
|
* <p>The name of the rule.</p>
|
|
1925
|
+
* @public
|
|
1926
1926
|
*/
|
|
1927
1927
|
Name: string | undefined;
|
|
1928
1928
|
/**
|
|
1929
|
-
* @public
|
|
1930
1929
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
1931
1930
|
* event bus is used.</p>
|
|
1931
|
+
* @public
|
|
1932
1932
|
*/
|
|
1933
1933
|
EventBusName?: string;
|
|
1934
1934
|
}
|
|
@@ -1937,24 +1937,24 @@ export interface EnableRuleRequest {
|
|
|
1937
1937
|
*/
|
|
1938
1938
|
export interface ListApiDestinationsRequest {
|
|
1939
1939
|
/**
|
|
1940
|
-
* @public
|
|
1941
1940
|
* <p>A name prefix to filter results returned. Only API destinations with a name that starts
|
|
1942
1941
|
* with the prefix are returned.</p>
|
|
1942
|
+
* @public
|
|
1943
1943
|
*/
|
|
1944
1944
|
NamePrefix?: string;
|
|
1945
1945
|
/**
|
|
1946
|
-
* @public
|
|
1947
1946
|
* <p>The ARN of the connection specified for the API destination.</p>
|
|
1947
|
+
* @public
|
|
1948
1948
|
*/
|
|
1949
1949
|
ConnectionArn?: string;
|
|
1950
1950
|
/**
|
|
1951
|
-
* @public
|
|
1952
1951
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1952
|
+
* @public
|
|
1953
1953
|
*/
|
|
1954
1954
|
NextToken?: string;
|
|
1955
1955
|
/**
|
|
1956
|
-
* @public
|
|
1957
1956
|
* <p>The maximum number of API destinations to include in the response.</p>
|
|
1957
|
+
* @public
|
|
1958
1958
|
*/
|
|
1959
1959
|
Limit?: number;
|
|
1960
1960
|
}
|
|
@@ -1963,14 +1963,14 @@ export interface ListApiDestinationsRequest {
|
|
|
1963
1963
|
*/
|
|
1964
1964
|
export interface ListApiDestinationsResponse {
|
|
1965
1965
|
/**
|
|
1966
|
-
* @public
|
|
1967
1966
|
* <p>An array of <code>ApiDestination</code> objects that include information about an API
|
|
1968
1967
|
* destination.</p>
|
|
1968
|
+
* @public
|
|
1969
1969
|
*/
|
|
1970
1970
|
ApiDestinations?: ApiDestination[];
|
|
1971
1971
|
/**
|
|
1972
|
-
* @public
|
|
1973
1972
|
* <p>A token you can use in a subsequent request to retrieve the next set of results.</p>
|
|
1973
|
+
* @public
|
|
1974
1974
|
*/
|
|
1975
1975
|
NextToken?: string;
|
|
1976
1976
|
}
|
|
@@ -1979,29 +1979,29 @@ export interface ListApiDestinationsResponse {
|
|
|
1979
1979
|
*/
|
|
1980
1980
|
export interface ListArchivesRequest {
|
|
1981
1981
|
/**
|
|
1982
|
-
* @public
|
|
1983
1982
|
* <p>A name prefix to filter the archives returned. Only archives with name that match the
|
|
1984
1983
|
* prefix are returned.</p>
|
|
1984
|
+
* @public
|
|
1985
1985
|
*/
|
|
1986
1986
|
NamePrefix?: string;
|
|
1987
1987
|
/**
|
|
1988
|
-
* @public
|
|
1989
1988
|
* <p>The ARN of the event source associated with the archive.</p>
|
|
1989
|
+
* @public
|
|
1990
1990
|
*/
|
|
1991
1991
|
EventSourceArn?: string;
|
|
1992
1992
|
/**
|
|
1993
|
-
* @public
|
|
1994
1993
|
* <p>The state of the archive.</p>
|
|
1994
|
+
* @public
|
|
1995
1995
|
*/
|
|
1996
1996
|
State?: ArchiveState;
|
|
1997
1997
|
/**
|
|
1998
|
-
* @public
|
|
1999
1998
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
1999
|
+
* @public
|
|
2000
2000
|
*/
|
|
2001
2001
|
NextToken?: string;
|
|
2002
2002
|
/**
|
|
2003
|
-
* @public
|
|
2004
2003
|
* <p>The maximum number of results to return.</p>
|
|
2004
|
+
* @public
|
|
2005
2005
|
*/
|
|
2006
2006
|
Limit?: number;
|
|
2007
2007
|
}
|
|
@@ -2010,13 +2010,13 @@ export interface ListArchivesRequest {
|
|
|
2010
2010
|
*/
|
|
2011
2011
|
export interface ListArchivesResponse {
|
|
2012
2012
|
/**
|
|
2013
|
-
* @public
|
|
2014
2013
|
* <p>An array of <code>Archive</code> objects that include details about an archive.</p>
|
|
2014
|
+
* @public
|
|
2015
2015
|
*/
|
|
2016
2016
|
Archives?: Archive[];
|
|
2017
2017
|
/**
|
|
2018
|
-
* @public
|
|
2019
2018
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2019
|
+
* @public
|
|
2020
2020
|
*/
|
|
2021
2021
|
NextToken?: string;
|
|
2022
2022
|
}
|
|
@@ -2025,73 +2025,73 @@ export interface ListArchivesResponse {
|
|
|
2025
2025
|
*/
|
|
2026
2026
|
export interface ListConnectionsRequest {
|
|
2027
2027
|
/**
|
|
2028
|
-
* @public
|
|
2029
2028
|
* <p>A name prefix to filter results returned. Only connections with a name that starts with
|
|
2030
2029
|
* the prefix are returned.</p>
|
|
2030
|
+
* @public
|
|
2031
2031
|
*/
|
|
2032
2032
|
NamePrefix?: string;
|
|
2033
2033
|
/**
|
|
2034
|
-
* @public
|
|
2035
2034
|
* <p>The state of the connection.</p>
|
|
2035
|
+
* @public
|
|
2036
2036
|
*/
|
|
2037
2037
|
ConnectionState?: ConnectionState;
|
|
2038
2038
|
/**
|
|
2039
|
-
* @public
|
|
2040
2039
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2040
|
+
* @public
|
|
2041
2041
|
*/
|
|
2042
2042
|
NextToken?: string;
|
|
2043
2043
|
/**
|
|
2044
|
-
* @public
|
|
2045
2044
|
* <p>The maximum number of connections to return.</p>
|
|
2045
|
+
* @public
|
|
2046
2046
|
*/
|
|
2047
2047
|
Limit?: number;
|
|
2048
2048
|
}
|
|
2049
2049
|
/**
|
|
2050
|
-
* @public
|
|
2051
2050
|
* <p>Contains information about a connection.</p>
|
|
2051
|
+
* @public
|
|
2052
2052
|
*/
|
|
2053
2053
|
export interface Connection {
|
|
2054
2054
|
/**
|
|
2055
|
-
* @public
|
|
2056
2055
|
* <p>The ARN of the connection.</p>
|
|
2056
|
+
* @public
|
|
2057
2057
|
*/
|
|
2058
2058
|
ConnectionArn?: string;
|
|
2059
2059
|
/**
|
|
2060
|
-
* @public
|
|
2061
2060
|
* <p>The name of the connection.</p>
|
|
2061
|
+
* @public
|
|
2062
2062
|
*/
|
|
2063
2063
|
Name?: string;
|
|
2064
2064
|
/**
|
|
2065
|
-
* @public
|
|
2066
2065
|
* <p>The state of the connection.</p>
|
|
2066
|
+
* @public
|
|
2067
2067
|
*/
|
|
2068
2068
|
ConnectionState?: ConnectionState;
|
|
2069
2069
|
/**
|
|
2070
|
-
* @public
|
|
2071
2070
|
* <p>The reason that the connection is in the connection state.</p>
|
|
2071
|
+
* @public
|
|
2072
2072
|
*/
|
|
2073
2073
|
StateReason?: string;
|
|
2074
2074
|
/**
|
|
2075
|
-
* @public
|
|
2076
2075
|
* <p>The authorization type specified for the connection.</p>
|
|
2077
2076
|
* <note>
|
|
2078
2077
|
* <p>OAUTH tokens are refreshed when a 401 or 407 response is returned.</p>
|
|
2079
2078
|
* </note>
|
|
2079
|
+
* @public
|
|
2080
2080
|
*/
|
|
2081
2081
|
AuthorizationType?: ConnectionAuthorizationType;
|
|
2082
2082
|
/**
|
|
2083
|
-
* @public
|
|
2084
2083
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
2084
|
+
* @public
|
|
2085
2085
|
*/
|
|
2086
2086
|
CreationTime?: Date;
|
|
2087
2087
|
/**
|
|
2088
|
-
* @public
|
|
2089
2088
|
* <p>A time stamp for the time that the connection was last modified.</p>
|
|
2089
|
+
* @public
|
|
2090
2090
|
*/
|
|
2091
2091
|
LastModifiedTime?: Date;
|
|
2092
2092
|
/**
|
|
2093
|
-
* @public
|
|
2094
2093
|
* <p>A time stamp for the time that the connection was last authorized.</p>
|
|
2094
|
+
* @public
|
|
2095
2095
|
*/
|
|
2096
2096
|
LastAuthorizedTime?: Date;
|
|
2097
2097
|
}
|
|
@@ -2100,13 +2100,13 @@ export interface Connection {
|
|
|
2100
2100
|
*/
|
|
2101
2101
|
export interface ListConnectionsResponse {
|
|
2102
2102
|
/**
|
|
2103
|
-
* @public
|
|
2104
2103
|
* <p>An array of connections objects that include details about the connections.</p>
|
|
2104
|
+
* @public
|
|
2105
2105
|
*/
|
|
2106
2106
|
Connections?: Connection[];
|
|
2107
2107
|
/**
|
|
2108
|
-
* @public
|
|
2109
2108
|
* <p>A token you can use in a subsequent request to retrieve the next set of results.</p>
|
|
2109
|
+
* @public
|
|
2110
2110
|
*/
|
|
2111
2111
|
NextToken?: string;
|
|
2112
2112
|
}
|
|
@@ -2115,97 +2115,97 @@ export interface ListConnectionsResponse {
|
|
|
2115
2115
|
*/
|
|
2116
2116
|
export interface ListEndpointsRequest {
|
|
2117
2117
|
/**
|
|
2118
|
-
* @public
|
|
2119
2118
|
* <p>A value that will return a subset of the endpoints associated with this account. For example, <code>"NamePrefix": "ABC"</code> will return all endpoints with "ABC" in the name.</p>
|
|
2119
|
+
* @public
|
|
2120
2120
|
*/
|
|
2121
2121
|
NamePrefix?: string;
|
|
2122
2122
|
/**
|
|
2123
|
-
* @public
|
|
2124
2123
|
* <p>The primary Region of the endpoints associated with this account. For example <code>"HomeRegion": "us-east-1"</code>.</p>
|
|
2124
|
+
* @public
|
|
2125
2125
|
*/
|
|
2126
2126
|
HomeRegion?: string;
|
|
2127
2127
|
/**
|
|
2128
|
-
* @public
|
|
2129
2128
|
* <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
2130
2129
|
* Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination
|
|
2131
2130
|
* token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.</p>
|
|
2131
|
+
* @public
|
|
2132
2132
|
*/
|
|
2133
2133
|
NextToken?: string;
|
|
2134
2134
|
/**
|
|
2135
|
-
* @public
|
|
2136
2135
|
* <p>The maximum number of results returned by the call.</p>
|
|
2136
|
+
* @public
|
|
2137
2137
|
*/
|
|
2138
2138
|
MaxResults?: number;
|
|
2139
2139
|
}
|
|
2140
2140
|
/**
|
|
2141
|
-
* @public
|
|
2142
2141
|
* <p>A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
2142
|
+
* @public
|
|
2143
2143
|
*/
|
|
2144
2144
|
export interface Endpoint {
|
|
2145
2145
|
/**
|
|
2146
|
-
* @public
|
|
2147
2146
|
* <p>The name of the endpoint.</p>
|
|
2147
|
+
* @public
|
|
2148
2148
|
*/
|
|
2149
2149
|
Name?: string;
|
|
2150
2150
|
/**
|
|
2151
|
-
* @public
|
|
2152
2151
|
* <p>A description for the endpoint.</p>
|
|
2152
|
+
* @public
|
|
2153
2153
|
*/
|
|
2154
2154
|
Description?: string;
|
|
2155
2155
|
/**
|
|
2156
|
-
* @public
|
|
2157
2156
|
* <p>The ARN of the endpoint.</p>
|
|
2157
|
+
* @public
|
|
2158
2158
|
*/
|
|
2159
2159
|
Arn?: string;
|
|
2160
2160
|
/**
|
|
2161
|
-
* @public
|
|
2162
2161
|
* <p>The routing configuration of the endpoint.</p>
|
|
2162
|
+
* @public
|
|
2163
2163
|
*/
|
|
2164
2164
|
RoutingConfig?: RoutingConfig;
|
|
2165
2165
|
/**
|
|
2166
|
-
* @public
|
|
2167
2166
|
* <p>Whether event replication was enabled or disabled for this endpoint. The default state is <code>ENABLED</code> which means you must supply a <code>RoleArn</code>.
|
|
2168
2167
|
* If you don't have a <code>RoleArn</code> or you don't want event replication enabled, set the state to <code>DISABLED</code>.</p>
|
|
2168
|
+
* @public
|
|
2169
2169
|
*/
|
|
2170
2170
|
ReplicationConfig?: ReplicationConfig;
|
|
2171
2171
|
/**
|
|
2172
|
-
* @public
|
|
2173
2172
|
* <p>The event buses being used by the endpoint.</p>
|
|
2173
|
+
* @public
|
|
2174
2174
|
*/
|
|
2175
2175
|
EventBuses?: EndpointEventBus[];
|
|
2176
2176
|
/**
|
|
2177
|
-
* @public
|
|
2178
2177
|
* <p>The ARN of the role used by event replication for the endpoint.</p>
|
|
2178
|
+
* @public
|
|
2179
2179
|
*/
|
|
2180
2180
|
RoleArn?: string;
|
|
2181
2181
|
/**
|
|
2182
|
-
* @public
|
|
2183
2182
|
* <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p>
|
|
2183
|
+
* @public
|
|
2184
2184
|
*/
|
|
2185
2185
|
EndpointId?: string;
|
|
2186
2186
|
/**
|
|
2187
|
-
* @public
|
|
2188
2187
|
* <p>The URL of the endpoint.</p>
|
|
2188
|
+
* @public
|
|
2189
2189
|
*/
|
|
2190
2190
|
EndpointUrl?: string;
|
|
2191
2191
|
/**
|
|
2192
|
-
* @public
|
|
2193
2192
|
* <p>The current state of the endpoint.</p>
|
|
2193
|
+
* @public
|
|
2194
2194
|
*/
|
|
2195
2195
|
State?: EndpointState;
|
|
2196
2196
|
/**
|
|
2197
|
-
* @public
|
|
2198
2197
|
* <p>The reason the endpoint is in its current state.</p>
|
|
2198
|
+
* @public
|
|
2199
2199
|
*/
|
|
2200
2200
|
StateReason?: string;
|
|
2201
2201
|
/**
|
|
2202
|
-
* @public
|
|
2203
2202
|
* <p>The time the endpoint was created.</p>
|
|
2203
|
+
* @public
|
|
2204
2204
|
*/
|
|
2205
2205
|
CreationTime?: Date;
|
|
2206
2206
|
/**
|
|
2207
|
-
* @public
|
|
2208
2207
|
* <p>The last time the endpoint was modified.</p>
|
|
2208
|
+
* @public
|
|
2209
2209
|
*/
|
|
2210
2210
|
LastModifiedTime?: Date;
|
|
2211
2211
|
}
|
|
@@ -2214,15 +2214,15 @@ export interface Endpoint {
|
|
|
2214
2214
|
*/
|
|
2215
2215
|
export interface ListEndpointsResponse {
|
|
2216
2216
|
/**
|
|
2217
|
-
* @public
|
|
2218
2217
|
* <p>The endpoints returned by the call.</p>
|
|
2218
|
+
* @public
|
|
2219
2219
|
*/
|
|
2220
2220
|
Endpoints?: Endpoint[];
|
|
2221
2221
|
/**
|
|
2222
|
-
* @public
|
|
2223
2222
|
* <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
2224
2223
|
* Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination
|
|
2225
2224
|
* token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.</p>
|
|
2225
|
+
* @public
|
|
2226
2226
|
*/
|
|
2227
2227
|
NextToken?: string;
|
|
2228
2228
|
}
|
|
@@ -2231,47 +2231,47 @@ export interface ListEndpointsResponse {
|
|
|
2231
2231
|
*/
|
|
2232
2232
|
export interface ListEventBusesRequest {
|
|
2233
2233
|
/**
|
|
2234
|
-
* @public
|
|
2235
2234
|
* <p>Specifying this limits the results to only those event buses with names that start with
|
|
2236
2235
|
* the specified prefix.</p>
|
|
2236
|
+
* @public
|
|
2237
2237
|
*/
|
|
2238
2238
|
NamePrefix?: string;
|
|
2239
2239
|
/**
|
|
2240
|
-
* @public
|
|
2241
2240
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2241
|
+
* @public
|
|
2242
2242
|
*/
|
|
2243
2243
|
NextToken?: string;
|
|
2244
2244
|
/**
|
|
2245
|
-
* @public
|
|
2246
2245
|
* <p>Specifying this limits the number of results returned by this operation. The operation
|
|
2247
2246
|
* also returns a NextToken which you can use in a subsequent operation to retrieve the next set
|
|
2248
2247
|
* of results.</p>
|
|
2248
|
+
* @public
|
|
2249
2249
|
*/
|
|
2250
2250
|
Limit?: number;
|
|
2251
2251
|
}
|
|
2252
2252
|
/**
|
|
2253
|
-
* @public
|
|
2254
2253
|
* <p>An event bus receives events from a source, uses rules to evaluate them, applies any configured input transformation, and routes them to the appropriate target(s).
|
|
2255
2254
|
* Your account's default event bus receives events from Amazon Web Services services. A custom event
|
|
2256
2255
|
* bus can receive events from your custom applications and services. A partner event bus
|
|
2257
2256
|
* receives events from an event source created by an SaaS partner. These events come from the
|
|
2258
2257
|
* partners services or applications.</p>
|
|
2258
|
+
* @public
|
|
2259
2259
|
*/
|
|
2260
2260
|
export interface EventBus {
|
|
2261
2261
|
/**
|
|
2262
|
-
* @public
|
|
2263
2262
|
* <p>The name of the event bus.</p>
|
|
2263
|
+
* @public
|
|
2264
2264
|
*/
|
|
2265
2265
|
Name?: string;
|
|
2266
2266
|
/**
|
|
2267
|
-
* @public
|
|
2268
2267
|
* <p>The ARN of the event bus.</p>
|
|
2268
|
+
* @public
|
|
2269
2269
|
*/
|
|
2270
2270
|
Arn?: string;
|
|
2271
2271
|
/**
|
|
2272
|
-
* @public
|
|
2273
2272
|
* <p>The permissions policy of the event bus, describing which other Amazon Web Services accounts can write
|
|
2274
2273
|
* events to this event bus.</p>
|
|
2274
|
+
* @public
|
|
2275
2275
|
*/
|
|
2276
2276
|
Policy?: string;
|
|
2277
2277
|
}
|
|
@@ -2280,13 +2280,13 @@ export interface EventBus {
|
|
|
2280
2280
|
*/
|
|
2281
2281
|
export interface ListEventBusesResponse {
|
|
2282
2282
|
/**
|
|
2283
|
-
* @public
|
|
2284
2283
|
* <p>This list of event buses.</p>
|
|
2284
|
+
* @public
|
|
2285
2285
|
*/
|
|
2286
2286
|
EventBuses?: EventBus[];
|
|
2287
2287
|
/**
|
|
2288
|
-
* @public
|
|
2289
2288
|
* <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
2289
|
+
* @public
|
|
2290
2290
|
*/
|
|
2291
2291
|
NextToken?: string;
|
|
2292
2292
|
}
|
|
@@ -2295,63 +2295,63 @@ export interface ListEventBusesResponse {
|
|
|
2295
2295
|
*/
|
|
2296
2296
|
export interface ListEventSourcesRequest {
|
|
2297
2297
|
/**
|
|
2298
|
-
* @public
|
|
2299
2298
|
* <p>Specifying this limits the results to only those partner event sources with names that
|
|
2300
2299
|
* start with the specified prefix.</p>
|
|
2300
|
+
* @public
|
|
2301
2301
|
*/
|
|
2302
2302
|
NamePrefix?: string;
|
|
2303
2303
|
/**
|
|
2304
|
-
* @public
|
|
2305
2304
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2305
|
+
* @public
|
|
2306
2306
|
*/
|
|
2307
2307
|
NextToken?: string;
|
|
2308
2308
|
/**
|
|
2309
|
-
* @public
|
|
2310
2309
|
* <p>Specifying this limits the number of results returned by this operation. The operation
|
|
2311
2310
|
* also returns a NextToken which you can use in a subsequent operation to retrieve the next set
|
|
2312
2311
|
* of results.</p>
|
|
2312
|
+
* @public
|
|
2313
2313
|
*/
|
|
2314
2314
|
Limit?: number;
|
|
2315
2315
|
}
|
|
2316
2316
|
/**
|
|
2317
|
-
* @public
|
|
2318
2317
|
* <p>A partner event source is created by an SaaS partner. If a customer creates a partner
|
|
2319
2318
|
* event bus that matches this event source, that Amazon Web Services account can receive events from the
|
|
2320
2319
|
* partner's applications or services.</p>
|
|
2320
|
+
* @public
|
|
2321
2321
|
*/
|
|
2322
2322
|
export interface EventSource {
|
|
2323
2323
|
/**
|
|
2324
|
-
* @public
|
|
2325
2324
|
* <p>The ARN of the event source.</p>
|
|
2325
|
+
* @public
|
|
2326
2326
|
*/
|
|
2327
2327
|
Arn?: string;
|
|
2328
2328
|
/**
|
|
2329
|
-
* @public
|
|
2330
2329
|
* <p>The name of the partner that created the event source.</p>
|
|
2330
|
+
* @public
|
|
2331
2331
|
*/
|
|
2332
2332
|
CreatedBy?: string;
|
|
2333
2333
|
/**
|
|
2334
|
-
* @public
|
|
2335
2334
|
* <p>The date and time the event source was created.</p>
|
|
2335
|
+
* @public
|
|
2336
2336
|
*/
|
|
2337
2337
|
CreationTime?: Date;
|
|
2338
2338
|
/**
|
|
2339
|
-
* @public
|
|
2340
2339
|
* <p>The date and time that the event source will expire, if the Amazon Web Services account doesn't create a
|
|
2341
2340
|
* matching event bus for it.</p>
|
|
2341
|
+
* @public
|
|
2342
2342
|
*/
|
|
2343
2343
|
ExpirationTime?: Date;
|
|
2344
2344
|
/**
|
|
2345
|
-
* @public
|
|
2346
2345
|
* <p>The name of the event source.</p>
|
|
2346
|
+
* @public
|
|
2347
2347
|
*/
|
|
2348
2348
|
Name?: string;
|
|
2349
2349
|
/**
|
|
2350
|
-
* @public
|
|
2351
2350
|
* <p>The state of the event source. If it is ACTIVE, you have already created a matching event
|
|
2352
2351
|
* bus for this event source, and that event bus is active. If it is PENDING, either you haven't
|
|
2353
2352
|
* yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have
|
|
2354
2353
|
* created a matching event bus, but the event source has since been deleted.</p>
|
|
2354
|
+
* @public
|
|
2355
2355
|
*/
|
|
2356
2356
|
State?: EventSourceState;
|
|
2357
2357
|
}
|
|
@@ -2360,13 +2360,13 @@ export interface EventSource {
|
|
|
2360
2360
|
*/
|
|
2361
2361
|
export interface ListEventSourcesResponse {
|
|
2362
2362
|
/**
|
|
2363
|
-
* @public
|
|
2364
2363
|
* <p>The list of event sources.</p>
|
|
2364
|
+
* @public
|
|
2365
2365
|
*/
|
|
2366
2366
|
EventSources?: EventSource[];
|
|
2367
2367
|
/**
|
|
2368
|
-
* @public
|
|
2369
2368
|
* <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
2369
|
+
* @public
|
|
2370
2370
|
*/
|
|
2371
2371
|
NextToken?: string;
|
|
2372
2372
|
}
|
|
@@ -2375,51 +2375,51 @@ export interface ListEventSourcesResponse {
|
|
|
2375
2375
|
*/
|
|
2376
2376
|
export interface ListPartnerEventSourceAccountsRequest {
|
|
2377
2377
|
/**
|
|
2378
|
-
* @public
|
|
2379
2378
|
* <p>The name of the partner event source to display account information about.</p>
|
|
2379
|
+
* @public
|
|
2380
2380
|
*/
|
|
2381
2381
|
EventSourceName: string | undefined;
|
|
2382
2382
|
/**
|
|
2383
|
-
* @public
|
|
2384
2383
|
* <p>The token returned by a previous call to this operation. Specifying this retrieves the
|
|
2385
2384
|
* next set of results.</p>
|
|
2385
|
+
* @public
|
|
2386
2386
|
*/
|
|
2387
2387
|
NextToken?: string;
|
|
2388
2388
|
/**
|
|
2389
|
-
* @public
|
|
2390
2389
|
* <p>Specifying this limits the number of results returned by this operation. The operation
|
|
2391
2390
|
* also returns a NextToken which you can use in a subsequent operation to retrieve the next set
|
|
2392
2391
|
* of results.</p>
|
|
2392
|
+
* @public
|
|
2393
2393
|
*/
|
|
2394
2394
|
Limit?: number;
|
|
2395
2395
|
}
|
|
2396
2396
|
/**
|
|
2397
|
-
* @public
|
|
2398
2397
|
* <p>The Amazon Web Services account that a partner event source has been offered to.</p>
|
|
2398
|
+
* @public
|
|
2399
2399
|
*/
|
|
2400
2400
|
export interface PartnerEventSourceAccount {
|
|
2401
2401
|
/**
|
|
2402
|
-
* @public
|
|
2403
2402
|
* <p>The Amazon Web Services account ID that the partner event source was offered to.</p>
|
|
2403
|
+
* @public
|
|
2404
2404
|
*/
|
|
2405
2405
|
Account?: string;
|
|
2406
2406
|
/**
|
|
2407
|
-
* @public
|
|
2408
2407
|
* <p>The date and time the event source was created.</p>
|
|
2408
|
+
* @public
|
|
2409
2409
|
*/
|
|
2410
2410
|
CreationTime?: Date;
|
|
2411
2411
|
/**
|
|
2412
|
-
* @public
|
|
2413
2412
|
* <p>The date and time that the event source will expire, if the Amazon Web Services account doesn't create a
|
|
2414
2413
|
* matching event bus for it.</p>
|
|
2414
|
+
* @public
|
|
2415
2415
|
*/
|
|
2416
2416
|
ExpirationTime?: Date;
|
|
2417
2417
|
/**
|
|
2418
|
-
* @public
|
|
2419
2418
|
* <p>The state of the event source. If it is ACTIVE, you have already created a matching event
|
|
2420
2419
|
* bus for this event source, and that event bus is active. If it is PENDING, either you haven't
|
|
2421
2420
|
* yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have
|
|
2422
2421
|
* created a matching event bus, but the event source has since been deleted.</p>
|
|
2422
|
+
* @public
|
|
2423
2423
|
*/
|
|
2424
2424
|
State?: EventSourceState;
|
|
2425
2425
|
}
|
|
@@ -2428,13 +2428,13 @@ export interface PartnerEventSourceAccount {
|
|
|
2428
2428
|
*/
|
|
2429
2429
|
export interface ListPartnerEventSourceAccountsResponse {
|
|
2430
2430
|
/**
|
|
2431
|
-
* @public
|
|
2432
2431
|
* <p>The list of partner event sources returned by the operation.</p>
|
|
2432
|
+
* @public
|
|
2433
2433
|
*/
|
|
2434
2434
|
PartnerEventSourceAccounts?: PartnerEventSourceAccount[];
|
|
2435
2435
|
/**
|
|
2436
|
-
* @public
|
|
2437
2436
|
* <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
2437
|
+
* @public
|
|
2438
2438
|
*/
|
|
2439
2439
|
NextToken?: string;
|
|
2440
2440
|
}
|
|
@@ -2443,40 +2443,40 @@ export interface ListPartnerEventSourceAccountsResponse {
|
|
|
2443
2443
|
*/
|
|
2444
2444
|
export interface ListPartnerEventSourcesRequest {
|
|
2445
2445
|
/**
|
|
2446
|
-
* @public
|
|
2447
2446
|
* <p>If you specify this, the results are limited to only those partner event sources that
|
|
2448
2447
|
* start with the string you specify.</p>
|
|
2448
|
+
* @public
|
|
2449
2449
|
*/
|
|
2450
2450
|
NamePrefix: string | undefined;
|
|
2451
2451
|
/**
|
|
2452
|
-
* @public
|
|
2453
2452
|
* <p>The token returned by a previous call to this operation. Specifying this retrieves the
|
|
2454
2453
|
* next set of results.</p>
|
|
2454
|
+
* @public
|
|
2455
2455
|
*/
|
|
2456
2456
|
NextToken?: string;
|
|
2457
2457
|
/**
|
|
2458
|
-
* @public
|
|
2459
2458
|
* <p>pecifying this limits the number of results returned by this operation. The operation also
|
|
2460
2459
|
* returns a NextToken which you can use in a subsequent operation to retrieve the next set of
|
|
2461
2460
|
* results.</p>
|
|
2461
|
+
* @public
|
|
2462
2462
|
*/
|
|
2463
2463
|
Limit?: number;
|
|
2464
2464
|
}
|
|
2465
2465
|
/**
|
|
2466
|
-
* @public
|
|
2467
2466
|
* <p>A partner event source is created by an SaaS partner. If a customer creates a partner
|
|
2468
2467
|
* event bus that matches this event source, that Amazon Web Services account can receive events from the
|
|
2469
2468
|
* partner's applications or services.</p>
|
|
2469
|
+
* @public
|
|
2470
2470
|
*/
|
|
2471
2471
|
export interface PartnerEventSource {
|
|
2472
2472
|
/**
|
|
2473
|
-
* @public
|
|
2474
2473
|
* <p>The ARN of the partner event source.</p>
|
|
2474
|
+
* @public
|
|
2475
2475
|
*/
|
|
2476
2476
|
Arn?: string;
|
|
2477
2477
|
/**
|
|
2478
|
-
* @public
|
|
2479
2478
|
* <p>The name of the partner event source.</p>
|
|
2479
|
+
* @public
|
|
2480
2480
|
*/
|
|
2481
2481
|
Name?: string;
|
|
2482
2482
|
}
|
|
@@ -2485,13 +2485,13 @@ export interface PartnerEventSource {
|
|
|
2485
2485
|
*/
|
|
2486
2486
|
export interface ListPartnerEventSourcesResponse {
|
|
2487
2487
|
/**
|
|
2488
|
-
* @public
|
|
2489
2488
|
* <p>The list of partner event sources returned by the operation.</p>
|
|
2489
|
+
* @public
|
|
2490
2490
|
*/
|
|
2491
2491
|
PartnerEventSources?: PartnerEventSource[];
|
|
2492
2492
|
/**
|
|
2493
|
-
* @public
|
|
2494
2493
|
* <p>A token you can use in a subsequent operation to retrieve the next set of results.</p>
|
|
2494
|
+
* @public
|
|
2495
2495
|
*/
|
|
2496
2496
|
NextToken?: string;
|
|
2497
2497
|
}
|
|
@@ -2500,82 +2500,82 @@ export interface ListPartnerEventSourcesResponse {
|
|
|
2500
2500
|
*/
|
|
2501
2501
|
export interface ListReplaysRequest {
|
|
2502
2502
|
/**
|
|
2503
|
-
* @public
|
|
2504
2503
|
* <p>A name prefix to filter the replays returned. Only replays with name that match the prefix
|
|
2505
2504
|
* are returned.</p>
|
|
2505
|
+
* @public
|
|
2506
2506
|
*/
|
|
2507
2507
|
NamePrefix?: string;
|
|
2508
2508
|
/**
|
|
2509
|
-
* @public
|
|
2510
2509
|
* <p>The state of the replay.</p>
|
|
2510
|
+
* @public
|
|
2511
2511
|
*/
|
|
2512
2512
|
State?: ReplayState;
|
|
2513
2513
|
/**
|
|
2514
|
-
* @public
|
|
2515
2514
|
* <p>The ARN of the archive from which the events are replayed.</p>
|
|
2515
|
+
* @public
|
|
2516
2516
|
*/
|
|
2517
2517
|
EventSourceArn?: string;
|
|
2518
2518
|
/**
|
|
2519
|
-
* @public
|
|
2520
2519
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2520
|
+
* @public
|
|
2521
2521
|
*/
|
|
2522
2522
|
NextToken?: string;
|
|
2523
2523
|
/**
|
|
2524
|
-
* @public
|
|
2525
2524
|
* <p>The maximum number of replays to retrieve.</p>
|
|
2525
|
+
* @public
|
|
2526
2526
|
*/
|
|
2527
2527
|
Limit?: number;
|
|
2528
2528
|
}
|
|
2529
2529
|
/**
|
|
2530
|
-
* @public
|
|
2531
2530
|
* <p>A <code>Replay</code> object that contains details about a replay.</p>
|
|
2531
|
+
* @public
|
|
2532
2532
|
*/
|
|
2533
2533
|
export interface Replay {
|
|
2534
2534
|
/**
|
|
2535
|
-
* @public
|
|
2536
2535
|
* <p>The name of the replay.</p>
|
|
2536
|
+
* @public
|
|
2537
2537
|
*/
|
|
2538
2538
|
ReplayName?: string;
|
|
2539
2539
|
/**
|
|
2540
|
-
* @public
|
|
2541
2540
|
* <p>The ARN of the archive to replay event from.</p>
|
|
2541
|
+
* @public
|
|
2542
2542
|
*/
|
|
2543
2543
|
EventSourceArn?: string;
|
|
2544
2544
|
/**
|
|
2545
|
-
* @public
|
|
2546
2545
|
* <p>The current state of the replay.</p>
|
|
2546
|
+
* @public
|
|
2547
2547
|
*/
|
|
2548
2548
|
State?: ReplayState;
|
|
2549
2549
|
/**
|
|
2550
|
-
* @public
|
|
2551
2550
|
* <p>A description of why the replay is in the current state.</p>
|
|
2551
|
+
* @public
|
|
2552
2552
|
*/
|
|
2553
2553
|
StateReason?: string;
|
|
2554
2554
|
/**
|
|
2555
|
-
* @public
|
|
2556
2555
|
* <p>A time stamp for the time to start replaying events. This is determined by the time in the
|
|
2557
2556
|
* event as described in <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time">Time</a>.</p>
|
|
2557
|
+
* @public
|
|
2558
2558
|
*/
|
|
2559
2559
|
EventStartTime?: Date;
|
|
2560
2560
|
/**
|
|
2561
|
-
* @public
|
|
2562
2561
|
* <p>A time stamp for the time to start replaying events. Any event with a creation time prior
|
|
2563
2562
|
* to the <code>EventEndTime</code> specified is replayed.</p>
|
|
2563
|
+
* @public
|
|
2564
2564
|
*/
|
|
2565
2565
|
EventEndTime?: Date;
|
|
2566
2566
|
/**
|
|
2567
|
-
* @public
|
|
2568
2567
|
* <p>A time stamp for the time that the last event was replayed.</p>
|
|
2568
|
+
* @public
|
|
2569
2569
|
*/
|
|
2570
2570
|
EventLastReplayedTime?: Date;
|
|
2571
2571
|
/**
|
|
2572
|
-
* @public
|
|
2573
2572
|
* <p>A time stamp for the time that the replay started.</p>
|
|
2573
|
+
* @public
|
|
2574
2574
|
*/
|
|
2575
2575
|
ReplayStartTime?: Date;
|
|
2576
2576
|
/**
|
|
2577
|
-
* @public
|
|
2578
2577
|
* <p>A time stamp for the time that the replay completed.</p>
|
|
2578
|
+
* @public
|
|
2579
2579
|
*/
|
|
2580
2580
|
ReplayEndTime?: Date;
|
|
2581
2581
|
}
|
|
@@ -2584,13 +2584,13 @@ export interface Replay {
|
|
|
2584
2584
|
*/
|
|
2585
2585
|
export interface ListReplaysResponse {
|
|
2586
2586
|
/**
|
|
2587
|
-
* @public
|
|
2588
2587
|
* <p>An array of <code>Replay</code> objects that contain information about the replay.</p>
|
|
2588
|
+
* @public
|
|
2589
2589
|
*/
|
|
2590
2590
|
Replays?: Replay[];
|
|
2591
2591
|
/**
|
|
2592
|
-
* @public
|
|
2593
2592
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2593
|
+
* @public
|
|
2594
2594
|
*/
|
|
2595
2595
|
NextToken?: string;
|
|
2596
2596
|
}
|
|
@@ -2599,24 +2599,24 @@ export interface ListReplaysResponse {
|
|
|
2599
2599
|
*/
|
|
2600
2600
|
export interface ListRuleNamesByTargetRequest {
|
|
2601
2601
|
/**
|
|
2602
|
-
* @public
|
|
2603
2602
|
* <p>The Amazon Resource Name (ARN) of the target resource.</p>
|
|
2603
|
+
* @public
|
|
2604
2604
|
*/
|
|
2605
2605
|
TargetArn: string | undefined;
|
|
2606
2606
|
/**
|
|
2607
|
-
* @public
|
|
2608
2607
|
* <p>The name or ARN of the event bus to list rules for. If you omit this, the default event
|
|
2609
2608
|
* bus is used.</p>
|
|
2609
|
+
* @public
|
|
2610
2610
|
*/
|
|
2611
2611
|
EventBusName?: string;
|
|
2612
2612
|
/**
|
|
2613
|
-
* @public
|
|
2614
2613
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2614
|
+
* @public
|
|
2615
2615
|
*/
|
|
2616
2616
|
NextToken?: string;
|
|
2617
2617
|
/**
|
|
2618
|
-
* @public
|
|
2619
2618
|
* <p>The maximum number of results to return.</p>
|
|
2619
|
+
* @public
|
|
2620
2620
|
*/
|
|
2621
2621
|
Limit?: number;
|
|
2622
2622
|
}
|
|
@@ -2625,14 +2625,14 @@ export interface ListRuleNamesByTargetRequest {
|
|
|
2625
2625
|
*/
|
|
2626
2626
|
export interface ListRuleNamesByTargetResponse {
|
|
2627
2627
|
/**
|
|
2628
|
-
* @public
|
|
2629
2628
|
* <p>The names of the rules that can invoke the given target.</p>
|
|
2629
|
+
* @public
|
|
2630
2630
|
*/
|
|
2631
2631
|
RuleNames?: string[];
|
|
2632
2632
|
/**
|
|
2633
|
-
* @public
|
|
2634
2633
|
* <p>Indicates whether there are additional results to retrieve. If there are no more results,
|
|
2635
2634
|
* the value is null.</p>
|
|
2635
|
+
* @public
|
|
2636
2636
|
*/
|
|
2637
2637
|
NextToken?: string;
|
|
2638
2638
|
}
|
|
@@ -2641,82 +2641,82 @@ export interface ListRuleNamesByTargetResponse {
|
|
|
2641
2641
|
*/
|
|
2642
2642
|
export interface ListRulesRequest {
|
|
2643
2643
|
/**
|
|
2644
|
-
* @public
|
|
2645
2644
|
* <p>The prefix matching the rule name.</p>
|
|
2645
|
+
* @public
|
|
2646
2646
|
*/
|
|
2647
2647
|
NamePrefix?: string;
|
|
2648
2648
|
/**
|
|
2649
|
-
* @public
|
|
2650
2649
|
* <p>The name or ARN of the event bus to list the rules for. If you omit this, the default
|
|
2651
2650
|
* event bus is used.</p>
|
|
2651
|
+
* @public
|
|
2652
2652
|
*/
|
|
2653
2653
|
EventBusName?: string;
|
|
2654
2654
|
/**
|
|
2655
|
-
* @public
|
|
2656
2655
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2656
|
+
* @public
|
|
2657
2657
|
*/
|
|
2658
2658
|
NextToken?: string;
|
|
2659
2659
|
/**
|
|
2660
|
-
* @public
|
|
2661
2660
|
* <p>The maximum number of results to return.</p>
|
|
2661
|
+
* @public
|
|
2662
2662
|
*/
|
|
2663
2663
|
Limit?: number;
|
|
2664
2664
|
}
|
|
2665
2665
|
/**
|
|
2666
|
-
* @public
|
|
2667
2666
|
* <p>Contains information about a rule in Amazon EventBridge.</p>
|
|
2667
|
+
* @public
|
|
2668
2668
|
*/
|
|
2669
2669
|
export interface Rule {
|
|
2670
2670
|
/**
|
|
2671
|
-
* @public
|
|
2672
2671
|
* <p>The name of the rule.</p>
|
|
2672
|
+
* @public
|
|
2673
2673
|
*/
|
|
2674
2674
|
Name?: string;
|
|
2675
2675
|
/**
|
|
2676
|
-
* @public
|
|
2677
2676
|
* <p>The Amazon Resource Name (ARN) of the rule.</p>
|
|
2677
|
+
* @public
|
|
2678
2678
|
*/
|
|
2679
2679
|
Arn?: string;
|
|
2680
2680
|
/**
|
|
2681
|
-
* @public
|
|
2682
2681
|
* <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
|
|
2683
2682
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
2683
|
+
* @public
|
|
2684
2684
|
*/
|
|
2685
2685
|
EventPattern?: string;
|
|
2686
2686
|
/**
|
|
2687
|
-
* @public
|
|
2688
2687
|
* <p>The state of the rule.</p>
|
|
2688
|
+
* @public
|
|
2689
2689
|
*/
|
|
2690
2690
|
State?: RuleState;
|
|
2691
2691
|
/**
|
|
2692
|
-
* @public
|
|
2693
2692
|
* <p>The description of the rule.</p>
|
|
2693
|
+
* @public
|
|
2694
2694
|
*/
|
|
2695
2695
|
Description?: string;
|
|
2696
2696
|
/**
|
|
2697
|
-
* @public
|
|
2698
2697
|
* <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>
|
|
2698
|
+
* @public
|
|
2699
2699
|
*/
|
|
2700
2700
|
ScheduleExpression?: string;
|
|
2701
2701
|
/**
|
|
2702
|
-
* @public
|
|
2703
2702
|
* <p>The Amazon Resource Name (ARN) of the role that is used for target invocation.</p>
|
|
2704
2703
|
* <p>If you're setting an event bus in another account as the target and that account granted
|
|
2705
2704
|
* permission to your account through an organization instead of directly by the account ID, you
|
|
2706
2705
|
* must specify a <code>RoleArn</code> with proper permissions in the <code>Target</code>
|
|
2707
2706
|
* structure, instead of here in this parameter.</p>
|
|
2707
|
+
* @public
|
|
2708
2708
|
*/
|
|
2709
2709
|
RoleArn?: string;
|
|
2710
2710
|
/**
|
|
2711
|
-
* @public
|
|
2712
2711
|
* <p>If the rule was created on behalf of your account by an Amazon Web Services service, this field displays
|
|
2713
2712
|
* the principal name of the service that created the rule.</p>
|
|
2713
|
+
* @public
|
|
2714
2714
|
*/
|
|
2715
2715
|
ManagedBy?: string;
|
|
2716
2716
|
/**
|
|
2717
|
-
* @public
|
|
2718
2717
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
2719
2718
|
* event bus is used.</p>
|
|
2719
|
+
* @public
|
|
2720
2720
|
*/
|
|
2721
2721
|
EventBusName?: string;
|
|
2722
2722
|
}
|
|
@@ -2725,14 +2725,14 @@ export interface Rule {
|
|
|
2725
2725
|
*/
|
|
2726
2726
|
export interface ListRulesResponse {
|
|
2727
2727
|
/**
|
|
2728
|
-
* @public
|
|
2729
2728
|
* <p>The rules that match the specified criteria.</p>
|
|
2729
|
+
* @public
|
|
2730
2730
|
*/
|
|
2731
2731
|
Rules?: Rule[];
|
|
2732
2732
|
/**
|
|
2733
|
-
* @public
|
|
2734
2733
|
* <p>Indicates whether there are additional results to retrieve. If there are no more results,
|
|
2735
2734
|
* the value is null.</p>
|
|
2735
|
+
* @public
|
|
2736
2736
|
*/
|
|
2737
2737
|
NextToken?: string;
|
|
2738
2738
|
}
|
|
@@ -2741,8 +2741,8 @@ export interface ListRulesResponse {
|
|
|
2741
2741
|
*/
|
|
2742
2742
|
export interface ListTagsForResourceRequest {
|
|
2743
2743
|
/**
|
|
2744
|
-
* @public
|
|
2745
2744
|
* <p>The ARN of the EventBridge resource for which you want to view tags.</p>
|
|
2745
|
+
* @public
|
|
2746
2746
|
*/
|
|
2747
2747
|
ResourceARN: string | undefined;
|
|
2748
2748
|
}
|
|
@@ -2751,8 +2751,8 @@ export interface ListTagsForResourceRequest {
|
|
|
2751
2751
|
*/
|
|
2752
2752
|
export interface ListTagsForResourceResponse {
|
|
2753
2753
|
/**
|
|
2754
|
-
* @public
|
|
2755
2754
|
* <p>The list of tag keys and values associated with the resource you specified</p>
|
|
2755
|
+
* @public
|
|
2756
2756
|
*/
|
|
2757
2757
|
Tags?: Tag[];
|
|
2758
2758
|
}
|
|
@@ -2761,120 +2761,120 @@ export interface ListTagsForResourceResponse {
|
|
|
2761
2761
|
*/
|
|
2762
2762
|
export interface ListTargetsByRuleRequest {
|
|
2763
2763
|
/**
|
|
2764
|
-
* @public
|
|
2765
2764
|
* <p>The name of the rule.</p>
|
|
2765
|
+
* @public
|
|
2766
2766
|
*/
|
|
2767
2767
|
Rule: string | undefined;
|
|
2768
2768
|
/**
|
|
2769
|
-
* @public
|
|
2770
2769
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
2771
2770
|
* event bus is used.</p>
|
|
2771
|
+
* @public
|
|
2772
2772
|
*/
|
|
2773
2773
|
EventBusName?: string;
|
|
2774
2774
|
/**
|
|
2775
|
-
* @public
|
|
2776
2775
|
* <p>The token returned by a previous call to retrieve the next set of results.</p>
|
|
2776
|
+
* @public
|
|
2777
2777
|
*/
|
|
2778
2778
|
NextToken?: string;
|
|
2779
2779
|
/**
|
|
2780
|
-
* @public
|
|
2781
2780
|
* <p>The maximum number of results to return.</p>
|
|
2781
|
+
* @public
|
|
2782
2782
|
*/
|
|
2783
2783
|
Limit?: number;
|
|
2784
2784
|
}
|
|
2785
2785
|
/**
|
|
2786
|
-
* @public
|
|
2787
2786
|
* <p>The array properties for the submitted job, such as the size of the array. The array size
|
|
2788
2787
|
* can be between 2 and 10,000. If you specify array properties for a job, it becomes an array
|
|
2789
2788
|
* job. This parameter is used only if the target is an Batch job.</p>
|
|
2789
|
+
* @public
|
|
2790
2790
|
*/
|
|
2791
2791
|
export interface BatchArrayProperties {
|
|
2792
2792
|
/**
|
|
2793
|
-
* @public
|
|
2794
2793
|
* <p>The size of the array, if this is an array batch job. Valid values are integers between 2
|
|
2795
2794
|
* and 10,000.</p>
|
|
2795
|
+
* @public
|
|
2796
2796
|
*/
|
|
2797
2797
|
Size?: number;
|
|
2798
2798
|
}
|
|
2799
2799
|
/**
|
|
2800
|
-
* @public
|
|
2801
2800
|
* <p>The retry strategy to use for failed jobs, if the target is an Batch job. If you
|
|
2802
2801
|
* specify a retry strategy here, it overrides the retry strategy defined in the job
|
|
2803
2802
|
* definition.</p>
|
|
2803
|
+
* @public
|
|
2804
2804
|
*/
|
|
2805
2805
|
export interface BatchRetryStrategy {
|
|
2806
2806
|
/**
|
|
2807
|
-
* @public
|
|
2808
2807
|
* <p>The number of times to attempt to retry, if the job fails. Valid values are 1–10.</p>
|
|
2808
|
+
* @public
|
|
2809
2809
|
*/
|
|
2810
2810
|
Attempts?: number;
|
|
2811
2811
|
}
|
|
2812
2812
|
/**
|
|
2813
|
-
* @public
|
|
2814
2813
|
* <p>The custom parameters to be used when the target is an Batch job.</p>
|
|
2814
|
+
* @public
|
|
2815
2815
|
*/
|
|
2816
2816
|
export interface BatchParameters {
|
|
2817
2817
|
/**
|
|
2818
|
-
* @public
|
|
2819
2818
|
* <p>The ARN or name of the job definition to use if the event target is an Batch job. This
|
|
2820
2819
|
* job definition must already exist.</p>
|
|
2820
|
+
* @public
|
|
2821
2821
|
*/
|
|
2822
2822
|
JobDefinition: string | undefined;
|
|
2823
2823
|
/**
|
|
2824
|
-
* @public
|
|
2825
2824
|
* <p>The name to use for this execution of the job, if the target is an Batch job.</p>
|
|
2825
|
+
* @public
|
|
2826
2826
|
*/
|
|
2827
2827
|
JobName: string | undefined;
|
|
2828
2828
|
/**
|
|
2829
|
-
* @public
|
|
2830
2829
|
* <p>The array properties for the submitted job, such as the size of the array. The array size
|
|
2831
2830
|
* can be between 2 and 10,000. If you specify array properties for a job, it becomes an array
|
|
2832
2831
|
* job. This parameter is used only if the target is an Batch job.</p>
|
|
2832
|
+
* @public
|
|
2833
2833
|
*/
|
|
2834
2834
|
ArrayProperties?: BatchArrayProperties;
|
|
2835
2835
|
/**
|
|
2836
|
-
* @public
|
|
2837
2836
|
* <p>The retry strategy to use for failed jobs, if the target is an Batch job. The retry
|
|
2838
2837
|
* strategy is the number of times to retry the failed job execution. Valid values are 1–10. When
|
|
2839
2838
|
* you specify a retry strategy here, it overrides the retry strategy defined in the job
|
|
2840
2839
|
* definition.</p>
|
|
2840
|
+
* @public
|
|
2841
2841
|
*/
|
|
2842
2842
|
RetryStrategy?: BatchRetryStrategy;
|
|
2843
2843
|
}
|
|
2844
2844
|
/**
|
|
2845
|
-
* @public
|
|
2846
2845
|
* <p>A <code>DeadLetterConfig</code> object that contains information about a dead-letter queue
|
|
2847
2846
|
* configuration.</p>
|
|
2847
|
+
* @public
|
|
2848
2848
|
*/
|
|
2849
2849
|
export interface DeadLetterConfig {
|
|
2850
2850
|
/**
|
|
2851
|
-
* @public
|
|
2852
2851
|
* <p>The ARN of the SQS queue specified as the target for the dead-letter queue.</p>
|
|
2852
|
+
* @public
|
|
2853
2853
|
*/
|
|
2854
2854
|
Arn?: string;
|
|
2855
2855
|
}
|
|
2856
2856
|
/**
|
|
2857
|
-
* @public
|
|
2858
2857
|
* <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>
|
|
2858
|
+
* @public
|
|
2859
2859
|
*/
|
|
2860
2860
|
export interface CapacityProviderStrategyItem {
|
|
2861
2861
|
/**
|
|
2862
|
-
* @public
|
|
2863
2862
|
* <p>The short name of the capacity provider.</p>
|
|
2863
|
+
* @public
|
|
2864
2864
|
*/
|
|
2865
2865
|
capacityProvider: string | undefined;
|
|
2866
2866
|
/**
|
|
2867
|
-
* @public
|
|
2868
2867
|
* <p>The weight value designates the relative percentage of the total number of tasks launched
|
|
2869
2868
|
* that should use the specified capacity provider. The weight value is taken into consideration
|
|
2870
2869
|
* after the base value, if defined, is satisfied.</p>
|
|
2870
|
+
* @public
|
|
2871
2871
|
*/
|
|
2872
2872
|
weight?: number;
|
|
2873
2873
|
/**
|
|
2874
|
-
* @public
|
|
2875
2874
|
* <p>The base value designates how many tasks, at a minimum, to run on the specified capacity
|
|
2876
2875
|
* provider. Only one capacity provider in a capacity provider strategy can have a base defined.
|
|
2877
2876
|
* If no value is specified, the default value of 0 is used. </p>
|
|
2877
|
+
* @public
|
|
2878
2878
|
*/
|
|
2879
2879
|
base?: number;
|
|
2880
2880
|
}
|
|
@@ -2892,43 +2892,43 @@ export declare const LaunchType: {
|
|
|
2892
2892
|
*/
|
|
2893
2893
|
export type LaunchType = (typeof LaunchType)[keyof typeof LaunchType];
|
|
2894
2894
|
/**
|
|
2895
|
-
* @public
|
|
2896
2895
|
* <p>This structure specifies the VPC subnets and security groups for the task, and whether a
|
|
2897
2896
|
* public IP address is to be used. This structure is relevant only for ECS tasks that use the
|
|
2898
2897
|
* <code>awsvpc</code> network mode.</p>
|
|
2898
|
+
* @public
|
|
2899
2899
|
*/
|
|
2900
2900
|
export interface AwsVpcConfiguration {
|
|
2901
2901
|
/**
|
|
2902
|
-
* @public
|
|
2903
2902
|
* <p>Specifies the subnets associated with the task. These subnets must all be in the same VPC.
|
|
2904
2903
|
* You can specify as many as 16 subnets.</p>
|
|
2904
|
+
* @public
|
|
2905
2905
|
*/
|
|
2906
2906
|
Subnets: string[] | undefined;
|
|
2907
2907
|
/**
|
|
2908
|
-
* @public
|
|
2909
2908
|
* <p>Specifies the security groups associated with the task. These security groups must all be
|
|
2910
2909
|
* in the same VPC. You can specify as many as five security groups. If you do not specify a
|
|
2911
2910
|
* security group, the default security group for the VPC is used.</p>
|
|
2911
|
+
* @public
|
|
2912
2912
|
*/
|
|
2913
2913
|
SecurityGroups?: string[];
|
|
2914
2914
|
/**
|
|
2915
|
-
* @public
|
|
2916
2915
|
* <p>Specifies whether the task's elastic network interface receives a public IP address. You
|
|
2917
2916
|
* can specify <code>ENABLED</code> only when <code>LaunchType</code> in
|
|
2918
2917
|
* <code>EcsParameters</code> is set to <code>FARGATE</code>.</p>
|
|
2918
|
+
* @public
|
|
2919
2919
|
*/
|
|
2920
2920
|
AssignPublicIp?: AssignPublicIp;
|
|
2921
2921
|
}
|
|
2922
2922
|
/**
|
|
2923
|
-
* @public
|
|
2924
2923
|
* <p>This structure specifies the network configuration for an ECS task.</p>
|
|
2924
|
+
* @public
|
|
2925
2925
|
*/
|
|
2926
2926
|
export interface NetworkConfiguration {
|
|
2927
2927
|
/**
|
|
2928
|
-
* @public
|
|
2929
2928
|
* <p>Use this structure to specify the VPC subnets and security groups for the task, and
|
|
2930
2929
|
* whether a public IP address is to be used. This structure is relevant only for ECS tasks that
|
|
2931
2930
|
* use the <code>awsvpc</code> network mode.</p>
|
|
2931
|
+
* @public
|
|
2932
2932
|
*/
|
|
2933
2933
|
awsvpcConfiguration?: AwsVpcConfiguration;
|
|
2934
2934
|
}
|
|
@@ -2945,23 +2945,23 @@ export declare const PlacementConstraintType: {
|
|
|
2945
2945
|
*/
|
|
2946
2946
|
export type PlacementConstraintType = (typeof PlacementConstraintType)[keyof typeof PlacementConstraintType];
|
|
2947
2947
|
/**
|
|
2948
|
-
* @public
|
|
2949
2948
|
* <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
|
|
2950
2949
|
* Guide.</p>
|
|
2950
|
+
* @public
|
|
2951
2951
|
*/
|
|
2952
2952
|
export interface PlacementConstraint {
|
|
2953
2953
|
/**
|
|
2954
|
-
* @public
|
|
2955
2954
|
* <p>The type of constraint. Use distinctInstance to ensure that each task in a particular
|
|
2956
2955
|
* group is running on a different container instance. Use memberOf to restrict the selection to
|
|
2957
2956
|
* a group of valid candidates. </p>
|
|
2957
|
+
* @public
|
|
2958
2958
|
*/
|
|
2959
2959
|
type?: PlacementConstraintType;
|
|
2960
2960
|
/**
|
|
2961
|
-
* @public
|
|
2962
2961
|
* <p>A cluster query language expression to apply to the constraint. You cannot specify an
|
|
2963
2962
|
* 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.
|
|
2964
2963
|
* </p>
|
|
2964
|
+
* @public
|
|
2965
2965
|
*/
|
|
2966
2966
|
expression?: string;
|
|
2967
2967
|
}
|
|
@@ -2979,28 +2979,28 @@ export declare const PlacementStrategyType: {
|
|
|
2979
2979
|
*/
|
|
2980
2980
|
export type PlacementStrategyType = (typeof PlacementStrategyType)[keyof typeof PlacementStrategyType];
|
|
2981
2981
|
/**
|
|
2982
|
-
* @public
|
|
2983
2982
|
* <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
|
|
2984
2983
|
* Guide.</p>
|
|
2984
|
+
* @public
|
|
2985
2985
|
*/
|
|
2986
2986
|
export interface PlacementStrategy {
|
|
2987
2987
|
/**
|
|
2988
|
-
* @public
|
|
2989
2988
|
* <p>The type of placement strategy. The random placement strategy randomly places tasks on
|
|
2990
2989
|
* available candidates. The spread placement strategy spreads placement across available
|
|
2991
2990
|
* candidates evenly based on the field parameter. The binpack strategy places tasks on available
|
|
2992
2991
|
* candidates that have the least available amount of the resource that is specified with the
|
|
2993
2992
|
* field parameter. For example, if you binpack on memory, a task is placed on the instance with
|
|
2994
2993
|
* the least amount of remaining memory (but still enough to run the task). </p>
|
|
2994
|
+
* @public
|
|
2995
2995
|
*/
|
|
2996
2996
|
type?: PlacementStrategyType;
|
|
2997
2997
|
/**
|
|
2998
|
-
* @public
|
|
2999
2998
|
* <p>The field to apply the placement strategy against. For the spread placement strategy,
|
|
3000
2999
|
* valid values are instanceId (or host, which has the same effect), or any platform or custom
|
|
3001
3000
|
* attribute that is applied to a container instance, such as attribute:ecs.availability-zone.
|
|
3002
3001
|
* For the binpack placement strategy, valid values are cpu and memory. For the random placement
|
|
3003
3002
|
* strategy, this field is not used. </p>
|
|
3003
|
+
* @public
|
|
3004
3004
|
*/
|
|
3005
3005
|
field?: string;
|
|
3006
3006
|
}
|
|
@@ -3016,32 +3016,31 @@ export declare const PropagateTags: {
|
|
|
3016
3016
|
*/
|
|
3017
3017
|
export type PropagateTags = (typeof PropagateTags)[keyof typeof PropagateTags];
|
|
3018
3018
|
/**
|
|
3019
|
-
* @public
|
|
3020
3019
|
* <p>The custom parameters to be used when the target is an Amazon ECS task.</p>
|
|
3020
|
+
* @public
|
|
3021
3021
|
*/
|
|
3022
3022
|
export interface EcsParameters {
|
|
3023
3023
|
/**
|
|
3024
|
-
* @public
|
|
3025
3024
|
* <p>The ARN of the task definition to use if the event target is an Amazon ECS task. </p>
|
|
3025
|
+
* @public
|
|
3026
3026
|
*/
|
|
3027
3027
|
TaskDefinitionArn: string | undefined;
|
|
3028
3028
|
/**
|
|
3029
|
-
* @public
|
|
3030
3029
|
* <p>The number of tasks to create based on <code>TaskDefinition</code>. The default is
|
|
3031
3030
|
* 1.</p>
|
|
3031
|
+
* @public
|
|
3032
3032
|
*/
|
|
3033
3033
|
TaskCount?: number;
|
|
3034
3034
|
/**
|
|
3035
|
-
* @public
|
|
3036
3035
|
* <p>Specifies the launch type on which your task is running. The launch type that you specify
|
|
3037
3036
|
* here must match one of the launch type (compatibilities) of the target task. The
|
|
3038
3037
|
* <code>FARGATE</code> value is supported only in the Regions where Fargate with Amazon ECS
|
|
3039
3038
|
* 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
|
|
3040
3039
|
* the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3040
|
+
* @public
|
|
3041
3041
|
*/
|
|
3042
3042
|
LaunchType?: LaunchType;
|
|
3043
3043
|
/**
|
|
3044
|
-
* @public
|
|
3045
3044
|
* <p>Use this structure if the Amazon ECS task uses the <code>awsvpc</code> network mode. This
|
|
3046
3045
|
* structure specifies the VPC subnets and security groups associated with the task, and whether
|
|
3047
3046
|
* a public IP address is to be used. This structure is required if <code>LaunchType</code> is
|
|
@@ -3049,112 +3048,112 @@ export interface EcsParameters {
|
|
|
3049
3048
|
* tasks.</p>
|
|
3050
3049
|
* <p>If you specify <code>NetworkConfiguration</code> when the target ECS task does not use the
|
|
3051
3050
|
* <code>awsvpc</code> network mode, the task fails.</p>
|
|
3051
|
+
* @public
|
|
3052
3052
|
*/
|
|
3053
3053
|
NetworkConfiguration?: NetworkConfiguration;
|
|
3054
3054
|
/**
|
|
3055
|
-
* @public
|
|
3056
3055
|
* <p>Specifies the platform version for the task. Specify only the numeric portion of the
|
|
3057
3056
|
* platform version, such as <code>1.1.0</code>.</p>
|
|
3058
3057
|
* <p>This structure is used only if <code>LaunchType</code> is <code>FARGATE</code>. For more
|
|
3059
3058
|
* information about valid platform versions, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform
|
|
3060
3059
|
* Versions</a> in the <i>Amazon Elastic Container Service Developer
|
|
3061
3060
|
* Guide</i>.</p>
|
|
3061
|
+
* @public
|
|
3062
3062
|
*/
|
|
3063
3063
|
PlatformVersion?: string;
|
|
3064
3064
|
/**
|
|
3065
|
-
* @public
|
|
3066
3065
|
* <p>Specifies an ECS task group for the task. The maximum length is 255 characters.</p>
|
|
3066
|
+
* @public
|
|
3067
3067
|
*/
|
|
3068
3068
|
Group?: string;
|
|
3069
3069
|
/**
|
|
3070
|
-
* @public
|
|
3071
3070
|
* <p>The capacity provider strategy to use for the task.</p>
|
|
3072
3071
|
* <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>
|
|
3073
3072
|
* parameter must be omitted. If no <code>capacityProviderStrategy</code> or launchType is
|
|
3074
3073
|
* specified, the <code>defaultCapacityProviderStrategy</code> for the cluster is used. </p>
|
|
3074
|
+
* @public
|
|
3075
3075
|
*/
|
|
3076
3076
|
CapacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
3077
3077
|
/**
|
|
3078
|
-
* @public
|
|
3079
3078
|
* <p>Specifies whether to enable Amazon ECS managed tags for the task. For more information,
|
|
3080
3079
|
* 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
|
|
3081
3080
|
* Guide. </p>
|
|
3081
|
+
* @public
|
|
3082
3082
|
*/
|
|
3083
3083
|
EnableECSManagedTags?: boolean;
|
|
3084
3084
|
/**
|
|
3085
|
-
* @public
|
|
3086
3085
|
* <p>Whether or not to enable the execute command functionality for the containers in this
|
|
3087
3086
|
* task. If true, this enables execute command functionality on all containers in the
|
|
3088
3087
|
* task.</p>
|
|
3088
|
+
* @public
|
|
3089
3089
|
*/
|
|
3090
3090
|
EnableExecuteCommand?: boolean;
|
|
3091
3091
|
/**
|
|
3092
|
-
* @public
|
|
3093
3092
|
* <p>An array of placement constraint objects to use for the task. You can specify up to 10
|
|
3094
3093
|
* constraints per task (including constraints in the task definition and those specified at
|
|
3095
3094
|
* runtime).</p>
|
|
3095
|
+
* @public
|
|
3096
3096
|
*/
|
|
3097
3097
|
PlacementConstraints?: PlacementConstraint[];
|
|
3098
3098
|
/**
|
|
3099
|
-
* @public
|
|
3100
3099
|
* <p>The placement strategy objects to use for the task. You can specify a maximum of five
|
|
3101
3100
|
* strategy rules per task. </p>
|
|
3101
|
+
* @public
|
|
3102
3102
|
*/
|
|
3103
3103
|
PlacementStrategy?: PlacementStrategy[];
|
|
3104
3104
|
/**
|
|
3105
|
-
* @public
|
|
3106
3105
|
* <p>Specifies whether to propagate the tags from the task definition to the task. If no value
|
|
3107
3106
|
* is specified, the tags are not propagated. Tags can only be propagated to the task during task
|
|
3108
3107
|
* creation. To add tags to a task after task creation, use the TagResource API action. </p>
|
|
3108
|
+
* @public
|
|
3109
3109
|
*/
|
|
3110
3110
|
PropagateTags?: PropagateTags;
|
|
3111
3111
|
/**
|
|
3112
|
-
* @public
|
|
3113
3112
|
* <p>The reference ID to use for the task.</p>
|
|
3113
|
+
* @public
|
|
3114
3114
|
*/
|
|
3115
3115
|
ReferenceId?: string;
|
|
3116
3116
|
/**
|
|
3117
|
-
* @public
|
|
3118
3117
|
* <p>The metadata that you apply to the task to help you categorize and organize them. Each tag
|
|
3119
3118
|
* 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>
|
|
3119
|
+
* @public
|
|
3120
3120
|
*/
|
|
3121
3121
|
Tags?: Tag[];
|
|
3122
3122
|
}
|
|
3123
3123
|
/**
|
|
3124
|
-
* @public
|
|
3125
3124
|
* <p>These are custom parameter to be used when the target is an API Gateway APIs or
|
|
3126
3125
|
* EventBridge ApiDestinations. In the latter case, these are merged with any
|
|
3127
3126
|
* InvocationParameters specified on the Connection, with any values from the Connection taking
|
|
3128
3127
|
* precedence.</p>
|
|
3128
|
+
* @public
|
|
3129
3129
|
*/
|
|
3130
3130
|
export interface HttpParameters {
|
|
3131
3131
|
/**
|
|
3132
|
-
* @public
|
|
3133
3132
|
* <p>The path parameter values to be used to populate API Gateway API or EventBridge
|
|
3134
3133
|
* ApiDestination path wildcards ("*").</p>
|
|
3134
|
+
* @public
|
|
3135
3135
|
*/
|
|
3136
3136
|
PathParameterValues?: string[];
|
|
3137
3137
|
/**
|
|
3138
|
-
* @public
|
|
3139
3138
|
* <p>The headers that need to be sent as part of request invoking the API Gateway API or
|
|
3140
3139
|
* EventBridge ApiDestination.</p>
|
|
3140
|
+
* @public
|
|
3141
3141
|
*/
|
|
3142
3142
|
HeaderParameters?: Record<string, string>;
|
|
3143
3143
|
/**
|
|
3144
|
-
* @public
|
|
3145
3144
|
* <p>The query string keys/values that need to be sent as part of request invoking the API Gateway
|
|
3146
3145
|
* API or EventBridge ApiDestination.</p>
|
|
3146
|
+
* @public
|
|
3147
3147
|
*/
|
|
3148
3148
|
QueryStringParameters?: Record<string, string>;
|
|
3149
3149
|
}
|
|
3150
3150
|
/**
|
|
3151
|
-
* @public
|
|
3152
3151
|
* <p>Contains the parameters needed for you to provide custom input to a target based on one or
|
|
3153
3152
|
* more pieces of data extracted from the event.</p>
|
|
3153
|
+
* @public
|
|
3154
3154
|
*/
|
|
3155
3155
|
export interface InputTransformer {
|
|
3156
3156
|
/**
|
|
3157
|
-
* @public
|
|
3158
3157
|
* <p>Map of JSON paths to be extracted from the event. You can then insert these in the
|
|
3159
3158
|
* template in <code>InputTemplate</code> to produce the output you want to be sent to the
|
|
3160
3159
|
* target.</p>
|
|
@@ -3163,10 +3162,10 @@ export interface InputTransformer {
|
|
|
3163
3162
|
* path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket
|
|
3164
3163
|
* notation.</p>
|
|
3165
3164
|
* <p>The keys cannot start with "Amazon Web Services." </p>
|
|
3165
|
+
* @public
|
|
3166
3166
|
*/
|
|
3167
3167
|
InputPathsMap?: Record<string, string>;
|
|
3168
3168
|
/**
|
|
3169
|
-
* @public
|
|
3170
3169
|
* <p>Input template where you specify placeholders that will be filled with the values of the
|
|
3171
3170
|
* keys from <code>InputPathsMap</code> to customize the data sent to the target. Enclose each
|
|
3172
3171
|
* <code>InputPathsMaps</code> value in brackets: <<i>value</i>>
|
|
@@ -3233,170 +3232,170 @@ export interface InputTransformer {
|
|
|
3233
3232
|
* <p>
|
|
3234
3233
|
* <code>\}</code>
|
|
3235
3234
|
* </p>
|
|
3235
|
+
* @public
|
|
3236
3236
|
*/
|
|
3237
3237
|
InputTemplate: string | undefined;
|
|
3238
3238
|
}
|
|
3239
3239
|
/**
|
|
3240
|
-
* @public
|
|
3241
3240
|
* <p>This object enables you to specify a JSON path to extract from the event and use as the
|
|
3242
3241
|
* partition key for the Amazon Kinesis data stream, so that you can control the shard to which
|
|
3243
3242
|
* the event goes. If you do not include this parameter, the default is to use the
|
|
3244
3243
|
* <code>eventId</code> as the partition key.</p>
|
|
3244
|
+
* @public
|
|
3245
3245
|
*/
|
|
3246
3246
|
export interface KinesisParameters {
|
|
3247
3247
|
/**
|
|
3248
|
-
* @public
|
|
3249
3248
|
* <p>The JSON path to be extracted from the event and used as the partition key. For more
|
|
3250
3249
|
* information, see <a href="https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key">Amazon Kinesis Streams Key
|
|
3251
3250
|
* Concepts</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p>
|
|
3251
|
+
* @public
|
|
3252
3252
|
*/
|
|
3253
3253
|
PartitionKeyPath: string | undefined;
|
|
3254
3254
|
}
|
|
3255
3255
|
/**
|
|
3256
|
-
* @public
|
|
3257
3256
|
* <p>These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the
|
|
3258
3257
|
* Amazon Redshift Data API ExecuteStatement based on EventBridge events.</p>
|
|
3258
|
+
* @public
|
|
3259
3259
|
*/
|
|
3260
3260
|
export interface RedshiftDataParameters {
|
|
3261
3261
|
/**
|
|
3262
|
-
* @public
|
|
3263
3262
|
* <p>The name or ARN of the secret that enables access to the database. Required when
|
|
3264
3263
|
* authenticating using Amazon Web Services Secrets Manager.</p>
|
|
3264
|
+
* @public
|
|
3265
3265
|
*/
|
|
3266
3266
|
SecretManagerArn?: string;
|
|
3267
3267
|
/**
|
|
3268
|
-
* @public
|
|
3269
3268
|
* <p>The name of the database. Required when authenticating using temporary credentials.</p>
|
|
3269
|
+
* @public
|
|
3270
3270
|
*/
|
|
3271
3271
|
Database: string | undefined;
|
|
3272
3272
|
/**
|
|
3273
|
-
* @public
|
|
3274
3273
|
* <p>The database user name. Required when authenticating using temporary credentials.</p>
|
|
3274
|
+
* @public
|
|
3275
3275
|
*/
|
|
3276
3276
|
DbUser?: string;
|
|
3277
3277
|
/**
|
|
3278
|
-
* @public
|
|
3279
3278
|
* <p>The SQL statement text to run.</p>
|
|
3279
|
+
* @public
|
|
3280
3280
|
*/
|
|
3281
3281
|
Sql?: string;
|
|
3282
3282
|
/**
|
|
3283
|
-
* @public
|
|
3284
3283
|
* <p>The name of the SQL statement. You can name the SQL statement when you create it to
|
|
3285
3284
|
* identify the query.</p>
|
|
3285
|
+
* @public
|
|
3286
3286
|
*/
|
|
3287
3287
|
StatementName?: string;
|
|
3288
3288
|
/**
|
|
3289
|
-
* @public
|
|
3290
3289
|
* <p>Indicates whether to send an event back to EventBridge after the SQL statement
|
|
3291
3290
|
* runs.</p>
|
|
3291
|
+
* @public
|
|
3292
3292
|
*/
|
|
3293
3293
|
WithEvent?: boolean;
|
|
3294
3294
|
/**
|
|
3295
|
-
* @public
|
|
3296
3295
|
* <p>One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array.
|
|
3297
3296
|
* Subsequent SQL statements don't start until the previous statement in the array completes.
|
|
3298
3297
|
* If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>
|
|
3298
|
+
* @public
|
|
3299
3299
|
*/
|
|
3300
3300
|
Sqls?: string[];
|
|
3301
3301
|
}
|
|
3302
3302
|
/**
|
|
3303
|
-
* @public
|
|
3304
3303
|
* <p>A <code>RetryPolicy</code> object that includes information about the retry policy
|
|
3305
3304
|
* settings.</p>
|
|
3305
|
+
* @public
|
|
3306
3306
|
*/
|
|
3307
3307
|
export interface RetryPolicy {
|
|
3308
3308
|
/**
|
|
3309
|
-
* @public
|
|
3310
3309
|
* <p>The maximum number of retry attempts to make before the request fails. Retry attempts
|
|
3311
3310
|
* continue until either the maximum number of attempts is made or until the duration of the
|
|
3312
3311
|
* <code>MaximumEventAgeInSeconds</code> is met.</p>
|
|
3312
|
+
* @public
|
|
3313
3313
|
*/
|
|
3314
3314
|
MaximumRetryAttempts?: number;
|
|
3315
3315
|
/**
|
|
3316
|
-
* @public
|
|
3317
3316
|
* <p>The maximum amount of time, in seconds, to continue to make retry attempts.</p>
|
|
3317
|
+
* @public
|
|
3318
3318
|
*/
|
|
3319
3319
|
MaximumEventAgeInSeconds?: number;
|
|
3320
3320
|
}
|
|
3321
3321
|
/**
|
|
3322
|
-
* @public
|
|
3323
3322
|
* <p>Information about the EC2 instances that are to be sent the command, specified as
|
|
3324
3323
|
* key-value pairs. Each <code>RunCommandTarget</code> block can include only one key, but this
|
|
3325
3324
|
* key may specify multiple values.</p>
|
|
3325
|
+
* @public
|
|
3326
3326
|
*/
|
|
3327
3327
|
export interface RunCommandTarget {
|
|
3328
3328
|
/**
|
|
3329
|
-
* @public
|
|
3330
3329
|
* <p>Can be either <code>tag:</code>
|
|
3331
3330
|
* <i>tag-key</i> or
|
|
3332
3331
|
* <code>InstanceIds</code>.</p>
|
|
3332
|
+
* @public
|
|
3333
3333
|
*/
|
|
3334
3334
|
Key: string | undefined;
|
|
3335
3335
|
/**
|
|
3336
|
-
* @public
|
|
3337
3336
|
* <p>If <code>Key</code> is <code>tag:</code>
|
|
3338
3337
|
* <i>tag-key</i>, <code>Values</code>
|
|
3339
3338
|
* is a list of tag values. If <code>Key</code> is <code>InstanceIds</code>, <code>Values</code>
|
|
3340
3339
|
* is a list of Amazon EC2 instance IDs.</p>
|
|
3340
|
+
* @public
|
|
3341
3341
|
*/
|
|
3342
3342
|
Values: string[] | undefined;
|
|
3343
3343
|
}
|
|
3344
3344
|
/**
|
|
3345
|
-
* @public
|
|
3346
3345
|
* <p>This parameter contains the criteria (either InstanceIds or a tag) used to specify which
|
|
3347
3346
|
* EC2 instances are to be sent the command. </p>
|
|
3347
|
+
* @public
|
|
3348
3348
|
*/
|
|
3349
3349
|
export interface RunCommandParameters {
|
|
3350
3350
|
/**
|
|
3351
|
-
* @public
|
|
3352
3351
|
* <p>Currently, we support including only one RunCommandTarget block, which specifies either an
|
|
3353
3352
|
* array of InstanceIds or a tag.</p>
|
|
3353
|
+
* @public
|
|
3354
3354
|
*/
|
|
3355
3355
|
RunCommandTargets: RunCommandTarget[] | undefined;
|
|
3356
3356
|
}
|
|
3357
3357
|
/**
|
|
3358
|
-
* @public
|
|
3359
3358
|
* <p>Name/Value pair of a parameter to start execution of a SageMaker Model Building
|
|
3360
3359
|
* Pipeline.</p>
|
|
3360
|
+
* @public
|
|
3361
3361
|
*/
|
|
3362
3362
|
export interface SageMakerPipelineParameter {
|
|
3363
3363
|
/**
|
|
3364
|
-
* @public
|
|
3365
3364
|
* <p>Name of parameter to start execution of a SageMaker Model Building Pipeline.</p>
|
|
3365
|
+
* @public
|
|
3366
3366
|
*/
|
|
3367
3367
|
Name: string | undefined;
|
|
3368
3368
|
/**
|
|
3369
|
-
* @public
|
|
3370
3369
|
* <p>Value of parameter to start execution of a SageMaker Model Building Pipeline.</p>
|
|
3370
|
+
* @public
|
|
3371
3371
|
*/
|
|
3372
3372
|
Value: string | undefined;
|
|
3373
3373
|
}
|
|
3374
3374
|
/**
|
|
3375
|
-
* @public
|
|
3376
3375
|
* <p>These are custom parameters to use when the target is a SageMaker Model Building Pipeline
|
|
3377
3376
|
* that starts based on EventBridge events.</p>
|
|
3377
|
+
* @public
|
|
3378
3378
|
*/
|
|
3379
3379
|
export interface SageMakerPipelineParameters {
|
|
3380
3380
|
/**
|
|
3381
|
-
* @public
|
|
3382
3381
|
* <p>List of Parameter names and values for SageMaker Model Building Pipeline execution.</p>
|
|
3382
|
+
* @public
|
|
3383
3383
|
*/
|
|
3384
3384
|
PipelineParameterList?: SageMakerPipelineParameter[];
|
|
3385
3385
|
}
|
|
3386
3386
|
/**
|
|
3387
|
-
* @public
|
|
3388
3387
|
* <p>This structure includes the custom parameter to be used when the target is an SQS FIFO
|
|
3389
3388
|
* queue.</p>
|
|
3389
|
+
* @public
|
|
3390
3390
|
*/
|
|
3391
3391
|
export interface SqsParameters {
|
|
3392
3392
|
/**
|
|
3393
|
-
* @public
|
|
3394
3393
|
* <p>The FIFO message group ID to use as the target.</p>
|
|
3394
|
+
* @public
|
|
3395
3395
|
*/
|
|
3396
3396
|
MessageGroupId?: string;
|
|
3397
3397
|
}
|
|
3398
3398
|
/**
|
|
3399
|
-
* @public
|
|
3400
3399
|
* <p>Targets are the resources to be invoked when a rule is triggered. For a complete list of
|
|
3401
3400
|
* 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>
|
|
3402
3401
|
* <p>If you are setting the event bus of another account as the target, and that account
|
|
@@ -3405,82 +3404,82 @@ export interface SqsParameters {
|
|
|
3405
3404
|
* <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
|
|
3406
3405
|
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User
|
|
3407
3406
|
* Guide</i>.</p>
|
|
3407
|
+
* @public
|
|
3408
3408
|
*/
|
|
3409
3409
|
export interface Target {
|
|
3410
3410
|
/**
|
|
3411
|
-
* @public
|
|
3412
3411
|
* <p>The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.</p>
|
|
3412
|
+
* @public
|
|
3413
3413
|
*/
|
|
3414
3414
|
Id: string | undefined;
|
|
3415
3415
|
/**
|
|
3416
|
-
* @public
|
|
3417
3416
|
* <p>The Amazon Resource Name (ARN) of the target.</p>
|
|
3417
|
+
* @public
|
|
3418
3418
|
*/
|
|
3419
3419
|
Arn: string | undefined;
|
|
3420
3420
|
/**
|
|
3421
|
-
* @public
|
|
3422
3421
|
* <p>The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is
|
|
3423
3422
|
* triggered. If one rule triggers multiple targets, you can use a different IAM role for each
|
|
3424
3423
|
* target.</p>
|
|
3424
|
+
* @public
|
|
3425
3425
|
*/
|
|
3426
3426
|
RoleArn?: string;
|
|
3427
3427
|
/**
|
|
3428
|
-
* @public
|
|
3429
3428
|
* <p>Valid JSON text passed to the target. In this case, nothing from the event itself is
|
|
3430
3429
|
* passed to the target. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data
|
|
3431
3430
|
* Interchange Format</a>.</p>
|
|
3431
|
+
* @public
|
|
3432
3432
|
*/
|
|
3433
3433
|
Input?: string;
|
|
3434
3434
|
/**
|
|
3435
|
-
* @public
|
|
3436
3435
|
* <p>The value of the JSONPath that is used for extracting part of the matched event when
|
|
3437
3436
|
* passing it to the target. You may use JSON dot notation or bracket notation. For more
|
|
3438
3437
|
* information about JSON paths, see <a href="http://goessner.net/articles/JsonPath/">JSONPath</a>.</p>
|
|
3438
|
+
* @public
|
|
3439
3439
|
*/
|
|
3440
3440
|
InputPath?: string;
|
|
3441
3441
|
/**
|
|
3442
|
-
* @public
|
|
3443
3442
|
* <p>Settings to enable you to provide custom input to a target based on certain event data.
|
|
3444
3443
|
* You can extract one or more key-value pairs from the event and then use that data to send
|
|
3445
3444
|
* customized input to the target.</p>
|
|
3445
|
+
* @public
|
|
3446
3446
|
*/
|
|
3447
3447
|
InputTransformer?: InputTransformer;
|
|
3448
3448
|
/**
|
|
3449
|
-
* @public
|
|
3450
3449
|
* <p>The custom parameter you can use to control the shard assignment, when the target is a
|
|
3451
3450
|
* Kinesis data stream. If you do not include this parameter, the default is to use the
|
|
3452
3451
|
* <code>eventId</code> as the partition key.</p>
|
|
3452
|
+
* @public
|
|
3453
3453
|
*/
|
|
3454
3454
|
KinesisParameters?: KinesisParameters;
|
|
3455
3455
|
/**
|
|
3456
|
-
* @public
|
|
3457
3456
|
* <p>Parameters used when you are using the rule to invoke Amazon EC2 Run Command.</p>
|
|
3457
|
+
* @public
|
|
3458
3458
|
*/
|
|
3459
3459
|
RunCommandParameters?: RunCommandParameters;
|
|
3460
3460
|
/**
|
|
3461
|
-
* @public
|
|
3462
3461
|
* <p>Contains the Amazon ECS task definition and task count to be used, if the event target is
|
|
3463
3462
|
* 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
|
|
3464
3463
|
* Definitions </a> in the <i>Amazon EC2 Container Service Developer
|
|
3465
3464
|
* Guide</i>.</p>
|
|
3465
|
+
* @public
|
|
3466
3466
|
*/
|
|
3467
3467
|
EcsParameters?: EcsParameters;
|
|
3468
3468
|
/**
|
|
3469
|
-
* @public
|
|
3470
3469
|
* <p>If the event target is an Batch job, this contains the job definition, job name, and
|
|
3471
3470
|
* 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
|
|
3472
3471
|
* Guide</i>.</p>
|
|
3472
|
+
* @public
|
|
3473
3473
|
*/
|
|
3474
3474
|
BatchParameters?: BatchParameters;
|
|
3475
3475
|
/**
|
|
3476
|
-
* @public
|
|
3477
3476
|
* <p>Contains the message group ID to use when the target is a FIFO queue.</p>
|
|
3478
3477
|
* <p>If you specify an SQS FIFO queue as a target, the queue must have content-based
|
|
3479
3478
|
* deduplication enabled.</p>
|
|
3479
|
+
* @public
|
|
3480
3480
|
*/
|
|
3481
3481
|
SqsParameters?: SqsParameters;
|
|
3482
3482
|
/**
|
|
3483
|
-
* @public
|
|
3484
3483
|
* <p>Contains the HTTP parameters to use when the target is a API Gateway endpoint or
|
|
3485
3484
|
* EventBridge ApiDestination.</p>
|
|
3486
3485
|
* <p>If you specify an API Gateway API or EventBridge ApiDestination as a target, you can
|
|
@@ -3488,39 +3487,40 @@ export interface Target {
|
|
|
3488
3487
|
* of your target invoking request. If you're using ApiDestinations, the corresponding Connection
|
|
3489
3488
|
* can also have these values configured. In case of any conflicting keys, values from the
|
|
3490
3489
|
* Connection take precedence.</p>
|
|
3490
|
+
* @public
|
|
3491
3491
|
*/
|
|
3492
3492
|
HttpParameters?: HttpParameters;
|
|
3493
3493
|
/**
|
|
3494
|
-
* @public
|
|
3495
3494
|
* <p>Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift
|
|
3496
3495
|
* cluster.</p>
|
|
3497
3496
|
* <p>If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to
|
|
3498
3497
|
* invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.</p>
|
|
3498
|
+
* @public
|
|
3499
3499
|
*/
|
|
3500
3500
|
RedshiftDataParameters?: RedshiftDataParameters;
|
|
3501
3501
|
/**
|
|
3502
|
-
* @public
|
|
3503
3502
|
* <p>Contains the SageMaker Model Building Pipeline parameters to start execution of a
|
|
3504
3503
|
* SageMaker Model Building Pipeline.</p>
|
|
3505
3504
|
* <p>If you specify a SageMaker Model Building Pipeline as a target, you can use this to
|
|
3506
3505
|
* specify parameters to start a pipeline execution based on EventBridge events.</p>
|
|
3506
|
+
* @public
|
|
3507
3507
|
*/
|
|
3508
3508
|
SageMakerPipelineParameters?: SageMakerPipelineParameters;
|
|
3509
3509
|
/**
|
|
3510
|
-
* @public
|
|
3511
3510
|
* <p>The <code>DeadLetterConfig</code> that defines the target queue to send dead-letter queue
|
|
3512
3511
|
* events to.</p>
|
|
3512
|
+
* @public
|
|
3513
3513
|
*/
|
|
3514
3514
|
DeadLetterConfig?: DeadLetterConfig;
|
|
3515
3515
|
/**
|
|
3516
|
-
* @public
|
|
3517
3516
|
* <p>The <code>RetryPolicy</code> object that contains the retry policy configuration to use
|
|
3518
3517
|
* for the dead-letter queue.</p>
|
|
3518
|
+
* @public
|
|
3519
3519
|
*/
|
|
3520
3520
|
RetryPolicy?: RetryPolicy;
|
|
3521
3521
|
/**
|
|
3522
|
-
* @public
|
|
3523
3522
|
* <p>Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.</p>
|
|
3523
|
+
* @public
|
|
3524
3524
|
*/
|
|
3525
3525
|
AppSyncParameters?: AppSyncParameters;
|
|
3526
3526
|
}
|
|
@@ -3529,29 +3529,28 @@ export interface Target {
|
|
|
3529
3529
|
*/
|
|
3530
3530
|
export interface ListTargetsByRuleResponse {
|
|
3531
3531
|
/**
|
|
3532
|
-
* @public
|
|
3533
3532
|
* <p>The targets assigned to the rule.</p>
|
|
3533
|
+
* @public
|
|
3534
3534
|
*/
|
|
3535
3535
|
Targets?: Target[];
|
|
3536
3536
|
/**
|
|
3537
|
-
* @public
|
|
3538
3537
|
* <p>Indicates whether there are additional results to retrieve. If there are no more results,
|
|
3539
3538
|
* the value is null.</p>
|
|
3539
|
+
* @public
|
|
3540
3540
|
*/
|
|
3541
3541
|
NextToken?: string;
|
|
3542
3542
|
}
|
|
3543
3543
|
/**
|
|
3544
|
-
* @public
|
|
3545
3544
|
* <p>Represents an event to be submitted.</p>
|
|
3545
|
+
* @public
|
|
3546
3546
|
*/
|
|
3547
3547
|
export interface PutEventsRequestEntry {
|
|
3548
3548
|
/**
|
|
3549
|
-
* @public
|
|
3550
3549
|
* <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>
|
|
3550
|
+
* @public
|
|
3551
3551
|
*/
|
|
3552
3552
|
Time?: Date;
|
|
3553
3553
|
/**
|
|
3554
|
-
* @public
|
|
3555
3554
|
* <p>The source of the event.</p>
|
|
3556
3555
|
* <note>
|
|
3557
3556
|
* <p>
|
|
@@ -3560,16 +3559,16 @@ export interface PutEventsRequestEntry {
|
|
|
3560
3559
|
* If you submit a request in which <i>none</i> of the entries have each of these properties, EventBridge fails the entire request.
|
|
3561
3560
|
* </p>
|
|
3562
3561
|
* </note>
|
|
3562
|
+
* @public
|
|
3563
3563
|
*/
|
|
3564
3564
|
Source?: string;
|
|
3565
3565
|
/**
|
|
3566
|
-
* @public
|
|
3567
3566
|
* <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
|
|
3568
3567
|
* concerns. Any number, including zero, may be present.</p>
|
|
3568
|
+
* @public
|
|
3569
3569
|
*/
|
|
3570
3570
|
Resources?: string[];
|
|
3571
3571
|
/**
|
|
3572
|
-
* @public
|
|
3573
3572
|
* <p>Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</p>
|
|
3574
3573
|
* <note>
|
|
3575
3574
|
* <p>
|
|
@@ -3578,10 +3577,10 @@ export interface PutEventsRequestEntry {
|
|
|
3578
3577
|
* If you submit a request in which <i>none</i> of the entries have each of these properties, EventBridge fails the entire request.
|
|
3579
3578
|
* </p>
|
|
3580
3579
|
* </note>
|
|
3580
|
+
* @public
|
|
3581
3581
|
*/
|
|
3582
3582
|
DetailType?: string;
|
|
3583
3583
|
/**
|
|
3584
|
-
* @public
|
|
3585
3584
|
* <p>A valid JSON object. There is no other schema imposed. The JSON object may contain fields
|
|
3586
3585
|
* and nested sub-objects.</p>
|
|
3587
3586
|
* <note>
|
|
@@ -3591,10 +3590,10 @@ export interface PutEventsRequestEntry {
|
|
|
3591
3590
|
* If you submit a request in which <i>none</i> of the entries have each of these properties, EventBridge fails the entire request.
|
|
3592
3591
|
* </p>
|
|
3593
3592
|
* </note>
|
|
3593
|
+
* @public
|
|
3594
3594
|
*/
|
|
3595
3595
|
Detail?: string;
|
|
3596
3596
|
/**
|
|
3597
|
-
* @public
|
|
3598
3597
|
* <p>The name or ARN of the event bus to receive the event. Only the rules that are associated
|
|
3599
3598
|
* with this event bus are used to match the event. If you omit this, the default event bus is
|
|
3600
3599
|
* used.</p>
|
|
@@ -3603,13 +3602,14 @@ export interface PutEventsRequestEntry {
|
|
|
3603
3602
|
* in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the
|
|
3604
3603
|
* other Region based on the endpoint referenced by the <code>EndpointId</code>. Specifying the event bus ARN is preferred.</p>
|
|
3605
3604
|
* </note>
|
|
3605
|
+
* @public
|
|
3606
3606
|
*/
|
|
3607
3607
|
EventBusName?: string;
|
|
3608
3608
|
/**
|
|
3609
|
-
* @public
|
|
3610
3609
|
* <p>An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the
|
|
3611
3610
|
* trace-id associated with the event.</p>
|
|
3612
3611
|
* <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>
|
|
3612
|
+
* @public
|
|
3613
3613
|
*/
|
|
3614
3614
|
TraceHeader?: string;
|
|
3615
3615
|
}
|
|
@@ -3618,37 +3618,36 @@ export interface PutEventsRequestEntry {
|
|
|
3618
3618
|
*/
|
|
3619
3619
|
export interface PutEventsRequest {
|
|
3620
3620
|
/**
|
|
3621
|
-
* @public
|
|
3622
3621
|
* <p>The entry that defines an event in your system. You can specify several parameters for the
|
|
3623
3622
|
* entry such as the source and type of the event, resources associated with the event, and so
|
|
3624
3623
|
* on.</p>
|
|
3624
|
+
* @public
|
|
3625
3625
|
*/
|
|
3626
3626
|
Entries: PutEventsRequestEntry[] | undefined;
|
|
3627
3627
|
/**
|
|
3628
|
-
* @public
|
|
3629
3628
|
* <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p>
|
|
3630
3629
|
* <important>
|
|
3631
3630
|
* <p>When using Java, you must include <code>auth-crt</code> on the class path.</p>
|
|
3632
3631
|
* </important>
|
|
3632
|
+
* @public
|
|
3633
3633
|
*/
|
|
3634
3634
|
EndpointId?: string;
|
|
3635
3635
|
}
|
|
3636
3636
|
/**
|
|
3637
|
-
* @public
|
|
3638
3637
|
* <p>Represents the results of an event submitted to an event bus.</p>
|
|
3639
3638
|
* <p>If the submission was successful, the entry has the event ID in it.
|
|
3640
3639
|
* Otherwise, you can use the error code and error message to identify the problem with the entry.</p>
|
|
3641
3640
|
* <p>For information about the errors that are common to all actions, see
|
|
3642
3641
|
* <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
3642
|
+
* @public
|
|
3643
3643
|
*/
|
|
3644
3644
|
export interface PutEventsResultEntry {
|
|
3645
3645
|
/**
|
|
3646
|
-
* @public
|
|
3647
3646
|
* <p>The ID of the event.</p>
|
|
3647
|
+
* @public
|
|
3648
3648
|
*/
|
|
3649
3649
|
EventId?: string;
|
|
3650
3650
|
/**
|
|
3651
|
-
* @public
|
|
3652
3651
|
* <p>The error code that indicates why the event submission failed.</p>
|
|
3653
3652
|
* <p>Retryable errors include:</p>
|
|
3654
3653
|
* <ul>
|
|
@@ -3716,11 +3715,12 @@ export interface PutEventsResultEntry {
|
|
|
3716
3715
|
* <p>You do not have permissions to publish events with this detail type onto this event bus.</p>
|
|
3717
3716
|
* </li>
|
|
3718
3717
|
* </ul>
|
|
3718
|
+
* @public
|
|
3719
3719
|
*/
|
|
3720
3720
|
ErrorCode?: string;
|
|
3721
3721
|
/**
|
|
3722
|
-
* @public
|
|
3723
3722
|
* <p>The error message that explains why the event submission failed.</p>
|
|
3723
|
+
* @public
|
|
3724
3724
|
*/
|
|
3725
3725
|
ErrorMessage?: string;
|
|
3726
3726
|
}
|
|
@@ -3729,31 +3729,30 @@ export interface PutEventsResultEntry {
|
|
|
3729
3729
|
*/
|
|
3730
3730
|
export interface PutEventsResponse {
|
|
3731
3731
|
/**
|
|
3732
|
-
* @public
|
|
3733
3732
|
* <p>The number of failed entries.</p>
|
|
3733
|
+
* @public
|
|
3734
3734
|
*/
|
|
3735
3735
|
FailedEntryCount?: number;
|
|
3736
3736
|
/**
|
|
3737
|
-
* @public
|
|
3738
3737
|
* <p>The successfully and unsuccessfully ingested events results. If the ingestion was
|
|
3739
3738
|
* successful, the entry has the event ID in it. Otherwise, you can use the error code and error
|
|
3740
3739
|
* message to identify the problem with the entry.</p>
|
|
3741
3740
|
* <p>For each record, the index of the response element is the same as the index in the request array.</p>
|
|
3741
|
+
* @public
|
|
3742
3742
|
*/
|
|
3743
3743
|
Entries?: PutEventsResultEntry[];
|
|
3744
3744
|
}
|
|
3745
3745
|
/**
|
|
3746
|
-
* @public
|
|
3747
3746
|
* <p>The details about an event generated by an SaaS partner.</p>
|
|
3747
|
+
* @public
|
|
3748
3748
|
*/
|
|
3749
3749
|
export interface PutPartnerEventsRequestEntry {
|
|
3750
3750
|
/**
|
|
3751
|
-
* @public
|
|
3752
3751
|
* <p>The date and time of the event.</p>
|
|
3752
|
+
* @public
|
|
3753
3753
|
*/
|
|
3754
3754
|
Time?: Date;
|
|
3755
3755
|
/**
|
|
3756
|
-
* @public
|
|
3757
3756
|
* <p>The event source that is generating the entry.</p>
|
|
3758
3757
|
* <note>
|
|
3759
3758
|
* <p>
|
|
@@ -3762,16 +3761,16 @@ export interface PutPartnerEventsRequestEntry {
|
|
|
3762
3761
|
* If you submit a request in which <i>none</i> of the entries have each of these properties, EventBridge fails the entire request.
|
|
3763
3762
|
* </p>
|
|
3764
3763
|
* </note>
|
|
3764
|
+
* @public
|
|
3765
3765
|
*/
|
|
3766
3766
|
Source?: string;
|
|
3767
3767
|
/**
|
|
3768
|
-
* @public
|
|
3769
3768
|
* <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
|
|
3770
3769
|
* concerns. Any number, including zero, may be present.</p>
|
|
3770
|
+
* @public
|
|
3771
3771
|
*/
|
|
3772
3772
|
Resources?: string[];
|
|
3773
3773
|
/**
|
|
3774
|
-
* @public
|
|
3775
3774
|
* <p>A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</p>
|
|
3776
3775
|
* <note>
|
|
3777
3776
|
* <p>
|
|
@@ -3780,10 +3779,10 @@ export interface PutPartnerEventsRequestEntry {
|
|
|
3780
3779
|
* If you submit a request in which <i>none</i> of the entries have each of these properties, EventBridge fails the entire request.
|
|
3781
3780
|
* </p>
|
|
3782
3781
|
* </note>
|
|
3782
|
+
* @public
|
|
3783
3783
|
*/
|
|
3784
3784
|
DetailType?: string;
|
|
3785
3785
|
/**
|
|
3786
|
-
* @public
|
|
3787
3786
|
* <p>A valid JSON string. There is no other schema imposed. The JSON string may contain fields
|
|
3788
3787
|
* and nested sub-objects.</p>
|
|
3789
3788
|
* <note>
|
|
@@ -3793,6 +3792,7 @@ export interface PutPartnerEventsRequestEntry {
|
|
|
3793
3792
|
* If you submit a request in which <i>none</i> of the entries have each of these properties, EventBridge fails the entire request.
|
|
3794
3793
|
* </p>
|
|
3795
3794
|
* </note>
|
|
3795
|
+
* @public
|
|
3796
3796
|
*/
|
|
3797
3797
|
Detail?: string;
|
|
3798
3798
|
}
|
|
@@ -3801,31 +3801,31 @@ export interface PutPartnerEventsRequestEntry {
|
|
|
3801
3801
|
*/
|
|
3802
3802
|
export interface PutPartnerEventsRequest {
|
|
3803
3803
|
/**
|
|
3804
|
-
* @public
|
|
3805
3804
|
* <p>The list of events to write to the event bus.</p>
|
|
3805
|
+
* @public
|
|
3806
3806
|
*/
|
|
3807
3807
|
Entries: PutPartnerEventsRequestEntry[] | undefined;
|
|
3808
3808
|
}
|
|
3809
3809
|
/**
|
|
3810
|
-
* @public
|
|
3811
3810
|
* <p>The result of an event entry the partner submitted in this request.
|
|
3812
3811
|
* If the event was successfully submitted, the entry has the event ID in it.
|
|
3813
3812
|
* Otherwise, you can use the error code and error message to identify the problem with the entry.</p>
|
|
3813
|
+
* @public
|
|
3814
3814
|
*/
|
|
3815
3815
|
export interface PutPartnerEventsResultEntry {
|
|
3816
3816
|
/**
|
|
3817
|
-
* @public
|
|
3818
3817
|
* <p>The ID of the event.</p>
|
|
3818
|
+
* @public
|
|
3819
3819
|
*/
|
|
3820
3820
|
EventId?: string;
|
|
3821
3821
|
/**
|
|
3822
|
-
* @public
|
|
3823
3822
|
* <p>The error code that indicates why the event submission failed.</p>
|
|
3823
|
+
* @public
|
|
3824
3824
|
*/
|
|
3825
3825
|
ErrorCode?: string;
|
|
3826
3826
|
/**
|
|
3827
|
-
* @public
|
|
3828
3827
|
* <p>The error message that explains why the event submission failed.</p>
|
|
3828
|
+
* @public
|
|
3829
3829
|
*/
|
|
3830
3830
|
ErrorMessage?: string;
|
|
3831
3831
|
}
|
|
@@ -3834,23 +3834,23 @@ export interface PutPartnerEventsResultEntry {
|
|
|
3834
3834
|
*/
|
|
3835
3835
|
export interface PutPartnerEventsResponse {
|
|
3836
3836
|
/**
|
|
3837
|
-
* @public
|
|
3838
3837
|
* <p>The number of events from this operation that could not be written to the partner event
|
|
3839
3838
|
* bus.</p>
|
|
3839
|
+
* @public
|
|
3840
3840
|
*/
|
|
3841
3841
|
FailedEntryCount?: number;
|
|
3842
3842
|
/**
|
|
3843
|
-
* @public
|
|
3844
3843
|
* <p>The results for each event entry the partner submitted in this request.
|
|
3845
3844
|
* If the event was successfully submitted, the entry has the event ID in it.
|
|
3846
3845
|
* Otherwise, you can use the error code and error message to identify the problem with the entry.</p>
|
|
3847
3846
|
* <p>For each record, the index of the response element is the same as the index in the request array.</p>
|
|
3847
|
+
* @public
|
|
3848
3848
|
*/
|
|
3849
3849
|
Entries?: PutPartnerEventsResultEntry[];
|
|
3850
3850
|
}
|
|
3851
3851
|
/**
|
|
3852
|
-
* @public
|
|
3853
3852
|
* <p>The event bus policy is too long. For more information, see the limits.</p>
|
|
3853
|
+
* @public
|
|
3854
3854
|
*/
|
|
3855
3855
|
export declare class PolicyLengthExceededException extends __BaseException {
|
|
3856
3856
|
readonly name: "PolicyLengthExceededException";
|
|
@@ -3861,7 +3861,6 @@ export declare class PolicyLengthExceededException extends __BaseException {
|
|
|
3861
3861
|
constructor(opts: __ExceptionOptionType<PolicyLengthExceededException, __BaseException>);
|
|
3862
3862
|
}
|
|
3863
3863
|
/**
|
|
3864
|
-
* @public
|
|
3865
3864
|
* <p>A JSON string which you can use to limit the event bus permissions you are granting to
|
|
3866
3865
|
* only accounts that fulfill the condition. Currently, the only supported condition is
|
|
3867
3866
|
* membership in a certain Amazon Web Services organization. The string must contain <code>Type</code>,
|
|
@@ -3871,24 +3870,25 @@ export declare class PolicyLengthExceededException extends __BaseException {
|
|
|
3871
3870
|
* <code>'\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
|
|
3872
3871
|
* "o-1234567890"\}'</code>
|
|
3873
3872
|
* </p>
|
|
3873
|
+
* @public
|
|
3874
3874
|
*/
|
|
3875
3875
|
export interface Condition {
|
|
3876
3876
|
/**
|
|
3877
|
-
* @public
|
|
3878
3877
|
* <p>Specifies the type of condition. Currently the only supported value is
|
|
3879
3878
|
* <code>StringEquals</code>.</p>
|
|
3879
|
+
* @public
|
|
3880
3880
|
*/
|
|
3881
3881
|
Type: string | undefined;
|
|
3882
3882
|
/**
|
|
3883
|
-
* @public
|
|
3884
3883
|
* <p>Specifies the key for the condition. Currently the only supported key is
|
|
3885
3884
|
* <code>aws:PrincipalOrgID</code>.</p>
|
|
3885
|
+
* @public
|
|
3886
3886
|
*/
|
|
3887
3887
|
Key: string | undefined;
|
|
3888
3888
|
/**
|
|
3889
|
-
* @public
|
|
3890
3889
|
* <p>Specifies the value for the key. Currently, this must be the ID of the
|
|
3891
3890
|
* organization.</p>
|
|
3891
|
+
* @public
|
|
3892
3892
|
*/
|
|
3893
3893
|
Value: string | undefined;
|
|
3894
3894
|
}
|
|
@@ -3897,18 +3897,17 @@ export interface Condition {
|
|
|
3897
3897
|
*/
|
|
3898
3898
|
export interface PutPermissionRequest {
|
|
3899
3899
|
/**
|
|
3900
|
-
* @public
|
|
3901
3900
|
* <p>The name of the event bus associated with the rule. If you omit this, the default event
|
|
3902
3901
|
* bus is used.</p>
|
|
3902
|
+
* @public
|
|
3903
3903
|
*/
|
|
3904
3904
|
EventBusName?: string;
|
|
3905
3905
|
/**
|
|
3906
|
-
* @public
|
|
3907
3906
|
* <p>The action that you are enabling the other account to perform.</p>
|
|
3907
|
+
* @public
|
|
3908
3908
|
*/
|
|
3909
3909
|
Action?: string;
|
|
3910
3910
|
/**
|
|
3911
|
-
* @public
|
|
3912
3911
|
* <p>The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event
|
|
3913
3912
|
* bus. Specify "*" to permit any account to put events to your default event bus.</p>
|
|
3914
3913
|
* <p>If you specify "*" without specifying <code>Condition</code>, avoid creating rules that
|
|
@@ -3916,20 +3915,20 @@ export interface PutPermissionRequest {
|
|
|
3916
3915
|
* for each rule contains an <code>account</code> field with a specific account ID from which to
|
|
3917
3916
|
* receive events. Rules with an account field do not match any events sent from other
|
|
3918
3917
|
* accounts.</p>
|
|
3918
|
+
* @public
|
|
3919
3919
|
*/
|
|
3920
3920
|
Principal?: string;
|
|
3921
3921
|
/**
|
|
3922
|
-
* @public
|
|
3923
3922
|
* <p>An identifier string for the external account that you are granting permissions to. If you
|
|
3924
3923
|
* later want to revoke the permission for this external account, specify this
|
|
3925
3924
|
* <code>StatementId</code> when you run <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html">RemovePermission</a>.</p>
|
|
3926
3925
|
* <note>
|
|
3927
3926
|
* <p>Each <code>StatementId</code> must be unique.</p>
|
|
3928
3927
|
* </note>
|
|
3928
|
+
* @public
|
|
3929
3929
|
*/
|
|
3930
3930
|
StatementId?: string;
|
|
3931
3931
|
/**
|
|
3932
|
-
* @public
|
|
3933
3932
|
* <p>This parameter enables you to limit the permission to accounts that fulfill a certain
|
|
3934
3933
|
* condition, such as being a member of a certain Amazon Web Services organization. For more information about
|
|
3935
3934
|
* Amazon Web Services Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What Is Amazon Web Services
|
|
@@ -3939,13 +3938,14 @@ export interface PutPermissionRequest {
|
|
|
3939
3938
|
* organization.</p>
|
|
3940
3939
|
* <p>The <code>Condition</code> is a JSON string which must contain <code>Type</code>,
|
|
3941
3940
|
* <code>Key</code>, and <code>Value</code> fields.</p>
|
|
3941
|
+
* @public
|
|
3942
3942
|
*/
|
|
3943
3943
|
Condition?: Condition;
|
|
3944
3944
|
/**
|
|
3945
|
-
* @public
|
|
3946
3945
|
* <p>A JSON string that describes the permission policy statement. You can include a
|
|
3947
3946
|
* <code>Policy</code> parameter in the request instead of using the <code>StatementId</code>,
|
|
3948
3947
|
* <code>Action</code>, <code>Principal</code>, or <code>Condition</code> parameters.</p>
|
|
3948
|
+
* @public
|
|
3949
3949
|
*/
|
|
3950
3950
|
Policy?: string;
|
|
3951
3951
|
}
|
|
@@ -3954,49 +3954,49 @@ export interface PutPermissionRequest {
|
|
|
3954
3954
|
*/
|
|
3955
3955
|
export interface PutRuleRequest {
|
|
3956
3956
|
/**
|
|
3957
|
-
* @public
|
|
3958
3957
|
* <p>The name of the rule that you are creating or updating.</p>
|
|
3958
|
+
* @public
|
|
3959
3959
|
*/
|
|
3960
3960
|
Name: string | undefined;
|
|
3961
3961
|
/**
|
|
3962
|
-
* @public
|
|
3963
3962
|
* <p>The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".</p>
|
|
3963
|
+
* @public
|
|
3964
3964
|
*/
|
|
3965
3965
|
ScheduleExpression?: string;
|
|
3966
3966
|
/**
|
|
3967
|
-
* @public
|
|
3968
3967
|
* <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html">Amazon EventBridge event
|
|
3969
3968
|
* patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
3969
|
+
* @public
|
|
3970
3970
|
*/
|
|
3971
3971
|
EventPattern?: string;
|
|
3972
3972
|
/**
|
|
3973
|
-
* @public
|
|
3974
3973
|
* <p>Indicates whether the rule is enabled or disabled.</p>
|
|
3974
|
+
* @public
|
|
3975
3975
|
*/
|
|
3976
3976
|
State?: RuleState;
|
|
3977
3977
|
/**
|
|
3978
|
-
* @public
|
|
3979
3978
|
* <p>A description of the rule.</p>
|
|
3979
|
+
* @public
|
|
3980
3980
|
*/
|
|
3981
3981
|
Description?: string;
|
|
3982
3982
|
/**
|
|
3983
|
-
* @public
|
|
3984
3983
|
* <p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
|
|
3985
3984
|
* <p>If you're setting an event bus in another account as the target and that account granted
|
|
3986
3985
|
* permission to your account through an organization instead of directly by the account ID, you
|
|
3987
3986
|
* must specify a <code>RoleArn</code> with proper permissions in the <code>Target</code>
|
|
3988
3987
|
* structure, instead of here in this parameter.</p>
|
|
3988
|
+
* @public
|
|
3989
3989
|
*/
|
|
3990
3990
|
RoleArn?: string;
|
|
3991
3991
|
/**
|
|
3992
|
-
* @public
|
|
3993
3992
|
* <p>The list of key-value pairs to associate with the rule.</p>
|
|
3993
|
+
* @public
|
|
3994
3994
|
*/
|
|
3995
3995
|
Tags?: Tag[];
|
|
3996
3996
|
/**
|
|
3997
|
-
* @public
|
|
3998
3997
|
* <p>The name or ARN of the event bus to associate with this rule. If you omit this, the
|
|
3999
3998
|
* default event bus is used.</p>
|
|
3999
|
+
* @public
|
|
4000
4000
|
*/
|
|
4001
4001
|
EventBusName?: string;
|
|
4002
4002
|
}
|
|
@@ -4005,8 +4005,8 @@ export interface PutRuleRequest {
|
|
|
4005
4005
|
*/
|
|
4006
4006
|
export interface PutRuleResponse {
|
|
4007
4007
|
/**
|
|
4008
|
-
* @public
|
|
4009
4008
|
* <p>The Amazon Resource Name (ARN) of the rule.</p>
|
|
4009
|
+
* @public
|
|
4010
4010
|
*/
|
|
4011
4011
|
RuleArn?: string;
|
|
4012
4012
|
}
|
|
@@ -4015,42 +4015,42 @@ export interface PutRuleResponse {
|
|
|
4015
4015
|
*/
|
|
4016
4016
|
export interface PutTargetsRequest {
|
|
4017
4017
|
/**
|
|
4018
|
-
* @public
|
|
4019
4018
|
* <p>The name of the rule.</p>
|
|
4019
|
+
* @public
|
|
4020
4020
|
*/
|
|
4021
4021
|
Rule: string | undefined;
|
|
4022
4022
|
/**
|
|
4023
|
-
* @public
|
|
4024
4023
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
4025
4024
|
* event bus is used.</p>
|
|
4025
|
+
* @public
|
|
4026
4026
|
*/
|
|
4027
4027
|
EventBusName?: string;
|
|
4028
4028
|
/**
|
|
4029
|
-
* @public
|
|
4030
4029
|
* <p>The targets to update or add to the rule.</p>
|
|
4030
|
+
* @public
|
|
4031
4031
|
*/
|
|
4032
4032
|
Targets: Target[] | undefined;
|
|
4033
4033
|
}
|
|
4034
4034
|
/**
|
|
4035
|
-
* @public
|
|
4036
4035
|
* <p>Represents a target that failed to be added to a rule.</p>
|
|
4036
|
+
* @public
|
|
4037
4037
|
*/
|
|
4038
4038
|
export interface PutTargetsResultEntry {
|
|
4039
4039
|
/**
|
|
4040
|
-
* @public
|
|
4041
4040
|
* <p>The ID of the target.</p>
|
|
4041
|
+
* @public
|
|
4042
4042
|
*/
|
|
4043
4043
|
TargetId?: string;
|
|
4044
4044
|
/**
|
|
4045
|
-
* @public
|
|
4046
4045
|
* <p>The error code that indicates why the target addition failed. If the value is
|
|
4047
4046
|
* <code>ConcurrentModificationException</code>, too many requests were made at the same
|
|
4048
4047
|
* time.</p>
|
|
4048
|
+
* @public
|
|
4049
4049
|
*/
|
|
4050
4050
|
ErrorCode?: string;
|
|
4051
4051
|
/**
|
|
4052
|
-
* @public
|
|
4053
4052
|
* <p>The error message that explains why the target addition failed.</p>
|
|
4053
|
+
* @public
|
|
4054
4054
|
*/
|
|
4055
4055
|
ErrorMessage?: string;
|
|
4056
4056
|
}
|
|
@@ -4059,13 +4059,13 @@ export interface PutTargetsResultEntry {
|
|
|
4059
4059
|
*/
|
|
4060
4060
|
export interface PutTargetsResponse {
|
|
4061
4061
|
/**
|
|
4062
|
-
* @public
|
|
4063
4062
|
* <p>The number of failed entries.</p>
|
|
4063
|
+
* @public
|
|
4064
4064
|
*/
|
|
4065
4065
|
FailedEntryCount?: number;
|
|
4066
4066
|
/**
|
|
4067
|
-
* @public
|
|
4068
4067
|
* <p>The failed target entries.</p>
|
|
4068
|
+
* @public
|
|
4069
4069
|
*/
|
|
4070
4070
|
FailedEntries?: PutTargetsResultEntry[];
|
|
4071
4071
|
}
|
|
@@ -4074,20 +4074,20 @@ export interface PutTargetsResponse {
|
|
|
4074
4074
|
*/
|
|
4075
4075
|
export interface RemovePermissionRequest {
|
|
4076
4076
|
/**
|
|
4077
|
-
* @public
|
|
4078
4077
|
* <p>The statement ID corresponding to the account that is no longer allowed to put events to
|
|
4079
4078
|
* the default event bus.</p>
|
|
4079
|
+
* @public
|
|
4080
4080
|
*/
|
|
4081
4081
|
StatementId?: string;
|
|
4082
4082
|
/**
|
|
4083
|
-
* @public
|
|
4084
4083
|
* <p>Specifies whether to remove all permissions.</p>
|
|
4084
|
+
* @public
|
|
4085
4085
|
*/
|
|
4086
4086
|
RemoveAllPermissions?: boolean;
|
|
4087
4087
|
/**
|
|
4088
|
-
* @public
|
|
4089
4088
|
* <p>The name of the event bus to revoke permissions for. If you omit this, the default event
|
|
4090
4089
|
* bus is used.</p>
|
|
4090
|
+
* @public
|
|
4091
4091
|
*/
|
|
4092
4092
|
EventBusName?: string;
|
|
4093
4093
|
}
|
|
@@ -4096,51 +4096,51 @@ export interface RemovePermissionRequest {
|
|
|
4096
4096
|
*/
|
|
4097
4097
|
export interface RemoveTargetsRequest {
|
|
4098
4098
|
/**
|
|
4099
|
-
* @public
|
|
4100
4099
|
* <p>The name of the rule.</p>
|
|
4100
|
+
* @public
|
|
4101
4101
|
*/
|
|
4102
4102
|
Rule: string | undefined;
|
|
4103
4103
|
/**
|
|
4104
|
-
* @public
|
|
4105
4104
|
* <p>The name or ARN of the event bus associated with the rule. If you omit this, the default
|
|
4106
4105
|
* event bus is used.</p>
|
|
4106
|
+
* @public
|
|
4107
4107
|
*/
|
|
4108
4108
|
EventBusName?: string;
|
|
4109
4109
|
/**
|
|
4110
|
-
* @public
|
|
4111
4110
|
* <p>The IDs of the targets to remove from the rule.</p>
|
|
4111
|
+
* @public
|
|
4112
4112
|
*/
|
|
4113
4113
|
Ids: string[] | undefined;
|
|
4114
4114
|
/**
|
|
4115
|
-
* @public
|
|
4116
4115
|
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
|
|
4117
4116
|
* <code>Force</code> as <code>True</code> to remove targets. This parameter is ignored for
|
|
4118
4117
|
* rules that are not managed rules. You can check whether a rule is a managed rule by using
|
|
4119
4118
|
* <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code>
|
|
4120
4119
|
* field of the response.</p>
|
|
4120
|
+
* @public
|
|
4121
4121
|
*/
|
|
4122
4122
|
Force?: boolean;
|
|
4123
4123
|
}
|
|
4124
4124
|
/**
|
|
4125
|
-
* @public
|
|
4126
4125
|
* <p>Represents a target that failed to be removed from a rule.</p>
|
|
4126
|
+
* @public
|
|
4127
4127
|
*/
|
|
4128
4128
|
export interface RemoveTargetsResultEntry {
|
|
4129
4129
|
/**
|
|
4130
|
-
* @public
|
|
4131
4130
|
* <p>The ID of the target.</p>
|
|
4131
|
+
* @public
|
|
4132
4132
|
*/
|
|
4133
4133
|
TargetId?: string;
|
|
4134
4134
|
/**
|
|
4135
|
-
* @public
|
|
4136
4135
|
* <p>The error code that indicates why the target removal failed. If the value is
|
|
4137
4136
|
* <code>ConcurrentModificationException</code>, too many requests were made at the same
|
|
4138
4137
|
* time.</p>
|
|
4138
|
+
* @public
|
|
4139
4139
|
*/
|
|
4140
4140
|
ErrorCode?: string;
|
|
4141
4141
|
/**
|
|
4142
|
-
* @public
|
|
4143
4142
|
* <p>The error message that explains why the target removal failed.</p>
|
|
4143
|
+
* @public
|
|
4144
4144
|
*/
|
|
4145
4145
|
ErrorMessage?: string;
|
|
4146
4146
|
}
|
|
@@ -4149,13 +4149,13 @@ export interface RemoveTargetsResultEntry {
|
|
|
4149
4149
|
*/
|
|
4150
4150
|
export interface RemoveTargetsResponse {
|
|
4151
4151
|
/**
|
|
4152
|
-
* @public
|
|
4153
4152
|
* <p>The number of failed entries.</p>
|
|
4153
|
+
* @public
|
|
4154
4154
|
*/
|
|
4155
4155
|
FailedEntryCount?: number;
|
|
4156
4156
|
/**
|
|
4157
|
-
* @public
|
|
4158
4157
|
* <p>The failed target entries.</p>
|
|
4158
|
+
* @public
|
|
4159
4159
|
*/
|
|
4160
4160
|
FailedEntries?: RemoveTargetsResultEntry[];
|
|
4161
4161
|
}
|
|
@@ -4164,36 +4164,36 @@ export interface RemoveTargetsResponse {
|
|
|
4164
4164
|
*/
|
|
4165
4165
|
export interface StartReplayRequest {
|
|
4166
4166
|
/**
|
|
4167
|
-
* @public
|
|
4168
4167
|
* <p>The name of the replay to start.</p>
|
|
4168
|
+
* @public
|
|
4169
4169
|
*/
|
|
4170
4170
|
ReplayName: string | undefined;
|
|
4171
4171
|
/**
|
|
4172
|
-
* @public
|
|
4173
4172
|
* <p>A description for the replay to start.</p>
|
|
4173
|
+
* @public
|
|
4174
4174
|
*/
|
|
4175
4175
|
Description?: string;
|
|
4176
4176
|
/**
|
|
4177
|
-
* @public
|
|
4178
4177
|
* <p>The ARN of the archive to replay events from.</p>
|
|
4178
|
+
* @public
|
|
4179
4179
|
*/
|
|
4180
4180
|
EventSourceArn: string | undefined;
|
|
4181
4181
|
/**
|
|
4182
|
-
* @public
|
|
4183
4182
|
* <p>A time stamp for the time to start replaying events. Only events that occurred between the
|
|
4184
4183
|
* <code>EventStartTime</code> and <code>EventEndTime</code> are replayed.</p>
|
|
4184
|
+
* @public
|
|
4185
4185
|
*/
|
|
4186
4186
|
EventStartTime: Date | undefined;
|
|
4187
4187
|
/**
|
|
4188
|
-
* @public
|
|
4189
4188
|
* <p>A time stamp for the time to stop replaying events. Only events that occurred between the
|
|
4190
4189
|
* <code>EventStartTime</code> and <code>EventEndTime</code> are replayed.</p>
|
|
4190
|
+
* @public
|
|
4191
4191
|
*/
|
|
4192
4192
|
EventEndTime: Date | undefined;
|
|
4193
4193
|
/**
|
|
4194
|
-
* @public
|
|
4195
4194
|
* <p>A <code>ReplayDestination</code> object that includes details about the destination for
|
|
4196
4195
|
* the replay.</p>
|
|
4196
|
+
* @public
|
|
4197
4197
|
*/
|
|
4198
4198
|
Destination: ReplayDestination | undefined;
|
|
4199
4199
|
}
|
|
@@ -4202,23 +4202,23 @@ export interface StartReplayRequest {
|
|
|
4202
4202
|
*/
|
|
4203
4203
|
export interface StartReplayResponse {
|
|
4204
4204
|
/**
|
|
4205
|
-
* @public
|
|
4206
4205
|
* <p>The ARN of the replay.</p>
|
|
4206
|
+
* @public
|
|
4207
4207
|
*/
|
|
4208
4208
|
ReplayArn?: string;
|
|
4209
4209
|
/**
|
|
4210
|
-
* @public
|
|
4211
4210
|
* <p>The state of the replay.</p>
|
|
4211
|
+
* @public
|
|
4212
4212
|
*/
|
|
4213
4213
|
State?: ReplayState;
|
|
4214
4214
|
/**
|
|
4215
|
-
* @public
|
|
4216
4215
|
* <p>The reason that the replay is in the state.</p>
|
|
4216
|
+
* @public
|
|
4217
4217
|
*/
|
|
4218
4218
|
StateReason?: string;
|
|
4219
4219
|
/**
|
|
4220
|
-
* @public
|
|
4221
4220
|
* <p>The time at which the replay started.</p>
|
|
4221
|
+
* @public
|
|
4222
4222
|
*/
|
|
4223
4223
|
ReplayStartTime?: Date;
|
|
4224
4224
|
}
|
|
@@ -4227,13 +4227,13 @@ export interface StartReplayResponse {
|
|
|
4227
4227
|
*/
|
|
4228
4228
|
export interface TagResourceRequest {
|
|
4229
4229
|
/**
|
|
4230
|
-
* @public
|
|
4231
4230
|
* <p>The ARN of the EventBridge resource that you're adding tags to.</p>
|
|
4231
|
+
* @public
|
|
4232
4232
|
*/
|
|
4233
4233
|
ResourceARN: string | undefined;
|
|
4234
4234
|
/**
|
|
4235
|
-
* @public
|
|
4236
4235
|
* <p>The list of key-value pairs to associate with the resource.</p>
|
|
4236
|
+
* @public
|
|
4237
4237
|
*/
|
|
4238
4238
|
Tags: Tag[] | undefined;
|
|
4239
4239
|
}
|
|
@@ -4247,13 +4247,12 @@ export interface TagResourceResponse {
|
|
|
4247
4247
|
*/
|
|
4248
4248
|
export interface TestEventPatternRequest {
|
|
4249
4249
|
/**
|
|
4250
|
-
* @public
|
|
4251
4250
|
* <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
|
|
4252
4251
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
4252
|
+
* @public
|
|
4253
4253
|
*/
|
|
4254
4254
|
EventPattern: string | undefined;
|
|
4255
4255
|
/**
|
|
4256
|
-
* @public
|
|
4257
4256
|
* <p>The event, in JSON format, to test against the event pattern. The JSON must follow the
|
|
4258
4257
|
* format specified in <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html">Amazon Web Services Events</a>, and the following
|
|
4259
4258
|
* fields are mandatory:</p>
|
|
@@ -4294,6 +4293,7 @@ export interface TestEventPatternRequest {
|
|
|
4294
4293
|
* </p>
|
|
4295
4294
|
* </li>
|
|
4296
4295
|
* </ul>
|
|
4296
|
+
* @public
|
|
4297
4297
|
*/
|
|
4298
4298
|
Event: string | undefined;
|
|
4299
4299
|
}
|
|
@@ -4302,8 +4302,8 @@ export interface TestEventPatternRequest {
|
|
|
4302
4302
|
*/
|
|
4303
4303
|
export interface TestEventPatternResponse {
|
|
4304
4304
|
/**
|
|
4305
|
-
* @public
|
|
4306
4305
|
* <p>Indicates whether the event matches the event pattern.</p>
|
|
4306
|
+
* @public
|
|
4307
4307
|
*/
|
|
4308
4308
|
Result?: boolean;
|
|
4309
4309
|
}
|
|
@@ -4312,13 +4312,13 @@ export interface TestEventPatternResponse {
|
|
|
4312
4312
|
*/
|
|
4313
4313
|
export interface UntagResourceRequest {
|
|
4314
4314
|
/**
|
|
4315
|
-
* @public
|
|
4316
4315
|
* <p>The ARN of the EventBridge resource from which you are removing tags.</p>
|
|
4316
|
+
* @public
|
|
4317
4317
|
*/
|
|
4318
4318
|
ResourceARN: string | undefined;
|
|
4319
4319
|
/**
|
|
4320
|
-
* @public
|
|
4321
4320
|
* <p>The list of tag keys to remove from the resource.</p>
|
|
4321
|
+
* @public
|
|
4322
4322
|
*/
|
|
4323
4323
|
TagKeys: string[] | undefined;
|
|
4324
4324
|
}
|
|
@@ -4332,33 +4332,33 @@ export interface UntagResourceResponse {
|
|
|
4332
4332
|
*/
|
|
4333
4333
|
export interface UpdateApiDestinationRequest {
|
|
4334
4334
|
/**
|
|
4335
|
-
* @public
|
|
4336
4335
|
* <p>The name of the API destination to update.</p>
|
|
4336
|
+
* @public
|
|
4337
4337
|
*/
|
|
4338
4338
|
Name: string | undefined;
|
|
4339
4339
|
/**
|
|
4340
|
-
* @public
|
|
4341
4340
|
* <p>The name of the API destination to update.</p>
|
|
4341
|
+
* @public
|
|
4342
4342
|
*/
|
|
4343
4343
|
Description?: string;
|
|
4344
4344
|
/**
|
|
4345
|
-
* @public
|
|
4346
4345
|
* <p>The ARN of the connection to use for the API destination.</p>
|
|
4346
|
+
* @public
|
|
4347
4347
|
*/
|
|
4348
4348
|
ConnectionArn?: string;
|
|
4349
4349
|
/**
|
|
4350
|
-
* @public
|
|
4351
4350
|
* <p>The URL to the endpoint to use for the API destination.</p>
|
|
4351
|
+
* @public
|
|
4352
4352
|
*/
|
|
4353
4353
|
InvocationEndpoint?: string;
|
|
4354
4354
|
/**
|
|
4355
|
-
* @public
|
|
4356
4355
|
* <p>The method to use for the API destination.</p>
|
|
4356
|
+
* @public
|
|
4357
4357
|
*/
|
|
4358
4358
|
HttpMethod?: ApiDestinationHttpMethod;
|
|
4359
4359
|
/**
|
|
4360
|
-
* @public
|
|
4361
4360
|
* <p>The maximum number of invocations per second to send to the API destination.</p>
|
|
4361
|
+
* @public
|
|
4362
4362
|
*/
|
|
4363
4363
|
InvocationRateLimitPerSecond?: number;
|
|
4364
4364
|
}
|
|
@@ -4367,23 +4367,23 @@ export interface UpdateApiDestinationRequest {
|
|
|
4367
4367
|
*/
|
|
4368
4368
|
export interface UpdateApiDestinationResponse {
|
|
4369
4369
|
/**
|
|
4370
|
-
* @public
|
|
4371
4370
|
* <p>The ARN of the API destination that was updated.</p>
|
|
4371
|
+
* @public
|
|
4372
4372
|
*/
|
|
4373
4373
|
ApiDestinationArn?: string;
|
|
4374
4374
|
/**
|
|
4375
|
-
* @public
|
|
4376
4375
|
* <p>The state of the API destination that was updated.</p>
|
|
4376
|
+
* @public
|
|
4377
4377
|
*/
|
|
4378
4378
|
ApiDestinationState?: ApiDestinationState;
|
|
4379
4379
|
/**
|
|
4380
|
-
* @public
|
|
4381
4380
|
* <p>A time stamp for the time that the API destination was created.</p>
|
|
4381
|
+
* @public
|
|
4382
4382
|
*/
|
|
4383
4383
|
CreationTime?: Date;
|
|
4384
4384
|
/**
|
|
4385
|
-
* @public
|
|
4386
4385
|
* <p>A time stamp for the time that the API destination was last modified.</p>
|
|
4386
|
+
* @public
|
|
4387
4387
|
*/
|
|
4388
4388
|
LastModifiedTime?: Date;
|
|
4389
4389
|
}
|
|
@@ -4392,23 +4392,23 @@ export interface UpdateApiDestinationResponse {
|
|
|
4392
4392
|
*/
|
|
4393
4393
|
export interface UpdateArchiveRequest {
|
|
4394
4394
|
/**
|
|
4395
|
-
* @public
|
|
4396
4395
|
* <p>The name of the archive to update.</p>
|
|
4396
|
+
* @public
|
|
4397
4397
|
*/
|
|
4398
4398
|
ArchiveName: string | undefined;
|
|
4399
4399
|
/**
|
|
4400
|
-
* @public
|
|
4401
4400
|
* <p>The description for the archive.</p>
|
|
4401
|
+
* @public
|
|
4402
4402
|
*/
|
|
4403
4403
|
Description?: string;
|
|
4404
4404
|
/**
|
|
4405
|
-
* @public
|
|
4406
4405
|
* <p>The event pattern to use to filter events sent to the archive.</p>
|
|
4406
|
+
* @public
|
|
4407
4407
|
*/
|
|
4408
4408
|
EventPattern?: string;
|
|
4409
4409
|
/**
|
|
4410
|
-
* @public
|
|
4411
4410
|
* <p>The number of days to retain events in the archive.</p>
|
|
4411
|
+
* @public
|
|
4412
4412
|
*/
|
|
4413
4413
|
RetentionDays?: number;
|
|
4414
4414
|
}
|
|
@@ -4417,130 +4417,130 @@ export interface UpdateArchiveRequest {
|
|
|
4417
4417
|
*/
|
|
4418
4418
|
export interface UpdateArchiveResponse {
|
|
4419
4419
|
/**
|
|
4420
|
-
* @public
|
|
4421
4420
|
* <p>The ARN of the archive.</p>
|
|
4421
|
+
* @public
|
|
4422
4422
|
*/
|
|
4423
4423
|
ArchiveArn?: string;
|
|
4424
4424
|
/**
|
|
4425
|
-
* @public
|
|
4426
4425
|
* <p>The state of the archive.</p>
|
|
4426
|
+
* @public
|
|
4427
4427
|
*/
|
|
4428
4428
|
State?: ArchiveState;
|
|
4429
4429
|
/**
|
|
4430
|
-
* @public
|
|
4431
4430
|
* <p>The reason that the archive is in the current state.</p>
|
|
4431
|
+
* @public
|
|
4432
4432
|
*/
|
|
4433
4433
|
StateReason?: string;
|
|
4434
4434
|
/**
|
|
4435
|
-
* @public
|
|
4436
4435
|
* <p>The time at which the archive was updated.</p>
|
|
4436
|
+
* @public
|
|
4437
4437
|
*/
|
|
4438
4438
|
CreationTime?: Date;
|
|
4439
4439
|
}
|
|
4440
4440
|
/**
|
|
4441
|
-
* @public
|
|
4442
4441
|
* <p>Contains the API key authorization parameters to use to update the connection.</p>
|
|
4442
|
+
* @public
|
|
4443
4443
|
*/
|
|
4444
4444
|
export interface UpdateConnectionApiKeyAuthRequestParameters {
|
|
4445
4445
|
/**
|
|
4446
|
-
* @public
|
|
4447
4446
|
* <p>The name of the API key to use for authorization.</p>
|
|
4447
|
+
* @public
|
|
4448
4448
|
*/
|
|
4449
4449
|
ApiKeyName?: string;
|
|
4450
4450
|
/**
|
|
4451
|
-
* @public
|
|
4452
4451
|
* <p>The value associated with teh API key to use for authorization.</p>
|
|
4452
|
+
* @public
|
|
4453
4453
|
*/
|
|
4454
4454
|
ApiKeyValue?: string;
|
|
4455
4455
|
}
|
|
4456
4456
|
/**
|
|
4457
|
-
* @public
|
|
4458
4457
|
* <p>Contains the Basic authorization parameters for the connection.</p>
|
|
4458
|
+
* @public
|
|
4459
4459
|
*/
|
|
4460
4460
|
export interface UpdateConnectionBasicAuthRequestParameters {
|
|
4461
4461
|
/**
|
|
4462
|
-
* @public
|
|
4463
4462
|
* <p>The user name to use for Basic authorization.</p>
|
|
4463
|
+
* @public
|
|
4464
4464
|
*/
|
|
4465
4465
|
Username?: string;
|
|
4466
4466
|
/**
|
|
4467
|
-
* @public
|
|
4468
4467
|
* <p>The password associated with the user name to use for Basic authorization.</p>
|
|
4468
|
+
* @public
|
|
4469
4469
|
*/
|
|
4470
4470
|
Password?: string;
|
|
4471
4471
|
}
|
|
4472
4472
|
/**
|
|
4473
|
-
* @public
|
|
4474
4473
|
* <p>Contains the OAuth authorization parameters to use for the connection.</p>
|
|
4474
|
+
* @public
|
|
4475
4475
|
*/
|
|
4476
4476
|
export interface UpdateConnectionOAuthClientRequestParameters {
|
|
4477
4477
|
/**
|
|
4478
|
-
* @public
|
|
4479
4478
|
* <p>The client ID to use for OAuth authorization.</p>
|
|
4479
|
+
* @public
|
|
4480
4480
|
*/
|
|
4481
4481
|
ClientID?: string;
|
|
4482
4482
|
/**
|
|
4483
|
-
* @public
|
|
4484
4483
|
* <p>The client secret assciated with the client ID to use for OAuth authorization.</p>
|
|
4484
|
+
* @public
|
|
4485
4485
|
*/
|
|
4486
4486
|
ClientSecret?: string;
|
|
4487
4487
|
}
|
|
4488
4488
|
/**
|
|
4489
|
-
* @public
|
|
4490
4489
|
* <p>Contains the OAuth request parameters to use for the connection.</p>
|
|
4490
|
+
* @public
|
|
4491
4491
|
*/
|
|
4492
4492
|
export interface UpdateConnectionOAuthRequestParameters {
|
|
4493
4493
|
/**
|
|
4494
|
-
* @public
|
|
4495
4494
|
* <p>A <code>UpdateConnectionOAuthClientRequestParameters</code> object that contains the
|
|
4496
4495
|
* client parameters to use for the connection when OAuth is specified as the authorization
|
|
4497
4496
|
* type.</p>
|
|
4497
|
+
* @public
|
|
4498
4498
|
*/
|
|
4499
4499
|
ClientParameters?: UpdateConnectionOAuthClientRequestParameters;
|
|
4500
4500
|
/**
|
|
4501
|
-
* @public
|
|
4502
4501
|
* <p>The URL to the authorization endpoint when OAuth is specified as the authorization
|
|
4503
4502
|
* type.</p>
|
|
4503
|
+
* @public
|
|
4504
4504
|
*/
|
|
4505
4505
|
AuthorizationEndpoint?: string;
|
|
4506
4506
|
/**
|
|
4507
|
-
* @public
|
|
4508
4507
|
* <p>The method used to connect to the HTTP endpoint.</p>
|
|
4508
|
+
* @public
|
|
4509
4509
|
*/
|
|
4510
4510
|
HttpMethod?: ConnectionOAuthHttpMethod;
|
|
4511
4511
|
/**
|
|
4512
|
-
* @public
|
|
4513
4512
|
* <p>The additional HTTP parameters used for the OAuth authorization request.</p>
|
|
4513
|
+
* @public
|
|
4514
4514
|
*/
|
|
4515
4515
|
OAuthHttpParameters?: ConnectionHttpParameters;
|
|
4516
4516
|
}
|
|
4517
4517
|
/**
|
|
4518
|
-
* @public
|
|
4519
4518
|
* <p>Contains the additional parameters to use for the connection.</p>
|
|
4519
|
+
* @public
|
|
4520
4520
|
*/
|
|
4521
4521
|
export interface UpdateConnectionAuthRequestParameters {
|
|
4522
4522
|
/**
|
|
4523
|
-
* @public
|
|
4524
4523
|
* <p>A <code>UpdateConnectionBasicAuthRequestParameters</code> object that contains the
|
|
4525
4524
|
* authorization parameters for Basic authorization.</p>
|
|
4525
|
+
* @public
|
|
4526
4526
|
*/
|
|
4527
4527
|
BasicAuthParameters?: UpdateConnectionBasicAuthRequestParameters;
|
|
4528
4528
|
/**
|
|
4529
|
-
* @public
|
|
4530
4529
|
* <p>A <code>UpdateConnectionOAuthRequestParameters</code> object that contains the
|
|
4531
4530
|
* authorization parameters for OAuth authorization.</p>
|
|
4531
|
+
* @public
|
|
4532
4532
|
*/
|
|
4533
4533
|
OAuthParameters?: UpdateConnectionOAuthRequestParameters;
|
|
4534
4534
|
/**
|
|
4535
|
-
* @public
|
|
4536
4535
|
* <p>A <code>UpdateConnectionApiKeyAuthRequestParameters</code> object that contains the
|
|
4537
4536
|
* authorization parameters for API key authorization.</p>
|
|
4537
|
+
* @public
|
|
4538
4538
|
*/
|
|
4539
4539
|
ApiKeyAuthParameters?: UpdateConnectionApiKeyAuthRequestParameters;
|
|
4540
4540
|
/**
|
|
4541
|
-
* @public
|
|
4542
4541
|
* <p>A <code>ConnectionHttpParameters</code> object that contains the additional parameters to
|
|
4543
4542
|
* use for the connection.</p>
|
|
4543
|
+
* @public
|
|
4544
4544
|
*/
|
|
4545
4545
|
InvocationHttpParameters?: ConnectionHttpParameters;
|
|
4546
4546
|
}
|
|
@@ -4549,23 +4549,23 @@ export interface UpdateConnectionAuthRequestParameters {
|
|
|
4549
4549
|
*/
|
|
4550
4550
|
export interface UpdateConnectionRequest {
|
|
4551
4551
|
/**
|
|
4552
|
-
* @public
|
|
4553
4552
|
* <p>The name of the connection to update.</p>
|
|
4553
|
+
* @public
|
|
4554
4554
|
*/
|
|
4555
4555
|
Name: string | undefined;
|
|
4556
4556
|
/**
|
|
4557
|
-
* @public
|
|
4558
4557
|
* <p>A description for the connection.</p>
|
|
4558
|
+
* @public
|
|
4559
4559
|
*/
|
|
4560
4560
|
Description?: string;
|
|
4561
4561
|
/**
|
|
4562
|
-
* @public
|
|
4563
4562
|
* <p>The type of authorization to use for the connection.</p>
|
|
4563
|
+
* @public
|
|
4564
4564
|
*/
|
|
4565
4565
|
AuthorizationType?: ConnectionAuthorizationType;
|
|
4566
4566
|
/**
|
|
4567
|
-
* @public
|
|
4568
4567
|
* <p>The authorization parameters to use for the connection.</p>
|
|
4568
|
+
* @public
|
|
4569
4569
|
*/
|
|
4570
4570
|
AuthParameters?: UpdateConnectionAuthRequestParameters;
|
|
4571
4571
|
}
|
|
@@ -4574,28 +4574,28 @@ export interface UpdateConnectionRequest {
|
|
|
4574
4574
|
*/
|
|
4575
4575
|
export interface UpdateConnectionResponse {
|
|
4576
4576
|
/**
|
|
4577
|
-
* @public
|
|
4578
4577
|
* <p>The ARN of the connection that was updated.</p>
|
|
4578
|
+
* @public
|
|
4579
4579
|
*/
|
|
4580
4580
|
ConnectionArn?: string;
|
|
4581
4581
|
/**
|
|
4582
|
-
* @public
|
|
4583
4582
|
* <p>The state of the connection that was updated.</p>
|
|
4583
|
+
* @public
|
|
4584
4584
|
*/
|
|
4585
4585
|
ConnectionState?: ConnectionState;
|
|
4586
4586
|
/**
|
|
4587
|
-
* @public
|
|
4588
4587
|
* <p>A time stamp for the time that the connection was created.</p>
|
|
4588
|
+
* @public
|
|
4589
4589
|
*/
|
|
4590
4590
|
CreationTime?: Date;
|
|
4591
4591
|
/**
|
|
4592
|
-
* @public
|
|
4593
4592
|
* <p>A time stamp for the time that the connection was last modified.</p>
|
|
4593
|
+
* @public
|
|
4594
4594
|
*/
|
|
4595
4595
|
LastModifiedTime?: Date;
|
|
4596
4596
|
/**
|
|
4597
|
-
* @public
|
|
4598
4597
|
* <p>A time stamp for the time that the connection was last authorized.</p>
|
|
4598
|
+
* @public
|
|
4599
4599
|
*/
|
|
4600
4600
|
LastAuthorizedTime?: Date;
|
|
4601
4601
|
}
|
|
@@ -4604,33 +4604,33 @@ export interface UpdateConnectionResponse {
|
|
|
4604
4604
|
*/
|
|
4605
4605
|
export interface UpdateEndpointRequest {
|
|
4606
4606
|
/**
|
|
4607
|
-
* @public
|
|
4608
4607
|
* <p>The name of the endpoint you want to update.</p>
|
|
4608
|
+
* @public
|
|
4609
4609
|
*/
|
|
4610
4610
|
Name: string | undefined;
|
|
4611
4611
|
/**
|
|
4612
|
-
* @public
|
|
4613
4612
|
* <p>A description for the endpoint.</p>
|
|
4613
|
+
* @public
|
|
4614
4614
|
*/
|
|
4615
4615
|
Description?: string;
|
|
4616
4616
|
/**
|
|
4617
|
-
* @public
|
|
4618
4617
|
* <p>Configure the routing policy, including the health check and secondary Region.</p>
|
|
4618
|
+
* @public
|
|
4619
4619
|
*/
|
|
4620
4620
|
RoutingConfig?: RoutingConfig;
|
|
4621
4621
|
/**
|
|
4622
|
-
* @public
|
|
4623
4622
|
* <p>Whether event replication was enabled or disabled by this request.</p>
|
|
4623
|
+
* @public
|
|
4624
4624
|
*/
|
|
4625
4625
|
ReplicationConfig?: ReplicationConfig;
|
|
4626
4626
|
/**
|
|
4627
|
-
* @public
|
|
4628
4627
|
* <p>Define event buses used for replication.</p>
|
|
4628
|
+
* @public
|
|
4629
4629
|
*/
|
|
4630
4630
|
EventBuses?: EndpointEventBus[];
|
|
4631
4631
|
/**
|
|
4632
|
-
* @public
|
|
4633
4632
|
* <p>The ARN of the role used by event replication for this request.</p>
|
|
4633
|
+
* @public
|
|
4634
4634
|
*/
|
|
4635
4635
|
RoleArn?: string;
|
|
4636
4636
|
}
|
|
@@ -4639,48 +4639,48 @@ export interface UpdateEndpointRequest {
|
|
|
4639
4639
|
*/
|
|
4640
4640
|
export interface UpdateEndpointResponse {
|
|
4641
4641
|
/**
|
|
4642
|
-
* @public
|
|
4643
4642
|
* <p>The name of the endpoint you updated in this request.</p>
|
|
4643
|
+
* @public
|
|
4644
4644
|
*/
|
|
4645
4645
|
Name?: string;
|
|
4646
4646
|
/**
|
|
4647
|
-
* @public
|
|
4648
4647
|
* <p>The ARN of the endpoint you updated in this request.</p>
|
|
4648
|
+
* @public
|
|
4649
4649
|
*/
|
|
4650
4650
|
Arn?: string;
|
|
4651
4651
|
/**
|
|
4652
|
-
* @public
|
|
4653
4652
|
* <p>The routing configuration you updated in this request.</p>
|
|
4653
|
+
* @public
|
|
4654
4654
|
*/
|
|
4655
4655
|
RoutingConfig?: RoutingConfig;
|
|
4656
4656
|
/**
|
|
4657
|
-
* @public
|
|
4658
4657
|
* <p>Whether event replication was enabled or disabled for the endpoint you updated in this request.</p>
|
|
4658
|
+
* @public
|
|
4659
4659
|
*/
|
|
4660
4660
|
ReplicationConfig?: ReplicationConfig;
|
|
4661
4661
|
/**
|
|
4662
|
-
* @public
|
|
4663
4662
|
* <p>The event buses used for replication for the endpoint you updated in this request.</p>
|
|
4663
|
+
* @public
|
|
4664
4664
|
*/
|
|
4665
4665
|
EventBuses?: EndpointEventBus[];
|
|
4666
4666
|
/**
|
|
4667
|
-
* @public
|
|
4668
4667
|
* <p>The ARN of the role used by event replication for the endpoint you updated in this request.</p>
|
|
4668
|
+
* @public
|
|
4669
4669
|
*/
|
|
4670
4670
|
RoleArn?: string;
|
|
4671
4671
|
/**
|
|
4672
|
-
* @public
|
|
4673
4672
|
* <p>The ID of the endpoint you updated in this request.</p>
|
|
4673
|
+
* @public
|
|
4674
4674
|
*/
|
|
4675
4675
|
EndpointId?: string;
|
|
4676
4676
|
/**
|
|
4677
|
-
* @public
|
|
4678
4677
|
* <p>The URL of the endpoint you updated in this request.</p>
|
|
4678
|
+
* @public
|
|
4679
4679
|
*/
|
|
4680
4680
|
EndpointUrl?: string;
|
|
4681
4681
|
/**
|
|
4682
|
-
* @public
|
|
4683
4682
|
* <p>The state of the endpoint you updated in this request.</p>
|
|
4683
|
+
* @public
|
|
4684
4684
|
*/
|
|
4685
4685
|
State?: EndpointState;
|
|
4686
4686
|
}
|