Skip to content

Commit d7010ea

Browse files
author
awstools
committed
feat(client-pipes): This release adds Timestream for LiveAnalytics as a supported target in EventBridge Pipes
1 parent 06f51cc commit d7010ea

File tree

11 files changed

+1341
-433
lines changed

11 files changed

+1341
-433
lines changed

clients/client-pipes/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,12 @@
66

77
AWS SDK for JavaScript Pipes Client for Node.js, Browser and React Native.
88

9-
<p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing
10-
event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target.
11-
To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data. </p>
9+
<p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need
10+
for specialized knowledge and integration code when developing event driven architectures.
11+
This helps ensures consistency across your company’s applications. With Pipes, the target
12+
can be any available EventBridge target. To set up a pipe, you select the event
13+
source, add optional event filtering, define optional enrichment, and select the target for
14+
the event data. </p>
1215

1316
## Installing
1417

clients/client-pipes/src/Pipes.ts

+6-3
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,12 @@ export interface Pipes {
159159
}
160160

161161
/**
162-
* <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing
163-
* event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target.
164-
* To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data. </p>
162+
* <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need
163+
* for specialized knowledge and integration code when developing event driven architectures.
164+
* This helps ensures consistency across your company’s applications. With Pipes, the target
165+
* can be any available EventBridge target. To set up a pipe, you select the event
166+
* source, add optional event filtering, define optional enrichment, and select the target for
167+
* the event data. </p>
165168
* @public
166169
*/
167170
export class Pipes extends PipesClient implements Pipes {}

clients/client-pipes/src/PipesClient.ts

+6-3
Original file line numberDiff line numberDiff line change
@@ -279,9 +279,12 @@ export type PipesClientResolvedConfigType = __SmithyResolvedConfiguration<__Http
279279
export interface PipesClientResolvedConfig extends PipesClientResolvedConfigType {}
280280

281281
/**
282-
* <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing
283-
* event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target.
284-
* To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data. </p>
282+
* <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need
283+
* for specialized knowledge and integration code when developing event driven architectures.
284+
* This helps ensures consistency across your company’s applications. With Pipes, the target
285+
* can be any available EventBridge target. To set up a pipe, you select the event
286+
* source, add optional event filtering, define optional enrichment, and select the target for
287+
* the event data. </p>
285288
* @public
286289
*/
287290
export class PipesClient extends __Client<

clients/client-pipes/src/commands/CreatePipeCommand.ts

+35-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ export interface CreatePipeCommandInput extends CreatePipeRequest {}
2727
export interface CreatePipeCommandOutput extends CreatePipeResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.</p>
30+
* <p>Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces
31+
* the need for specialized knowledge and integration code.</p>
3132
* @example
3233
* Use a bare-bones client and the command you need to make an API call.
3334
* ```javascript
@@ -331,6 +332,39 @@ export interface CreatePipeCommandOutput extends CreatePipeResponse, __MetadataB
331332
* LogStreamName: "STRING_VALUE",
332333
* Timestamp: "STRING_VALUE",
333334
* },
335+
* TimestreamParameters: { // PipeTargetTimestreamParameters
336+
* TimeValue: "STRING_VALUE", // required
337+
* EpochTimeUnit: "STRING_VALUE",
338+
* TimeFieldType: "STRING_VALUE",
339+
* TimestampFormat: "STRING_VALUE",
340+
* VersionValue: "STRING_VALUE", // required
341+
* DimensionMappings: [ // DimensionMappings // required
342+
* { // DimensionMapping
343+
* DimensionValue: "STRING_VALUE", // required
344+
* DimensionValueType: "STRING_VALUE", // required
345+
* DimensionName: "STRING_VALUE", // required
346+
* },
347+
* ],
348+
* SingleMeasureMappings: [ // SingleMeasureMappings
349+
* { // SingleMeasureMapping
350+
* MeasureValue: "STRING_VALUE", // required
351+
* MeasureValueType: "STRING_VALUE", // required
352+
* MeasureName: "STRING_VALUE", // required
353+
* },
354+
* ],
355+
* MultiMeasureMappings: [ // MultiMeasureMappings
356+
* { // MultiMeasureMapping
357+
* MultiMeasureName: "STRING_VALUE", // required
358+
* MultiMeasureAttributeMappings: [ // MultiMeasureAttributeMappings // required
359+
* { // MultiMeasureAttributeMapping
360+
* MeasureValue: "STRING_VALUE", // required
361+
* MeasureValueType: "STRING_VALUE", // required
362+
* MultiMeasureAttributeName: "STRING_VALUE", // required
363+
* },
364+
* ],
365+
* },
366+
* ],
367+
* },
334368
* },
335369
* RoleArn: "STRING_VALUE", // required
336370
* Tags: { // TagMap

clients/client-pipes/src/commands/DescribePipeCommand.ts

+33
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,39 @@ export interface DescribePipeCommandOutput extends DescribePipeResponse, __Metad
339339
* // LogStreamName: "STRING_VALUE",
340340
* // Timestamp: "STRING_VALUE",
341341
* // },
342+
* // TimestreamParameters: { // PipeTargetTimestreamParameters
343+
* // TimeValue: "STRING_VALUE", // required
344+
* // EpochTimeUnit: "STRING_VALUE",
345+
* // TimeFieldType: "STRING_VALUE",
346+
* // TimestampFormat: "STRING_VALUE",
347+
* // VersionValue: "STRING_VALUE", // required
348+
* // DimensionMappings: [ // DimensionMappings // required
349+
* // { // DimensionMapping
350+
* // DimensionValue: "STRING_VALUE", // required
351+
* // DimensionValueType: "STRING_VALUE", // required
352+
* // DimensionName: "STRING_VALUE", // required
353+
* // },
354+
* // ],
355+
* // SingleMeasureMappings: [ // SingleMeasureMappings
356+
* // { // SingleMeasureMapping
357+
* // MeasureValue: "STRING_VALUE", // required
358+
* // MeasureValueType: "STRING_VALUE", // required
359+
* // MeasureName: "STRING_VALUE", // required
360+
* // },
361+
* // ],
362+
* // MultiMeasureMappings: [ // MultiMeasureMappings
363+
* // { // MultiMeasureMapping
364+
* // MultiMeasureName: "STRING_VALUE", // required
365+
* // MultiMeasureAttributeMappings: [ // MultiMeasureAttributeMappings // required
366+
* // { // MultiMeasureAttributeMapping
367+
* // MeasureValue: "STRING_VALUE", // required
368+
* // MeasureValueType: "STRING_VALUE", // required
369+
* // MultiMeasureAttributeName: "STRING_VALUE", // required
370+
* // },
371+
* // ],
372+
* // },
373+
* // ],
374+
* // },
342375
* // },
343376
* // RoleArn: "STRING_VALUE",
344377
* // Tags: { // TagMap

clients/client-pipes/src/commands/TagResourceCommand.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,16 @@ export interface TagResourceCommandInput extends TagResourceRequest {}
2727
export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Assigns one or more tags (key-value pairs) to the specified pipe. Tags can
31-
* help you organize and categorize your resources. You can also use them to scope user
32-
* permissions by granting a user permission to access or change only resources with certain tag
30+
* <p>Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you
31+
* organize and categorize your resources. You can also use them to scope user permissions by
32+
* granting a user permission to access or change only resources with certain tag
3333
* values.</p>
34-
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of
35-
* characters.</p>
34+
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly
35+
* as strings of characters.</p>
3636
* <p>You can use the <code>TagResource</code> action with a pipe that already has tags. If
37-
* you specify a new tag key, this tag is appended to the list of tags associated with the
38-
* pipe. If you specify a tag key that is already associated with the pipe, the new tag
39-
* value that you specify replaces the previous value for that tag.</p>
37+
* you specify a new tag key, this tag is appended to the list of tags associated with the
38+
* pipe. If you specify a tag key that is already associated with the pipe, the new tag value
39+
* that you specify replaces the previous value for that tag.</p>
4040
* <p>You can associate as many as 50 tags with a pipe.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.

clients/client-pipes/src/commands/UpdatePipeCommand.ts

+44-6
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,18 @@ export interface UpdatePipeCommandInput extends UpdatePipeRequest {}
2727
export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataBearer {}
2828

2929
/**
30-
* <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.
31-
* The exception to this is if you modify any Amazon Web Services-service specific fields in the <code>SourceParameters</code>, <code>EnrichmentParameters</code>, or
32-
* <code>TargetParameters</code> objects. For example, <code>DynamoDBStreamParameters</code> or <code>EventBridgeEventBusParameters</code>.
33-
* EventBridge updates the fields in these objects atomically as one and overrides existing values.
34-
* 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+
* <p>Update an existing pipe. When you call <code>UpdatePipe</code>, EventBridge only the
31+
* updates fields you have specified in the request; the rest remain unchanged. The exception
32+
* to this is if you modify any Amazon Web Services-service specific fields in the
33+
* <code>SourceParameters</code>, <code>EnrichmentParameters</code>, or
34+
* <code>TargetParameters</code> objects. For example,
35+
* <code>DynamoDBStreamParameters</code> or <code>EventBridgeEventBusParameters</code>.
36+
* EventBridge updates the fields in these objects atomically as one and overrides existing
37+
* values. This is by design, and means that if you don't specify an optional field in one of
38+
* these <code>Parameters</code> objects, EventBridge sets that field to its system-default
39+
* value during the update.</p>
3540
* <p>For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">
36-
* Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>
41+
* Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>
3742
* @example
3843
* Use a bare-bones client and the command you need to make an API call.
3944
* ```javascript
@@ -321,6 +326,39 @@ export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataB
321326
* LogStreamName: "STRING_VALUE",
322327
* Timestamp: "STRING_VALUE",
323328
* },
329+
* TimestreamParameters: { // PipeTargetTimestreamParameters
330+
* TimeValue: "STRING_VALUE", // required
331+
* EpochTimeUnit: "STRING_VALUE",
332+
* TimeFieldType: "STRING_VALUE",
333+
* TimestampFormat: "STRING_VALUE",
334+
* VersionValue: "STRING_VALUE", // required
335+
* DimensionMappings: [ // DimensionMappings // required
336+
* { // DimensionMapping
337+
* DimensionValue: "STRING_VALUE", // required
338+
* DimensionValueType: "STRING_VALUE", // required
339+
* DimensionName: "STRING_VALUE", // required
340+
* },
341+
* ],
342+
* SingleMeasureMappings: [ // SingleMeasureMappings
343+
* { // SingleMeasureMapping
344+
* MeasureValue: "STRING_VALUE", // required
345+
* MeasureValueType: "STRING_VALUE", // required
346+
* MeasureName: "STRING_VALUE", // required
347+
* },
348+
* ],
349+
* MultiMeasureMappings: [ // MultiMeasureMappings
350+
* { // MultiMeasureMapping
351+
* MultiMeasureName: "STRING_VALUE", // required
352+
* MultiMeasureAttributeMappings: [ // MultiMeasureAttributeMappings // required
353+
* { // MultiMeasureAttributeMapping
354+
* MeasureValue: "STRING_VALUE", // required
355+
* MeasureValueType: "STRING_VALUE", // required
356+
* MultiMeasureAttributeName: "STRING_VALUE", // required
357+
* },
358+
* ],
359+
* },
360+
* ],
361+
* },
324362
* },
325363
* RoleArn: "STRING_VALUE", // required
326364
* LogConfiguration: { // PipeLogConfigurationParameters

clients/client-pipes/src/index.ts

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
// smithy-typescript generated code
22
/* eslint-disable */
33
/**
4-
* <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing
5-
* event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target.
6-
* To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data. </p>
4+
* <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need
5+
* for specialized knowledge and integration code when developing event driven architectures.
6+
* This helps ensures consistency across your company’s applications. With Pipes, the target
7+
* can be any available EventBridge target. To set up a pipe, you select the event
8+
* source, add optional event filtering, define optional enrichment, and select the target for
9+
* the event data. </p>
710
*
811
* @packageDocumentation
912
*/

0 commit comments

Comments
 (0)