feat(client-pipes): This release adds Timestream for LiveAnalytics as…

… a supported target in EventBridge Pipes
aws · Jun 4, 2024 · d7010ea · d7010ea
1 parent 06f51cc
commit d7010ea
Show file tree

Hide file tree

Showing 11 changed files with 1,341 additions and 433 deletions.
diff --git a/clients/client-pipes/README.md b/clients/client-pipes/README.md
@@ -6,9 +6,12 @@
 
 AWS SDK for JavaScript Pipes Client for Node.js, Browser and React Native.
 
-<p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing
-event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target.
-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>
+<p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need
+for specialized knowledge and integration code when developing event driven architectures.
+This helps ensures consistency across your company’s applications. With Pipes, the target
+can be any available EventBridge target. 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>
 
 ## Installing
 

diff --git a/clients/client-pipes/src/Pipes.ts b/clients/client-pipes/src/Pipes.ts
@@ -159,9 +159,12 @@ export interface Pipes {
 }
 
 /**
- * <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing
- *       event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target.
- *       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>
+ * <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need
+ *          for specialized knowledge and integration code when developing event driven architectures.
+ *          This helps ensures consistency across your company’s applications. With Pipes, the target
+ *          can be any available EventBridge target. 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>
  * @public
  */
 export class Pipes extends PipesClient implements Pipes {}

diff --git a/clients/client-pipes/src/PipesClient.ts b/clients/client-pipes/src/PipesClient.ts
@@ -279,9 +279,12 @@ export type PipesClientResolvedConfigType = __SmithyResolvedConfiguration<__Http
 export interface PipesClientResolvedConfig extends PipesClientResolvedConfigType {}
 
 /**
- * <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing
- *       event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target.
- *       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>
+ * <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need
+ *          for specialized knowledge and integration code when developing event driven architectures.
+ *          This helps ensures consistency across your company’s applications. With Pipes, the target
+ *          can be any available EventBridge target. 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>
  * @public
  */
 export class PipesClient extends __Client<

diff --git a/clients/client-pipes/src/commands/CreatePipeCommand.ts b/clients/client-pipes/src/commands/CreatePipeCommand.ts
@@ -27,7 +27,8 @@ export interface CreatePipeCommandInput extends CreatePipeRequest {}
 export interface CreatePipeCommandOutput extends CreatePipeResponse, __MetadataBearer {}
 
 /**
- * <p>Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.</p>
+ * <p>Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces
+ *          the need for specialized knowledge and integration code.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -331,6 +332,39 @@ export interface CreatePipeCommandOutput extends CreatePipeResponse, __MetadataB
  *       LogStreamName: "STRING_VALUE",
  *       Timestamp: "STRING_VALUE",
  *     },
+ *     TimestreamParameters: { // PipeTargetTimestreamParameters
+ *       TimeValue: "STRING_VALUE", // required
+ *       EpochTimeUnit: "STRING_VALUE",
+ *       TimeFieldType: "STRING_VALUE",
+ *       TimestampFormat: "STRING_VALUE",
+ *       VersionValue: "STRING_VALUE", // required
+ *       DimensionMappings: [ // DimensionMappings // required
+ *         { // DimensionMapping
+ *           DimensionValue: "STRING_VALUE", // required
+ *           DimensionValueType: "STRING_VALUE", // required
+ *           DimensionName: "STRING_VALUE", // required
+ *         },
+ *       ],
+ *       SingleMeasureMappings: [ // SingleMeasureMappings
+ *         { // SingleMeasureMapping
+ *           MeasureValue: "STRING_VALUE", // required
+ *           MeasureValueType: "STRING_VALUE", // required
+ *           MeasureName: "STRING_VALUE", // required
+ *         },
+ *       ],
+ *       MultiMeasureMappings: [ // MultiMeasureMappings
+ *         { // MultiMeasureMapping
+ *           MultiMeasureName: "STRING_VALUE", // required
+ *           MultiMeasureAttributeMappings: [ // MultiMeasureAttributeMappings // required
+ *             { // MultiMeasureAttributeMapping
+ *               MeasureValue: "STRING_VALUE", // required
+ *               MeasureValueType: "STRING_VALUE", // required
+ *               MultiMeasureAttributeName: "STRING_VALUE", // required
+ *             },
+ *           ],
+ *         },
+ *       ],
+ *     },
  *   },
  *   RoleArn: "STRING_VALUE", // required
  *   Tags: { // TagMap

diff --git a/clients/client-pipes/src/commands/DescribePipeCommand.ts b/clients/client-pipes/src/commands/DescribePipeCommand.ts
@@ -339,6 +339,39 @@ export interface DescribePipeCommandOutput extends DescribePipeResponse, __Metad
  * //       LogStreamName: "STRING_VALUE",
  * //       Timestamp: "STRING_VALUE",
  * //     },
+ * //     TimestreamParameters: { // PipeTargetTimestreamParameters
+ * //       TimeValue: "STRING_VALUE", // required
+ * //       EpochTimeUnit: "STRING_VALUE",
+ * //       TimeFieldType: "STRING_VALUE",
+ * //       TimestampFormat: "STRING_VALUE",
+ * //       VersionValue: "STRING_VALUE", // required
+ * //       DimensionMappings: [ // DimensionMappings // required
+ * //         { // DimensionMapping
+ * //           DimensionValue: "STRING_VALUE", // required
+ * //           DimensionValueType: "STRING_VALUE", // required
+ * //           DimensionName: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //       SingleMeasureMappings: [ // SingleMeasureMappings
+ * //         { // SingleMeasureMapping
+ * //           MeasureValue: "STRING_VALUE", // required
+ * //           MeasureValueType: "STRING_VALUE", // required
+ * //           MeasureName: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //       MultiMeasureMappings: [ // MultiMeasureMappings
+ * //         { // MultiMeasureMapping
+ * //           MultiMeasureName: "STRING_VALUE", // required
+ * //           MultiMeasureAttributeMappings: [ // MultiMeasureAttributeMappings // required
+ * //             { // MultiMeasureAttributeMapping
+ * //               MeasureValue: "STRING_VALUE", // required
+ * //               MeasureValueType: "STRING_VALUE", // required
+ * //               MultiMeasureAttributeName: "STRING_VALUE", // required
+ * //             },
+ * //           ],
+ * //         },
+ * //       ],
+ * //     },
  * //   },
  * //   RoleArn: "STRING_VALUE",
  * //   Tags: { // TagMap

diff --git a/clients/client-pipes/src/commands/TagResourceCommand.ts b/clients/client-pipes/src/commands/TagResourceCommand.ts
@@ -27,16 +27,16 @@ export interface TagResourceCommandInput extends TagResourceRequest {}
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {}
 
 /**
- * <p>Assigns one or more tags (key-value pairs) to the specified pipe. Tags can
- *          help you organize and categorize your resources. You can also use them to scope user
- *          permissions by granting a user permission to access or change only resources with certain tag
+ * <p>Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you
+ *          organize and categorize your resources. You can also use them to scope user permissions by
+ *          granting a user permission to access or change only resources with certain tag
  *          values.</p>
- *          <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of
- *             characters.</p>
+ *          <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly
+ *          as strings of characters.</p>
  *          <p>You can use the <code>TagResource</code> action with a pipe that already has tags. If
- *             you specify a new tag key, this tag is appended to the list of tags associated with the
- *             pipe. If you specify a tag key that is already associated with the pipe, the new tag
- *             value that you specify replaces the previous value for that tag.</p>
+ *          you specify a new tag key, this tag is appended to the list of tags associated with the
+ *          pipe. If you specify a tag key that is already associated with the pipe, the new tag value
+ *          that you specify replaces the previous value for that tag.</p>
  *          <p>You can associate as many as 50 tags with a pipe.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-pipes/src/commands/UpdatePipeCommand.ts b/clients/client-pipes/src/commands/UpdatePipeCommand.ts
@@ -27,13 +27,18 @@ export interface UpdatePipeCommandInput extends UpdatePipeRequest {}
 export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataBearer {}
 
 /**
- * <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.
- *          The exception to this is if you modify any Amazon Web Services-service specific fields in the <code>SourceParameters</code>, <code>EnrichmentParameters</code>, or
- *          <code>TargetParameters</code> objects. For example, <code>DynamoDBStreamParameters</code> or <code>EventBridgeEventBusParameters</code>.
- *          EventBridge updates the fields in these objects atomically as one and overrides existing values.
- *          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>
+ * <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. The exception
+ *          to this is if you modify any Amazon Web Services-service specific fields in the
+ *             <code>SourceParameters</code>, <code>EnrichmentParameters</code>, or
+ *             <code>TargetParameters</code> objects. For example,
+ *             <code>DynamoDBStreamParameters</code> or <code>EventBridgeEventBusParameters</code>.
+ *          EventBridge updates the fields in these objects atomically as one and overrides existing
+ *          values. 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>
  *          <p>For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">
- *          Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>
+ *             Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -321,6 +326,39 @@ export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataB
  *       LogStreamName: "STRING_VALUE",
  *       Timestamp: "STRING_VALUE",
  *     },
+ *     TimestreamParameters: { // PipeTargetTimestreamParameters
+ *       TimeValue: "STRING_VALUE", // required
+ *       EpochTimeUnit: "STRING_VALUE",
+ *       TimeFieldType: "STRING_VALUE",
+ *       TimestampFormat: "STRING_VALUE",
+ *       VersionValue: "STRING_VALUE", // required
+ *       DimensionMappings: [ // DimensionMappings // required
+ *         { // DimensionMapping
+ *           DimensionValue: "STRING_VALUE", // required
+ *           DimensionValueType: "STRING_VALUE", // required
+ *           DimensionName: "STRING_VALUE", // required
+ *         },
+ *       ],
+ *       SingleMeasureMappings: [ // SingleMeasureMappings
+ *         { // SingleMeasureMapping
+ *           MeasureValue: "STRING_VALUE", // required
+ *           MeasureValueType: "STRING_VALUE", // required
+ *           MeasureName: "STRING_VALUE", // required
+ *         },
+ *       ],
+ *       MultiMeasureMappings: [ // MultiMeasureMappings
+ *         { // MultiMeasureMapping
+ *           MultiMeasureName: "STRING_VALUE", // required
+ *           MultiMeasureAttributeMappings: [ // MultiMeasureAttributeMappings // required
+ *             { // MultiMeasureAttributeMapping
+ *               MeasureValue: "STRING_VALUE", // required
+ *               MeasureValueType: "STRING_VALUE", // required
+ *               MultiMeasureAttributeName: "STRING_VALUE", // required
+ *             },
+ *           ],
+ *         },
+ *       ],
+ *     },
  *   },
  *   RoleArn: "STRING_VALUE", // required
  *   LogConfiguration: { // PipeLogConfigurationParameters

diff --git a/clients/client-pipes/src/index.ts b/clients/client-pipes/src/index.ts
@@ -1,9 +1,12 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing
- *       event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target.
- *       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>
+ * <p>Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need
+ *          for specialized knowledge and integration code when developing event driven architectures.
+ *          This helps ensures consistency across your company’s applications. With Pipes, the target
+ *          can be any available EventBridge target. 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>
  *
  * @packageDocumentation
  */