Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1410238162.6 KB

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

post/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.

Sourcestring required

The ARN of the source resource.

Enrichmentstring

The ARN of the enrichment resource.

Targetstring required

The ARN of the target resource.

RoleArnstring required

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

Tagsobject

The list of key-value pairs to associate with the pipe.

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>If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt pipe data.</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).