Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListPipes

Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Request Syntax


GET /v1/pipes?CurrentState=CurrentState&DesiredState=DesiredState&Limit=Limit&NamePrefix=NamePrefix&NextToken=NextToken&SourcePrefix=SourcePrefix&TargetPrefix=TargetPrefix HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

CurrentState

The state the pipe is in.

DesiredState

The state the pipe should be in.

Valid Values: RUNNING | STOPPED

Limit

The maximum number of pipes to include in the response.

Valid Range: Minimum value of 1. Maximum value of 100.

NamePrefix

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

NextToken

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Length Constraints: Minimum length of 1. Maximum length of 2048.

SourcePrefix

The prefix matching the pipe source.

Length Constraints: Minimum length of 1. Maximum length of 1600.

TargetPrefix

The prefix matching the pipe target.

Length Constraints: Minimum length of 1. Maximum length of 1600.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Pipes": [ 
      { 
         "Arn": "string",
         "CreationTime": number,
         "CurrentState": "string",
         "DesiredState": "string",
         "Enrichment": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "Source": "string",
         "StateReason": "string",
         "Target": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pipes

The pipes returned by the call.

Type: Array of Pipe objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

ThrottlingException

An action was throttled.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400