Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1410238162.6 KB

Get the information about an existing pipe. 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.

get/v1/pipes/{Name}

Path parameters

Namestring required

The name of the pipe.

Response

Success

Arnstring

The ARN of the pipe.

Namestring

The name of the pipe.

Descriptionstring password

A description of the pipe.

DesiredState'RUNNING' | 'STOPPED' | 'DELETED'

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.

StateReasonstring

The reason the pipe is in its current state.

Sourcestring

The ARN of the source resource.

Enrichmentstring

The ARN of the enrichment resource.

Targetstring

The ARN of the target resource.

RoleArnstring

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.

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).

KmsKeyIdentifierstring
<p>The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html">Data encryption in EventBridge</a> in the <i>Amazon EventBridge User Guide</i>.</p>
All 10 operations