import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { UpdatePipeRequest, UpdatePipeResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link UpdatePipeCommand}. */ export interface UpdatePipeCommandInput extends UpdatePipeRequest { } /** * @public * * The output of {@link UpdatePipeCommand}. */ export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataBearer { } declare const UpdatePipeCommand_base: { new (input: UpdatePipeCommandInput): import("@smithy/core/client").CommandImpl; new (input: UpdatePipeCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Update an existing pipe. When you call UpdatePipe, 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 * SourceParameters, EnrichmentParameters, or * TargetParameters objects. For example, * DynamoDBStreamParameters or EventBridgeEventBusParameters. * 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 Parameters objects, EventBridge sets that field to its system-default * value during the update.

*

For more information about pipes, see * Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

* @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 * // import type { PipesClientConfig } from "@aws-sdk/client-pipes"; * const config = {}; // type is PipesClientConfig * const client = new PipesClient(config); * const input = { // UpdatePipeRequest * Name: "STRING_VALUE", // required * Description: "STRING_VALUE", * DesiredState: "STRING_VALUE", * SourceParameters: { // UpdatePipeSourceParameters * FilterCriteria: { // FilterCriteria * Filters: [ // FilterList * { // Filter * Pattern: "STRING_VALUE", * }, * ], * }, * KinesisStreamParameters: { // UpdatePipeSourceKinesisStreamParameters * BatchSize: Number("int"), * DeadLetterConfig: { // DeadLetterConfig * Arn: "STRING_VALUE", * }, * OnPartialBatchItemFailure: "STRING_VALUE", * MaximumBatchingWindowInSeconds: Number("int"), * MaximumRecordAgeInSeconds: Number("int"), * MaximumRetryAttempts: Number("int"), * ParallelizationFactor: Number("int"), * }, * DynamoDBStreamParameters: { // UpdatePipeSourceDynamoDBStreamParameters * BatchSize: Number("int"), * DeadLetterConfig: { * Arn: "STRING_VALUE", * }, * OnPartialBatchItemFailure: "STRING_VALUE", * MaximumBatchingWindowInSeconds: Number("int"), * MaximumRecordAgeInSeconds: Number("int"), * MaximumRetryAttempts: Number("int"), * ParallelizationFactor: Number("int"), * }, * SqsQueueParameters: { // UpdatePipeSourceSqsQueueParameters * BatchSize: Number("int"), * MaximumBatchingWindowInSeconds: Number("int"), * }, * ActiveMQBrokerParameters: { // UpdatePipeSourceActiveMQBrokerParameters * Credentials: { // MQBrokerAccessCredentials Union: only one key present * BasicAuth: "STRING_VALUE", * }, * BatchSize: Number("int"), * MaximumBatchingWindowInSeconds: Number("int"), * }, * RabbitMQBrokerParameters: { // UpdatePipeSourceRabbitMQBrokerParameters * Credentials: {// Union: only one key present * BasicAuth: "STRING_VALUE", * }, * BatchSize: Number("int"), * MaximumBatchingWindowInSeconds: Number("int"), * }, * ManagedStreamingKafkaParameters: { // UpdatePipeSourceManagedStreamingKafkaParameters * BatchSize: Number("int"), * Credentials: { // MSKAccessCredentials Union: only one key present * SaslScram512Auth: "STRING_VALUE", * ClientCertificateTlsAuth: "STRING_VALUE", * }, * MaximumBatchingWindowInSeconds: Number("int"), * }, * SelfManagedKafkaParameters: { // UpdatePipeSourceSelfManagedKafkaParameters * BatchSize: Number("int"), * MaximumBatchingWindowInSeconds: Number("int"), * Credentials: { // SelfManagedKafkaAccessConfigurationCredentials Union: only one key present * BasicAuth: "STRING_VALUE", * SaslScram512Auth: "STRING_VALUE", * SaslScram256Auth: "STRING_VALUE", * ClientCertificateTlsAuth: "STRING_VALUE", * }, * ServerRootCaCertificate: "STRING_VALUE", * Vpc: { // SelfManagedKafkaAccessConfigurationVpc * Subnets: [ // SubnetIds * "STRING_VALUE", * ], * SecurityGroup: [ // SecurityGroupIds * "STRING_VALUE", * ], * }, * }, * }, * Enrichment: "STRING_VALUE", * EnrichmentParameters: { // PipeEnrichmentParameters * InputTemplate: "STRING_VALUE", * HttpParameters: { // PipeEnrichmentHttpParameters * PathParameterValues: [ // PathParameterList * "STRING_VALUE", * ], * HeaderParameters: { // HeaderParametersMap * "": "STRING_VALUE", * }, * QueryStringParameters: { // QueryStringParametersMap * "": "STRING_VALUE", * }, * }, * }, * Target: "STRING_VALUE", * TargetParameters: { // PipeTargetParameters * InputTemplate: "STRING_VALUE", * LambdaFunctionParameters: { // PipeTargetLambdaFunctionParameters * InvocationType: "STRING_VALUE", * }, * StepFunctionStateMachineParameters: { // PipeTargetStateMachineParameters * InvocationType: "STRING_VALUE", * }, * KinesisStreamParameters: { // PipeTargetKinesisStreamParameters * PartitionKey: "STRING_VALUE", // required * }, * EcsTaskParameters: { // PipeTargetEcsTaskParameters * TaskDefinitionArn: "STRING_VALUE", // required * TaskCount: Number("int"), * LaunchType: "STRING_VALUE", * NetworkConfiguration: { // NetworkConfiguration * awsvpcConfiguration: { // AwsVpcConfiguration * Subnets: [ // Subnets // required * "STRING_VALUE", * ], * SecurityGroups: [ // SecurityGroups * "STRING_VALUE", * ], * AssignPublicIp: "STRING_VALUE", * }, * }, * PlatformVersion: "STRING_VALUE", * Group: "STRING_VALUE", * CapacityProviderStrategy: [ // CapacityProviderStrategy * { // CapacityProviderStrategyItem * capacityProvider: "STRING_VALUE", // required * weight: Number("int"), * base: Number("int"), * }, * ], * EnableECSManagedTags: true || false, * EnableExecuteCommand: true || false, * PlacementConstraints: [ // PlacementConstraints * { // PlacementConstraint * type: "STRING_VALUE", * expression: "STRING_VALUE", * }, * ], * PlacementStrategy: [ // PlacementStrategies * { // PlacementStrategy * type: "STRING_VALUE", * field: "STRING_VALUE", * }, * ], * PropagateTags: "STRING_VALUE", * ReferenceId: "STRING_VALUE", * Overrides: { // EcsTaskOverride * ContainerOverrides: [ // EcsContainerOverrideList * { // EcsContainerOverride * Command: [ // StringList * "STRING_VALUE", * ], * Cpu: Number("int"), * Environment: [ // EcsEnvironmentVariableList * { // EcsEnvironmentVariable * name: "STRING_VALUE", * value: "STRING_VALUE", * }, * ], * EnvironmentFiles: [ // EcsEnvironmentFileList * { // EcsEnvironmentFile * type: "STRING_VALUE", // required * value: "STRING_VALUE", // required * }, * ], * Memory: Number("int"), * MemoryReservation: Number("int"), * Name: "STRING_VALUE", * ResourceRequirements: [ // EcsResourceRequirementsList * { // EcsResourceRequirement * type: "STRING_VALUE", // required * value: "STRING_VALUE", // required * }, * ], * }, * ], * Cpu: "STRING_VALUE", * EphemeralStorage: { // EcsEphemeralStorage * sizeInGiB: Number("int"), // required * }, * ExecutionRoleArn: "STRING_VALUE", * InferenceAcceleratorOverrides: [ // EcsInferenceAcceleratorOverrideList * { // EcsInferenceAcceleratorOverride * deviceName: "STRING_VALUE", * deviceType: "STRING_VALUE", * }, * ], * Memory: "STRING_VALUE", * TaskRoleArn: "STRING_VALUE", * }, * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }, * BatchJobParameters: { // PipeTargetBatchJobParameters * JobDefinition: "STRING_VALUE", // required * JobName: "STRING_VALUE", // required * ArrayProperties: { // BatchArrayProperties * Size: Number("int"), * }, * RetryStrategy: { // BatchRetryStrategy * Attempts: Number("int"), * }, * ContainerOverrides: { // BatchContainerOverrides * Command: [ * "STRING_VALUE", * ], * Environment: [ // BatchEnvironmentVariableList * { // BatchEnvironmentVariable * Name: "STRING_VALUE", * Value: "STRING_VALUE", * }, * ], * InstanceType: "STRING_VALUE", * ResourceRequirements: [ // BatchResourceRequirementsList * { // BatchResourceRequirement * Type: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }, * DependsOn: [ // BatchDependsOn * { // BatchJobDependency * JobId: "STRING_VALUE", * Type: "STRING_VALUE", * }, * ], * Parameters: { // BatchParametersMap * "": "STRING_VALUE", * }, * }, * SqsQueueParameters: { // PipeTargetSqsQueueParameters * MessageGroupId: "STRING_VALUE", * MessageDeduplicationId: "STRING_VALUE", * }, * HttpParameters: { // PipeTargetHttpParameters * PathParameterValues: [ * "STRING_VALUE", * ], * HeaderParameters: { * "": "STRING_VALUE", * }, * QueryStringParameters: { * "": "STRING_VALUE", * }, * }, * RedshiftDataParameters: { // PipeTargetRedshiftDataParameters * SecretManagerArn: "STRING_VALUE", * Database: "STRING_VALUE", // required * DbUser: "STRING_VALUE", * StatementName: "STRING_VALUE", * WithEvent: true || false, * Sqls: [ // Sqls // required * "STRING_VALUE", * ], * }, * SageMakerPipelineParameters: { // PipeTargetSageMakerPipelineParameters * PipelineParameterList: [ // SageMakerPipelineParameterList * { // SageMakerPipelineParameter * Name: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }, * EventBridgeEventBusParameters: { // PipeTargetEventBridgeEventBusParameters * EndpointId: "STRING_VALUE", * DetailType: "STRING_VALUE", * Source: "STRING_VALUE", * Resources: [ // EventBridgeEventResourceList * "STRING_VALUE", * ], * Time: "STRING_VALUE", * }, * CloudWatchLogsParameters: { // PipeTargetCloudWatchLogsParameters * 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 * S3LogDestination: { // S3LogDestinationParameters * BucketName: "STRING_VALUE", // required * BucketOwner: "STRING_VALUE", // required * OutputFormat: "STRING_VALUE", * Prefix: "STRING_VALUE", * }, * FirehoseLogDestination: { // FirehoseLogDestinationParameters * DeliveryStreamArn: "STRING_VALUE", // required * }, * CloudwatchLogsLogDestination: { // CloudwatchLogsLogDestinationParameters * LogGroupArn: "STRING_VALUE", // required * }, * Level: "STRING_VALUE", // required * IncludeExecutionData: [ // IncludeExecutionData * "STRING_VALUE", * ], * }, * KmsKeyIdentifier: "STRING_VALUE", * }; * const command = new UpdatePipeCommand(input); * const response = await client.send(command); * // { // UpdatePipeResponse * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // DesiredState: "STRING_VALUE", * // CurrentState: "STRING_VALUE", * // CreationTime: new Date("TIMESTAMP"), * // LastModifiedTime: new Date("TIMESTAMP"), * // }; * * ``` * * @param UpdatePipeCommandInput - {@link UpdatePipeCommandInput} * @returns {@link UpdatePipeCommandOutput} * @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. * * @throws {@link ConflictException} (client fault) *

An action you attempted resulted in an exception.

* * @throws {@link InternalException} (server fault) *

This exception occurs due to unexpected causes.

* * @throws {@link NotFoundException} (client fault) *

An entity that you specified does not exist.

* * @throws {@link ThrottlingException} (client fault) *

An action was throttled.

* * @throws {@link ValidationException} (client fault) *

Indicates that an error has occurred while performing a validate operation.

* * @throws {@link PipesServiceException} *

Base exception class for all service exceptions from Pipes service.

* * * @public */ export declare class UpdatePipeCommand extends UpdatePipeCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdatePipeRequest; output: UpdatePipeResponse; }; sdk: { input: UpdatePipeCommandInput; output: UpdatePipeCommandOutput; }; }; }