Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1410238162.6 KB

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.

put/v1/pipes/{Name}

Path parameters

Namestring required

The name of the pipe.

Request body

Descriptionstring password

A description of the pipe.

DesiredState'RUNNING' | 'STOPPED'

The state the pipe should be in.

Enrichmentstring

The ARN of the enrichment resource.

Targetstring

The ARN of the target resource.

RoleArnstring required

The ARN of the role that allows the pipe to send data to the target.

KmsKeyIdentifierstring
<p>The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p> <p>To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.</p> <p>To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service Developer Guide</i>. </p>

Response

Success

Arnstring

The ARN of the pipe.

Namestring

The name of the pipe.

DesiredState'RUNNING' | 'STOPPED'

The state the pipe should be in.

CurrentState'RUNNING' | 'STOPPED' | 'CREATING' | 'UPDATING' | 'DELETING' | 'STARTING' | 'STOPPING' | 'CREATE_FAILED' | 'UPDATE_FAILED' | 'START_FAILED' | 'STOP_FAILED' | 'DELETE_FAILED' | 'CREATE_ROLLBACK_FAILED' | 'DELETE_ROLLBACK_FAILED' | 'UPDATE_ROLLBACK_FAILED'

The state the pipe is in.

CreationTimestring date-time

The time the pipe was created.

LastModifiedTimestring date-time

When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).