@aws-sdk/client-pipes 3.587.0 → 3.590.0

package/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
 

package/dist-cjs/index.js

@@ -32,9 +32,11 @@ __export(src_exports, {
   DeletePipeCommand: () => DeletePipeCommand,
   DescribePipeCommand: () => DescribePipeCommand,
   DescribePipeResponseFilterSensitiveLog: () => DescribePipeResponseFilterSensitiveLog,
+  DimensionValueType: () => DimensionValueType,
   DynamoDBStreamStartPosition: () => DynamoDBStreamStartPosition,
   EcsEnvironmentFileType: () => EcsEnvironmentFileType,
   EcsResourceRequirementType: () => EcsResourceRequirementType,
+  EpochTimeUnit: () => EpochTimeUnit,
   FilterCriteriaFilterSensitiveLog: () => FilterCriteriaFilterSensitiveLog,
   FilterFilterSensitiveLog: () => FilterFilterSensitiveLog,
   IncludeExecutionDataOption: () => IncludeExecutionDataOption,
@@ -50,6 +52,7 @@ __export(src_exports, {
   MQBrokerAccessCredentials: () => MQBrokerAccessCredentials,
   MSKAccessCredentials: () => MSKAccessCredentials,
   MSKStartPosition: () => MSKStartPosition,
+  MeasureValueType: () => MeasureValueType,
   NetworkConfigurationFilterSensitiveLog: () => NetworkConfigurationFilterSensitiveLog,
   NotFoundException: () => NotFoundException,
   OnPartialBatchItemFailureStreams: () => OnPartialBatchItemFailureStreams,
@@ -92,6 +95,7 @@ __export(src_exports, {
   TagResourceCommand: () => TagResourceCommand,
   TagResourceRequestFilterSensitiveLog: () => TagResourceRequestFilterSensitiveLog,
   ThrottlingException: () => ThrottlingException,
+  TimeFieldType: () => TimeFieldType,
   UntagResourceCommand: () => UntagResourceCommand,
   UpdatePipeCommand: () => UpdatePipeCommand,
   UpdatePipeRequestFilterSensitiveLog: () => UpdatePipeRequestFilterSensitiveLog,
@@ -403,6 +407,26 @@ var PipeTargetInvocationType = {
   FIRE_AND_FORGET: "FIRE_AND_FORGET",
   REQUEST_RESPONSE: "REQUEST_RESPONSE"
 };
+var DimensionValueType = {
+  VARCHAR: "VARCHAR"
+};
+var EpochTimeUnit = {
+  MICROSECONDS: "MICROSECONDS",
+  MILLISECONDS: "MILLISECONDS",
+  NANOSECONDS: "NANOSECONDS",
+  SECONDS: "SECONDS"
+};
+var MeasureValueType = {
+  BIGINT: "BIGINT",
+  BOOLEAN: "BOOLEAN",
+  DOUBLE: "DOUBLE",
+  TIMESTAMP: "TIMESTAMP",
+  VARCHAR: "VARCHAR"
+};
+var TimeFieldType = {
+  EPOCH: "EPOCH",
+  TIMESTAMP_FORMAT: "TIMESTAMP_FORMAT"
+};
 var PipeState = {
   CREATE_FAILED: "CREATE_FAILED",
   CREATE_ROLLBACK_FAILED: "CREATE_ROLLBACK_FAILED",
@@ -1525,6 +1549,10 @@ var paginateListPipes = (0, import_core.createPaginator)(PipesClient, ListPipesC
   PlacementStrategyType,
   PropagateTags,
   PipeTargetInvocationType,
+  DimensionValueType,
+  EpochTimeUnit,
+  MeasureValueType,
+  TimeFieldType,
   PipeState,
   InternalException,
   NotFoundException,

package/dist-es/models/models_0.js

@@ -125,6 +125,26 @@ export const PipeTargetInvocationType = {
     FIRE_AND_FORGET: "FIRE_AND_FORGET",
     REQUEST_RESPONSE: "REQUEST_RESPONSE",
 };
+export const DimensionValueType = {
+    VARCHAR: "VARCHAR",
+};
+export const EpochTimeUnit = {
+    MICROSECONDS: "MICROSECONDS",
+    MILLISECONDS: "MILLISECONDS",
+    NANOSECONDS: "NANOSECONDS",
+    SECONDS: "SECONDS",
+};
+export const MeasureValueType = {
+    BIGINT: "BIGINT",
+    BOOLEAN: "BOOLEAN",
+    DOUBLE: "DOUBLE",
+    TIMESTAMP: "TIMESTAMP",
+    VARCHAR: "VARCHAR",
+};
+export const TimeFieldType = {
+    EPOCH: "EPOCH",
+    TIMESTAMP_FORMAT: "TIMESTAMP_FORMAT",
+};
 export const PipeState = {
     CREATE_FAILED: "CREATE_FAILED",
     CREATE_ROLLBACK_FAILED: "CREATE_ROLLBACK_FAILED",

package/dist-types/Pipes.d.ts

@@ -74,9 +74,12 @@ export interface Pipes {
     updatePipe(args: UpdatePipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePipeCommandOutput) => void): void;
 }
 /**
- * <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 declare class Pipes extends PipesClient implements Pipes {

package/dist-types/PipesClient.d.ts

@@ -100,15 +100,15 @@ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHand
      * Enables FIPS compatible endpoints.
      */
     useFipsEndpoint?: boolean | __Provider<boolean>;
+    /**
+     * The AWS region to which this client will send requests
+     */
+    region?: string | __Provider<string>;
     /**
      * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
      * @internal
      */
     defaultUserAgentProvider?: Provider<__UserAgent>;
-    /**
-     * The AWS region to which this client will send requests
-     */
-    region?: string | __Provider<string>;
     /**
      * Default credentials provider; Not available in browser runtime.
      * @deprecated
@@ -161,9 +161,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 declare class PipesClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PipesClientResolvedConfig> {

package/dist-types/commands/CreatePipeCommand.d.ts

@@ -26,7 +26,8 @@ declare const CreatePipeCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <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
@@ -330,6 +331,39 @@ declare const CreatePipeCommand_base: {
  *       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

package/dist-types/commands/DescribePipeCommand.d.ts

@@ -338,6 +338,39 @@ declare const DescribePipeCommand_base: {
  * //       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

package/dist-types/commands/TagResourceCommand.d.ts

@@ -26,16 +26,16 @@ declare const TagResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <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.

package/dist-types/commands/UpdatePipeCommand.d.ts

@@ -26,13 +26,18 @@ declare const UpdatePipeCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <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
@@ -320,6 +325,39 @@ declare const UpdatePipeCommand_base: {
  *       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

package/dist-types/index.d.ts

@@ -1,7 +1,10 @@
 /**
- * <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
  */