@aws-sdk/client-pipes 3.222.0

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

@@ -0,0 +1,47 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
+import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
+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
+ *          values.</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>
+ *          <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.
+ * ```javascript
+ * import { PipesClient, TagResourceCommand } from "@aws-sdk/client-pipes"; // ES Modules import
+ * // const { PipesClient, TagResourceCommand } = require("@aws-sdk/client-pipes"); // CommonJS import
+ * const client = new PipesClient(config);
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
+ * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
+ *
+ */
+export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, PipesClientResolvedConfig> {
+    readonly input: TagResourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    constructor(input: TagResourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,37 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
+import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
+export interface UntagResourceCommandInput extends UntagResourceRequest {
+}
+export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
+}
+/**
+ * <p>Removes one or more tags from the specified pipes.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PipesClient, UntagResourceCommand } from "@aws-sdk/client-pipes"; // ES Modules import
+ * // const { PipesClient, UntagResourceCommand } = require("@aws-sdk/client-pipes"); // CommonJS import
+ * const client = new PipesClient(config);
+ * const command = new UntagResourceCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
+ * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
+ *
+ */
+export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, PipesClientResolvedConfig> {
+    readonly input: UntagResourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    constructor(input: UntagResourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,43 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { UpdatePipeRequest, UpdatePipeResponse } from "../models/models_0";
+import { PipesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PipesClient";
+export interface UpdatePipeCommandInput extends UpdatePipeRequest {
+}
+export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataBearer {
+}
+/**
+ * <p>Update an existing pipe. When you call <code>UpdatePipe</code>, only the fields that are included in the request are changed, the rest are 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. The fields in these objects are updated atomically as one and override existing values. This is by design and means that
+ *          if you don't specify an optional field in one of these Parameters objects, that field will be set to its system-default value after 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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PipesClient, UpdatePipeCommand } from "@aws-sdk/client-pipes"; // ES Modules import
+ * // const { PipesClient, UpdatePipeCommand } = require("@aws-sdk/client-pipes"); // CommonJS import
+ * const client = new PipesClient(config);
+ * const command = new UpdatePipeCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link UpdatePipeCommandInput} for command's `input` shape.
+ * @see {@link UpdatePipeCommandOutput} for command's `response` shape.
+ * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape.
+ *
+ */
+export declare class UpdatePipeCommand extends $Command<UpdatePipeCommandInput, UpdatePipeCommandOutput, PipesClientResolvedConfig> {
+    readonly input: UpdatePipeCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    constructor(input: UpdatePipeCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PipesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePipeCommandInput, UpdatePipeCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -0,0 +1,10 @@
+export * from "./CreatePipeCommand";
+export * from "./DeletePipeCommand";
+export * from "./DescribePipeCommand";
+export * from "./ListPipesCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./StartPipeCommand";
+export * from "./StopPipeCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdatePipeCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,19 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@aws-sdk/types";
+export interface ClientInputEndpointParameters {
+    region?: string | Provider<string>;
+    useDualstackEndpoint?: boolean | Provider<boolean>;
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export declare type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export interface EndpointParameters extends __EndpointParameters {
+    Region: string;
+    UseDualStack?: boolean;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@aws-sdk/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@aws-sdk/util-endpoints";
+export declare const ruleSet: RuleSetObject;

package/dist-types/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./Pipes";
+export * from "./PipesClient";
+export * from "./commands";
+export * from "./models";
+export * from "./pagination";
+export { PipesServiceException } from "./models/PipesServiceException";

package/dist-types/models/PipesServiceException.d.ts

@@ -0,0 +1,10 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
+/**
+ * Base exception class for all service exceptions from Pipes service.
+ */
+export declare class PipesServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/index.d.ts

@@ -0,0 +1 @@
+export * from "./models_0";