@aws-sdk/client-pipes 3.449.0 → 3.451.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/README.md +1 -1
- package/dist-cjs/models/models_0.js +20 -2
- package/dist-cjs/protocols/Aws_restJson1.js +3 -0
- package/dist-es/models/models_0.js +18 -0
- package/dist-es/protocols/Aws_restJson1.js +3 -0
- package/dist-types/commands/CreatePipeCommand.d.ts +18 -0
- package/dist-types/commands/DescribePipeCommand.d.ts +18 -0
- package/dist-types/commands/UpdatePipeCommand.d.ts +22 -3
- package/dist-types/models/models_0.d.ts +318 -26
- package/dist-types/ts3.4/models/models_0.d.ts +64 -0
- package/package.json +35 -35
package/README.md
CHANGED
|
@@ -164,7 +164,7 @@ try {
|
|
|
164
164
|
const data = await client.send(command);
|
|
165
165
|
// process data.
|
|
166
166
|
} catch (error) {
|
|
167
|
-
const { requestId, cfId, extendedRequestId } = error
|
|
167
|
+
const { requestId, cfId, extendedRequestId } = error.$metadata;
|
|
168
168
|
console.log({ requestId, cfId, extendedRequestId });
|
|
169
169
|
/**
|
|
170
170
|
* The keys within exceptions are also parsed.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
exports.TagResourceRequestFilterSensitiveLog = exports.UpdatePipeRequestFilterSensitiveLog = exports.UpdatePipeSourceParametersFilterSensitiveLog = exports.UpdatePipeSourceSelfManagedKafkaParametersFilterSensitiveLog = exports.ListTagsForResourceResponseFilterSensitiveLog = exports.ListPipesResponseFilterSensitiveLog = exports.ListPipesRequestFilterSensitiveLog = exports.DescribePipeResponseFilterSensitiveLog = exports.CreatePipeRequestFilterSensitiveLog = exports.PipeTargetParametersFilterSensitiveLog = exports.PipeTargetSqsQueueParametersFilterSensitiveLog = void 0;
|
|
3
|
+
exports.PipeTargetKinesisStreamParametersFilterSensitiveLog = exports.PipeTargetHttpParametersFilterSensitiveLog = exports.PipeTargetEventBridgeEventBusParametersFilterSensitiveLog = exports.PipeTargetEcsTaskParametersFilterSensitiveLog = exports.TagFilterSensitiveLog = exports.PlacementStrategyFilterSensitiveLog = exports.PlacementConstraintFilterSensitiveLog = exports.NetworkConfigurationFilterSensitiveLog = exports.PipeSourceParametersFilterSensitiveLog = exports.PipeSourceSelfManagedKafkaParametersFilterSensitiveLog = exports.SelfManagedKafkaAccessConfigurationVpcFilterSensitiveLog = exports.PipeSourceRabbitMQBrokerParametersFilterSensitiveLog = exports.PipeSourceManagedStreamingKafkaParametersFilterSensitiveLog = exports.FilterCriteriaFilterSensitiveLog = exports.FilterFilterSensitiveLog = exports.PipeSourceActiveMQBrokerParametersFilterSensitiveLog = exports.PipeEnrichmentParametersFilterSensitiveLog = exports.PipeEnrichmentHttpParametersFilterSensitiveLog = exports.CapacityProviderStrategyItemFilterSensitiveLog = exports.AwsVpcConfigurationFilterSensitiveLog = exports.RequestedPipeStateDescribeResponse = exports.ValidationException = exports.ThrottlingException = exports.ServiceQuotaExceededException = exports.NotFoundException = exports.InternalException = exports.PipeState = exports.PipeTargetInvocationType = exports.PropagateTags = exports.PlacementStrategyType = exports.PlacementConstraintType = exports.EcsResourceRequirementType = exports.EcsEnvironmentFileType = exports.LaunchType = exports.SelfManagedKafkaStartPosition = exports.SelfManagedKafkaAccessConfigurationCredentials = exports.MSKStartPosition = exports.MSKAccessCredentials = exports.KinesisStreamStartPosition = exports.DynamoDBStreamStartPosition = exports.OnPartialBatchItemFailureStreams = exports.MQBrokerAccessCredentials = exports.S3OutputFormat = exports.LogLevel = exports.IncludeExecutionDataOption = exports.RequestedPipeState = exports.ConflictException = exports.BatchJobDependencyType = exports.BatchResourceRequirementType = exports.AssignPublicIp = void 0;
|
|
4
|
+
exports.TagResourceRequestFilterSensitiveLog = exports.UpdatePipeRequestFilterSensitiveLog = exports.UpdatePipeSourceParametersFilterSensitiveLog = exports.UpdatePipeSourceSelfManagedKafkaParametersFilterSensitiveLog = exports.ListTagsForResourceResponseFilterSensitiveLog = exports.ListPipesResponseFilterSensitiveLog = exports.ListPipesRequestFilterSensitiveLog = exports.DescribePipeResponseFilterSensitiveLog = exports.CreatePipeRequestFilterSensitiveLog = exports.PipeTargetParametersFilterSensitiveLog = exports.PipeTargetSqsQueueParametersFilterSensitiveLog = exports.PipeTargetSageMakerPipelineParametersFilterSensitiveLog = exports.SageMakerPipelineParameterFilterSensitiveLog = exports.PipeTargetRedshiftDataParametersFilterSensitiveLog = void 0;
|
|
5
5
|
const smithy_client_1 = require("@smithy/smithy-client");
|
|
6
6
|
const PipesServiceException_1 = require("./PipesServiceException");
|
|
7
7
|
exports.AssignPublicIp = {
|
|
@@ -36,6 +36,20 @@ exports.RequestedPipeState = {
|
|
|
36
36
|
RUNNING: "RUNNING",
|
|
37
37
|
STOPPED: "STOPPED",
|
|
38
38
|
};
|
|
39
|
+
exports.IncludeExecutionDataOption = {
|
|
40
|
+
ALL: "ALL",
|
|
41
|
+
};
|
|
42
|
+
exports.LogLevel = {
|
|
43
|
+
ERROR: "ERROR",
|
|
44
|
+
INFO: "INFO",
|
|
45
|
+
OFF: "OFF",
|
|
46
|
+
TRACE: "TRACE",
|
|
47
|
+
};
|
|
48
|
+
exports.S3OutputFormat = {
|
|
49
|
+
JSON: "json",
|
|
50
|
+
PLAIN: "plain",
|
|
51
|
+
W3C: "w3c",
|
|
52
|
+
};
|
|
39
53
|
var MQBrokerAccessCredentials;
|
|
40
54
|
(function (MQBrokerAccessCredentials) {
|
|
41
55
|
MQBrokerAccessCredentials.visit = (value, visitor) => {
|
|
@@ -118,7 +132,10 @@ exports.PipeTargetInvocationType = {
|
|
|
118
132
|
};
|
|
119
133
|
exports.PipeState = {
|
|
120
134
|
CREATE_FAILED: "CREATE_FAILED",
|
|
135
|
+
CREATE_ROLLBACK_FAILED: "CREATE_ROLLBACK_FAILED",
|
|
121
136
|
CREATING: "CREATING",
|
|
137
|
+
DELETE_FAILED: "DELETE_FAILED",
|
|
138
|
+
DELETE_ROLLBACK_FAILED: "DELETE_ROLLBACK_FAILED",
|
|
122
139
|
DELETING: "DELETING",
|
|
123
140
|
RUNNING: "RUNNING",
|
|
124
141
|
STARTING: "STARTING",
|
|
@@ -127,6 +144,7 @@ exports.PipeState = {
|
|
|
127
144
|
STOPPING: "STOPPING",
|
|
128
145
|
STOP_FAILED: "STOP_FAILED",
|
|
129
146
|
UPDATE_FAILED: "UPDATE_FAILED",
|
|
147
|
+
UPDATE_ROLLBACK_FAILED: "UPDATE_ROLLBACK_FAILED",
|
|
130
148
|
UPDATING: "UPDATING",
|
|
131
149
|
};
|
|
132
150
|
class InternalException extends PipesServiceException_1.PipesServiceException {
|
|
@@ -18,6 +18,7 @@ const se_CreatePipeCommand = async (input, context) => {
|
|
|
18
18
|
DesiredState: [],
|
|
19
19
|
Enrichment: [],
|
|
20
20
|
EnrichmentParameters: (_) => (0, smithy_client_1._json)(_),
|
|
21
|
+
LogConfiguration: (_) => (0, smithy_client_1._json)(_),
|
|
21
22
|
RoleArn: [],
|
|
22
23
|
Source: [],
|
|
23
24
|
SourceParameters: (_) => se_PipeSourceParameters(_, context),
|
|
@@ -206,6 +207,7 @@ const se_UpdatePipeCommand = async (input, context) => {
|
|
|
206
207
|
DesiredState: [],
|
|
207
208
|
Enrichment: [],
|
|
208
209
|
EnrichmentParameters: (_) => (0, smithy_client_1._json)(_),
|
|
210
|
+
LogConfiguration: (_) => (0, smithy_client_1._json)(_),
|
|
209
211
|
RoleArn: [],
|
|
210
212
|
SourceParameters: (_) => (0, smithy_client_1._json)(_),
|
|
211
213
|
Target: [],
|
|
@@ -344,6 +346,7 @@ const de_DescribePipeCommand = async (output, context) => {
|
|
|
344
346
|
Enrichment: smithy_client_1.expectString,
|
|
345
347
|
EnrichmentParameters: smithy_client_1._json,
|
|
346
348
|
LastModifiedTime: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
|
|
349
|
+
LogConfiguration: smithy_client_1._json,
|
|
347
350
|
Name: smithy_client_1.expectString,
|
|
348
351
|
RoleArn: smithy_client_1.expectString,
|
|
349
352
|
Source: smithy_client_1.expectString,
|
|
@@ -31,6 +31,20 @@ export const RequestedPipeState = {
|
|
|
31
31
|
RUNNING: "RUNNING",
|
|
32
32
|
STOPPED: "STOPPED",
|
|
33
33
|
};
|
|
34
|
+
export const IncludeExecutionDataOption = {
|
|
35
|
+
ALL: "ALL",
|
|
36
|
+
};
|
|
37
|
+
export const LogLevel = {
|
|
38
|
+
ERROR: "ERROR",
|
|
39
|
+
INFO: "INFO",
|
|
40
|
+
OFF: "OFF",
|
|
41
|
+
TRACE: "TRACE",
|
|
42
|
+
};
|
|
43
|
+
export const S3OutputFormat = {
|
|
44
|
+
JSON: "json",
|
|
45
|
+
PLAIN: "plain",
|
|
46
|
+
W3C: "w3c",
|
|
47
|
+
};
|
|
34
48
|
export var MQBrokerAccessCredentials;
|
|
35
49
|
(function (MQBrokerAccessCredentials) {
|
|
36
50
|
MQBrokerAccessCredentials.visit = (value, visitor) => {
|
|
@@ -113,7 +127,10 @@ export const PipeTargetInvocationType = {
|
|
|
113
127
|
};
|
|
114
128
|
export const PipeState = {
|
|
115
129
|
CREATE_FAILED: "CREATE_FAILED",
|
|
130
|
+
CREATE_ROLLBACK_FAILED: "CREATE_ROLLBACK_FAILED",
|
|
116
131
|
CREATING: "CREATING",
|
|
132
|
+
DELETE_FAILED: "DELETE_FAILED",
|
|
133
|
+
DELETE_ROLLBACK_FAILED: "DELETE_ROLLBACK_FAILED",
|
|
117
134
|
DELETING: "DELETING",
|
|
118
135
|
RUNNING: "RUNNING",
|
|
119
136
|
STARTING: "STARTING",
|
|
@@ -122,6 +139,7 @@ export const PipeState = {
|
|
|
122
139
|
STOPPING: "STOPPING",
|
|
123
140
|
STOP_FAILED: "STOP_FAILED",
|
|
124
141
|
UPDATE_FAILED: "UPDATE_FAILED",
|
|
142
|
+
UPDATE_ROLLBACK_FAILED: "UPDATE_ROLLBACK_FAILED",
|
|
125
143
|
UPDATING: "UPDATING",
|
|
126
144
|
};
|
|
127
145
|
export class InternalException extends __BaseException {
|
|
@@ -15,6 +15,7 @@ export const se_CreatePipeCommand = async (input, context) => {
|
|
|
15
15
|
DesiredState: [],
|
|
16
16
|
Enrichment: [],
|
|
17
17
|
EnrichmentParameters: (_) => _json(_),
|
|
18
|
+
LogConfiguration: (_) => _json(_),
|
|
18
19
|
RoleArn: [],
|
|
19
20
|
Source: [],
|
|
20
21
|
SourceParameters: (_) => se_PipeSourceParameters(_, context),
|
|
@@ -194,6 +195,7 @@ export const se_UpdatePipeCommand = async (input, context) => {
|
|
|
194
195
|
DesiredState: [],
|
|
195
196
|
Enrichment: [],
|
|
196
197
|
EnrichmentParameters: (_) => _json(_),
|
|
198
|
+
LogConfiguration: (_) => _json(_),
|
|
197
199
|
RoleArn: [],
|
|
198
200
|
SourceParameters: (_) => _json(_),
|
|
199
201
|
Target: [],
|
|
@@ -329,6 +331,7 @@ export const de_DescribePipeCommand = async (output, context) => {
|
|
|
329
331
|
Enrichment: __expectString,
|
|
330
332
|
EnrichmentParameters: _json,
|
|
331
333
|
LastModifiedTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
334
|
+
LogConfiguration: _json,
|
|
332
335
|
Name: __expectString,
|
|
333
336
|
RoleArn: __expectString,
|
|
334
337
|
Source: __expectString,
|
|
@@ -332,6 +332,24 @@ export interface CreatePipeCommandOutput extends CreatePipeResponse, __MetadataB
|
|
|
332
332
|
* Tags: { // TagMap
|
|
333
333
|
* "<keys>": "STRING_VALUE",
|
|
334
334
|
* },
|
|
335
|
+
* LogConfiguration: { // PipeLogConfigurationParameters
|
|
336
|
+
* S3LogDestination: { // S3LogDestinationParameters
|
|
337
|
+
* BucketName: "STRING_VALUE", // required
|
|
338
|
+
* BucketOwner: "STRING_VALUE", // required
|
|
339
|
+
* OutputFormat: "STRING_VALUE",
|
|
340
|
+
* Prefix: "STRING_VALUE",
|
|
341
|
+
* },
|
|
342
|
+
* FirehoseLogDestination: { // FirehoseLogDestinationParameters
|
|
343
|
+
* DeliveryStreamArn: "STRING_VALUE", // required
|
|
344
|
+
* },
|
|
345
|
+
* CloudwatchLogsLogDestination: { // CloudwatchLogsLogDestinationParameters
|
|
346
|
+
* LogGroupArn: "STRING_VALUE", // required
|
|
347
|
+
* },
|
|
348
|
+
* Level: "STRING_VALUE", // required
|
|
349
|
+
* IncludeExecutionData: [ // IncludeExecutionData
|
|
350
|
+
* "STRING_VALUE",
|
|
351
|
+
* ],
|
|
352
|
+
* },
|
|
335
353
|
* };
|
|
336
354
|
* const command = new CreatePipeCommand(input);
|
|
337
355
|
* const response = await client.send(command);
|
|
@@ -342,6 +342,24 @@ export interface DescribePipeCommandOutput extends DescribePipeResponse, __Metad
|
|
|
342
342
|
* // },
|
|
343
343
|
* // CreationTime: new Date("TIMESTAMP"),
|
|
344
344
|
* // LastModifiedTime: new Date("TIMESTAMP"),
|
|
345
|
+
* // LogConfiguration: { // PipeLogConfiguration
|
|
346
|
+
* // S3LogDestination: { // S3LogDestination
|
|
347
|
+
* // BucketName: "STRING_VALUE",
|
|
348
|
+
* // Prefix: "STRING_VALUE",
|
|
349
|
+
* // BucketOwner: "STRING_VALUE",
|
|
350
|
+
* // OutputFormat: "STRING_VALUE",
|
|
351
|
+
* // },
|
|
352
|
+
* // FirehoseLogDestination: { // FirehoseLogDestination
|
|
353
|
+
* // DeliveryStreamArn: "STRING_VALUE",
|
|
354
|
+
* // },
|
|
355
|
+
* // CloudwatchLogsLogDestination: { // CloudwatchLogsLogDestination
|
|
356
|
+
* // LogGroupArn: "STRING_VALUE",
|
|
357
|
+
* // },
|
|
358
|
+
* // Level: "STRING_VALUE",
|
|
359
|
+
* // IncludeExecutionData: [ // IncludeExecutionData
|
|
360
|
+
* // "STRING_VALUE",
|
|
361
|
+
* // ],
|
|
362
|
+
* // },
|
|
345
363
|
* // };
|
|
346
364
|
*
|
|
347
365
|
* ```
|
|
@@ -23,10 +23,11 @@ export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataB
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Update an existing pipe. When you call <code>UpdatePipe</code>, only the fields
|
|
26
|
+
* <p>Update an existing pipe. When you call <code>UpdatePipe</code>, EventBridge only the updates fields you have specified in the request; the rest remain unchanged.
|
|
27
27
|
* The exception to this is if you modify any Amazon Web Services-service specific fields in the <code>SourceParameters</code>, <code>EnrichmentParameters</code>, or
|
|
28
|
-
* <code>TargetParameters</code> objects.
|
|
29
|
-
*
|
|
28
|
+
* <code>TargetParameters</code> objects. For example, <code>DynamoDBStreamParameters</code> or <code>EventBridgeEventBusParameters</code>.
|
|
29
|
+
* EventBridge updates the fields in these objects atomically as one and overrides existing values.
|
|
30
|
+
* This is by design, and means that if you don't specify an optional field in one of these <code>Parameters</code> objects, EventBridge sets that field to its system-default value during the update.</p>
|
|
30
31
|
* <p>For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">
|
|
31
32
|
* Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>
|
|
32
33
|
* @example
|
|
@@ -318,6 +319,24 @@ export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataB
|
|
|
318
319
|
* },
|
|
319
320
|
* },
|
|
320
321
|
* RoleArn: "STRING_VALUE", // required
|
|
322
|
+
* LogConfiguration: { // PipeLogConfigurationParameters
|
|
323
|
+
* S3LogDestination: { // S3LogDestinationParameters
|
|
324
|
+
* BucketName: "STRING_VALUE", // required
|
|
325
|
+
* BucketOwner: "STRING_VALUE", // required
|
|
326
|
+
* OutputFormat: "STRING_VALUE",
|
|
327
|
+
* Prefix: "STRING_VALUE",
|
|
328
|
+
* },
|
|
329
|
+
* FirehoseLogDestination: { // FirehoseLogDestinationParameters
|
|
330
|
+
* DeliveryStreamArn: "STRING_VALUE", // required
|
|
331
|
+
* },
|
|
332
|
+
* CloudwatchLogsLogDestination: { // CloudwatchLogsLogDestinationParameters
|
|
333
|
+
* LogGroupArn: "STRING_VALUE", // required
|
|
334
|
+
* },
|
|
335
|
+
* Level: "STRING_VALUE", // required
|
|
336
|
+
* IncludeExecutionData: [ // IncludeExecutionData
|
|
337
|
+
* "STRING_VALUE",
|
|
338
|
+
* ],
|
|
339
|
+
* },
|
|
321
340
|
* };
|
|
322
341
|
* const command = new UpdatePipeCommand(input);
|
|
323
342
|
* const response = await client.send(command);
|
|
@@ -357,6 +357,28 @@ export interface CapacityProviderStrategyItem {
|
|
|
357
357
|
*/
|
|
358
358
|
base?: number;
|
|
359
359
|
}
|
|
360
|
+
/**
|
|
361
|
+
* @public
|
|
362
|
+
* <p>The Amazon CloudWatch Logs logging configuration settings for the pipe.</p>
|
|
363
|
+
*/
|
|
364
|
+
export interface CloudwatchLogsLogDestination {
|
|
365
|
+
/**
|
|
366
|
+
* @public
|
|
367
|
+
* <p>The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.</p>
|
|
368
|
+
*/
|
|
369
|
+
LogGroupArn?: string;
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* @public
|
|
373
|
+
* <p>The Amazon CloudWatch Logs logging configuration settings for the pipe.</p>
|
|
374
|
+
*/
|
|
375
|
+
export interface CloudwatchLogsLogDestinationParameters {
|
|
376
|
+
/**
|
|
377
|
+
* @public
|
|
378
|
+
* <p>The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.</p>
|
|
379
|
+
*/
|
|
380
|
+
LogGroupArn: string | undefined;
|
|
381
|
+
}
|
|
360
382
|
/**
|
|
361
383
|
* @public
|
|
362
384
|
* <p>An action you attempted resulted in an exception.</p>
|
|
@@ -428,6 +450,7 @@ export interface PipeEnrichmentParameters {
|
|
|
428
450
|
* <p>Valid JSON text passed to the enrichment. In this case, nothing from the event itself is
|
|
429
451
|
* passed to the enrichment. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data
|
|
430
452
|
* Interchange Format</a>.</p>
|
|
453
|
+
* <p>To remove an input template, specify an empty string.</p>
|
|
431
454
|
*/
|
|
432
455
|
InputTemplate?: string;
|
|
433
456
|
/**
|
|
@@ -442,6 +465,151 @@ export interface PipeEnrichmentParameters {
|
|
|
442
465
|
*/
|
|
443
466
|
HttpParameters?: PipeEnrichmentHttpParameters;
|
|
444
467
|
}
|
|
468
|
+
/**
|
|
469
|
+
* @public
|
|
470
|
+
* <p>The Amazon Kinesis Data Firehose logging configuration settings for the pipe.</p>
|
|
471
|
+
*/
|
|
472
|
+
export interface FirehoseLogDestinationParameters {
|
|
473
|
+
/**
|
|
474
|
+
* @public
|
|
475
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.</p>
|
|
476
|
+
*/
|
|
477
|
+
DeliveryStreamArn: string | undefined;
|
|
478
|
+
}
|
|
479
|
+
/**
|
|
480
|
+
* @public
|
|
481
|
+
* @enum
|
|
482
|
+
*/
|
|
483
|
+
export declare const IncludeExecutionDataOption: {
|
|
484
|
+
readonly ALL: "ALL";
|
|
485
|
+
};
|
|
486
|
+
/**
|
|
487
|
+
* @public
|
|
488
|
+
*/
|
|
489
|
+
export type IncludeExecutionDataOption = (typeof IncludeExecutionDataOption)[keyof typeof IncludeExecutionDataOption];
|
|
490
|
+
/**
|
|
491
|
+
* @public
|
|
492
|
+
* @enum
|
|
493
|
+
*/
|
|
494
|
+
export declare const LogLevel: {
|
|
495
|
+
readonly ERROR: "ERROR";
|
|
496
|
+
readonly INFO: "INFO";
|
|
497
|
+
readonly OFF: "OFF";
|
|
498
|
+
readonly TRACE: "TRACE";
|
|
499
|
+
};
|
|
500
|
+
/**
|
|
501
|
+
* @public
|
|
502
|
+
*/
|
|
503
|
+
export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
|
|
504
|
+
/**
|
|
505
|
+
* @public
|
|
506
|
+
* @enum
|
|
507
|
+
*/
|
|
508
|
+
export declare const S3OutputFormat: {
|
|
509
|
+
readonly JSON: "json";
|
|
510
|
+
readonly PLAIN: "plain";
|
|
511
|
+
readonly W3C: "w3c";
|
|
512
|
+
};
|
|
513
|
+
/**
|
|
514
|
+
* @public
|
|
515
|
+
*/
|
|
516
|
+
export type S3OutputFormat = (typeof S3OutputFormat)[keyof typeof S3OutputFormat];
|
|
517
|
+
/**
|
|
518
|
+
* @public
|
|
519
|
+
* <p>The Amazon S3 logging configuration settings for the pipe.</p>
|
|
520
|
+
*/
|
|
521
|
+
export interface S3LogDestinationParameters {
|
|
522
|
+
/**
|
|
523
|
+
* @public
|
|
524
|
+
* <p>Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</p>
|
|
525
|
+
*/
|
|
526
|
+
BucketName: string | undefined;
|
|
527
|
+
/**
|
|
528
|
+
* @public
|
|
529
|
+
* <p>Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</p>
|
|
530
|
+
*/
|
|
531
|
+
BucketOwner: string | undefined;
|
|
532
|
+
/**
|
|
533
|
+
* @public
|
|
534
|
+
* <p>How EventBridge should format the log records.</p>
|
|
535
|
+
* <ul>
|
|
536
|
+
* <li>
|
|
537
|
+
* <p>
|
|
538
|
+
* <code>json</code>: JSON </p>
|
|
539
|
+
* </li>
|
|
540
|
+
* <li>
|
|
541
|
+
* <p>
|
|
542
|
+
* <code>plain</code>: Plain text</p>
|
|
543
|
+
* </li>
|
|
544
|
+
* <li>
|
|
545
|
+
* <p>
|
|
546
|
+
* <code>w3c</code>: <a href="https://www.w3.org/TR/WD-logfile">W3C extended logging file format</a>
|
|
547
|
+
* </p>
|
|
548
|
+
* </li>
|
|
549
|
+
* </ul>
|
|
550
|
+
*/
|
|
551
|
+
OutputFormat?: S3OutputFormat;
|
|
552
|
+
/**
|
|
553
|
+
* @public
|
|
554
|
+
* <p>Specifies any prefix text with which to begin Amazon S3 log object names.</p>
|
|
555
|
+
* <p>You can use prefixes to organize the data that you store in Amazon S3 buckets.
|
|
556
|
+
* A prefix is a string of characters at the beginning of the object key name.
|
|
557
|
+
* A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes).
|
|
558
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a>
|
|
559
|
+
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
560
|
+
*/
|
|
561
|
+
Prefix?: string;
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* @public
|
|
565
|
+
* <p>Specifies the logging configuration settings for the pipe.</p>
|
|
566
|
+
* <p>When you call <code>UpdatePipe</code>, EventBridge updates the fields in the
|
|
567
|
+
* <code>PipeLogConfigurationParameters</code> object atomically as one and overrides
|
|
568
|
+
* existing values. This is by design. If you don't specify an optional field in any of the
|
|
569
|
+
* Amazon Web Services service parameters objects
|
|
570
|
+
* (<code>CloudwatchLogsLogDestinationParameters</code>,
|
|
571
|
+
* <code>FirehoseLogDestinationParameters</code>, or
|
|
572
|
+
* <code>S3LogDestinationParameters</code>), EventBridge sets that field to its
|
|
573
|
+
* system-default value during the update. </p>
|
|
574
|
+
* <p>For example, suppose when you created the pipe you
|
|
575
|
+
* specified a Kinesis Data Firehose stream log destination. You then update the pipe to add an
|
|
576
|
+
* Amazon S3 log destination. In addition to specifying the
|
|
577
|
+
* <code>S3LogDestinationParameters</code> for the new log destination, you must also
|
|
578
|
+
* specify the fields in the <code>FirehoseLogDestinationParameters</code> object in order to
|
|
579
|
+
* retain the Kinesis Data Firehose stream log destination. </p>
|
|
580
|
+
* <p>For more information on generating pipe log records, see <a href="eventbridge/latest/userguide/eb-pipes-logs.html">Log EventBridge Pipes</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
581
|
+
*/
|
|
582
|
+
export interface PipeLogConfigurationParameters {
|
|
583
|
+
/**
|
|
584
|
+
* @public
|
|
585
|
+
* <p>The Amazon S3 logging configuration settings for the pipe.</p>
|
|
586
|
+
*/
|
|
587
|
+
S3LogDestination?: S3LogDestinationParameters;
|
|
588
|
+
/**
|
|
589
|
+
* @public
|
|
590
|
+
* <p>The Amazon Kinesis Data Firehose logging configuration settings for the pipe.</p>
|
|
591
|
+
*/
|
|
592
|
+
FirehoseLogDestination?: FirehoseLogDestinationParameters;
|
|
593
|
+
/**
|
|
594
|
+
* @public
|
|
595
|
+
* <p>The Amazon CloudWatch Logs logging configuration settings for the pipe.</p>
|
|
596
|
+
*/
|
|
597
|
+
CloudwatchLogsLogDestination?: CloudwatchLogsLogDestinationParameters;
|
|
598
|
+
/**
|
|
599
|
+
* @public
|
|
600
|
+
* <p>The level of logging detail to include. This applies to all log destinations for the pipe.</p>
|
|
601
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-level">Specifying EventBridge Pipes log level</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
602
|
+
*/
|
|
603
|
+
Level: LogLevel | undefined;
|
|
604
|
+
/**
|
|
605
|
+
* @public
|
|
606
|
+
* <p>Specify <code>ON</code> to include the execution data (specifically, the <code>payload</code> and <code>awsRequest</code> fields) in the log messages for this pipe.</p>
|
|
607
|
+
* <p>This applies to all log destinations for the pipe.</p>
|
|
608
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data">Including execution data in logs</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
609
|
+
* <p>The default is <code>OFF</code>.</p>
|
|
610
|
+
*/
|
|
611
|
+
IncludeExecutionData?: IncludeExecutionDataOption[];
|
|
612
|
+
}
|
|
445
613
|
/**
|
|
446
614
|
* @public
|
|
447
615
|
* <p>The Secrets Manager secret that stores your broker credentials.</p>
|
|
@@ -505,7 +673,9 @@ export interface PipeSourceActiveMQBrokerParameters {
|
|
|
505
673
|
export interface DeadLetterConfig {
|
|
506
674
|
/**
|
|
507
675
|
* @public
|
|
508
|
-
* <p>The ARN of the
|
|
676
|
+
* <p>The ARN of the specified target for the dead-letter queue. </p>
|
|
677
|
+
* <p>For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify
|
|
678
|
+
* either an Amazon SNS topic or Amazon SQS queue ARN.</p>
|
|
509
679
|
*/
|
|
510
680
|
Arn?: string;
|
|
511
681
|
}
|
|
@@ -595,7 +765,9 @@ export interface Filter {
|
|
|
595
765
|
}
|
|
596
766
|
/**
|
|
597
767
|
* @public
|
|
598
|
-
* <p>The collection of event patterns used to filter events
|
|
768
|
+
* <p>The collection of event patterns used to filter events.</p>
|
|
769
|
+
* <p>To remove a filter, specify a <code>FilterCriteria</code> object with an empty array of <code>Filter</code> objects.</p>
|
|
770
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
599
771
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
600
772
|
*/
|
|
601
773
|
export interface FilterCriteria {
|
|
@@ -968,7 +1140,9 @@ export interface PipeSourceSqsQueueParameters {
|
|
|
968
1140
|
export interface PipeSourceParameters {
|
|
969
1141
|
/**
|
|
970
1142
|
* @public
|
|
971
|
-
* <p>The collection of event patterns used to filter events
|
|
1143
|
+
* <p>The collection of event patterns used to filter events.</p>
|
|
1144
|
+
* <p>To remove a filter, specify a <code>FilterCriteria</code> object with an empty array of <code>Filter</code> objects.</p>
|
|
1145
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
972
1146
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
973
1147
|
*/
|
|
974
1148
|
FilterCriteria?: FilterCriteria;
|
|
@@ -1572,9 +1746,6 @@ export interface PipeTargetEventBridgeEventBusParameters {
|
|
|
1572
1746
|
/**
|
|
1573
1747
|
* @public
|
|
1574
1748
|
* <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>
|
|
1575
|
-
* <important>
|
|
1576
|
-
* <p>When using Java, you must include <code>auth-crt</code> on the class path.</p>
|
|
1577
|
-
* </important>
|
|
1578
1749
|
*/
|
|
1579
1750
|
EndpointId?: string;
|
|
1580
1751
|
/**
|
|
@@ -1626,7 +1797,7 @@ export interface PipeTargetHttpParameters {
|
|
|
1626
1797
|
}
|
|
1627
1798
|
/**
|
|
1628
1799
|
* @public
|
|
1629
|
-
* <p>The parameters for using a Kinesis stream as a
|
|
1800
|
+
* <p>The parameters for using a Kinesis stream as a target.</p>
|
|
1630
1801
|
*/
|
|
1631
1802
|
export interface PipeTargetKinesisStreamParameters {
|
|
1632
1803
|
/**
|
|
@@ -1657,38 +1828,31 @@ export type PipeTargetInvocationType = (typeof PipeTargetInvocationType)[keyof t
|
|
|
1657
1828
|
export interface PipeTargetLambdaFunctionParameters {
|
|
1658
1829
|
/**
|
|
1659
1830
|
* @public
|
|
1660
|
-
* <p>
|
|
1831
|
+
* <p>Specify whether to invoke the function synchronously or asynchronously.</p>
|
|
1661
1832
|
* <ul>
|
|
1662
1833
|
* <li>
|
|
1663
1834
|
* <p>
|
|
1664
|
-
* <code>
|
|
1665
|
-
* the function returns a response or times out. The API response includes the function response and additional
|
|
1666
|
-
* data.</p>
|
|
1835
|
+
* <code>REQUEST_RESPONSE</code> (default) - Invoke synchronously. This corresponds to the <code>RequestResponse</code> option in the <code>InvocationType</code> parameter for the Lambda <a href="https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax">Invoke</a> API.</p>
|
|
1667
1836
|
* </li>
|
|
1668
1837
|
* <li>
|
|
1669
1838
|
* <p>
|
|
1670
|
-
* <code>
|
|
1671
|
-
* function's dead-letter queue (if it's configured). The API response only includes a status code.</p>
|
|
1672
|
-
* </li>
|
|
1673
|
-
* <li>
|
|
1674
|
-
* <p>
|
|
1675
|
-
* <code>DryRun</code> - Validate parameter values and verify that the user or role has permission to invoke
|
|
1676
|
-
* the function.</p>
|
|
1839
|
+
* <code>FIRE_AND_FORGET</code> - Invoke asynchronously. This corresponds to the <code>Event</code> option in the <code>InvocationType</code> parameter for the Lambda <a href="https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax">Invoke</a> API.</p>
|
|
1677
1840
|
* </li>
|
|
1678
1841
|
* </ul>
|
|
1842
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation">Invocation types</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1679
1843
|
*/
|
|
1680
1844
|
InvocationType?: PipeTargetInvocationType;
|
|
1681
1845
|
}
|
|
1682
1846
|
/**
|
|
1683
1847
|
* @public
|
|
1684
1848
|
* <p>These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the
|
|
1685
|
-
* Amazon Redshift Data API
|
|
1849
|
+
* Amazon Redshift Data API BatchExecuteStatement.</p>
|
|
1686
1850
|
*/
|
|
1687
1851
|
export interface PipeTargetRedshiftDataParameters {
|
|
1688
1852
|
/**
|
|
1689
1853
|
* @public
|
|
1690
1854
|
* <p>The name or ARN of the secret that enables access to the database. Required when
|
|
1691
|
-
* authenticating using
|
|
1855
|
+
* authenticating using Secrets Manager.</p>
|
|
1692
1856
|
*/
|
|
1693
1857
|
SecretManagerArn?: string;
|
|
1694
1858
|
/**
|
|
@@ -1749,7 +1913,7 @@ export interface PipeTargetSageMakerPipelineParameters {
|
|
|
1749
1913
|
}
|
|
1750
1914
|
/**
|
|
1751
1915
|
* @public
|
|
1752
|
-
* <p>The parameters for using a Amazon SQS stream as a
|
|
1916
|
+
* <p>The parameters for using a Amazon SQS stream as a target.</p>
|
|
1753
1917
|
*/
|
|
1754
1918
|
export interface PipeTargetSqsQueueParameters {
|
|
1755
1919
|
/**
|
|
@@ -1771,13 +1935,29 @@ export interface PipeTargetSqsQueueParameters {
|
|
|
1771
1935
|
export interface PipeTargetStateMachineParameters {
|
|
1772
1936
|
/**
|
|
1773
1937
|
* @public
|
|
1774
|
-
* <p>Specify whether to
|
|
1938
|
+
* <p>Specify whether to invoke the Step Functions state machine synchronously or asynchronously.</p>
|
|
1939
|
+
* <ul>
|
|
1940
|
+
* <li>
|
|
1941
|
+
* <p>
|
|
1942
|
+
* <code>REQUEST_RESPONSE</code> (default) - Invoke synchronously. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html">StartSyncExecution</a> in the <i>Step Functions API Reference</i>.</p>
|
|
1943
|
+
* <note>
|
|
1944
|
+
* <p>
|
|
1945
|
+
* <code>REQUEST_RESPONSE</code> is not supported for <code>STANDARD</code> state machine workflows.</p>
|
|
1946
|
+
* </note>
|
|
1947
|
+
* </li>
|
|
1948
|
+
* <li>
|
|
1949
|
+
* <p>
|
|
1950
|
+
* <code>FIRE_AND_FORGET</code> - Invoke asynchronously. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html">StartExecution</a> in the <i>Step Functions API Reference</i>.</p>
|
|
1951
|
+
* </li>
|
|
1952
|
+
* </ul>
|
|
1953
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation">Invocation types</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1775
1954
|
*/
|
|
1776
1955
|
InvocationType?: PipeTargetInvocationType;
|
|
1777
1956
|
}
|
|
1778
1957
|
/**
|
|
1779
1958
|
* @public
|
|
1780
1959
|
* <p>The parameters required to set up a target for your pipe.</p>
|
|
1960
|
+
* <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1781
1961
|
*/
|
|
1782
1962
|
export interface PipeTargetParameters {
|
|
1783
1963
|
/**
|
|
@@ -1785,6 +1965,7 @@ export interface PipeTargetParameters {
|
|
|
1785
1965
|
* <p>Valid JSON text passed to the target. In this case, nothing from the event itself is
|
|
1786
1966
|
* passed to the target. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data
|
|
1787
1967
|
* Interchange Format</a>.</p>
|
|
1968
|
+
* <p>To remove an input template, specify an empty string.</p>
|
|
1788
1969
|
*/
|
|
1789
1970
|
InputTemplate?: string;
|
|
1790
1971
|
/**
|
|
@@ -1799,7 +1980,7 @@ export interface PipeTargetParameters {
|
|
|
1799
1980
|
StepFunctionStateMachineParameters?: PipeTargetStateMachineParameters;
|
|
1800
1981
|
/**
|
|
1801
1982
|
* @public
|
|
1802
|
-
* <p>The parameters for using a Kinesis stream as a
|
|
1983
|
+
* <p>The parameters for using a Kinesis stream as a target.</p>
|
|
1803
1984
|
*/
|
|
1804
1985
|
KinesisStreamParameters?: PipeTargetKinesisStreamParameters;
|
|
1805
1986
|
/**
|
|
@@ -1814,7 +1995,7 @@ export interface PipeTargetParameters {
|
|
|
1814
1995
|
BatchJobParameters?: PipeTargetBatchJobParameters;
|
|
1815
1996
|
/**
|
|
1816
1997
|
* @public
|
|
1817
|
-
* <p>The parameters for using a Amazon SQS stream as a
|
|
1998
|
+
* <p>The parameters for using a Amazon SQS stream as a target.</p>
|
|
1818
1999
|
*/
|
|
1819
2000
|
SqsQueueParameters?: PipeTargetSqsQueueParameters;
|
|
1820
2001
|
/**
|
|
@@ -1826,7 +2007,7 @@ export interface PipeTargetParameters {
|
|
|
1826
2007
|
/**
|
|
1827
2008
|
* @public
|
|
1828
2009
|
* <p>These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the
|
|
1829
|
-
* Amazon Redshift Data API
|
|
2010
|
+
* Amazon Redshift Data API BatchExecuteStatement.</p>
|
|
1830
2011
|
*/
|
|
1831
2012
|
RedshiftDataParameters?: PipeTargetRedshiftDataParameters;
|
|
1832
2013
|
/**
|
|
@@ -1892,6 +2073,7 @@ export interface CreatePipeRequest {
|
|
|
1892
2073
|
/**
|
|
1893
2074
|
* @public
|
|
1894
2075
|
* <p>The parameters required to set up a target for your pipe.</p>
|
|
2076
|
+
* <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1895
2077
|
*/
|
|
1896
2078
|
TargetParameters?: PipeTargetParameters;
|
|
1897
2079
|
/**
|
|
@@ -1904,6 +2086,11 @@ export interface CreatePipeRequest {
|
|
|
1904
2086
|
* <p>The list of key-value pairs to associate with the pipe.</p>
|
|
1905
2087
|
*/
|
|
1906
2088
|
Tags?: Record<string, string>;
|
|
2089
|
+
/**
|
|
2090
|
+
* @public
|
|
2091
|
+
* <p>The logging configuration settings for the pipe.</p>
|
|
2092
|
+
*/
|
|
2093
|
+
LogConfiguration?: PipeLogConfigurationParameters;
|
|
1907
2094
|
}
|
|
1908
2095
|
/**
|
|
1909
2096
|
* @public
|
|
@@ -1911,7 +2098,10 @@ export interface CreatePipeRequest {
|
|
|
1911
2098
|
*/
|
|
1912
2099
|
export declare const PipeState: {
|
|
1913
2100
|
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
2101
|
+
readonly CREATE_ROLLBACK_FAILED: "CREATE_ROLLBACK_FAILED";
|
|
1914
2102
|
readonly CREATING: "CREATING";
|
|
2103
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
2104
|
+
readonly DELETE_ROLLBACK_FAILED: "DELETE_ROLLBACK_FAILED";
|
|
1915
2105
|
readonly DELETING: "DELETING";
|
|
1916
2106
|
readonly RUNNING: "RUNNING";
|
|
1917
2107
|
readonly STARTING: "STARTING";
|
|
@@ -1920,6 +2110,7 @@ export declare const PipeState: {
|
|
|
1920
2110
|
readonly STOPPING: "STOPPING";
|
|
1921
2111
|
readonly STOP_FAILED: "STOP_FAILED";
|
|
1922
2112
|
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
2113
|
+
readonly UPDATE_ROLLBACK_FAILED: "UPDATE_ROLLBACK_FAILED";
|
|
1923
2114
|
readonly UPDATING: "UPDATING";
|
|
1924
2115
|
};
|
|
1925
2116
|
/**
|
|
@@ -2150,6 +2341,93 @@ export interface DescribePipeRequest {
|
|
|
2150
2341
|
*/
|
|
2151
2342
|
Name: string | undefined;
|
|
2152
2343
|
}
|
|
2344
|
+
/**
|
|
2345
|
+
* @public
|
|
2346
|
+
* <p>The Amazon Kinesis Data Firehose logging configuration settings for the pipe.</p>
|
|
2347
|
+
*/
|
|
2348
|
+
export interface FirehoseLogDestination {
|
|
2349
|
+
/**
|
|
2350
|
+
* @public
|
|
2351
|
+
* <p>The Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.</p>
|
|
2352
|
+
*/
|
|
2353
|
+
DeliveryStreamArn?: string;
|
|
2354
|
+
}
|
|
2355
|
+
/**
|
|
2356
|
+
* @public
|
|
2357
|
+
* <p>The Amazon S3 logging configuration settings for the pipe.</p>
|
|
2358
|
+
*/
|
|
2359
|
+
export interface S3LogDestination {
|
|
2360
|
+
/**
|
|
2361
|
+
* @public
|
|
2362
|
+
* <p>The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</p>
|
|
2363
|
+
*/
|
|
2364
|
+
BucketName?: string;
|
|
2365
|
+
/**
|
|
2366
|
+
* @public
|
|
2367
|
+
* <p>The prefix text with which to begin Amazon S3 log object names.</p>
|
|
2368
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a>
|
|
2369
|
+
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
2370
|
+
*/
|
|
2371
|
+
Prefix?: string;
|
|
2372
|
+
/**
|
|
2373
|
+
* @public
|
|
2374
|
+
* <p>The Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</p>
|
|
2375
|
+
*/
|
|
2376
|
+
BucketOwner?: string;
|
|
2377
|
+
/**
|
|
2378
|
+
* @public
|
|
2379
|
+
* <p>The format EventBridge uses for the log records.</p>
|
|
2380
|
+
* <ul>
|
|
2381
|
+
* <li>
|
|
2382
|
+
* <p>
|
|
2383
|
+
* <code>json</code>: JSON </p>
|
|
2384
|
+
* </li>
|
|
2385
|
+
* <li>
|
|
2386
|
+
* <p>
|
|
2387
|
+
* <code>plain</code>: Plain text</p>
|
|
2388
|
+
* </li>
|
|
2389
|
+
* <li>
|
|
2390
|
+
* <p>
|
|
2391
|
+
* <code>w3c</code>: <a href="https://www.w3.org/TR/WD-logfile">W3C extended logging file format</a>
|
|
2392
|
+
* </p>
|
|
2393
|
+
* </li>
|
|
2394
|
+
* </ul>
|
|
2395
|
+
*/
|
|
2396
|
+
OutputFormat?: S3OutputFormat;
|
|
2397
|
+
}
|
|
2398
|
+
/**
|
|
2399
|
+
* @public
|
|
2400
|
+
* <p>The logging configuration settings for the pipe.</p>
|
|
2401
|
+
*/
|
|
2402
|
+
export interface PipeLogConfiguration {
|
|
2403
|
+
/**
|
|
2404
|
+
* @public
|
|
2405
|
+
* <p>The Amazon S3 logging configuration settings for the pipe.</p>
|
|
2406
|
+
*/
|
|
2407
|
+
S3LogDestination?: S3LogDestination;
|
|
2408
|
+
/**
|
|
2409
|
+
* @public
|
|
2410
|
+
* <p>The Amazon Kinesis Data Firehose logging configuration settings for the pipe.</p>
|
|
2411
|
+
*/
|
|
2412
|
+
FirehoseLogDestination?: FirehoseLogDestination;
|
|
2413
|
+
/**
|
|
2414
|
+
* @public
|
|
2415
|
+
* <p>The Amazon CloudWatch Logs logging configuration settings for the pipe.</p>
|
|
2416
|
+
*/
|
|
2417
|
+
CloudwatchLogsLogDestination?: CloudwatchLogsLogDestination;
|
|
2418
|
+
/**
|
|
2419
|
+
* @public
|
|
2420
|
+
* <p>The level of logging detail to include. This applies to all log destinations for the pipe.</p>
|
|
2421
|
+
*/
|
|
2422
|
+
Level?: LogLevel;
|
|
2423
|
+
/**
|
|
2424
|
+
* @public
|
|
2425
|
+
* <p>Whether the execution data (specifically, the <code>payload</code>, <code>awsRequest</code>, and <code>awsResponse</code> fields) is included in the log messages for this pipe.</p>
|
|
2426
|
+
* <p>This applies to all log destinations for the pipe.</p>
|
|
2427
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data">Including execution data in logs</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
2428
|
+
*/
|
|
2429
|
+
IncludeExecutionData?: IncludeExecutionDataOption[];
|
|
2430
|
+
}
|
|
2153
2431
|
/**
|
|
2154
2432
|
* @public
|
|
2155
2433
|
*/
|
|
@@ -2212,6 +2490,7 @@ export interface DescribePipeResponse {
|
|
|
2212
2490
|
/**
|
|
2213
2491
|
* @public
|
|
2214
2492
|
* <p>The parameters required to set up a target for your pipe.</p>
|
|
2493
|
+
* <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
2215
2494
|
*/
|
|
2216
2495
|
TargetParameters?: PipeTargetParameters;
|
|
2217
2496
|
/**
|
|
@@ -2234,6 +2513,11 @@ export interface DescribePipeResponse {
|
|
|
2234
2513
|
* <p>When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>
|
|
2235
2514
|
*/
|
|
2236
2515
|
LastModifiedTime?: Date;
|
|
2516
|
+
/**
|
|
2517
|
+
* @public
|
|
2518
|
+
* <p>The logging configuration settings for the pipe.</p>
|
|
2519
|
+
*/
|
|
2520
|
+
LogConfiguration?: PipeLogConfiguration;
|
|
2237
2521
|
}
|
|
2238
2522
|
/**
|
|
2239
2523
|
* @public
|
|
@@ -2666,7 +2950,9 @@ export interface UpdatePipeSourceSqsQueueParameters {
|
|
|
2666
2950
|
export interface UpdatePipeSourceParameters {
|
|
2667
2951
|
/**
|
|
2668
2952
|
* @public
|
|
2669
|
-
* <p>The collection of event patterns used to filter events
|
|
2953
|
+
* <p>The collection of event patterns used to filter events.</p>
|
|
2954
|
+
* <p>To remove a filter, specify a <code>FilterCriteria</code> object with an empty array of <code>Filter</code> objects.</p>
|
|
2955
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
2670
2956
|
* Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
2671
2957
|
*/
|
|
2672
2958
|
FilterCriteria?: FilterCriteria;
|
|
@@ -2748,6 +3034,7 @@ export interface UpdatePipeRequest {
|
|
|
2748
3034
|
/**
|
|
2749
3035
|
* @public
|
|
2750
3036
|
* <p>The parameters required to set up a target for your pipe.</p>
|
|
3037
|
+
* <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
2751
3038
|
*/
|
|
2752
3039
|
TargetParameters?: PipeTargetParameters;
|
|
2753
3040
|
/**
|
|
@@ -2755,6 +3042,11 @@ export interface UpdatePipeRequest {
|
|
|
2755
3042
|
* <p>The ARN of the role that allows the pipe to send data to the target.</p>
|
|
2756
3043
|
*/
|
|
2757
3044
|
RoleArn: string | undefined;
|
|
3045
|
+
/**
|
|
3046
|
+
* @public
|
|
3047
|
+
* <p>The logging configuration settings for the pipe.</p>
|
|
3048
|
+
*/
|
|
3049
|
+
LogConfiguration?: PipeLogConfigurationParameters;
|
|
2758
3050
|
}
|
|
2759
3051
|
/**
|
|
2760
3052
|
* @public
|
|
@@ -53,6 +53,12 @@ export interface CapacityProviderStrategyItem {
|
|
|
53
53
|
weight?: number;
|
|
54
54
|
base?: number;
|
|
55
55
|
}
|
|
56
|
+
export interface CloudwatchLogsLogDestination {
|
|
57
|
+
LogGroupArn?: string;
|
|
58
|
+
}
|
|
59
|
+
export interface CloudwatchLogsLogDestinationParameters {
|
|
60
|
+
LogGroupArn: string | undefined;
|
|
61
|
+
}
|
|
56
62
|
export declare class ConflictException extends __BaseException {
|
|
57
63
|
readonly name: "ConflictException";
|
|
58
64
|
readonly $fault: "client";
|
|
@@ -75,6 +81,41 @@ export interface PipeEnrichmentParameters {
|
|
|
75
81
|
InputTemplate?: string;
|
|
76
82
|
HttpParameters?: PipeEnrichmentHttpParameters;
|
|
77
83
|
}
|
|
84
|
+
export interface FirehoseLogDestinationParameters {
|
|
85
|
+
DeliveryStreamArn: string | undefined;
|
|
86
|
+
}
|
|
87
|
+
export declare const IncludeExecutionDataOption: {
|
|
88
|
+
readonly ALL: "ALL";
|
|
89
|
+
};
|
|
90
|
+
export type IncludeExecutionDataOption =
|
|
91
|
+
(typeof IncludeExecutionDataOption)[keyof typeof IncludeExecutionDataOption];
|
|
92
|
+
export declare const LogLevel: {
|
|
93
|
+
readonly ERROR: "ERROR";
|
|
94
|
+
readonly INFO: "INFO";
|
|
95
|
+
readonly OFF: "OFF";
|
|
96
|
+
readonly TRACE: "TRACE";
|
|
97
|
+
};
|
|
98
|
+
export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
|
|
99
|
+
export declare const S3OutputFormat: {
|
|
100
|
+
readonly JSON: "json";
|
|
101
|
+
readonly PLAIN: "plain";
|
|
102
|
+
readonly W3C: "w3c";
|
|
103
|
+
};
|
|
104
|
+
export type S3OutputFormat =
|
|
105
|
+
(typeof S3OutputFormat)[keyof typeof S3OutputFormat];
|
|
106
|
+
export interface S3LogDestinationParameters {
|
|
107
|
+
BucketName: string | undefined;
|
|
108
|
+
BucketOwner: string | undefined;
|
|
109
|
+
OutputFormat?: S3OutputFormat;
|
|
110
|
+
Prefix?: string;
|
|
111
|
+
}
|
|
112
|
+
export interface PipeLogConfigurationParameters {
|
|
113
|
+
S3LogDestination?: S3LogDestinationParameters;
|
|
114
|
+
FirehoseLogDestination?: FirehoseLogDestinationParameters;
|
|
115
|
+
CloudwatchLogsLogDestination?: CloudwatchLogsLogDestinationParameters;
|
|
116
|
+
Level: LogLevel | undefined;
|
|
117
|
+
IncludeExecutionData?: IncludeExecutionDataOption[];
|
|
118
|
+
}
|
|
78
119
|
export type MQBrokerAccessCredentials =
|
|
79
120
|
| MQBrokerAccessCredentials.BasicAuthMember
|
|
80
121
|
| MQBrokerAccessCredentials.$UnknownMember;
|
|
@@ -473,10 +514,14 @@ export interface CreatePipeRequest {
|
|
|
473
514
|
TargetParameters?: PipeTargetParameters;
|
|
474
515
|
RoleArn: string | undefined;
|
|
475
516
|
Tags?: Record<string, string>;
|
|
517
|
+
LogConfiguration?: PipeLogConfigurationParameters;
|
|
476
518
|
}
|
|
477
519
|
export declare const PipeState: {
|
|
478
520
|
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
521
|
+
readonly CREATE_ROLLBACK_FAILED: "CREATE_ROLLBACK_FAILED";
|
|
479
522
|
readonly CREATING: "CREATING";
|
|
523
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
524
|
+
readonly DELETE_ROLLBACK_FAILED: "DELETE_ROLLBACK_FAILED";
|
|
480
525
|
readonly DELETING: "DELETING";
|
|
481
526
|
readonly RUNNING: "RUNNING";
|
|
482
527
|
readonly STARTING: "STARTING";
|
|
@@ -485,6 +530,7 @@ export declare const PipeState: {
|
|
|
485
530
|
readonly STOPPING: "STOPPING";
|
|
486
531
|
readonly STOP_FAILED: "STOP_FAILED";
|
|
487
532
|
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
533
|
+
readonly UPDATE_ROLLBACK_FAILED: "UPDATE_ROLLBACK_FAILED";
|
|
488
534
|
readonly UPDATING: "UPDATING";
|
|
489
535
|
};
|
|
490
536
|
export type PipeState = (typeof PipeState)[keyof typeof PipeState];
|
|
@@ -561,6 +607,22 @@ export interface DeletePipeResponse {
|
|
|
561
607
|
export interface DescribePipeRequest {
|
|
562
608
|
Name: string | undefined;
|
|
563
609
|
}
|
|
610
|
+
export interface FirehoseLogDestination {
|
|
611
|
+
DeliveryStreamArn?: string;
|
|
612
|
+
}
|
|
613
|
+
export interface S3LogDestination {
|
|
614
|
+
BucketName?: string;
|
|
615
|
+
Prefix?: string;
|
|
616
|
+
BucketOwner?: string;
|
|
617
|
+
OutputFormat?: S3OutputFormat;
|
|
618
|
+
}
|
|
619
|
+
export interface PipeLogConfiguration {
|
|
620
|
+
S3LogDestination?: S3LogDestination;
|
|
621
|
+
FirehoseLogDestination?: FirehoseLogDestination;
|
|
622
|
+
CloudwatchLogsLogDestination?: CloudwatchLogsLogDestination;
|
|
623
|
+
Level?: LogLevel;
|
|
624
|
+
IncludeExecutionData?: IncludeExecutionDataOption[];
|
|
625
|
+
}
|
|
564
626
|
export interface DescribePipeResponse {
|
|
565
627
|
Arn?: string;
|
|
566
628
|
Name?: string;
|
|
@@ -578,6 +640,7 @@ export interface DescribePipeResponse {
|
|
|
578
640
|
Tags?: Record<string, string>;
|
|
579
641
|
CreationTime?: Date;
|
|
580
642
|
LastModifiedTime?: Date;
|
|
643
|
+
LogConfiguration?: PipeLogConfiguration;
|
|
581
644
|
}
|
|
582
645
|
export interface ListPipesRequest {
|
|
583
646
|
NamePrefix?: string;
|
|
@@ -696,6 +759,7 @@ export interface UpdatePipeRequest {
|
|
|
696
759
|
Target?: string;
|
|
697
760
|
TargetParameters?: PipeTargetParameters;
|
|
698
761
|
RoleArn: string | undefined;
|
|
762
|
+
LogConfiguration?: PipeLogConfigurationParameters;
|
|
699
763
|
}
|
|
700
764
|
export interface UpdatePipeResponse {
|
|
701
765
|
Arn?: string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-pipes",
|
|
3
3
|
"description": "AWS SDK for JavaScript Pipes Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.451.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,42 +21,42 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/core": "3.
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
27
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
28
|
-
"@aws-sdk/middleware-logger": "3.
|
|
29
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
30
|
-
"@aws-sdk/middleware-signing": "3.
|
|
31
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
32
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
33
|
-
"@aws-sdk/types": "3.
|
|
34
|
-
"@aws-sdk/util-endpoints": "3.
|
|
35
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
36
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
37
|
-
"@smithy/config-resolver": "^2.0.
|
|
38
|
-
"@smithy/fetch-http-handler": "^2.2.
|
|
39
|
-
"@smithy/hash-node": "^2.0.
|
|
40
|
-
"@smithy/invalid-dependency": "^2.0.
|
|
41
|
-
"@smithy/middleware-content-length": "^2.0.
|
|
42
|
-
"@smithy/middleware-endpoint": "^2.
|
|
43
|
-
"@smithy/middleware-retry": "^2.0.
|
|
44
|
-
"@smithy/middleware-serde": "^2.0.
|
|
45
|
-
"@smithy/middleware-stack": "^2.0.
|
|
46
|
-
"@smithy/node-config-provider": "^2.1.
|
|
47
|
-
"@smithy/node-http-handler": "^2.1.
|
|
48
|
-
"@smithy/protocol-http": "^3.0.
|
|
49
|
-
"@smithy/smithy-client": "^2.1.
|
|
50
|
-
"@smithy/types": "^2.
|
|
51
|
-
"@smithy/url-parser": "^2.0.
|
|
52
|
-
"@smithy/util-base64": "^2.0.
|
|
24
|
+
"@aws-sdk/client-sts": "3.451.0",
|
|
25
|
+
"@aws-sdk/core": "3.451.0",
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.451.0",
|
|
27
|
+
"@aws-sdk/middleware-host-header": "3.451.0",
|
|
28
|
+
"@aws-sdk/middleware-logger": "3.451.0",
|
|
29
|
+
"@aws-sdk/middleware-recursion-detection": "3.451.0",
|
|
30
|
+
"@aws-sdk/middleware-signing": "3.451.0",
|
|
31
|
+
"@aws-sdk/middleware-user-agent": "3.451.0",
|
|
32
|
+
"@aws-sdk/region-config-resolver": "3.451.0",
|
|
33
|
+
"@aws-sdk/types": "3.451.0",
|
|
34
|
+
"@aws-sdk/util-endpoints": "3.451.0",
|
|
35
|
+
"@aws-sdk/util-user-agent-browser": "3.451.0",
|
|
36
|
+
"@aws-sdk/util-user-agent-node": "3.451.0",
|
|
37
|
+
"@smithy/config-resolver": "^2.0.18",
|
|
38
|
+
"@smithy/fetch-http-handler": "^2.2.6",
|
|
39
|
+
"@smithy/hash-node": "^2.0.15",
|
|
40
|
+
"@smithy/invalid-dependency": "^2.0.13",
|
|
41
|
+
"@smithy/middleware-content-length": "^2.0.15",
|
|
42
|
+
"@smithy/middleware-endpoint": "^2.2.0",
|
|
43
|
+
"@smithy/middleware-retry": "^2.0.20",
|
|
44
|
+
"@smithy/middleware-serde": "^2.0.13",
|
|
45
|
+
"@smithy/middleware-stack": "^2.0.7",
|
|
46
|
+
"@smithy/node-config-provider": "^2.1.5",
|
|
47
|
+
"@smithy/node-http-handler": "^2.1.9",
|
|
48
|
+
"@smithy/protocol-http": "^3.0.9",
|
|
49
|
+
"@smithy/smithy-client": "^2.1.15",
|
|
50
|
+
"@smithy/types": "^2.5.0",
|
|
51
|
+
"@smithy/url-parser": "^2.0.13",
|
|
52
|
+
"@smithy/util-base64": "^2.0.1",
|
|
53
53
|
"@smithy/util-body-length-browser": "^2.0.0",
|
|
54
54
|
"@smithy/util-body-length-node": "^2.1.0",
|
|
55
|
-
"@smithy/util-defaults-mode-browser": "^2.0.
|
|
56
|
-
"@smithy/util-defaults-mode-node": "^2.0.
|
|
57
|
-
"@smithy/util-endpoints": "^1.0.
|
|
58
|
-
"@smithy/util-retry": "^2.0.
|
|
59
|
-
"@smithy/util-utf8": "^2.0.
|
|
55
|
+
"@smithy/util-defaults-mode-browser": "^2.0.19",
|
|
56
|
+
"@smithy/util-defaults-mode-node": "^2.0.25",
|
|
57
|
+
"@smithy/util-endpoints": "^1.0.4",
|
|
58
|
+
"@smithy/util-retry": "^2.0.6",
|
|
59
|
+
"@smithy/util-utf8": "^2.0.2",
|
|
60
60
|
"tslib": "^2.5.0"
|
|
61
61
|
},
|
|
62
62
|
"devDependencies": {
|